Add basic e2e test for example shard

test/e2e/example_test.go

@@ -0,0 +1,148 @@
+/*
+Copyright 2024 Tim Ebert.
+
+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 e2e
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gstruct"
+	appsv1 "k8s.io/api/apps/v1"
+	coordinationv1 "k8s.io/api/coordination/v1"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	shardingv1alpha1 "github.com/timebertt/kubernetes-controller-sharding/pkg/apis/sharding/v1alpha1"
+	"github.com/timebertt/kubernetes-controller-sharding/pkg/test"
+	. "github.com/timebertt/kubernetes-controller-sharding/pkg/test/komega"
+	. "github.com/timebertt/kubernetes-controller-sharding/pkg/test/matchers"
+)
+
+var _ = Describe("Example Shard", Label("example"), Ordered, func() {
+	const clusterRingName = "example"
+
+	var (
+		clusterRing *shardingv1alpha1.ClusterRing
+	)
+
+	BeforeAll(func() {
+		clusterRing = &shardingv1alpha1.ClusterRing{ObjectMeta: metav1.ObjectMeta{Name: clusterRingName}}
+	})
+
+	Describe("setup", func() {
+		It("the Deployment should be healthy", func(ctx SpecContext) {
+			deployment := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Name: "shard", Namespace: metav1.NamespaceDefault}}
+
+			Eventually(ctx, func(g Gomega) {
+				g.Expect(Get(deployment)(ctx)).To(Succeed())
+				g.Expect(deployment.Spec.Replicas).To(PointTo(BeEquivalentTo(3)))
+				g.Expect(deployment.Status.AvailableReplicas).To(BeEquivalentTo(3))
+			}).Should(Succeed())
+		}, SpecTimeout(ShortTimeout))
+
+		It("there should be 3 ready shard leases", func(ctx SpecContext) {
+			leaseList := &coordinationv1.LeaseList{}
+
+			Eventually(ctx, func(g Gomega) {
+				g.Expect(List(leaseList, client.InNamespace(metav1.NamespaceDefault), client.MatchingLabels{
+					shardingv1alpha1.LabelClusterRing: clusterRingName,
+				})(ctx)).To(Succeed())
+				g.Expect(leaseList.Items).To(And(
+					HaveLen(3),
+					HaveEach(HaveLabelWithValue(shardingv1alpha1.LabelState, "ready")),
+				))
+			}).Should(Succeed())
+		}, SpecTimeout(ShortTimeout))
+
+		It("the ClusterRing should be healthy", func(ctx SpecContext) {
+			Eventually(ctx, func(g Gomega) {
+				g.Expect(Get(clusterRing)(ctx)).To(Succeed())
+				g.Expect(clusterRing.Status.Shards).To(BeEquivalentTo(3))
+				g.Expect(clusterRing.Status.AvailableShards).To(BeEquivalentTo(3))
+				g.Expect(clusterRing.Status.Conditions).To(ConsistOf(
+					MatchCondition(
+						OfType(shardingv1alpha1.ClusterRingReady),
+						WithStatus(metav1.ConditionTrue),
+					),
+				))
+			}).Should(Succeed())
+		}, SpecTimeout(ShortTimeout))
+	})
+
+	Describe("creating objects", func() {
+		var (
+			configMap *corev1.ConfigMap
+			shard     string
+		)
+
+		BeforeAll(func() {
+			configMap = &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{
+				Name:      "foo-" + test.RandomSuffix(),
+				Namespace: metav1.NamespaceDefault,
+			}}
+
+			DeferCleanup(func(ctx SpecContext) {
+				Eventually(ctx, func() error {
+					return testClient.Delete(ctx, configMap)
+				}).Should(BeNotFoundError())
+				log.Info("Deleted object", "configMap", client.ObjectKeyFromObject(configMap))
+			}, NodeTimeout(ShortTimeout))
+		})
+
+		It("should assign the main object to a healthy shard", func(ctx SpecContext) {
+			shards := getReadyShards(ctx, clusterRingName)
+
+			Expect(testClient.Create(ctx, configMap)).To(Succeed())
+			log.Info("Created object", "configMap", client.ObjectKeyFromObject(configMap))
+
+			shard = configMap.Labels[clusterRing.LabelShard()]
+			Expect(shard).To(BeElementOf(shards))
+			Expect(configMap).NotTo(HaveLabel(clusterRing.LabelDrain()))
+		}, SpecTimeout(ShortTimeout))
+
+		It("should assign the controlled object to the same shard", func(ctx SpecContext) {
+			secret := &corev1.Secret{}
+			secret.Name = "dummy-" + configMap.Name
+			secret.Namespace = configMap.Namespace
+
+			Eventually(ctx, Object(secret)).Should(And(
+				HaveLabelWithValue(clusterRing.LabelShard(), Equal(shard)),
+				Not(HaveLabel(clusterRing.LabelDrain())),
+			))
+		}, SpecTimeout(ShortTimeout))
+	})
+})
+
+func getReadyShards(ctx SpecContext, clusterRingName string) []string {
+	GinkgoHelper()
+
+	leaseList := &coordinationv1.LeaseList{}
+	Eventually(ctx, List(leaseList, client.InNamespace(metav1.NamespaceDefault), client.MatchingLabels{
+		shardingv1alpha1.LabelClusterRing: clusterRingName,
+		shardingv1alpha1.LabelState:       "ready",
+	})).Should(Succeed())
+
+	return toShardNames(leaseList.Items)
+}
+
+func toShardNames(leaseList []coordinationv1.Lease) []string {
+	out := make([]string, len(leaseList))
+	for i, lease := range leaseList {
+		out[i] = lease.Name
+	}
+	return out
+}