Merge pull request #161 from SUSE/viccuad/add-yaml-linting

Add yaml linting

Author: Thulio Ferraz Assis

.gitlab-ci.yml

@@ -17,6 +17,7 @@ lint:
   only: *common_refs
   script:
   - ./dev/linters/shellcheck.sh
+  - ./dev/linters/yamllint.sh
 
 build:chart:
   stage: build

WORKSPACE

@@ -13,6 +13,27 @@ external_binary(
     windows = project.shellcheck.platforms.windows,
 )
 
+load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
+
+git_repository(
+    name = "rules_python",
+    remote = "https://github.com/bazelbuild/rules_python.git",
+    commit = project.rules_python.commit,
+)
+
+load("@rules_python//python:pip.bzl", "pip_repositories", "pip3_import")
+
+pip_repositories()
+
+pip3_import(
+    name = "yamllint",
+    requirements = "//dev/linters:requirements.txt",
+)
+
+load("@yamllint//:requirements.bzl", "pip_install")
+
+pip_install()
+
 http_archive(
     name = "cf_deployment",
     build_file_content = """

def.bzl

@@ -112,6 +112,9 @@ project = struct(
             },
         ),
     ),
+    rules_python = struct(
+        commit = "94677401bc56ed5d756f50b441a6a5c7f735a6d4"
+    ),
     mysql_chart = struct(
         version = "1.3.3",
         sha256 = "9ef4ce3693eb2a7428598f9dae833ee546eac9c105b4005c6d7375c55e33bdff",

dev/linters/BUILD.bazel

@@ -0,0 +1,11 @@
+load("@yamllint//:requirements.bzl","all_requirements")
+
+load("@rules_python//python:defs.bzl", "py_binary")
+
+py_binary(
+    name = "yamllint",
+    srcs = ["//dev/linters:run_yamllint.py"],
+    main = "run_yamllint.py",
+    python_version = "PY3",
+    deps = all_requirements,
+)

dev/linters/requirements.txt

@@ -0,0 +1 @@
+yamllint

dev/linters/run_yamllint.py

@@ -0,0 +1,9 @@
+import os
+from yamllint import cli
+
+bazel_working_dir = os.environ['BUILD_WORKING_DIRECTORY']
+
+if bazel_working_dir:
+    os.chdir(bazel_working_dir)
+
+cli.run()

dev/linters/yamllint.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+set -o errexit
+
+# shellcheck disable=SC2046
+# We want word splitting with find.
+bazel run //dev/linters:yamllint -- \
+      -d "{extends: relaxed, rules: {line-length: {max: 120}}}" \
+      --strict $(find . -type f \
+                      -path "./deploy/helm/kubecf/values.*" \
+                      -or -not -path "./deploy/helm/kubecf/*" \
+                      -name '*.yaml' -or -name '*.yml')

doc/Contribute.md

@@ -97,18 +97,20 @@ associated documentation, if we have any.
 
 ## Linting
 
-Currently only one linter is available:
+Currently, 2 linters are available:
 
   - `dev/linters/shellcheck.sh`
+  - `dev/linters/yamllint.sh`
 
-Invoke this linter as
+Invoke these linters as
 
 ```sh
 dev/linters/shellcheck.sh
+dev/linters/yamllint.sh
 ```
 
-to run shellcheck on all `.sh` files found in the entire checkout and
-report any issues found.
+to run shellcheck on all `.sh` files found in the entire checkout, or yamllint
+on all `.yaml` or `.yml` files respectively, and report any issues found.
 
 ## Patching
 

doc/linters.md

@@ -9,3 +9,8 @@ The following linters are available:
 
     Runs shellcheck on all `.sh` files found in the entire checkout
     and reports any issues found.
+
+  - `yamllint.sh`:
+
+    Runs yamllint on all `.{yaml,yml}` files found in the entire checkout
+    and reports any issues found.