CLOUDP-273727 "atlas deployments search index describe" fails with unclear error message when local deployment is paused (#3284)

Author: fmenezes

internal/cli/deployments/options/deployment_opts_pre_run.go

@@ -17,6 +17,7 @@ package options
 import (
 	"context"
 	"errors"
+	"fmt"
 	"runtime"
 	"slices"
 
@@ -26,6 +27,8 @@ import (
 	atlasv2 "go.mongodb.org/atlas-sdk/v20240805001/admin"
 )
 
+var errDeploymentUnexpectedState = errors.New("deployment is in unexpected state")
+
 func (opts *DeploymentOpts) listDeployments(ctx context.Context, projectID string) ([]Deployment, error) {
 	var atlasDeployments, localDeployments []Deployment
 	var atlasErr, localErr error
@@ -72,9 +75,20 @@ func (opts *DeploymentOpts) SelectDeployments(ctx context.Context, projectID str
 	}
 
 	deployments = opts.filterDeploymentByName(deployments...)
-	deployments = opts.filterDeploymentByState(deployments, states...)
+	if opts.DeploymentName == "" {
+		deployments = opts.filterDeploymentByState(deployments, states...)
+	}
+
+	d, err := opts.Select(deployments)
+	if err != nil {
+		return Deployment{}, err
+	}
+
+	if len(states) > 0 && !slices.Contains(states, d.StateName) {
+		return Deployment{}, fmt.Errorf("%w: %s", errDeploymentUnexpectedState, d.StateName)
+	}
 
-	return opts.Select(deployments)
+	return d, nil
 }
 
 func isUnauthenticatedErr(err error) bool {

internal/cli/deployments/search/indexes/list.go

@@ -43,7 +43,7 @@ type ListOpts struct {
 }
 
 func (opts *ListOpts) Run(ctx context.Context) error {
-	if _, err := opts.SelectDeployments(ctx, opts.ConfigProjectID()); err != nil {
+	if _, err := opts.SelectDeployments(ctx, opts.ConfigProjectID(), options.IdleState); err != nil {
 		return err
 	}