Add unit tests for sharding API

Author: timebertt

pkg/apis/sharding/v1alpha1/constants_test.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2025 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 v1alpha1_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	. "github.com/timebertt/kubernetes-controller-sharding/pkg/apis/sharding/v1alpha1"
+)
+
+var _ = Describe("#LabelShard", func() {
+	It("should append the ControllerRing name", func() {
+		Expect(LabelShard("foo")).To(Equal("shard.alpha.sharding.timebertt.dev/foo"))
+	})
+})
+
+var _ = Describe("#LabelDrain", func() {
+	It("should append the ControllerRing name", func() {
+		Expect(LabelDrain("foo")).To(Equal("drain.alpha.sharding.timebertt.dev/foo"))
+	})
+})

pkg/apis/sharding/v1alpha1/types_controllerring.go

@@ -131,7 +131,7 @@ func (c *ControllerRing) LabelDrain() string {
 	return LabelDrain(c.Name)
 }
 
-// RingResources returns the the list of resources that are distributed across shards in this ControllerRing.
+// RingResources returns the list of resources that are distributed across shards in this ControllerRing.
 func (c *ControllerRing) RingResources() []RingResource {
 	return c.Spec.Resources
 }

pkg/apis/sharding/v1alpha1/types_controllerring_test.go

@@ -0,0 +1,73 @@
+/*
+Copyright 2025 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 v1alpha1_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	. "github.com/timebertt/kubernetes-controller-sharding/pkg/apis/sharding/v1alpha1"
+)
+
+var _ = Describe("ControllerRing", func() {
+	var ring *ControllerRing
+
+	BeforeEach(func() {
+		ring = &ControllerRing{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "operator",
+			},
+			Spec: ControllerRingSpec{
+				Resources: []RingResource{{
+					GroupResource: metav1.GroupResource{
+						Group:    "",
+						Resource: "configmaps",
+					},
+					ControlledResources: []metav1.GroupResource{{
+						Group:    "",
+						Resource: "secrets",
+					}},
+				}},
+			},
+		}
+	})
+
+	Describe("#LeaseSelector", func() {
+		It("should return the correct lease selector", func() {
+			Expect(ring.LeaseSelector().String()).To(Equal("alpha.sharding.timebertt.dev/controllerring=operator"))
+		})
+	})
+
+	Describe("#LabelShard", func() {
+		It("should append the ControllerRing name", func() {
+			Expect(ring.LabelShard()).To(Equal("shard.alpha.sharding.timebertt.dev/operator"))
+		})
+	})
+
+	Describe("#LabelDrain", func() {
+		It("should append the ControllerRing name", func() {
+			Expect(ring.LabelDrain()).To(Equal("drain.alpha.sharding.timebertt.dev/operator"))
+		})
+	})
+
+	Describe("#RingResources", func() {
+		It("should return the specified resources", func() {
+			Expect(ring.RingResources()).To(Equal(ring.Spec.Resources))
+		})
+	})
+})

pkg/apis/sharding/v1alpha1/v1alpha1_suite_test.go

@@ -0,0 +1,29 @@
+/*
+Copyright 2025 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 v1alpha1_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestV1alpha1(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Sharding API V1alpha1 Suite")
+}