mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-10 12:47:04 +00:00
Refactor scripts/install/lint.sh (~870 LOC bash) into a Python package
under utils/install/. scripts/install/lint.sh becomes a 7-line wrapper
that delegates to `python3 -m utils.install.lint`.
Layout:
- utils/install/{primitives,pip,npm,github_release,system_pkg}.py:
channel-agnostic installers
- utils/install/lint/<tool>.py: one ensure() per tool (actionlint,
shfmt, mbake, ruff, ansible_lint, galaxy_importer, markdownlint_cli2,
eslint, shellcheck, ansible_commands, ansible_collections)
- utils/install/lint/__main__.py: CLI + group dispatch + stamp logic
INFINITO_LINT_RUNNER dispatch:
- New env var (host | docker, default docker), tracked in env/static.env
+ passthrough handler + drift test.
- scripts/install/wrapper.sh routes `make install-lint` to host or
container based on the runner.
- scripts/lint/wrapper.sh already dispatched; container branch now uses
bash (not --login) so /etc/profile does not reset PATH, and forwards
BASH_ENV so the .env keys land in the lint script's env.
Stamp logic:
- Per-interpreter stamp at build/install-lint-<sha256(sys.executable)>.stamp
so host venv and container venv track installs independently despite
bind-mounted build/.
- `--force` drops the stamp; group args bypass the stamp.
Tests + docs:
- 43 unit tests under tests/unit/utils/install/{,lint/} cover primitives,
pip/npm/github_release/system_pkg fallback chains, and the main CLI
(stamp logic, group dispatch, error path).
- utils/install/README.md + utils/install/lint/README.md document the
structure and the per-tool ensure() contract.
- docs/contributing/tools/make.md install-lint row updated to mention
the runner dispatch + per-env stamp + install-lint-force.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
90 lines
3.3 KiB
Python
90 lines
3.3 KiB
Python
"""Unit tests for :mod:`utils.install.npm`."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import subprocess
|
|
import unittest
|
|
from unittest import mock
|
|
|
|
from utils.install import npm as npm_mod
|
|
|
|
|
|
class TestEnsureNpmPresent(unittest.TestCase):
|
|
def test_present_noop(self) -> None:
|
|
with (
|
|
mock.patch.object(npm_mod.shutil, "which", return_value="/usr/bin/npm"),
|
|
mock.patch(
|
|
"utils.install.system_pkg.install_command_via_pkg"
|
|
) as install_pkg,
|
|
):
|
|
npm_mod.ensure_npm_present()
|
|
install_pkg.assert_not_called()
|
|
|
|
def test_installs_via_system_pkg(self) -> None:
|
|
whiches = iter([None, "/usr/bin/npm"])
|
|
with (
|
|
mock.patch.object(
|
|
npm_mod.shutil, "which", side_effect=lambda _x: next(whiches)
|
|
),
|
|
mock.patch(
|
|
"utils.install.system_pkg.install_command_via_pkg"
|
|
) as install_pkg,
|
|
):
|
|
npm_mod.ensure_npm_present()
|
|
install_pkg.assert_called_once_with("npm")
|
|
|
|
def test_raises_when_still_missing(self) -> None:
|
|
with (
|
|
mock.patch.object(npm_mod.shutil, "which", return_value=None),
|
|
mock.patch("utils.install.system_pkg.install_command_via_pkg"),
|
|
):
|
|
self.assertRaises(RuntimeError, npm_mod.ensure_npm_present)
|
|
|
|
|
|
class TestNpmInstallGlobal(unittest.TestCase):
|
|
def test_global_success(self) -> None:
|
|
with (
|
|
mock.patch.object(npm_mod, "ensure_npm_present"),
|
|
mock.patch.object(npm_mod, "install_with_optional_sudo") as installer,
|
|
):
|
|
npm_mod.npm_install_global("markdownlint-cli2")
|
|
installer.assert_called_once_with(["npm", "install", "-g", "markdownlint-cli2"])
|
|
|
|
def test_fallback_to_prefix(self) -> None:
|
|
err = subprocess.CalledProcessError(returncode=1, cmd=["npm"])
|
|
with (
|
|
mock.patch.object(npm_mod, "ensure_npm_present"),
|
|
mock.patch.object(npm_mod, "install_with_optional_sudo", side_effect=err),
|
|
mock.patch.object(npm_mod.Path, "mkdir"),
|
|
mock.patch.object(npm_mod, "ensure_dir_on_path"),
|
|
mock.patch.object(npm_mod.subprocess, "run") as run,
|
|
):
|
|
npm_mod.npm_install_global("markdownlint-cli2")
|
|
called_cmd = run.call_args.args[0]
|
|
self.assertIn("--prefix", called_cmd)
|
|
self.assertEqual(called_cmd[-1], "markdownlint-cli2")
|
|
|
|
|
|
class TestNpmInstallLocalInRepo(unittest.TestCase):
|
|
def test_uses_ci_when_lockfile_present(self) -> None:
|
|
with (
|
|
mock.patch.object(npm_mod, "ensure_npm_present"),
|
|
mock.patch.object(npm_mod.Path, "is_file", return_value=True),
|
|
mock.patch.object(npm_mod.subprocess, "run") as run,
|
|
):
|
|
npm_mod.npm_install_local_in_repo("/repo")
|
|
self.assertEqual(run.call_args.args[0][:2], ["npm", "ci"])
|
|
|
|
def test_uses_install_without_lockfile(self) -> None:
|
|
with (
|
|
mock.patch.object(npm_mod, "ensure_npm_present"),
|
|
mock.patch.object(npm_mod.Path, "is_file", return_value=False),
|
|
mock.patch.object(npm_mod.subprocess, "run") as run,
|
|
):
|
|
npm_mod.npm_install_local_in_repo("/repo")
|
|
self.assertEqual(run.call_args.args[0][:2], ["npm", "install"])
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|