fix: Disable telemetry by default in tests (coder#3200)

mafredri · johnstcn · web-flow · commit d1d89210b8f2 · 2022-07-26T16:27:48.000+03:00
I also noticed we don't have `goleak` enabled for CLI tests, this commit
adds it, but commented out. The reason being that we're nowhere near
being able to enable it yet.

Co-authored-by: Cian Johnston &lt;cian@coder.com&gt;
diff --git a/cli/root.go b/cli/root.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"flag"
 	"fmt"
 	"net/url"
 	"os"
@@ -175,6 +176,10 @@ func versionCmd() *cobra.Command {
 	}
 }
 
+func isTest() bool {
+	return flag.Lookup("test.v") != nil
+}
+
 // createClient returns a new client from the command context.
 // It reads from global configuration files if flags are not set.
 func createClient(cmd *cobra.Command) (*codersdk.Client, error) {
diff --git a/cli/root_internal_test.go b/cli/root_internal_test.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"os"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -64,3 +65,9 @@ func Test_formatExamples(t *testing.T) {
 		})
 	}
 }
+
+func TestMain(m *testing.M) {
+	// Replace with goleak.VerifyTestMain(m) when we enable goleak.
+	os.Exit(m.Run())
+	// goleak.VerifyTestMain(m)
+}
diff --git a/cli/server.go b/cli/server.go
@@ -566,7 +566,8 @@ func server() *cobra.Command {
 		"Specifies teams inside organizations the user must be a member of to authenticate with GitHub. Formatted as: <organization-name>/<team-slug>.")
 	cliflag.BoolVarP(root.Flags(), &oauth2GithubAllowSignups, "oauth2-github-allow-signups", "", "CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS", false,
 		"Specifies whether new users can sign up with GitHub.")
-	cliflag.BoolVarP(root.Flags(), &telemetryEnable, "telemetry", "", "CODER_TELEMETRY", true, "Specifies whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.")
+	enableTelemetryByDefault := !isTest()
+	cliflag.BoolVarP(root.Flags(), &telemetryEnable, "telemetry", "", "CODER_TELEMETRY", enableTelemetryByDefault, "Specifies whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.")
 	cliflag.StringVarP(root.Flags(), &telemetryURL, "telemetry-url", "", "CODER_TELEMETRY_URL", "https://telemetry.coder.com", "Specifies a URL to send telemetry to.")
 	_ = root.Flags().MarkHidden("telemetry-url")
 	cliflag.BoolVarP(root.Flags(), &tlsEnable, "tls-enable", "", "CODER_TLS_ENABLE", false, "Specifies if TLS will be enabled")
