add comment for test helper

Emyrk · Emyrk · commit 07fa2b1de7ea · 2024-09-05T12:36:56.000-05:00
diff --git a/coderd/coderdtest/uuids.go b/coderd/coderdtest/uuids.go
@@ -2,6 +2,10 @@ package coderdtest
 
 import "github.com/google/uuid"
 
+// DeterministicUUIDGenerator allows "naming" uuids for unit tests.
+// An example of where this is useful, is when a tabled test references
+// a UUID that is not yet known. An alternative to this would be to
+// hard code some UUID strings, but these strings are not human friendly.
 type DeterministicUUIDGenerator struct {
 	Named map[string]uuid.UUID
 }
diff --git a/coderd/coderdtest/uuids_test.go b/coderd/coderdtest/uuids_test.go
@@ -0,0 +1,33 @@
+package coderdtest_test
+
+import (
+	"github.com/google/uuid"
+
+	"github.com/coder/coder/v2/coderd/coderdtest"
+)
+
+func ExampleNewDeterministicUUIDGenerator() {
+	det := coderdtest.NewDeterministicUUIDGenerator()
+	testCases := []struct {
+		CreateUsers []uuid.UUID
+		ExpectedIDs []uuid.UUID
+	}{
+		{
+			CreateUsers: []uuid.UUID{
+				det.ID("player1"),
+				det.ID("player2"),
+			},
+			ExpectedIDs: []uuid.UUID{
+				det.ID("player1"),
+				det.ID("player2"),
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+		var _ = tc
+		// Do the test with CreateUsers as the setup, and the expected IDs
+		// will match.
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,10 @@ package coderdtest`
`2`	`2`
`3`	`3`	`import "github.com/google/uuid"`
`4`	`4`
	`5`	`+// DeterministicUUIDGenerator allows "naming" uuids for unit tests.`
	`6`	`+// An example of where this is useful, is when a tabled test references`
	`7`	`+// a UUID that is not yet known. An alternative to this would be to`
	`8`	`+// hard code some UUID strings, but these strings are not human friendly.`
`5`	`9`	`type DeterministicUUIDGenerator struct {`
`6`	`10`	`Named map[string]uuid.UUID`
`7`	`11`	`}`