CLOUDP-70010: iam users describe

e2e/atlas/helper_test.go

@@ -39,9 +39,6 @@ const (
 	configEntity           = "settings"
 	dbusersEntity          = "dbusers"
 	certsEntity            = "certs"
-	iamEntity              = "iam"
-	projectsEntity         = "projects"
-	usersEntity            = "users"
 	privateEndpointsEntity = "privateendpoints"
 	onlineArchiveEntity    = "onlineArchives"
 )

e2e/atlas/users_test.go → e2e/iam/atlas_users_test.go

@@ -11,9 +11,9 @@
 // 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 e2e atlas,generic
+// +build e2e iam
 
-package atlas_test
+package iam_test
 
 import (
 	"encoding/json"
@@ -30,6 +30,8 @@ func TestUsers(t *testing.T) {
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
+	var username string
+	var userID string
 
 	t.Run("List", func(t *testing.T) {
 		cmd := exec.Command(cliPath,
@@ -49,8 +51,56 @@ func TestUsers(t *testing.T) {
 		if err := json.Unmarshal(resp, &users); err != nil {
 			t.Fatalf("unexpected error: %v", err)
 		}
+
 		if len(users) == 0 {
 			t.Fatalf("expected len(users) > 0, got %v", len(users))
 		}
+
+		username = users[0].Username
+		userID = users[0].ID
+	})
+
+	t.Run("Describe by username", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			iamEntity,
+			usersEntity,
+			"describe",
+			"--username",
+			username,
+			"-o=json")
+		cmd.Env = os.Environ()
+		resp, err := cmd.CombinedOutput()
+
+		if err != nil {
+			t.Fatalf("unexpected error: %v, resp: %v", err, string(resp))
+		}
+
+		var user mongodbatlas.AtlasUser
+
+		if err := json.Unmarshal(resp, &user); err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+	})
+
+	t.Run("Describe by id", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			iamEntity,
+			usersEntity,
+			"describe",
+			"--id",
+			userID,
+			"-o=json")
+		cmd.Env = os.Environ()
+		resp, err := cmd.CombinedOutput()
+
+		if err != nil {
+			t.Fatalf("unexpected error: %v, resp: %v", err, string(resp))
+		}
+
+		var user mongodbatlas.AtlasUser
+
+		if err := json.Unmarshal(resp, &user); err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
 	})
 }

e2e/iam/helper_test.go

@@ -31,6 +31,8 @@ const (
 	projectEntity         = "projects"
 	apiKeysEntity         = "apikeys"
 	apiKeyWhitelistEntity = "whitelist"
+	usersEntity           = "users"
+	projectsEntity        = "projects"
 )
 
 func createOrgAPIKey() (string, error) {

internal/cli/iam/users/describe.go

@@ -0,0 +1,122 @@
+// Copyright 2020 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 users
+
+import (
+	"errors"
+
+	"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"
+)
+
+const describeTemplate = `id	FIRST NAME	LAST NAME	USERNAME	EMAIL
+{{.ID}}	{{.FirstName}}	{{.LastName}}	{{.Username}}	{{.EmailAddress}}
+`
+
+type DescribeOpts struct {
+	cli.OutputOpts
+	store    store.UserDescriber
+	username string
+	id       string
+}
+
+func (opts *DescribeOpts) init() error {
+	var err error
+	opts.store, err = store.New(config.Default())
+	return err
+}
+
+func (opts *DescribeOpts) Run() error {
+	var r interface{}
+	var err error
+
+	if opts.username != "" {
+		r, err = opts.store.UserByName(opts.username)
+	}
+
+	if opts.id != "" {
+		r, err = opts.store.UserByID(opts.id)
+	}
+
+	if err != nil {
+		return err
+	}
+
+	return opts.Print(r)
+}
+
+func (opts *DescribeOpts) validate() error {
+	if opts.id == "" && opts.username == "" {
+		return errors.New("must supply one of 'id' or 'username'")
+	}
+
+	if opts.id != "" && opts.username != "" {
+		return errors.New("cannot supply both 'id' and 'username'")
+	}
+
+	return nil
+}
+
+type cmdOpt func() error
+
+// PreRunE is a function to call before running the command,
+// It calls any additional function pass as a callback
+func PreRunE(cbs ...cmdOpt) error {
+	for _, f := range cbs {
+		if err := f(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// mongocli iam user(s) describe --id id --username USERNAME
+func DescribeBuilder() *cobra.Command {
+	opts := &DescribeOpts{}
+	cmd := &cobra.Command{
+		Use:     "describe",
+		Aliases: []string{"get"},
+		Example: `  
+  Describe a user by ID
+  $ mongocli iam users describe --id <id>
+
+  Describe a user by username
+  $ mongocli iam users describe --username <username>
+`,
+		Short: describeIAMUser,
+		Args:  cobra.NoArgs,
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			return PreRunE(
+				opts.init,
+				opts.InitOutput(cmd.OutOrStdout(), describeTemplate),
+				opts.validate,
+			)
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return opts.Run()
+		},
+	}
+
+	cmd.Flags().StringVar(&opts.username, flag.Username, "", usage.Username)
+	cmd.Flags().StringVar(&opts.id, flag.ID, "", usage.UserID)
+
+	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
+
+	return cmd
+}

internal/cli/iam/users/describe_test.go

@@ -0,0 +1,72 @@
+// Copyright 2020 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 users
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/mongodb/mongocli/internal/mocks"
+	"go.mongodb.org/atlas/mongodbatlas"
+)
+
+func TestDescribe_Run_ByID(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mockStore := mocks.NewMockUserDescriber(ctrl)
+	defer ctrl.Finish()
+
+	var expected mongodbatlas.AtlasUser
+
+	descOpts := &DescribeOpts{
+		store: mockStore,
+		id:    "id",
+	}
+
+	mockStore.
+		EXPECT().
+		UserByID(descOpts.id).
+		Return(expected, nil).
+		Times(1)
+
+	err := descOpts.Run()
+	if err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+}
+
+func TestDescribe_Run_ByName(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mockStore := mocks.NewMockUserDescriber(ctrl)
+	defer ctrl.Finish()
+
+	var expected mongodbatlas.AtlasUser
+
+	descOpts := &DescribeOpts{
+		store:    mockStore,
+		username: "test",
+	}
+
+	mockStore.
+		EXPECT().
+		UserByName(descOpts.username).
+		Return(expected, nil).
+		Times(1)
+
+	err := descOpts.Run()
+	if err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+}

internal/cli/iam/users/description.go

@@ -14,7 +14,8 @@
 package users
 
 const (
-	short      = "Users operations."
-	long       = "Create, list and manage your Atlas/Cloud Manager/Ops Manager users."
-	inviteUser = "Invite a user."
+	short           = "Users operations."
+	long            = "Create, list and manage your Atlas/Cloud Manager/Ops Manager users."
+	inviteUser      = "Invite a user."
+	describeIAMUser = "Get a user by username or id."
 )

internal/cli/iam/users/users.go

@@ -28,6 +28,10 @@ func Builder() *cobra.Command {
 		Aliases: cli.GenerateAliases(use),
 	}
 
-	cmd.AddCommand(InviteBuilder())
+	cmd.AddCommand(
+		InviteBuilder(),
+		DescribeBuilder(),
+	)
+
 	return cmd
 }

internal/flag/flags.go

@@ -34,6 +34,7 @@ const (
 	DiskSizeGB                      = "diskSizeGB"                      // DiskSizeGB flag
 	MDBVersion                      = "mdbVersion"                      // MDBVersion flag
 	Backup                          = "backup"                          // Backup flag
+	ID                              = "id"                              // ID flag
 	Username                        = "username"                        // Username flag
 	UsernameShort                   = "u"                               // UsernameShort flag
 	Password                        = "password"                        // Password flag