moved telemetry in command context

cmd/build.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/local"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
@@ -18,11 +17,12 @@ func newLocalExecuteCommand(config *settings.Config) *cobra.Command {
 			return nil
 		},
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			telemetryClient := create_telemetry.CreateTelemetry(config)
-			defer telemetryClient.Close()
-
 			err := local.Execute(cmd.Flags(), config, args)
-			_ = telemetryClient.Track(telemetry.CreateLocalExecuteEvent(create_telemetry.GetCommandInformation(cmd, true)))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateLocalExecuteEvent(telemetry.GetCommandInformation(cmd, true)))
+			}
 
 			return err
 		},

cmd/completion.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"os"
 
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
 	"github.com/spf13/cobra"
@@ -14,9 +13,10 @@ func newCompletionCommand(config *settings.Config) *cobra.Command {
 		Use:   "completion",
 		Short: "Generate shell completion scripts",
 		PersistentPreRun: func(cmd *cobra.Command, _ []string) {
-			telemetryClient := create_telemetry.CreateTelemetry(config)
-			defer telemetryClient.Close()
-			_ = telemetryClient.Track(telemetry.CreateCompletionCommand(create_telemetry.GetCommandInformation(cmd, false)))
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateCompletionCommand(telemetry.GetCommandInformation(cmd, true)))
+			}
 		},
 		Run: func(cmd *cobra.Command, _ []string) {
 			err := cmd.Help()

cmd/config.go

@@ -8,7 +8,6 @@ import (
 	"github.com/CircleCI-Public/circleci-config/labeling"
 	"github.com/CircleCI-Public/circleci-config/labeling/codebase"
 
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/config"
 	"github.com/CircleCI-Public/circleci-cli/filetree"
 	"github.com/CircleCI-Public/circleci-cli/proxy"
@@ -30,33 +29,21 @@ var configAnnotations = map[string]string{
 }
 
 func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
-	var telemetryClient telemetry.Client
-
-	closeTelemetryClient := func() {
-		if telemetryClient != nil {
-			telemetryClient.Close()
-			telemetryClient = nil
-		}
-	}
-
 	configCmd := &cobra.Command{
 		Use:   "config",
 		Short: "Operate on build config files",
-		PersistentPreRun: func(_ *cobra.Command, _ []string) {
-			telemetryClient = create_telemetry.CreateTelemetry(globalConfig)
-		},
-		PersistentPostRun: func(cmd *cobra.Command, args []string) {
-			closeTelemetryClient()
-		},
 	}
 
 	packCommand := &cobra.Command{
 		Use:   "pack <path>",
 		Short: "Pack up your CircleCI configuration into a single file.",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			defer closeTelemetryClient()
 			err := packConfig(args)
-			_ = telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateConfigEvent(telemetry.GetCommandInformation(cmd, true), err))
+			}
 			return err
 		},
 		Args:        cobra.ExactArgs(1),
@@ -69,8 +56,6 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 		Aliases: []string{"check"},
 		Short:   "Check that the config file is well formed.",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			defer closeTelemetryClient()
-
 			compiler := config.New(globalConfig)
 			orgID, _ := cmd.Flags().GetString("org-id")
 			orgSlug, _ := cmd.Flags().GetString("org-slug")
@@ -89,7 +74,10 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 				IgnoreDeprecatedImages: ignoreDeprecatedImages,
 				VerboseOutput:          verboseOutput,
 			})
-			_ = telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateConfigEvent(telemetry.GetCommandInformation(cmd, true), err))
+			}
 
 			return err
 		},
@@ -111,8 +99,6 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 		Use:   "process <path>",
 		Short: "Validate config and display expanded configuration.",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			defer closeTelemetryClient()
-
 			compiler := config.New(globalConfig)
 			pipelineParamsFilePath, _ := cmd.Flags().GetString("pipeline-parameters")
 			orgID, _ := cmd.Flags().GetString("org-id")
@@ -131,7 +117,10 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 				PipelineParamsFilePath: pipelineParamsFilePath,
 				VerboseOutput:          verboseOutput,
 			})
-			_ = telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateConfigEvent(telemetry.GetCommandInformation(cmd, true), err))
+			}
 			if err != nil {
 				return err
 			}

cmd/config_test.go

@@ -37,8 +37,8 @@ var _ = Describe("Config", func() {
 					"config", "pack",
 					"--skip-update-check",
 					filepath.Join("testdata", "hugo-pack", ".circleci"),
-					"--mock-telemetry", tempSettings.TelemetryDestPath,
 				)
+				command.Env = append(command.Env, fmt.Sprintf("MOCK_TELEMETRY=%s", tempSettings.TelemetryDestPath))
 			})
 
 			AfterEach(func() {

cmd/create_telemetry/create_telemetry.go → cmd/create_telemetry.go

@@ -1,4 +1,4 @@
-package create_telemetry
+package cmd
 
 import (
 	"fmt"
@@ -62,8 +62,12 @@ func (client nullTelemetryAPIClient) GetMyUserId() (string, error) {
 
 // Make sure the user gave their approval for the telemetry and
 func CreateTelemetry(config *settings.Config) telemetry.Client {
-	if config.MockTelemetry != "" {
-		return telemetry.CreateFileTelemetry(config.MockTelemetry)
+	mockTelemetry := config.MockTelemetry
+	if mockTelemetry == "" {
+		mockTelemetry = os.Getenv("MOCK_TELEMETRY")
+	}
+	if mockTelemetry != "" {
+		return telemetry.CreateFileTelemetry(mockTelemetry)
 	}
 
 	if config.IsTelemetryDisabled {

cmd/create_telemetry/create_telemetry_test.go → cmd/create_telemetry_test.go

@@ -1,4 +1,4 @@
-package create_telemetry
+package cmd
 
 import (
 	"path/filepath"

cmd/diagnostic.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/CircleCI-Public/circleci-cli/api"
 	"github.com/CircleCI-Public/circleci-cli/api/graphql"
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
 	"github.com/spf13/cobra"
@@ -30,12 +29,13 @@ func newDiagnosticCommand(config *settings.Config) *cobra.Command {
 			opts.args = args
 			opts.cl = graphql.NewClient(config.HTTPClient, config.Host, config.Endpoint, config.Token, config.Debug)
 		},
-		RunE: func(_ *cobra.Command, _ []string) error {
-			telemetryClient := create_telemetry.CreateTelemetry(config)
-			defer telemetryClient.Close()
-
+		RunE: func(cmd *cobra.Command, _ []string) error {
 			err := diagnostic(opts)
-			_ = telemetryClient.Track(telemetry.CreateDiagnosticEvent(err))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateDiagnosticEvent(err))
+			}
 
 			return err
 		},

cmd/diagnostic_test.go

@@ -85,8 +85,8 @@ var _ = Describe("Diagnostic", func() {
 			command = commandWithHome(pathCLI, tempSettings.Home,
 				"diagnostic",
 				"--skip-update-check",
-				"--host", tempSettings.TestServer.URL(),
-				"--mock-telemetry", tempSettings.TelemetryDestPath)
+				"--host", tempSettings.TestServer.URL())
+			command.Env = append(command.Env, fmt.Sprintf("MOCK_TELEMETRY=%s", tempSettings.TelemetryDestPath))
 			tempSettings.Config.Write([]byte(`token: mytoken`))
 			session, err := gexec.Start(command, GinkgoWriter, GinkgoWriter)
 			Expect(err).ShouldNot(HaveOccurred())

cmd/follow.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 
 	"github.com/CircleCI-Public/circleci-cli/api"
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/git"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
@@ -55,12 +54,13 @@ func followProjectCommand(config *settings.Config) *cobra.Command {
 	followCommand := &cobra.Command{
 		Use:   "follow",
 		Short: "Attempt to follow the project for the current git repository.",
-		RunE: func(_ *cobra.Command, _ []string) error {
-			telemetryClient := create_telemetry.CreateTelemetry(config)
-			defer telemetryClient.Close()
-
+		RunE: func(cmd *cobra.Command, _ []string) error {
 			err := followProject(opts)
-			_ = telemetryClient.Track(telemetry.CreateFollowEvent(err))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateFollowEvent(err))
+			}
 
 			return err
 		},

cmd/info/info.go

@@ -2,7 +2,6 @@ package info
 
 import (
 	"github.com/CircleCI-Public/circleci-cli/api/info"
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/cmd/validator"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
@@ -13,9 +12,8 @@ import (
 
 // infoOptions info command options
 type infoOptions struct {
-	cfg             *settings.Config
-	validator       validator.Validator
-	createTelemetry func() telemetry.Client
+	cfg       *settings.Config
+	validator validator.Validator
 }
 
 // NewInfoCommand information cobra command creation
@@ -25,9 +23,6 @@ func NewInfoCommand(config *settings.Config, preRunE validator.Validator) *cobra
 	opts := infoOptions{
 		cfg:       config,
 		validator: preRunE,
-		createTelemetry: func() telemetry.Client {
-			return create_telemetry.CreateTelemetry(config)
-		},
 	}
 	infoCommand := &cobra.Command{
 		Use:   "info",
@@ -47,11 +42,12 @@ func orgInfoCommand(client info.InfoClient, opts infoOptions) *cobra.Command {
 		Long:    `View your Organizations' names and ids.`,
 		PreRunE: opts.validator,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			telemetryClient := opts.createTelemetry()
-			defer telemetryClient.Close()
-
 			err := getOrgInformation(cmd, client)
-			_ = telemetryClient.Track(telemetry.CreateInfoEvent(create_telemetry.GetCommandInformation(cmd, true), err))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateInfoEvent(telemetry.GetCommandInformation(cmd, true), err))
+			}
 
 			return err
 		},

cmd/info/info_test.go

@@ -2,14 +2,12 @@ package info
 
 import (
 	"bytes"
-	"encoding/json"
+	"context"
 	"fmt"
 	"net/http"
 	"net/http/httptest"
-	"os"
 	"testing"
 
-	"github.com/CircleCI-Public/circleci-cli/clitest"
 	"github.com/CircleCI-Public/circleci-cli/cmd/validator"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
@@ -110,10 +108,19 @@ func TestFailedValidator(t *testing.T) {
 	assert.Error(t, err, errorMessage)
 }
 
-func TestTelemetry(t *testing.T) {
-	tempSettings := clitest.WithTempSettings()
-	defer tempSettings.Close()
+type testTelemetryClient struct {
+	events []telemetry.Event
+}
+
+func (cli *testTelemetryClient) Track(event telemetry.Event) error {
+	cli.events = append(cli.events, event)
+	return nil
+}
 
+func (cli *testTelemetryClient) Close() error { return nil }
+
+func TestTelemetry(t *testing.T) {
+	telemetryClient := testTelemetryClient{make([]telemetry.Event, 0)}
 	// Test server
 	var serverHandler http.HandlerFunc = func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(http.StatusOK)
@@ -124,25 +131,25 @@ func TestTelemetry(t *testing.T) {
 
 	// Test command
 	config := &settings.Config{
-		Token:         "testtoken",
-		HTTPClient:    http.DefaultClient,
-		Host:          server.URL,
-		MockTelemetry: tempSettings.TelemetryDestPath,
+		Token:      "testtoken",
+		HTTPClient: http.DefaultClient,
+		Host:       server.URL,
 	}
 	cmd := NewInfoCommand(config, nil)
+	cmd.SetArgs([]string{"org"})
+	ctx := cmd.Context()
+	if ctx == nil {
+		ctx = context.Background()
+	}
+	cmd.SetContext(telemetry.NewContext(ctx, &telemetryClient))
 
 	// Execute
 	err := cmd.Execute()
 
-	assert.NilError(t, err)
-	// We compare the
-	content, err := os.ReadFile(tempSettings.TelemetryDestPath)
 	assert.NilError(t, err)
 
-	result := []telemetry.Event{}
-	err = json.Unmarshal(content, &result)
-	assert.NilError(t, err)
-	assert.DeepEqual(t, result, []telemetry.Event{
+	// Read the telemetry events and compare them
+	assert.DeepEqual(t, telemetryClient.events, []telemetry.Event{
 		telemetry.CreateInfoEvent(telemetry.CommandInfo{
 			Name:      "org",
 			LocalArgs: map[string]string{"help": "false"},

cmd/namespace.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/CircleCI-Public/circleci-cli/api"
 	"github.com/CircleCI-Public/circleci-cli/api/graphql"
-	"github.com/CircleCI-Public/circleci-cli/cmd/create_telemetry"
 	"github.com/CircleCI-Public/circleci-cli/prompt"
 	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/CircleCI-Public/circleci-cli/telemetry"
@@ -70,17 +69,18 @@ Please note that at this time all namespaces created in the registry are world-r
 			return validateToken(opts.cfg)
 		},
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			telemetryClient := create_telemetry.CreateTelemetry(config)
-			defer telemetryClient.Close()
-
 			if opts.integrationTesting {
 				opts.tty = createNamespaceTestUI{
 					confirm: true,
 				}
 			}
 
 			err := createNamespace(cmd, opts)
-			_ = telemetryClient.Track(telemetry.CreateNamespaceEvent(create_telemetry.GetCommandInformation(cmd, true)))
+
+			telemetryClient, ok := telemetry.FromContext(cmd.Context())
+			if ok {
+				_ = telemetryClient.Track(telemetry.CreateNamespaceEvent(telemetry.GetCommandInformation(cmd, true)))
+			}
 
 			return err
 		},