fix: fsoc-106: additional config bypass needed (#18)

Stop requiring config profile for certain commands: version, help, gendocs and complete

cmd/gendocs/gendocs.go

@@ -29,6 +29,7 @@ import (
  "github.com/spf13/cobra"
  "github.com/spf13/cobra/doc"
 
+ "github.com/cisco-open/fsoc/cmd/config"
  "github.com/cisco-open/fsoc/output"
 )
 
@@ -46,6 +47,7 @@ The directory should either be empty or not exist.`,
  Args: cobra.ExactArgs(1),
  Run: genDocs,
  TraverseChildren: true,
+ Annotations: map[string]string{config.AnnotationForConfigBypass: ""},
 }
 
 func NewSubCmd() *cobra.Command {

cmd/root.go

@@ -141,8 +141,11 @@ func preExecHook(cmd *cobra.Command, args []string) {
  config.SetSelectedProfile(profile)
  }
  }
- _, bypassConfig := cmd.Annotations[config.AnnotationForConfigBypass]
- if !bypassConfig {
+
+ // enforce presence of a configured profile (unless bypassed for commands that
+ // must work or can work without it)
+ bypass := bypassConfig(cmd) || cmd.Name() == "help" || isCompletionCommand(cmd)
+ if !bypass {
  // If a config file is found, read it in.
  if err := viper.ReadInConfig(); err == nil {
  profile := config.GetCurrentProfileName()
@@ -161,3 +164,13 @@ func preExecHook(cmd *cobra.Command, args []string) {
  }
  }
 }
+
+func bypassConfig(cmd *cobra.Command) bool {
+ _, bypassConfig := cmd.Annotations[config.AnnotationForConfigBypass]
+ return bypassConfig
+}
+
+func isCompletionCommand(cmd *cobra.Command) bool {
+ p := cmd.Parent()
+ return (p != nil && p.Name() == "completion")
+}

cmd/version/update.go

@@ -19,21 +19,24 @@ import (
 
  "github.com/apex/log"
  "github.com/spf13/cobra"
+
+ "github.com/cisco-open/fsoc/cmd/config"
 )
 
 var updateCmd = &cobra.Command{
- Use: "update",
- Short: "Update fsoc",
- Long: `Update fsoc if a new version is available.`,
- Run: update,
+ Use: "update",
+ Short: "Update fsoc",
+ Long: `Update fsoc if a new version is available.`,
+ Run: update,
+ Annotations: map[string]string{config.AnnotationForConfigBypass: ""},
 }
 
 func init() {
  versionCmd.AddCommand(updateCmd)
 }
 
 func update(cmd *cobra.Command, args []string) {
- log.Fatalf("Update command is not yet implemented. Please check version manually and download update if available.")
+ log.Fatalf("Update command is not implemented yet. Please check version manually and download an update if available.")
 }
 
 // func update(core *Core, pkg dependency.Installable) {

cmd/version/version.go

@@ -19,6 +19,7 @@ import (
 
  "github.com/spf13/cobra"
 
+ "github.com/cisco-open/fsoc/cmd/config"
  "github.com/cisco-open/fsoc/output"
 )
 
@@ -29,6 +30,7 @@ var versionCmd = &cobra.Command{
  Run: func(cmd *cobra.Command, args []string) {
  displayVersion(cmd)
  },
+ Annotations: map[string]string{config.AnnotationForConfigBypass: ""},
 }
 
 func init() {