add new tests for the apiresourceschema controller

On-behalf-of: @SAP [email protected]

Author: xrstf

Diff for: test/e2e/apiresourceschema/apiresourceschema_test.go

@@ -106,3 +106,169 @@ func TestARSAreCreated(t *testing.T) {
 		t.Fatalf("APIResourceSchema does not exist: %v", err)
 	}
 }
+
+func TestARSAreNotUpdated(t *testing.T) {
+	const (
+		apiExportName = "example.com"
+	)
+
+	ctx := context.Background()
+	ctrlruntime.SetLogger(logr.Discard())
+
+	// setup a test environment in kcp
+	orgKubconfig := utils.CreateOrganization(t, ctx, "ars-are-not-updated", apiExportName)
+
+	// start a service cluster
+	envtestKubeconfig, envtestClient, _ := utils.RunEnvtest(t, []string{
+		"test/crds/crontab.yaml",
+	})
+
+	// publish Crontabs
+	t.Logf("Publishing CronTabs…")
+	pr := &syncagentv1alpha1.PublishedResource{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "publish-crontabs",
+		},
+		Spec: syncagentv1alpha1.PublishedResourceSpec{
+			Resource: syncagentv1alpha1.SourceResourceDescriptor{
+				APIGroup: "example.com",
+				Version:  "v1",
+				Kind:     "CronTab",
+			},
+		},
+	}
+
+	if err := envtestClient.Create(ctx, pr); err != nil {
+		t.Fatalf("Failed to create PublishedResource: %v", err)
+	}
+
+	// let the agent do its thing
+	utils.RunAgent(ctx, t, "bob", orgKubconfig, envtestKubeconfig, apiExportName)
+
+	// wait for the APIExport to be updated
+	t.Logf("Waiting for APIExport to be updated…")
+	orgClient := utils.GetClient(t, orgKubconfig)
+	apiExportKey := types.NamespacedName{Name: apiExportName}
+
+	var arsName string
+	err := wait.PollUntilContextTimeout(ctx, 500*time.Millisecond, 1*time.Minute, false, func(ctx context.Context) (done bool, err error) {
+		apiExport := &kcpapisv1alpha1.APIExport{}
+		err = orgClient.Get(ctx, apiExportKey, apiExport)
+		if err != nil {
+			return false, err
+		}
+
+		if len(apiExport.Spec.LatestResourceSchemas) == 0 {
+			return false, nil
+		}
+
+		arsName = apiExport.Spec.LatestResourceSchemas[0]
+
+		return true, nil
+	})
+	if err != nil {
+		t.Fatalf("Failed to wait for APIExport to be updated: %v", err)
+	}
+
+	// update the CRD
+	t.Logf("Updating CRD (same version, but new schema)…")
+	utils.ApplyCRD(t, ctx, envtestClient, "test/crds/crontab-improved.yaml")
+
+	// give the agent some time to do nothing
+	time.Sleep(3 * time.Second)
+
+	// validate that the APIExport has *not* changed
+	apiExport := &kcpapisv1alpha1.APIExport{}
+	err = orgClient.Get(ctx, apiExportKey, apiExport)
+	if err != nil {
+		t.Fatalf("APIExport disappeared: %v", err)
+	}
+
+	if l := len(apiExport.Spec.LatestResourceSchemas); l != 1 {
+		t.Fatalf("APIExport should still have 1 resource schema, but has %d.", l)
+	}
+
+	if currentName := apiExport.Spec.LatestResourceSchemas[0]; currentName != arsName {
+		t.Fatalf("APIExport should still refer to the original ARS %q, but now contains %q.", arsName, currentName)
+	}
+}
+
+func TestARSDropsAllVersionsExceptTheSelectedOne(t *testing.T) {
+	const (
+		apiExportName = "example.com"
+		theVersion    = "v1"
+	)
+
+	ctx := context.Background()
+	ctrlruntime.SetLogger(logr.Discard())
+
+	// setup a test environment in kcp
+	orgKubconfig := utils.CreateOrganization(t, ctx, "ars-drops-crd-versions", apiExportName)
+
+	// start a service cluster
+	envtestKubeconfig, envtestClient, _ := utils.RunEnvtest(t, []string{
+		"test/crds/crontab-multi-versions.yaml",
+	})
+
+	// publish Crontabs
+	t.Logf("Publishing CronTabs…")
+	pr := &syncagentv1alpha1.PublishedResource{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "publish-crontabs",
+		},
+		Spec: syncagentv1alpha1.PublishedResourceSpec{
+			Resource: syncagentv1alpha1.SourceResourceDescriptor{
+				APIGroup: "example.com",
+				Version:  theVersion,
+				Kind:     "CronTab",
+			},
+		},
+	}
+
+	if err := envtestClient.Create(ctx, pr); err != nil {
+		t.Fatalf("Failed to create PublishedResource: %v", err)
+	}
+
+	// let the agent do its thing
+	utils.RunAgent(ctx, t, "bob", orgKubconfig, envtestKubeconfig, apiExportName)
+
+	// wait for the APIExport to be updated
+	t.Logf("Waiting for APIExport to be updated…")
+	orgClient := utils.GetClient(t, orgKubconfig)
+	apiExportKey := types.NamespacedName{Name: apiExportName}
+
+	var arsName string
+	err := wait.PollUntilContextTimeout(ctx, 500*time.Millisecond, 1*time.Minute, false, func(ctx context.Context) (done bool, err error) {
+		apiExport := &kcpapisv1alpha1.APIExport{}
+		err = orgClient.Get(ctx, apiExportKey, apiExport)
+		if err != nil {
+			return false, err
+		}
+
+		if len(apiExport.Spec.LatestResourceSchemas) == 0 {
+			return false, nil
+		}
+
+		arsName = apiExport.Spec.LatestResourceSchemas[0]
+
+		return true, nil
+	})
+	if err != nil {
+		t.Fatalf("Failed to wait for APIExport to be updated: %v", err)
+	}
+
+	// check the APIResourceSchema
+	ars := &kcpapisv1alpha1.APIResourceSchema{}
+	err = orgClient.Get(ctx, types.NamespacedName{Name: arsName}, ars)
+	if err != nil {
+		t.Fatalf("APIResourceSchema does not exist: %v", err)
+	}
+
+	if len(ars.Spec.Versions) != 1 {
+		t.Fatalf("Expected only one version to remain in ARS, but found %d.", len(ars.Spec.Versions))
+	}
+
+	if name := ars.Spec.Versions[0].Name; name != theVersion {
+		t.Fatalf("Expected ARS to contain %q, but contains %q.", theVersion, name)
+	}
+}

Diff for: test/utils/fixtures.go

@@ -19,6 +19,8 @@ package utils
 import (
 	"context"
 	"fmt"
+	"os"
+	"path/filepath"
 	"strings"
 	"testing"
 	"time"
@@ -32,8 +34,10 @@ import (
 	"github.com/kcp-dev/kcp/sdk/apis/third_party/conditions/util/conditions"
 
 	rbacv1 "k8s.io/api/rbac/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/wait"
+	"k8s.io/apimachinery/pkg/util/yaml"
 	ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/kontext"
 )
@@ -301,3 +305,42 @@ func BindToAPIExport(t *testing.T, ctx context.Context, client ctrlruntimeclient
 
 	return apiBinding
 }
+
+func ApplyCRD(t *testing.T, ctx context.Context, client ctrlruntimeclient.Client, filename string) {
+	t.Helper()
+
+	crd := loadCRD(t, filename)
+
+	existingCRD := &apiextensionsv1.CustomResourceDefinition{}
+	if err := client.Get(ctx, ctrlruntimeclient.ObjectKeyFromObject(crd), existingCRD); err != nil {
+		if err := client.Create(ctx, crd); err != nil {
+			t.Fatalf("Failed to create CRD: %v", err)
+		}
+	} else {
+		existingCRD.Spec = crd.Spec
+
+		if err := client.Update(ctx, existingCRD); err != nil {
+			t.Fatalf("Failed to update CRD: %v", err)
+		}
+	}
+}
+
+func loadCRD(t *testing.T, filename string) *apiextensionsv1.CustomResourceDefinition {
+	t.Helper()
+
+	rootDirectory := requiredEnv(t, "ROOT_DIRECTORY")
+
+	f, err := os.Open(filepath.Join(rootDirectory, filename))
+	if err != nil {
+		t.Fatalf("Failed to read CRD: %v", err)
+	}
+	defer f.Close()
+
+	crd := &apiextensionsv1.CustomResourceDefinition{}
+	dec := yaml.NewYAMLOrJSONDecoder(f, 1024)
+	if err := dec.Decode(crd); err != nil {
+		t.Fatalf("Failed to decode CRD: %v", err)
+	}
+
+	return crd
+}

Diff for: test/utils/utils.go

@@ -30,6 +30,7 @@ import (
 
 	corev1 "k8s.io/api/core/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/scale/scheme"
 	"k8s.io/client-go/tools/clientcmd"
@@ -60,6 +61,7 @@ func newScheme(t *testing.T) *runtime.Scheme {
 	must(t, kcptenancyv1alpha1.AddToScheme(sc))
 	must(t, kcpapisv1alpha1.AddToScheme(sc))
 	must(t, syncagentv1alpha1.AddToScheme(sc))
+	must(t, apiextensionsv1.AddToScheme(sc))
 
 	return sc
 }