feat: Add reusable interactive prompts and `configure` command (issue #19528) #19637

david-wu-octopus · 2024-08-22T05:50:17Z

Description

Closes #19528

This PR implements reusable functionality for interactive prompts:

Interactive prompts can be toggled on or off using the prompts-enabled flag in local configuration.
It adds a new CLI command argocd configure with flag --prompts-enabled which can be used to toggle the prompts-enabled flag in local configuration
It adds a new global CLI flag --force-prompts-enabled which will override the local configuration value if specified

Usage and examples:

How to add interactive prompts to a command:

When initialising the command, pass in an instance of *apiclient.ClientOptions
When defining the business logic for the command, create a new prompt using the util NewPrompt(clientOpts *apiclient.ClientOptions) (*Prompt, error) and then call (p *Prompt) Confirm(message string) bool in the command's logic

Example: `argocd admin export` command

admin.go:

command.AddCommand(NewExportCommand(clientOpts))

backup.go:

func NewExportCommand(clientOpts *argocdclient.ClientOptions) *cobra.Command {
	
        // ...

	command := cobra.Command{
		Use:   "export",
		Short: "Export all Argo CD data to stdout (default) or a file",
		Run: func(c *cobra.Command, args []string) {

			// ...

			prompt, err := utils.NewPrompt(clientOpts.PromptsEnabled)
			errors.CheckError(err)

			if !prompt.Confirm("Are you sure you want to export? (y/n) ") {
				return
			}

			// ...

		},
	}

	// ...

	return &command
}

CLI examples

By default, optional prompts are disabled:

argocd admin export
# All Argo CD data is printed in the terminal

We can force prompts to be enabled for the current command only using a global flag --prompts-enabled:

argocd admin export --force-prompts-enabled
Are you sure you want to export? (y/n) n

A new local configuration field, prompts-enabled, can be set to enable optional prompts for all commands as the default. To set this field, we can use a new command argocd configuration --prompts-enabled (where --prompts-enabled=false will turn off optional interactive prompts):

argocd configure --prompts-enabled
Successfully updated the following configuration settings:
prompts-enabled: true

argocd admin export
Are you sure you want to export? (y/n) y
# All Argo CD data is printed in the terminal

The field will be added to the local configuration file if it isn't there already

The global flag --force-prompts-enabled overrides the local configuration value:

argocd admin export --force-prompts-enabled=false
# All Argo CD data is printed in the terminal

Checklist:

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

…eSettingsManager()` and `commandContext.CreateSettingsManager()` exportable Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

bunnyshell · 2024-08-22T05:50:24Z

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

🚀 /bns:deploy to deploy the environment

bunnyshell · 2024-08-22T05:50:25Z

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

🚀 /bns:deploy to deploy the environment

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

codecov · 2024-08-22T06:48:10Z

Codecov Report

Attention: Patch coverage is 84.48276% with 9 lines in your changes missing coverage. Please review.

Project coverage is 55.18%. Comparing base (ec499bb) to head (2fd0cbe).
Report is 409 commits behind head on master.

Files with missing lines	Patch %	Lines
util/localconfig/localconfig.go	66.66%	4 Missing and 2 partials ⚠️
cmd/argocd/commands/root.go	0.00%	2 Missing ⚠️
cmd/argocd/commands/utils/prompt.go	88.88%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #19637      +/-   ##
==========================================
+ Coverage   55.07%   55.18%   +0.10%     
==========================================
  Files         322      324       +2     
  Lines       54927    55078     +151     
==========================================
+ Hits        30253    30393     +140     
+ Misses      22068    22060       -8     
- Partials     2606     2625      +19

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

nitishfy · 2024-08-22T10:42:19Z

Hi @david-wu-octopus , can you please link the issue this PR is associated with?

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus · 2024-08-22T11:43:45Z

cmd/argocd/commands/utils/prompt.go

+	enabled bool
+}
+
+func NewPrompt(clientOpts *apiclient.ClientOptions) (*Prompt, error) {


I've decided to pass in clientOpts *apiclient.ClientOptions here to reduce duplicated set up code and to make clear to other contributors that the boolean value for the prompts-enabled setting is supposed to come from local config

If we instead passed through a bool value as the argument, it may not be clear to other developers where this value comes from

Yes, thats make sense, but i would just apply config path instead whole structure. Because here a lot of redundant fields in clients options that not relevant for prompts

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus · 2024-08-23T05:30:07Z

Hi @david-wu-octopus , can you please link the issue this PR is associated with?

Done, thank you!

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

pasha-codefresh · 2024-08-23T07:01:03Z

cmd/argocd/commands/utils/prompt.go

+	enabled bool
+}
+
+func NewPrompt(clientOpts *apiclient.ClientOptions) (*Prompt, error) {


Yes, thats make sense, but i would just apply config path instead whole structure. Because here a lot of redundant fields in clients options that not relevant for prompts

cmd/argocd/commands/utils/prompt.go

cmd/argocd/commands/admin/settings.go

util/settings/settings.go

pasha-codefresh · 2024-08-23T07:09:24Z

cmd/argocd/commands/configuration.go

+			fmt.Printf("prompts-enabled: %v", strconv.FormatBool(localCfg.PromptsEnabled))
+		},
+	}
+	command.Flags().BoolVar(&promptsEnabled, "prompts-enabled", false, "Enable (or disable) optional interactive prompts")


Lets change it to pointer and prompts, so we can verify existance of this flag

As far as I can tell, the package pflag (https://github.com/spf13/pflag) doesn't actually support pointers for boolean flags

The alternative approach I've identified is for the default --prompts-enabled and --force-prompts-enabled flag values to be read from local configuration

cmd/argocd/commands/configuration.go

cmd/argocd/commands/utils/prompt.go

david-wu-octopus · 2024-08-23T07:22:04Z

cmd/argocd/commands/utils/prompt.go

+	if err != nil {
+		return nil, err
+	}
+


Add override param on clientOpts

I've added a global CLI flag --force-prompts-enabled that will override the value in local config if it's set

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

…or `--prompts-enabled` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

…led` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

…ntOptions` arg Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

pasha-codefresh

LGTM, amazing work

…rgoproj#19528) (argoproj#19637) * Add `Prompt`, with `prompts.enabled` setting in `argocd-cm` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Make `SettingsOpts`, `SettingsOpts.ArgocdCMPath`, `SettingsOpts.CreateSettingsManager()` and `commandContext.CreateSettingsManager()` exportable Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add `prompt_test.go` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Refactor `NewPrompt()` and move into new package `utils` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Update `NewPrompt()` to use local config Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add `NewConfigurationCommand()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Move `prompt_test.go` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Remove `prompt_test.go` for now Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add back and update `prompt_test.go` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add `configuration_test.go` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix linting issues Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix linting issues Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Reverse early-termination logic in `Confirm()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Rename `ArgocdCMPath` to `argocdCMPath` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Rename `SettingsOpts` to `settingsOpts` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Rename `CreateSettingsManager()` to `createSettingsManager()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Rename `configuration` to `configure` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Further rename `configuration` to `configure` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Remove redundant Argo CD ConfigMap logic Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix terminal output spacing Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Make `argocd configure` use local config value as the default value for `--prompts-enabled` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add global CLI flag `--force-prompts-enabled` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Update existing `prompt_test.go` test cases Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add test case for `(p *Prompt).Confirm()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add test cases for `GetBoolFlagWithFallback()` to `env_test.go` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Format imports Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Further format imports and remove unused variable Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Again format imports Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add fallback to `GetPromptsEnabled()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix bug in `GetPromptsEnabled()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix missing import Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add auto-generated docs for `argocd configure` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add auto-generated docs for new global CLI flag `--force-prompts-enabled` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Update `NewPrompt()` to receive a `bool` rather than `*apiclient.ClientOptions` arg Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Remove arg `fallback` from `GetPromptsEnabled()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add arg `useCLIOpts bool` to `GetPromptsEnabled()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Make `config.LoadFlags()` exportable Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Add tests for `GetPromptsEnabled()` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Fix linting errors in tests Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> * Run `make codegen-local` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> --------- Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com> Signed-off-by: Adrian Aneci <aneci@adobe.com>

david-wu-octopus added 3 commits August 21, 2024 16:52

Add Prompt, with prompts.enabled setting in argocd-cm

7a70dbf

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Make SettingsOpts, SettingsOpts.ArgocdCMPath, `SettingsOpts.Creat…

0f9ae4d

…eSettingsManager()` and `commandContext.CreateSettingsManager()` exportable Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add prompt_test.go

7078727

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Refactor NewPrompt() and move into new package utils

ddb42e8

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Update NewPrompt() to use local config

5fe5f33

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus added 3 commits August 22, 2024 21:24

Add NewConfigurationCommand()

138d03f

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Move prompt_test.go

eb73b5f

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Remove prompt_test.go for now

59aecd0

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus commented Aug 22, 2024

View reviewed changes

david-wu-octopus added 2 commits August 23, 2024 14:29

Add back and update prompt_test.go

d7f0975

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add configuration_test.go

665d924

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus changed the title ~~Prompt config~~ feat: Add reusable interactive prompts and configuration command (issue #19528) Aug 23, 2024

david-wu-octopus marked this pull request as ready for review August 23, 2024 05:30

david-wu-octopus requested a review from a team as a code owner August 23, 2024 05:30

david-wu-octopus added 3 commits August 23, 2024 15:44

Fix linting issues

597771b

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Merge remote-tracking branch 'origin' into prompt-config

82e47d4

Fix linting issues

7eda495

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

pasha-codefresh requested changes Aug 23, 2024

View reviewed changes

david-wu-octopus commented Aug 23, 2024

View reviewed changes

cmd/argocd/commands/utils/prompt.go Outdated Show resolved Hide resolved

david-wu-octopus commented Aug 23, 2024

View reviewed changes

david-wu-octopus added 5 commits August 30, 2024 11:17

Reverse early-termination logic in Confirm()

9b3e6d1

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Rename ArgocdCMPath to argocdCMPath

5757015

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Rename SettingsOpts to settingsOpts

0b75a5f

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Rename CreateSettingsManager() to createSettingsManager()

8bec127

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Rename configuration to configure

d9aedde

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus added 16 commits October 7, 2024 15:17

Merge remote-tracking branch 'origin' into prompt-config

aff102e

Fix terminal output spacing

ec048f6

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Make argocd configure use local config value as the default value f…

db4af76

…or `--prompts-enabled` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Merge remote-tracking branch 'origin' into prompt-config

fad085a

Add global CLI flag --force-prompts-enabled

4d47f3d

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Update existing prompt_test.go test cases

fe592d8

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add test case for (p *Prompt).Confirm()

8d3becc

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add test cases for GetBoolFlagWithFallback() to env_test.go

239e10c

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Format imports

ea650b8

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Further format imports and remove unused variable

e6b054e

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Again format imports

90fee9a

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add fallback to GetPromptsEnabled()

e4e4903

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Fix bug in GetPromptsEnabled()

db8654e

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Fix missing import

10957fa

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add auto-generated docs for argocd configure

77f25ed

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add auto-generated docs for new global CLI flag `--force-prompts-enab…

f52f61e

…led` Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

david-wu-octopus requested a review from a team as a code owner October 11, 2024 05:39

david-wu-octopus added 9 commits October 24, 2024 14:23

Update NewPrompt() to receive a bool rather than `*apiclient.Clie…

929f7fa

…ntOptions` arg Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Merge remote-tracking branch 'origin' into prompt-config

f913ca1

Remove arg fallback from GetPromptsEnabled()

17ad752

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add arg useCLIOpts bool to GetPromptsEnabled()

147e701

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Make config.LoadFlags() exportable

58ae10f

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Add tests for GetPromptsEnabled()

48ccd76

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Fix linting errors in tests

19081ad

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

Merge remote-tracking branch 'origin' into prompt-config

a842213

Run make codegen-local

2fd0cbe

Signed-off-by: David Wu <155603967+david-wu-octopus@users.noreply.github.com>

pasha-codefresh approved these changes Oct 25, 2024

View reviewed changes

pasha-codefresh merged commit b5d8edd into argoproj:master Oct 25, 2024
27 checks passed

david-wu-octopus mentioned this pull request Feb 3, 2025

REQUEST: New membership for @david-wu-octopus argoproj/argoproj#354

Closed

6 tasks

feat: Add reusable interactive prompts and configure command (issue #19528) #19637

feat: Add reusable interactive prompts and configure command (issue #19528) #19637

Uh oh!

Conversation

david-wu-octopus commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Usage and examples:

How to add interactive prompts to a command:

Example: argocd admin export command

CLI examples

Checklist:

Uh oh!

bunnyshell bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Preview Environment deleted from Bunnyshell

Uh oh!

bunnyshell bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Preview Environment deleted from Bunnyshell

Uh oh!

codecov bot commented Aug 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nitishfy commented Aug 22, 2024

Uh oh!

david-wu-octopus Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

pasha-codefresh Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

david-wu-octopus commented Aug 23, 2024

Uh oh!

pasha-codefresh Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pasha-codefresh Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

david-wu-octopus Oct 11, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

david-wu-octopus Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

david-wu-octopus Oct 11, 2024

Choose a reason for hiding this comment

Uh oh!

pasha-codefresh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feat: Add reusable interactive prompts and `configure` command (issue #19528) #19637

feat: Add reusable interactive prompts and `configure` command (issue #19528) #19637

david-wu-octopus commented Aug 22, 2024 •

edited

Loading

Example: `argocd admin export` command

bunnyshell bot commented Aug 22, 2024 •

edited

Loading

bunnyshell bot commented Aug 22, 2024 •

edited

Loading

codecov bot commented Aug 22, 2024 •

edited

Loading