Address merge conflicts

Signed-off-by: Thomas Stromberg <[email protected]>

Author: tstromberg

.golangci.yml

@@ -18,6 +18,12 @@ linters-settings:
     min-occurrences: 5
     ignore-tests: true
 
+  gosec:
+    excludes:
+      - G107 # Potential HTTP request made with variable url
+      - G204 # Subprocess launched with function call as argument or cmd arguments
+      - G404 # Use of weak random number generator (math/rand instead of crypto/rand
+
   errorlint:
     # these are still common in Go: for instance, exit errors.
     asserts: false
@@ -108,6 +114,8 @@ linters:
     - gocritic
     - godot
     - gofmt
+    - gofumpt
+    - gosec
     - goheader
     - goimports
     - goprintffuncname
@@ -142,45 +150,45 @@ linters:
     - wastedassign
     - whitespace
 
-    # Disabled linters, due to being misaligned with Go practices
-    # - exhaustivestruct
-    # - gochecknoglobals
-    # - gochecknoinits
-    # - goconst
-    # - godox
-    # - goerr113
-    # - gomnd
-    # - lll
-    # - nlreturn
-    # - testpackage
-    # - wsl
-    # Disabled linters, due to not being relevant to our code base:
-    # - maligned
-    # - prealloc "For most programs usage of prealloc will be a premature optimization."
-    # Disabled linters due to bad error messages or bugs
-    # - gofumpt
-    # - gosec
-    # - tagliatelle
+  # Disabled linters, due to being misaligned with Go practices
+  # - exhaustivestruct
+  # - gochecknoglobals
+  # - gochecknoinits
+  # - goconst
+  # - godox
+  # - goerr113
+  # - gomnd
+  # - lll
+  # - nlreturn
+  # - testpackage
+  # - wsl
+  # Disabled linters, due to not being relevant to our code base:
+  # - maligned
+  # - prealloc "For most programs usage of prealloc will be a premature optimization."
+  # Disabled linters due to bad error messages or bugs
+  # - tagliatelle
 
 issues:
   # Excluding configuration per-path, per-linter, per-text and per-source
   exclude-rules:
     - path: _test\.go
       linters:
-        - gocyclo
-        - errcheck
         - dupl
+        - errcheck
+        - forcetypeassert
+        - gocyclo
         - gosec
+        - noctx
 
-    - path: cmd.*
+    - path: .*cmd.*
       linters:
         - noctx
 
     - path: main\.go
       linters:
         - noctx
 
-    - path: cmd.*
+    - path: .*cmd.*
       text: "deep-exit"
 
     - path: main\.go

CONTRIBUTING.md

@@ -9,7 +9,7 @@ We're so glad you're here.
 
 ### Code of Conduct
 
-Please read and understand the code of conduct found [here](https://github.com/tinkerbell/.github/blob/master/CODE_OF_CONDUCT.md).
+Please read and understand the code of conduct found [here](https://github.com/tinkerbell/.github/blob/main/CODE_OF_CONDUCT.md).
 
 ### DCO Sign Off
 

Makefile

@@ -8,6 +8,7 @@ SHELLCHECK_VERSION ?= v0.7.2
 YAMLLINT_VERSION ?= 1.26.3
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
+LINT_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 # shellcheck and hadolint lack arm64 native binaries: rely on x86-64 emulation
 ifeq ($(LINT_OS),Darwin)
@@ -17,15 +18,19 @@ ifeq ($(LINT_OS),Darwin)
 endif
 
 LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
-GOLINT_CONFIG = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))/.golangci.yml
+GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml
 YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION)
 
 lint: out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) $(YAMLLINT_ROOT)/bin/yamllint
 	out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) run
-	out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) -t info $(shell find . -name "*Dockerfile")
+	out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) $(shell find . -name "*Dockerfile")
 	out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh")
 	PYTHONPATH=$(YAMLLINT_ROOT)/lib $(YAMLLINT_ROOT)/bin/yamllint .
 
+fix: out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
+	out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) run --fix
+	out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh") -f diff | git apply -p2 -
+
 out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck:
 	mkdir -p out/linters
 	curl -sSfL https://github.com/koalaman/shellcheck/releases/download/$(SHELLCHECK_VERSION)/shellcheck-$(SHELLCHECK_VERSION).$(LINT_LOWER_OS).$(LINT_ARCH).tar.xz | tar -C out/linters -xJf -
@@ -44,5 +49,5 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 $(YAMLLINT_ROOT)/bin/yamllint:
 	mkdir -p $(YAMLLINT_ROOT)/lib
 	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
-	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py install --prefix . --install-lib lib
+	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py -q install --prefix . --install-lib lib
 # END: lint-install .

Makefile.tmpl

@@ -8,6 +8,7 @@
 {{ if .YAML}}YAMLLINT_VERSION ?= 1.26.3{{ end }}
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
+LINT_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 # shellcheck and hadolint lack arm64 native binaries: rely on x86-64 emulation
 ifeq ($(LINT_OS),Darwin)
@@ -17,11 +18,15 @@ ifeq ($(LINT_OS),Darwin)
 endif
 
 {{ if .Shell }}LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]'){{ end }}
-{{ if .Go }}GOLINT_CONFIG = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))/.golangci.yml{{ end }}
+{{ if .Go }}GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml{{ end }}
 {{ if .YAML }}YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION){{ end }}
 
 lint: {{ if .Shell }}out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck {{ end }}{{ if .Dockerfile }}out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) {{ end }}{{ if .Go}}out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) {{ end }}{{ if .YAML}}$(YAMLLINT_ROOT)/bin/yamllint{{ end }}
-	{{- range .Commands }}
+	{{- range .LintCommands }}
+	{{ .}}{{ end}}
+
+fix: {{ if .Shell }}out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck {{ end }}{{ if .Go}}out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH){{ end }}
+	{{- range .FixCommands }}
 	{{ .}}{{ end}}
 
 {{ if .Shell -}}
@@ -50,7 +55,7 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 $(YAMLLINT_ROOT)/bin/yamllint:
 	mkdir -p $(YAMLLINT_ROOT)/lib
 	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
-	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py install --prefix . --install-lib lib
+	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py -q install --prefix . --install-lib lib
 {{ end -}}
 
 # END: lint-install {{.Args}}

lint-install.go

@@ -41,13 +41,14 @@ const (
 )
 
 type Config struct {
-	Makefile   string
-	Args       string
-	Go         string
-	Dockerfile string
-	Shell      string
-	YAML       string
-	Commands   []string
+	Makefile     string
+	Args         string
+	Go           string
+	Dockerfile   string
+	Shell        string
+	YAML         string
+	LintCommands []string
+	FixCommands  []string
 }
 
 // applicableLinters returns a list of languages with known linters within a given directory.
@@ -126,14 +127,17 @@ func updateMakefile(root string, cfg Config, dryRun bool) (string, error) {
 		proposed = append(proposed, newRules.Bytes()...)
 	}
 
-	// trim any accidental trailing newlines
+	// Trim extraneous newlines
+	if len(existing) == 0 {
+		proposed = bytes.TrimLeft(proposed, "\n")
+	}
 	proposed = bytes.TrimRight(proposed, "\n")
 	proposed = append(proposed, byte('\n'))
 
 	edits := myers.ComputeEdits("Makefile", string(existing), string(proposed))
 	change := gotextdiff.ToUnified(filepath.Base(dest), filepath.Base(dest), string(existing), edits)
 	if !dryRun {
-		if err := os.WriteFile(dest, proposed, 0755); err != nil {
+		if err := os.WriteFile(dest, proposed, 0o600); err != nil {
 			return "", err
 		}
 	}
@@ -159,7 +163,7 @@ func updateGoLint(root string, dryRun bool) (string, error) {
 	change := gotextdiff.ToUnified(filepath.Base(dest), filepath.Base(dest), string(existing), edits)
 
 	if !dryRun {
-		if err := os.WriteFile(dest, goLintConfig, 0755); err != nil {
+		if err := os.WriteFile(dest, goLintConfig, 0o600); err != nil {
 			return "", err
 		}
 	}
@@ -168,7 +172,7 @@ func updateGoLint(root string, dryRun bool) (string, error) {
 }
 
 // goLintCmd returns the appropriate golangci-lint command to run for a project.
-func goLintCmd(root string, level string) string {
+func goLintCmd(root string, level string, fix bool) string {
 	klog.Infof("Searching for go modules within %s ...", root)
 	found := []string{}
 
@@ -181,39 +185,47 @@ func goLintCmd(root string, level string) string {
 		},
 		Unsorted: true,
 	})
-
 	if err != nil {
 		klog.Errorf("unable to find go.mod files: %v", err)
 	}
 
 	suffix := ""
-	if level == "warn" {
+	if fix {
+		suffix = " --fix"
+	} else if level == "warn" {
 		suffix = " || true"
 	}
 
-	if len(found) == 1 && found[0] == root {
+	klog.Infof("found %d modules within %s: %s", len(found), root, found)
+	if len(found) == 0 || (len(found) == 1 && found[0] == strings.Trim(root, "/")) {
 		return fmt.Sprintf("out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) run%s", suffix)
 	}
 
-	return fmt.Sprintf(`find . -name go.mod | xargs -n1 dirname | xargs -n1 -I{} sh -c "cd {} && golangci-lint run -c $(GOLINT_CONFIG)"%s`, suffix)
+	return fmt.Sprintf(`find . -name go.mod -execdir "$(LINT_ROOT)/out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)" run -c "$(GOLINT_CONFIG)"%s \;`, suffix)
 }
 
 // shellLintCmd returns the appropriate shell lint command for a project.
-func shellLintCmd(_ string, level string) string {
+func shellLintCmd(_ string, level string, fix bool) string {
 	suffix := ""
-	if level == "warn" {
+
+	if fix {
+		// patch(1) doesn't support patching from stdin on all platforms, so we use git apply instead
+		suffix = " -f diff | git apply -p2 -"
+	} else if level == "warn" {
 		suffix = " || true"
 	}
+
 	return fmt.Sprintf(`out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh")%s`, suffix)
 }
 
 // dockerLintCmd returns the appropriate docker lint command for a project.
 func dockerLintCmd(_ string, level string) string {
-	threshold := "info"
+	f := ""
 	if level == "warn" {
-		threshold = "none"
+		f = " --no-fail"
 	}
-	return fmt.Sprintf(`out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) -t %s $(shell find . -name "*Dockerfile")`, threshold)
+
+	return fmt.Sprintf(`out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH)%s $(shell find . -name "*Dockerfile")`, f)
 }
 
 // yamlLintCmd returns the appropriate yamllint command for a project.
@@ -262,19 +274,21 @@ func main() {
 
 		if needs[Go] {
 			cfg.Go = *goFlag
-			cfg.Commands = append(cfg.Commands, goLintCmd(root, cfg.Go))
+			cfg.LintCommands = append(cfg.LintCommands, goLintCmd(root, cfg.Go, false))
+			cfg.FixCommands = append(cfg.FixCommands, goLintCmd(root, cfg.Go, true))
 		}
 		if needs[Dockerfile] {
 			cfg.Dockerfile = *dockerfileFlag
-			cfg.Commands = append(cfg.Commands, dockerLintCmd(root, cfg.Dockerfile))
+			cfg.LintCommands = append(cfg.LintCommands, dockerLintCmd(root, cfg.Dockerfile))
 		}
 		if needs[Shell] {
 			cfg.Shell = *shellFlag
-			cfg.Commands = append(cfg.Commands, shellLintCmd(root, cfg.Shell))
+			cfg.LintCommands = append(cfg.LintCommands, shellLintCmd(root, cfg.Shell, false))
+			cfg.FixCommands = append(cfg.FixCommands, shellLintCmd(root, cfg.Shell, true))
 		}
 		if needs[YAML] {
 			cfg.YAML = *yamlFlag
-			cfg.Commands = append(cfg.Commands, yamlLintCmd(root, cfg.Shell))
+			cfg.LintCommands = append(cfg.LintCommands, yamlLintCmd(root, cfg.Shell))
 		}
 
 		diff, err := updateMakefile(root, cfg, *dryRunFlag)