CLOUDP-70010: iam users describe

e2e/atlas/users_test.go

@@ -53,4 +53,25 @@ func TestUsers(t *testing.T) {
 			t.Fatalf("expected len(users) > 0, got %v", len(users))
 		}
 	})
+
+	t.Run("Describe", func(t *testing.T) {
+		cmd := exec.Command(cliPath,
+			iamEntity,
+			usersEntity,
+			"describe",
+			"nonExistentUser",
+			"-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)
+		}
+	})
 }

internal/cli/iam/users/describe.go

@@ -0,0 +1,102 @@
+// 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
+{{.ID}}	{{.FirstName}}	{{.LastName}}	{{.Username}}
+`
+
+type DescribeOpts struct {
+	cli.GlobalOpts
+	cli.OutputOpts
+	store    store.UsersDescriber
+	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
+}
+
+// mongocli iam project(s) user(s) describe --id ID --username USERNAME
+func DescribeBuilder() *cobra.Command {
+	opts := &DescribeOpts{}
+	cmd := &cobra.Command{
+		Use:     "describe --id ID | describe --name username",
+		Aliases: []string{"get"},
+		Short:   describeIAMUser,
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			return opts.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,77 @@
+// 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.NewMockUsersDescriber(ctrl)
+	defer ctrl.Finish()
+
+	var expected mongodbatlas.AtlasUser
+
+	var id = "some_id"
+
+	descOpts := &DescribeOpts{
+		store: mockStore,
+		ID:    id,
+	}
+
+	mockStore.
+		EXPECT().
+		UserByID(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.NewMockUsersDescriber(ctrl)
+	defer ctrl.Finish()
+
+	var expected mongodbatlas.AtlasUser
+
+	var name = "some_name"
+
+	descOpts := &DescribeOpts{
+		store:    mockStore,
+		username: name,
+	}
+
+	mockStore.
+		EXPECT().
+		UserByName(name).
+		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 name or ID."
 )

internal/cli/iam/users/users.go

@@ -29,5 +29,6 @@ func Builder() *cobra.Command {
 	}
 
 	cmd.AddCommand(InviteBuilder())
+	cmd.AddCommand(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

internal/store/users.go

@@ -23,12 +23,17 @@ import (
 	"go.mongodb.org/ops-manager/opsmngr"
 )
 
-//go:generate mockgen -destination=../mocks/mock_users.go -package=mocks github.com/mongodb/mongocli/internal/store UserCreator
+//go:generate mockgen -destination=../mocks/mock_users.go -package=mocks github.com/mongodb/mongocli/internal/store UserCreator,UsersDescriber
 
 type UserCreator interface {
 	CreateUser(*UserRequest) (interface{}, error)
 }
 
+type UsersDescriber interface {
+	UserByID(string) (interface{}, error)
+	UserByName(string) (interface{}, error)
+}
+
 type UserRequest struct {
 	*opsmngr.User
 	AtlasRoles   []atlas.AtlasRole
@@ -59,3 +64,31 @@ func (s *Store) CreateUser(user *UserRequest) (interface{}, error) {
 		return nil, fmt.Errorf("unsupported service: %s", s.service)
 	}
 }
+
+// UserByID gets an IAM user by ID
+func (s *Store) UserByID(userID string) (interface{}, error) {
+	switch s.service {
+	case config.CloudService:
+		result, _, err := s.client.(*atlas.Client).AtlasUsers.Get(context.Background(), userID)
+		return result, err
+	case config.OpsManagerService, config.CloudManagerService:
+		result, _, err := s.client.(*opsmngr.Client).Users.Get(context.Background(), userID)
+		return result, err
+	default:
+		return nil, fmt.Errorf("unsupported service: %s", s.service)
+	}
+}
+
+// UserByName gets an IAM user by name
+func (s *Store) UserByName(username string) (interface{}, error) {
+	switch s.service {
+	case config.CloudService:
+		result, _, err := s.client.(*atlas.Client).AtlasUsers.GetByName(context.Background(), username)
+		return result, err
+	case config.OpsManagerService, config.CloudManagerService:
+		result, _, err := s.client.(*opsmngr.Client).Users.GetByName(context.Background(), username)
+		return result, err
+	default:
+		return nil, fmt.Errorf("unsupported service: %s", s.service)
+	}
+}

internal/usage/usage.go

@@ -33,6 +33,7 @@ const (
 	Limit                           = "Number of items per page."
 	Username                        = "Username of the user."
 	DBUsername                      = "Username for authenticating to MongoDB."
+	UserID                          = "The ID of the user."
 	Password                        = "User’s password." //nolint:gosec // This is just a message not a password
 	Country                         = "The ISO 3166-1 alpha 2 country code of the user’s country of residence."
 	Mobile                          = "The user’s mobile or cell phone number."