Add auto-fixing implementation for key-order[task] rule (#3705)

Co-authored-by: Sorin Sbarnea <[email protected]>

Author: audgirka

.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: 818
+      PYTEST_REQPASS: 819
     steps:
       - name: Activate WSL1
         if: "contains(matrix.shell, 'wsl')"

examples/playbooks/transform-key-order.transformed.yml

@@ -0,0 +1,32 @@
+---
+- name: Fixture
+  hosts: localhost
+  tasks:
+    # comment before keys
+    - name: Task with no_log on top # name comment
+      no_log: true # no_log comment
+      ansible.builtin.command: echo hello # command comment
+      changed_when: false # changed_when comment
+      # comment after keys
+    - name: Task with when on top
+      when: true
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - name: Delegate_to on top
+      delegate_to: localhost
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - name: Loopy
+      loop:
+        - 1
+        - 2
+      ansible.builtin.command: echo {{ item }}
+      changed_when: false
+    - name: Become first
+      become: true
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - name: Register first
+      register: test
+      ansible.builtin.command: echo hello
+      changed_when: false

examples/playbooks/transform-key-order.yml

@@ -0,0 +1,32 @@
+---
+- name: Fixture
+  hosts: localhost
+  tasks:
+    - # comment before keys
+      no_log: true # no_log comment
+      ansible.builtin.command: echo hello # command comment
+      name: Task with no_log on top # name comment
+      changed_when: false # changed_when comment
+      # comment after keys
+    - when: true
+      name: Task with when on top
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - delegate_to: localhost
+      name: Delegate_to on top
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - loop:
+        - 1
+        - 2
+      name: Loopy
+      ansible.builtin.command: echo {{ item }}
+      changed_when: false
+    - become: true
+      name: Become first
+      ansible.builtin.command: echo hello
+      changed_when: false
+    - register: test
+      ansible.builtin.command: echo hello
+      name: Register first
+      changed_when: false

src/ansiblelint/rules/key_order.py

@@ -3,11 +3,15 @@
 
 import functools
 import sys
+from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from ansiblelint.rules import AnsibleLintRule
+from ansiblelint.errors import RuleMatchTransformMeta
+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
@@ -46,7 +50,21 @@ def task_property_sorter(property1: str, property2: str) -> int:
     return (v_1 > v_2) - (v_1 < v_2)
 
 
-class KeyOrderRule(AnsibleLintRule):
+@dataclass(frozen=True)
+class KeyOrderTMeta(RuleMatchTransformMeta):
+    """Key Order transform metadata.
+
+    :param fixed: tuple with updated key order
+    """
+
+    fixed: tuple[str | int, ...]
+
+    def __str__(self) -> str:
+        """Return string representation."""
+        return f"Fixed to {self.fixed}"
+
+
+class KeyOrderRule(AnsibleLintRule, TransformMixin):
     """Ensure specific order of keys in mappings."""
 
     id = "key-order"
@@ -74,10 +92,25 @@ def matchtask(
                     f"You can improve the task key order to: {', '.join(sorted_keys)}",
                     filename=file,
                     tag="key-order[task]",
+                    transform_meta=KeyOrderTMeta(fixed=tuple(sorted_keys)),
                 ),
             )
         return result
 
+    def transform(
+        self,
+        match: MatchError,
+        lintable: Lintable,
+        data: CommentedMap | CommentedSeq | str,
+    ) -> None:
+        if match.tag == "key-order[task]":
+            task = self.seek(match.yaml_path, data)
+            sorted_keys = match.message.split(":")[1].split(",")
+            for key in sorted_keys:
+                key = key.strip()
+                task[key] = task.pop(key)
+            match.fixed = True
+
 
 # testing code to be loaded only with pytest or when executed the rule file
 if "pytest" in sys.modules:

test/test_transformer.py

@@ -120,6 +120,12 @@ def fixture_runner_result(
             True,
             id="nested",
         ),
+        pytest.param(
+            "examples/playbooks/transform-key-order.yml",
+            6,
+            True,
+            id="key_order_transform",
+        ),
     ),
 )
 def test_transformer(  # pylint: disable=too-many-arguments, too-many-locals