Add unit tests for reconcile_state, cluster_controller, & conditions

kubernetes-sigs · Sep 14, 2023 · 12cd28d · 12cd28d
1 parent 321096f
commit 12cd28d
Show file tree

Hide file tree

Showing 9 changed files with 1,226 additions and 36 deletions.
diff --git a/controllers/remote/cluster_cache_tracker_fake.go b/controllers/remote/cluster_cache_tracker_fake.go
@@ -30,6 +30,7 @@ func NewTestClusterCacheTracker(log logr.Logger, cl client.Client, scheme *runti
 		client:           cl,
 		scheme:           scheme,
 		clusterAccessors: make(map[client.ObjectKey]*clusterAccessor),
+		clusterLock:      newKeyedMutex(),
 	}
 
 	testCacheTracker.clusterAccessors[objKey] = &clusterAccessor{

diff --git a/internal/controllers/topology/cluster/cluster_controller_test.go b/internal/controllers/topology/cluster/cluster_controller_test.go
diff --git a/internal/controllers/topology/cluster/conditions_test.go b/internal/controllers/topology/cluster/conditions_test.go
diff --git a/internal/controllers/topology/cluster/reconcile_state_test.go b/internal/controllers/topology/cluster/reconcile_state_test.go
diff --git a/internal/controllers/topology/cluster/suite_test.go b/internal/controllers/topology/cluster/suite_test.go
@@ -24,6 +24,7 @@ import (
 	"time"
 
 	. "github.com/onsi/gomega"
+	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
@@ -33,6 +34,7 @@ import (
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/api/v1beta1/index"
+	"sigs.k8s.io/cluster-api/controllers/remote"
 	expv1 "sigs.k8s.io/cluster-api/exp/api/v1beta1"
 	"sigs.k8s.io/cluster-api/internal/controllers/clusterclass"
 	"sigs.k8s.io/cluster-api/internal/test/envtest"
@@ -49,6 +51,7 @@ func init() {
 	_ = clusterv1.AddToScheme(fakeScheme)
 	_ = apiextensionsv1.AddToScheme(fakeScheme)
 	_ = expv1.AddToScheme(fakeScheme)
+	_ = corev1.AddToScheme(fakeScheme)
 }
 func TestMain(m *testing.M) {
 	setupIndexes := func(ctx context.Context, mgr ctrl.Manager) {
@@ -62,6 +65,9 @@ func TestMain(m *testing.M) {
 		}
 	}
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
+		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
+		// requiring a connection to a remote cluster
+		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
 		unstructuredCachingClient, err := client.New(mgr.GetConfig(), client.Options{
 			Cache: &client.CacheOptions{
 				Reader:       mgr.GetCache(),
@@ -71,11 +77,37 @@ func TestMain(m *testing.M) {
 		if err != nil {
 			panic(fmt.Sprintf("unable to create unstructuredCachineClient: %v", err))
 		}
+		secretCachingClient, err := client.New(mgr.GetConfig(), client.Options{
+			HTTPClient: mgr.GetHTTPClient(),
+			Cache: &client.CacheOptions{
+				Reader: mgr.GetCache(),
+			},
+		})
+		if err != nil {
+			panic(fmt.Sprintf("unable to create secretCachingClient: %v", err))
+		}
+		tracker, err := remote.NewClusterCacheTracker(
+			mgr,
+			remote.ClusterCacheTrackerOptions{
+				Log:                 &log,
+				SecretCachingClient: secretCachingClient,
+			},
+		)
+		if err != nil {
+			panic(fmt.Sprintf("unable to create cluster cache tracker: %v", err))
+		}
+		if err := (&remote.ClusterCacheReconciler{
+			Client:  mgr.GetClient(),
+			Tracker: tracker,
+		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
+			panic(fmt.Sprintf("Failed to start ClusterCacheReconciler: %v", err))
+		}
 		if err := (&Reconciler{
 			Client:                    mgr.GetClient(),
 			APIReader:                 mgr.GetAPIReader(),
 			UnstructuredCachingClient: unstructuredCachingClient,
-		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 5}); err != nil {
+			Tracker:                   tracker,
+		}).SetupWithManager(ctx, mgr, controller.Options{MaxConcurrentReconciles: 1}); err != nil {
 			panic(fmt.Sprintf("unable to create topology cluster reconciler: %v", err))
 		}
 		if err := (&clusterclass.Reconciler{

diff --git a/internal/test/builder/builders.go b/internal/test/builder/builders.go
@@ -1440,15 +1440,16 @@ func (c *TestControlPlaneBuilder) Build() *unstructured.Unstructured {
 
 // MachinePoolBuilder holds the variables and objects needed to build a generic MachinePool.
 type MachinePoolBuilder struct {
-	namespace      string
-	name           string
-	bootstrap      *unstructured.Unstructured
-	infrastructure *unstructured.Unstructured
-	version        *string
-	clusterName    string
-	replicas       *int32
-	labels         map[string]string
-	status         *expv1.MachinePoolStatus
+	namespace       string
+	name            string
+	bootstrap       *unstructured.Unstructured
+	infrastructure  *unstructured.Unstructured
+	version         *string
+	clusterName     string
+	replicas        *int32
+	labels          map[string]string
+	status          *expv1.MachinePoolStatus
+	minReadySeconds *int32
 }
 
 // MachinePool creates a MachinePoolBuilder with the given name and namespace.
@@ -1501,6 +1502,12 @@ func (m *MachinePoolBuilder) WithStatus(status expv1.MachinePoolStatus) *Machine
 	return m
 }
 
+// WithMinReadySeconds sets the passed value on the machine pool spec.
+func (m *MachinePoolBuilder) WithMinReadySeconds(minReadySeconds int32) *MachinePoolBuilder {
+	m.minReadySeconds = &minReadySeconds
+	return m
+}
+
 // Build creates a new MachinePool with the variables and objects passed to the MachinePoolBuilder.
 func (m *MachinePoolBuilder) Build() *expv1.MachinePool {
 	obj := &expv1.MachinePool{
@@ -1514,8 +1521,15 @@ func (m *MachinePoolBuilder) Build() *expv1.MachinePool {
 			Labels:    m.labels,
 		},
 		Spec: expv1.MachinePoolSpec{
-			ClusterName: m.clusterName,
-			Replicas:    m.replicas,
+			ClusterName:     m.clusterName,
+			Replicas:        m.replicas,
+			MinReadySeconds: m.minReadySeconds,
+			Template: clusterv1.MachineTemplateSpec{
+				Spec: clusterv1.MachineSpec{
+					Version:     m.version,
+					ClusterName: m.clusterName,
+				},
+			},
 		},
 	}
 	if m.bootstrap != nil {
@@ -1524,9 +1538,6 @@ func (m *MachinePoolBuilder) Build() *expv1.MachinePool {
 	if m.infrastructure != nil {
 		obj.Spec.Template.Spec.InfrastructureRef = *objToRef(m.infrastructure)
 	}
-	if m.version != nil {
-		obj.Spec.Template.Spec.Version = m.version
-	}
 	if m.status != nil {
 		obj.Status = *m.status
 	}

diff --git a/internal/test/builder/infrastructure.go b/internal/test/builder/infrastructure.go
@@ -70,9 +70,13 @@ var (
 
 	// TestInfrastructureMachinePoolTemplateKind is the kind for the TestInfrastructureMachinePoolTemplate type.
 	TestInfrastructureMachinePoolTemplateKind = "TestInfrastructureMachinePoolTemplate"
+	// TestInfrastructureMachinePoolTemplateCRD is a test infrastructure machine template CRD.
+	TestInfrastructureMachinePoolTemplateCRD = testInfrastructureMachinePoolTemplateCRD(InfrastructureGroupVersion.WithKind(TestInfrastructureMachinePoolTemplateKind))
 
 	// TestInfrastructureMachinePoolKind is the kind for the TestInfrastructureMachinePool type.
 	TestInfrastructureMachinePoolKind = "TestInfrastructureMachinePool"
+	// TestInfrastructureMachinePoolCRD is a test infrastructure machine CRD.
+	TestInfrastructureMachinePoolCRD = testInfrastructureMachinePoolCRD(InfrastructureGroupVersion.WithKind(TestInfrastructureMachinePoolKind))
 
 	// TestInfrastructureMachineKind is the kind for the TestInfrastructureMachine type.
 	TestInfrastructureMachineKind = "TestInfrastructureMachine"
@@ -147,6 +151,30 @@ func testInfrastructureMachineTemplateCRD(gvk schema.GroupVersionKind) *apiexten
 	})
 }
 
+func testInfrastructureMachinePoolTemplateCRD(gvk schema.GroupVersionKind) *apiextensionsv1.CustomResourceDefinition {
+	return generateCRD(gvk, map[string]apiextensionsv1.JSONSchemaProps{
+		"metadata": {
+			// NOTE: in CRD there is only a partial definition of metadata schema.
+			// Ref https://github.com/kubernetes-sigs/controller-tools/blob/59485af1c1f6a664655dad49543c474bb4a0d2a2/pkg/crd/gen.go#L185
+			Type: "object",
+		},
+		"spec": {
+			Type: "object",
+			Properties: map[string]apiextensionsv1.JSONSchemaProps{
+				// Mandatory field from the Cluster API contract
+				"template": {
+					Type: "object",
+					Properties: map[string]apiextensionsv1.JSONSchemaProps{
+						"clusterName": {Type: "string"},
+						"metadata":    metadataSchema,
+						"spec":        machineSpecSchema,
+					},
+				},
+			},
+		},
+	})
+}
+
 func testInfrastructureMachineCRD(gvk schema.GroupVersionKind) *apiextensionsv1.CustomResourceDefinition {
 	return generateCRD(gvk, map[string]apiextensionsv1.JSONSchemaProps{
 		"metadata": {
@@ -168,6 +196,27 @@ func testInfrastructureMachineCRD(gvk schema.GroupVersionKind) *apiextensionsv1.
 	})
 }
 
+func testInfrastructureMachinePoolCRD(gvk schema.GroupVersionKind) *apiextensionsv1.CustomResourceDefinition {
+	return generateCRD(gvk, map[string]apiextensionsv1.JSONSchemaProps{
+		"metadata": {
+			// NOTE: in CRD there is only a partial definition of metadata schema.
+			// Ref https://github.com/kubernetes-sigs/controller-tools/blob/59485af1c1f6a664655dad49543c474bb4a0d2a2/pkg/crd/gen.go#L185
+			Type: "object",
+		},
+		"spec": machinePoolSpecSchema,
+		"status": {
+			Type: "object",
+			Properties: map[string]apiextensionsv1.JSONSchemaProps{
+				// mandatory field from the Cluster API contract
+				"ready": {Type: "boolean"},
+				// General purpose fields to be used in different test scenario.
+				"foo": {Type: "string"},
+				"bar": {Type: "string"},
+			},
+		},
+	})
+}
+
 var (
 	clusterSpecSchema = apiextensionsv1.JSONSchemaProps{
 		Type: "object",
@@ -215,4 +264,30 @@ var (
 			"bar": {Type: "string"},
 		},
 	}
+
+	machinePoolSpecSchema = apiextensionsv1.JSONSchemaProps{
+		Type: "object",
+		Properties: map[string]apiextensionsv1.JSONSchemaProps{
+			// Mandatory field from the Cluster API contract
+			"providerIDList": {
+				Type: "array",
+				Items: &apiextensionsv1.JSONSchemaPropsOrArray{
+					Schema: &apiextensionsv1.JSONSchemaProps{
+						Type: "string",
+					},
+				},
+			},
+			"template": {
+				Type: "object",
+				Properties: map[string]apiextensionsv1.JSONSchemaProps{
+					"metadata": metadataSchema,
+					"spec":     machineSpecSchema,
+				},
+			},
+			"clusterName": {Type: "string"},
+			// General purpose fields to be used in different test scenario.
+			"foo": {Type: "string"},
+			"bar": {Type: "string"},
+		},
+	}
 )
diff --git a/internal/test/builder/zz_generated.deepcopy.go b/internal/test/builder/zz_generated.deepcopy.go
diff --git a/internal/test/envtest/environment.go b/internal/test/envtest/environment.go
@@ -219,6 +219,8 @@ func newEnvironment(uncachedObjs ...client.Object) *Environment {
 			builder.TestInfrastructureClusterTemplateCRD.DeepCopy(),
 			builder.TestInfrastructureClusterCRD.DeepCopy(),
 			builder.TestInfrastructureMachineTemplateCRD.DeepCopy(),
+			builder.TestInfrastructureMachinePoolCRD.DeepCopy(),
+			builder.TestInfrastructureMachinePoolTemplateCRD.DeepCopy(),
 			builder.TestInfrastructureMachineCRD.DeepCopy(),
 			builder.TestBootstrapConfigTemplateCRD.DeepCopy(),
 			builder.TestBootstrapConfigCRD.DeepCopy(),