knative
/
client
mirror of https://github.com/knative/client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixes(#414): change plugins config to use - instead of camel case (#428) 

This solves 414 by adopting new format for config keys and thereby
bypassing the need for case sensitivity in Viper. Also changed
`lookupPluginsInPath` key to `lookup-plugins` and also same for the
persistent flag. The PATH part is implied and can be read from
help.
This commit is contained in:
dr.max 2019-10-04 00:48:08 -07:00 committed by Knative Prow Robot
parent b27e366dcb
commit d543b0e5a3
10 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/cmd/kn.md
View File

@ -12,12 +12,12 @@ Manage your Knative building blocks:
### Options
```
--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)
--log-http log http traffic
--lookup-plugins-in-path look for kn plugins in $PATH
--plugins-dir string kn plugins directory (default "~/.kn/plugins")
--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)
--log-http log http traffic
--lookup-plugins look for kn plugins in $PATH
--plugins-dir string kn plugins directory (default "~/.kn/plugins")
```
### SEE ALSO

6
docs/cmd/kn_plugin.md
View File

@ -16,9 +16,9 @@ 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")
-h, --help help for plugin
--lookup-plugins look for kn plugins in $PATH
--plugins-dir string kn plugins directory (default "~/.kn/plugins")
```
### Options inherited from parent commands

10
docs/cmd/kn_plugin_list.md
View File

@ -19,11 +19,11 @@ 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")
--verbose verbose output
-h, --help help for list
--lookup-plugins 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")
--verbose verbose output
```
### Options inherited from parent commands

4
pkg/kn/commands/plugin/list.go
View File

@ -63,7 +63,7 @@ func listPlugins(cmd *cobra.Command, flags pluginListFlags) error {
if err != nil {
return err
}
if commands.Cfg.LookupPluginsInPath {
if commands.Cfg.LookupPlugins {
pluginPath = pluginPath + string(os.PathListSeparator) + os.Getenv("PATH")
}
@ -74,7 +74,7 @@ func listPlugins(cmd *cobra.Command, flags pluginListFlags) error {
if flags.verbose {
fmt.Fprintf(out, "The following plugins are available, using options:\n")
fmt.Fprintf(out, " - plugins dir: '%s'%s\n", commands.Cfg.PluginsDir, extraLabelIfPathNotExists(pluginPath))
fmt.Fprintf(out, " - lookup plugins in path: '%t'\n", commands.Cfg.LookupPluginsInPath)
fmt.Fprintf(out, " - lookup plugins in $PATH: '%t'\n", commands.Cfg.LookupPlugins)
}
if len(pluginsFound) == 0 {

18
pkg/kn/commands/plugin/list_test.go
View File

@ -107,14 +107,14 @@ func TestPluginList(t *testing.T) {
assert.Assert(t, pluginListCmd.RunE != nil)
})
t.Run("when pluginsDir does not include any plugins", func(t *testing.T) {
t.Run("when --lookup-plugins-in-path is true", func(t *testing.T) {
t.Run("when plugins-dir does not include any plugins", func(t *testing.T) {
t.Run("when --lookup-plugins is true", func(t *testing.T) {
t.Run("no plugins installed", func(t *testing.T) {
t.Run("warns user that no plugins found in verbose mode", func(t *testing.T) {
ctx := setup(t)
defer ctx.cleanup()
err := ctx.execute("plugin", "list", "--lookup-plugins-in-path=true", "--verbose")
err := ctx.execute("plugin", "list", "--lookup-plugins=true", "--verbose")
assert.NilError(t, err)
assert.Assert(t, util.ContainsAll(ctx.output(), "No plugins found"))
})
@ -122,7 +122,7 @@ func TestPluginList(t *testing.T) {
t.Run("no output when no plugins found", func(t *testing.T) {
ctx := setup(t)
defer ctx.cleanup()
err := ctx.execute("plugin", "list", "--lookup-plugins-in-path=true")
err := ctx.execute("plugin", "list", "--lookup-plugins=true")
assert.NilError(t, err)
assert.Equal(t, ctx.output(), "No plugins found.\n")
})
@ -138,7 +138,7 @@ func TestPluginList(t *testing.T) {
err := ctx.createTestPlugin(KnTestPluginName, FileModeExecutable, true)
assert.NilError(t, err)
err = ctx.execute("plugin", "list", "--lookup-plugins-in-path=true")
err = ctx.execute("plugin", "list", "--lookup-plugins=true")
assert.NilError(t, err)
assert.Assert(t, util.ContainsAll(ctx.output(), KnTestPluginName))
})
@ -152,7 +152,7 @@ func TestPluginList(t *testing.T) {
err := ctx.createTestPlugin(KnTestPluginName, FileModeReadable, false)
assert.NilError(t, err)
err = ctx.execute("plugin", "list", "--lookup-plugins-in-path=false")
err = ctx.execute("plugin", "list", "--lookup-plugins=false")
assert.NilError(t, err)
assert.Assert(t, util.ContainsAll(ctx.output(), "WARNING", "not executable", "current user"))
})
@ -177,7 +177,7 @@ func TestPluginList(t *testing.T) {
err = ctx.createTestPluginWithPath(KnTestPluginName, FileModeExecutable, tmpPathDir2)
assert.NilError(t, err)
err = ctx.execute("plugin", "list", "--lookup-plugins-in-path=true")
err = ctx.execute("plugin", "list", "--lookup-plugins=true")
assert.NilError(t, err)
assert.Assert(t, util.ContainsAll(ctx.output(), "WARNING", "shadowed", "ignored"))
})
@ -197,7 +197,7 @@ func TestPluginList(t *testing.T) {
err := ctx.createTestPlugin("kn-fake", FileModeExecutable, true)
assert.NilError(t, err)
err = ctx.execute("plugin", "list", "--lookup-plugins-in-path=true")
err = ctx.execute("plugin", "list", "--lookup-plugins=true")
assert.ErrorContains(t, err, "overwrite", "built-in")
assert.Assert(t, util.ContainsAll(ctx.output(), "ERROR", "overwrite", "built-in"))
})
@ -206,7 +206,7 @@ func TestPluginList(t *testing.T) {
})
})
t.Run("when pluginsDir has plugins", func(t *testing.T) {
t.Run("when plugins-dir has plugins", func(t *testing.T) {
t.Run("list plugins in --plugins-dir", func(t *testing.T) {
ctx := setup(t)
defer ctx.cleanup()

10
pkg/kn/commands/plugin/plugin.go
View File

@ -41,14 +41,14 @@ Please refer to the documentation and examples for more information about how wr
// AddPluginFlags plugins-dir and lookup-plugins-in-path to cmd
func AddPluginFlags(cmd *cobra.Command) {
cmd.Flags().StringVar(&commands.Cfg.PluginsDir, "plugins-dir", "~/.kn/plugins", "kn plugins directory")
cmd.Flags().BoolVar(&commands.Cfg.LookupPluginsInPath, "lookup-plugins-in-path", false, "look for kn plugins in $PATH")
cmd.Flags().BoolVar(&commands.Cfg.LookupPlugins, "lookup-plugins", false, "look for kn plugins in $PATH")
}
// BindPluginsFlagToViper bind and set default with viper for plugins flags
func BindPluginsFlagToViper(cmd *cobra.Command) {
viper.BindPFlag("pluginsDir", cmd.Flags().Lookup("plugins-dir"))
viper.BindPFlag("lookupPluginsInPath", cmd.Flags().Lookup("lookup-plugins-in-path"))
viper.BindPFlag("plugins-dir", cmd.Flags().Lookup("plugins-dir"))
viper.BindPFlag("lookup-plugins", cmd.Flags().Lookup("lookup-plugins"))
viper.SetDefault("pluginsDir", "~/.kn/plugins")
viper.SetDefault("lookupPluginsInPath", false)
viper.SetDefault("plugins-dir", "~/.kn/plugins")
viper.SetDefault("lookup-plugins", false)
}

4
pkg/kn/commands/plugin/plugin_test.go
View File

@ -37,7 +37,7 @@ Available Commands:
Flags:
-h, --help help for plugin
--lookup-plugins-in-path look for kn plugins in $PATH
--lookup-plugins look for kn plugins in $PATH
--plugins-dir string kn plugins directory (default "~/.kn/plugins")
Global Flags:
@ -68,7 +68,7 @@ func TestNewPluginCommand(t *testing.T) {
assert.Assert(t, pluginCmd.Short == "Plugin command group")
assert.Assert(t, strings.Contains(pluginCmd.Long, "Provides utilities for interacting and managing with kn plugins."))
assert.Assert(t, pluginCmd.Flags().Lookup("plugins-dir") != nil)
assert.Assert(t, pluginCmd.Flags().Lookup("lookup-plugins-in-path") != nil)
assert.Assert(t, pluginCmd.Flags().Lookup("lookup-plugins") != nil)
assert.Assert(t, pluginCmd.Args == nil)
})
}

10
pkg/kn/commands/testing_helper.go
View File

@ -119,13 +119,13 @@ Eventing: Manage event subscriptions and channels. Connect up event sources.`,
rootCmd.PersistentFlags().StringVar(&params.KubeCfgPath, "kubeconfig", "", "kubectl config file (default is $HOME/.kube/config)")
rootCmd.Flags().StringVar(&Cfg.PluginsDir, "plugins-dir", "~/.kn/plugins", "kn plugins directory")
rootCmd.Flags().BoolVar(&Cfg.LookupPluginsInPath, "lookup-plugins-in-path", false, "look for kn plugins in $PATH")
rootCmd.Flags().BoolVar(&Cfg.LookupPlugins, "lookup-plugins", false, "look for kn plugins in $PATH")
viper.BindPFlag("pluginsDir", rootCmd.Flags().Lookup("plugins-dir"))
viper.BindPFlag("lookupPluginsInPath", rootCmd.Flags().Lookup("lookup-plugins-in-path"))
viper.BindPFlag("plugins-dir", rootCmd.Flags().Lookup("plugins-dir"))
viper.BindPFlag("lookup-plugins", rootCmd.Flags().Lookup("lookup-plugins"))
viper.SetDefault("pluginsDir", "~/.kn/plugins")
viper.SetDefault("lookupPluginsInPath", false)
viper.SetDefault("plugins-dir", "~/.kn/plugins")
viper.SetDefault("lookup-plugins", false)
rootCmd.AddCommand(subCommand)

4
pkg/kn/commands/types.go
View File

@ -34,8 +34,8 @@ var Cfg Config
// Config contains the variables for the Kn config
type Config struct {
PluginsDir string
LookupPluginsInPath bool
PluginsDir string
LookupPlugins bool
}
// Parameters for creating commands. Useful for inserting mocks for testing.

2
pkg/kn/core/root_test.go
View File

@ -177,7 +177,7 @@ func checkRootCmd(t *testing.T, rootCmd *cobra.Command) {
assert.Assert(t, rootCmd.SilenceErrors)
assert.Assert(t, rootCmd.Flags().Lookup("plugins-dir") != nil)
assert.Assert(t, rootCmd.Flags().Lookup("lookup-plugins-in-path") != nil)
assert.Assert(t, rootCmd.Flags().Lookup("lookup-plugins") != nil)
assert.Assert(t, rootCmd.RunE == nil)
}