computer-playbook/tests/unit/python/utils/install/test_npm.py

"""Unit tests for :mod:`utils.install.npm`."""

from __future__ import annotations

import json
import shutil
import subprocess
import tempfile
import unittest
import unittest.mock as mock
from pathlib import Path

from utils.install import npm as npm_mod


class TestEnsureNpmPresent(unittest.TestCase):
    def setUp(self) -> None:
        patcher = mock.patch("utils.install.node.ensure_node_present")
        self.ensure_node = patcher.start()
        self.addCleanup(patcher.stop)

    def test_provides_a_supported_node_first(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"),
        ):
            npm_mod.ensure_npm_present()
        self.ensure_node.assert_called_once_with()

    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"])


class TestNpmLocalMissing(unittest.TestCase):
    def _repo(self, installed: list[str]) -> str:
        root = Path(tempfile.mkdtemp())
        self.addCleanup(shutil.rmtree, root)
        (root / "package.json").write_text(
            json.dumps({"devDependencies": {"@scope/added": "^1", "plain": "^2"}}),
            encoding="utf-8",
        )
        for name in installed:
            (root / "node_modules" / name).mkdir(parents=True)
            (root / "node_modules" / name / "package.json").write_text(
                "{}", encoding="utf-8"
            )
        return str(root)

    def test_a_dependency_added_after_the_install_counts_as_missing(self) -> None:
        self.assertEqual(
            npm_mod.npm_local_missing(self._repo(["plain"])), ["@scope/added"]
        )

    def test_a_complete_install_misses_nothing(self) -> None:
        self.assertEqual(
            npm_mod.npm_local_missing(self._repo(["plain", "@scope/added"])), []
        )


if __name__ == "__main__":
    unittest.main()