Files
headroom/tests/test_update_check.py
c1dae5adae fix(update-check): skip releases with no files and do not fall back to an uninstallable version (#4560)
## Description

`_select_latest` (`headroom/update_check.py:153-193`) promises the
newest non-yanked release, but it treated a release whose file list is
empty as installable, and when no release was installable it fell back
to `info.version`, which names one of those releases. The update banner
could then advise a version `pip` cannot install. Releases with an empty
file list are now skipped like fully yanked ones, and when `releases`
lists versions but none is installable the function returns `None`; the
`info.version` fallback is kept for a payload with no `releases`. Item 3
of #4546.

Refs #4546

This PR used to carry all three items of #4546; per the
one-logical-change-per-PR rule the other two are now #4562 (null
thinking block) and #4563 (interior blank CSV rows).

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- `headroom/update_check.py`: skip a release when its file list is empty
or every file is yanked; return `None` instead of the `info.version`
fallback when releases are listed but none is installable.
- `tests/test_update_check.py`:
`test_select_latest_skips_release_with_no_files`,
`test_select_latest_no_fallback_when_every_release_is_unavailable`.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
# fail before (source at a2d4fe72, new tests kept)
FAILED tests/test_update_check.py::test_select_latest_skips_release_with_no_files  (assert '9.9.9' == '1.0.0')
FAILED tests/test_update_check.py::test_select_latest_no_fallback_when_every_release_is_unavailable

# pass after: tests/test_update_check.py tests/test_update_helpers.py
74 passed

# ruff check / ruff format --check: All checks passed! / 2 files already formatted
```

## Real Behavior Proof

- Environment: Ubuntu (WSL2) on Windows 11, Python 3.12.15, `headroom`
Python source at `a2d4fe72` and at this branch, offline.
- Exact command / steps: `_select_latest({"info": {"version": "1.0.0"},
"releases": {"1.0.0": [{"yanked": False}], "9.9.9": []}},
allow_pre=False)` and `_select_latest({"releases": {"9.9.9": []},
"info": {"version": "9.9.9"}}, allow_pre=False)`.
- Observed result: on `a2d4fe72`: `9.9.9` and `9.9.9`. On this branch:
`1.0.0` and `None`.
- Not tested: whether PyPI's JSON API ever lists a release with no files
(the fix follows the function's own docstring); the full suite and
`mypy`.

## Runtime Rollout Safety

- Rollout-managed feature(s): None.
- Minimum rollout channel: N/A
- Stable/default behavior changed: Only for payloads where every listed
release is uninstallable; the banner then stays quiet instead of naming
an uninstallable version.
- Kill switch / disable path: `HEADROOM_UPDATE_CHECK=off` (existing).
- Unsafe override required: No
- Qualification impact: None expected
- Rollback path: revert this PR.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md` — it is generated by
release-please from my Conventional Commit PR title (a CI guard enforces
this)

## Screenshots (if applicable)

N/A

## Additional Notes

Produced with AI assistance (Claude Code) operated by me (HetCreep); the
reproduction was run on my machine against a clone of the repository.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-11-04 23:19:58 -06:00

199 lines
6.7 KiB
Python

"""Tests for headroom.update_check (PyPI probe, cache, banner notice)."""
from __future__ import annotations
import json
import time
import pytest
from headroom import update_check as uc
@pytest.fixture(autouse=True)
def _workspace(tmp_path, monkeypatch):
"""Point the workspace (cache) dir at a tmp dir and enable the check."""
monkeypatch.setenv("HEADROOM_WORKSPACE_DIR", str(tmp_path))
monkeypatch.setenv("HEADROOM_UPDATE_CHECK", "on")
monkeypatch.delenv("HEADROOM_STATELESS", raising=False)
monkeypatch.delenv("CI", raising=False)
# Treat tests as a non-checkout, non-docker install by default.
monkeypatch.setattr(uc, "_is_source_checkout", lambda: False)
monkeypatch.setattr(uc, "_in_docker", lambda: False)
return tmp_path
# --------------------------------------------------------------------------- #
# enable gate
# --------------------------------------------------------------------------- #
def test_enabled_by_default(monkeypatch):
assert uc.is_update_check_enabled() is True
@pytest.mark.parametrize("val", ["off", "false", "0", "no", "disabled"])
def test_disabled_by_env(monkeypatch, val):
monkeypatch.setenv("HEADROOM_UPDATE_CHECK", val)
assert uc.is_update_check_enabled() is False
def test_disabled_in_stateless(monkeypatch):
monkeypatch.setenv("HEADROOM_STATELESS", "1")
assert uc.is_update_check_enabled() is False
def test_disabled_in_ci(monkeypatch):
monkeypatch.setenv("CI", "true")
assert uc.is_update_check_enabled() is False
# --------------------------------------------------------------------------- #
# _select_latest
# --------------------------------------------------------------------------- #
def test_select_latest_picks_max_stable():
data = {"releases": {"0.25.0": [{}], "0.26.0": [{}], "0.27.0rc1": [{}]}}
assert uc._select_latest(data, allow_pre=False) == "0.26.0"
def test_select_latest_allows_pre():
data = {"releases": {"0.26.0": [{}], "0.27.0rc1": [{}]}}
assert uc._select_latest(data, allow_pre=True) == "0.27.0rc1"
def test_select_latest_skips_fully_yanked():
data = {
"releases": {
"0.26.0": [{"yanked": False}],
"0.27.0": [{"yanked": True}],
}
}
assert uc._select_latest(data, allow_pre=False) == "0.26.0"
def test_select_latest_skips_release_with_no_files():
data = {"releases": {"1.0.0": [{"yanked": False}], "9.9.9": []}}
assert uc._select_latest(data, allow_pre=False) == "1.0.0"
def test_select_latest_no_fallback_when_every_release_is_unavailable():
data = {"releases": {"9.9.9": []}, "info": {"version": "9.9.9"}}
assert uc._select_latest(data, allow_pre=False) is None
data = {"releases": {"9.9.9": [{"yanked": True}]}, "info": {"version": "9.9.9"}}
assert uc._select_latest(data, allow_pre=False) is None
def test_select_latest_falls_back_to_info_version():
data = {"releases": {}, "info": {"version": "0.26.0"}}
assert uc._select_latest(data, allow_pre=False) == "0.26.0"
# --------------------------------------------------------------------------- #
# fetch_latest_version
# --------------------------------------------------------------------------- #
def test_fetch_latest_version_parses(monkeypatch):
payload = json.dumps({"releases": {"0.26.0": [{}], "0.27.0": [{}]}}).encode()
class _Resp:
def __enter__(self):
return self
def __exit__(self, *a):
return False
def read(self):
return payload
monkeypatch.setattr(uc.urllib.request, "urlopen", lambda *a, **k: _Resp())
assert uc.fetch_latest_version() == "0.27.0"
def test_fetch_latest_version_network_error_returns_none(monkeypatch):
def _boom(*a, **k):
raise OSError("no network")
monkeypatch.setattr(uc.urllib.request, "urlopen", _boom)
assert uc.fetch_latest_version() is None
# --------------------------------------------------------------------------- #
# cache + should_check
# --------------------------------------------------------------------------- #
def test_cache_roundtrip():
uc.write_cache("0.27.0", now=1000.0)
cache = uc.read_cache()
assert cache["latest_version"] == "0.27.0"
assert cache["last_check"] == 1000.0
def test_should_check_true_when_no_cache():
assert uc.should_check() is True
def test_should_check_false_when_fresh():
now = time.time()
uc.write_cache("0.27.0", now=now)
assert uc.should_check(now=now + 10) is False
def test_should_check_true_when_stale():
now = time.time()
uc.write_cache("0.27.0", now=now)
assert uc.should_check(now=now + uc._CHECK_TTL_SECONDS + 1) is True
# --------------------------------------------------------------------------- #
# format_update_notice
# --------------------------------------------------------------------------- #
def test_notice_when_newer(monkeypatch):
uc.write_cache("0.27.0")
monkeypatch.setattr(uc, "installed_version", lambda: "0.26.0")
notice = uc.format_update_notice()
assert notice and "0.27.0" in notice and "headroom update" in notice
def test_no_notice_when_current(monkeypatch):
uc.write_cache("0.26.0")
monkeypatch.setattr(uc, "installed_version", lambda: "0.26.0")
assert uc.format_update_notice() is None
def test_no_notice_in_checkout(monkeypatch):
uc.write_cache("0.27.0")
monkeypatch.setattr(uc, "installed_version", lambda: "0.26.0")
monkeypatch.setattr(uc, "_is_source_checkout", lambda: True)
assert uc.format_update_notice() is None
def test_no_notice_when_disabled(monkeypatch):
uc.write_cache("0.27.0")
monkeypatch.setattr(uc, "installed_version", lambda: "0.26.0")
monkeypatch.setenv("HEADROOM_UPDATE_CHECK", "off")
assert uc.format_update_notice() is None
def test_no_notice_when_version_unknown(monkeypatch):
uc.write_cache("0.27.0")
monkeypatch.setattr(uc, "installed_version", lambda: None)
assert uc.format_update_notice() is None
# --------------------------------------------------------------------------- #
# maybe_check_async
# --------------------------------------------------------------------------- #
def test_maybe_check_async_writes_cache(monkeypatch):
monkeypatch.setattr(uc, "fetch_latest_version", lambda **k: "0.27.0")
thread = uc.maybe_check_async()
assert thread is not None
thread.join(timeout=5)
assert uc.read_cache()["latest_version"] == "0.27.0"
def test_maybe_check_async_skips_in_checkout(monkeypatch):
monkeypatch.setattr(uc, "_is_source_checkout", lambda: True)
assert uc.maybe_check_async() is None
def test_maybe_check_async_skips_when_fresh(monkeypatch):
uc.write_cache("0.27.0")
monkeypatch.setattr(uc, "fetch_latest_version", lambda **k: pytest.fail("should not fetch"))
assert uc.maybe_check_async() is None