fix: refactor RulesCollection to always require app argument

ssbarnea · ssbarnea · commit 65bb80fa0d06 · 2026-01-07T17:02:58.000Z
This change reduce use of get_app in codebase as this can cause unexpected behaviors for tests and also at runtime. Related: AAP-60425
diff --git a/src/ansiblelint/__main__.py b/src/ansiblelint/__main__.py
@@ -376,9 +376,9 @@ def main(argv: list[str] | None = None) -> int:
         cached=True,
     )  # to be sure we use the offline value from settings
     rules = RulesCollection(
-        options.rulesdirs,
-        profile_name=options.profile,
         app=app,
+        rulesdirs=options.rulesdirs,
+        profile_name=options.profile,
         options=options,
     )
 
diff --git a/src/ansiblelint/app.py b/src/ansiblelint/app.py
@@ -7,7 +7,6 @@
 import logging
 import os
 import sys
-from functools import lru_cache
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
@@ -387,7 +386,6 @@ def _sanitize_list_options(tag_list: list[str]) -> list[str]:
     return sorted(set(tags))
 
 
-@lru_cache
 def get_app(*, offline: bool | None = None, cached: bool = False) -> App:
     """Return the application instance, caching the return value."""
     # Avoids ever running the app initialization twice if cached argument
diff --git a/src/ansiblelint/rules/__init__.py b/src/ansiblelint/rules/__init__.py
@@ -23,7 +23,6 @@
     RuntimeErrorRule,
     WarningRule,
 )
-from ansiblelint.app import App, get_app
 from ansiblelint.config import PROFILES, Options
 from ansiblelint.config import options as default_options
 from ansiblelint.constants import RULE_DOC_URL, SKIPPED_RULES_KEY
@@ -33,6 +32,7 @@
 if TYPE_CHECKING:
     from ruamel.yaml.comments import CommentedMap, CommentedSeq
 
+    from ansiblelint.app import App
     from ansiblelint.errors import RuleMatchTransformMeta
 
 _logger = logging.getLogger(__name__)
@@ -390,12 +390,12 @@ class RulesCollection:
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
+        app: App,
         rulesdirs: list[str] | list[Path] | None = None,
         options: Options | None = None,
         profile_name: str | None = None,
         *,
         conditional: bool = True,
-        app: App | None = None,
     ) -> None:
         """Initialize a RulesCollection instance."""
         if options is None:
@@ -406,10 +406,7 @@ def __init__(  # pylint: disable=too-many-arguments
         else:
             self.options = options
         self.profile = []
-        # app should be defined on normal run logic, but for testing we might
-        # not pass it, and in this case we assume offline mode for performance
-        # reasons.
-        self.app = app or get_app(offline=True)
+        self.app = app
 
         if profile_name:
             self.profile = PROFILES[profile_name]
diff --git a/src/ansiblelint/rules/complexity.py b/src/ansiblelint/rules/complexity.py
@@ -9,6 +9,7 @@
 from ansiblelint.rules import AnsibleLintRule, RulesCollection
 
 if TYPE_CHECKING:
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
@@ -100,11 +101,12 @@ def test_complexity(
         expected_results: list[str],
         monkeypatch: pytest.MonkeyPatch,
         config_options: Options,
+        app: App,
     ) -> None:
         """Test rule."""
         monkeypatch.setattr(config_options, "max_tasks", 5)
         monkeypatch.setattr(config_options, "max_block_depth", 3)
-        collection = RulesCollection(options=config_options)
+        collection = RulesCollection(app=app, options=config_options)
         collection.register(ComplexityRule())
         results = Runner(file, rules=collection).run()
 
diff --git a/src/ansiblelint/rules/name.py b/src/ansiblelint/rules/name.py
@@ -15,6 +15,7 @@
 if TYPE_CHECKING:
     from ruamel.yaml.comments import CommentedMap, CommentedSeq
 
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
     from ansiblelint.utils import Task
@@ -324,10 +325,10 @@ def test_file_negative(empty_rule_collection: RulesCollection) -> None:
         errs = bad_runner.run()
         assert len(errs) == 5
 
-    def test_name_prefix_positive(config_options: Options) -> None:
+    def test_name_prefix_positive(config_options: Options, app: App) -> None:
         """Positive test for name[prefix]."""
         config_options.enable_list = ["name[prefix]"]
-        collection = RulesCollection(options=config_options)
+        collection = RulesCollection(app=app, options=config_options)
         collection.register(NameRule())
         success = Lintable(
             "examples/playbooks/tasks/main.yml",
@@ -337,10 +338,10 @@ def test_name_prefix_positive(config_options: Options) -> None:
         results = good_runner.run()
         assert len(results) == 0
 
-    def test_name_prefix_negative(config_options: Options) -> None:
+    def test_name_prefix_negative(config_options: Options, app: App) -> None:
         """Negative test for name[missing]."""
         config_options.enable_list = ["name[prefix]"]
-        collection = RulesCollection(options=config_options)
+        collection = RulesCollection(app=app, options=config_options)
         collection.register(NameRule())
         failure = Lintable(
             "examples/playbooks/tasks/rule-name-prefix-fail.yml",
@@ -354,10 +355,10 @@ def test_name_prefix_negative(config_options: Options) -> None:
         assert results[1].tag == "name[prefix]"
         assert results[2].tag == "name[prefix]"
 
-    def test_name_prefix_negative_2(config_options: Options) -> None:
+    def test_name_prefix_negative_2(config_options: Options, app: App) -> None:
         """Negative test for name[prefix]."""
         config_options.enable_list = ["name[prefix]"]
-        collection = RulesCollection(options=config_options)
+        collection = RulesCollection(app=app, options=config_options)
         collection.register(NameRule())
         failure = Lintable(
             "examples/playbooks/tasks/partial_prefix/foo.yml",
@@ -369,10 +370,10 @@ def test_name_prefix_negative_2(config_options: Options) -> None:
         assert results[0].tag == "name[prefix]"
         assert results[1].tag == "name[prefix]"
 
-    def test_name_prefix_negative_3(config_options: Options) -> None:
+    def test_name_prefix_negative_3(config_options: Options, app: App) -> None:
         """Negative test for name[prefix]."""
         config_options.enable_list = ["name[prefix]"]
-        collection = RulesCollection(options=config_options)
+        collection = RulesCollection(app=app, options=config_options)
         collection.register(NameRule())
         failure = Lintable(
             "examples/playbooks/tasks/partial_prefix/main.yml",
diff --git a/src/ansiblelint/rules/no_log_password.py b/src/ansiblelint/rules/no_log_password.py
@@ -29,6 +29,7 @@
 if TYPE_CHECKING:
     from ruamel.yaml.comments import CommentedMap, CommentedSeq
 
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
@@ -332,11 +333,12 @@ def test_password_lock_false(rule_runner: RunFromText) -> None:
     @mock.patch.dict(os.environ, {"ANSIBLE_LINT_WRITE_TMP": "1"}, clear=True)
     def test_no_log_password_transform(
         config_options: Options,
+        app: App,
     ) -> None:
         """Test transform functionality for no-log-password rule."""
         playbook = Path("examples/playbooks/transform-no-log-password.yml")
         config_options.write_list = ["all"]
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(NoLogPasswordsRule())
 
         config_options.lintables = [str(playbook)]
diff --git a/src/ansiblelint/rules/no_prompting.py b/src/ansiblelint/rules/no_prompting.py
@@ -8,6 +8,7 @@
 from ansiblelint.rules import AnsibleLintRule
 
 if TYPE_CHECKING:
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
     from ansiblelint.file_utils import Lintable
@@ -64,11 +65,11 @@ def matchtask(
     from ansiblelint.rules import RulesCollection
     from ansiblelint.runner import Runner
 
-    def test_no_prompting_fail(config_options: Options) -> None:
+    def test_no_prompting_fail(config_options: Options, app: App) -> None:
         """Negative test for no-prompting."""
         # For testing we want to manually enable opt-in rules
         config_options.enable_list = ["no-prompting"]
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(NoPromptingRule())
         results = Runner("examples/playbooks/rule-no-prompting.yml", rules=rules).run()
         assert len(results) == 2
diff --git a/src/ansiblelint/rules/schema.py b/src/ansiblelint/rules/schema.py
@@ -16,6 +16,7 @@
 if TYPE_CHECKING:
     from collections.abc import MutableMapping
 
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
     from ansiblelint.utils import Task
@@ -389,12 +390,13 @@ def test_schema(
         expected_kind: str,
         expected: list[str],
         config_options: Options,
+        app: App,
     ) -> None:
         """Validate parsing of ansible output."""
         lintable = Lintable(file)
         assert lintable.kind == expected_kind
 
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(ValidateSchemaRule())
         results = Runner(lintable, rules=rules).run()
 
@@ -422,12 +424,13 @@ def test_schema_moves(
         expected_tag: str,
         count: int,
         config_options: Options,
+        app: App,
     ) -> None:
         """Validate ability to detect schema[moves]."""
         lintable = Lintable(file)
         assert lintable.kind == expected_kind
 
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(ValidateSchemaRule())
         results = Runner(lintable, rules=rules).run()
 
diff --git a/src/ansiblelint/rules/var_naming.py b/src/ansiblelint/rules/var_naming.py
@@ -23,6 +23,7 @@
 from ansiblelint.utils import parse_yaml_from_file
 
 if TYPE_CHECKING:
+    from ansiblelint.app import App
     from ansiblelint.errors import MatchError
     from ansiblelint.utils import Task
 
@@ -365,9 +366,10 @@ def test_invalid_var_name_playbook(
         file: str,
         expected: int,
         config_options: Options,
+        app: App,
     ) -> None:
         """Test rule matches."""
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(VariableNamingRule())
         results = Runner(Lintable(file), rules=rules).run()
         assert len(results) == expected
diff --git a/src/ansiblelint/rules/yaml_rule.py b/src/ansiblelint/rules/yaml_rule.py
@@ -16,6 +16,7 @@
     from collections.abc import MutableMapping, MutableSequence
     from typing import Any
 
+    from ansiblelint.app import App
     from ansiblelint.config import Options
     from ansiblelint.errors import MatchError
 
@@ -178,12 +179,13 @@ def test_yamllint(
         expected_kind: str,
         expected: list[str],
         config_options: Options,
+        app: App,
     ) -> None:
         """Validate parsing of ansible output."""
         lintable = Lintable(file)
         assert lintable.kind == expected_kind
 
-        rules = RulesCollection(options=config_options)
+        rules = RulesCollection(app=app, options=config_options)
         rules.register(YamllintRule())
         results = Runner(lintable, rules=rules).run()
 
diff --git a/src/ansiblelint/testing/fixtures.py b/src/ansiblelint/testing/fixtures.py
@@ -27,15 +27,17 @@
 # The sessions scope does not apply to xdist, so we will still have one
 # session for each worker, but at least it will a limited number.
 @pytest.fixture(name="default_rules_collection", scope="session")
-def fixture_default_rules_collection() -> RulesCollection:
+def fixture_default_rules_collection(app: App) -> RulesCollection:
     """Return default rule collection."""
     assert DEFAULT_RULESDIR.is_dir()
     config_options = Options()
     config_options.enable_list = ["no-same-owner"]
     # That is instantiated very often and do want to avoid ansible-galaxy
     # install errors due to concurrency.
     config_options.offline = True
-    return RulesCollection(rulesdirs=[DEFAULT_RULESDIR], options=config_options)
+    return RulesCollection(
+        app=app, rulesdirs=[DEFAULT_RULESDIR], options=config_options
+    )
 
 
 @pytest.fixture
@@ -58,7 +60,7 @@ def rule_runner(request: SubRequest, app: App) -> RunFromText:
     rule_class = request.param
     config_options = Options()
     config_options.enable_list.append(rule_class().id)
-    collection = RulesCollection(options=config_options)
+    collection = RulesCollection(app=app, options=config_options)
     collection.register(rule_class())
     return RunFromText(collection, app)
 
diff --git a/src/ansiblelint/utils.py b/src/ansiblelint/utils.py
@@ -79,7 +79,7 @@
 from yaml.scanner import ScannerError
 
 from ansiblelint._internal.rules import AnsibleParserErrorRule, RuntimeErrorRule
-from ansiblelint.app import App, get_app
+from ansiblelint.app import App
 from ansiblelint.config import Options, get_deps_versions, options
 from ansiblelint.constants import (
     ANNOTATION_KEYS,
@@ -633,7 +633,7 @@ def _rolepath(self, basedir: str, role: str) -> str | None:
             possible_paths.append(path_dwim(loc, role_name[-1]))
 
         if namespace_name and collection_name:
-            for loc in get_app(cached=True).runtime.config.collections_paths:
+            for loc in self.app.runtime.config.collections_paths:
                 loc = os.path.expanduser(loc)
                 possible_paths.append(
                     path_dwim(
diff --git a/test/test_rules_collection.py b/test/test_rules_collection.py
@@ -33,13 +33,14 @@
 from ansiblelint.testing import run_ansible_lint
 
 if TYPE_CHECKING:
+    from ansiblelint.app import App
     from ansiblelint.config import Options
 
 
 @pytest.fixture(name="test_rules_collection")
-def fixture_test_rules_collection() -> RulesCollection:
+def fixture_test_rules_collection(app: App) -> RulesCollection:
     """Create a shared rules collection test instance."""
-    return RulesCollection([Path("./test/rules/fixtures").resolve()])
+    return RulesCollection(app=app, rulesdirs=[Path("./test/rules/fixtures").resolve()])
 
 
 @pytest.fixture(name="ematchtestfile")
@@ -133,14 +134,16 @@ def test_skip_non_existent_id(
     assert len(matches) == 4
 
 
-def test_no_duplicate_rule_ids() -> None:
+def test_no_duplicate_rule_ids(app: App) -> None:
     """Check that rules of the collection don't have duplicate IDs."""
-    real_rules = RulesCollection([Path("./src/ansiblelint/rules").resolve()])
+    real_rules = RulesCollection(
+        app=app, rulesdirs=[Path("./src/ansiblelint/rules").resolve()]
+    )
     rule_ids = [rule.id for rule in real_rules]
     assert not any(y > 1 for y in collections.Counter(rule_ids).values())
 
 
-def test_rule_listing() -> None:
+def test_rule_listing(app: App) -> None:
     """Test that rich list format output is rendered as a table.
 
     This check also offers the contract of having rule id, short and long
@@ -150,16 +153,17 @@ def test_rule_listing() -> None:
     result = run_ansible_lint("-r", str(rules_path), "-L")
     assert result.returncode == 0
 
-    for rule in RulesCollection([rules_path]):
+    for rule in RulesCollection(app=app, rulesdirs=[rules_path]):
         assert rule.id in result.stdout
         assert rule.shortdesc in result.stdout
 
 
-def test_rules_id_format(config_options: Options) -> None:
+def test_rules_id_format(config_options: Options, app: App) -> None:
     """Assure all our rules have consistent format."""
     rule_id_re = re.compile(r"^[a-z-]{4,30}$")
     rules = RulesCollection(
-        [Path("./src/ansiblelint/rules").resolve()],
+        app=app,
+        rulesdirs=[Path("./src/ansiblelint/rules").resolve()],
         options=config_options,
         conditional=False,
     )
diff --git a/tools/generate_docs.py b/tools/generate_docs.py
@@ -6,6 +6,7 @@
 import subprocess
 from pathlib import Path
 
+from ansiblelint.app import get_app
 from ansiblelint.cli import get_rules_dirs
 from ansiblelint.config import Options
 from ansiblelint.rules import (
@@ -25,7 +26,8 @@
     options.rulesdirs = get_rules_dirs([])
     options.list_rules = True
     rules = RulesCollection(
-        options.rulesdirs,
+        app=get_app(offline=True),
+        rulesdirs=options.rulesdirs,
         options=options,
     )
     contents: list[str] = [
