sigs.k8s.io/cluster-api@v1.7.1/cmd/clusterctl/client/cluster/crd_migration_test.go

/*
Copyright 2022 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 cluster

import (
	"context"
	"fmt"
	"testing"

	. "github.com/onsi/gomega"
	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"sigs.k8s.io/controller-runtime/pkg/client"

	"sigs.k8s.io/cluster-api/cmd/clusterctl/internal/test"
)

func Test_CRDMigrator(t *testing.T) {
	tests := []struct {
		name               string
		CRs                []unstructured.Unstructured
		currentCRD         *apiextensionsv1.CustomResourceDefinition
		newCRD             *apiextensionsv1.CustomResourceDefinition
		wantIsMigrated     bool
		wantStoredVersions []string
		wantErr            bool
	}{
		{
			name:           "No-op if current CRD does not exists",
			currentCRD:     &apiextensionsv1.CustomResourceDefinition{ObjectMeta: metav1.ObjectMeta{Name: "something else"}}, // There is currently no "foo" CRD
			newCRD:         &apiextensionsv1.CustomResourceDefinition{ObjectMeta: metav1.ObjectMeta{Name: "foo"}},
			wantIsMigrated: false,
		},
		{
			name: "Error if current CRD does not have a storage version",
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Served: true}, // No storage version as storage is not set.
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Served: true},
					},
				},
			},
			wantErr:        true,
			wantIsMigrated: false,
		},
		{
			name: "No-op if new CRD supports same versions",
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Storage: true, Served: true},
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Storage: true, Served: true},
					},
				},
			},
			wantIsMigrated: false,
		},
		{
			name: "No-op if new CRD adds a new versions",
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Storage: true, Served: true},
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1beta1", Storage: true, Served: true}, // v1beta1 is being added
						{Name: "v1alpha1", Served: true},               // v1alpha1 still exists
					},
				},
			},
			wantIsMigrated: false,
		},
		{
			name: "Fails if new CRD drops current storage version",
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1alpha1", Storage: true, Served: true},
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1", Storage: true, Served: true}, // CRD is jumping to v1, but dropping current storage version without allowing migration.
					},
				},
			},
			wantErr: true,
		},
		{
			name: "Migrate CRs if their storage version is removed from the CRD",
			CRs: []unstructured.Unstructured{
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr1",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr2",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr3",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
			},
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Group: "foo",
					Names: apiextensionsv1.CustomResourceDefinitionNames{Kind: "Foo", ListKind: "FooList"},
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1beta1", Storage: true, Served: true},
						{Name: "v1alpha1", Served: true},
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1beta1", "v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Group: "foo",
					Names: apiextensionsv1.CustomResourceDefinitionNames{Kind: "Foo", ListKind: "FooList"},
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1", Storage: true, Served: true}, // v1 is being added
						{Name: "v1beta1", Served: true},           // v1beta1 still there (required for migration)
						// v1alpha1 is being dropped
					},
				},
			},
			wantStoredVersions: []string{"v1beta1"}, // v1alpha1 should be dropped from current CRD's stored versions
			wantIsMigrated:     true,
		},
		{
			name: "Migrate the CR if their storage version is no longer served by the CRD",
			CRs: []unstructured.Unstructured{
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr1",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr2",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
				{
					Object: map[string]interface{}{
						"apiVersion": "foo/v1beta1",
						"kind":       "Foo",
						"metadata": map[string]interface{}{
							"name":      "cr3",
							"namespace": metav1.NamespaceDefault,
						},
					},
				},
			},
			currentCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Group: "foo",
					Names: apiextensionsv1.CustomResourceDefinitionNames{Kind: "Foo", ListKind: "FooList"},
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1beta1", Storage: true, Served: true},
						{Name: "v1alpha1", Served: true},
					},
				},
				Status: apiextensionsv1.CustomResourceDefinitionStatus{StoredVersions: []string{"v1beta1", "v1alpha1"}},
			},
			newCRD: &apiextensionsv1.CustomResourceDefinition{
				ObjectMeta: metav1.ObjectMeta{Name: "foo"},
				Spec: apiextensionsv1.CustomResourceDefinitionSpec{
					Group: "foo",
					Names: apiextensionsv1.CustomResourceDefinitionNames{Kind: "Foo", ListKind: "FooList"},
					Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
						{Name: "v1", Storage: true, Served: true}, // v1 is being added
						{Name: "v1beta1", Served: true},           // v1beta1 still there (required for migration)
						{Name: "v1alpha1", Served: false},         // v1alpha1 is no longer being served (required for migration)
					},
				},
			},
			wantStoredVersions: []string{"v1beta1"}, // v1alpha1 should be dropped from current CRD's stored versions
			wantIsMigrated:     true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			g := NewWithT(t)

			objs := []client.Object{tt.currentCRD}
			for i := range tt.CRs {
				objs = append(objs, &tt.CRs[i])
			}

			c, err := test.NewFakeProxy().WithObjs(objs...).NewClient(context.Background())
			g.Expect(err).ToNot(HaveOccurred())
			countingClient := newUpgradeCountingClient(c)

			m := crdMigrator{
				Client: countingClient,
			}

			isMigrated, err := m.run(context.Background(), tt.newCRD)
			if tt.wantErr {
				g.Expect(err).To(HaveOccurred())
			} else {
				g.Expect(err).ToNot(HaveOccurred())
			}
			g.Expect(isMigrated).To(Equal(tt.wantIsMigrated))

			if isMigrated {
				storageVersion, err := storageVersionForCRD(tt.currentCRD)
				g.Expect(err).ToNot(HaveOccurred())

				// Check all the objects has been migrated.
				g.Expect(countingClient.count).To(HaveKeyWithValue(fmt.Sprintf("%s/%s, Kind=%s", tt.currentCRD.Spec.Group, storageVersion, tt.currentCRD.Spec.Names.Kind), len(tt.CRs)))

				// Check storage versions has been cleaned up.
				currentCRD := &apiextensionsv1.CustomResourceDefinition{}
				err = c.Get(context.Background(), client.ObjectKeyFromObject(tt.newCRD), currentCRD)
				g.Expect(err).ToNot(HaveOccurred())
				g.Expect(currentCRD.Status.StoredVersions).To(Equal(tt.wantStoredVersions))
			}
		})
	}
}

type UpgradeCountingClient struct {
	count map[string]int
	client.Client
}

func newUpgradeCountingClient(inner client.Client) UpgradeCountingClient {
	return UpgradeCountingClient{
		count:  map[string]int{},
		Client: inner,
	}
}

func (u UpgradeCountingClient) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error {
	u.count[obj.GetObjectKind().GroupVersionKind().String()]++
	return u.Client.Update(ctx, obj, opts...)
}