Separate make command -> make update-golden-files

mafredri · mafredri · commit 1b4dbe98d5a6 · 2022-11-04T16:03:19.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,9 @@ gotests.coverage
 .gitpod.yml
 .DS_Store
 
+# Make target for updating golden files.
+cli/testdata/.gen-golden
+
 # Front-end ignore
 .next/
 site/.eslintcache
diff --git a/Makefile b/Makefile
@@ -394,16 +394,14 @@ gen: \
 	coderd/database/querier.go \
 	provisionersdk/proto/provisioner.pb.go \
 	provisionerd/proto/provisionerd.pb.go \
-	site/src/api/typesGenerated.ts \
-	cli/testdata/golden
+	site/src/api/typesGenerated.ts
 .PHONY: gen
 
 # Mark all generated files as fresh so make thinks they're up-to-date. This is
 # used during releases so we don't run generation scripts.
 gen/mark-fresh:
 	files="coderd/database/dump.sql coderd/database/querier.go provisionersdk/proto/provisioner.pb.go provisionerd/proto/provisionerd.pb.go site/src/api/typesGenerated.ts"
-	files=($$files cli/testdata/*.golden)
-	for file in "$${files[@]}"; do
+	for file in $$files; do
 		echo "$$file"
 		if [ ! -f "$$file" ]; then
 			echo "File '$$file' does not exist"
@@ -445,9 +443,14 @@ site/src/api/typesGenerated.ts: scripts/apitypings/main.go $(shell find codersdk
 	cd site
 	yarn run format:types
 
-cli/testdata/golden: $(wildcard cli/testdata/*.golden)
+update-golden-files: cli/testdata/.gen-golden
+.PHONY: update-golden-files
+
+cli/testdata/.gen-golden: $(wildcard cli/testdata/*.golden) \
+	$(shell find . -not -path './vendor/*' -type f -name '*.go')
+
 	go test ./cli -run=TestCommandHelp -update
-.PHONY: cli/testdata/golden
+	touch "$@"
 
 test: test-clean
 	gotestsum -- -v -short ./...
diff --git a/cli/root_test.go b/cli/root_test.go
@@ -82,9 +82,9 @@ func TestCommandHelp(t *testing.T) {
 			}
 
 			want, err := os.ReadFile(gf)
-			require.NoError(t, err, "read golden file, run \"make gen\" and commit the changes")
+			require.NoError(t, err, "read golden file, run \"make update-golden-files\" and commit the changes")
 			got := buf.Bytes()
-			require.Equal(t, string(want), string(got), "golden file mismatch: %s, run \"make gen\", verify and commit the changes", gf)
+			require.Equal(t, string(want), string(got), "golden file mismatch: %s, run \"make update-golden-files\", verify and commit the changes", gf)
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -82,9 +82,9 @@ func TestCommandHelp(t *testing.T) {`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`want, err := os.ReadFile(gf)`
`85`		`- require.NoError(t, err, "read golden file, run \"make gen\" and commit the changes")`
	`85`	`+ require.NoError(t, err, "read golden file, run \"make update-golden-files\" and commit the changes")`
`86`	`86`	`got := buf.Bytes()`
`87`		`- require.Equal(t, string(want), string(got), "golden file mismatch: %s, run \"make gen\", verify and commit the changes", gf)`
	`87`	`+ require.Equal(t, string(want), string(got), "golden file mismatch: %s, run \"make update-golden-files\", verify and commit the changes", gf)`
`88`	`88`	`})`
`89`	`89`	`}`
`90`	`90`	`}`