Update schema to accept a list for 'listen' (#2817)

'listen' for handlers is actually a list: - https://github.com/ansible/ansible/blob/aa268b8db27193dd3f842ad72860ec3aefc3620d/lib/ansible/playbook/handler.py#L29 - https://github.com/ansible/ansible/blob/aa268b8db27193dd3f842ad72860ec3aefc3620d/examples/play.yml#L513 Co-authored-by: Sorin Sbarnea <[email protected]>
ansible · Dec 14, 2022 · c444166 · c444166
1 parent 02ec69f
commit c444166
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 9 deletions.
diff --git a/src/ansiblelint/schemas/ansible.json b/src/ansiblelint/schemas/ansible.json
@@ -911,9 +911,19 @@
           "type": "boolean"
         },
         "listen": {
-          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html#handlers-running-when-notified)",
-          "title": "Listen",
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html)",
+          "title": "Listen"
         },
         "local_action": {
           "title": "Local Action",

diff --git a/src/ansiblelint/schemas/playbook.json b/src/ansiblelint/schemas/playbook.json
@@ -933,9 +933,19 @@
           "type": "boolean"
         },
         "listen": {
-          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html#handlers-running-when-notified)",
-          "title": "Listen",
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html)",
+          "title": "Listen"
         },
         "local_action": {
           "title": "Local Action",

diff --git a/src/ansiblelint/schemas/tasks.json b/src/ansiblelint/schemas/tasks.json
@@ -385,9 +385,19 @@
           "type": "boolean"
         },
         "listen": {
-          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html#handlers-running-when-notified)",
-          "title": "Listen",
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html)",
+          "title": "Listen"
         },
         "local_action": {
           "title": "Local Action",

diff --git a/test/schemas/test/playbooks/run.yml b/test/schemas/test/playbooks/run.yml
@@ -12,6 +12,13 @@
         msg: "I am handler 1"
       listen: "always handler"
 
+    - name: handler 2
+      ansible.builtin.debug:
+        msg: "I am handler 2"
+      listen: #  to check if lists are allowed:
+        - "list listening handler"
+        - "other listening topic"
+
 - hosts: localhost
   serial: 1 # validate serial allows integer