CLOUDP-322512: Use latest SDK for atlas deployments list (#3934)

blva · web-flow · commit fe75b12cea9e · 2025-06-06T11:18:14.000+01:00
diff --git a/internal/cli/deployments/list_test.go b/internal/cli/deployments/list_test.go
@@ -30,13 +30,13 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store"
 	"github.com/stretchr/testify/assert"
-	atlasClustersPinned "go.mongodb.org/atlas-sdk/v20240530005/admin"
+	atlasv2 "go.mongodb.org/atlas-sdk/v20250312003/admin"
 	"go.uber.org/mock/gomock"
 )
 
 func TestList_Run(t *testing.T) {
 	ctrl := gomock.NewController(t)
-	mockStore := mocks.NewMockClusterLister(ctrl)
+	mockStore := fixture.NewMockClusterLister(ctrl)
 	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
 	mockContainerEngine := mocks.NewMockEngine(ctrl)
 	ctx := t.Context()
@@ -46,8 +46,8 @@ func TestList_Run(t *testing.T) {
 		cli.TokenRefreshed = false
 	})
 
-	expectedAtlasClusters := &atlasClustersPinned.PaginatedAdvancedClusterDescription{
-		Results: &[]atlasClustersPinned.AdvancedClusterDescription{
+	expectedAtlasClusters := &atlasv2.PaginatedClusterDescription20240805{
+		Results: &[]atlasv2.ClusterDescription20240805{
 			{
 				Name:           pointer.Get("atlasCluster2"),
 				Id:             pointer.Get("123"),
@@ -96,7 +96,7 @@ func TestList_Run(t *testing.T) {
 
 	mockStore.
 		EXPECT().
-		ProjectClusters(listOpts.ProjectID,
+		LatestProjectClusters(listOpts.ProjectID,
 			&store.ListOptions{
 				PageNum:      cli.DefaultPage,
 				ItemsPerPage: options.MaxItemsPerPage,
@@ -141,7 +141,7 @@ localTest2      LOCAL   6.0.9     IDLE
 
 func TestList_Run_NoLocal(t *testing.T) {
 	ctrl := gomock.NewController(t)
-	mockStore := mocks.NewMockClusterLister(ctrl)
+	mockStore := fixture.NewMockClusterLister(ctrl)
 	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
 
 	mockContainerEngine := mocks.NewMockEngine(ctrl)
@@ -152,8 +152,8 @@ func TestList_Run_NoLocal(t *testing.T) {
 		cli.TokenRefreshed = false
 	})
 
-	expectedAtlasClusters := &atlasClustersPinned.PaginatedAdvancedClusterDescription{
-		Results: &[]atlasClustersPinned.AdvancedClusterDescription{
+	expectedAtlasClusters := &atlasv2.PaginatedClusterDescription20240805{
+		Results: &[]atlasv2.ClusterDescription20240805{
 			{
 				Name:           pointer.Get("atlasCluster2"),
 				Id:             pointer.Get("123"),
@@ -189,7 +189,7 @@ func TestList_Run_NoLocal(t *testing.T) {
 
 	mockStore.
 		EXPECT().
-		ProjectClusters(listOpts.ProjectID,
+		LatestProjectClusters(listOpts.ProjectID,
 			&store.ListOptions{
 				PageNum:      cli.DefaultPage,
 				ItemsPerPage: options.MaxItemsPerPage,
@@ -232,7 +232,7 @@ atlasCluster1   ATLAS   7.0.0     IDLE
 
 func TestList_Run_NoAtlas(t *testing.T) {
 	ctrl := gomock.NewController(t)
-	mockStore := mocks.NewMockClusterLister(ctrl)
+	mockStore := fixture.NewMockClusterLister(ctrl)
 	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
 	mockContainerEngine := mocks.NewMockEngine(ctrl)
 	ctx := t.Context()
@@ -242,8 +242,8 @@ func TestList_Run_NoAtlas(t *testing.T) {
 		cli.TokenRefreshed = false
 	})
 
-	expectedAtlasClusters := &atlasClustersPinned.PaginatedAdvancedClusterDescription{
-		Results: &[]atlasClustersPinned.AdvancedClusterDescription{
+	expectedAtlasClusters := &atlasv2.PaginatedClusterDescription20240805{
+		Results: &[]atlasv2.ClusterDescription20240805{
 			{
 				Name:           pointer.Get("atlasCluster2"),
 				Id:             pointer.Get("123"),
@@ -279,7 +279,7 @@ func TestList_Run_NoAtlas(t *testing.T) {
 
 	mockStore.
 		EXPECT().
-		ProjectClusters(listOpts.ProjectID,
+		LatestProjectClusters(listOpts.ProjectID,
 			&store.ListOptions{
 				PageNum:      cli.DefaultPage,
 				ItemsPerPage: options.MaxItemsPerPage,
@@ -324,7 +324,7 @@ func TestListOpts_PostRun(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	buf := new(bytes.Buffer)
 
-	mockStore := mocks.NewMockClusterLister(ctrl)
+	mockStore := fixture.NewMockClusterLister(ctrl)
 	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
 
 	deploymentsTest := fixture.NewMockLocalDeploymentOpts(ctrl, "localDeployment")
diff --git a/internal/cli/deployments/options/deployment_opts.go b/internal/cli/deployments/options/deployment_opts.go
@@ -37,8 +37,11 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage"
 	"github.com/shirou/gopsutil/v4/cpu"
 	"github.com/shirou/gopsutil/v4/mem"
+	atlasv2 "go.mongodb.org/atlas-sdk/v20250312003/admin"
 )
 
+//go:generate go tool go.uber.org/mock/mockgen -typed -destination=../test/fixture/deployment_opts_mocks.go -package=fixture . ClusterLister
+
 const (
 	spinnerSpeed = 100 * time.Millisecond
 	// based on https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster
@@ -100,7 +103,7 @@ type DeploymentOpts struct {
 	CredStore             store.CredentialsGetter
 	s                     *spinner.Spinner
 	DefaultSetter         cli.DefaultSetterOpts
-	AtlasClusterListStore store.ClusterLister
+	AtlasClusterListStore ClusterLister
 	Config                ProfileReader
 	DeploymentTelemetry   DeploymentTelemetry
 	DeploymentUUID        string
@@ -113,6 +116,10 @@ type Deployment struct {
 	StateName      string
 }
 
+type ClusterLister interface {
+	LatestProjectClusters(string, *store.ListOptions) (*atlasv2.PaginatedClusterDescription20240805, error)
+}
+
 func (opts *DeploymentOpts) InitStore(ctx context.Context, writer io.Writer) func() error {
 	return func() error {
 		var err error
diff --git a/internal/cli/deployments/options/deployment_opts_pre_run.go b/internal/cli/deployments/options/deployment_opts_pre_run.go
@@ -154,7 +154,7 @@ func (opts *DeploymentOpts) AtlasDeployments(projectID string) ([]Deployment, er
 		ItemsPerPage: MaxItemsPerPage,
 	}
 
-	atlasClusters, err := opts.AtlasClusterListStore.ProjectClusters(projectID, listOpts)
+	atlasClusters, err := opts.AtlasClusterListStore.LatestProjectClusters(projectID, listOpts)
 	if err != nil {
 		return nil, err
 	}
diff --git a/internal/cli/deployments/test/fixture/deployment.go b/internal/cli/deployments/test/fixture/deployment.go
@@ -22,7 +22,7 @@ import (
 type MockDeploymentOpts struct {
 	ctrl                      *gomock.Controller
 	MockCredentialsGetter     *mocks.MockCredentialsGetter
-	MockAtlasClusterListStore *mocks.MockClusterLister
+	MockAtlasClusterListStore *MockClusterLister
 	MockContainerEngine       *mocks.MockEngine
 	MockDeploymentTelemetry   *mocks.MockDeploymentTelemetry
 	Opts                      *options.DeploymentOpts
diff --git a/internal/cli/deployments/test/fixture/deployment_atlas.go b/internal/cli/deployments/test/fixture/deployment_atlas.go
@@ -19,13 +19,13 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/mocks"
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/pointer"
-	atlasClustersPinned "go.mongodb.org/atlas-sdk/v20240530005/admin"
+	atlasv2 "go.mongodb.org/atlas-sdk/v20250312003/admin"
 	"go.uber.org/mock/gomock"
 )
 
 func NewMockAtlasDeploymentOpts(ctrl *gomock.Controller, deploymentName string) MockDeploymentOpts {
 	mockCredentialsGetter := mocks.NewMockCredentialsGetter(ctrl)
-	mockAtlasClusterListStore := mocks.NewMockClusterLister(ctrl)
+	mockAtlasClusterListStore := NewMockClusterLister(ctrl)
 	mockDeploymentTelemetry := mocks.NewMockDeploymentTelemetry(ctrl)
 
 	return MockDeploymentOpts{
@@ -43,9 +43,9 @@ func NewMockAtlasDeploymentOpts(ctrl *gomock.Controller, deploymentName string)
 	}
 }
 
-func (m *MockDeploymentOpts) MockPaginatedAdvancedClusterDescription(state string) *atlasClustersPinned.PaginatedAdvancedClusterDescription {
-	return &atlasClustersPinned.PaginatedAdvancedClusterDescription{
-		Results: &[]atlasClustersPinned.AdvancedClusterDescription{
+func (m *MockDeploymentOpts) MockPaginatedAdvancedClusterDescription(state string) *atlasv2.PaginatedClusterDescription20240805 {
+	return &atlasv2.PaginatedClusterDescription20240805{
+		Results: &[]atlasv2.ClusterDescription20240805{
 			{
 				Name:           pointer.Get(m.Opts.DeploymentName),
 				Id:             pointer.Get("123"),
@@ -70,7 +70,7 @@ func (m *MockDeploymentOpts) CommonAtlasMocksWithState(projectID string, state s
 
 	m.MockAtlasClusterListStore.
 		EXPECT().
-		ProjectClusters(projectID, gomock.Any()).
+		LatestProjectClusters(projectID, gomock.Any()).
 		Return(m.MockPaginatedAdvancedClusterDescription(state), nil).
 		Times(1)
 
diff --git a/internal/cli/deployments/test/fixture/deployment_opts_mocks.go b/internal/cli/deployments/test/fixture/deployment_opts_mocks.go
diff --git a/internal/mocks/mock_clusters.go b/internal/mocks/mock_clusters.go
diff --git a/internal/store/clusters.go b/internal/store/clusters.go
@@ -20,12 +20,7 @@ import (
 	atlas "go.mongodb.org/atlas/mongodbatlas"
 )
 
-//go:generate go tool go.uber.org/mock/mockgen -destination=../mocks/mock_clusters.go -package=mocks github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store ClusterLister,ClusterDescriber
-
-type ClusterLister interface { //nolint:iface // right now requires some refactor to deployment commands
-	ProjectClusters(string, *ListOptions) (*atlasClustersPinned.PaginatedAdvancedClusterDescription, error)
-	ListFlexClusters(*atlasv2.ListFlexClustersApiParams) (*atlasv2.PaginatedFlexClusters20241113, error)
-}
+//go:generate go tool go.uber.org/mock/mockgen -destination=../mocks/mock_clusters.go -package=mocks github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store ClusterDescriber
 
 type ClusterDescriber interface { //nolint:iface // right now requires some refactor to deployment commands
 	AtlasCluster(string, string) (*atlasClustersPinned.AdvancedClusterDescription, error)
@@ -102,6 +97,16 @@ func (s *Store) ProjectClusters(projectID string, opts *ListOptions) (*atlasClus
 	return result, err
 }
 
+// LatestProjectClusters lists the clusters using the latest API version.
+func (s *Store) LatestProjectClusters(projectID string, opts *ListOptions) (*atlasv2.PaginatedClusterDescription20240805, error) {
+	res := s.clientv2.ClustersApi.ListClusters(s.ctx, projectID)
+	if opts != nil {
+		res = res.PageNum(opts.PageNum).ItemsPerPage(opts.ItemsPerPage).IncludeCount(opts.IncludeCount)
+	}
+	result, _, err := res.Execute()
+	return result, err
+}
+
 // AtlasCluster encapsulates the logic to manage different cloud providers.
 func (s *Store) AtlasCluster(projectID, name string) (*atlasClustersPinned.AdvancedClusterDescription, error) {
 	result, _, err := s.clientClusters.ClustersApi.GetCluster(s.ctx, projectID, name).Execute()

Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ func (opts *DeploymentOpts) AtlasDeployments(projectID string) ([]Deployment, er`
`154`	`154`	`ItemsPerPage: MaxItemsPerPage,`
`155`	`155`	`}`
`156`	`156`
`157`		`- atlasClusters, err := opts.AtlasClusterListStore.ProjectClusters(projectID, listOpts)`
	`157`	`+ atlasClusters, err := opts.AtlasClusterListStore.LatestProjectClusters(projectID, listOpts)`
`158`	`158`	`if err != nil {`
`159`	`159`	`return nil, err`
`160`	`160`	`}`