sigs.k8s.io/cluster-api@v1.7.1/bootstrap/util/configowner_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 util

import (
	"context"
	"testing"

	. "github.com/onsi/gomega"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/utils/ptr"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/client/fake"

	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
	bootstrapv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1"
	expv1 "sigs.k8s.io/cluster-api/exp/api/v1beta1"
	"sigs.k8s.io/cluster-api/feature"
)

func TestGetConfigOwner(t *testing.T) {
	doTests := func(t *testing.T, getFn func(context.Context, client.Client, metav1.Object) (*ConfigOwner, error)) {
		t.Helper()

		t.Run("should get the owner when present (Machine)", func(t *testing.T) {
			g := NewWithT(t)
			myMachine := &clusterv1.Machine{
				ObjectMeta: metav1.ObjectMeta{
					Name:      "my-machine",
					Namespace: metav1.NamespaceDefault,
					Labels: map[string]string{
						clusterv1.MachineControlPlaneLabel: "",
					},
				},
				Spec: clusterv1.MachineSpec{
					ClusterName: "my-cluster",
					Bootstrap: clusterv1.Bootstrap{
						DataSecretName: ptr.To("my-data-secret"),
					},
					Version: ptr.To("v1.19.6"),
				},
				Status: clusterv1.MachineStatus{
					InfrastructureReady: true,
				},
			}

			c := fake.NewClientBuilder().WithObjects(myMachine).Build()
			obj := &bootstrapv1.KubeadmConfig{
				ObjectMeta: metav1.ObjectMeta{
					OwnerReferences: []metav1.OwnerReference{
						{
							Kind:       "Machine",
							APIVersion: clusterv1.GroupVersion.String(),
							Name:       "my-machine",
						},
					},
					Namespace: metav1.NamespaceDefault,
					Name:      "my-resource-owned-by-machine",
				},
			}
			configOwner, err := getFn(ctx, c, obj)
			g.Expect(err).ToNot(HaveOccurred())
			g.Expect(configOwner).ToNot(BeNil())
			g.Expect(configOwner.ClusterName()).To(BeEquivalentTo("my-cluster"))
			g.Expect(configOwner.IsInfrastructureReady()).To(BeTrue())
			g.Expect(configOwner.IsControlPlaneMachine()).To(BeTrue())
			g.Expect(configOwner.IsMachinePool()).To(BeFalse())
			g.Expect(configOwner.KubernetesVersion()).To(Equal("v1.19.6"))
			g.Expect(*configOwner.DataSecretName()).To(BeEquivalentTo("my-data-secret"))
		})

		t.Run("should get the owner when present (MachinePool)", func(t *testing.T) {
			_ = feature.MutableGates.Set("MachinePool=true")

			g := NewWithT(t)
			myPool := &expv1.MachinePool{
				ObjectMeta: metav1.ObjectMeta{
					Name:      "my-machine-pool",
					Namespace: metav1.NamespaceDefault,
					Labels: map[string]string{
						clusterv1.MachineControlPlaneLabel: "",
					},
				},
				Spec: expv1.MachinePoolSpec{
					ClusterName: "my-cluster",
					Template: clusterv1.MachineTemplateSpec{
						Spec: clusterv1.MachineSpec{
							Version: ptr.To("v1.19.6"),
						},
					},
				},
				Status: expv1.MachinePoolStatus{
					InfrastructureReady: true,
				},
			}

			c := fake.NewClientBuilder().WithObjects(myPool).Build()
			obj := &bootstrapv1.KubeadmConfig{
				ObjectMeta: metav1.ObjectMeta{
					OwnerReferences: []metav1.OwnerReference{
						{
							Kind:       "MachinePool",
							APIVersion: expv1.GroupVersion.String(),
							Name:       "my-machine-pool",
						},
					},
					Namespace: metav1.NamespaceDefault,
					Name:      "my-resource-owned-by-machine-pool",
				},
			}
			configOwner, err := getFn(ctx, c, obj)
			g.Expect(err).ToNot(HaveOccurred())
			g.Expect(configOwner).ToNot(BeNil())
			g.Expect(configOwner.ClusterName()).To(BeEquivalentTo("my-cluster"))
			g.Expect(configOwner.IsInfrastructureReady()).To(BeTrue())
			g.Expect(configOwner.IsControlPlaneMachine()).To(BeFalse())
			g.Expect(configOwner.IsMachinePool()).To(BeTrue())
			g.Expect(configOwner.KubernetesVersion()).To(Equal("v1.19.6"))
			g.Expect(configOwner.DataSecretName()).To(BeNil())
		})

		t.Run("return an error when not found", func(t *testing.T) {
			g := NewWithT(t)
			c := fake.NewClientBuilder().Build()
			obj := &bootstrapv1.KubeadmConfig{
				ObjectMeta: metav1.ObjectMeta{
					OwnerReferences: []metav1.OwnerReference{
						{
							Kind:       "Machine",
							APIVersion: clusterv1.GroupVersion.String(),
							Name:       "my-machine",
						},
					},
					Namespace: metav1.NamespaceDefault,
					Name:      "my-resource-owned-by-machine",
				},
			}
			_, err := getFn(ctx, c, obj)
			g.Expect(err).To(HaveOccurred())
		})

		t.Run("return nothing when there is no owner", func(t *testing.T) {
			g := NewWithT(t)
			c := fake.NewClientBuilder().Build()
			obj := &bootstrapv1.KubeadmConfig{
				ObjectMeta: metav1.ObjectMeta{
					OwnerReferences: []metav1.OwnerReference{},
					Namespace:       metav1.NamespaceDefault,
					Name:            "my-resource-owned-by-machine",
				},
			}
			configOwner, err := getFn(ctx, c, obj)
			g.Expect(err).ToNot(HaveOccurred())
			g.Expect(configOwner).To(BeNil())
		})
	}
	t.Run("uncached", func(t *testing.T) {
		doTests(t, GetConfigOwner)
	})
	t.Run("cached", func(t *testing.T) {
		doTests(t, GetTypedConfigOwner)
	})
}

func TestHasNodeRefs(t *testing.T) {
	t.Run("should return false if there is no nodeRef", func(t *testing.T) {
		g := NewWithT(t)
		machine := &clusterv1.Machine{
			TypeMeta: metav1.TypeMeta{
				APIVersion: clusterv1.GroupVersion.String(),
				Kind:       "Machine",
			},
			ObjectMeta: metav1.ObjectMeta{
				Name:      "machine-name",
				Namespace: metav1.NamespaceDefault,
			},
		}
		content, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&machine)
		if err != nil {
			g.Fail(err.Error())
		}
		unstructuredOwner := unstructured.Unstructured{}
		unstructuredOwner.SetUnstructuredContent(content)
		co := ConfigOwner{&unstructuredOwner}
		result := co.HasNodeRefs()
		g.Expect(result).To(BeFalse())
	})
	t.Run("should return true if there is a nodeRef for Machine", func(t *testing.T) {
		g := NewWithT(t)
		machine := &clusterv1.Machine{
			TypeMeta: metav1.TypeMeta{
				APIVersion: clusterv1.GroupVersion.String(),
				Kind:       "Machine",
			},
			ObjectMeta: metav1.ObjectMeta{
				Name:      "machine-name",
				Namespace: metav1.NamespaceDefault,
			},
			Status: clusterv1.MachineStatus{
				InfrastructureReady: true,
				NodeRef: &corev1.ObjectReference{
					Kind:      "Node",
					Namespace: metav1.NamespaceDefault,
					Name:      "node-0",
				},
			},
		}
		content, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&machine)
		if err != nil {
			g.Fail(err.Error())
		}
		unstructuredOwner := unstructured.Unstructured{}
		unstructuredOwner.SetUnstructuredContent(content)
		co := ConfigOwner{&unstructuredOwner}

		result := co.HasNodeRefs()
		g.Expect(result).To(BeTrue())
	})
	t.Run("should return false if nodes are missing from MachinePool", func(t *testing.T) {
		g := NewWithT(t)
		machinePools := []expv1.MachinePool{
			{
				// No replicas specified (default is 1). No nodeRefs either.
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
			},
			{
				// 1 replica but no nodeRefs
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
				Spec: expv1.MachinePoolSpec{
					Replicas: ptr.To[int32](1),
				},
			},
			{
				// 2 replicas but only 1 nodeRef
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
				Spec: expv1.MachinePoolSpec{
					Replicas: ptr.To[int32](2),
				},
				Status: expv1.MachinePoolStatus{
					NodeRefs: []corev1.ObjectReference{
						{
							Kind:      "Node",
							Namespace: metav1.NamespaceDefault,
							Name:      "node-0",
						},
					},
				},
			},
		}

		for i := range machinePools {
			content, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&machinePools[i])
			if err != nil {
				g.Fail(err.Error())
			}
			unstructuredOwner := unstructured.Unstructured{}
			unstructuredOwner.SetUnstructuredContent(content)
			co := ConfigOwner{&unstructuredOwner}

			result := co.HasNodeRefs()
			g.Expect(result).To(BeFalse())
		}
	})
	t.Run("should return true if MachinePool has nodeRefs for all replicas", func(t *testing.T) {
		g := NewWithT(t)
		machinePools := []expv1.MachinePool{
			{
				// 1 replica (default) and 1 nodeRef
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
				Status: expv1.MachinePoolStatus{
					NodeRefs: []corev1.ObjectReference{
						{
							Kind:      "Node",
							Namespace: metav1.NamespaceDefault,
							Name:      "node-0",
						},
					},
				},
			},
			{
				// 2 replicas and nodeRefs
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
				Spec: expv1.MachinePoolSpec{
					Replicas: ptr.To[int32](2),
				},
				Status: expv1.MachinePoolStatus{
					NodeRefs: []corev1.ObjectReference{
						{
							Kind:      "Node",
							Namespace: metav1.NamespaceDefault,
							Name:      "node-0",
						},
						{
							Kind:      "Node",
							Namespace: metav1.NamespaceDefault,
							Name:      "node-1",
						},
					},
				},
			},
			{
				// 0 replicas and 0 nodeRef
				TypeMeta: metav1.TypeMeta{
					APIVersion: expv1.GroupVersion.String(),
					Kind:       "MachinePool",
				},
				ObjectMeta: metav1.ObjectMeta{
					Namespace: metav1.NamespaceDefault,
					Name:      "machine-pool-name",
				},
				Spec: expv1.MachinePoolSpec{
					Replicas: ptr.To[int32](0),
				},
			},
		}

		for i := range machinePools {
			content, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&machinePools[i])
			if err != nil {
				g.Fail(err.Error())
			}
			unstructuredOwner := unstructured.Unstructured{}
			unstructuredOwner.SetUnstructuredContent(content)
			co := ConfigOwner{&unstructuredOwner}

			result := co.HasNodeRefs()
			g.Expect(result).To(BeTrue())
		}
	})
}