Improve gather facts and subset support

.config/dictionary.txt

@@ -25,6 +25,7 @@ dzdo
 ededed
 envlist
 eoan
+facter
 fbba
 fbca
 fcba

f/ansible-playbook.json

@@ -349,8 +349,36 @@
           "type": "boolean"
         },
         "gather_subset": {
+          "items": {
+            "anyOf": [
+              {
+                "enum": [
+                  "all",
+                  "min",
+                  "hardware",
+                  "network",
+                  "virtual",
+                  "ohai",
+                  "facter"
+                ],
+                "type": "string"
+              },
+              {
+                "enum": [
+                  "!all",
+                  "!min",
+                  "!hardware",
+                  "!network",
+                  "!virtual",
+                  "!ohai",
+                  "!facter"
+                ],
+                "type": "string"
+              }
+            ]
+          },
           "title": "Gather Subset",
-          "type": "boolean"
+          "type": "array"
         },
         "gather_timeout": {
           "$ref": "#/$defs/templated-integer",

f/ansible.json

@@ -334,8 +334,36 @@
           "type": "boolean"
         },
         "gather_subset": {
+          "items": {
+            "anyOf": [
+              {
+                "enum": [
+                  "all",
+                  "min",
+                  "hardware",
+                  "network",
+                  "virtual",
+                  "ohai",
+                  "facter"
+                ],
+                "type": "string"
+              },
+              {
+                "enum": [
+                  "!all",
+                  "!min",
+                  "!hardware",
+                  "!network",
+                  "!virtual",
+                  "!ohai",
+                  "!facter"
+                ],
+                "type": "string"
+              }
+            ]
+          },
           "title": "Gather Subset",
-          "type": "boolean"
+          "type": "array"
         },
         "gather_timeout": {
           "$ref": "#/$defs/templated-integer",

negative_test/playbooks/gather_facts.yml

@@ -0,0 +1,6 @@
+---
+- hosts: localhost
+  gather_facts: non
+  tasks:
+    - ansible.builtin.debug:
+        msg: foo

negative_test/playbooks/gather_facts.yml.md

@@ -0,0 +1,122 @@
+# ajv errors
+
+```json
+[
+  {
+    "instancePath": "/0",
+    "keyword": "required",
+    "message": "must have required property 'ansible.builtin.import_playbook'",
+    "params": {
+      "missingProperty": "ansible.builtin.import_playbook"
+    },
+    "schemaPath": "#/oneOf/0/required"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "required",
+    "message": "must have required property 'import_playbook'",
+    "params": {
+      "missingProperty": "import_playbook"
+    },
+    "schemaPath": "#/oneOf/1/required"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "oneOf",
+    "message": "must match exactly one schema in oneOf",
+    "params": {
+      "passingSchemas": null
+    },
+    "schemaPath": "#/oneOf"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "hosts"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "gather_facts"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "tasks"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0/gather_facts",
+    "keyword": "type",
+    "message": "must be boolean",
+    "params": {
+      "type": "boolean"
+    },
+    "schemaPath": "#/properties/gather_facts/type"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "oneOf",
+    "message": "must match exactly one schema in oneOf",
+    "params": {
+      "passingSchemas": null
+    },
+    "schemaPath": "#/items/oneOf"
+  }
+]
+```
+
+# check-jsonschema
+
+stdout:
+
+```json
+{
+  "status": "fail",
+  "errors": [
+    {
+      "filename": "negative_test/playbooks/gather_facts.yml",
+      "path": "$[0]",
+      "message": "{'hosts': 'localhost', 'gather_facts': 'non', 'tasks': [{'ansible.builtin.debug': {'msg': 'foo'}}]} is not valid under any of the given schemas",
+      "has_sub_errors": true,
+      "best_match": {
+        "path": "$[0]",
+        "message": "'gather_facts', 'hosts', 'tasks' do not match any of the regexes: '^(ansible\\\\.builtin\\\\.)?import_playbook$', 'name', 'tags', 'vars'"
+      },
+      "sub_errors": [
+        {
+          "path": "$[0]",
+          "message": "'gather_facts', 'hosts', 'tasks' do not match any of the regexes: '^(ansible\\\\.builtin\\\\.)?import_playbook$', 'name', 'tags', 'vars'"
+        },
+        {
+          "path": "$[0]",
+          "message": "{'hosts': 'localhost', 'gather_facts': 'non', 'tasks': [{'ansible.builtin.debug': {'msg': 'foo'}}]} is not valid under any of the given schemas"
+        },
+        {
+          "path": "$[0]",
+          "message": "'ansible.builtin.import_playbook' is a required property"
+        },
+        {
+          "path": "$[0]",
+          "message": "'import_playbook' is a required property"
+        },
+        {
+          "path": "$[0].gather_facts",
+          "message": "'non' is not of type 'boolean'"
+        }
+      ]
+    }
+  ]
+}
+```

negative_test/playbooks/gather_subset.yml

@@ -0,0 +1,6 @@
+---
+- hosts: localhost
+  gather_subset: all
+  tasks:
+    - ansible.builtin.debug:
+        msg: foo

negative_test/playbooks/gather_subset.yml.md

@@ -0,0 +1,122 @@
+# ajv errors
+
+```json
+[
+  {
+    "instancePath": "/0",
+    "keyword": "required",
+    "message": "must have required property 'ansible.builtin.import_playbook'",
+    "params": {
+      "missingProperty": "ansible.builtin.import_playbook"
+    },
+    "schemaPath": "#/oneOf/0/required"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "required",
+    "message": "must have required property 'import_playbook'",
+    "params": {
+      "missingProperty": "import_playbook"
+    },
+    "schemaPath": "#/oneOf/1/required"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "oneOf",
+    "message": "must match exactly one schema in oneOf",
+    "params": {
+      "passingSchemas": null
+    },
+    "schemaPath": "#/oneOf"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "hosts"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "gather_subset"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "additionalProperties",
+    "message": "must NOT have additional properties",
+    "params": {
+      "additionalProperty": "tasks"
+    },
+    "schemaPath": "#/additionalProperties"
+  },
+  {
+    "instancePath": "/0/gather_subset",
+    "keyword": "type",
+    "message": "must be array",
+    "params": {
+      "type": "array"
+    },
+    "schemaPath": "#/properties/gather_subset/type"
+  },
+  {
+    "instancePath": "/0",
+    "keyword": "oneOf",
+    "message": "must match exactly one schema in oneOf",
+    "params": {
+      "passingSchemas": null
+    },
+    "schemaPath": "#/items/oneOf"
+  }
+]
+```
+
+# check-jsonschema
+
+stdout:
+
+```json
+{
+  "status": "fail",
+  "errors": [
+    {
+      "filename": "negative_test/playbooks/gather_subset.yml",
+      "path": "$[0]",
+      "message": "{'hosts': 'localhost', 'gather_subset': 'all', 'tasks': [{'ansible.builtin.debug': {'msg': 'foo'}}]} is not valid under any of the given schemas",
+      "has_sub_errors": true,
+      "best_match": {
+        "path": "$[0]",
+        "message": "'gather_subset', 'hosts', 'tasks' do not match any of the regexes: '^(ansible\\\\.builtin\\\\.)?import_playbook$', 'name', 'tags', 'vars'"
+      },
+      "sub_errors": [
+        {
+          "path": "$[0]",
+          "message": "'gather_subset', 'hosts', 'tasks' do not match any of the regexes: '^(ansible\\\\.builtin\\\\.)?import_playbook$', 'name', 'tags', 'vars'"
+        },
+        {
+          "path": "$[0]",
+          "message": "{'hosts': 'localhost', 'gather_subset': 'all', 'tasks': [{'ansible.builtin.debug': {'msg': 'foo'}}]} is not valid under any of the given schemas"
+        },
+        {
+          "path": "$[0]",
+          "message": "'ansible.builtin.import_playbook' is a required property"
+        },
+        {
+          "path": "$[0]",
+          "message": "'import_playbook' is a required property"
+        },
+        {
+          "path": "$[0].gather_subset",
+          "message": "'all' is not of type 'array'"
+        }
+      ]
+    }
+  ]
+}
+```

negative_test/playbooks/gather_subset2.yml

@@ -0,0 +1,7 @@
+---
+- hosts: localhost
+  gather_subset:
+    - invalid
+  tasks:
+    - ansible.builtin.debug:
+        msg: foo