CLOUDP-97432: live migration validation job status command (#859)

Author: colm-quinn

docs/command/mongocli-atlas-liveMigrations-create.txt

@@ -54,6 +54,11 @@ Options
      - string
      - false
      - Organization ID to use. Overrides configuration file or environment variable settings.
+   * - -o, --output
+     - string
+     - false
+     - Output format.
+       Valid values: json|json-path|go-template|go-template-file
    * - --sourceCACertificatePath
      - string
      - false

docs/command/mongocli-atlas-liveMigrations-validation-create.txt

@@ -54,6 +54,11 @@ Options
      - string
      - false
      - Organization ID to use. Overrides configuration file or environment variable settings.
+   * - -o, --output
+     - string
+     - false
+     - Output format.
+       Valid values: json|json-path|go-template|go-template-file
    * - --sourceCACertificatePath
      - string
      - false

docs/command/mongocli-atlas-liveMigrations-validation-describe.txt

@@ -0,0 +1,70 @@
+.. _mongocli-atlas-liveMigrations-validation-describe:
+
+=================================================
+mongocli atlas liveMigrations validation describe
+=================================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Return one validation job.
+
+Your API Key must have the Organization Owner role to successfully run this command.
+
+Syntax
+------
+
+.. code-block::
+
+   mongocli atlas liveMigrations validation describe [options]
+
+Options
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -h, --help
+     - 
+     - false
+     - help for describe
+   * - -o, --output
+     - string
+     - false
+     - Output format.
+       Valid values: json|json-path|go-template|go-template-file
+   * - --projectId
+     - string
+     - false
+     - Project ID to use. Overrides configuration file or environment variable settings.
+   * - --validationId
+     - string
+     - false
+     - Unique 24-hexadecimal digit string that identifies the validation job.
+
+Inherited Options
+-----------------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 10 60
+
+   * - Name
+     - Type
+     - Required
+     - Description
+   * - -P, --profile
+     - string
+     - false
+     - Profile to use from your configuration file.
+

docs/command/mongocli-atlas-liveMigrations-validation.txt

@@ -50,10 +50,12 @@ Related Commands
 ----------------
 
 * :ref:`mongocli-atlas-liveMigrations-validation-create` - Create one new validation request.
+* :ref:`mongocli-atlas-liveMigrations-validation-describe` - Return one validation job.
 
 
 .. toctree::
    :titlesonly:
 
    create </command/mongocli-atlas-liveMigrations-validation-create>
+   describe </command/mongocli-atlas-liveMigrations-validation-describe>
 

internal/cli/atlas/livemigrations/create.go

@@ -15,15 +15,13 @@
 package livemigrations
 
 import (
-	"github.com/mongodb/mongocli/internal/cli"
 	"github.com/mongodb/mongocli/internal/cli/atlas/livemigrations/options"
 	"github.com/mongodb/mongocli/internal/config"
 	"github.com/mongodb/mongocli/internal/store"
 	"github.com/spf13/cobra"
 )
 
 type CreateOpts struct {
-	cli.OutputOpts
 	options.LiveMigrationsOpts
 	store store.LiveMigrationCreator
 }

internal/cli/atlas/livemigrations/options/live_migrations_opts.go

@@ -28,6 +28,7 @@ import (
 )
 
 type LiveMigrationsOpts struct {
+	cli.OutputOpts
 	cli.GlobalOpts
 	DestinationClusterName      string
 	DestinationDropEnabled      bool
@@ -138,6 +139,7 @@ func (opts *LiveMigrationsOpts) GenerateFlags(cmd *cobra.Command) {
 	cmd.Flags().StringVar(&opts.DestinationClusterName, flag.ClusterName, "", usage.LiveMigrationDestinationClusterName)
 	cmd.Flags().StringSliceVar(&opts.MigrationHosts, flag.LiveMigrationHost, []string{}, usage.LiveMigrationHostEntries)
 	cmd.Flags().BoolVar(&opts.DestinationDropEnabled, flag.LiveMigrationDropCollections, false, usage.LiveMigrationDropCollections)
+	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 
 	_ = cmd.MarkFlagRequired(flag.LiveMigrationSourceClusterName)
 	_ = cmd.MarkFlagRequired(flag.LiveMigrationSourceProjectID)

internal/cli/atlas/livemigrations/validation/create.go

@@ -15,15 +15,13 @@
 package validation
 
 import (
-	"github.com/mongodb/mongocli/internal/cli"
 	"github.com/mongodb/mongocli/internal/cli/atlas/livemigrations/options"
 	"github.com/mongodb/mongocli/internal/config"
 	"github.com/mongodb/mongocli/internal/store"
 	"github.com/spf13/cobra"
 )
 
 type CreateOpts struct {
-	cli.OutputOpts
 	options.LiveMigrationsOpts
 	store store.LiveMigrationValidationsCreator
 }

internal/cli/atlas/livemigrations/validation/describe.go

@@ -0,0 +1,78 @@
+// 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 validation
+
+import (
+	"github.com/mongodb/mongocli/internal/cli"
+	"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"
+)
+
+type DescribeOpts struct {
+	cli.GlobalOpts
+	cli.OutputOpts
+	validationID string
+	store        store.LiveMigrationValidationsDescriber
+}
+
+func (opts *DescribeOpts) initStore() error {
+	var err error
+	opts.store, err = store.New(store.AuthenticatedPreset(config.Default()))
+	return err
+}
+
+var describeTemplate = `ID	PROJECT ID	SOURCE PROJECT ID	STATUS
+{{.ID}}	{{.GroupID}}	{{.SourceGroupID}}	{{.Status}}`
+
+func (opts *DescribeOpts) Run() error {
+	r, err := opts.store.GetValidationStatus(opts.ConfigProjectID(), opts.validationID)
+
+	if err != nil {
+		return err
+	}
+
+	return opts.Print(r)
+}
+
+// mongocli atlas liveMigrations|lm validation(s) describe|get <validationId> [--projectId projectId].
+
+func DescribeBuilder() *cobra.Command {
+	opts := new(DescribeOpts)
+	cmd := &cobra.Command{
+		Use:     "describe",
+		Aliases: []string{"get"},
+		Short:   "Return one validation job.",
+		Long:    "Your API Key must have the Organization Owner role to successfully run this command.",
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			return opts.PreRunE(
+				opts.ValidateProjectID,
+				opts.initStore,
+				opts.InitOutput(cmd.OutOrStdout(), describeTemplate),
+			)
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return opts.Run()
+		},
+	}
+
+	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
+	cmd.Flags().StringVar(&opts.validationID, flag.LiveMigrationValidationID, "", usage.LiveMigrationValidationID)
+	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
+
+	return cmd
+}

internal/cli/atlas/livemigrations/validation/describe_test.go

@@ -0,0 +1,62 @@
+// 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.
+
+//go:build unit
+
+package validation
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/mongodb/mongocli/internal/cli"
+	"github.com/mongodb/mongocli/internal/flag"
+	"github.com/mongodb/mongocli/internal/mocks"
+	"github.com/mongodb/mongocli/internal/test"
+	"go.mongodb.org/atlas/mongodbatlas"
+)
+
+func TestValidationDescribeOpts_Run(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mockStore := mocks.NewMockLiveMigrationValidationsDescriber(ctrl)
+	defer ctrl.Finish()
+
+	expected := mongodbatlas.Validation{}
+
+	describeOpts := &DescribeOpts{
+		GlobalOpts:   cli.GlobalOpts{ProjectID: "2"},
+		validationID: "3",
+		store:        mockStore,
+	}
+
+	mockStore.
+		EXPECT().GetValidationStatus(describeOpts.ProjectID, describeOpts.validationID).Return(&expected, nil).
+		Times(1)
+
+	if err := describeOpts.Run(); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+}
+
+func TestDescribeBuilder(t *testing.T) {
+	test.CmdValidator(
+		t,
+		DescribeBuilder(),
+		0,
+		[]string{
+			flag.ProjectID,
+			flag.LiveMigrationValidationID,
+		},
+	)
+}

internal/cli/atlas/livemigrations/validation/validation.go

@@ -26,6 +26,7 @@ func Builder() *cobra.Command {
 
 	cmd.AddCommand(
 		CreateBuilder(),
+		DescribeBuilder(),
 	)
 
 	return cmd