Skip to content

Confirm before automatically setting a new environment as the default #4832

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
19 changes: 16 additions & 3 deletions cli/azd/cmd/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -658,9 +658,22 @@ func (en *envNewAction) Run(ctx context.Context) (*actions.ActionResult, error)
if err != nil {
return nil, fmt.Errorf("creating new environment: %w", err)
}

if err := en.azdCtx.SetProjectState(azdcontext.ProjectState{DefaultEnvironment: env.Name()}); err != nil {
return nil, fmt.Errorf("saving default environment: %w", err)
msg := fmt.Sprintf("Would you like to set the new environment '%s' as default environment?", env.Name())
shouldSetDefault, promptErr := en.console.Confirm(ctx, input.ConsoleOptions{
Message: msg,
DefaultValue: true,
})
if promptErr != nil {
return nil, fmt.Errorf("prompting to set environment '%s' as default environment: %w", env.Name(), promptErr)
}
if shouldSetDefault {
if err := en.azdCtx.SetProjectState(azdcontext.ProjectState{DefaultEnvironment: env.Name()}); err != nil {
return nil, fmt.Errorf("saving default environment: %w", err)
}
en.console.Message(ctx,
fmt.Sprintf(
"The new environment '%s' has been set as the default environment.", env.Name()),
)
}

return nil, nil
Expand Down
19 changes: 17 additions & 2 deletions cli/azd/pkg/environment/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,23 @@ func (m *manager) LoadOrInitInteractive(ctx context.Context, environmentName str
return nil, err
}

if err := m.azdContext.SetProjectState(azdcontext.ProjectState{DefaultEnvironment: env.Name()}); err != nil {
return nil, fmt.Errorf("saving default environment: %w", err)
m.console.Message(ctx, "")
msg := fmt.Sprintf("Would you like to set the new environment '%s' as default environment?", env.Name())
shouldSetDefault, promptErr := m.console.Confirm(ctx, input.ConsoleOptions{
Message: msg,
DefaultValue: true,
})
if promptErr != nil {
return nil, fmt.Errorf("prompting to set environment '%s' as default environment: %w", env.Name(), promptErr)
}
if shouldSetDefault {
if err := m.azdContext.SetProjectState(azdcontext.ProjectState{DefaultEnvironment: env.Name()}); err != nil {
return nil, fmt.Errorf("saving default environment: %w", err)
}
m.console.Message(ctx,
fmt.Sprintf(
"The new environment '%s' has been set as the default environment.", env.Name()),
)
}
}

Expand Down
8 changes: 8 additions & 0 deletions cli/azd/pkg/environment/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ func Test_EnvManager_PromptEnvironmentName(t *testing.T) {
return strings.Contains(options.Message, "would you like to create it?")
}).Respond(true)

mockContext.Console.WhenConfirm(func(options input.ConsoleOptions) bool {
return strings.Contains(options.Message, "Would you like to set the new environment")
}).Respond(true)

mockContext.Console.WhenPrompt(func(options input.ConsoleOptions) bool {
return true
}).SetError(errors.New("prompt should not be called for valid environment name"))
Expand All @@ -106,6 +110,10 @@ func Test_EnvManager_PromptEnvironmentName(t *testing.T) {
return true
}).Respond(expected)

mockContext.Console.WhenConfirm(func(options input.ConsoleOptions) bool {
return strings.Contains(options.Message, "Would you like to set the new environment")
}).Respond(true)

envManager := createEnvManagerForManagerTest(t, mockContext)
env, err := envManager.LoadOrInitInteractive(*mockContext.Context, "")

Expand Down
2 changes: 1 addition & 1 deletion cli/azd/test/functional/env_refresh_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func Test_CLI_EnvRefresh_NoBicep(t *testing.T) {
require.NoError(t, os.Rename(infraPath, infraPathHidden))

// Reuse same environment name
_, err = cli.RunCommandWithStdIn(ctx, envName+"\n", "env", "refresh")
_, err = cli.RunCommandWithStdIn(ctx, envName+"\ny\n", "env", "refresh")
require.NoError(t, err)

env, err := envFromAzdRoot(ctx, dir, envName)
Expand Down
6 changes: 3 additions & 3 deletions cli/azd/test/functional/env_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func Test_CLI_Env_Management(t *testing.T) {
envName3 := randomEnvName()
_, _ = cli.RunCommandWithStdIn(
ctx,
"Create a new environment\n"+envName3+"\n",
"Create a new environment\n"+envName3+"\ny\n",
cmdNeedingEnv...)
environmentList = envList(ctx, t, cli)
require.Len(t, environmentList, 3)
Expand Down Expand Up @@ -329,10 +329,10 @@ func envNew(ctx context.Context, t *testing.T, cli *azdcli.CLI, envName string,

if usePrompt {
runArgs := append(defaultArgs, args...)
_, err := cli.RunCommandWithStdIn(ctx, envName+"\n", runArgs...)
_, err := cli.RunCommandWithStdIn(ctx, envName+"\ny\n", runArgs...)
require.NoError(t, err)
} else {
runArgs := append(defaultArgs, envName, "--subscription", cfg.SubscriptionID, "-l", cfg.Location)
runArgs := append(defaultArgs, envName, "--no-prompt", "--subscription", cfg.SubscriptionID, "-l", cfg.Location)
runArgs = append(runArgs, args...)
_, err := cli.RunCommand(ctx, runArgs...)
require.NoError(t, err)
Expand Down
Loading