CLOUDP-93398: Allow to reclaim free space for a cluster (#761)

Author: andreaangiolillo

e2e/E2E-TESTS.md

@@ -280,6 +280,7 @@ Command                                         | E2E Atlas | E2E OM    | E2E CM
 | `cluster  startup`                            |           | N         | N         |           | Y     | Y     |
 | `cluster  unmanage`                           |           | Y         | Y         |           | Y     | Y     |
 | `cluster  update`                             |           | N         | N         |           | Y     | Y     |
+| `cluster  reclaimFreeSpace`                   |           | Y         | Y         |           | Y     | Y     |
 | `cluster  index create`                       |           | N         | N         |           | Y     | Y     |
 | `dbuser create`                               |           | N         | Y         |           | Y     | Y     |
 | `dbuser delete`                               |           | N         | Y         |           | Y     | Y     |

e2e/cloud_manager/deploy_replica_set_test.go

@@ -114,6 +114,23 @@ func TestDeployReplicaSet(t *testing.T) {
 		}
 	})
 
+	t.Run("Reclaim free space", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			entity,
+			clustersEntity,
+			"reclaimFreeSpace",
+			clusterName,
+			"--force",
+		)
+
+		cmd.Env = os.Environ()
+		if resp, err := cmd.CombinedOutput(); err != nil {
+			t.Fatalf("unexpected error: %v, resp: %v\n", err, string(resp))
+		}
+	})
+
+	t.Run("Watch", watchAutomation(cliPath))
+
 	t.Run("Restart", func(t *testing.T) {
 		cmd := exec.Command(cliPath,
 			entity,

e2e/cloud_manager/deploy_sharded_cluster_test.go

@@ -80,6 +80,23 @@ func TestDeployCluster(t *testing.T) {
 
 	t.Run("Watch", watchAutomation(cliPath))
 
+	t.Run("Reclaim free space", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			entity,
+			clustersEntity,
+			"reclaimFreeSpace",
+			clusterName,
+			"--force",
+		)
+
+		cmd.Env = os.Environ()
+		if resp, err := cmd.CombinedOutput(); err != nil {
+			t.Fatalf("unexpected error: %v, resp: %v\n", err, string(resp))
+		}
+	})
+
+	t.Run("Watch", watchAutomation(cliPath))
+
 	t.Run("Shutdown", func(t *testing.T) {
 		cmd := exec.Command(cliPath,
 			entity,

go.mod

@@ -22,6 +22,6 @@ require (
 	github.com/stretchr/testify v1.7.0
 	github.com/tangzero/inflector v1.0.0
 	go.mongodb.org/atlas v0.10.1
-	go.mongodb.org/ops-manager v0.24.1-0.20210712085958-0820f6a47c22
+	go.mongodb.org/ops-manager v0.25.0
 	gopkg.in/yaml.v2 v2.4.0
 )

go.sum

@@ -296,8 +296,8 @@ go.etcd.io/etcd/client/v2 v2.305.0/go.mod h1:h9puh54ZTgAKtEbut2oe9P4L/oqKCVB6xsX
 go.mongodb.org/atlas v0.9.1-0.20210707095538-d4a51579e8e0/go.mod h1:MMWDsc2akjTDSG4tVQrxv/82p3QbBnqeELbtTl45sbg=
 go.mongodb.org/atlas v0.10.1 h1:IerzfJ7wqxJpaXen3jewg2+kUBnq2elMz2OPOz7Usas=
 go.mongodb.org/atlas v0.10.1/go.mod h1:MMWDsc2akjTDSG4tVQrxv/82p3QbBnqeELbtTl45sbg=
-go.mongodb.org/ops-manager v0.24.1-0.20210712085958-0820f6a47c22 h1:t6i0M0UtPU0r0LbU+XKu9sOEX1efB62TM24gccZtyjo=
-go.mongodb.org/ops-manager v0.24.1-0.20210712085958-0820f6a47c22/go.mod h1:XgJU31JIcelHxW2ilkAO+R0vsvka9QiUdJOlWWHyKSw=
+go.mongodb.org/ops-manager v0.25.0 h1:EtPL2rPG+V6IYsFA75BOo7rm2uIENi1derJ6v6aIY7c=
+go.mongodb.org/ops-manager v0.25.0/go.mod h1:XgJU31JIcelHxW2ilkAO+R0vsvka9QiUdJOlWWHyKSw=
 go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
 go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
 go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=

internal/cli/opsmanager/clusters/clusters.go

@@ -31,14 +31,15 @@ func Builder() *cobra.Command {
 		ListBuilder(),
 		DescribeBuilder(),
 		CreateBuilder(),
-		ShutdownBuilder(),
-		StartupBuilder(),
 		UpdateBuilder(),
 		DeleteBuilder(),
 		ApplyBuilder(),
 		IndexesBuilder(),
 		UnmanageBuilder(),
 		RestartBuilder(),
+		StartupBuilder(),
+		ShutdownBuilder(),
+		ReclaimFreeSpaceBuilder(),
 	)
 
 	return cmd

internal/cli/opsmanager/clusters/clusters_test.go

@@ -26,7 +26,7 @@ func TestBuilder(t *testing.T) {
 	test.CmdValidator(
 		t,
 		Builder(),
-		11,
+		12,
 		[]string{},
 	)
 }

internal/cli/opsmanager/clusters/reclaim_free_space.go

@@ -0,0 +1,115 @@
+// Copyright 2021 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 clusters
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/AlecAivazis/survey/v2"
+	"github.com/mongodb/mongocli/internal/cli"
+	"github.com/mongodb/mongocli/internal/cli/require"
+	"github.com/mongodb/mongocli/internal/config"
+	"github.com/mongodb/mongocli/internal/flag"
+	"github.com/mongodb/mongocli/internal/store"
+	"github.com/mongodb/mongocli/internal/usage"
+	"github.com/spf13/cobra"
+	"go.mongodb.org/ops-manager/atmcfg"
+)
+
+type ReclaimFreeSpaceOpts struct {
+	cli.GlobalOpts
+	confirm     bool
+	clusterName string
+	timestamp   string
+	processes   []string
+	store       store.AutomationPatcher
+}
+
+func (opts *ReclaimFreeSpaceOpts) initStore() error {
+	var err error
+	opts.store, err = store.New(store.AuthenticatedPreset(config.Default()))
+	return err
+}
+
+func (opts *ReclaimFreeSpaceOpts) Run() error {
+	current, err := opts.store.GetAutomationConfig(opts.ConfigProjectID())
+	if err != nil {
+		return err
+	}
+
+	err = atmcfg.ReclaimFreeSpaceForProcessesByClusterName(current, opts.clusterName, opts.timestamp, opts.processes)
+	if err != nil {
+		return err
+	}
+
+	if err := opts.store.UpdateAutomationConfig(opts.ConfigProjectID(), current); err != nil {
+		return err
+	}
+
+	fmt.Print(cli.DeploymentStatus(config.OpsManagerURL(), opts.ConfigProjectID()))
+
+	return nil
+}
+
+func (opts *ReclaimFreeSpaceOpts) Confirm() error {
+	if opts.confirm {
+		return nil
+	}
+
+	process := opts.clusterName
+
+	if len(opts.processes) > 0 {
+		process = fmt.Sprintf("%s (%s)", opts.clusterName, strings.Join(opts.processes, ", "))
+	}
+
+	prompt := &survey.Confirm{
+		Message: fmt.Sprintf("Are you sure you want to reclaim free space for: %s", process),
+	}
+	return survey.AskOne(prompt, &opts.confirm)
+}
+
+// mongocli cloud-manager cluster(s) reclaimFreeSpace|rfs <clusterName> [--processName process1,process2...][--timestamp timestamp] [--force].
+func ReclaimFreeSpaceBuilder() *cobra.Command {
+	opts := &ReclaimFreeSpaceOpts{}
+	cmd := &cobra.Command{
+		Use:     "reclaimFreeSpace <clusterName>",
+		Short:   "Reclaim unused space for a cluster.",
+		Aliases: []string{"rfs"},
+		Args:    require.ExactArgs(1),
+		Annotations: map[string]string{
+			"args":            "clusterName",
+			"clusterNameDesc": "Name of the cluster for which you want to reclaim free space.",
+		},
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			if err := opts.PreRunE(opts.ValidateProjectID, opts.initStore); err != nil {
+				return err
+			}
+			opts.clusterName = args[0]
+			return opts.Confirm()
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return opts.Run()
+		},
+	}
+
+	cmd.Flags().StringSliceVar(&opts.processes, flag.ProcessName, []string{}, usage.ProcessName)
+	cmd.Flags().BoolVar(&opts.confirm, flag.Force, false, usage.Force)
+	cmd.Flags().StringVar(&opts.timestamp, flag.Timestamp, "", usage.ReclaimFreeSpaceTimestamp)
+
+	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
+
+	return cmd
+}

internal/cli/opsmanager/clusters/reclaim_free_space_test.go

@@ -0,0 +1,66 @@
+// Copyright 2021 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.
+
+// +build unit
+
+package clusters
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/mongodb/mongocli/internal/flag"
+	"github.com/mongodb/mongocli/internal/mocks"
+	"github.com/mongodb/mongocli/internal/test"
+	"github.com/mongodb/mongocli/internal/test/fixture"
+)
+
+func TestReclaimFreeSpace_Run(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mockStore := mocks.NewMockAutomationPatcher(ctrl)
+	defer ctrl.Finish()
+
+	expected := fixture.AutomationConfig()
+
+	opts := &ReclaimFreeSpaceOpts{
+		store:       mockStore,
+		confirm:     true,
+		clusterName: "myReplicaSet2",
+	}
+
+	mockStore.
+		EXPECT().
+		GetAutomationConfig(opts.ProjectID).
+		Return(expected, nil).
+		Times(1)
+
+	mockStore.
+		EXPECT().
+		UpdateAutomationConfig(opts.ProjectID, expected).
+		Return(nil).
+		Times(1)
+
+	if err := opts.Run(); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+}
+
+func TestReclaimFreeSpaceBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		ReclaimFreeSpaceBuilder(),
+		0,
+		[]string{flag.ProjectID, flag.Force, flag.ProcessName},
+	)
+}

internal/flag/flags.go

@@ -250,5 +250,6 @@ const (
 	Policy                          = "policy"                          // Policy flag
 	SystemID                        = "systemId"                        // SystemID flag
 	Default                         = "default"                         // Default flag
+	Timestamp                       = "timestamp"                       // Timestamp flag
 
 )