-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cli): add completion cmd and remove unused flag (#647)
- Loading branch information
1 parent
63e837c
commit 06ff15b
Showing
18 changed files
with
309 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| /* | ||
| Copyright (c) 2024 OceanBase | ||
| ob-operator is licensed under Mulan PSL v2. | ||
| You can use this software according to the terms and conditions of the Mulan PSL v2. | ||
| You may obtain a copy of Mulan PSL v2 at: | ||
| http://license.coscl.org.cn/MulanPSL2 | ||
| THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, | ||
| EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, | ||
| MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. | ||
| See the Mulan PSL v2 for more details. | ||
| */ | ||
| package completion | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/oceanbase/ob-operator/internal/cli/utils" | ||
| ) | ||
|
|
||
| const defaultBoilerPlate = ` | ||
| # Copyright (c) 2024 OceanBase | ||
| # ob-operator is licensed under Mulan PSL v2. | ||
| # You can use this software according to the terms and conditions of the Mulan PSL v2. | ||
| # You may obtain a copy of Mulan PSL v2 at: | ||
| # | ||
| # http://license.coscl.org.cn/MulanPSL2 | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, | ||
| # EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, | ||
| # MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. | ||
| # See the Mulan PSL v2 for more details. | ||
| ` | ||
|
|
||
| var completionLong = `To load completions: | ||
| Bash: | ||
| $ source <(obocli completion bash) | ||
| # To load completions for each session, execute once: | ||
| # Linux: | ||
| $ obocli completion bash > /etc/bash_completion.d/obocli | ||
| # macOS: | ||
| $ obocli completion bash > /usr/local/etc/bash_completion.d/obocli | ||
| 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 in your current shell session: | ||
| $ source <(obocli completion zsh) | ||
| # To load completions for each session, execute once: | ||
| $ obocli completion zsh > "${fpath[1]}/_obocli" | ||
| # You will need to start a new shell for this setup to take effect. | ||
| fish: | ||
| $ obocli completion fish | source | ||
| # To load completions for each session, execute once: | ||
| $ obocli completion fish > ~/.config/fish/completions/obocli.fish | ||
| PowerShell: | ||
| PS> obocli completion powershell | Out-String | Invoke-Expression | ||
| # To load completions for every new session, run: | ||
| PS> obocli completion powershell > obocli.ps1 | ||
| # and source this file from your PowerShell profile. | ||
| ` | ||
| var ( | ||
| completionShells = map[string]func(out io.Writer, boilerPlate string, cmd *cobra.Command) error{ | ||
| "bash": runCompletionBash, | ||
| "zsh": runCompletionZsh, | ||
| "fish": runCompletionFish, | ||
| "powershell": runCompletionPwsh, | ||
| } | ||
| ) | ||
|
|
||
| // NewCmd creates the instruction command for the completion of commands | ||
| func NewCmd(out io.Writer, boilerPlate string) *cobra.Command { | ||
| logger := utils.GetDefaultLoggerInstance() | ||
| shells := make([]string, 0, len(completionShells)) | ||
| for shell := range completionShells { | ||
| shells = append(shells, shell) | ||
| } | ||
| cmd := &cobra.Command{ | ||
| Use: "completion [bash|zsh|fish|powershell]", | ||
| Short: "Generate completion script for the specified shell (bash, zsh, fish, powershell)", | ||
| Long: completionLong, | ||
| DisableFlagsInUseLine: true, | ||
| ValidArgs: shells, | ||
| Args: cobra.OnlyValidArgs, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| if err := RunCompletionE(out, boilerPlate, cmd, args); err != nil { | ||
| logger.Fatalln(err) | ||
| } | ||
| }, | ||
| } | ||
| return cmd | ||
| } | ||
|
|
||
| // RunCompletionE is the entry point for the completion command | ||
| func RunCompletionE(out io.Writer, boilerPlate string, cmd *cobra.Command, args []string) error { | ||
| if len(args) == 0 { | ||
| return errors.New("shell not specified. See 'obocli completion -h' for help and examples") | ||
| } | ||
| if len(args) > 1 { | ||
| return errors.New("too many arguments. Expected only the shell type. See 'obocli completion -h' for help and examples") | ||
| } | ||
| run, found := completionShells[args[0]] | ||
| if !found { | ||
| return fmt.Errorf("unsupported shell type %q", args[0]) | ||
| } | ||
| return run(out, boilerPlate, cmd.Parent()) | ||
| } | ||
|
|
||
| func runCompletionBash(out io.Writer, boilerPlate string, cmd *cobra.Command) error { | ||
| if len(boilerPlate) == 0 { | ||
| boilerPlate = defaultBoilerPlate | ||
| } | ||
| if _, err := out.Write([]byte(boilerPlate)); err != nil { | ||
| return err | ||
| } | ||
| return cmd.GenBashCompletionV2(out, true) | ||
| } | ||
|
|
||
| func runCompletionZsh(out io.Writer, boilerPlate string, cmd *cobra.Command) error { | ||
| // Add zsh completion header to specify the command to complete for zsh | ||
| zshHead := fmt.Sprintf("#compdef %[1]s\ncompdef _%[1]s %[1]s\n", cmd.Name()) | ||
| if _, err := out.Write([]byte(zshHead)); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if len(boilerPlate) == 0 { | ||
| boilerPlate = defaultBoilerPlate | ||
| } | ||
| if _, err := out.Write([]byte(boilerPlate)); err != nil { | ||
| return err | ||
| } | ||
| return cmd.GenZshCompletion(out) | ||
| } | ||
|
|
||
| func runCompletionFish(out io.Writer, boilerPlate string, cmd *cobra.Command) error { | ||
| if len(boilerPlate) == 0 { | ||
| boilerPlate = defaultBoilerPlate | ||
| } | ||
| if _, err := out.Write([]byte(boilerPlate)); err != nil { | ||
| return err | ||
| } | ||
| return cmd.GenFishCompletion(out, true) | ||
| } | ||
|
|
||
| func runCompletionPwsh(out io.Writer, boilerPlate string, cmd *cobra.Command) error { | ||
| if len(boilerPlate) == 0 { | ||
| boilerPlate = defaultBoilerPlate | ||
| } | ||
| if _, err := out.Write([]byte(boilerPlate)); err != nil { | ||
| return err | ||
| } | ||
| return cmd.GenPowerShellCompletionWithDesc(out) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| Copyright (c) 2024 OceanBase | ||
| ob-operator is licensed under Mulan PSL v2. | ||
| You can use this software according to the terms and conditions of the Mulan PSL v2. | ||
| You may obtain a copy of Mulan PSL v2 at: | ||
| http://license.coscl.org.cn/MulanPSL2 | ||
| THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, | ||
| EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, | ||
| MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. | ||
| See the Mulan PSL v2 for more details. | ||
| */ | ||
| package completion | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func TestCompletions(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| args []string | ||
| expectedError string | ||
| }{ | ||
| { | ||
| name: "bash", | ||
| args: []string{"bash"}, | ||
| }, | ||
| { | ||
| name: "zsh", | ||
| args: []string{"zsh"}, | ||
| }, | ||
| { | ||
| name: "fish", | ||
| args: []string{"fish"}, | ||
| }, | ||
| { | ||
| name: "powershell", | ||
| args: []string{"powershell"}, | ||
| }, | ||
| { | ||
| name: "no args", | ||
| args: []string{}, | ||
| expectedError: "shell not specified. See 'obocli completion -h' for help and examples", | ||
| }, | ||
| { | ||
| name: "too many args", | ||
| args: []string{"bash", "zsh"}, | ||
| expectedError: "too many arguments. Expected only the shell type. See 'obocli completion -h' for help and examples", | ||
| }, | ||
| { | ||
| name: "unsupported shell", | ||
| args: []string{"foo"}, | ||
| expectedError: (`unsupported shell type "foo"`), | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(tt *testing.T) { | ||
| parentCmd := &cobra.Command{ | ||
| Use: "obocli", | ||
| } | ||
| out := new(bytes.Buffer) | ||
| cmd := NewCmd(out, defaultBoilerPlate) | ||
| parentCmd.AddCommand(cmd) | ||
| err := RunCompletionE(out, defaultBoilerPlate, cmd, tc.args) | ||
| if tc.expectedError == "" { | ||
| if err != nil { | ||
| tt.Fatalf("Unexpected error: %v", err) | ||
| } | ||
| if out.Len() == 0 { | ||
| tt.Fatalf("Output was not written") | ||
| } | ||
| if !strings.Contains(out.String(), defaultBoilerPlate) { | ||
| tt.Fatalf("Output does not contain boilerplate:\n%s", out.String()) | ||
| } | ||
| } else { | ||
| if err == nil { | ||
| tt.Fatalf("An error was expected but no error was returned") | ||
| } | ||
| if err.Error() != tc.expectedError { | ||
| tt.Fatalf("unexpected error: %v\n expected: %v\n", err, tc.expectedError) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.