mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
d947fda96f
* refactor: extract _version.py from __init__.py (PR-3/8) Move version-checking helpers and `specify self` sub-commands into a focused `_version.py` module. Moved symbols: - GITHUB_API_LATEST — GitHub releases API endpoint constant - _get_installed_version — importlib.metadata-based version lookup - _normalize_tag — strip leading 'v' from release tag strings - _is_newer — PEP 440 version comparison - _fetch_latest_release_tag — single outbound call to GitHub API - self_app — Typer sub-app for `specify self` - self_check, self_upgrade — `specify self check/upgrade` commands Dependency rule: _version.py imports only stdlib + packaging + ._console. Backward compatibility: GITHUB_API_LATEST, self_check, self_upgrade remain importable from specify_cli via re-exports in __init__.py. Update test_upgrade.py to import helpers from specify_cli._version and patch at the correct module path (specify_cli._version.*). Add test_version_imports.py as regression guard. * fix(tests): update _fetch_latest_release_tag import path in test_authentication.py PR-3 moved _fetch_latest_release_tag from specify_cli into specify_cli._version. test_upgrade.py was updated at the time, but test_authentication.py::TestFetchLatestReleaseTagDelegation still imported from the old location, causing ImportError on all three delegation tests. Update all three inline imports to the correct module path.
412 lines
17 KiB
Python
412 lines
17 KiB
Python
"""Tests for the `specify self` sub-app (`self check` and `self upgrade`).
|
|
|
|
Network isolation contract (SC-004 / FR-014): every test that exercises
|
|
`specify self check` or `_fetch_latest_release_tag()` MUST mock
|
|
`urllib.request.urlopen` so no real outbound call ever reaches
|
|
api.github.com. The `self upgrade` stub tests do not need that patch because
|
|
the stub is contractually network-free. Run this module under `pytest-socket`
|
|
(if installed) with `--disable-socket` as an extra safety net.
|
|
"""
|
|
|
|
import json
|
|
import urllib.error
|
|
import importlib.metadata
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
from typer.testing import CliRunner
|
|
|
|
from specify_cli import app
|
|
from specify_cli._version import (
|
|
_fetch_latest_release_tag,
|
|
_get_installed_version,
|
|
_is_newer,
|
|
_normalize_tag,
|
|
)
|
|
from tests.conftest import strip_ansi
|
|
|
|
runner = CliRunner()
|
|
|
|
SENTINEL_GH_TOKEN = "SENTINEL-GH-TOKEN-VALUE"
|
|
SENTINEL_GITHUB_TOKEN = "SENTINEL-GITHUB-TOKEN-VALUE"
|
|
|
|
_RATE_LIMITED_REASON = (
|
|
"rate limited (configure ~/.specify/auth.json with a GitHub token)"
|
|
)
|
|
|
|
|
|
def _mock_urlopen_response(payload: dict) -> MagicMock:
|
|
body = json.dumps(payload).encode("utf-8")
|
|
resp = MagicMock()
|
|
resp.read.return_value = body
|
|
cm = MagicMock()
|
|
cm.__enter__.return_value = resp
|
|
cm.__exit__.return_value = False
|
|
return cm
|
|
|
|
|
|
def _http_error(code: int, message: str = "error") -> urllib.error.HTTPError:
|
|
return urllib.error.HTTPError(
|
|
url="https://api.github.com/repos/github/spec-kit/releases/latest",
|
|
code=code,
|
|
msg=message,
|
|
hdrs={}, # type: ignore[arg-type]
|
|
fp=None,
|
|
)
|
|
|
|
|
|
class TestSelfUpgradeStub:
|
|
"""Pins the `specify self upgrade` stub output + exit code (contract §3.5, FR-016)."""
|
|
|
|
def test_prints_exactly_three_lines_and_exits_zero(self):
|
|
result = runner.invoke(app, ["self", "upgrade"])
|
|
assert result.exit_code == 0
|
|
lines = strip_ansi(result.output).strip().splitlines()
|
|
assert lines == [
|
|
"specify self upgrade is not implemented yet.",
|
|
"Run 'specify self check' to see whether a newer release is available.",
|
|
"Actual self-upgrade is planned as follow-up work.",
|
|
]
|
|
|
|
def test_stub_makes_no_network_call(self):
|
|
# The stub must not hit the network via either urllib path:
|
|
# unauthenticated requests use urlopen() directly; authenticated ones
|
|
# go through build_opener(...).open(). Both are patched so that any
|
|
# accidental network call raises immediately.
|
|
network_error = AssertionError("stub must not hit the network")
|
|
with (
|
|
patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=network_error,
|
|
),
|
|
patch(
|
|
"specify_cli.authentication.http.urllib.request.build_opener",
|
|
side_effect=network_error,
|
|
),
|
|
):
|
|
result = runner.invoke(app, ["self", "upgrade"])
|
|
assert result.exit_code == 0
|
|
|
|
|
|
class TestIsNewer:
|
|
def test_latest_strictly_greater_returns_true(self):
|
|
assert _is_newer("0.8.0", "0.7.4") is True
|
|
|
|
def test_equal_versions_returns_false(self):
|
|
assert _is_newer("0.7.4", "0.7.4") is False
|
|
|
|
def test_current_greater_than_latest_returns_false(self):
|
|
assert _is_newer("0.7.0", "0.7.4") is False
|
|
|
|
def test_dev_build_ahead_of_release_returns_false(self):
|
|
assert _is_newer("0.7.4", "0.7.5.dev0") is False
|
|
|
|
def test_invalid_version_returns_false(self):
|
|
assert _is_newer("not-a-version", "0.7.4") is False
|
|
|
|
def test_local_version_containing_unknown_is_not_treated_as_sentinel(self):
|
|
assert _is_newer("1.2.4", "1.2.3+unknown") is True
|
|
|
|
|
|
class TestInstalledVersion:
|
|
def test_invalid_metadata_error_returns_unknown(self):
|
|
invalid_metadata_error = getattr(importlib.metadata, "InvalidMetadataError", None)
|
|
if invalid_metadata_error is None:
|
|
# Python versions without InvalidMetadataError: simulate with a
|
|
# custom exception to verify the guarded except path works.
|
|
class _FakeInvalidMetadataError(Exception):
|
|
pass
|
|
invalid_metadata_error = _FakeInvalidMetadataError
|
|
# Patch the attribute onto importlib.metadata so the production
|
|
# getattr() finds it during this test.
|
|
with patch.object(importlib.metadata, "InvalidMetadataError", invalid_metadata_error, create=True):
|
|
with patch(
|
|
"importlib.metadata.version",
|
|
side_effect=invalid_metadata_error("bad metadata"),
|
|
):
|
|
assert _get_installed_version() == "unknown"
|
|
else:
|
|
with patch(
|
|
"importlib.metadata.version",
|
|
side_effect=invalid_metadata_error("bad metadata"),
|
|
):
|
|
assert _get_installed_version() == "unknown"
|
|
|
|
|
|
class TestNormalizeTag:
|
|
def test_strips_single_leading_v(self):
|
|
assert _normalize_tag("v0.7.4") == "0.7.4"
|
|
|
|
def test_idempotent_when_no_leading_v(self):
|
|
assert _normalize_tag("0.7.4") == "0.7.4"
|
|
|
|
def test_strips_exactly_one_v(self):
|
|
assert _normalize_tag("vv0.7.4") == "v0.7.4"
|
|
|
|
def test_empty_string_passthrough(self):
|
|
assert _normalize_tag("") == ""
|
|
|
|
|
|
class TestUserStory1:
|
|
def test_newer_available_prints_update_and_install_command(self):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
return_value=_mock_urlopen_response({"tag_name": "v0.9.0"}),
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert result.exit_code == 0
|
|
assert "Update available" in output
|
|
assert "0.7.4" in output
|
|
assert "0.9.0" in output
|
|
assert "git+https://github.com/github/spec-kit.git@v0.9.0" in output
|
|
|
|
def test_up_to_date_prints_current_only(self):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.9.0"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
return_value=_mock_urlopen_response({"tag_name": "v0.9.0"}),
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert result.exit_code == 0
|
|
assert "Up to date: 0.9.0" in output
|
|
assert "Update available" not in output
|
|
assert "git+https://" not in output
|
|
|
|
def test_dev_build_ahead_of_release_is_up_to_date(self):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.5.dev0"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
return_value=_mock_urlopen_response({"tag_name": "v0.7.4"}),
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert result.exit_code == 0
|
|
assert "Update available" not in output
|
|
assert "Up to date" in output
|
|
|
|
def test_unknown_installed_still_prints_latest_and_reinstall(self):
|
|
with patch("specify_cli._version._get_installed_version", return_value="unknown"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
return_value=_mock_urlopen_response({"tag_name": "v0.7.4"}),
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert result.exit_code == 0
|
|
assert "Current version could not be determined" in output
|
|
assert "0.7.4" in output
|
|
assert "git+https://github.com/github/spec-kit.git@v0.7.4" in output
|
|
|
|
def test_unparseable_tag_routes_to_indeterminate(self):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
return_value=_mock_urlopen_response({"tag_name": "not-a-version"}),
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert result.exit_code == 0
|
|
assert "Update available" not in output
|
|
assert "Up to date" in output
|
|
assert "0.7.4" in output
|
|
|
|
|
|
class TestFailureCategorization:
|
|
def test_urlerror_maps_to_offline(self):
|
|
with patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=urllib.error.URLError("no route to host"),
|
|
):
|
|
tag, reason = _fetch_latest_release_tag()
|
|
assert tag is None
|
|
assert reason == "offline or timeout"
|
|
|
|
def test_timeout_maps_to_offline(self):
|
|
with patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=TimeoutError(),
|
|
):
|
|
tag, reason = _fetch_latest_release_tag()
|
|
assert tag is None
|
|
assert reason == "offline or timeout"
|
|
|
|
def test_403_maps_to_rate_limited(self):
|
|
with patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=_http_error(403, "rate limited"),
|
|
):
|
|
tag, reason = _fetch_latest_release_tag()
|
|
assert tag is None
|
|
assert reason == _RATE_LIMITED_REASON
|
|
|
|
@pytest.mark.parametrize("code", [404, 500, 502])
|
|
def test_other_http_uses_code_string(self, code):
|
|
with patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=_http_error(code, "oops"),
|
|
):
|
|
tag, reason = _fetch_latest_release_tag()
|
|
assert tag is None
|
|
assert reason == f"HTTP {code}"
|
|
|
|
def test_generic_exception_propagates(self):
|
|
# Per research D-006, no catch-all exists; RuntimeError MUST bubble.
|
|
with patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen",
|
|
side_effect=RuntimeError("boom"),
|
|
):
|
|
with pytest.raises(RuntimeError):
|
|
_fetch_latest_release_tag()
|
|
|
|
|
|
_FAILURE_CASES = [
|
|
("offline or timeout", urllib.error.URLError("down")),
|
|
(_RATE_LIMITED_REASON, _http_error(403)),
|
|
("HTTP 500", _http_error(500)),
|
|
]
|
|
|
|
|
|
class TestUserStory2:
|
|
@pytest.mark.parametrize("expected_reason, side_effect", _FAILURE_CASES)
|
|
def test_failure_prints_installed_plus_one_line_reason(
|
|
self, expected_reason, side_effect
|
|
):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
output = strip_ansi(result.output)
|
|
assert "Installed: 0.7.4" in output
|
|
if expected_reason == _RATE_LIMITED_REASON:
|
|
assert "Could not check latest release: rate limited" in output
|
|
assert "~/.specify/auth.json" in output
|
|
else:
|
|
assert f"Could not check latest release: {expected_reason}" in output
|
|
|
|
@pytest.mark.parametrize("_expected_reason, side_effect", _FAILURE_CASES)
|
|
def test_failure_exits_zero(self, _expected_reason, side_effect):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
assert result.exit_code == 0
|
|
|
|
@pytest.mark.parametrize("_expected_reason, side_effect", _FAILURE_CASES)
|
|
def test_failure_output_contains_no_traceback_no_url(
|
|
self, _expected_reason, side_effect
|
|
):
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
combined = (result.output or "") + (result.stderr or "")
|
|
combined = strip_ansi(combined)
|
|
assert "Traceback" not in combined
|
|
assert "https://api.github.com" not in combined
|
|
|
|
|
|
def _capture_request_via_urlopen():
|
|
captured = {}
|
|
|
|
def _side_effect(req, timeout=None):
|
|
captured["request"] = req
|
|
return _mock_urlopen_response({"tag_name": "v0.7.4"})
|
|
|
|
return captured, _side_effect
|
|
|
|
|
|
def _inject_github_config(monkeypatch, token_env="GH_TOKEN"):
|
|
from tests.auth_helpers import inject_github_config
|
|
inject_github_config(monkeypatch, token_env)
|
|
|
|
|
|
class TestUserStory3:
|
|
def test_gh_token_attached_as_bearer_header(self, monkeypatch):
|
|
monkeypatch.setenv("GH_TOKEN", SENTINEL_GH_TOKEN)
|
|
monkeypatch.delenv("GITHUB_TOKEN", raising=False)
|
|
_inject_github_config(monkeypatch, token_env="GH_TOKEN")
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
mock_opener = MagicMock()
|
|
mock_opener.open.side_effect = side_effect
|
|
with patch("specify_cli.authentication.http.urllib.request.build_opener", return_value=mock_opener):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") == f"Bearer {SENTINEL_GH_TOKEN}"
|
|
|
|
def test_github_token_used_when_gh_token_unset(self, monkeypatch):
|
|
monkeypatch.delenv("GH_TOKEN", raising=False)
|
|
monkeypatch.setenv("GITHUB_TOKEN", SENTINEL_GITHUB_TOKEN)
|
|
_inject_github_config(monkeypatch, token_env="GITHUB_TOKEN")
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
mock_opener = MagicMock()
|
|
mock_opener.open.side_effect = side_effect
|
|
with patch("specify_cli.authentication.http.urllib.request.build_opener", return_value=mock_opener):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") == f"Bearer {SENTINEL_GITHUB_TOKEN}"
|
|
|
|
def test_no_authorization_header_when_both_unset(self, monkeypatch):
|
|
monkeypatch.delenv("GH_TOKEN", raising=False)
|
|
monkeypatch.delenv("GITHUB_TOKEN", raising=False)
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
with patch("specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") is None
|
|
|
|
def test_empty_string_gh_token_treated_as_unset(self, monkeypatch):
|
|
monkeypatch.setenv("GH_TOKEN", "")
|
|
monkeypatch.delenv("GITHUB_TOKEN", raising=False)
|
|
_inject_github_config(monkeypatch, token_env="GH_TOKEN")
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
with patch("specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") is None
|
|
|
|
def test_whitespace_only_gh_token_treated_as_unset(self, monkeypatch):
|
|
monkeypatch.setenv("GH_TOKEN", " ")
|
|
monkeypatch.delenv("GITHUB_TOKEN", raising=False)
|
|
_inject_github_config(monkeypatch, token_env="GH_TOKEN")
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
with patch("specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") is None
|
|
|
|
def test_whitespace_only_gh_token_falls_back_to_github_token(self, monkeypatch):
|
|
monkeypatch.setenv("GH_TOKEN", " ")
|
|
monkeypatch.setenv("GITHUB_TOKEN", SENTINEL_GITHUB_TOKEN)
|
|
_inject_github_config(monkeypatch, token_env="GITHUB_TOKEN")
|
|
captured, side_effect = _capture_request_via_urlopen()
|
|
mock_opener = MagicMock()
|
|
mock_opener.open.side_effect = side_effect
|
|
with patch("specify_cli.authentication.http.urllib.request.build_opener", return_value=mock_opener):
|
|
_fetch_latest_release_tag()
|
|
req = captured["request"]
|
|
assert req.get_header("Authorization") == f"Bearer {SENTINEL_GITHUB_TOKEN}"
|
|
|
|
@pytest.mark.parametrize("_reason, side_effect", _FAILURE_CASES)
|
|
def test_gh_token_never_appears_in_failure_output(
|
|
self, _reason, side_effect, monkeypatch
|
|
):
|
|
monkeypatch.setenv("GH_TOKEN", SENTINEL_GH_TOKEN)
|
|
monkeypatch.delenv("GITHUB_TOKEN", raising=False)
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
combined = strip_ansi((result.output or "") + (result.stderr or ""))
|
|
assert SENTINEL_GH_TOKEN not in combined
|
|
|
|
@pytest.mark.parametrize("_reason, side_effect", _FAILURE_CASES)
|
|
def test_github_token_never_appears_in_failure_output(
|
|
self, _reason, side_effect, monkeypatch
|
|
):
|
|
monkeypatch.delenv("GH_TOKEN", raising=False)
|
|
monkeypatch.setenv("GITHUB_TOKEN", SENTINEL_GITHUB_TOKEN)
|
|
with patch("specify_cli._version._get_installed_version", return_value="0.7.4"), patch(
|
|
"specify_cli.authentication.http.urllib.request.urlopen", side_effect=side_effect
|
|
):
|
|
result = runner.invoke(app, ["self", "check"])
|
|
combined = strip_ansi((result.output or "") + (result.stderr or ""))
|
|
assert SENTINEL_GITHUB_TOKEN not in combined
|