Implement object key utilities

Author: adracus

clientutils/objectkey.go

@@ -0,0 +1,54 @@
+// Copyright 2022 OnMetal 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 clientutils
+
+import "sigs.k8s.io/controller-runtime/pkg/client"
+
+// ObjectKeySet set is a set of client.ObjectKey.
+type ObjectKeySet map[client.ObjectKey]struct{}
+
+// Insert inserts the given items into the ObjectKeySet.
+// The ObjectKeySet has to be non-nil for this operation.
+func (s ObjectKeySet) Insert(items ...client.ObjectKey) {
+	for _, item := range items {
+		s[item] = struct{}{}
+	}
+}
+
+// Has checks if the given item is in the set.
+func (s ObjectKeySet) Has(item client.ObjectKey) bool {
+	_, ok := s[item]
+	return ok
+}
+
+// Delete removes the given items from the ObjectKeySet.
+// The ObjectKeySet has to be non-nil for this operation.
+func (s ObjectKeySet) Delete(items ...client.ObjectKey) {
+	for _, item := range items {
+		delete(s, item)
+	}
+}
+
+// Len returns the length of the ObjectKeySet.
+func (s ObjectKeySet) Len() int {
+	return len(s)
+}
+
+// NewObjectKeySet creates a new ObjectKeySet and initializes it with the given items.
+func NewObjectKeySet(items ...client.ObjectKey) ObjectKeySet {
+	s := make(ObjectKeySet)
+	s.Insert(items...)
+	return s
+}

clientutils/objectkey_test.go

@@ -0,0 +1,125 @@
+// Copyright 2022 OnMetal 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 clientutils_test
+
+import (
+	. "github.com/onmetal/controller-utils/clientutils"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ = Describe("ObjectKey", func() {
+	Context("ObjectKeySet", func() {
+		var (
+			k1, k2, k3, k4, k5, k6 client.ObjectKey
+		)
+		BeforeEach(func() {
+			k1 = client.ObjectKey{
+				Namespace: "n1",
+				Name:      "foo",
+			}
+			k2 = client.ObjectKey{
+				Namespace: "n1",
+				Name:      "bar",
+			}
+			k3 = client.ObjectKey{
+				Namespace: "n2",
+				Name:      "foo",
+			}
+			k4 = client.ObjectKey{
+				Namespace: "n2",
+				Name:      "bar",
+			}
+			k5 = client.ObjectKey{
+				Name: "cluster1",
+			}
+			k6 = client.ObjectKey{
+				Name: "cluster2",
+			}
+		})
+
+		Describe("New", func() {
+			It("should initialize a new object key set with the given elements", func() {
+				s := NewObjectKeySet(k1, k2, k3, k4, k5, k6)
+				Expect(s).To(Equal(ObjectKeySet{
+					k1: struct{}{},
+					k2: struct{}{},
+					k3: struct{}{},
+					k4: struct{}{},
+					k5: struct{}{},
+					k6: struct{}{},
+				}))
+			})
+		})
+
+		Describe("Insert", func() {
+			It("should insert the given items", func() {
+				s := NewObjectKeySet()
+				s.Insert(k1, k2, k3)
+				Expect(s).To(Equal(ObjectKeySet{
+					k1: struct{}{},
+					k2: struct{}{},
+					k3: struct{}{},
+				}))
+
+				s.Insert(k4, k5, k6)
+				Expect(s).To(Equal(ObjectKeySet{
+					k1: struct{}{},
+					k2: struct{}{},
+					k3: struct{}{},
+					k4: struct{}{},
+					k5: struct{}{},
+					k6: struct{}{},
+				}))
+			})
+		})
+
+		Describe("Delete", func() {
+			It("should delete the given items from the set", func() {
+				s := NewObjectKeySet(k1, k2, k3, k4, k5, k6)
+
+				s.Delete(k2, k4, k6)
+
+				Expect(s).To(Equal(ObjectKeySet{
+					k1: struct{}{},
+					k3: struct{}{},
+					k5: struct{}{},
+				}))
+			})
+		})
+
+		Describe("Has", func() {
+			It("should return whether the given item is present in the set", func() {
+				s := NewObjectKeySet(k1, k2, k3)
+
+				Expect(s.Has(k1)).To(BeTrue(), "set should have key: set %#v, key %s", s, k1)
+				Expect(s.Has(k2)).To(BeTrue(), "set should have key: set %#v, key %s", s, k2)
+				Expect(s.Has(k3)).To(BeTrue(), "set should have key: set %#v, key %s", s, k3)
+				Expect(s.Has(k4)).To(BeFalse(), "set should not have key: set %#v, key %s", s, k4)
+				Expect(s.Has(k5)).To(BeFalse(), "set should not have key: set %#v, key %s", s, k5)
+				Expect(s.Has(k6)).To(BeFalse(), "set should not have key: set %#v, key %s", s, k6)
+			})
+		})
+
+		Describe("Len", func() {
+			It("should return the length of the set", func() {
+				Expect(NewObjectKeySet(k1, k2, k3).Len()).To(Equal(3))
+				Expect((ObjectKeySet)(nil).Len()).To(Equal(0))
+				Expect(NewObjectKeySet().Len()).To(Equal(0))
+			})
+		})
+	})
+})