chore: avoid dbmock test errors in dbgen (#10923)

deansheather · web-flow · commit 452668c893a2 · 2023-11-28T17:04:25.000Z
diff --git a/coderd/database/generate.sh b/coderd/database/generate.sh
@@ -58,6 +58,7 @@ SCRIPT_DIR=$(dirname "${BASH_SOURCE[0]}")
 	go run golang.org/x/tools/cmd/goimports@latest -w queries.sql.go
 
 	go run ../../scripts/dbgen
-	# This will error if a view is broken.
-	go test -run=TestViewSubset
+	# This will error if a view is broken. This is in it's own package to avoid
+	# stuff like dbmock breaking builds if it's out of date from the interface.
+	go test ./gentest
 )
diff --git a/coderd/database/gentest/doc.go b/coderd/database/gentest/doc.go
@@ -0,0 +1,8 @@
+// Package gentest contains tests that are run at db generate time. These tests
+// need to exist in their own package to avoid importing stuff that gets
+// generated after the DB.
+//
+// E.g. if we put these tests in coderd/database, then we'd be importing dbmock
+// which is generated after the DB and can cause type problems when building
+// the tests.
+package gentest
diff --git a/coderd/database/gentest/models_test.go b/coderd/database/gentest/models_test.go
@@ -1,4 +1,4 @@
-package database_test
+package gentest_test
 
 import (
 	"reflect"

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ SCRIPT_DIR=$(dirname "${BASH_SOURCE[0]}")`
`58`	`58`	`go run golang.org/x/tools/cmd/goimports@latest -w queries.sql.go`
`59`	`59`
`60`	`60`	`go run ../../scripts/dbgen`
`61`		`- # This will error if a view is broken.`
`62`		`- go test -run=TestViewSubset`
	`61`	`+ # This will error if a view is broken. This is in it's own package to avoid`
	`62`	`+ # stuff like dbmock breaking builds if it's out of date from the interface.`
	`63`	`+ go test ./gentest`
`63`	`64`	`)`