feature(kn plugins): Implements Kn plugins re-using some code from kubectl plugins.

cmd/kn/main.go

@@ -19,12 +19,26 @@ import (
 	"os"
 
 	"github.com/knative/client/pkg/kn/core"
+	"github.com/spf13/viper"
 )
 
+func init() {
+	core.InitializeConfig()
+}
+
+var err error
+
 func main() {
-	err := core.NewKnCommand().Execute()
+	defer cleanup()
+	err = core.NewDefaultKnCommand().Execute()
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
 }
+
+func cleanup() {
+	if err == nil {
+		viper.WriteConfig()
+	}
+}

docs/cmd/kn.md

@@ -12,13 +12,16 @@ Manage your Knative building blocks:
 ### Options
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
-  -h, --help                help for kn
-      --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
+      --config string            kn config file (default is $HOME/.kn/config.yaml)
+  -h, --help                     help for kn
+      --kubeconfig string        kubectl config file (default is $HOME/.kube/config)
+      --lookup-plugins-in-path   look for kn plugins in $PATH
+      --plugins-dir string       kn plugins directory (default "~/.kn/plugins")
 ```
 
 ### SEE ALSO
 
+* [kn plugin](kn_plugin.md)	 - Plugin command group
 * [kn revision](kn_revision.md)	 - Revision command group
 * [kn route](kn_route.md)	 - Route command group
 * [kn service](kn_service.md)	 - Service command group

docs/cmd/kn_plugin.md

@@ -0,0 +1,35 @@
+## kn plugin
+
+Plugin command group
+
+### Synopsis
+
+Provides utilities for interacting and managing with kn plugins.
+
+Plugins provide extended functionality that is not part of the core kn command-line distribution.
+Please refer to the documentation and examples for more information about how write your own plugins.
+
+```
+kn plugin [flags]
+```
+
+### Options
+
+```
+  -h, --help                     help for plugin
+      --lookup-plugins-in-path   look for kn plugins in $PATH
+      --plugins-dir string       kn plugins directory (default "~/.kn/plugins")
+```
+
+### Options inherited from parent commands
+
+```
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
+      --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
+```
+
+### SEE ALSO
+
+* [kn](kn.md)	 - Knative client
+* [kn plugin list](kn_plugin_list.md)	 - List all visible plugin executables
+

docs/cmd/kn_plugin_list.md

@@ -0,0 +1,38 @@
+## kn plugin list
+
+List all visible plugin executables
+
+### Synopsis
+
+List all visible plugin executables.
+
+Available plugin files are those that are:
+- executable
+- begin with "kn-
+- anywhere on the path specified in Kn's config pluginDir variable, which:
+  * can be overridden with the --plugin-dir flag
+
+```
+kn plugin list [flags]
+```
+
+### Options
+
+```
+  -h, --help                     help for list
+      --lookup-plugins-in-path   look for kn plugins in $PATH
+      --name-only                If true, display only the binary name of each plugin, rather than its full path
+      --plugins-dir string       kn plugins directory (default "~/.kn/plugins")
+```
+
+### Options inherited from parent commands
+
+```
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
+      --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
+```
+
+### SEE ALSO
+
+* [kn plugin](kn_plugin.md)	 - Plugin command group
+

docs/cmd/kn_revision.md

@@ -19,7 +19,7 @@ kn revision [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_revision_delete.md

@@ -28,7 +28,7 @@ kn revision delete NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_revision_describe.md

@@ -23,7 +23,7 @@ kn revision describe NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_revision_list.md

@@ -42,7 +42,7 @@ kn revision list [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_route.md

@@ -19,7 +19,7 @@ kn route [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_route_describe.md

@@ -23,7 +23,7 @@ kn route describe NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_route_list.md

@@ -38,7 +38,7 @@ kn route list NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service.md

@@ -19,7 +19,7 @@ kn service [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service_create.md

@@ -60,7 +60,7 @@ kn service create NAME --image IMAGE [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service_delete.md

@@ -31,7 +31,7 @@ kn service delete NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service_describe.md

@@ -23,7 +23,7 @@ kn service describe NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service_list.md

@@ -38,7 +38,7 @@ kn service list [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_service_update.md

@@ -47,7 +47,7 @@ kn service update NAME [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

docs/cmd/kn_version.md

@@ -19,7 +19,7 @@ kn version [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string       config file (default is $HOME/.kn/config.yaml)
+      --config string       kn config file (default is $HOME/.kn/config.yaml)
       --kubeconfig string   kubectl config file (default is $HOME/.kube/config)
 ```
 

pkg/kn/commands/plugin/path_verifier.go

@@ -0,0 +1,102 @@
+// Copyright © 2018 The Knative 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 plugin
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+// PathVerifier receives a path and determines if it is valid or not
+type PathVerifier interface {
+	// Verify determines if a given path is valid
+	Verify(path string) []error
+}
+
+// CommandOverrideVerifier verifies that existing kn commands are not overriden
+type CommandOverrideVerifier struct {
+	Root        *cobra.Command
+	SeenPlugins map[string]string
+}
+
+// Verify implements PathVerifier and determines if a given path
+// is valid depending on whether or not it overwrites an existing
+// kn command path, or a previously seen plugin.
+func (v *CommandOverrideVerifier) Verify(path string) []error {
+	if v.Root == nil {
+		return []error{fmt.Errorf("unable to verify path with nil root")}
+	}
+
+	// extract the plugin binary name
+	segs := strings.Split(path, string(os.PathSeparator))
+	binName := segs[len(segs)-1]
+
+	cmdPath := strings.Split(binName, "-")
+	if len(cmdPath) > 1 {
+		// the first argument is always "kn" for a plugin binary
+		cmdPath = cmdPath[1:]
+	}
+
+	errors := []error{}
+	isExec, err := isExecutable(path)
+	if err == nil && !isExec {
+		errors = append(errors, fmt.Errorf("warning: %s identified as a kn plugin, but it is not executable", path))
+	} else if err != nil {
+		errors = append(errors, fmt.Errorf("error: unable to identify %s as an executable file: %v", path, err))
+	}
+
+	if existingPath, ok := v.SeenPlugins[binName]; ok {
+		errors = append(errors, fmt.Errorf("warning: %s is overshadowed by a similarly named plugin: %s", path, existingPath))
+	} else {
+		v.SeenPlugins[binName] = path
+	}
+
+	cmd, _, err := v.Root.Find(cmdPath)
+	if err == nil {
+		errors = append(errors, fmt.Errorf("warning: %s overwrites existing command: %q", binName, cmd.CommandPath()))
+	}
+
+	return errors
+}
+
+// Private functions
+
+func isExecutable(fullPath string) (bool, error) {
+	info, err := os.Stat(fullPath)
+	if err != nil {
+		return false, err
+	}
+
+	if runtime.GOOS == "windows" {
+		fileExt := strings.ToLower(filepath.Ext(fullPath))
+
+		switch fileExt {
+		case ".bat", ".cmd", ".com", ".exe", ".ps1":
+			return true, nil
+		}
+		return false, nil
+	}
+
+	if m := info.Mode(); !m.IsDir() && m&0111 != 0 {
+		return true, nil
+	}
+
+	return false, nil
+}