Add tests for commodore tool command group

Author: simu

tests/test_cli.py

@@ -107,3 +107,18 @@ def test_package_sync_command():
 def test_version_command():
     exit_status = call("commodore version --help", shell=True)
     assert exit_status == 0
+
+
+def test_tool_list_command():
+    exit_status = call("commodore tool list --help", shell=True)
+    assert exit_status == 0
+
+
+def test_tool_install_command():
+    exit_status = call("commodore tool install --help", shell=True)
+    assert exit_status == 0
+
+
+def test_tool_upgrade_command():
+    exit_status = call("commodore tool upgrade --help", shell=True)
+    assert exit_status == 0

tests/test_tools.py

@@ -0,0 +1,147 @@
+import json
+
+from pathlib import Path
+from typing import Optional
+from unittest.mock import patch
+
+import pytest
+import responses
+
+DATA_DIR = Path(__file__).parent.absolute() / "testdata" / "github"
+
+TOOL_VERSIONS = {
+    "helm": "v3.18.3",
+    "jb": "0.6.3",
+    "kustomize": "v5.7.0",
+}
+
+
+class MockToolInfo:
+    tool: str
+    path: Optional[str]
+    version: Optional[str]
+
+    def __init__(self, tool: str):
+        self.tool = tool
+        self.path = f"/path/to/{tool}"
+        self.version = TOOL_VERSIONS[tool]
+
+
+from commodore.config import Config
+
+from commodore import tools
+
+
+def _parse_list_tools_output(out: str) -> dict[str, list[str]]:
+    tool = None
+    tool_lines = {}
+    for line in out.splitlines():
+        trimmed_line = " ".join(line.strip().split())
+        if trimmed_line.startswith(tuple(TOOL_VERSIONS.keys())):
+            tool = trimmed_line.split(" ")[0]
+        tool_lines.setdefault(tool, []).append(trimmed_line)
+    return tool_lines
+
+
+def _setup_tool_github_responses() -> dict[str, str]:
+    latest_versions = {}
+    for repo, tool in {
+        "helm/helm": "helm",
+        "projectsyn/jsonnet-bundler": "jb",
+        "kubernetes-sigs/kustomize": "kustomize",
+    }.items():
+        repo_key = repo.replace("/", "-")
+        with open(DATA_DIR / f"{repo_key}.json", "r", encoding="utf-8") as respf:
+            resp = json.load(respf)
+            responses.add(
+                responses.GET,
+                f"https://api.github.com:443/repos/{repo}",
+                json=resp,
+                status=200,
+            )
+        with open(
+            DATA_DIR / f"{repo_key}-releases-latest.json", "r", encoding="utf-8"
+        ) as latestf:
+            latest = json.load(latestf)
+            responses.add(
+                responses.GET,
+                f"https://api.github.com:443/repos/{repo}/releases/latest",
+                json=latest,
+                status=200,
+            )
+            latest_versions[tool] = latest["tag_name"].removeprefix(f"{tool}/")
+    return latest_versions
+
+
+@patch.object(tools, "ToolInfo")
+def test_list_tools_no_version_check(mock_tinfo, config: Config, capsys):
+    mock_tinfo.side_effect = MockToolInfo
+    tools.list_tools(config, False)
+
+    out, _ = capsys.readouterr()
+    tool_lines = _parse_list_tools_output(out)
+
+    for tool, version in TOOL_VERSIONS.items():
+        assert tool_lines[tool][0] == f"{tool} {version}"
+        assert tool_lines[tool][1] == f"Location: /path/to/{tool}"
+        assert tool_lines[tool][2] == f"Managed: {False}"
+        assert tool_lines[tool][3] == "Latest version: N/A (Version check skipped)"
+        assert tool_lines[tool][4] == "Updated: UNKNOWN"
+
+
+@patch.object(tools, "ToolInfo")
+@responses.activate
+def test_list_tool_version_check(mock_tinfo, config: Config, capsys):
+    mock_tinfo.side_effect = MockToolInfo
+    latest_versions = _setup_tool_github_responses()
+
+    tools.list_tools(config, True)
+
+    out, _ = capsys.readouterr()
+    tool_lines = _parse_list_tools_output(out)
+
+    for tool, version in TOOL_VERSIONS.items():
+        assert tool_lines[tool][0] == f"{tool} {version}"
+        assert tool_lines[tool][1] == f"Location: /path/to/{tool}"
+        assert tool_lines[tool][2] == f"Managed: {False}"
+        if latest_versions[tool].removeprefix("v") == TOOL_VERSIONS[tool].removeprefix(
+            "v"
+        ):
+            # Latest version is always GH tag name even for tools that report
+            # their own version without a v prefix.
+            assert (
+                tool_lines[tool][3]
+                == f"Latest version: v{TOOL_VERSIONS[tool].removeprefix('v')} (No upgrade available)"
+            )
+        else:
+            assert (
+                tool_lines[tool][3]
+                == f"Latest version: {latest_versions[tool]} (Upgrade available!)"
+            )
+        assert tool_lines[tool][4] == "Updated: UNKNOWN"
+
+
+@patch.object(tools, "ToolInfo")
+def test_list_tool_version_check(mock_tinfo, config: Config, capsys):
+    class MockToolInfo2(MockToolInfo):
+        def __init__(self, tool):
+            if tool != "jb":
+                super().__init__(tool)
+            else:
+                self.tool = tool
+                self.path = None
+                self.version = None
+
+    mock_tinfo.side_effect = MockToolInfo2
+
+    tools.list_tools(config, False)
+
+    out, _ = capsys.readouterr()
+    tool_lines = _parse_list_tools_output(out)
+    for tool, version in TOOL_VERSIONS.items():
+        if tool == "jb":
+            assert len(tool_lines[tool]) == 1
+            assert tool_lines[tool][0] == f"{tool} missing!"
+        else:
+            assert len(tool_lines[tool]) == 5
+            assert tool_lines[tool][0] == f"{tool} {version}"