feat: add rule CheckChangedInWhen

ansiblelater/rules/CheckChangedInWhen.py

@@ -0,0 +1,58 @@
+# Copyright (c) 2016 Will Thames <will@thames.id.au>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from ansiblelater.standard import StandardBase
+
+
+class CheckChangedInWhen(StandardBase):
+
+    sid = "ANSIBLE0026"
+    description = "Use handlers instead of `when: changed`"
+    helptext = "tasks using `when: result.changed` setting are effectively acting as a handler"
+    version = "0.2"
+    types = ["playbook", "task", "handler"]
+
+    def check(self, candidate, settings):
+        tasks, errors = self.get_normalized_tasks(candidate, settings)
+
+        if not errors:
+            for task in tasks:
+                when = None
+
+                if task["__ansible_action_type__"] == "task":
+                    when = task.get('when')
+
+                if isinstance(when, str):
+                    when = [when]
+
+                if isinstance(when, list):
+                    for item in when:
+                        if self._changed_in_when(item):
+                            errors.append(self.Error(task["__line__"], self.helptext))
+
+        return self.Result(candidate.path, errors)
+
+    @staticmethod
+    def _changed_in_when(item):
+        if not isinstance(item, str):
+            return False
+
+        return any(
+            changed in item for changed in ['.changed', '|changed', '["changed"]', "['changed']"]
+        )

docs/content/included_rules/_index.md

@@ -40,3 +40,4 @@ Reviews are nothing without some rules or standards against which to review. ans
 | CheckNestedJinja              | ANSIBLE0023 | Don't use nested Jinja2 pattern.                                  |                                                                      |
 | CheckLocalAction              | ANSIBLE0024 | Don't use local_action.                                           |                                                                      |
 | CheckRelativeRolePaths        | ANSIBLE0025 | Don't use a relative path in a role.                              |                                                                      |
+| CheckChangedInWhen            | ANSIBLE0026 | Use handlers instead of `when: changed`.                          |                                                                      |