maintainability-agent 3.0.1__tar.gz → 3.0.2__tar.gz

{maintainability_agent-3.0.1/src/maintainability_agent.egg-info → maintainability_agent-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maintainability-agent
-Version: 3.0.1
+Version: 3.0.2
 Summary: Maintainability gate and AI remediation prompt generator for CI.
 Author: Marshall Guillory
 License: MIT
@@ -45,7 +45,7 @@ Dynamic: license-file
 **A deterministic, offline maintainability audit whose output is a _bounded
 work order_ for an AI coding agent** — a copy-paste prompt, per finding, that
 says *fix exactly these and refactor nothing else*. Chat-primary; CLI for CI.
-Version **3.0.1**.
+Version **3.0.2**.
 
 **Planned, not shipped:** the audit tool will become `maintainability-audit`;
 a new `maintainability-agent` companion will run it and automate human-selected

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/README.md

@@ -5,7 +5,7 @@
 **A deterministic, offline maintainability audit whose output is a _bounded
 work order_ for an AI coding agent** — a copy-paste prompt, per finding, that
 says *fix exactly these and refactor nothing else*. Chat-primary; CLI for CI.
-Version **3.0.1**.
+Version **3.0.2**.
 
 **Planned, not shipped:** the audit tool will become `maintainability-audit`;
 a new `maintainability-agent` companion will run it and automate human-selected

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maintainability-agent"
-version = "3.0.1"
+version = "3.0.2"
 description = "Maintainability gate and AI remediation prompt generator for CI."
 readme = "README.md"
 # 3.11, not 3.10. `_discovery`, `_pillars` and `_runner` all import

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2/src/maintainability_agent.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maintainability-agent
-Version: 3.0.1
+Version: 3.0.2
 Summary: Maintainability gate and AI remediation prompt generator for CI.
 Author: Marshall Guillory
 License: MIT
@@ -45,7 +45,7 @@ Dynamic: license-file
 **A deterministic, offline maintainability audit whose output is a _bounded
 work order_ for an AI coding agent** — a copy-paste prompt, per finding, that
 says *fix exactly these and refactor nothing else*. Chat-primary; CLI for CI.
-Version **3.0.1**.
+Version **3.0.2**.
 
 **Planned, not shipped:** the audit tool will become `maintainability-audit`;
 a new `maintainability-agent` companion will run it and automate human-selected

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/src/maintainability_agent.egg-info/SOURCES.txt

@@ -336,6 +336,7 @@ tests/test_tdd_structure.py
 tests/test_test_commands.py
 tests/test_test_execution_class.py
 tests/test_three_presentations.py
+tests/test_tool_resolution.py
 tests/test_tree_chosen_spawn.py
 tests/test_trends.py
 tests/test_type_fields_not_functions_class.py

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/src/maintainability_audit/__init__.py

@@ -1,3 +1,3 @@
 """Maintainability Audit CI."""
 
-__version__ = "3.0.1"
+__version__ = "3.0.2"

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/src/maintainability_audit/_runner.py

@@ -32,8 +32,10 @@ import re
 import shutil
 import subprocess
 import sys
+import sysconfig
 import tempfile
 import time
+from contextlib import suppress
 from dataclasses import dataclass, field
 from enum import StrEnum
 from pathlib import Path
@@ -137,13 +139,38 @@ def locate(executable: str) -> str | None:
     `maintainability-audit --analyzers` finds almost nothing and reports
     an honest but useless "not installed" for every one of them.
     """
-    own_bin = Path(sys.executable).parent
-    candidate = own_bin / executable
-    if candidate.is_file():
-        return str(candidate)
+    for directory in _agent_script_dirs():
+        candidate = directory / executable
+        if candidate.is_file():
+            return str(candidate)
     return shutil.which(executable)
 
 
+def _agent_script_dirs() -> tuple[Path, ...]:
+    """Where this interpreter's console scripts land, in precedence order.
+
+    Two directories, because `pip install lizard` writes to a different
+    one depending on whether the agent lives in a virtualenv. In a venv
+    it is the interpreter's own `bin`. On a **system** Python it is the
+    per-user scripts directory, because the framework directory is not
+    writable and pip falls back to `--user` — on macOS that is
+    `~/Library/Python/3.11/bin`, which is not on the default `PATH`.
+
+    Searching only the first was D142. A user followed the environment
+    work order's own instruction, ran `pip install lizard`, and the next
+    audit still reported it "not installed or not on PATH" — because it
+    was installed exactly where neither this function nor `PATH` looked.
+    The whole Python pool went missing that way on the MCP surface, so
+    `declarations` fell to the built-in tier while the report's own
+    remedy could not fix it.
+    """
+    directories = [Path(sys.executable).parent]
+    with suppress(Exception):
+        scheme = sysconfig.get_preferred_scheme("user")
+        directories.append(Path(sysconfig.get_path("scripts", scheme=scheme)))
+    return tuple(directories)
+
+
 # Variables that make an interpreter or a linter load code from
 # somewhere the operator did not choose. `PYTHONPATH` and `NODE_PATH`
 # put a directory on an import path; `PYTHONSTARTUP` names a file

{maintainability_agent-3.0.1 → maintainability_agent-3.0.2}/src/maintainability_audit/config.py

@@ -20,7 +20,7 @@ from ._operator_reads import (
 # still the door every caller comes through.
 __all__ = ["DEFAULT_CONFIG", "DEFAULT_IDIOM_GROUPS", "PROJECT_URL", "VERSION"]
 
-VERSION = "3.0.1"
+VERSION = "3.0.2"
 
 PROJECT_URL = "https://github.com/marshallguillory86/maintainability-agent"
 

maintainability_agent-3.0.2/tests/test_tool_resolution.py

@@ -0,0 +1,166 @@
+"""Finding a tool the operator installed the way we told them to — D142.
+
+`locate` searched the interpreter's own `bin` and then `PATH`. That is
+correct for a virtualenv, where `pip install lizard` writes beside the
+interpreter. It is wrong for a **system** Python: the framework
+directory is not writable, pip falls back to `--user`, and the console
+script lands in the per-user scripts directory — on macOS
+`~/Library/Python/3.11/bin`, which is on neither list and not on the
+default `PATH`.
+
+So the environment work order told an operator to run `pip install
+lizard`, they ran it, and the next audit still reported the tool "not
+installed or not on PATH". The remedy the product prescribes could not
+fix the problem the product reports.
+
+Found by running the audit against this repository through the MCP
+server, the surface product intent calls primary. Nine analyzers were
+invisible — the whole Python pool, `lizard` and `complexipy` among them
+— so `declarations` fell to the built-in tier. The scan still passed its
+gate and reported a **better** grade than the same scan with the pool
+visible: B against C. A fallback that scores higher than the truth is
+the worst direction for a silent failure, because nothing in the result
+asks to be looked at.
+"""
+from __future__ import annotations
+
+import stat
+import sysconfig
+from pathlib import Path
+from types import SimpleNamespace
+
+import pytest
+
+from maintainability_audit import _runner
+
+
+def _fake_tool(directory: Path, name: str) -> Path:
+    directory.mkdir(parents=True, exist_ok=True)
+    script = directory / name
+    script.write_text("#!/bin/sh\nexit 0\n", encoding="utf-8")
+    script.chmod(script.stat().st_mode | stat.S_IEXEC)
+    return script
+
+
+@pytest.fixture
+def isolated(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    """Point every place `locate` looks at an empty directory.
+
+    Each test then puts the tool in exactly one of them, so what is being
+    asserted is the lookup and not the machine. Without this the tests
+    passed here and failed in CI: the runner installs the analyzer pool
+    beside its interpreter, so `own_bin` answered first and the fixture
+    directories were never reached. A test that agrees with the
+    environment it happens to run in cannot say which directory the code
+    actually searched.
+    """
+    own_bin = tmp_path / "interpreter" / "bin"
+    user_scripts = tmp_path / "user-base" / "bin"
+    on_path = tmp_path / "opt" / "bin"
+    for directory in (own_bin, user_scripts, on_path):
+        directory.mkdir(parents=True, exist_ok=True)
+
+    monkeypatch.setattr(_runner.sys, "executable", str(own_bin / "python3"))
+    monkeypatch.setenv("PATH", str(on_path))
+    monkeypatch.setattr(
+        sysconfig, "get_path",
+        lambda name, scheme=None, **kw: (
+            str(user_scripts) if name == "scripts" else sysconfig.get_paths()[name]
+        ),
+    )
+    return SimpleNamespace(own_bin=own_bin, user_scripts=user_scripts, on_path=on_path)
+
+
+def test_a_tool_in_the_user_scripts_directory_is_found(isolated) -> None:
+    """The case `pip install <tool>` actually produces on a system Python.
+
+    Neither beside the interpreter nor on `PATH`, because that is
+    precisely the combination that made the whole Python pool invisible
+    on the MCP surface.
+    """
+    _fake_tool(isolated.user_scripts, "lizard")
+
+    found = _runner.locate("lizard")
+
+    assert found is not None, (
+        "a tool installed by `pip install lizard` on a system Python was not "
+        "found; that is where pip puts it and it is on neither the "
+        "interpreter's bin nor PATH"
+    )
+    assert Path(found) == isolated.user_scripts / "lizard"
+
+
+def test_the_interpreters_own_bin_still_wins(isolated) -> None:
+    """Covers existing behaviour: the venv co-install keeps precedence.
+
+    It passes at the base — own-bin was already searched first — and is
+    here because the D142 fix appends a second directory. Appending it
+    ahead of `own_bin` would silently prefer a stale user-site copy over
+    the pinned one shipped beside the agent, which is the version-drift
+    the analyzer pinning exists to prevent.
+    """
+    _fake_tool(isolated.own_bin, "lizard")
+    _fake_tool(isolated.user_scripts, "lizard")
+
+    assert Path(_runner.locate("lizard")) == isolated.own_bin / "lizard"
+
+
+def test_path_is_still_searched_when_neither_script_dir_has_it(isolated) -> None:
+    """Covers existing behaviour: `PATH` remains the last resort.
+
+    Passes at the base. It is here because the fix changed the shape of
+    the lookup from two steps to a loop plus a fallback, and dropping the
+    fallback would strand every tool an operator installed with homebrew
+    or a system package manager — `jscpd` and `pmd` on this machine.
+    """
+    _fake_tool(isolated.on_path, "pmd")
+
+    assert Path(_runner.locate("pmd")) == isolated.on_path / "pmd"
+
+
+def test_a_missing_tool_is_still_reported_missing(isolated) -> None:
+    """Covers existing behaviour: absence is still absence.
+
+    Passes at the base, and pins the direction the fix must not move.
+    Widening the search until something is always found would turn "not
+    installed" into a false positive, which is worse than the defect —
+    the work order would name a tool that cannot run.
+    """
+    assert _runner.locate("a-tool-that-does-not-exist") is None
+
+
+def test_a_broken_user_scheme_does_not_break_resolution(
+    isolated, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Covers existing behaviour: `PATH` resolution survives sysconfig.
+
+    `get_preferred_scheme("user")` is interpreter-dependent and can raise
+    on an unusual install. It is wrapped, because a tool the operator has
+    on `PATH` must not become unfindable due to a lookup that exists only
+    to find a *different* directory.
+    """
+    _fake_tool(isolated.on_path, "radon")
+
+    def explode(*_args: object, **_kwargs: object) -> str:
+        raise KeyError("no such scheme")
+
+    monkeypatch.setattr(sysconfig, "get_preferred_scheme", explode)
+
+    assert Path(_runner.locate("radon")) == isolated.on_path / "radon"
+
+
+def test_the_agents_script_dirs_are_real_directories_not_guesses() -> None:
+    """Whatever is searched must come from this interpreter, not a list.
+
+    A hardcoded `~/Library/Python/3.11/bin` would be right on one machine
+    and wrong on every other Python version and platform. Both entries
+    are derived: one from `sys.executable`, one from `sysconfig`.
+    """
+    directories = _runner._agent_script_dirs()
+
+    assert directories, "no script directory is searched at all"
+    assert directories[0] == Path(_runner.sys.executable).parent
+    assert all(isinstance(d, Path) for d in directories)
+    assert len(set(directories)) == len(directories), (
+        f"the same directory is searched twice: {directories}"
+    )