From 15aa5adabf063b9cfe53d6a30039aea21d054af9 Mon Sep 17 00:00:00 2001
From: Adrian Orive <adrian.orive.oneca@gmail.com>
Date: Tue, 3 Nov 2020 10:36:29 +0100
Subject: [PATCH] Provide a cli option to enable and disable completion command

Signed-off-by: Adrian Orive <adrian.orive.oneca@gmail.com>
---
 cmd/completion.go                     |  72 -----------------
 cmd/main.go                           |   2 +-
 docs/book/src/reference/completion.md |   2 +-
 pkg/cli/cli.go                        |  15 ++++
 pkg/cli/cli_test.go                   |  17 ++++
 pkg/cli/completion.go                 | 108 ++++++++++++++++++++++++++
 6 files changed, 142 insertions(+), 74 deletions(-)
 delete mode 100644 cmd/completion.go
 create mode 100644 pkg/cli/completion.go

diff --git a/cmd/completion.go b/cmd/completion.go
deleted file mode 100644
index ca671a75b09..00000000000
--- a/cmd/completion.go
+++ /dev/null
@@ -1,72 +0,0 @@
-/*
-Copyright 2020 The Kubernetes 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 main
-
-import (
-	"os"
-
-	"github.com/spf13/cobra"
-)
-
-func newCompletionCmd() *cobra.Command {
-	completionCmd := &cobra.Command{
-		Use: "completion",
-		Long: `Output shell completion code for the specified shell (bash or zsh). 
-The shell code must be evaluated to provide interactive completion of kubebuilder commands.
-This can be done by sourcing ~/.bash_profile or ~/.bashrc.
-Detailed instructions on how to do this are available at docs/book/src/reference/completion.md
-`,
-		Example: `To load all completions run:
-$ . <(kubebuilder completion)
-To configure your shell to load completions for each session add to your .bashrc:
-$ echo -e "\n. <(kubebuilder completion)" >> ~/.bashrc
-`,
-	}
-	completionCmd.AddCommand(newZshCmd())
-	completionCmd.AddCommand(newBashCmd())
-	return completionCmd
-}
-
-func newBashCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:   "bash",
-		Short: "Generate bash completions",
-		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
-			return cmd.Root().GenBashCompletion(os.Stdout)
-		},
-		Example: `To load completion run:
-$ . <(kubebuilder completion bash)
-To configure your bash shell to load completions for each session add to your bashrc:
-$ echo -e "\n. <(kubebuilder completion bash)" >> ~/.bashrc
-`,
-	}
-}
-
-func newZshCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:   "zsh",
-		Short: "Generate zsh completions",
-		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
-			return cmd.Root().GenZshCompletion(os.Stdout)
-		},
-		Example: `To load completion run:
-$ . <(kubebuilder completion zsh)
-To configure your zsh shell to load completions for each session add to your bashrc:
-$ echo -e "\n. <(kubebuilder completion zsh)" >> ~/.bashrc
-`,
-	}
-}
diff --git a/cmd/main.go b/cmd/main.go
index 0839bcd2ba4..d49adcadc38 100644
--- a/cmd/main.go
+++ b/cmd/main.go
@@ -35,9 +35,9 @@ func main() {
 			&pluginv2.Plugin{},
 		),
 		cli.WithExtraCommands(
-			newCompletionCmd(),
 			version.NewCmd(),
 		),
+		cli.WithCompletion,
 	)
 	if err != nil {
 		log.Fatal(err)
diff --git a/docs/book/src/reference/completion.md b/docs/book/src/reference/completion.md
index 44e5ecdae98..a30635c7e0e 100644
--- a/docs/book/src/reference/completion.md
+++ b/docs/book/src/reference/completion.md
@@ -1,5 +1,5 @@
 # Enabling shell autocompletion
-The Kubebuilder completion script for Bash can be generated with the command `kubebuilder completion bash` as the Kubebuilder completion script for Zsh can be generated with the command `kubebuilder completion zsh`. 
+The Kubebuilder completion script can be generated with the command `kubebuilder completion [bash|zsh|powershell]`. 
 Note that sourcing the completion script in your shell enables Kubebuilder autocompletion. 
 
 <aside class="note">
diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go
index 350094386d0..c8827ce6c96 100644
--- a/pkg/cli/cli.go
+++ b/pkg/cli/cli.go
@@ -66,6 +66,9 @@ type cli struct {
 	// Whether the command is requesting help.
 	doGenericHelp bool
 
+	// Whether to add a completion command to the cli
+	completionCommand bool
+
 	// Plugins injected by options.
 	pluginsFromOptions map[string][]plugin.Base
 	// Default plugins injected by options. Only one plugin per project version
@@ -173,6 +176,12 @@ func WithExtraCommands(cmds ...*cobra.Command) Option {
 	}
 }
 
+// WithCompletion is an Option that adds the completion subcommand.
+func WithCompletion(c *cli) error {
+	c.completionCommand = true
+	return nil
+}
+
 // initialize initializes the cli.
 func (c *cli) initialize() error {
 	// Initialize cli with globally-relevant flags or flags that determine
@@ -345,6 +354,12 @@ func (c cli) buildRootCmd() *cobra.Command {
 		rootCmd.AddCommand(alphaCmd)
 	}
 
+	// kubebuilder completion
+	// Only add completion if requested
+	if c.completionCommand {
+		rootCmd.AddCommand(c.newCompletionCmd())
+	}
+
 	// kubebuilder create
 	createCmd := c.newCreateCmd()
 	// kubebuilder create api
diff --git a/pkg/cli/cli_test.go b/pkg/cli/cli_test.go
index bb7c2163ac5..bfba567625e 100644
--- a/pkg/cli/cli_test.go
+++ b/pkg/cli/cli_test.go
@@ -244,6 +244,23 @@ var _ = Describe("CLI", func() {
 				Expect(c.(*cli).extraCommands[0].Use).To(Equal(commandTest.Use))
 			})
 		})
+
+		Context("WithCompletion", func() {
+			It("should add the completion command if requested", func() {
+				By("not providing WithCompletion")
+				c, err = New(WithDefaultPlugins(pluginAV1), WithPlugins(allPlugins...))
+				Expect(err).NotTo(HaveOccurred())
+				Expect(c).NotTo(BeNil())
+				Expect(c.(*cli).completionCommand).To(BeFalse())
+
+				By("providing WithCompletion")
+				c, err = New(WithCompletion, WithDefaultPlugins(pluginAV1), WithPlugins(allPlugins...))
+				Expect(err).NotTo(HaveOccurred())
+				Expect(c).NotTo(BeNil())
+				Expect(c.(*cli).completionCommand).To(BeTrue())
+			})
+		})
+
 	})
 
 })
diff --git a/pkg/cli/completion.go b/pkg/cli/completion.go
new file mode 100644
index 00000000000..624aac0625e
--- /dev/null
+++ b/pkg/cli/completion.go
@@ -0,0 +1,108 @@
+/*
+Copyright 2020 The Kubernetes 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 cli
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+func (c *cli) newBashCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "bash",
+		Short: "Load bash completions",
+		Example: fmt.Sprintf(`# To load completion for this session, execute:
+$ source <(%[1]s completion bash)
+
+# To load completions for each session, execute once:
+Linux:
+  $ %[1]s completion bash > /etc/bash_completion.d/%[1]s
+MacOS:
+  $ %[1]s completion bash > /usr/local/etc/bash_completion.d/%[1]s
+`, c.commandName),
+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenBashCompletion(os.Stdout)
+		},
+	}
+}
+
+func (c *cli) newZshCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "zsh",
+		Short: "Load zsh completions",
+		Example: fmt.Sprintf(`# 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:
+$ %[1]s completion zsh > "${fpath[1]}/_%[1]s"
+
+# You will need to start a new shell for this setup to take effect.
+`, c.commandName),
+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenZshCompletion(os.Stdout)
+		},
+	}
+}
+
+/* TODO: support fish code completion
+    At the time this comment is written, the imported spf13.cobra version does not support fish completion.
+    However, fish completion has been added to new spf13.cobra versions. When a new spf13.cobra version that
+    supports it is used, uncomment this command and add it to the base completion command.
+func (c *cli) newFishCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "fish",
+		Short: "Load fish completions",
+		Example: fmt.Sprintf(`# To load completion for this session, execute:
+$ %[1]s completion fish | source
+
+# To load completions for each session, execute once:
+$ %[1]s completion fish > ~/.config/fish/completions/%[1]s.fish`, c.commandName),
+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenFishCompletion(os.Stdout)
+		},
+	}
+}
+*/
+
+func (c *cli) newPowerShellCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "powershell",
+		Short: "Load powershell completions",
+		RunE: func(cmd *cobra.Command, cmdArgs []string) error {
+			return cmd.Root().GenPowerShellCompletion(os.Stdout)
+		},
+	}
+}
+
+func (c *cli) newCompletionCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "completion",
+		Short: "Load completions for the specified shell",
+		Long: fmt.Sprintf(`Output shell completion code for the specified shell.
+The shell code must be evaluated to provide interactive completion of %[1]s commands.
+Detailed instructions on how to do this for each shell are provided in their own commands.
+`, c.commandName),
+	}
+	cmd.AddCommand(c.newBashCmd())
+	cmd.AddCommand(c.newZshCmd())
+	// cmd.AddCommand(c.newFishCmd()) // TODO: uncomment when adding fish completion
+	cmd.AddCommand(c.newPowerShellCmd())
+	return cmd
+}