fix: Add test for argument_specs matching

Compare contents of `meta/arguments_spec.yml` against `defaults/main.yml` on each role to make sure keys match. Signed-off-by: SuperQ <[email protected]>
prometheus-community · Jul 29, 2023 · e2425db · e2425db
1 parent 603aa0c
commit e2425db
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/.github/scripts/lint_arguments_spec.sh b/.github/scripts/lint_arguments_spec.sh
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+#
+# Description: Lint the defaults/main.yml against the meta/arguments_spec.yml
+
+lint_diff() {
+  diff -u \
+    <(yq 'keys | .[]' "${role}/defaults/main.yml" | sort -u) \
+    <(yq '.argument_specs.main.options | keys | .[] ' "${role}/meta/argument_specs.yml" | sort -u)
+  return $?
+}
+
+error=0
+
+for role in roles/* ; do
+  echo "Checking ${role}"
+  if ! lint_diff ; then
+    echo "ERROR: ${role}: meta/argument_specs.yml doesn't match defaults/main.yml"
+    error=1
+  fi
+done
+
+exit "${error}"
diff --git a/.github/workflows/ansible-ci.yml b/.github/workflows/ansible-ci.yml
@@ -29,6 +29,15 @@ jobs:
       - name: Lint collection
         uses: ansible/ansible-lint-action@main
 
+  arguments-spec-lint:
+    runs-on: ubuntu-latest
+    container:
+      image: quay.io/prometheus/golang-builder:base
+    steps:
+      - uses: actions/checkout@v3
+      - name: Lint arguments spec
+        run: ./.github/scripts/lint_arguments_spec.sh
+
   discover-ansible-versions:
     runs-on: ubuntu-latest
     outputs: