Transform for deprecated-local-action rule (#3689)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sorin Sbarnea <[email protected]>
Co-authored-by: Shatakshi Mishra <[email protected]>
Co-authored-by: Joachim Schwarm <[email protected]>
Co-authored-by: Ruchi Pakhle <[email protected]>

Author: 6 people

.github/workflows/tox.yml

@@ -71,7 +71,7 @@ jobs:
       WSLENV: FORCE_COLOR:PYTEST_REQPASS:TOXENV:GITHUB_STEP_SUMMARY
       # Number of expected test passes, safety measure for accidental skip of
       # tests. Update value if you add/remove tests.
-      PYTEST_REQPASS: 813
+      PYTEST_REQPASS: 814
     steps:
       - name: Activate WSL1
         if: "contains(matrix.shell, 'wsl')"

examples/playbooks/transform-deprecated-local-action.transformed.yml

@@ -0,0 +1,7 @@
+---
+- name: Fixture for deprecated-local-action
+  hosts: localhost
+  tasks:
+    - name: Task example
+      ansible.builtin.debug:
+      delegate_to: localhost

examples/playbooks/transform-deprecated-local-action.yml

@@ -0,0 +1,7 @@
+---
+- name: Fixture for deprecated-local-action
+  hosts: localhost
+  tasks:
+    - name: Task example
+      local_action:
+        module: ansible.builtin.debug

src/ansiblelint/rules/deprecated_local_action.py

@@ -6,14 +6,17 @@
 import sys
 from typing import TYPE_CHECKING
 
-from ansiblelint.rules import AnsibleLintRule
+from ansiblelint.rules import AnsibleLintRule, TransformMixin
 
 if TYPE_CHECKING:
+    from ruamel.yaml.comments import CommentedMap, CommentedSeq
+
+    from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
     from ansiblelint.utils import Task
 
 
-class TaskNoLocalAction(AnsibleLintRule):
+class TaskNoLocalAction(AnsibleLintRule, TransformMixin):
     """Do not use 'local_action', use 'delegate_to: localhost'."""
 
     id = "deprecated-local-action"
@@ -35,6 +38,24 @@ def matchtask(
 
         return False
 
+    def transform(
+        self,
+        match: MatchError,
+        lintable: Lintable,
+        data: CommentedMap | CommentedSeq | str,
+    ) -> None:
+        if match.tag == self.id:
+            target_task = self.seek(match.yaml_path, data)
+            for _ in range(len(target_task)):
+                k, v = target_task.popitem(False)
+                if k == "local_action":
+                    module_name = v["module"]
+                    target_task[module_name] = None
+                    target_task["delegate_to"] = "localhost"
+                else:
+                    target_task[k] = v
+        match.fixed = True
+
 
 # testing code to be loaded only with pytest or when executed the rule file
 if "pytest" in sys.modules:

src/ansiblelint/schemas/rulebook.json

@@ -1,6 +1,8 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://raw.githubusercontent.com/ansible/ansible-rulebook/main/ansible_rulebook/schema/ruleset_schema.json",
+    "title": "Ansible Rulebook",
+    "description": "See https://ansible.readthedocs.io/projects/rulebook/en/stable/rulebooks.html",
     "type": "array",
     "items": {
         "$ref": "#/$defs/ruleset"

test/test_transformer.py

@@ -96,6 +96,12 @@ def fixture_runner_result(
             True,
             id="cmd_instead_of_shell",
         ),
+        pytest.param(
+            "examples/playbooks/transform-deprecated-local-action.yml",
+            1,
+            True,
+            id="dep_local_action",
+        ),
     ),
 )
 def test_transformer(  # pylint: disable=too-many-arguments, too-many-locals