test(coderd/database/dbauthz): compare outputs with cmp (#16161)

mafredri · web-flow · commit 0e8ef0941559 · 2025-01-20T11:12:04.000+02:00
diff --git a/coderd/database/dbauthz/setup_test.go b/coderd/database/dbauthz/setup_test.go
@@ -2,13 +2,16 @@ package dbauthz_test
 
 import (
 	"context"
+	"encoding/gob"
 	"errors"
 	"fmt"
 	"reflect"
 	"sort"
 	"strings"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/google/uuid"
 	"github.com/open-policy-agent/opa/topdown"
 	"github.com/stretchr/testify/require"
@@ -198,11 +201,29 @@ func (s *MethodTestSuite) Subtest(testCaseF func(db database.Store, check *expec
 				s.Equal(len(testCase.outputs), len(outputs), "method %q returned unexpected number of outputs", methodName)
 				for i := range outputs {
 					a, b := testCase.outputs[i].Interface(), outputs[i].Interface()
-					if reflect.TypeOf(a).Kind() == reflect.Slice || reflect.TypeOf(a).Kind() == reflect.Array {
-						// Order does not matter
-						s.ElementsMatch(a, b, "method %q returned unexpected output %d", methodName, i)
-					} else {
-						s.Equal(a, b, "method %q returned unexpected output %d", methodName, i)
+
+					// To avoid the extra small overhead of gob encoding, we can
+					// first check if the values are equal with regard to order.
+					// If not, re-check disregarding order and show a nice diff
+					// output of the two values.
+					if !cmp.Equal(a, b, cmpopts.EquateEmpty()) {
+						if diff := cmp.Diff(a, b,
+							// Equate nil and empty slices.
+							cmpopts.EquateEmpty(),
+							// Allow slice order to be ignored.
+							cmpopts.SortSlices(func(a, b any) bool {
+								var ab, bb strings.Builder
+								_ = gob.NewEncoder(&ab).Encode(a)
+								_ = gob.NewEncoder(&bb).Encode(b)
+								// This might seem a bit dubious, but we really
+								// don't care about order and cmp doesn't provide
+								// a generic less function for slices:
+								// https://github.com/google/go-cmp/issues/67
+								return ab.String() < bb.String()
+							}),
+						); diff != "" {
+							s.Failf("compare outputs failed", "method %q returned unexpected output %d (-want +got):\n%s", methodName, i, diff)
+						}
 					}
 				}
 			}
