Change matchtask to receive a Task instance (#3403)

ansible · May 7, 2023 · 6921d99 · 6921d99
1 parent 5cb5810
commit 6921d99
Show file tree

Hide file tree

Showing 43 changed files with 150 additions and 85 deletions.
diff --git a/docs/custom-rules.md b/docs/custom-rules.md
@@ -58,6 +58,7 @@ from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 class TaskHasTag(AnsibleLintRule):
     """Tasks must have tag."""
@@ -66,7 +67,7 @@ class TaskHasTag(AnsibleLintRule):
     description = 'Tasks must have tag'
     tags = ['productivity']
 
-    def matchtask(self, task: Dict[str, Any], file: 'Lintable' | None = None) -> Union[bool,str]:
+    def matchtask(self, task: Task, file: 'Lintable' | None = None) -> Union[bool,str]:
         # If the task include another task or make the playbook fail
         # Don't force to have a tag
         if not set(task.keys()).isdisjoint(['include','fail']):

diff --git a/examples/rules/task_has_tag.py b/examples/rules/task_has_tag.py
@@ -1,12 +1,13 @@
 """Example implementation of a rule requiring tasks to have tags set."""
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class TaskHasTag(AnsibleLintRule):
@@ -18,7 +19,7 @@ class TaskHasTag(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         """Task matching method."""

diff --git a/src/ansiblelint/_internal/rules.py b/src/ansiblelint/_internal/rules.py
@@ -12,6 +12,7 @@
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
     from ansiblelint.rules import RulesCollection
+    from ansiblelint.utils import Task
 
 _logger = logging.getLogger(__name__)
 LOAD_FAILURE_MD = """\
@@ -105,7 +106,7 @@ def matchlines(self, file: Lintable) -> list[MatchError]:
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str | MatchError | list[MatchError]:
         """Confirm if current rule is matching a specific task.

diff --git a/src/ansiblelint/errors.py b/src/ansiblelint/errors.py
@@ -3,12 +3,15 @@
 
 import functools
 from dataclasses import dataclass, field
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from ansiblelint._internal.rules import BaseRule, RuntimeErrorRule
 from ansiblelint.config import options
 from ansiblelint.file_utils import Lintable
 
+if TYPE_CHECKING:
+    from ansiblelint.utils import Task
+
 
 class StrictModeError(RuntimeError):
     """Raise when we encounter a warning in strict mode."""
@@ -72,7 +75,7 @@ def __post_init__(self) -> None:
 
         self.match_type: str | None = None
         # for task matches, save the normalized task object (useful for transforms)
-        self.task: dict[str, Any] | None = None
+        self.task: Task | None = None
         # path to the problem area, like: [0,"pre_tasks",3] for [0].pre_tasks[3]
         self.yaml_path: list[int | str] = []
 

diff --git a/src/ansiblelint/rules/__init__.py b/src/ansiblelint/rules/__init__.py
@@ -103,7 +103,7 @@ def create_matcherror(
     @staticmethod
     def _enrich_matcherror_with_task_details(
         match: MatchError,
-        task: dict[str, Any],
+        task: ansiblelint.utils.Task,
     ) -> None:
         match.task = task
         if not match.details:
@@ -172,7 +172,7 @@ def matchtasks(self, file: Lintable) -> list[MatchError]:  # noqa: C901
             if self.needs_raw_task:
                 task.normalized_task["__raw_task__"] = task.raw_task
 
-            result = self.matchtask(task.normalized_task, file=file)
+            result = self.matchtask(task, file=file)
             if not result:
                 continue
 
@@ -187,7 +187,7 @@ def matchtasks(self, file: Lintable) -> list[MatchError]:  # noqa: C901
                         continue
                     self._enrich_matcherror_with_task_details(
                         match,
-                        task.normalized_task,
+                        task,
                     )
                     matches.append(match)
                 continue
@@ -205,7 +205,7 @@ def matchtasks(self, file: Lintable) -> list[MatchError]:  # noqa: C901
                     filename=file,
                 )
 
-            self._enrich_matcherror_with_task_details(match, task.normalized_task)
+            self._enrich_matcherror_with_task_details(match, task)
             matches.append(match)
         return matches
 

diff --git a/src/ansiblelint/rules/args.py b/src/ansiblelint/rules/args.py
@@ -28,6 +28,7 @@
 if TYPE_CHECKING:
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 _logger = logging.getLogger(__name__)
@@ -96,7 +97,7 @@ class ArgsRule(AnsibleLintRule):
 
     def matchtask(  # noqa: C901
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> list[MatchError]:
         # pylint: disable=too-many-branches,too-many-locals

diff --git a/src/ansiblelint/rules/avoid_implicit.py b/src/ansiblelint/rules/avoid_implicit.py
@@ -3,12 +3,13 @@
 from __future__ import annotations
 
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class AvoidImplicitRule(AnsibleLintRule):
@@ -26,7 +27,7 @@ class AvoidImplicitRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         """Confirm if current rule is matching a specific task."""

diff --git a/src/ansiblelint/rules/command_instead_of_module.py b/src/ansiblelint/rules/command_instead_of_module.py
@@ -22,13 +22,14 @@
 
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 from ansiblelint.utils import convert_to_boolean, get_first_cmd_arg, get_second_cmd_arg
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class CommandsInsteadOfModulesRule(AnsibleLintRule):
@@ -75,7 +76,7 @@ class CommandsInsteadOfModulesRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         if task["action"]["__ansible_module__"] not in self._commands:

diff --git a/src/ansiblelint/rules/command_instead_of_shell.py b/src/ansiblelint/rules/command_instead_of_shell.py
@@ -21,13 +21,14 @@
 from __future__ import annotations
 
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 from ansiblelint.utils import get_cmd_args
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class UseCommandInsteadOfShellRule(AnsibleLintRule):
@@ -45,7 +46,7 @@ class UseCommandInsteadOfShellRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         # Use unjinja so that we don't match on jinja filters

diff --git a/src/ansiblelint/rules/deprecated_bare_vars.py b/src/ansiblelint/rules/deprecated_bare_vars.py
@@ -31,6 +31,7 @@
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class UsingBareVariablesIsDeprecatedRule(AnsibleLintRule):
@@ -48,7 +49,7 @@ class UsingBareVariablesIsDeprecatedRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         loop_type = next((key for key in task if key.startswith("with_")), None)

diff --git a/src/ansiblelint/rules/deprecated_local_action.py b/src/ansiblelint/rules/deprecated_local_action.py
@@ -4,12 +4,13 @@
 from __future__ import annotations
 
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class TaskNoLocalAction(AnsibleLintRule):
@@ -24,7 +25,7 @@ class TaskNoLocalAction(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         """Return matches for a task."""

diff --git a/src/ansiblelint/rules/empty_string_compare.py b/src/ansiblelint/rules/empty_string_compare.py
@@ -6,13 +6,14 @@
 
 import re
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 from ansiblelint.yaml_utils import nested_items_path
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class ComparisonToEmptyStringRule(AnsibleLintRule):
@@ -31,7 +32,7 @@ class ComparisonToEmptyStringRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         for k, v, _ in nested_items_path(task):

diff --git a/src/ansiblelint/rules/fqcn.py b/src/ansiblelint/rules/fqcn.py
@@ -15,6 +15,8 @@
 
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
+
 
 _logger = logging.getLogger(__name__)
 
@@ -104,7 +106,7 @@ class FQCNBuiltinsRule(AnsibleLintRule, TransformMixin):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> list[MatchError]:
         result = []

diff --git a/src/ansiblelint/rules/ignore_errors.py b/src/ansiblelint/rules/ignore_errors.py
@@ -2,12 +2,13 @@
 from __future__ import annotations
 
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 class IgnoreErrorsRule(AnsibleLintRule):
@@ -26,7 +27,7 @@ class IgnoreErrorsRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         if (

diff --git a/src/ansiblelint/rules/inline_env_var.py b/src/ansiblelint/rules/inline_env_var.py
@@ -20,11 +20,11 @@
 # THE SOFTWARE.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.constants import FILENAME_KEY, LINE_NUMBER_KEY
 from ansiblelint.rules import AnsibleLintRule
-from ansiblelint.utils import get_first_cmd_arg
+from ansiblelint.utils import Task, get_first_cmd_arg
 
 if TYPE_CHECKING:
     from ansiblelint.file_utils import Lintable
@@ -61,7 +61,7 @@ class EnvVarsInCommandRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> bool | str:
         if task["action"]["__ansible_module__"] in ["command"]:

diff --git a/src/ansiblelint/rules/jinja.py b/src/ansiblelint/rules/jinja.py
@@ -24,6 +24,7 @@
 
 if TYPE_CHECKING:
     from ansiblelint.errors import MatchError
+    from ansiblelint.utils import Task
 
 
 _logger = logging.getLogger(__package__)
@@ -77,7 +78,7 @@ def _msg(self, tag: str, value: str, reformatted: str) -> str:
     # pylint: disable=too-many-branches,too-many-locals
     def matchtask(  # noqa: C901
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> list[MatchError]:
         result = []

diff --git a/src/ansiblelint/rules/key_order.py b/src/ansiblelint/rules/key_order.py
@@ -3,13 +3,14 @@
 
 import functools
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
+    from ansiblelint.utils import Task
 
 
 SORTER_TASKS = (
@@ -57,7 +58,7 @@ class KeyOrderRule(AnsibleLintRule):
 
     def matchtask(
         self,
-        task: dict[str, Any],
+        task: Task,
         file: Lintable | None = None,
     ) -> list[MatchError]:
         result = []