Detect role argument_specs files as a lintable kind (#2091)

Beginning with ansible version 2.11 role argument validation based on an argument specification was introduced. This specification is defined in the meta/argument_specs.yml file of a role. This change enables the linter to detect this new format and for it to be used in future rules. Fixes: #1688 Relates: #1966 Signed-off-by: Daniel Ziegenberg <[email protected]>
ansible · May 3, 2022 · 6ffd7a8 · 6ffd7a8
1 parent bce29ae
commit 6ffd7a8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/ansiblelint/config.py b/src/ansiblelint/config.py
@@ -22,6 +22,7 @@
     {"handlers": "**/handlers/*.{yaml,yml}"},
     {"vars": "**/{host_vars,group_vars,vars,defaults}/**/*.{yaml,yml}"},
     {"meta": "**/meta/main.{yaml,yml}"},
+    {"arg_specs": "**/roles/**/meta/argument_specs.{yaml,yml}"},  # role argument specs
     {"yaml": ".config/molecule/config.{yaml,yml}"},  # molecule global config
     {
         "requirements": "**/molecule/*/{collections,requirements}.{yaml,yml}"

diff --git a/test/test_file_utils.py b/test/test_file_utils.py
@@ -165,6 +165,7 @@ def test_discover_lintables_umlaut(monkeypatch: MonkeyPatch) -> None:
             "roles/foo/molecule/scenario3/collections.yml",
             "requirements",
         ),  # requirements
+        ("roles/foo/meta/argument_specs.yml", "arg_specs"),  # role argument specs
         # tasks files:
         ("tasks/directory with spaces/main.yml", "tasks"),  # tasks
         ("tasks/requirements.yml", "tasks"),  # tasks