Merge pull request #21 from mia-platform/issue-10

Add completion for fish, bash and zsh

Author: davidebianchi

.gitignore

@@ -16,3 +16,6 @@
 
 # Build output directory
 execs/*
+
+# Program binary
+miactl

README.md

@@ -41,6 +41,77 @@ miactl help
 ```
 
 
+## Enabling shell autocompletion
+
+miactl provides autocompletion support for Bash, Zsh and Fish, which can save you a lot of typing.
+
+### Bash
+
+Completion could be generate running the `miactl completion bash` command.
+In order to make this completion work, you should have [bash completion](https://github.com/scop/bash-completion)
+correctly installed.
+
+Warning: there are two versions of `bash-completion`, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The miactl completion script requires `bash-completion` v2 and Bash 4.1+.
+
+**For linux:**
+
+You could install `bash-completion` running `apt-get install bash-completion`.
+
+The above command create `/usr/share/bash-completion/bash_completion`, which is the main script of bash completion.
+Try to run the command `type _init_completion`. If the command succeeds, you're already seet. Otherwise add to the `~/.bashrc` file:
+
+```sh
+source /usr/share/bash-completion/bash_completion
+```
+
+After the correct installation if bash completion, you could make the completion works running:
+```sh
+miactl completion bash >/etc/bash_completion.d/miactl
+```
+
+**For osx:**
+
+Check the bash version running `echo $BASH_VERSION`. If the version is less than 4.1, you should install a new bash version with Homebrew running
+
+```sh
+brew install bash
+```
+
+Reload your shell and run the command `echo $BASH_VERSION` to verify the bash version.
+
+Once installed the correct bash version, you should install `bash-completion` to v2. To check if it is already installed, run `type _init_completion`. If not, you can install it with Homebrew
+
+```sh
+brew install bash-completion@2
+````
+
+And add in your `~/.bashrc` file:
+```sh
+export BASH_COMPLETION_COMPAT_DIR="/usr/local/etc/bash_completion.d"
+[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"
+```
+
+After the correct installation if bash completion, you could make the completion works running:
+```sh
+miactl completion bash >/etc/bash_completion.d/miactl
+```
+
+### Fish
+
+Completion could be generate running the `miactl completion fish` command.
+
+In order to make this completion work, you should run:
+```sh
+miactl completion fish >~/.config/fish/completions/miactl.fish
+```
+
+### Zsh
+
+Completion could be generate running the `miactl completion zsh` command
+
+The generated completion script should be put somewhere in your $fpath named _miactl.
+
+
 [github-actions]: https://github.com/mia-platform/miactl/actions
 [github-actions-svg]: https://github.com/mia-platform/miactl/workflows/Test%20and%20build/badge.svg
 [godoc-svg]: https://godoc.org/github.com/mia-platform/miactl?status.svg

cmd/completion.go

@@ -0,0 +1,59 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// completionCmd represents the completion command
+func newCompletionCmd(rootCmd *cobra.Command) *cobra.Command {
+	longUsage := `To load completion run
+
+	For bash:
+
+	miactl completion bash >/etc/bash_completion.d/miactl
+
+	To configure your bash shell to load completions for each session add to your bashrc, run
+
+	echo 'source <(miactl completion bash)' >>~/.bashrc
+
+	For fish:
+
+	miactl completion fish >~/.config/fish/completions/miactl.fish
+
+	For zsh:
+
+	To generate the completion script, run miactl completion zsh
+	the generated completion script should be put somewhere in your $fpath named _miactl
+
+	---
+
+	After reloading your shell, miactl autocompletion should be working.
+	`
+
+	validArgs := []string{"bash", "fish", "zsh"}
+
+	var completionCmd = &cobra.Command{
+		Use:       "completion",
+		Short:     "Generates bash completion scripts",
+		Long:      longUsage,
+		ValidArgs: validArgs,
+		Args: func(cmd *cobra.Command, args []string) error {
+			return cobra.ExactValidArgs(1)(cmd, args)
+		},
+		Run: func(cmd *cobra.Command, args []string) {
+
+			shell := args[0]
+
+			switch shell {
+			case "bash":
+				rootCmd.GenBashCompletion(cmd.OutOrStdout())
+			case "fish":
+				rootCmd.GenFishCompletion(cmd.OutOrStdout(), true)
+			case "zsh":
+				rootCmd.GenZshCompletion(cmd.OutOrStdout())
+			}
+		},
+	}
+
+	return completionCmd
+}

cmd/completion_test.go

@@ -0,0 +1,41 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestCompletion(t *testing.T) {
+	t.Run("without correct args", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "completion", "not-correct-arg")
+		expectedErrMessage := `invalid argument "not-correct-arg" for "miactl completion"`
+		require.Contains(t, out, expectedErrMessage)
+		require.EqualError(t, err, expectedErrMessage)
+	})
+
+	t.Run("without args", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "completion")
+		expectedErrMessage := `accepts 1 arg(s), received 0`
+		require.Contains(t, out, expectedErrMessage)
+		require.EqualError(t, err, expectedErrMessage)
+	})
+
+	t.Run("with fish arg", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "completion", "fish")
+		require.Nil(t, err)
+		require.Contains(t, out, "# fish completion for miactl")
+	})
+
+	t.Run("with bash arg", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "completion", "bash")
+		require.Nil(t, err)
+		require.Contains(t, out, "# bash completion for miactl")
+	})
+
+	t.Run("with zsh arg", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "completion", "zsh")
+		require.Nil(t, err)
+		require.Contains(t, out, "#compdef _miactl miactl")
+	})
+}

cmd/get.go

@@ -9,12 +9,12 @@ import (
 var validArgs = []string{"project", "projects"}
 
 // NewGetCmd func creates a new command
-func NewGetCmd() *cobra.Command {
+func newGetCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:       "get",
 		ValidArgs: validArgs,
 		Args: func(cmd *cobra.Command, args []string) error {
-			return cobra.OnlyValidArgs(cmd, args)
+			return cobra.ExactValidArgs(1)(cmd, args)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			f, err := GetFactoryFromContext(cmd.Context(), opts)

cmd/get_test.go

@@ -22,7 +22,14 @@ func TestGetCommandRenderAndReturnsError(t *testing.T) {
 
 	t.Run("without correct args", func(t *testing.T) {
 		out, err := executeCommand(NewRootCmd(), "get", "not-correct-arg")
-		expectedErrMessage := `invalid argument "not-correct-arg" for "miaplatformctl get"`
+		expectedErrMessage := `invalid argument "not-correct-arg" for "miactl get"`
+		require.Contains(t, out, expectedErrMessage)
+		require.EqualError(t, err, expectedErrMessage)
+	})
+
+	t.Run("without args", func(t *testing.T) {
+		out, err := executeCommand(NewRootCmd(), "get")
+		expectedErrMessage := `accepts 1 arg(s), received 0`
 		require.Contains(t, out, expectedErrMessage)
 		require.EqualError(t, err, expectedErrMessage)
 	})

cmd/root.go

@@ -20,14 +20,14 @@ var (
 // NewRootCmd creates a new root command
 func NewRootCmd() *cobra.Command {
 	rootCmd := &cobra.Command{
-		Use:     "miaplatformctl",
-		Aliases: []string{"miactl"},
+		Use: "miactl",
 	}
 	setRootPersistentFlag(rootCmd)
 
 	// add sub command to root command
-	rootCmd.AddCommand(NewGetCmd())
+	rootCmd.AddCommand(newGetCmd())
 
+	rootCmd.AddCommand(newCompletionCmd(rootCmd))
 	return rootCmd
 }