chore: refactor testing code to reduce use of get_app() (#4890)

Author: ssbarnea

.config/vulture_whitelist.py

@@ -26,3 +26,6 @@
 _.BRIGHT_MAGENTA  # unused variable (src/ansiblelint/output.py:185)
 _.BRIGHT_CYAN  # unused variable (src/ansiblelint/output.py:186)
 _.BRIGHT_WHITE  # unused variable (src/ansiblelint/output.py:187)
+formatter_collection  # unused function (test/test_formatter.py:47)
+json_formatter_collection  # unused function (test/test_formatter_json.py:29)
+sarif_formatter_collection  # unused function (test/test_formatter_sarif.py:47)

.gitignore

@@ -37,7 +37,6 @@ junit.xml
 .python-version
 
 # Environments
-.env
 .venv
 env/
 venv/

.vscode/extensions.json

@@ -15,8 +15,7 @@
     "ryanluker.vscode-coverage-gutters",
     "shardulm94.trailing-spaces",
     "tombi-toml.tombi",
-    "timonwong.shellcheck",
-    "znck.grammarly"
+    "timonwong.shellcheck"
   ],
   "unwantedRecommendations": [
     "esbenp.prettier-vscode",

.vscode/settings.json

@@ -33,8 +33,6 @@
     "build": true
   },
   "git.ignoreLimitWarning": true,
-  "grammarly.config.documentDomain": "academic",
-  "grammarly.files.include": ["**/*.txt", "**/*.md"],
   "mypy-type-checker.severity": {
     "error": "Warning"
   },

mise.toml

@@ -0,0 +1,8 @@
+# Ensure that you can use `uv` directly if you already have a pre-activated
+# virtual environment, otherwise `uv sync` will refuse to run as it will
+# complain about uv project environment being different than yours.
+[env]
+UV_PROJECT_ENVIRONMENT = "{{ get_env(name='VIRTUAL_ENV', default='.venv') }}"
+
+[tools]
+python = "latest"

src/ansiblelint/rules/avoid_implicit.py

@@ -44,19 +44,21 @@ def matchtask(
     from ansiblelint.rules import RulesCollection
     from ansiblelint.runner import Runner
 
-    def test_template_instead_of_copy_positive() -> None:
+    def test_template_instead_of_copy_positive(
+        empty_rule_collection: RulesCollection,
+    ) -> None:
         """Positive test for avoid-implicit."""
-        collection = RulesCollection()
-        collection.register(AvoidImplicitRule())
+        empty_rule_collection.register(AvoidImplicitRule())
         success = "examples/playbooks/rule-avoid-implicit-pass.yml"
-        good_runner = Runner(success, rules=collection)
+        good_runner = Runner(success, rules=empty_rule_collection)
         assert good_runner.run() == []
 
-    def test_template_instead_of_copy_negative() -> None:
+    def test_template_instead_of_copy_negative(
+        empty_rule_collection: RulesCollection,
+    ) -> None:
         """Negative test for avoid-implicit."""
-        collection = RulesCollection()
-        collection.register(AvoidImplicitRule())
+        empty_rule_collection.register(AvoidImplicitRule())
         failure = "examples/playbooks/rule-avoid-implicit-fail.yml"
-        bad_runner = Runner(failure, rules=collection)
+        bad_runner = Runner(failure, rules=empty_rule_collection)
         errs = bad_runner.run()
         assert len(errs) == 1

src/ansiblelint/rules/deprecated_bare_vars.py

@@ -112,19 +112,17 @@ def _matchvar(
     from ansiblelint.runner import Runner
 
     @pytest.mark.filterwarnings("ignore::ansible_compat.runtime.AnsibleWarning")
-    def test_use_bare_positive() -> None:
+    def test_use_bare_positive(empty_rule_collection: RulesCollection) -> None:
         """Positive test for deprecated-bare-vars."""
-        collection = RulesCollection()
-        collection.register(UsingBareVariablesIsDeprecatedRule())
+        empty_rule_collection.register(UsingBareVariablesIsDeprecatedRule())
         success = "examples/playbooks/rule-deprecated-bare-vars-pass.yml"
-        good_runner = Runner(success, rules=collection)
+        good_runner = Runner(success, rules=empty_rule_collection)
         assert good_runner.run() == []
 
-    def test_use_bare_negative() -> None:
+    def test_use_bare_negative(empty_rule_collection: RulesCollection) -> None:
         """Negative test for deprecated-bare-vars."""
-        collection = RulesCollection()
-        collection.register(UsingBareVariablesIsDeprecatedRule())
+        empty_rule_collection.register(UsingBareVariablesIsDeprecatedRule())
         failure = "examples/playbooks/rule-deprecated-bare-vars-fail.yml"
-        bad_runner = Runner(failure, rules=collection)
+        bad_runner = Runner(failure, rules=empty_rule_collection)
         errs = bad_runner.run()
         assert len(errs) == 11

src/ansiblelint/rules/deprecated_local_action.py

@@ -229,6 +229,7 @@ def test_local_action_transform_fail(
     def test_local_action_transform(
         config_options: Options,
         monkeypatch: pytest.MonkeyPatch,
+        empty_rule_collection: RulesCollection,
     ) -> None:
         """Test transform functionality for no-log-password rule."""
         monkeypatch.setenv("ANSIBLE_LINT_WRITE_TMP", "1")
@@ -237,10 +238,9 @@ def test_local_action_transform(
         config_options.write_list = ["all"]
 
         config_options.lintables = [str(playbook)]
-        only_local_action_rule: RulesCollection = RulesCollection()
-        only_local_action_rule.register(TaskNoLocalActionRule())
+        empty_rule_collection.register(TaskNoLocalActionRule())
         runner_result = get_matches(
-            rules=only_local_action_rule,
+            rules=empty_rule_collection,
             options=config_options,
         )
         transformer = Transformer(result=runner_result, options=config_options)

src/ansiblelint/rules/empty_string_compare.py

@@ -58,24 +58,26 @@ def matchtask(
     from ansiblelint.rules import RulesCollection
     from ansiblelint.runner import Runner
 
-    def test_rule_empty_string_compare_fail() -> None:
+    def test_rule_empty_string_compare_fail(
+        empty_rule_collection: RulesCollection,
+    ) -> None:
         """Test rule matches."""
-        rules = RulesCollection()
-        rules.register(ComparisonToEmptyStringRule())
+        empty_rule_collection.register(ComparisonToEmptyStringRule())
         results = Runner(
             "examples/playbooks/rule-empty-string-compare-fail.yml",
-            rules=rules,
+            rules=empty_rule_collection,
         ).run()
         assert len(results) == 3
         for result in results:
             assert result.message == ComparisonToEmptyStringRule().shortdesc
 
-    def test_rule_empty_string_compare_pass() -> None:
+    def test_rule_empty_string_compare_pass(
+        empty_rule_collection: RulesCollection,
+    ) -> None:
         """Test rule matches."""
-        rules = RulesCollection()
-        rules.register(ComparisonToEmptyStringRule())
+        empty_rule_collection.register(ComparisonToEmptyStringRule())
         results = Runner(
             "examples/playbooks/rule-empty-string-compare-pass.yml",
-            rules=rules,
+            rules=empty_rule_collection,
         ).run()
         assert len(results) == 0, results

src/ansiblelint/rules/fqcn.py

@@ -266,12 +266,11 @@ def transform(
     from ansiblelint.runner import Runner
 
     @pytest.mark.libyaml
-    def test_fqcn_builtin_fail() -> None:
+    def test_fqcn_builtin_fail(empty_rule_collection: RulesCollection) -> None:
         """Test rule matches."""
-        collection = RulesCollection()
-        collection.register(FQCNBuiltinsRule())
+        empty_rule_collection.register(FQCNBuiltinsRule())
         success = "examples/playbooks/rule-fqcn-fail.yml"
-        results = Runner(success, rules=collection).run()
+        results = Runner(success, rules=empty_rule_collection).run()
         assert len(results) == 3
         assert results[0].tag == "fqcn[keyword]"
         assert "Avoid `collections` keyword" in results[0].message
@@ -280,36 +279,32 @@ def test_fqcn_builtin_fail() -> None:
         assert results[2].tag == "fqcn[action]"
         assert "Use FQCN for module actions, such" in results[2].message
 
-    def test_fqcn_builtin_pass() -> None:
+    def test_fqcn_builtin_pass(empty_rule_collection: RulesCollection) -> None:
         """Test rule does not match."""
-        collection = RulesCollection()
-        collection.register(FQCNBuiltinsRule())
+        empty_rule_collection.register(FQCNBuiltinsRule())
         success = "examples/playbooks/rule-fqcn-pass.yml"
-        results = Runner(success, rules=collection).run()
+        results = Runner(success, rules=empty_rule_collection).run()
         assert len(results) == 0, results
 
-    def test_fqcn_deep_fail() -> None:
+    def test_fqcn_deep_fail(empty_rule_collection: RulesCollection) -> None:
         """Test rule matches."""
-        collection = RulesCollection()
-        collection.register(FQCNBuiltinsRule())
+        empty_rule_collection.register(FQCNBuiltinsRule())
         failure = "examples/.collection/plugins/modules/deep/beta.py"
-        results = Runner(failure, rules=collection).run()
+        results = Runner(failure, rules=empty_rule_collection).run()
         assert len(results) == 1
         assert results[0].tag == "fqcn[deep]"
         assert "Deep plugins directory is discouraged" in results[0].message
 
-    def test_fqcn_deep_pass() -> None:
+    def test_fqcn_deep_pass(empty_rule_collection: RulesCollection) -> None:
         """Test rule does not match."""
-        collection = RulesCollection()
-        collection.register(FQCNBuiltinsRule())
+        empty_rule_collection.register(FQCNBuiltinsRule())
         success = "examples/.collection/plugins/modules/alpha.py"
-        results = Runner(success, rules=collection).run()
+        results = Runner(success, rules=empty_rule_collection).run()
         assert len(results) == 0
 
-    def test_fqcn_deep_test_dir_pass() -> None:
+    def test_fqcn_deep_test_dir_pass(empty_rule_collection: RulesCollection) -> None:
         """Test rule does not match."""
-        collection = RulesCollection()
-        collection.register(FQCNBuiltinsRule())
+        empty_rule_collection.register(FQCNBuiltinsRule())
         success = "examples/.collection/plugins/modules/tests/gamma.py"
-        results = Runner(success, rules=collection).run()
+        results = Runner(success, rules=empty_rule_collection).run()
         assert len(results) == 0