Skip to content

🌱 Implement unit-tests for desired state generator #12656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🌱 Implement unit-tests for desired state generator #12656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions exp/topology/desiredstate/desired_state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,14 @@ import (
utilfeature "k8s.io/component-base/featuregate/testing"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"

clusterv1beta1 "sigs.k8s.io/cluster-api/api/core/v1beta1"
clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
runtimehooksv1 "sigs.k8s.io/cluster-api/api/runtime/hooks/v1alpha1"
runtimev1 "sigs.k8s.io/cluster-api/api/runtime/v1beta2"
"sigs.k8s.io/cluster-api/controllers/clustercache"
runtimecatalog "sigs.k8s.io/cluster-api/exp/runtime/catalog"
"sigs.k8s.io/cluster-api/exp/topology/scope"
"sigs.k8s.io/cluster-api/feature"
Expand Down Expand Up @@ -3607,6 +3609,97 @@ func TestCalculateRefDesiredAPIVersion(t *testing.T) {
}
}

func TestGenerate(t *testing.T) {
// templates and ClusterClass
infrastructureClusterTemplate := builder.InfrastructureClusterTemplate(metav1.NamespaceDefault, "template1").
Build()
controlPlaneTemplate := builder.ControlPlaneTemplate(metav1.NamespaceDefault, "template1").
Build()
clusterClass := builder.ClusterClass(metav1.NamespaceDefault, "class1").
WithInfrastructureClusterTemplate(infrastructureClusterTemplate).
WithControlPlaneTemplate(controlPlaneTemplate).
Build()

// aggregating templates and cluster class into a blueprint
blueprint := &scope.ClusterBlueprint{
ClusterClass: clusterClass,
InfrastructureClusterTemplate: infrastructureClusterTemplate,
ControlPlane: &scope.ControlPlaneBlueprint{
Template: controlPlaneTemplate,
},
}

// current cluster objects
cluster := &clusterv1.Cluster{
ObjectMeta: metav1.ObjectMeta{
Name: "cluster1",
Namespace: metav1.NamespaceDefault,
},
}

version := "v1.33.0"
workerInfrastructureMachinePool := builder.InfrastructureMachinePoolTemplate(metav1.NamespaceDefault, "linux-worker-inframachinepool").
Build()
workerBootstrapConfig := builder.BootstrapTemplate(metav1.NamespaceDefault, "linux-worker-bootstrap").
Build()

node := &corev1.Node{
ObjectMeta: metav1.ObjectMeta{
Name: "node-0",
},
}
crd := builder.GenericControlPlaneCRD.DeepCopy()

t.Run("Generate desired state", func(t *testing.T) {
g := NewWithT(t)

fakeClient := fake.NewClientBuilder().WithScheme(fakeScheme).WithObjects(node, crd).Build()
fakeRuntimeClient := fakeruntimeclient.NewRuntimeClientBuilder().Build()
clusterCache := clustercache.NewFakeClusterCache(fakeClient, client.ObjectKey{Name: cluster.Name, Namespace: cluster.Namespace})

desiredStateGenerator := NewGenerator(
fakeClient,
clusterCache,
fakeRuntimeClient,
)

s := scope.New(cluster)
s.Blueprint = blueprint

mp := builder.MachinePool(metav1.NamespaceDefault, "existing-pool").
WithVersion(version).
WithReplicas(3).
WithBootstrap(workerBootstrapConfig).
WithInfrastructure(workerInfrastructureMachinePool).
WithStatus(clusterv1.MachinePoolStatus{
NodeRefs: []corev1.ObjectReference{
{
Kind: "Node",
Namespace: metav1.NamespaceDefault,
Name: "node-0",
},
},
}).
Build()

s.Current.MachinePools = map[string]*scope.MachinePoolState{
"pool-of-machines": {
Object: mp,
BootstrapObject: workerBootstrapConfig,
InfrastructureMachinePoolObject: workerInfrastructureMachinePool,
},
}

// Get the desired state.
desiredState, err := desiredStateGenerator.Generate(ctx, s)
g.Expect(err).ToNot(HaveOccurred())
g.Expect(desiredState).ToNot(BeNil())
g.Expect(desiredState.Cluster).ToNot(BeNil())
g.Expect(desiredState.InfrastructureCluster).ToNot(BeNil())
g.Expect(desiredState.ControlPlane).ToNot(BeNil())
})
}

func validateClusterParameter(originalCluster *clusterv1.Cluster) func(req runtimehooksv1.RequestObject) error {
// return a func that allows to check if expected transformations are applied to the Cluster parameter which is
// included in the payload for lifecycle hooks calls.
Expand Down