coder · mafredri · Nov 4, 2022 · Nov 4, 2022 · Nov 4, 2022 · Nov 4, 2022
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
@@ -443,6 +443,15 @@ site/src/api/typesGenerated.ts: scripts/apitypings/main.go $(shell find codersdk
 	cd site
 	yarn run format:types
 
+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
+	touch "$@"
+
 test: test-clean
 	gotestsum -- -v -short ./...
 .PHONY: test

diff --git a/cli/root_test.go b/cli/root_test.go
@@ -2,8 +2,12 @@ package cli_test
 
 import (
 	"bytes"
+	"flag"
 	"net/http"
 	"net/http/httptest"
+	"os"
+	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/spf13/cobra"
@@ -16,8 +20,80 @@ import (
 	"github.com/coder/coder/cli/cliflag"
 	"github.com/coder/coder/cli/clitest"
 	"github.com/coder/coder/codersdk"
+	"github.com/coder/coder/testutil"
 )
 
+var updateGoldenFiles = flag.Bool("update", false, "update .golden files")
+
+//nolint:tparallel,paralleltest // These test sets env vars.
+func TestCommandHelp(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name string
+		cmd  []string
+		env  map[string]string
+	}{
+		{
+			name: "coder --help",
+			cmd:  []string{"--help"},
+			env: map[string]string{
+				"CODER_CONFIG_DIR": "/tmp/coder-cli-test-config",
+			},
+		},
+		{
+			name: "coder server --help",
+			cmd:  []string{"server", "--help"},
+			env: map[string]string{
+				"CODER_CONFIG_DIR":      "/tmp/coder-cli-test-config",
+				"CODER_CACHE_DIRECTORY": "/tmp/coder-cli-test-cache",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			// Unset all CODER_ environment variables for a clean slate.
+			for _, kv := range os.Environ() {
+				name := strings.Split(kv, "=")[0]
+				if _, ok := tt.env[name]; !ok && strings.HasPrefix(name, "CODER_") {
+					t.Setenv(name, "")
+				}
+			}
+			// Override environment variables for a reproducible test.
+			for k, v := range tt.env {
+				t.Setenv(k, v)
+			}
+
+			ctx, _ := testutil.Context(t)
+
+			var buf bytes.Buffer
+			root, _ := clitest.New(t, tt.cmd...)
+			root.SetOut(&buf)
+			err := root.ExecuteContext(ctx)
+			require.NoError(t, err)
+
+			got := buf.Bytes()
+			// Remove CRLF newlines (Windows).
+			got = bytes.ReplaceAll(got, []byte{'\r', '\n'}, []byte{'\n'})
+
+			gf := filepath.Join("testdata", strings.Replace(tt.name, " ", "_", -1)+".golden")
+			if *updateGoldenFiles {
+				t.Logf("update golden file for: %q: %s", tt.name, gf)
+				err = os.WriteFile(gf, got, 0o600)
+				require.NoError(t, err, "update golden file")
+			}
+
+			want, err := os.ReadFile(gf)
+			require.NoError(t, err, "read golden file, run \"make update-golden-files\" and commit the changes")
+			// Remove CRLF newlines (Windows).
+			want = bytes.ReplaceAll(want, []byte{'\r', '\n'}, []byte{'\n'})
+			require.Equal(t, string(want), string(got), "golden file mismatch: %s, run \"make update-golden-files\", verify and commit the changes", gf)
+		})
+	}
+}
+
 func TestRoot(t *testing.T) {
 	t.Parallel()
 	t.Run("FormatCobraError", func(t *testing.T) {

diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
@@ -0,0 +1,67 @@
+Coder v0.0.0-devel — A tool for provisioning self-hosted development environments with Terraform.
+
+Usage:
+  coder [flags]
+
+  coder [command]
+
+Get Started:
+  - Start a Coder server:                                                       
+
+      [;m$ coder server[0m 
+
+  - Get started by creating a template from an example:                         
+
+      [;m$ coder templates init[0m 
+
+Commands:
+  completion     Generate the autocompletion script for the specified shell
+  dotfiles       Checkout and install a dotfiles repository from a Git URL
+  help           Help about any command
+  login          Authenticate with Coder deployment
+  logout         Unauthenticate your local session
+  port-forward   Forward ports from machine to a workspace
+  publickey      Output your Coder public key used for Git operations
+  reset-password Directly connect to the database to reset a user's password
+  server         Start a Coder server
+  state          Manually manage Terraform state to fix broken workspaces
+  templates      Manage templates
+  tokens         Manage personal access tokens
+  users          Manage users
+  version        Show coder version
+
+Workspace Commands:
+  config-ssh     Add an SSH Host entry for your workspaces "ssh coder.workspace"
+  create         Create a workspace
+  delete         Delete a workspace
+  list           List workspaces
+  schedule       Schedule automated start and stop times for workspaces
+  show           Display details of a workspace's resources and agents
+  speedtest      Run upload and download tests from your machine to a workspace
+  ssh            Start a shell into a workspace
+  start          Start a workspace
+  stop           Stop a workspace
+  update         Update a workspace
+
+Flags:
+      --experimental          Enable experimental features. Experimental features are not
+                              ready for production.
+                              Consumes $CODER_EXPERIMENTAL
+      --global-config coder   Path to the global coder config directory.
+                              Consumes $CODER_CONFIG_DIR (default "/tmp/coder-cli-test-config")
+      --header stringArray    HTTP headers added to all requests. Provide as "Key=Value".
+                              Consumes $CODER_HEADER
+  -h, --help                  help for coder
+      --no-feature-warning    Suppress warnings about unlicensed features.
+                              Consumes $CODER_NO_FEATURE_WARNING
+      --no-version-warning    Suppress warning when client and server versions do not match.
+                              Consumes $CODER_NO_VERSION_WARNING
+      --token string          Specify an authentication token. For security reasons setting
+                              CODER_SESSION_TOKEN is preferred.
+                              Consumes $CODER_SESSION_TOKEN
+      --url string            URL to a deployment.
+                              Consumes $CODER_URL
+  -v, --verbose               Enable verbose output.
+                              Consumes $CODER_VERBOSE
+
+Use "coder [command] --help" for more information about a command.