Skip to content

CLOUDP-120668: Add register command skeleton #1149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion internal/cli/auth/login.go
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ func LoginBuilder() *cobra.Command {
if hasUserProgrammaticKeys() {
return fmt.Errorf(`you have already set the programmatic keys for this profile.

Run '%s auth login --profile <profile_name>' to use your username and password on a new profile`, config.BinName())
Run '%s auth login --profile <profile_name>' to use your username and password with a new profile`, config.BinName())
}

opts.OutWriter = cmd.OutOrStdout()
Expand Down Expand Up @@ -230,5 +230,9 @@ func Builder() *cobra.Command {
LogoutBuilder(),
)

if config.ToolName == config.AtlasCLI {
cmd.AddCommand(RegisterBuilder())
}

return cmd
}
18 changes: 18 additions & 0 deletions internal/cli/auth/login_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"testing"

"github.com/golang/mock/gomock"
"github.com/mongodb/mongocli/internal/config"
"github.com/mongodb/mongocli/internal/mocks"
"github.com/mongodb/mongocli/internal/test"
"github.com/stretchr/testify/assert"
Expand All @@ -40,6 +41,23 @@ func TestBuilder(t *testing.T) {
)
}

func TestBuilderForAtlas(t *testing.T) {
// Test for AtlasCLI
prevTool := config.ToolName
config.ToolName = config.AtlasCLI

t.Cleanup(func() {
config.ToolName = prevTool
})

test.CmdValidator(
t,
Builder(),
4,
[]string{},
)
}

func TestLoginBuilder(t *testing.T) {
test.CmdValidator(
t,
Expand Down
69 changes: 69 additions & 0 deletions internal/cli/auth/register.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Copyright 2022 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 auth

import (
"fmt"

"github.com/mongodb/mongocli/internal/cli/require"
"github.com/mongodb/mongocli/internal/config"
"github.com/spf13/cobra"
)

type registerOpts struct {
loginOpts
}

func (opts *registerOpts) Run() error {
_, _ = fmt.Fprintf(opts.OutWriter, "Create and verify your MongoDB Atlas account from the web browser and return to Atlas CLI after activating your account.\n")
// TODO: CLOUDP-120669
return nil
}

func RegisterBuilder() *cobra.Command {
opts := &registerOpts{}
cmd := &cobra.Command{
Use: "register",
Short: "Register with MongoDB Atlas.",
Hidden: true,
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the command is hidden, no doc generated until we flip it.

Example: fmt.Sprintf(` To start the interactive setup:
$ %s auth register
`, config.BinName()),
PreRunE: func(cmd *cobra.Command, args []string) error {
if hasUserProgrammaticKeys() {
return fmt.Errorf(`you have already set the programmatic keys for this profile.

Run '%s auth register --profile <profileName>' to use your username and password with a new profile`, config.BinName())
}

opts.OutWriter = cmd.OutOrStdout()
opts.config = config.Default()
if config.OpsManagerURL() != "" {
opts.OpsManagerURL = config.OpsManagerURL()
}
return opts.initFlow()
},
RunE: func(cmd *cobra.Command, args []string) error {
return opts.Run()
},
Args: require.NoArgs,
}

cmd.Flags().BoolVar(&opts.isGov, "gov", false, "Register to Atlas for Government.")
cmd.Flags().BoolVar(&opts.noBrowser, "noBrowser", false, "Don't try to open a browser session.")
cmd.Flags().BoolVar(&opts.skipConfig, "skipConfig", false, "Skip profile configuration.")

return cmd
}
65 changes: 65 additions & 0 deletions internal/cli/auth/register_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// Copyright 2022 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
// +build unit

package auth

import (
"bytes"
"testing"

"github.com/golang/mock/gomock"
"github.com/mongodb/mongocli/internal/mocks"
"github.com/mongodb/mongocli/internal/test"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestRegisterBuilder(t *testing.T) {
test.CmdValidator(
t,
RegisterBuilder(),
0,
[]string{"gov", "noBrowser"},
)
}

func Test_registerOpts_Run(t *testing.T) {
ctrl := gomock.NewController(t)
mockFlow := mocks.NewMockAuthenticator(ctrl)
mockConfig := mocks.NewMockLoginConfig(ctrl)
mockStore := mocks.NewMockProjectOrgsLister(ctrl)
defer ctrl.Finish()
buf := new(bytes.Buffer)

loginOpts := &loginOpts{
flow: mockFlow,
config: mockConfig,
noBrowser: true,
skipConfig: true,
}

opts := &registerOpts{
*loginOpts,
}

opts.OutWriter = buf
opts.Store = mockStore

require.NoError(t, opts.Run())
assert.Equal(t, `Create and verify your MongoDB Atlas account from the web browser and return to Atlas CLI after activating your account.
`, buf.String())
}