Add gomega ID matcher for gophercloud objects

Author: mdbooth

test/e2e/suites/e2e/e2e_suite_test.go

@@ -86,19 +86,19 @@ var _ = SynchronizedAfterSuite(func() {
 }, func() {
 	endServers, err := shared.DumpOpenStackServers(e2eCtx, servers.ListOpts{})
 	Expect(err).NotTo(HaveOccurred())
-	Expect(endServers).To(Equal(initialServers))
+	Expect(endServers).To(ConsistOfIDs(initialServers))
 	endNetworks, err := shared.DumpOpenStackNetworks(e2eCtx, networks.ListOpts{})
 	Expect(err).NotTo(HaveOccurred())
-	Expect(endNetworks).To(Equal(initialNetworks))
+	Expect(endNetworks).To(ConsistOfIDs(initialNetworks))
 	endSecurityGroups, err := shared.DumpOpenStackSecurityGroups(e2eCtx, groups.ListOpts{})
 	Expect(err).NotTo(HaveOccurred())
-	Expect(endSecurityGroups).To(Equal(initialSecurityGroups))
+	Expect(endSecurityGroups).To(ConsistOfIDs(initialSecurityGroups))
 	endLoadBalancers, err := shared.DumpOpenStackLoadBalancers(e2eCtx, loadbalancers.ListOpts{})
 	Expect(err).NotTo(HaveOccurred())
-	Expect(endLoadBalancers).To(Equal(initialLoadBalancers))
+	Expect(endLoadBalancers).To(ConsistOfIDs(initialLoadBalancers))
 	endVolumes, err := shared.DumpOpenStackVolumes(e2eCtx, volumes.ListOpts{})
 	Expect(err).NotTo(HaveOccurred())
-	Expect(endVolumes).To(Equal(initialVolumes))
+	Expect(endVolumes).To(ConsistOfIDs(initialVolumes))
 
 	shared.Node1AfterSuite(e2eCtx)
 })

test/e2e/suites/e2e/idmatcher_test.go

@@ -0,0 +1,57 @@
+package e2e
+
+import (
+	"fmt"
+	"reflect"
+
+	"github.com/onsi/gomega"
+	"github.com/onsi/gomega/format"
+	"github.com/onsi/gomega/gstruct"
+	"github.com/onsi/gomega/types"
+)
+
+type idMatcher struct {
+	expected interface{}
+}
+
+var _ types.GomegaMatcher = &idMatcher{}
+var _ format.GomegaStringer = &idMatcher{}
+
+func (m *idMatcher) Match(actual interface{}) (bool, error) {
+	v := reflect.ValueOf(m.expected)
+	id := v.FieldByName("ID").String()
+
+	matcher := &gstruct.FieldsMatcher{
+		Fields: gstruct.Fields{
+			"ID": gomega.Equal(id),
+		},
+		IgnoreExtras: true,
+	}
+
+	return matcher.Match(actual)
+}
+
+func (m *idMatcher) FailureMessage(actual interface{}) string {
+	return fmt.Sprintf("Expected:\n%s\nto have the same ID as:\n%s", format.Object(actual, 1), format.Object(m.expected, 1))
+}
+
+func (m *idMatcher) NegatedFailureMessage(actual interface{}) string {
+	return fmt.Sprintf("Expected:\n%s\nnot to have the same ID as:\n%s", format.Object(actual, 1), format.Object(m.expected, 1))
+}
+
+func (m *idMatcher) GomegaString() string {
+	return fmt.Sprintf("ID match for:\n%s", format.Object(m.expected, 1))
+}
+
+func IDOf(expected interface{}) types.GomegaMatcher {
+	return &idMatcher{expected: expected}
+}
+
+func ConsistOfIDs[T any](expected []T) types.GomegaMatcher {
+	matchers := make([]types.GomegaMatcher, len(expected))
+	for i := range expected {
+		matchers[i] = IDOf(expected[i])
+	}
+
+	return gomega.ConsistOf(matchers)
+}