Add schema check for validating pattern specification file (#4653)

Co-authored-by: Sorin Sbarnea <[email protected]>

Author: shatakshiiii

examples/patterns/correct_pattern/meta/pattern.json

@@ -0,0 +1,44 @@
+{
+  "schema_version": "1.0",
+  "name": "weather_forecasting",
+  "title": "Weather Forecasting",
+  "description": "This pattern is designed to help get the weather forecast for a given airport code. It creates a project, EE, and job templates in automation controller to get the weather forecast.",
+  "short_description": "This pattern is designed to help get the weather forecast for a given airport code.",
+  "tags": ["weather", "forecasting"],
+  "aap_resources": {
+    "controller_project": {
+      "name": "Weather Forecasting",
+      "description": "Project for the Weather Forecasting pattern"
+    },
+    "controller_execution_environment": {
+      "name": "Weather Forecasting",
+      "description": "EE for the Weather Forecasting pattern",
+      "image_name": "weather-demo-ee",
+      "pull": "missing"
+    },
+    "controller_labels": ["weather", "forecasting"],
+    "controller_job_templates": [
+      {
+        "name": "Get Weather Forecast",
+        "description": "This job template gets the weather at the location of a provided airport code.",
+        "execution_environment": "Weather Forecasting",
+        "playbook": "site.yml",
+        "primary": true,
+        "labels": ["weather", "forecasting"],
+        "survey": {
+          "name": "Weather Forecasting",
+          "description": "Survey to configure the weather forecasting pattern",
+          "spec": [
+            {
+              "type": "text",
+              "question_name": "Location",
+              "question_description": "Enter the airport code for which you want to get the weather forecast",
+              "variable": "location",
+              "required": true
+            }
+          ]
+        }
+      }
+    ]
+  }
+}

examples/patterns/incorrect_pattern/meta/pattern.json

@@ -0,0 +1,43 @@
+{
+  "schema_version": "1.0",
+  "title": "Weather Forecasting",
+  "description": "This pattern is designed to help get the weather forecast for a given airport code. It creates a project, EE, and job templates in automation controller to get the weather forecast.",
+  "short_description": "This pattern is designed to help get the weather forecast for a given airport code.",
+  "tags": ["weather", "forecasting"],
+  "aap_resources": {
+    "controller_project": {
+      "name": "Weather Forecasting",
+      "description": "Project for the Weather Forecasting pattern"
+    },
+    "controller_execution_environment": {
+      "name": "Weather Forecasting",
+      "description": "EE for the Weather Forecasting pattern",
+      "image_name": "weather-demo-ee",
+      "pull": "missing"
+    },
+    "controller_labels": ["weather", "forecasting"],
+    "controller_job_templates": [
+      {
+        "name": "Get Weather Forecast",
+        "description": "This job template gets the weather at the location of a provided airport code.",
+        "execution_environment": "Weather Forecasting",
+        "playbook": "site.yml",
+        "primary": true,
+        "labels": ["weather", "forecasting"],
+        "survey": {
+          "name": "Weather Forecasting",
+          "description": "Survey to configure the weather forecasting pattern",
+          "spec": [
+            {
+              "type": "text",
+              "question_name": "Location",
+              "question_description": "Enter the airport code for which you want to get the weather forecast",
+              "variable": "location",
+              "required": true
+            }
+          ]
+        }
+      }
+    ]
+  }
+}

src/ansiblelint/config.py

@@ -53,6 +53,7 @@
     {"vars": "**/{host_vars,group_vars,vars,defaults}/**/*.{yaml,yml}"},
     {"tasks": "**/tasks/**/*.{yaml,yml}"},
     {"rulebook": "**/rulebooks/*.{yml,yaml"},
+    {"pattern": "**/patterns/*/meta/pattern.json"},
     {"playbook": "**/playbooks/*.{yml,yaml}"},
     {"playbook": "**/*playbook*.{yml,yaml}"},
     {"role": "**/roles/*/"},

src/ansiblelint/rules/schema.md

@@ -40,6 +40,7 @@ project:
   or
   [role/metadata.py](https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role/metadata.py#L79))
   for details.
+- `schema[pattern]` validates Ansible patterns.
 - `schema[playbook]` validates Ansible playbooks.
 - `schema[requirements]` validates Ansible
   [requirements](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#install-multiple-collections-with-a-requirements-file)

src/ansiblelint/rules/schema.py

@@ -62,7 +62,7 @@ class ValidateSchemaRule(AnsibleLintRule):
     id = "schema"
     severity = "VERY_HIGH"
     tags = ["core"]
-    version_changed = "6.1.0"
+    version_changed = "25.7.0"
     _ids = {
         "schema[ansible-lint-config]": "",
         "schema[ansible-navigator-config]": "",
@@ -73,6 +73,7 @@ class ValidateSchemaRule(AnsibleLintRule):
         "schema[meta]": "",
         "schema[meta-runtime]": "",
         "schema[molecule]": "",
+        "schema[pattern]": "",
         "schema[playbook]": "",
         "schema[requirements]": "",
         "schema[role-arg-spec]": "",
@@ -367,6 +368,20 @@ def matchyaml(self, file: Lintable) -> list[MatchError]:
                 ],
                 id="playbook2",
             ),
+            pytest.param(
+                "examples/patterns/correct_pattern/meta/pattern.json",
+                "pattern",
+                [],
+                id="pattern_positive",
+            ),
+            pytest.param(
+                "examples/patterns/incorrect_pattern/meta/pattern.json",
+                "pattern",
+                [
+                    r"\$ 'name' is a required property",
+                ],
+                id="pattern_negative",
+            ),
         ),
     )
     def test_schema(

src/ansiblelint/schemas/__store__.json

@@ -35,6 +35,9 @@
     "etag": "3b625438c28e884ac42a14c09ca542fc3e1b4466abaf47d0c28646e0857d3fb5",
     "url": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/molecule.json"
   },
+  "pattern": {
+    "url": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/pattern.json"
+  },
   "playbook": {
     "etag": "4f8cbba62fcf8a1fa6e8ef5e42696aec5b0876487478df83a7ffdf8bdbb4abcf",
     "url": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/playbook.json"