refactor: cmd options ToOptions method, enforce lll on cmd package (#2776)

* refactor: cmd options ToOptions method, enforce lll on cmd package

* chore: enforce mnd on cmd package

* fix: resolve #2775

* fix: generate parseNodeFlags regression

* chore: enable wsl on cmd package

* chore: appease a few deepsource nits

Author: carlmontanari

.golangci.yml

@@ -12,7 +12,9 @@ linters:
     - govet
     - ineffassign
     - importas
+    - lll
     - misspell
+    - mnd
     - nakedret
     - noctx
     - nolintlint
@@ -21,6 +23,7 @@ linters:
     - unparam
     - unused
     - whitespace
+    - wsl_v5
   disable:
     # disabling for *now* so ci can pass nicely, but (some?) of these likely should be adressed
     - dupl
@@ -30,14 +33,11 @@ linters:
     - goconst
     - gocyclo
     - gosec
-    - lll
-    - mnd
     - nestif
     - perfsprint
     - prealloc
     - revive
     - wrapcheck
-    - wsl_v5
   settings:
     dupl:
       threshold: 100
@@ -95,6 +95,12 @@ linters:
       - linters:
           - staticcheck
         text: could remove embedded field
+      # currently slowly enforcing some things, starting with cmd package
+      - linters:
+          - lll
+          - mnd
+          - wsl_v5
+        path-except: cmd
 formatters:
   enable:
     - gofmt

cmd/config.go

@@ -16,9 +16,10 @@ import (
 
 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/",
+		Use:   "config",
+		Short: "configure a lab",
+		Long: "configure a lab based on templates and variables from the topology definition " +
+			"file\n reference: https://containerlab.dev/cmd/config/",
 		Aliases:      []string{"conf"},
 		ValidArgs:    []string{"commit", "send", "compare", "template"},
 		SilenceUsage: true,
@@ -105,9 +106,10 @@ func configSubCmds(c *cobra.Command, o *Options) {
 	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",
+		Use:   "template",
+		Short: "render a template",
+		Long: "render a template based on variables from the topology definition file\n" +
+			"reference: https://containerlab.dev/cmd/config/template",
 		Aliases:      []string{"conf"},
 		SilenceUsage: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
@@ -117,8 +119,13 @@ func configSubCmds(c *cobra.Command, o *Options) {
 
 	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().BoolVarP(
+		&o.Config.TemplateVarOnly,
+		"vars",
+		"v",
+		o.Config.TemplateVarOnly,
+		"show variable used for template rendering",
+	)
 	templateC.Flags().SortFlags = false
 }
 
@@ -128,12 +135,7 @@ func configRun(_ *cobra.Command, args []string, o *Options) error {
 	transport.DebugCount = o.Global.DebugCount
 	clabcoreconfig.DebugCount = o.Global.DebugCount
 
-	c, err := clabcore.NewContainerLab(
-		clabcore.WithTimeout(o.Global.Timeout),
-		clabcore.WithTopoPath(o.Global.TopologyFile, o.Global.VarsFile),
-		clabcore.WithNodeFilter(o.Filter.NodeFilter),
-		clabcore.WithDebug(o.Global.DebugCount > 0),
-	)
+	c, err := clabcore.NewContainerLab(o.ToClabOptions()...)
 	if err != nil {
 		return err
 	}
@@ -168,12 +170,14 @@ func configRun(_ *cobra.Command, args []string, o *Options) error {
 	}
 
 	var wg sync.WaitGroup
+
 	deploy := func(n string) {
 		defer wg.Done()
 
 		cs, ok := allConfig[n]
 		if !ok {
 			log.Errorf("Invalid node in filter: %s", n)
+
 			return
 		}
 
@@ -182,7 +186,9 @@ func configRun(_ *cobra.Command, args []string, o *Options) error {
 			log.Warnf("%s: %s", cs.TargetNode.ShortName, err)
 		}
 	}
+
 	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) {
@@ -191,6 +197,7 @@ func configRun(_ *cobra.Command, args []string, o *Options) error {
 			go deploy(node)
 		}
 	}
+
 	wg.Wait()
 
 	return nil
@@ -201,11 +208,7 @@ func configTemplate(o *Options) 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),
-	)
+	c, err := clabcore.NewContainerLab(o.ToClabOptions()...)
 	if err != nil {
 		return err
 	}
@@ -216,11 +219,13 @@ func configTemplate(o *Options) error {
 	}
 
 	allConfig := clabcoreconfig.PrepareVars(c)
+
 	if o.Config.TemplateVarOnly {
 		for _, n := range o.Filter.LabelFilter {
 			conf := allConfig[n]
 			conf.Print(true, false)
 		}
+
 		return nil
 	}
 
@@ -241,17 +246,21 @@ func validateFilter(nodes map[string]clabnodes.Node, o *Options) error {
 		for n := range nodes {
 			o.Filter.LabelFilter = append(o.Filter.LabelFilter, n)
 		}
+
 		return nil
 	}
 
 	var mis []string
+
 	for _, nn := range o.Filter.LabelFilter {
 		if _, ok := nodes[nn]; !ok {
 			mis = append(mis, nn)
 		}
 	}
+
 	if len(mis) > 0 {
 		return fmt.Errorf("invalid nodes in filter: %s", strings.Join(mis, ", "))
 	}
+
 	return nil
 }

cmd/context.go

@@ -11,6 +11,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const (
+	maxCancelledDestroyTimeout = 20 * time.Second
+)
+
 var onlyOneSignalHandler = make(chan struct{}) //nolint: gochecknoglobals
 
 // SignalHandledContext returns a context that will be canceled if a SIGINT or SIGTERM is
@@ -27,23 +31,35 @@ func SignalHandledContext() (context.Context, context.CancelFunc) {
 
 	go func() {
 		sig := <-sigs
-		log.Errorf("received signal %q, canceling context and cleaning deployment...", sig)
+
+		log.Errorf("received signal %q, canceling context", sig)
 
 		cancel()
 
-		destroyCtx, destroyCancel := context.WithTimeout(context.Background(), 20*time.Second)
+		defer os.Exit(1)
+
+		options := GetOptions()
+
+		if !options.Global.CleanOnCancel {
+			log.Debug("clean on cancel is not true, exiting")
+
+			return
+		}
+
+		destroyCtx, destroyCancel := context.WithTimeout(
+			context.Background(),
+			maxCancelledDestroyTimeout,
+		)
 		defer destroyCancel()
 
 		// destroyFn requires a cobra.Command but only needs the ctx from it
 		destroyCmd := &cobra.Command{}
 		destroyCmd.SetContext(destroyCtx)
 
-		err := destroyFn(destroyCmd, GetOptions())
+		err := destroyFn(destroyCmd, options)
 		if err != nil {
 			log.Errorf("failed destroying lab after cancellation signal: %v", err)
 		}
-
-		os.Exit(1) // skipcq: RVV-A0003
 	}()
 
 	return ctx, cancel