Make no-jinja-when also detect list conditions (#2975)

Author: ssbarnea

examples/playbooks/jinja2-when-failure.yml

@@ -0,0 +1,21 @@
+---
+- name: One
+  hosts: all
+  tasks:
+    - name: Test when with jinja2 # noqa: jinja[spacing]
+      ansible.builtin.debug:
+        msg: text
+      when: "{{ false }}"
+
+- name: Two
+  hosts: all
+  roles:
+    - role: test
+      when: "{{ '1' = '1' }}"
+
+- name: Three
+  hosts: all
+  roles:
+    - role: test
+      when:
+        - "{{ '1' = '1' }}"

examples/playbooks/jinja2-when-success.yml

@@ -0,0 +1,17 @@
+---
+- name: Test fixture for no-jinja-when
+  hosts: all
+  tasks:
+    - name: Test when
+      ansible.builtin.debug:
+        msg: text
+      when: true
+    - name: Test when 2
+      ansible.builtin.debug:
+        msg: text2
+      when: 1 = 1
+    - name: Three
+      ansible.builtin.debug:
+        msg: text2
+      when:
+        - "false"

examples/playbooks/rule-no-jinja-when-fail.yml

@@ -1,6 +1,7 @@
 """Implementation of no-jinja-when rule."""
 from __future__ import annotations
 
+import sys
 from typing import TYPE_CHECKING, Any
 
 from ansiblelint.constants import LINE_NUMBER_KEY
@@ -24,6 +25,15 @@ class NoFormattingInWhenRule(AnsibleLintRule):
 
     @staticmethod
     def _is_valid(when: str) -> bool:
+        if isinstance(when, list):
+            for item in when:
+                if (
+                    isinstance(item, str)
+                    and item.find("{{") != -1
+                    and item.find("}}") != -1
+                ):
+                    return False
+            return True
         if not isinstance(when, str):
             return True
         return when.find("{{") == -1 and when.find("}}") == -1
@@ -53,3 +63,26 @@ def matchtask(
         self, task: dict[str, Any], file: Lintable | None = None
     ) -> bool | str:
         return "when" in task and not self._is_valid(task["when"])
+
+
+if "pytest" in sys.modules:
+    # Tests for no-jinja-when rule.
+    from ansiblelint.rules import RulesCollection
+    from ansiblelint.runner import Runner
+
+    def test_file_positive() -> None:
+        """Positive test for no-jinja-when."""
+        collection = RulesCollection()
+        collection.register(NoFormattingInWhenRule())
+        success = "examples/playbooks/rule-no-jinja-when-pass.yml"
+        good_runner = Runner(success, rules=collection)
+        assert [] == good_runner.run()
+
+    def test_file_negative() -> None:
+        """Negative test for no-jinja-when."""
+        collection = RulesCollection()
+        collection.register(NoFormattingInWhenRule())
+        failure = "examples/playbooks/rule-no-jinja-when-fail.yml"
+        bad_runner = Runner(failure, rules=collection)
+        errs = bad_runner.run()
+        assert len(errs) == 3