github.com/zppinho/prow@v0.0.0-20240510014325-1738badeb017/cmd/config-bootstrapper/main_test.go

/*
Copyright 2019 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package main

import (
	"context"
	"path/filepath"
	"testing"

	"github.com/google/go-cmp/cmp"

	coreapi "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/equality"
	"k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/client-go/kubernetes/fake"

	"sigs.k8s.io/prow/pkg/git/localgit"
	"sigs.k8s.io/prow/pkg/plugins"
)

var (
	defaultNamespace = "default"
	defaultBranch    = localgit.DefaultBranch("")
)

func TestRunV2(t *testing.T) {
	testRun(localgit.NewV2, t)
}

func testRun(clients localgit.Clients, t *testing.T) {
	lg, c, err := clients()
	if err != nil {
		t.Fatalf("Making local git repo: %v", err)
	}

	defer func() {
		if err := c.Clean(); err != nil {
			t.Errorf("Could not clean up git client cache: %v.", err)
		}
	}()

	if err := lg.MakeFakeRepo("openshift", "release"); err != nil {
		t.Fatalf("Making fake repo: %v", err)
	}
	if err := lg.Checkout("openshift", "release", defaultBranch); err != nil {
		t.Fatalf("Checkout new branch: %v", err)
	}

	if err := lg.AddCommit("openshift", "release", map[string][]byte{
		"config/foo.yaml": []byte(`#foo.yaml`),
		"config/bar.yaml": []byte(`#bar.yaml`),
		"VERSION":         []byte("some-git-sha"),
	}); err != nil {
		t.Fatalf("Add commit: %v", err)
	}

	if err := lg.MakeFakeRepo("openshift", "other"); err != nil {
		t.Fatalf("Making fake repo: %v", err)
	}
	if err := lg.Checkout("openshift", "other", defaultBranch); err != nil {
		t.Fatalf("Checkout new branch: %v", err)
	}

	if err := lg.AddCommit("openshift", "other", map[string][]byte{
		"config/other-foo.yaml": []byte(`#other-foo.yaml`),
		"config/other-bar.yaml": []byte(`#other-bar.yaml`),
	}); err != nil {
		t.Fatalf("Add commit: %v", err)
	}

	if err := lg.MakeFakeRepo("org", "partition-test"); err != nil {
		t.Fatalf("Making fake repo: %v", err)
	}
	if err := lg.Checkout("org", "partition-test", defaultBranch); err != nil {
		t.Fatalf("Checkout new branch: %v", err)
	}

	if err := lg.AddCommit("org", "partition-test", map[string][]byte{
		"config/foo.yaml": []byte(`#foo.yaml`),
		"config/bar.yaml": []byte(`#bar.yaml`),
		"config/baz.yaml": []byte(`#baz.yaml`),
	}); err != nil {
		t.Fatalf("Add commit: %v", err)
	}

	if err := lg.MakeFakeRepo("org", "partition-test2"); err != nil {
		t.Fatalf("Making fake repo: %v", err)
	}
	if err := lg.Checkout("org", "partition-test2", defaultBranch); err != nil {
		t.Fatalf("Checkout new branch: %v", err)
	}

	if err := lg.AddCommit("org", "partition-test2", map[string][]byte{
		"config/foo.yaml": []byte(`#foo.yaml`),
		"config/bar.yaml": []byte(`#bar.yaml`),
	}); err != nil {
		t.Fatalf("Add commit: %v", err)
	}

	testcases := []struct {
		name             string
		sourcePaths      []string
		defaultNamespace string
		configUpdater    plugins.ConfigUpdater
		expected         int

		existConfigMaps    []runtime.Object
		expectedConfigMaps []*coreapi.ConfigMap
	}{
		{
			name:             "issues/15570 is covered",
			sourcePaths:      []string{filepath.Join(lg.Dir, "openshift/release")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/foo.yaml": {
						Name: "multikey-config",
						Clusters: map[string][]string{
							"default": {defaultNamespace},
						},
					},
					"config/bar.yaml": {
						Name: "multikey-config",
					},
				},
			},
			existConfigMaps: []runtime.Object{
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "multikey-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "multikey-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"VERSION":  "some-git-sha",
						"foo.yaml": "#foo.yaml",
						"bar.yaml": "#bar.yaml",
					},
				},
			},
		},
		{
			name:             "multiple sources",
			sourcePaths:      []string{filepath.Join(lg.Dir, "openshift/release"), filepath.Join(lg.Dir, "openshift/other")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/foo.yaml": {
						Name: "multikey-config",
						Clusters: map[string][]string{
							"default": {defaultNamespace},
						},
					},
					"config/bar.yaml": {
						Name: "multikey-config",
					},
					"config/other-foo.yaml": {
						Name: "other",
						Clusters: map[string][]string{
							"default": {defaultNamespace},
						},
					},
					"config/other-bar.yaml": {
						Name: "bar",
					},
				},
			},
			existConfigMaps: []runtime.Object{
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "multikey-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "multikey-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"VERSION":  "some-git-sha",
						"foo.yaml": "#foo.yaml",
						"bar.yaml": "#bar.yaml",
					},
				},
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "other",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"VERSION":        "some-git-sha",
						"other-foo.yaml": "#other-foo.yaml",
					},
				},
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "bar",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"VERSION":        "some-git-sha",
						"other-bar.yaml": "#other-bar.yaml",
					},
				},
			},
		},
		{
			name:             "undefined cluster errors",
			sourcePaths:      []string{filepath.Join(lg.Dir, "openshift/release")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/foo.yaml": {
						Name: "multikey-config",
						Clusters: map[string][]string{
							"undef": {defaultNamespace},
						},
					},
				},
			},
			expected: 1,
		},
		{
			name:             "PartitionedNames properly partitions",
			sourcePaths:      []string{filepath.Join(lg.Dir, "org/partition-test")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/**/*.yaml": {
						PartitionedNames: []string{"job-config-part-1", "job-config-part-2"},
					},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-1",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"foo.yaml": "#foo.yaml",
						"bar.yaml": "#bar.yaml",
					},
				},
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-2",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"baz.yaml": "#baz.yaml",
					},
				},
			},
		},
		{
			name:             "PartitionedNames file moves between partitions properly",
			sourcePaths:      []string{filepath.Join(lg.Dir, "org/partition-test")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/**/*.yaml": {
						PartitionedNames: []string{"job-config-part-1", "job-config-part-2"},
					},
				},
			},
			existConfigMaps: []runtime.Object{
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-1",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"foo.yaml": "#foo.yaml",
					},
				},
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-2",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"baz.yaml":       "#baz.yaml",
						"barbarbar.yaml": "#bar.yaml",
					},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-1",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"foo.yaml": "#foo.yaml",
						"bar.yaml": "#bar.yaml",
					},
				},
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-2",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"baz.yaml": "#baz.yaml",
					},
				},
			},
		},
		{
			name:             "PartitionedNames: emptied partition is properly wiped",
			sourcePaths:      []string{filepath.Join(lg.Dir, "org/partition-test2")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/**/*.yaml": {
						PartitionedNames: []string{"job-config-part-1", "job-config-part-2"},
					},
				},
			},
			existConfigMaps: []runtime.Object{
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-1",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"foo.yaml": "#foo.yaml",
					},
				},
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-2",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"barbarbar.yaml": "#bar.yaml",
					},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-1",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"foo.yaml": "#foo.yaml",
						"bar.yaml": "#bar.yaml", // renamed from barbarbar.yaml
					},
				},
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config-part-2",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{},
				},
			},
		},
		{
			// The keys for files a, b, and c are unaccounted for (they don't
			// exist in the repo), so they should be deleted.
			name:             "untouched keys are deleted",
			sourcePaths:      []string{filepath.Join(lg.Dir, "openshift/other")},
			defaultNamespace: defaultNamespace,
			configUpdater: plugins.ConfigUpdater{
				Maps: map[string]plugins.ConfigMapSpec{
					"config/other-foo.yaml": {
						Name: "job-config",
					},
					"config/other-bar.yaml": {
						Name: "job-config",
					},
				},
			},
			existConfigMaps: []runtime.Object{
				&coreapi.ConfigMap{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"other-foo.yaml": "#other-foo.yaml",
						"other-bar.yaml": "#other-bar.yaml",

						// The ones below should be deleted.
						"a": "xxx",
						"b": "xxx",
						"c": "xxx",
					},
				},
			},
			expectedConfigMaps: []*coreapi.ConfigMap{
				{
					ObjectMeta: metav1.ObjectMeta{
						Name:      "job-config",
						Namespace: defaultNamespace,
						Labels: map[string]string{
							"app.kubernetes.io/name":      "prow",
							"app.kubernetes.io/component": "updateconfig-plugin",
						},
					},
					Data: map[string]string{
						"other-foo.yaml": "#other-foo.yaml",
						"other-bar.yaml": "#other-bar.yaml",
					},
				},
			},
		},
	}

	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			fkc := fake.NewSimpleClientset(tc.existConfigMaps...)
			tc.configUpdater.SetDefaults()
			actual := run(tc.sourcePaths, tc.defaultNamespace, tc.configUpdater, fkc, nil)
			if tc.expected != actual {
				t.Errorf("%s: incorrect errors '%d': expecting '%d'", tc.name, actual, tc.expected)
			}

			for _, expected := range tc.expectedConfigMaps {
				actual, err := fkc.CoreV1().ConfigMaps(expected.Namespace).Get(context.TODO(), expected.Name, metav1.GetOptions{})
				if err != nil && errors.IsNotFound(err) {
					t.Errorf("%s: Should have updated or created configmap for '%s'", tc.name, expected)
				} else if !equality.Semantic.DeepEqual(expected, actual) {
					t.Errorf("%s: incorrect ConfigMap state after update: %v", tc.name, cmp.Diff(expected, actual))
				}
			}
		})

	}
}