CLOUDP-323576: Add autoScalingMode support to atlas clusters update (#3983)

Author: blva

docs/command/atlas-clusters-describe.txt

@@ -58,6 +58,10 @@ Options
      - Type
      - Required
      - Description
+   * - --autoScalingMode
+     - string
+     - false
+     - Mode in which the cluster scales. Valid values are clusterWideScaling or independentShardScaling. This value defaults to "clusterWideScaling".
    * - -h, --help
      - 
      - false

docs/command/atlas-clusters-update.txt

@@ -67,6 +67,12 @@ Options
      - Type
      - Required
      - Description
+   * - --autoScalingMode
+     - string
+     - false
+     - Mode in which the cluster scales. Valid values are clusterWideScaling or independentShardScaling.
+
+       Mutually exclusive with --file.
    * - --disableTerminationProtection
      - 
      - false
@@ -90,7 +96,7 @@ Options
      - false
      - Path to an optional JSON configuration file that defines cluster settings. Note: Unsupported fields in the JSON file are ignored. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
 
-       Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag.
+       Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag, --autoScalingMode.
    * - -h, --help
      - 
      - false

internal/cli/clusters/clusters.go

@@ -26,7 +26,9 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/clusters/onlinearchive"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/clusters/sampledata"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/search"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/file"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/telemetry"
+	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 	atlasClustersPinned "go.mongodb.org/atlas-sdk/v20240530005/admin"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20250312003/admin"
@@ -202,6 +204,27 @@ func isClusterWideScaling(mode string) bool {
 	return strings.EqualFold(mode, clusterWideScalingFlag) || strings.EqualFold(mode, clusterWideScalingResponse)
 }
 
+func detectIsFileISS(fs afero.Fs, filename string) string {
+	// First try to load as a default dedicated cluster in strict mode.
+	// If it succeeds, it is a default dedicated cluster.
+	oldCluster := new(atlasClustersPinned.AdvancedClusterDescription)
+	oldLoadErr := file.StrictLoad(fs, filename, oldCluster)
+	if oldLoadErr == nil {
+		return clusterWideScalingFlag
+	}
+
+	// Then try to load as an ISS cluster in strict mode.
+	// If it succeeds, it is an ISS cluster. If it fails, it is a default dedicated cluster.
+	cluster := new(atlasv2.ClusterDescription20240805)
+	latestLoadErr := file.StrictLoad(fs, filename, cluster)
+	if latestLoadErr == nil {
+		return independentShardScalingFlag
+	}
+
+	// default to cluster wide scaling
+	return clusterWideScalingFlag
+}
+
 func appendAutoScalingModeTelemetry(mode string) {
 	if mode == "" {
 		return

internal/cli/clusters/create.go

@@ -195,7 +195,7 @@ func (opts *CreateOpts) RunDedicatedCluster() error {
 }
 
 func (opts *CreateOpts) PostRun() error {
-	if opts.autoScalingMode == independentShardScalingFlag {
+	if isIndependentShardScaling(opts.autoScalingMode) {
 		return opts.PostRunDedicatedClusterLatest()
 	}
 
@@ -500,41 +500,17 @@ func (opts *CreateOpts) validateAutoScalingMode() error {
 		return err
 	}
 
-	if opts.filename != "" && isIndependentShardScaling(opts.autoScalingMode) {
-		return fmt.Errorf("auto scaling mode %s is not supported for files", opts.autoScalingMode)
-	}
-
 	if opts.isFlexCluster {
 		return nil
 	}
 
 	if opts.filename != "" {
-		opts.detectIsFileISS()
+		opts.autoScalingMode = detectIsFileISS(opts.fs, opts.filename)
 	}
 
 	return nil
 }
 
-func (opts *CreateOpts) detectIsFileISS() {
-	// First try to load as a default dedicated cluster in strict mode.
-	// If it succeeds, it is a default dedicated cluster.
-	oldCluster := new(atlasClustersPinned.AdvancedClusterDescription)
-	oldLoadErr := file.StrictLoad(opts.fs, opts.filename, oldCluster)
-	if oldLoadErr == nil {
-		opts.autoScalingMode = clusterWideScalingFlag
-		return
-	}
-
-	// Then try to load as an ISS cluster in strict mode.
-	// If it succeeds, it is an ISS cluster. If it fails, it is a default dedicated cluster.
-	cluster := new(atlasv2.ClusterDescription20240805)
-	latestLoadErr := file.StrictLoad(opts.fs, opts.filename, cluster)
-	if latestLoadErr == nil {
-		opts.autoScalingMode = independentShardScalingFlag
-		return
-	}
-}
-
 // CreateBuilder builds a cobra.Command that can run as:
 // create <name> --projectId projectId --provider AWS|GCP|AZURE --region regionName [--members N] [--tier M#] [--diskSizeGB N] [--backup] [--mdbVersion] [--tag key=value].
 func CreateBuilder() *cobra.Command {

internal/cli/clusters/create_test.go

@@ -451,21 +451,7 @@ func TestCreateOpts_RunDedicatedClusterLatest(t *testing.T) {
 		require.NoError(t, createOpts.Run())
 	})
 
-	t.Run("filename and autoScalingMode are not compatible", func(t *testing.T) {
-		appFS := afero.NewMemMapFs()
-		_ = afero.WriteFile(appFS, fileName, []byte("invalid"), 0600)
-
-		createOpts := &CreateOpts{
-			filename:        fileName,
-			fs:              appFS,
-			store:           mockStore,
-			autoScalingMode: independentShardScalingFlag,
-		}
-
-		require.Error(t, createOpts.validateAutoScalingMode())
-	})
-
-	t.Run("does not set autoScalingMode if invalid file", func(t *testing.T) {
+	t.Run("default to clusterWideScaling if invalid file", func(t *testing.T) {
 		appFS := afero.NewMemMapFs()
 		_ = afero.WriteFile(appFS, fileName, []byte("invalid"), 0600)
 
@@ -476,7 +462,7 @@ func TestCreateOpts_RunDedicatedClusterLatest(t *testing.T) {
 		}
 
 		require.NoError(t, createOpts.validateAutoScalingMode())
-		assert.Empty(t, createOpts.autoScalingMode)
+		assert.Equal(t, clusterWideScalingFlag, createOpts.autoScalingMode)
 	})
 }
 

internal/cli/clusters/describe.go

@@ -19,10 +19,13 @@ import (
 	"fmt"
 
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/commonerrors"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/require"
 	"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/store"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/validate"
 	"github.com/spf13/cobra"
 	atlasClustersPinned "go.mongodb.org/atlas-sdk/v20240530005/admin"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20250312003/admin"
@@ -34,14 +37,14 @@ type ClusterDescriber interface {
 	AtlasCluster(string, string) (*atlasClustersPinned.AdvancedClusterDescription, error)
 	FlexCluster(string, string) (*atlasv2.FlexClusterDescription20241113, error)
 	LatestAtlasCluster(string, string) (*atlasv2.ClusterDescription20240805, error)
-	GetClusterAutoScalingConfig(string, string) (*atlasv2.ClusterDescriptionAutoScalingModeConfiguration, error)
 }
 
 type DescribeOpts struct {
 	cli.ProjectOpts
 	cli.OutputOpts
-	name  string
-	store ClusterDescriber
+	name            string
+	autoScalingMode string
+	store           ClusterDescriber
 }
 
 func (opts *DescribeOpts) initStore(ctx context.Context) func() error {
@@ -57,9 +60,7 @@ var describeTemplate = `ID	NAME	MDB VER	STATE
 `
 
 func (opts *DescribeOpts) Run() error {
-	autoScalingModeConfig, err := opts.store.GetClusterAutoScalingConfig(opts.ConfigProjectID(), opts.name)
-	appendAutoScalingModeTelemetry(autoScalingModeConfig.GetAutoScalingMode())
-	if err == nil && isIndependentShardScaling(autoScalingModeConfig.GetAutoScalingMode()) {
+	if opts.autoScalingMode != "" && isIndependentShardScaling(opts.autoScalingMode) {
 		r, err := opts.store.LatestAtlasCluster(opts.ConfigProjectID(), opts.name)
 		if err != nil {
 			return err
@@ -82,12 +83,12 @@ func (opts *DescribeOpts) RunFlexCluster(err error) error {
 	}
 
 	if *apiError.ErrorCode != cannotUseFlexWithClusterApisErrorCode {
-		return err
+		return commonerrors.Check(err)
 	}
 
 	r, err := opts.store.FlexCluster(opts.ConfigProjectID(), opts.name)
 	if err != nil {
-		return err
+		return commonerrors.Check(err)
 	}
 
 	return opts.Print(r)
@@ -114,6 +115,7 @@ func DescribeBuilder() *cobra.Command {
 				opts.ValidateProjectID,
 				opts.initStore(cmd.Context()),
 				opts.InitOutput(cmd.OutOrStdout(), describeTemplate),
+				validate.AutoScalingMode(opts.autoScalingMode),
 			)
 		},
 		RunE: func(_ *cobra.Command, args []string) error {
@@ -124,6 +126,10 @@ func DescribeBuilder() *cobra.Command {
 
 	opts.AddProjectOptsFlags(cmd)
 	opts.AddOutputOptFlags(cmd)
+	cmd.Flags().StringVar(&opts.autoScalingMode, flag.AutoScalingMode, clusterWideScalingFlag, usage.AutoScalingMode)
+	_ = cmd.RegisterFlagCompletionFunc(flag.AutoScalingMode, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
+		return []string{clusterWideScalingFlag, independentShardScalingFlag}, cobra.ShellCompDirectiveDefault
+	})
 
 	return cmd
 }

internal/cli/clusters/describe_mock_test.go

@@ -28,9 +28,6 @@ import (
 	"go.uber.org/mock/gomock"
 )
 
-var clusterWideScalingConfig = &atlasv2.ClusterDescriptionAutoScalingModeConfiguration{AutoScalingMode: pointer.Get(clusterWideScalingResponse)}
-var independentShardScalingConfig = &atlasv2.ClusterDescriptionAutoScalingModeConfiguration{AutoScalingMode: pointer.Get(independentShardScalingResponse)}
-
 func TestDescribe_Run(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	mockStore := NewMockClusterDescriber(ctrl)
@@ -42,12 +39,6 @@ func TestDescribe_Run(t *testing.T) {
 		store: mockStore,
 	}
 
-	mockStore.
-		EXPECT().
-		GetClusterAutoScalingConfig(describeOpts.ProjectID, describeOpts.name).
-		Return(clusterWideScalingConfig, nil).
-		Times(1)
-
 	mockStore.
 		EXPECT().
 		AtlasCluster(describeOpts.ProjectID, describeOpts.name).
@@ -71,12 +62,6 @@ func TestDescribe_RunFlexCluster(t *testing.T) {
 		store: mockStore,
 	}
 
-	mockStore.
-		EXPECT().
-		GetClusterAutoScalingConfig(describeOpts.ProjectID, describeOpts.name).
-		Return(clusterWideScalingConfig, nil).
-		Times(1)
-
 	mockStore.
 		EXPECT().
 		AtlasCluster(describeOpts.ProjectID, describeOpts.name).
@@ -105,12 +90,6 @@ func TestDescribe_RunFlexCluster_Error(t *testing.T) {
 		store: mockStore,
 	}
 
-	mockStore.
-		EXPECT().
-		GetClusterAutoScalingConfig(describeOpts.ProjectID, describeOpts.name).
-		Return(clusterWideScalingConfig, nil).
-		Times(1)
-
 	mockStore.
 		EXPECT().
 		AtlasCluster(describeOpts.ProjectID, describeOpts.name).
@@ -133,16 +112,11 @@ func TestDescribe_RunDedicatedCluster_IndependentShardScaling(t *testing.T) {
 	expected := &atlasv2.ClusterDescription20240805{}
 
 	describeOpts := &DescribeOpts{
-		name:  "test",
-		store: mockStore,
+		name:            "test",
+		store:           mockStore,
+		autoScalingMode: independentShardScalingFlag,
 	}
 
-	mockStore.
-		EXPECT().
-		GetClusterAutoScalingConfig(describeOpts.ProjectID, describeOpts.name).
-		Return(independentShardScalingConfig, nil).
-		Times(1)
-
 	mockStore.
 		EXPECT().
 		LatestAtlasCluster(describeOpts.ProjectID, describeOpts.name).