Merge pull request #2795 from srl-labs/chore/more-linters-and-housekeeping

Chore/more linters and housekeeping

Author: hellt

.golangci.yml

@@ -72,6 +72,8 @@ linters:
           alias: clab$1
         - pkg: github.com/srl-labs/containerlab/(\w+)/(\w+)
           alias: clab$1$2
+        - pkg: github.com/srl-labs/containerlab/(\w+)/(\w+)/(\w+)
+          alias: clab$1$2$3
       no-unaliased: true
     lll:
       line-length: 100
@@ -95,12 +97,27 @@ linters:
       - linters:
           - staticcheck
         text: could remove embedded field
-      # currently slowly enforcing some things, starting with cmd package
+      # ssh bits have a lot of mnd that is pretty clear what it is for/doing, so just ignore
       - linters:
-          - lll
           - mnd
-          - wsl_v5
-        path-except: cmd
+        path: core/config/transport/
+    # slowly enforcing things, excluding these packages (for now!)
+    paths:
+      - cert
+      - errors
+      - exec
+      - git
+      - internal
+      - labels
+      - links
+      - mocks
+      - netconf
+      - nodes
+      - runtime
+      - schemas
+      - types
+      - utils
+      - virt
 formatters:
   enable:
     - gofmt

cert/local_dir_cert_storage.go

@@ -36,15 +36,17 @@ func (c *LocalDirCertStorage) LoadNodeCert(nodeName string) (*Certificate, error
 func (c *LocalDirCertStorage) StoreCaCert(cert *Certificate) error {
 	// CA cert/key/csr can only be stored in the labdir/.tls/ca dir,
 	// so we need to create it if it does not exist.
-	clabutils.CreateDirectory(filepath.Dir(c.paths.CaCertAbsFilename()), 0o777)
+	clabutils.CreateDirectory(filepath.Dir(c.paths.CaCertAbsFilename()),
+		clabutils.PermissionsOpen)
 
 	return cert.Write(c.paths.CaCertAbsFilename(), c.paths.CaKeyAbsFilename(), c.paths.CaCSRAbsFilename())
 }
 
 // StoreNodeCert stores the given certificate in a file in the baseFolder.
 func (c *LocalDirCertStorage) StoreNodeCert(nodeName string, cert *Certificate) error {
 	// create a folder for the node if it does not exist
-	clabutils.CreateDirectory(c.paths.NodeTLSDir(nodeName), 0o777)
+	clabutils.CreateDirectory(c.paths.NodeTLSDir(nodeName),
+		clabutils.PermissionsOpen)
 
 	// write cert files
 	return cert.Write(c.paths.NodeCertAbsFilename(nodeName),

cmd/config.go

@@ -8,7 +8,6 @@ import (
 	"github.com/spf13/cobra"
 	clabcore "github.com/srl-labs/containerlab/core"
 	clabcoreconfig "github.com/srl-labs/containerlab/core/config"
-	"github.com/srl-labs/containerlab/core/config/transport"
 	clabnodes "github.com/srl-labs/containerlab/nodes"
 
 	"github.com/charmbracelet/log"
@@ -132,7 +131,6 @@ func configSubCmds(c *cobra.Command, o *Options) {
 func configRun(_ *cobra.Command, args []string, o *Options) error {
 	var err error
 
-	transport.DebugCount = o.Global.DebugCount
 	clabcoreconfig.DebugCount = o.Global.DebugCount
 
 	c, err := clabcore.NewContainerLab(o.ToClabOptions()...)
@@ -181,7 +179,7 @@ func configRun(_ *cobra.Command, args []string, o *Options) error {
 			return
 		}
 
-		err = clabcoreconfig.Send(cs, action)
+		err = clabcoreconfig.Send(cs, action, o.Global.DebugCount > 0)
 		if err != nil {
 			log.Warnf("%s: %s", cs.TargetNode.ShortName, err)
 		}

cmd/tools_cert.go

@@ -229,7 +229,7 @@ func createCA(o *Options) error {
 
 	clabutils.CreateDirectory(
 		o.ToolsCert.Path,
-		clabutils.PermissionsEveryoneAllPermissions,
+		clabutils.PermissionsOpen,
 	) // skipcq: GSC-G302
 
 	err = caCert.Write(
@@ -306,7 +306,7 @@ func signCert(o *Options) error {
 
 	clabutils.CreateDirectory(
 		o.ToolsCert.Path,
-		clabutils.PermissionsEveryoneAllPermissions,
+		clabutils.PermissionsOpen,
 	) // skipcq: GSC-G302
 
 	err = nodeCert.Write(

core/authz_keys.go

@@ -41,13 +41,17 @@ func (c *CLab) createAuthzKeysFile() error {
 	}
 
 	// ensure authz_keys will have the permissions allowing it to be read by anyone
-	return os.Chmod(clabAuthzKeysFPath, 0o644) // skipcq: GSC-G302
+	return os.Chmod(
+		clabAuthzKeysFPath,
+		clabutils.PermissiosnFileDefault,
+	) // skipcq: GSC-G302
 }
 
 // RetrieveSSHPubKeysFromFiles retrieves public keys from the ~/.ssh/*.authorized_keys
 // and ~/.ssh/*.pub files.
 func RetrieveSSHPubKeysFromFiles() ([]ssh.PublicKey, error) {
 	var keys []ssh.PublicKey
+
 	p := clabutils.ResolvePath(pubKeysGlob, "")
 
 	all, err := filepath.Glob(p)
@@ -115,12 +119,14 @@ func RetrieveSSHAgentKeys() ([]ssh.PublicKey, error) {
 		log.Debug("SSH_AUTH_SOCK not set, skipping pubkey fetching")
 		return nil, nil
 	}
+
 	conn, err := net.Dial("unix", socket)
 	if err != nil {
 		return nil, fmt.Errorf("failed to open SSH_AUTH_SOCK: %w", err)
 	}
 
 	agentClient := agent.NewClient(conn)
+
 	keys, err := agentClient.List()
 	if err != nil {
 		return nil, fmt.Errorf("error listing agent's pub keys %w", err)
@@ -135,6 +141,7 @@ func RetrieveSSHAgentKeys() ([]ssh.PublicKey, error) {
 		if err != nil {
 			return nil, err
 		}
+
 		pubKeys = append(pubKeys, pkey)
 	}