Refactor/cmd opts struct (#2761)

* refactor: create a clab.Save method, use that via cmd

* feat: squash all init funcs in cmd

* refactor: begin migration to structs for all cli opts, flatten version stuff up into cmd

* fix: dont use global var for generate node registry

* refactor: structs to hold all cmd options done (i think!)

* fix: typo on api server host

* chore: appease some deepsource nits

* use runtime constant

* GetOptions comment

* remove extra comment

* chore: cleanup some linter nits

* fix: rebased and nits fixed

---------

Co-authored-by: hellt <dodin.roman@gmail.com>

Author: carlmontanari

.gitignore

@@ -52,3 +52,7 @@ __pycache__
 .env
 
 .zed
+
+# to keep robot things away
+venv/
+.venv/

.golangci.yml

@@ -33,8 +33,10 @@ linters:
     - lll
     - mnd
     - nestif
+    - perfsprint
     - prealloc
     - revive
+    - wrapcheck
     - wsl_v5
   settings:
     dupl:
@@ -47,11 +49,7 @@ linters:
       min-occurrences: 2
     gocritic:
       disabled-checks:
-        - dupImport
-        - ifElseChain
-        - octalLiteral
         - whyNoLint
-        - wrapperFunc
       enabled-tags:
         - diagnostic
         - experimental
@@ -84,12 +82,6 @@ linters:
       require-specific: false
       allow-unused: false
   exclusions:
-    generated: lax
-    presets:
-      - comments
-      - common-false-positives
-      - legacy
-      - std-error-handling
     rules:
       # we *care* about tests, but... like less :P
       - linters:
@@ -103,10 +95,6 @@ linters:
       - linters:
           - staticcheck
         text: could remove embedded field
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
 formatters:
   enable:
     - gofmt

.goreleaser.yml

@@ -11,7 +11,7 @@ builds:
       - -trimpath
       - -tags=podman exclude_graphdriver_btrfs btrfs_noversion exclude_graphdriver_devicemapper exclude_graphdriver_overlay containers_image_openpgp
     ldflags:
-      - -s -w -X github.com/srl-labs/containerlab/cmd/version.Version={{.Version}} -X github.com/srl-labs/containerlab/cmd/version.commit={{.ShortCommit}} -X github.com/srl-labs/containerlab/cmd/version.date={{.Date}}
+      - -s -w -X github.com/srl-labs/containerlab/cmd.Version={{.Version}} -X github.com/srl-labs/containerlab/cmd.commit={{.ShortCommit}} -X github.com/srl-labs/containerlab/cmd.date={{.Date}}
     goos:
       - linux
     goarch:

cmd/version/assets/logo.txt cmd/assets/logo.txtcmd/version/assets/logo.txt renamed to cmd/assets/logo.txt

@@ -10,11 +10,11 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// completionCmd represents the completion command.
-var completionCmd = &cobra.Command{
-	Use:   "completion [bash|zsh|fish]",
-	Short: "generate completion script",
-	Long: `To load completions:
+func completionCmd(_ *Options) (*cobra.Command, error) {
+	c := &cobra.Command{
+		Use:   "completion [bash|zsh|fish]",
+		Short: "generate completion script",
+		Long: `To load completions:
 
 Bash:
 
@@ -45,21 +45,20 @@ fish:
   # To load completions for each session, execute once:
   $ containerlab completion fish > ~/.config/fish/completions/containerlab.fish
 `,
-	DisableFlagsInUseLine: true,
-	ValidArgs:             []string{"bash", "zsh", "fish"},
-	Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
-	Run: func(cmd *cobra.Command, args []string) {
-		switch args[0] {
-		case "bash":
-			_ = cmd.Root().GenBashCompletion(os.Stdout)
-		case "zsh":
-			_ = cmd.Root().GenZshCompletion(os.Stdout)
-		case "fish":
-			_ = cmd.Root().GenFishCompletion(os.Stdout, true)
-		}
-	},
-}
-
-func init() {
-	RootCmd.AddCommand(completionCmd)
+		DisableFlagsInUseLine: true,
+		ValidArgs:             []string{"bash", "zsh", "fish"},
+		Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
+		Run: func(cmd *cobra.Command, args []string) {
+			switch args[0] {
+			case "bash":
+				_ = cmd.Root().GenBashCompletion(os.Stdout)
+			case "zsh":
+				_ = cmd.Root().GenZshCompletion(os.Stdout)
+			case "fish":
+				_ = cmd.Root().GenFishCompletion(os.Stdout, true)
+			}
+		},
+	}
+
+	return c, nil
 }

cmd/completion.go

@@ -14,61 +14,131 @@ import (
 	"github.com/charmbracelet/log"
 )
 
-// Node Filter for config.
-var configFilter []string
-
-// configCmd represents the config command.
-var configCmd = &cobra.Command{
-	Use:          "config",
-	Short:        "configure a lab",
-	Long:         "configure a lab based on templates and variables from the topology definition file\nreference: https://containerlab.dev/cmd/config/",
-	Aliases:      []string{"conf"},
-	ValidArgs:    []string{"commit", "send", "compare", "template"},
-	SilenceUsage: true,
-	RunE:         configRun,
-}
+func configCmd(o *Options) (*cobra.Command, error) {
+	c := &cobra.Command{
+		Use:          "config",
+		Short:        "configure a lab",
+		Long:         "configure a lab based on templates and variables from the topology definition file\nreference: https://containerlab.dev/cmd/config/",
+		Aliases:      []string{"conf"},
+		ValidArgs:    []string{"commit", "send", "compare", "template"},
+		SilenceUsage: true,
+		RunE: func(cobraCmd *cobra.Command, args []string) error {
+			return configRun(cobraCmd, args, o)
+		},
+	}
 
-var configSendCmd = &cobra.Command{
-	Use:          "send",
-	Short:        "send raw configuration to a lab",
-	SilenceUsage: true,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		if len(args) > 0 {
-			return fmt.Errorf("unexpected arguments: %s", args)
-		}
-		return configRun(cmd, []string{"send"})
-	},
+	c.Flags().StringSliceVarP(
+		&clabcoreconfig.TemplatePaths,
+		"template-path",
+		"p",
+		[]string{},
+		"comma separated list of paths to search for templates",
+	)
+
+	c.Flags().StringSliceVarP(
+		&clabcoreconfig.TemplateNames,
+		"template-list",
+		"l",
+		[]string{},
+		"comma separated list of template names to render",
+	)
+
+	c.Flags().StringSliceVarP(
+		&o.Filter.LabelFilter,
+		"filter",
+		"f",
+		o.Filter.LabelFilter,
+		"comma separated list of nodes (by labels) to include",
+	)
+
+	c.Flags().StringSliceVarP(
+		&o.Filter.NodeFilter,
+		"node-filter",
+		"",
+		o.Filter.NodeFilter,
+		"comma separated list of nodes to include",
+	)
+
+	c.Flags().SortFlags = false
+
+	err := c.MarkFlagDirname("template-path")
+	if err != nil {
+		return nil, err
+	}
+
+	configSubCmds(c, o)
+
+	return c, nil
 }
 
-var configCompareCmd = &cobra.Command{
-	Use:          "compare",
-	Short:        "compare configuration to a running lab",
-	SilenceUsage: true,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		if len(args) > 0 {
-			return fmt.Errorf("unexpected arguments: %s", args)
-		}
-		return configRun(cmd, []string{"compare"})
-	},
+func configSubCmds(c *cobra.Command, o *Options) {
+	sendC := &cobra.Command{
+		Use:          "send",
+		Short:        "send raw configuration to a lab",
+		SilenceUsage: true,
+		RunE: func(cobraCmd *cobra.Command, args []string) error {
+			if len(args) > 0 {
+				return fmt.Errorf("unexpected arguments: %s", args)
+			}
+
+			return configRun(cobraCmd, []string{"send"}, o)
+		},
+	}
+
+	c.AddCommand(sendC)
+	sendC.Flags().AddFlagSet(c.Flags())
+
+	compareC := &cobra.Command{
+		Use:          "compare",
+		Short:        "compare configuration to a running lab",
+		SilenceUsage: true,
+		RunE: func(cobraCmd *cobra.Command, args []string) error {
+			if len(args) > 0 {
+				return fmt.Errorf("unexpected arguments: %s", args)
+			}
+
+			return configRun(cobraCmd, []string{"compare"}, o)
+		},
+	}
+
+	c.AddCommand(compareC)
+	compareC.Flags().AddFlagSet(c.Flags())
+
+	templateC := &cobra.Command{
+		Use:          "template",
+		Short:        "render a template",
+		Long:         "render a template based on variables from the topology definition file\nreference: https://containerlab.dev/cmd/config/template",
+		Aliases:      []string{"conf"},
+		SilenceUsage: true,
+		RunE: func(_ *cobra.Command, _ []string) error {
+			return configTemplate(o)
+		},
+	}
+
+	c.AddCommand(templateC)
+	templateC.Flags().AddFlagSet(c.Flags())
+	templateC.Flags().BoolVarP(&o.Config.TemplateVarOnly, "vars", "v", o.Config.TemplateVarOnly,
+		"show variable used for template rendering")
+	templateC.Flags().SortFlags = false
 }
 
-func configRun(_ *cobra.Command, args []string) error {
+func configRun(_ *cobra.Command, args []string, o *Options) error {
 	var err error
 
-	transport.DebugCount = debugCount
-	clabcoreconfig.DebugCount = debugCount
+	transport.DebugCount = o.Global.DebugCount
+	clabcoreconfig.DebugCount = o.Global.DebugCount
 
 	c, err := clabcore.NewContainerLab(
-		clabcore.WithTimeout(timeout),
-		clabcore.WithTopoPath(topoFile, varsFile),
-		clabcore.WithNodeFilter(nodeFilter),
-		clabcore.WithDebug(debug),
+		clabcore.WithTimeout(o.Global.Timeout),
+		clabcore.WithTopoPath(o.Global.TopologyFile, o.Global.VarsFile),
+		clabcore.WithNodeFilter(o.Filter.NodeFilter),
+		clabcore.WithDebug(o.Global.DebugCount > 0),
 	)
 	if err != nil {
 		return err
 	}
 
-	err = validateFilter(c.Nodes)
+	err = validateFilter(c.Nodes, o)
 	if err != nil {
 		return err
 	}
@@ -112,8 +182,8 @@ func configRun(_ *cobra.Command, args []string) error {
 			log.Warnf("%s: %s", cs.TargetNode.ShortName, err)
 		}
 	}
-	wg.Add(len(configFilter))
-	for _, node := range configFilter {
+	wg.Add(len(o.Filter.LabelFilter))
+	for _, node := range o.Filter.LabelFilter {
 		// On debug this will not be executed concurrently
 		if log.GetLevel() == (log.DebugLevel) {
 			deploy(node)
@@ -126,16 +196,56 @@ func configRun(_ *cobra.Command, args []string) error {
 	return nil
 }
 
-func validateFilter(nodes map[string]clabnodes.Node) error {
-	if len(configFilter) == 0 {
+func configTemplate(o *Options) error {
+	var err error
+
+	clabcoreconfig.DebugCount = o.Global.DebugCount
+
+	c, err := clabcore.NewContainerLab(
+		clabcore.WithTimeout(o.Global.Timeout),
+		clabcore.WithTopoPath(o.Global.TopologyFile, o.Global.VarsFile),
+		clabcore.WithDebug(o.Global.DebugCount > 0),
+	)
+	if err != nil {
+		return err
+	}
+
+	err = validateFilter(c.Nodes, o)
+	if err != nil {
+		return err
+	}
+
+	allConfig := clabcoreconfig.PrepareVars(c)
+	if o.Config.TemplateVarOnly {
+		for _, n := range o.Filter.LabelFilter {
+			conf := allConfig[n]
+			conf.Print(true, false)
+		}
+		return nil
+	}
+
+	err = clabcoreconfig.RenderAll(allConfig)
+	if err != nil {
+		return err
+	}
+
+	for _, n := range o.Filter.LabelFilter {
+		allConfig[n].Print(false, true)
+	}
+
+	return nil
+}
+
+func validateFilter(nodes map[string]clabnodes.Node, o *Options) error {
+	if len(o.Filter.LabelFilter) == 0 {
 		for n := range nodes {
-			configFilter = append(configFilter, n)
+			o.Filter.LabelFilter = append(o.Filter.LabelFilter, n)
 		}
 		return nil
 	}
 
 	var mis []string
-	for _, nn := range configFilter {
+	for _, nn := range o.Filter.LabelFilter {
 		if _, ok := nodes[nn]; !ok {
 			mis = append(mis, nn)
 		}
@@ -145,24 +255,3 @@ func validateFilter(nodes map[string]clabnodes.Node) error {
 	}
 	return nil
 }
-
-func init() {
-	RootCmd.AddCommand(configCmd)
-	configCmd.Flags().StringSliceVarP(&clabcoreconfig.TemplatePaths, "template-path", "p", []string{},
-		"comma separated list of paths to search for templates")
-	_ = configCmd.MarkFlagDirname("template-path")
-	configCmd.Flags().StringSliceVarP(&clabcoreconfig.TemplateNames, "template-list", "l", []string{},
-		"comma separated list of template names to render")
-	configCmd.Flags().StringSliceVarP(&configFilter, "filter", "f", []string{},
-		"comma separated list of nodes to include")
-	configCmd.Flags().SortFlags = false
-
-	configCmd.Flags().StringSliceVarP(&nodeFilter, "node-filter", "", []string{},
-		"comma separated list of nodes to include")
-
-	configCmd.AddCommand(configSendCmd)
-	configSendCmd.Flags().AddFlagSet(configCmd.Flags())
-
-	configCmd.AddCommand(configCompareCmd)
-	configCompareCmd.Flags().AddFlagSet(configCmd.Flags())
-}