CLOUDP-237254: Set deploymet_type telemetry value in missing atlas deployments commands (#2790)

Author: blva

internal/cli/atlas/deployments/delete.go

@@ -86,6 +86,7 @@ func (opts *DeleteOpts) runLocal(ctx context.Context) error {
 }
 
 func (opts *DeleteOpts) PostRun() error {
+	opts.UpdateDeploymentTelemetry()
 	if !opts.EnableWatch || !opts.IsAtlasDeploymentType() {
 		return nil
 	}

internal/cli/atlas/deployments/delete_test.go

@@ -159,3 +159,26 @@ func TestDeleteBuilder(t *testing.T) {
 		[]string{flag.TypeFlag, flag.Force, flag.EnableWatch, flag.WatchTimeout, flag.ProjectID},
 	)
 }
+
+func TestDelete_PostRun(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	deploymentsTest := fixture.NewMockLocalDeploymentOpts(ctrl, "localDeployment")
+	buf := new(bytes.Buffer)
+
+	opts := &DeleteOpts{
+		DeploymentOpts: *deploymentsTest.Opts,
+		GlobalOpts: cli.GlobalOpts{
+			ProjectID: "64f670f0bf789926667dad1a",
+		},
+		OutputOpts: cli.OutputOpts{
+			OutWriter: buf,
+		},
+		DeleteOpts: cli.NewDeleteOpts(deleteSuccessMessage, deleteFailMessage),
+	}
+
+	deploymentsTest.MockDeploymentTelemetry.EXPECT().AppendDeploymentType().Times(1)
+
+	if err := opts.PostRun(); err != nil {
+		t.Fatalf("PostRun() unexpected error: %v", err)
+	}
+}

internal/cli/atlas/deployments/list.go

@@ -71,6 +71,7 @@ func (opts *ListOpts) Run(ctx context.Context) error {
 }
 
 func (opts *ListOpts) PostRun() error {
+	opts.UpdateDeploymentTelemetry()
 	return opts.PostRunMessages()
 }
 
@@ -89,7 +90,8 @@ func ListBuilder() *cobra.Command {
 		PreRunE: func(cmd *cobra.Command, _ []string) error {
 			return opts.PreRunE(
 				opts.InitStore(cmd.Context(), cmd.OutOrStdout()),
-				opts.InitOutput(cmd.OutOrStdout(), listTemplate))
+				opts.InitOutput(cmd.OutOrStdout(), listTemplate),
+			)
 		},
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			return opts.Run(cmd.Context())

internal/cli/atlas/deployments/list_test.go

@@ -24,6 +24,7 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/atlas/deployments/options"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/atlas/deployments/test/fixture"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/flag"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/mocks"
@@ -147,3 +148,43 @@ func TestListBuilder(t *testing.T) {
 		[]string{flag.ProjectID},
 	)
 }
+
+func TestList_PostRun(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	buf := new(bytes.Buffer)
+
+	mockStore := mocks.NewMockClusterLister(ctrl)
+	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
+	mockProfileReader := mocks.NewMockProfileReader(ctrl)
+
+	deploymentsTest := fixture.NewMockLocalDeploymentOpts(ctrl, "localDeployment")
+	deploymentsTest.Opts.Config = mockProfileReader
+	deploymentsTest.Opts.CredStore = mockCredentialsGetter
+	deploymentsTest.Opts.AtlasClusterListStore = mockStore
+
+	listOpts := &ListOpts{
+		DeploymentOpts: *deploymentsTest.Opts,
+		GlobalOpts: cli.GlobalOpts{
+			ProjectID: "64f670f0bf789926667dad1a",
+		},
+		OutputOpts: cli.OutputOpts{
+			Template:  listTemplate,
+			OutWriter: buf,
+		},
+	}
+
+	mockCredentialsGetter.
+		EXPECT().
+		AuthType().
+		Return(config.OAuth).
+		Times(1)
+
+	deploymentsTest.MockDeploymentTelemetry.
+		EXPECT().
+		AppendDeploymentType().
+		Times(1)
+
+	if err := listOpts.PostRun(); err != nil {
+		t.Fatalf("PostRun() unexpected error: %v", err)
+	}
+}

internal/cli/atlas/deployments/options/connect_opts_local.go

@@ -15,13 +15,9 @@ package options
 
 import (
 	"context"
-
-	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/telemetry"
 )
 
 func (opts *ConnectOpts) connectToLocal(ctx context.Context) error {
-	telemetry.AppendOption(telemetry.WithDeploymentType(LocalCluster))
-
 	connectionString, err := opts.ConnectionString(ctx)
 	if err != nil {
 		return err

internal/cli/atlas/deployments/options/deployment_opts.go

@@ -96,6 +96,7 @@ type DeploymentOpts struct {
 	DefaultSetter         cli.DefaultSetterOpts
 	AtlasClusterListStore store.ClusterLister
 	Config                setup.ProfileReader
+	DeploymentTelemetry   DeploymentTelemetry
 }
 
 type Deployment struct {
@@ -115,6 +116,8 @@ func (opts *DeploymentOpts) InitStore(ctx context.Context, writer io.Writer) fun
 			return err
 		}
 		opts.DefaultSetter.OutWriter = writer
+		opts.DeploymentTelemetry = NewDeploymentTypeTelemetry(opts)
+		opts.UpdateDeploymentTelemetry()
 		return opts.DefaultSetter.InitStore(ctx)
 	}
 }
@@ -256,3 +259,7 @@ func (opts *DeploymentOpts) NoDeploymentTypeSet() bool {
 func (opts *DeploymentOpts) IsAuthEnabled() bool {
 	return opts.DBUsername != ""
 }
+
+func (opts *DeploymentOpts) UpdateDeploymentTelemetry() {
+	opts.DeploymentTelemetry.AppendDeploymentType()
+}

internal/cli/atlas/deployments/options/deployment_opts_select.go

@@ -102,9 +102,9 @@ func (opts *DeploymentOpts) Select(deployments []Deployment) (Deployment, error)
 
 	if len(deployments) == 1 {
 		opts.DeploymentName = deployments[0].Name
-		opts.DeploymentType = deployments[0].Type
+		opts.DeploymentType = strings.ToLower(deployments[0].Type)
 
-		telemetry.AppendOption(telemetry.WithDeploymentType(opts.DeploymentType))
+		opts.AppendDeploymentType()
 		return deployments[0], nil
 	}
 
@@ -130,7 +130,7 @@ func (opts *DeploymentOpts) Select(deployments []Deployment) (Deployment, error)
 
 	deployment := deploymentsByDisplayName[displayName]
 	opts.DeploymentName = deployment.Name
-	opts.DeploymentType = deployment.Type
-	telemetry.AppendOption(telemetry.WithDeploymentType(opts.DeploymentType))
+	opts.DeploymentType = strings.ToLower(deployment.Type)
+	opts.AppendDeploymentType()
 	return deployment, nil
 }

internal/cli/atlas/deployments/options/deployment_opts_telemetry.go

@@ -0,0 +1,40 @@
+// Copyright 2023 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package options
+
+import (
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/telemetry"
+)
+
+//go:generate mockgen -destination=../../../../mocks/mock_deployment_opts_telemetry.go -package=mocks github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/atlas/deployments/options DeploymentTelemetry
+type DeploymentTelemetry interface {
+	AppendDeploymentType()
+}
+
+func NewDeploymentTypeTelemetry(opts *DeploymentOpts) DeploymentTelemetry {
+	return opts
+}
+
+func (opts *DeploymentOpts) AppendDeploymentType() {
+	var deploymentType string
+	if opts.IsLocalDeploymentType() {
+		deploymentType = LocalCluster
+	} else if opts.IsAtlasDeploymentType() {
+		deploymentType = AtlasCluster
+	}
+	if deploymentType != "" {
+		telemetry.AppendOption(telemetry.WithDeploymentType(deploymentType))
+	}
+}

internal/cli/atlas/deployments/setup.go

@@ -815,7 +815,7 @@ func (opts *SetupOpts) Run(ctx context.Context) error {
 		return err
 	}
 
-	telemetry.AppendOption(telemetry.WithDeploymentType(opts.DeploymentType))
+	opts.AppendDeploymentType()
 	if strings.EqualFold(options.LocalCluster, opts.DeploymentType) {
 		return opts.runLocal(ctx)
 	}

internal/cli/atlas/deployments/test/fixture/deployment.go

@@ -24,5 +24,6 @@ type MockDeploymentOpts struct {
 	MockCredentialsGetter     *mocks.MockCredentialsGetter
 	MockAtlasClusterListStore *mocks.MockClusterLister
 	MockPodman                *mocks.MockClient
+	MockDeploymentTelemetry   *mocks.MockDeploymentTelemetry
 	Opts                      *options.DeploymentOpts
 }