sigs.k8s.io/kueue@v0.6.2/test/integration/controller/jobs/pod/pod_webhook_test.go

/*
Copyright 2023 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 pod

import (
	"github.com/onsi/ginkgo/v2"
	"github.com/onsi/gomega"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/types"
	"k8s.io/client-go/discovery"

	configapi "sigs.k8s.io/kueue/apis/config/v1beta1"
	"sigs.k8s.io/kueue/pkg/controller/jobframework"
	"sigs.k8s.io/kueue/pkg/util/kubeversion"
	testingpod "sigs.k8s.io/kueue/pkg/util/testingjobs/pod"
	"sigs.k8s.io/kueue/test/integration/framework"
	"sigs.k8s.io/kueue/test/util"
)

var _ = ginkgo.Describe("Pod Webhook", func() {
	var ns *corev1.Namespace

	ginkgo.When("with manageJobsWithoutQueueName disabled", ginkgo.Ordered, ginkgo.ContinueOnFailure, func() {
		ginkgo.BeforeAll(func() {
			fwk = &framework.Framework{
				CRDPath:     crdPath,
				WebhookPath: webhookPath,
			}
			cfg = fwk.Init()

			discoveryClient, err := discovery.NewDiscoveryClientForConfig(cfg)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			serverVersionFetcher = kubeversion.NewServerVersionFetcher(discoveryClient)
			err = serverVersionFetcher.FetchServerVersion()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			ctx, k8sClient = fwk.RunManager(cfg, managerSetup(
				jobframework.WithManageJobsWithoutQueueName(false),
				jobframework.WithKubeServerVersion(serverVersionFetcher),
				jobframework.WithIntegrationOptions(corev1.SchemeGroupVersion.WithKind("Pod").String(), &configapi.PodIntegrationOptions{
					PodSelector: &metav1.LabelSelector{},
					NamespaceSelector: &metav1.LabelSelector{
						MatchExpressions: []metav1.LabelSelectorRequirement{
							{
								Key:      "kubernetes.io/metadata.name",
								Operator: metav1.LabelSelectorOpNotIn,
								Values:   []string{"kube-system", "kueue-system"},
							},
						},
					},
				}),
			))
		})
		ginkgo.BeforeEach(func() {
			ns = &corev1.Namespace{
				ObjectMeta: metav1.ObjectMeta{
					GenerateName: "pod-",
				},
			}
			gomega.Expect(k8sClient.Create(ctx, ns)).To(gomega.Succeed())
		})

		ginkgo.AfterEach(func() {
			gomega.Expect(util.DeleteNamespace(ctx, k8sClient, ns)).To(gomega.Succeed())
		})
		ginkgo.AfterAll(func() {
			fwk.Teardown()
		})

		ginkgo.When("The queue-name label is set", func() {
			var (
				pod       *corev1.Pod
				lookupKey types.NamespacedName
			)

			ginkgo.BeforeEach(func() {
				pod = testingpod.MakePod("pod-with-queue-name", ns.Name).Queue("user-queue").Obj()
				lookupKey = types.NamespacedName{Name: pod.Name, Namespace: pod.Namespace}
			})

			ginkgo.It("Should inject scheduling gate, 'managed' label and finalizer into created pod", func() {
				gomega.Expect(k8sClient.Create(ctx, pod)).Should(gomega.Succeed())

				createdPod := &corev1.Pod{}
				gomega.Eventually(func() error {
					return k8sClient.Get(ctx, lookupKey, createdPod)
				}, util.Timeout, util.Interval).Should(gomega.Succeed())

				gomega.Expect(createdPod.Spec.SchedulingGates).To(
					gomega.ContainElement(corev1.PodSchedulingGate{Name: "kueue.x-k8s.io/admission"}),
					"Pod should have scheduling gate",
				)

				gomega.Expect(createdPod.Labels).To(
					gomega.HaveKeyWithValue("kueue.x-k8s.io/managed", "true"),
					"Pod should have the label",
				)

				gomega.Expect(createdPod.Finalizers).To(gomega.ContainElement("kueue.x-k8s.io/managed"),
					"Pod should have finalizer set")
			})

			ginkgo.It("Should skip a Pod created in the forbidden 'kube-system' namespace", func() {
				pod.Namespace = "kube-system"
				gomega.Expect(k8sClient.Create(ctx, pod)).Should(gomega.Succeed())

				lookupKey := types.NamespacedName{Name: pod.Name, Namespace: "kube-system"}
				createdPod := &corev1.Pod{}
				gomega.Eventually(func() error {
					return k8sClient.Get(ctx, lookupKey, createdPod)
				}, util.Timeout, util.Interval).Should(gomega.Succeed())

				gomega.Expect(createdPod.Spec.SchedulingGates).NotTo(
					gomega.ContainElement(corev1.PodSchedulingGate{Name: "kueue.x-k8s.io/admission"}),
					"Pod shouldn't have scheduling gate",
				)

				gomega.Expect(createdPod.Labels).NotTo(
					gomega.HaveKeyWithValue("kueue.x-k8s.io/managed", "true"),
					"Pod shouldn't have the label",
				)

				gomega.Expect(createdPod.Finalizers).NotTo(gomega.ContainElement("kueue.x-k8s.io/managed"),
					"Pod shouldn't have finalizer set")
			})
		})

		ginkgo.When("The queue-name label is not set", func() {
			var (
				pod       *corev1.Pod
				lookupKey types.NamespacedName
			)

			ginkgo.BeforeEach(func() {
				pod = testingpod.MakePod("pod-with-queue-name", ns.Name).Obj()
				lookupKey = types.NamespacedName{Name: pod.Name, Namespace: pod.Namespace}
			})

			ginkgo.It("Should not inject scheduling gate, 'managed' label and finalizer into created pod", func() {
				gomega.Expect(k8sClient.Create(ctx, pod)).Should(gomega.Succeed())

				createdPod := &corev1.Pod{}
				gomega.Eventually(func() error {
					return k8sClient.Get(ctx, lookupKey, createdPod)
				}, util.Timeout, util.Interval).Should(gomega.Succeed())

				gomega.Expect(createdPod.Spec.SchedulingGates).NotTo(
					gomega.ContainElement(corev1.PodSchedulingGate{Name: "kueue.x-k8s.io/admission"}),
					"Pod shouldn't have scheduling gate",
				)

				gomega.Expect(createdPod.Labels).NotTo(
					gomega.HaveKeyWithValue("kueue.x-k8s.io/managed", "true"),
					"Pod shouldn't have the label",
				)

				gomega.Expect(createdPod.Finalizers).NotTo(gomega.ContainElement("kueue.x-k8s.io/managed"),
					"Pod shouldn't have finalizer set")
			})
		})
	})

	ginkgo.When("with manageJobsWithoutQueueName enabled", ginkgo.Ordered, ginkgo.ContinueOnFailure, func() {
		ginkgo.BeforeAll(func() {
			fwk = &framework.Framework{
				CRDPath:     crdPath,
				WebhookPath: webhookPath,
			}
			cfg = fwk.Init()

			discoveryClient, err := discovery.NewDiscoveryClientForConfig(cfg)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			serverVersionFetcher = kubeversion.NewServerVersionFetcher(discoveryClient)
			err = serverVersionFetcher.FetchServerVersion()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			ctx, k8sClient = fwk.RunManager(cfg, managerSetup(
				jobframework.WithManageJobsWithoutQueueName(true),
				jobframework.WithKubeServerVersion(serverVersionFetcher),
				jobframework.WithIntegrationOptions(corev1.SchemeGroupVersion.WithKind("Pod").String(), &configapi.PodIntegrationOptions{
					PodSelector: &metav1.LabelSelector{},
					NamespaceSelector: &metav1.LabelSelector{
						MatchExpressions: []metav1.LabelSelectorRequirement{
							{
								Key:      "kubernetes.io/metadata.name",
								Operator: metav1.LabelSelectorOpNotIn,
								Values:   []string{"kube-system", "kueue-system"},
							},
						},
					},
				}),
			))
		})
		ginkgo.BeforeEach(func() {
			ns = &corev1.Namespace{
				ObjectMeta: metav1.ObjectMeta{
					GenerateName: "pod-",
				},
			}
			gomega.Expect(k8sClient.Create(ctx, ns)).To(gomega.Succeed())
		})

		ginkgo.AfterEach(func() {
			gomega.Expect(util.DeleteNamespace(ctx, k8sClient, ns)).To(gomega.Succeed())
		})
		ginkgo.AfterAll(func() {
			fwk.Teardown()
		})

		ginkgo.When("The queue-name label is not set", func() {
			var pod *corev1.Pod

			ginkgo.BeforeEach(func() {
				pod = testingpod.MakePod("pod-integration", ns.Name).Obj()
			})

			ginkgo.It("Should inject scheduling gate, 'managed' label and finalizer into created pod", func() {
				gomega.Expect(k8sClient.Create(ctx, pod)).Should(gomega.Succeed())

				lookupKey := types.NamespacedName{Name: pod.Name, Namespace: pod.Namespace}
				createdPod := &corev1.Pod{}
				gomega.Eventually(func() error {
					return k8sClient.Get(ctx, lookupKey, createdPod)
				}, util.Timeout, util.Interval).Should(gomega.Succeed())

				gomega.Expect(createdPod.Spec.SchedulingGates).To(
					gomega.ContainElement(corev1.PodSchedulingGate{Name: "kueue.x-k8s.io/admission"}),
					"Pod should have scheduling gate",
				)

				gomega.Expect(createdPod.Labels).To(
					gomega.HaveKeyWithValue("kueue.x-k8s.io/managed", "true"),
					"Pod should have the label",
				)

				gomega.Expect(createdPod.Finalizers).To(gomega.ContainElement("kueue.x-k8s.io/managed"),
					"Pod should have finalizer set")
			})

			ginkgo.It("Should skip a Pod created in the forbidden 'kube-system' namespace", func() {
				pod.Namespace = "kube-system"
				gomega.Expect(k8sClient.Create(ctx, pod)).Should(gomega.Succeed())

				lookupKey := types.NamespacedName{Name: pod.Name, Namespace: "kube-system"}
				createdPod := &corev1.Pod{}
				gomega.Eventually(func() error {
					return k8sClient.Get(ctx, lookupKey, createdPod)
				}, util.Timeout, util.Interval).Should(gomega.Succeed())

				gomega.Expect(createdPod.Spec.SchedulingGates).NotTo(
					gomega.ContainElement(corev1.PodSchedulingGate{Name: "kueue.x-k8s.io/admission"}),
					"Pod shouldn't have scheduling gate",
				)

				gomega.Expect(createdPod.Labels).NotTo(
					gomega.HaveKeyWithValue("kueue.x-k8s.io/managed", "true"),
					"Pod shouldn't have the label",
				)

				gomega.Expect(createdPod.Finalizers).NotTo(gomega.ContainElement("kueue.x-k8s.io/managed"),
					"Pod shouldn't have finalizer set")
			})
		})
	})
})