Add support for YAML linting

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

Author: tstromberg

.github/workflows/ci.yml

@@ -2,33 +2,33 @@ name: Go
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
 
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-    - name: Set up Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: 1.17
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
 
-    - name: Build
-      run: go build -v ./...
+      - name: Build
+        run: go build -v ./...
 
-    - name: Test
-      run: go test -v ./...
+      - name: Test
+        run: go test -v ./...
 
-    - name: Run
-      run: cp Makefile Makefile.old && go run . .
+      - name: Run
+        run: cp Makefile Makefile.old && go run . .
 
-    - name: Lint
-      run: make lint
+      - name: Lint
+        run: make lint
 
-    - name: Makefile diff
-      run: diff -ubB Makefile.old Makefile
+      - name: Makefile diff
+        run: diff -ubB Makefile.old Makefile

.gitignore

@@ -10,6 +10,7 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+out/
 
 # Dependency directories (remove the comment below to include it)
 # vendor/

.golangci.yml

@@ -98,7 +98,7 @@ linters:
     - durationcheck
     - errcheck
     # errname is only available in golangci-lint v1.42.0+ - wait until v1.43 is available to settle
-    #- errname
+    # - errname
     - errorlint
     - exhaustive
     - exportloopref
@@ -125,7 +125,7 @@ linters:
     - nolintlint
     - predeclared
     # disabling for the initial iteration of the linting tool
-    #- promlinter
+    # - promlinter
     - revive
     - rowserrcheck
     - sqlclosecheck
@@ -142,25 +142,25 @@ 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
+    # - gofumpt
+    # - gosec
+    # - tagliatelle
 
 issues:
   # Excluding configuration per-path, per-linter, per-text and per-source

.yamllint

@@ -0,0 +1,16 @@
+---
+extends: default
+
+rules:
+  braces:
+    max-spaces-inside: 1
+  brackets:
+    max-spaces-inside: 1
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  line-length:
+    level: warning
+    max: 160
+    allow-non-breakable-inline-mappings: true
+  truthy: disable

Makefile

@@ -5,6 +5,7 @@
 GOLINT_VERSION ?= v1.42.0
 HADOLINT_VERSION ?= v2.7.0
 SHELLCHECK_VERSION ?= v0.7.2
+YAMLLINT_VERSION ?= 1.26.3
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
 
@@ -15,13 +16,15 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 endif
 
-LINT_LOWER_OS  = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
-GOLINT_CONFIG:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))/.golangci.yml
+LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
+GOLINT_CONFIG = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))/.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)
+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/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh")
+	PYTHONPATH=$(YAMLLINT_ROOT)/lib $(YAMLLINT_ROOT)/bin/yamllint .
 
 out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck:
 	mkdir -p out/linters
@@ -38,4 +41,8 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b out/linters $(GOLINT_VERSION)
 	mv out/linters/golangci-lint 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
 # END: lint-install .

Makefile.tmpl

@@ -5,6 +5,7 @@
 {{ if .Go }}GOLINT_VERSION ?= v1.42.0{{ end }}
 {{ if .Dockerfile}}HADOLINT_VERSION ?= v2.7.0{{ end }}
 {{ if .Shell}}SHELLCHECK_VERSION ?= v0.7.2{{ end }}
+{{ if .YAML}}YAMLLINT_VERSION ?= 1.26.3{{ end }}
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
 
@@ -15,10 +16,11 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 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 .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 .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 }}
+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 }}
 	{{ .}}{{ end}}
 
@@ -43,4 +45,12 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 	mv out/linters/golangci-lint out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
 
 {{ end -}}
+
+{{ if .YAML -}}
+$(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
+{{ end -}}
+
 # END: lint-install {{.Args}}

lint-install.go

@@ -21,6 +21,7 @@ var (
 	goFlag         = flag.String("go", "error", "Level to lint Go with: [ignore, warn, error]")
 	shellFlag      = flag.String("shell", "error", "Level to lint Shell with: [ignore, warn, error]")
 	dockerfileFlag = flag.String("dockerfile", "error", "Level to lint Dockerfile with: [ignore, warn, error]")
+	yamlFlag       = flag.String("yaml", "error", "Level to lint YAML with: [ignore, warn, error]")
 	makeFileName   = flag.String("makefile", "Makefile", "name of Makefile to update")
 
 	//go:embed .golangci.yml
@@ -36,6 +37,7 @@ const (
 	Go Language = iota
 	Shell
 	Dockerfile
+	YAML
 )
 
 type Config struct {
@@ -44,6 +46,7 @@ type Config struct {
 	Go         string
 	Dockerfile string
 	Shell      string
+	YAML       string
 	Commands   []string
 }
 
@@ -54,15 +57,17 @@ func applicableLinters(root string) (map[Language]bool, error) {
 
 	err := godirwalk.Walk(root, &godirwalk.Options{
 		Callback: func(path string, de *godirwalk.Dirent) error {
-			if strings.HasSuffix(path, ".go") {
+			switch {
+			case strings.HasSuffix(path, ".go"):
 				found[Go] = true
-			}
-			if strings.HasSuffix(path, "Dockerfile") {
+			case strings.HasSuffix(path, "Dockerfile"):
 				found[Dockerfile] = true
-			}
-			if strings.HasSuffix(path, ".sh") {
+			case strings.HasSuffix(path, ".sh"):
 				found[Shell] = true
+			case strings.HasSuffix(path, ".yml"), strings.HasSuffix(path, ".yaml"):
+				found[YAML] = true
 			}
+
 			return nil
 		},
 		Unsorted: true,
@@ -211,6 +216,15 @@ func dockerLintCmd(_ string, level string) string {
 	return fmt.Sprintf(`out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) -t %s $(shell find . -name "*Dockerfile")`, threshold)
 }
 
+// yamlLintCmd returns the appropriate yamllint command for a project.
+func yamlLintCmd(_ string, level string) string {
+	suffix := ""
+	if level == "warn" {
+		suffix = " || true"
+	}
+	return fmt.Sprintf(`PYTHONPATH=$(YAMLLINT_ROOT)/lib $(YAMLLINT_ROOT)/bin/yamllint .%s`, suffix)
+}
+
 // main creates peanut butter & jelly sandwiches with utmost precision.
 func main() {
 	klog.InitFlags(nil)
@@ -258,6 +272,10 @@ func main() {
 			cfg.Shell = *shellFlag
 			cfg.Commands = append(cfg.Commands, shellLintCmd(root, cfg.Shell))
 		}
+		if needs[YAML] {
+			cfg.YAML = *yamlFlag
+			cfg.Commands = append(cfg.Commands, yamlLintCmd(root, cfg.Shell))
+		}
 
 		diff, err := updateMakefile(root, cfg, *dryRunFlag)
 		if err != nil {