Add support for json schema validation (#2035)

Author: ssbarnea

.config/dictionary.txt

@@ -76,6 +76,7 @@ isdir
 isdisjoint
 iskeyword
 isort
+jsonschema
 junitxml
 kubernetes
 libera

.github/workflows/tox.yml

@@ -155,7 +155,7 @@ jobs:
       WSLENV: FORCE_COLOR:PYTEST_REQPASS:TOXENV:TOX_PARALLEL_NO_SPINNER
       # Number of expected test passes, safety measure for accidental skip of
       # tests. Update value if you add/remove tests.
-      PYTEST_REQPASS: 625
+      PYTEST_REQPASS: 629
 
     steps:
       - name: Activate WSL1

.pre-commit-config.yaml

@@ -28,7 +28,8 @@ repos:
             examples/playbooks/templates/not-valid.yaml|
             examples/playbooks/with-umlaut-.*|
             examples/playbooks/with-skip-tag-id.yml|
-            test/fixtures/formatting-before/.*
+            test/fixtures/formatting-before/.*|
+            src/ansiblelint/schemas/.*
           )$
         additional_dependencies:
           - prettier
@@ -60,6 +61,7 @@ repos:
           (?x)^(
             examples/playbooks/(with-skip-tag-id|unicode).yml|
             examples/playbooks/example.yml|
+            test/eco/.*.result|
             test/fixtures/formatting-before/.*
           )$
       - id: mixed-line-ending
@@ -72,6 +74,10 @@ repos:
     rev: v2.1.0
     hooks:
       - id: codespell
+        exclude: >
+          (?x)^(
+            src/ansiblelint/schemas/.*\.json
+          )$
   - repo: https://github.com/PyCQA/doc8
     rev: 0.11.1
     hooks:
@@ -126,10 +132,11 @@ repos:
           - rich>=11.0.0
           - ruamel.yaml
           - sphinx>=4.4.0
-          - types-pyyaml>=6.0.4
           - types-dataclasses
           - types-docutils
+          - types-jsonschema>=4.4.2
           - types-pkg_resources
+          - types-pyyaml>=6.0.4
           - wcmatch
           - yamllint
         exclude: >
@@ -147,6 +154,7 @@ repos:
           - docutils
           - enrich
           - flaky
+          - jsonschema>=4.5.1
           - pytest
           - pyyaml
           - rich>=11.0.0

conftest.py

@@ -2,6 +2,9 @@
 import importlib
 import os
 import sys
+from typing import Any
+
+from ansiblelint.schemas import refresh_schemas
 
 # checking if user is running pytest without installing test dependencies:
 missing = []
@@ -18,3 +21,10 @@
 
 os.environ["NO_COLOR"] = "1"
 pytest_plugins = ["ansiblelint.testing.fixtures"]
+
+
+def pytest_configure(config: Any) -> None:
+    """Configure pytest."""
+    # run only on master node (xdist):
+    if not hasattr(config, "slaveinput"):
+        refresh_schemas()

cspell.config.yaml

@@ -17,6 +17,7 @@ ignorePaths:
   - docs/requirements.in
   # Test fixtures generated from outside
   - test/**/*.result
+  - src/ansiblelint/schemas/*.json
   # Other
   - "*.svg"
 allowCompoundWords: true

examples/galaxy.yml

@@ -11,5 +11,5 @@ dependencies:
   other_namespace.collection2: ">=2.0.0,<3.0.0"
   anderson55.my_collection: "*" # note: "*" selects the highest version available
 license:
-  - GPL
+  - GPL # <-- invalid license values based on galaxy schema
   - Apache

examples/playbooks/command-check-failure.yml

@@ -10,3 +10,4 @@
       ansible.builtin.shell: echo blah
       args:
         chdir: X
+      become_method: xx

examples/playbooks/json-schema-fail.yml

@@ -0,0 +1,4 @@
+---
+- name: This should raise json-schema error, due to hosts missing the last letter
+  host: localhost
+  tasks: []

examples/playbooks/schema-error-string.yml

@@ -0,0 +1,4 @@
+---
+foo
+# This file is valid YAML but from our point of view is an error, as is
+# neither a Sequence or a Mapping.

examples/playbooks/syntax-error-string.yml

@@ -1,3 +1,7 @@
-foo
-# This file is valid YAML but from our point of view is an error, as is
-# neither a Sequence or a Mapping.
+# This file is valid YAML and passed JSON Schema validation but not ansible
+# own syntax check.
+
+- hosts: localhost
+  tasks:
+    - name: invalid syntax
+      x.y.z.w: {}