From 3c6ace066ab991b70f752ad3b4dbaade80a5aecc Mon Sep 17 00:00:00 2001 From: Mario Valderrama Date: Wed, 23 Jun 2021 23:27:29 +0200 Subject: [PATCH] etcdutl: add command to generate shell completion Follow up of #13133. --- etcdutl/ctl.go | 4 ++ etcdutl/etcdutl/backup_command.go | 4 ++ etcdutl/etcdutl/completion_commmand.go | 84 ++++++++++++++++++++++++++ etcdutl/etcdutl/defrag_command.go | 3 +- etcdutl/etcdutl/snapshot_command.go | 3 +- tests/e2e/ctl_v3_completion_test.go | 8 ++- 6 files changed, 101 insertions(+), 5 deletions(-) create mode 100644 etcdutl/etcdutl/completion_commmand.go diff --git a/etcdutl/ctl.go b/etcdutl/ctl.go index a044547c6..2d74684d8 100644 --- a/etcdutl/ctl.go +++ b/etcdutl/ctl.go @@ -35,12 +35,16 @@ var ( func init() { rootCmd.PersistentFlags().StringVarP(&etcdutl.OutputFormat, "write-out", "w", "simple", "set the output format (fields, json, protobuf, simple, table)") + rootCmd.RegisterFlagCompletionFunc("write-out", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) { + return []string{"fields", "json", "protobuf", "simple", "table"}, cobra.ShellCompDirectiveDefault + }) rootCmd.AddCommand( etcdutl.NewBackupCommand(), etcdutl.NewDefragCommand(), etcdutl.NewSnapshotCommand(), etcdutl.NewVersionCommand(), + etcdutl.NewCompletionCommand(), ) } diff --git a/etcdutl/etcdutl/backup_command.go b/etcdutl/etcdutl/backup_command.go index c09bcf14a..75d2acc31 100644 --- a/etcdutl/etcdutl/backup_command.go +++ b/etcdutl/etcdutl/backup_command.go @@ -64,6 +64,10 @@ func NewBackupCommand() *cobra.Command { cmd.Flags().BoolVar(&withV3, "with-v3", true, "Backup v3 backend data") cmd.MarkFlagRequired("data-dir") cmd.MarkFlagRequired("backup-dir") + cmd.MarkFlagDirname("data-dir") + cmd.MarkFlagDirname("wal-dir") + cmd.MarkFlagDirname("backup-dir") + cmd.MarkFlagDirname("backup-wal-dir") return cmd } diff --git a/etcdutl/etcdutl/completion_commmand.go b/etcdutl/etcdutl/completion_commmand.go new file mode 100644 index 000000000..792799b15 --- /dev/null +++ b/etcdutl/etcdutl/completion_commmand.go @@ -0,0 +1,84 @@ +// Copyright 2021 The etcd Authors +// +// 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 etcdutl + +import ( + "os" + + "github.com/spf13/cobra" +) + +func NewCompletionCommand() *cobra.Command { + cmd := &cobra.Command{ + Use: "completion [bash|zsh|fish|powershell]", + Short: "Generate completion script", + Long: `To load completions: + +Bash: + + $ source <(etcdutl completion bash) + + # To load completions for each session, execute once: + # Linux: + $ etcdutl completion bash > /etc/bash_completion.d/etcdutl + # macOS: + $ etcdutl completion bash > /usr/local/etc/bash_completion.d/etcdutl + +Zsh: + + # If shell completion is not already enabled in your environment, + # you will need to enable it. You can execute the following once: + + $ echo "autoload -U compinit; compinit" >> ~/.zshrc + + # To load completions for each session, execute once: + $ etcdutl completion zsh > "${fpath[1]}/_etcdutl" + + # You will need to start a new shell for this setup to take effect. + +fish: + + $ etcdutl completion fish | source + + # To load completions for each session, execute once: + $ etcdutl completion fish > ~/.config/fish/completions/etcdutl.fish + +PowerShell: + + PS> etcdutl completion powershell | Out-String | Invoke-Expression + + # To load completions for every new session, run: + PS> etcdutl completion powershell > etcdutl.ps1 + # and source this file from your PowerShell profile. +`, + DisableFlagsInUseLine: true, + ValidArgs: []string{"bash", "zsh", "fish", "powershell"}, + Args: cobra.ExactValidArgs(1), + Run: func(cmd *cobra.Command, args []string) { + switch args[0] { + case "bash": + cmd.Root().GenBashCompletion(os.Stdout) + case "zsh": + cmd.Root().GenZshCompletion(os.Stdout) + case "fish": + cmd.Root().GenFishCompletion(os.Stdout, true) + case "powershell": + cmd.Root().GenPowerShellCompletionWithDesc(os.Stdout) + } + }, + } + + return cmd +} diff --git a/etcdutl/etcdutl/defrag_command.go b/etcdutl/etcdutl/defrag_command.go index 1660dd707..231d9e034 100644 --- a/etcdutl/etcdutl/defrag_command.go +++ b/etcdutl/etcdutl/defrag_command.go @@ -38,6 +38,7 @@ func NewDefragCommand() *cobra.Command { } cmd.Flags().StringVar(&defragDataDir, "data-dir", "", "Required. Defragments a data directory not in use by etcd.") cmd.MarkFlagRequired("data-dir") + cmd.MarkFlagDirname("data-dir") return cmd } @@ -65,7 +66,7 @@ func DefragData(dataDir string) error { case <-bch: case <-time.After(time.Second): fmt.Fprintf(os.Stderr, "waiting for etcd to close and release its lock on %q. "+ - "To defrag a running etcd instance, omit --data-dir.\n", dbDir) + "To defrag a running etcd instance, use `etcdctl defrag` instead.\n", dbDir) <-bch } return be.Defrag() diff --git a/etcdutl/etcdutl/snapshot_command.go b/etcdutl/etcdutl/snapshot_command.go index 94ab2a5ac..0ff618339 100644 --- a/etcdutl/etcdutl/snapshot_command.go +++ b/etcdutl/etcdutl/snapshot_command.go @@ -92,7 +92,8 @@ func NewSnapshotRestoreCommand() *cobra.Command { cmd.Flags().StringVar(&restoreName, "name", defaultName, "Human-readable name for this member") cmd.Flags().BoolVar(&skipHashCheck, "skip-hash-check", false, "Ignore snapshot integrity hash value (required if copied from data directory)") - cmd.MarkFlagRequired("data-dir") + cmd.MarkFlagDirname("data-dir") + cmd.MarkFlagDirname("wal-dir") return cmd } diff --git a/tests/e2e/ctl_v3_completion_test.go b/tests/e2e/ctl_v3_completion_test.go index eb5423a2b..6dcfef07e 100644 --- a/tests/e2e/ctl_v3_completion_test.go +++ b/tests/e2e/ctl_v3_completion_test.go @@ -24,13 +24,15 @@ import ( "github.com/stretchr/testify/require" ) -func TestCtlV3CompletionBash(t *testing.T) { testShellCompletion(t, "bash") } +func TestCtlV3CompletionBash(t *testing.T) { testShellCompletion(t, ctlBinPath, "bash") } -func testShellCompletion(t *testing.T, shellName string) { +func TestUtlV3CompletionBash(t *testing.T) { testShellCompletion(t, utlBinPath, "bash") } + +func testShellCompletion(t *testing.T, binPath, shellName string) { BeforeTest(t) stdout := new(bytes.Buffer) - completionCmd := exec.Command(ctlBinPath, "completion", shellName) + completionCmd := exec.Command(binPath, "completion", shellName) completionCmd.Stdout = stdout completionCmd.Stderr = os.Stderr require.NoError(t, completionCmd.Run())