Remove dead code and prevent regressions

ssbarnea · ssbarnea · commit dd8250ebeb42 · 2024-11-25T16:43:24.000Z
diff --git a/.config/vulture_whitelist.py b/.config/vulture_whitelist.py
@@ -0,0 +1,15 @@
+_.configured  # unused attribute (src/ansiblelint/__main__.py:140)
+configured  # unused variable (src/ansiblelint/config.py:132)
+_.keep_trailing_newline  # unused attribute (src/ansiblelint/rules/jinja.py:280)
+_.lstrip_blocks  # unused attribute (src/ansiblelint/rules/jinja.py:282)
+_.trim_blocks  # unused attribute (src/ansiblelint/rules/jinja.py:283)
+_.autoescape  # unused attribute (src/ansiblelint/rules/jinja.py:284)
+_.newline_sequence  # unused attribute (src/ansiblelint/rules/jinja.py:285)
+_.allow_duplicate_keys  # unused attribute (src/ansiblelint/skip_utils.py:138)
+_.playbook_paths  # unused attribute (src/ansiblelint/utils.py:257)
+_.explicit_end  # unused attribute (src/ansiblelint/yaml_utils.py:915)
+_.default_flow_style  # unused attribute (src/ansiblelint/yaml_utils.py:923)
+_.compact_seq_seq  # unused attribute (src/ansiblelint/yaml_utils.py:924)
+_.compact_seq_map  # unused attribute (src/ansiblelint/yaml_utils.py:925)
+_.Constructor  # unused attribute (src/ansiblelint/yaml_utils.py:946)
+_.preserve_quotes  # unused attribute (src/ansiblelint/yaml_utils.py:956)
diff --git a/.gitignore b/.gitignore
@@ -77,3 +77,4 @@ src/ansiblelint/_version.py
 test/eco
 test/local-content
 test/schemas/node_modules
+node_modules
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -173,6 +173,7 @@ repos:
           - wcmatch
         exclude: >
           (?x)^(
+            .config/.*|
             collections/.*|
             test/local-content/.*|
             plugins/.*
@@ -227,6 +228,10 @@ repos:
           - typing_extensions
           - wcmatch
           - yamllint
+  - repo: https://github.com/jendrikseipp/vulture
+    rev: v2.13
+    hooks:
+      - id: vulture
   - # keep at bottom as these are slower
     repo: local
     hooks:
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -43,5 +43,8 @@
         "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.formatOnSave": true
     },
-    "evenBetterToml.formatter.arrayTrailingComma": true
+    "evenBetterToml.formatter.arrayTrailingComma": true,
+    "[toml]": {
+        "editor.defaultFormatter": "panekj.even-betterer-toml"
+    }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "prettier": "^3.3.3"
+  }
+}
diff --git a/pyproject.toml b/pyproject.toml
@@ -93,7 +93,7 @@ error_summary = true
 # warn_return_any = True
 # warn_unused_configs = True
 # site-packages is here to help vscode mypy integration getting confused
-exclude = "(build|dist|test/local-content|site-packages|~/.pyenv|examples/playbooks/collections|plugins/modules)"
+exclude = "(.config|build|dist|test/local-content|site-packages|~/.pyenv|examples/playbooks/collections|plugins/modules)"
 # https://github.com/python/mypy/issues/12664
 incremental = false
 python_version = "3.10"
@@ -122,7 +122,7 @@ bad-names = [
 # pylint defaults + f,fh,v,id
 good-names = ["i", "j", "k", "Run", "_", "f", "fh", "v", "id", "T"]
 # Ignore as being generated:
-ignore-paths = "^src/ansiblelint/_version.*$"
+ignore-paths = "^(src/ansiblelint/_version|.config/).*$"
 
 [tool.pylint."MESSAGES CONTROL"]
 disable = [
@@ -195,6 +195,7 @@ minversion = "4.6.6"
 norecursedirs = [
   "*.egg",
   ".cache",
+  ".config",
   ".eggs",
   ".git",
   ".github",
@@ -222,6 +223,7 @@ xfail_strict = true
 
 [tool.ruff]
 cache-dir = "./.cache/.ruff"
+exclude = [".config"]
 fix = true
 # Same as Black.
 line-length = 88
@@ -322,3 +324,27 @@ sort_table_keys = true
 annotation-style = "line"
 custom-compile-command = "tox run deps"
 no-emit-package = ["ansible-core", "pip", "resolvelib", "typing_extensions", "uv"]
+
+[tool.vulture]
+exclude = [
+  ".eggs",
+  ".tox",
+  "build",
+  "collections",
+  "examples",
+  "plugins",
+  "test/local-content",
+  "venv",
+  "src/ansiblelint/_version.py"
+]
+ignore_names = [
+  "_ANSIBLE_ARGS",
+  "__rich_console__",
+  "fixture_*",
+  "pytest_addoption",
+  "pytest_collection_modifyitems",
+  "pytest_configure",
+  "side_effect",
+  "test_*"
+]
+paths = ["src", "test", ".config/vulture_whitelist.py"]
diff --git a/src/ansiblelint/cli.py b/src/ansiblelint/cli.py
@@ -135,6 +135,7 @@ def __call__(
         values: str | Sequence[Any] | None,
         option_string: str | None = None,
     ) -> None:
+        logging.debug(option_string)
         if isinstance(values, str | Path):
             values = [values]
         if values:
diff --git a/src/ansiblelint/config.py b/src/ansiblelint/config.py
@@ -10,7 +10,6 @@
 import urllib.request
 import warnings
 from dataclasses import dataclass, field
-from functools import lru_cache
 from http.client import HTTPException
 from importlib.metadata import PackageNotFoundError, distribution, version
 from pathlib import Path
@@ -201,26 +200,10 @@ def supported_ansible(self) -> list[str]:
 # Used to store detected tag deprecations
 used_old_tags: dict[str, str] = {}
 
-# Used to store collection list paths (with mock paths if needed)
-collection_list: list[str] = []
-
 # Used to store log messages before logging is initialized (level, message)
 log_entries: list[tuple[int, str]] = []
 
 
-@lru_cache
-def ansible_collections_path() -> str:
-    """Return collection path variable for current version of Ansible."""
-    # respect Ansible behavior, which is to load old name if present
-    for env_var in [
-        "ANSIBLE_COLLECTIONS_PATHS",
-        "ANSIBLE_COLLECTIONS_PATH",
-    ]:  # pragma: no cover
-        if env_var in os.environ:
-            return env_var
-    return "ANSIBLE_COLLECTIONS_PATH"
-
-
 def in_venv() -> bool:
     """Determine whether Python is running from a venv."""
     if hasattr(sys, "real_prefix") or os.environ.get("CONDA_EXE", None) is not None:
diff --git a/src/ansiblelint/constants.py b/src/ansiblelint/constants.py
@@ -36,9 +36,6 @@ class RC:  # pylint: disable=too-few-public-methods
     EXIT_CONTROL_C = 130
 
 
-# Minimal version of Ansible we support for runtime
-ANSIBLE_MIN_VERSION = "2.12"
-
 ANSIBLE_MOCKED_MODULE = """\
 # This is a mocked Ansible module generated by ansible-lint
 from ansible.module_utils.basic import AnsibleModule
@@ -208,13 +205,6 @@ def main():
     "include_role",
 }
 
-# Newer versions of git might fail to run when different file ownership is
-# found of repo. One example is on GHA runners executing containerized
-# reusable actions, where the mounted volume might have different owner.
-#
-# https://github.com/ansible/ansible-lint-action/issues/138
-GIT_CMD = ["git", "-c", f"safe.directory={Path.cwd()}"]
-
 CONFIG_FILENAMES = [
     ".ansible-lint",
     ".config/ansible-lint.yml",
diff --git a/src/ansiblelint/file_utils.py b/src/ansiblelint/file_utils.py
@@ -478,11 +478,6 @@ def discover_lintables(options: Options) -> list[str]:
     ]
 
 
-def strip_dotslash_prefix(fname: str) -> str:
-    """Remove ./ leading from filenames."""
-    return fname.removeprefix("./")
-
-
 def find_project_root(
     srcs: Sequence[str],
     config_file: str | None = None,
diff --git a/src/ansiblelint/rules/deprecated_local_action.py b/src/ansiblelint/rules/deprecated_local_action.py
@@ -27,7 +27,7 @@
 _logger = logging.getLogger(__name__)
 
 
-class TaskNoLocalAction(AnsibleLintRule, TransformMixin):
+class TaskNoLocalActionRule(AnsibleLintRule, TransformMixin):
     """Do not use 'local_action', use 'delegate_to: localhost'."""
 
     id = "deprecated-local-action"
diff --git a/src/ansiblelint/rules/jinja.py b/src/ansiblelint/rules/jinja.py
@@ -405,7 +405,6 @@ def uncook(value: str, *, implicit: bool = False) -> str:
 
         except jinja2.exceptions.TemplateSyntaxError as exc:
             return "", str(exc.message), "invalid"
-        # pylint: disable=c-extension-no-member
         except (NotImplementedError, ValueError) as exc:
             # black is not able to recognize all valid jinja2 templates, so we
             # just ignore InvalidInput errors.
diff --git a/src/ansiblelint/testing/__init__.py b/src/ansiblelint/testing/__init__.py
@@ -76,38 +76,6 @@ def run_role_tasks_main(
         shutil.rmtree(role_path)
         return results
 
-    def run_role_meta_main(
-        self,
-        meta_main_text: str,
-        temp_path: Path,
-    ) -> list[MatchError]:
-        """Lints received text as meta."""
-        role_path = temp_path
-        meta_path = role_path / "meta"
-        meta_path.mkdir(parents=True, exist_ok=True)
-        with (meta_path / "main.yml").open("w", encoding="utf-8") as fh:
-            fh.write(meta_main_text)
-            fh.flush()
-        results = self._call_runner(role_path)
-        shutil.rmtree(role_path)
-        return results
-
-    def run_role_defaults_main(
-        self,
-        defaults_main_text: str,
-        tmp_path: Path,
-    ) -> list[MatchError]:
-        """Lints received text as vars file in defaults."""
-        role_path = tmp_path
-        defaults_path = role_path / "defaults"
-        defaults_path.mkdir(parents=True, exist_ok=True)
-        with (defaults_path / "main.yml").open("w", encoding="utf-8") as fh:
-            fh.write(defaults_main_text)
-            fh.flush()
-        results = self._call_runner(role_path)
-        shutil.rmtree(role_path)
-        return results
-
 
 def run_ansible_lint(
     *argv: str | Path,
diff --git a/src/ansiblelint/utils.py b/src/ansiblelint/utils.py
@@ -85,7 +85,6 @@
 # string as the password to enable such yaml files to be opened and parsed
 # successfully.
 DEFAULT_VAULT_PASSWORD = "x"  # noqa: S105
-COLLECTION_PLAY_RE = re.compile(r"^[\w\d_]+\.[\w\d_]+\.[\w\d_]+$")
 
 PLAYBOOK_DIR = os.environ.get("ANSIBLE_PLAYBOOK_DIR", None)
 
diff --git a/test/test_skip_import_playbook.py b/test/test_skip_import_playbook.py
@@ -1,44 +1,8 @@
 """Test related to skipping import_playbook."""
 
-from pathlib import Path
-
-import pytest
-
 from ansiblelint.rules import RulesCollection
 from ansiblelint.runner import Runner
 
-IMPORTED_PLAYBOOK = """\
----
-- name: Fixture
-  hosts: all
-  tasks:
-    - name: Success # noqa: no-free-form
-      ansible.builtin.fail: msg="fail"
-      when: false
-"""
-
-MAIN_PLAYBOOK = """\
----
-- name: Fixture
-  hosts: all
-
-  tasks:
-    - name: Should be shell  # noqa: command-instead-of-shell no-changed-when no-free-form
-      ansible.builtin.shell: echo lol
-
-- name: Should not be imported
-  import_playbook: imported_playbook.yml
-"""
-
-
-@pytest.fixture(name="playbook")
-def fixture_playbook(tmp_path: Path) -> str:
-    """Create a reusable per-test playbook."""
-    playbook_path = tmp_path / "playbook.yml"
-    playbook_path.write_text(MAIN_PLAYBOOK)
-    (tmp_path / "imported_playbook.yml").write_text(IMPORTED_PLAYBOOK)
-    return str(playbook_path)
-
 
 def test_skip_import_playbook(
     default_rules_collection: RulesCollection,
diff --git a/test/test_vulture.py b/test/test_vulture.py
@@ -0,0 +1,34 @@
+"""Used only by vulture to determine reachable code."""
+
+# ExampleComRule
+from ansiblelint.rules.args import ArgsRule
+from ansiblelint.rules.deprecated_local_action import TaskNoLocalActionRule
+from ansiblelint.rules.key_order import KeyOrderRule
+from ansiblelint.rules.latest import LatestRule
+from ansiblelint.rules.literal_compare import ComparisonToLiteralBoolRule
+from ansiblelint.rules.meta_incorrect import MetaChangeFromDefaultRule
+from ansiblelint.rules.meta_video_links import MetaVideoLinksRule
+from ansiblelint.rules.no_handler import UseHandlerRatherThanWhenChangedRule
+from ansiblelint.rules.no_relative_paths import RoleRelativePath
+from ansiblelint.rules.risky_file_permissions import MissingFilePermissionsRule
+from ansiblelint.rules.syntax_check import AnsibleSyntaxCheckRule
+from test.custom_rules.example_com.example_com_rule import ExampleComRule
+from test.custom_rules.example_inc.custom_rule import CustomRule
+from test.rules.fixtures.unset_variable_matcher import UnsetVariableMatcherRule
+
+__all__ = [
+    "AnsibleSyntaxCheckRule",
+    "ArgsRule",
+    "ComparisonToLiteralBoolRule",
+    "CustomRule",
+    "ExampleComRule",
+    "KeyOrderRule",
+    "LatestRule",
+    "MetaChangeFromDefaultRule",
+    "MetaVideoLinksRule",
+    "MissingFilePermissionsRule",
+    "RoleRelativePath",
+    "TaskNoLocalActionRule",
+    "UnsetVariableMatcherRule",
+    "UseHandlerRatherThanWhenChangedRule",
+]

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "devDependencies": {
 +    "prettier": "^3.3.3"
 +  }
 +}