Files
bambuddy/backend/tests/integration/test_updates_api.py
maziggy 25a23eadd7 fix(updates): switch Windows installer installs to release-asset update flow
In-app "Install Update" on Windows installer installs failed with "Could
  not find git executable" because (1) _find_executable's fallback paths
  are Unix-only, and (2) the installer stages backend/ via shutil.copytree
  so there is no .git directory — even with Git for Windows installed, the
  fetch would die on "not a git repository". Adding Windows paths would
  only have changed which error users saw.

  Switches the Windows installer path to a fourth update_method
  ("windows_installer") that mirrors the existing docker / ha_addon
  branches — surface a link to the release .exe and let the user re-run
  the installer, matching the Discord / Spotify Windows update model.

  Backend:
  - New _is_windows_installer_install() — true iff sys.platform == "win32"
    AND no .git in app_dir, so Windows devs with a real git clone keep
    the git path.
  - New _find_windows_installer_asset() picks the matching release asset
    (prefers versioned bambuddy-<ver>-windows-x64-setup.exe, falls back
    to the unversioned alias on non-daily tags).
  - /updates/check now returns is_windows_installer / update_method /
    installer_download_url.
  - /updates/apply short-circuits with a friendly message after the
    existing HA / Docker guards — defense in depth, the frontend swaps
    the button so the POST should not fire on Windows.

  Frontend:
  - UpdateCheckResult extended with the new fields and 'windows_installer'
    in the update_method union.
  - SettingsPage renders a Bambu-green styled <a target="_blank"
    rel="noopener"> between the Docker snippet and the in-app Update
    button, with installer_download_url falling back to release_url then
    the tag page so the link is never broken.
  - applyUpdateMutation onSuccess toast guard extended to treat
    is_windows_installer the same as HA / Docker.
2026-06-21 10:25:57 +02:00

781 lines
34 KiB
Python

"""Integration tests for Updates API endpoints."""
from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from httpx import AsyncClient
class TestUpdatesAPI:
@pytest.mark.asyncio
async def test_get_version(self, async_client: AsyncClient):
response = await async_client.get("/api/v1/updates/version")
assert response.status_code == 200
@pytest.mark.asyncio
async def test_apply_update_docker_rejection(self, async_client: AsyncClient):
with (
patch("backend.app.api.routes.updates._is_ha_addon", return_value=False),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=True),
):
response = await async_client.post("/api/v1/updates/apply")
result = response.json()
assert result["success"] is False
assert result["is_docker"] is True
assert result.get("is_ha_addon") is not True
# Docker message tells the user to docker compose, not HA.
assert "Docker Compose" in result["message"]
@pytest.mark.asyncio
async def test_apply_update_ha_addon_rejection(self, async_client: AsyncClient):
"""HA addons are also Docker, so the route must check HA first and
return the HA-specific message — otherwise users see "run docker
compose" advice they can't follow."""
with (
patch("backend.app.api.routes.updates._is_ha_addon", return_value=True),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=True),
):
response = await async_client.post("/api/v1/updates/apply")
result = response.json()
assert result["success"] is False
assert result["is_ha_addon"] is True
assert result["is_docker"] is True
assert "Home Assistant" in result["message"]
assert "Docker Compose" not in result["message"]
@pytest.mark.asyncio
async def test_apply_update_non_docker(self, async_client: AsyncClient):
"""Test non-Docker path - mock _perform_update + _discover_target_release
to prevent side effects (network call to GitHub releases API + actual
git/pip subprocesses)."""
with (
patch("backend.app.api.routes.updates._is_ha_addon", return_value=False),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=False),
patch(
"backend.app.api.routes.updates._discover_target_release",
new_callable=AsyncMock,
return_value="v9.9.9",
),
patch("backend.app.api.routes.updates._perform_update", new_callable=AsyncMock),
):
response = await async_client.post("/api/v1/updates/apply")
assert response.json()["success"] is True
def test_is_docker_with_dockerenv(self):
from backend.app.api.routes.updates import _is_docker_environment
with patch("os.path.exists", return_value=True):
assert _is_docker_environment() is True
def test_is_ha_addon_detects_supervisor_token(self):
"""HA Supervisor sets SUPERVISOR_TOKEN on every addon container.
That env-var alone is the canonical HA-addon signal."""
from backend.app.api.routes.updates import _is_ha_addon
with patch.dict("os.environ", {"SUPERVISOR_TOKEN": "abc123"}, clear=False):
assert _is_ha_addon() is True
def test_is_ha_addon_false_outside_supervisor(self):
from backend.app.api.routes.updates import _is_ha_addon
with patch.dict("os.environ", {}, clear=True):
assert _is_ha_addon() is False
def test_is_ha_addon_empty_token_treated_as_unset(self):
"""An empty string is not a real token — guard against shells that
export the variable empty."""
from backend.app.api.routes.updates import _is_ha_addon
with patch.dict("os.environ", {"SUPERVISOR_TOKEN": ""}, clear=False):
assert _is_ha_addon() is False
@pytest.mark.asyncio
async def test_check_returns_ha_addon_flag_and_method(self, async_client: AsyncClient):
"""`/updates/check` must surface the deployment shape so the frontend
can pick the right CTA. HA must take precedence over Docker because
HA addons run *inside* a Docker container — checking docker first
would mis-classify them."""
import httpx as _httpx
fake_release = {
"tag_name": "v999.9.9",
"name": "Far Future Release",
"body": "",
"html_url": "https://example.invalid/r",
"published_at": "2099-01-01T00:00:00Z",
}
class _Resp:
status_code = 200
def raise_for_status(self):
return None
def json(self):
return [fake_release]
class _FakeClient:
async def __aenter__(self):
return self
async def __aexit__(self, *_):
return None
async def get(self, *_, **__):
return _Resp()
with (
patch.object(_httpx, "AsyncClient", _FakeClient),
patch("backend.app.api.routes.updates._is_ha_addon", return_value=True),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=True),
):
response = await async_client.get("/api/v1/updates/check")
body = response.json()
assert body["is_ha_addon"] is True
assert body["update_method"] == "ha_addon"
# is_docker is preserved alongside so older frontend bundles still
# hit a managed-deployment branch (degrades to Docker UX) instead of
# rendering the in-app Install button.
assert body["is_docker"] is True
@pytest.mark.asyncio
async def test_check_docker_only_returns_docker_method(self, async_client: AsyncClient):
import httpx as _httpx
fake_release = {
"tag_name": "v999.9.9",
"name": "Far Future Release",
"body": "",
"html_url": "https://example.invalid/r",
"published_at": "2099-01-01T00:00:00Z",
}
class _Resp:
status_code = 200
def raise_for_status(self):
return None
def json(self):
return [fake_release]
class _FakeClient:
async def __aenter__(self):
return self
async def __aexit__(self, *_):
return None
async def get(self, *_, **__):
return _Resp()
with (
patch.object(_httpx, "AsyncClient", _FakeClient),
patch("backend.app.api.routes.updates._is_ha_addon", return_value=False),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=True),
):
response = await async_client.get("/api/v1/updates/check")
body = response.json()
assert body["is_ha_addon"] is False
assert body["is_docker"] is True
assert body["update_method"] == "docker"
@pytest.mark.asyncio
async def test_check_backs_off_after_github_rate_limit(self, async_client: AsyncClient):
"""#1420: once GitHub returns 403 with X-RateLimit-Remaining=0, the
next call must short-circuit on the backoff window instead of hitting
api.github.com again. Otherwise the user's logs flood with rate-limit
errors and Bambuddy keeps adding to whatever throttle GitHub applies."""
import time
import httpx as _httpx
import backend.app.api.routes.updates as updates_module
# Reset module-level backoff state between tests.
updates_module._github_rate_limit_until = 0.0
# Future reset time, ~10 minutes ahead — the backoff window we expect.
future_reset = time.time() + 600
class _RateLimitedResp:
status_code = 403
headers = {
"X-RateLimit-Remaining": "0",
"X-RateLimit-Reset": str(int(future_reset)),
}
text = "API rate limit exceeded"
def raise_for_status(self):
raise _httpx.HTTPStatusError("403", request=None, response=self)
def json(self):
return {"message": "API rate limit exceeded"}
call_counter = {"n": 0}
class _FakeClient:
async def __aenter__(self):
return self
async def __aexit__(self, *_):
return None
async def get(self, *_, **__):
call_counter["n"] += 1
return _RateLimitedResp()
try:
with patch.object(_httpx, "AsyncClient", _FakeClient):
first = await async_client.get("/api/v1/updates/check")
second = await async_client.get("/api/v1/updates/check")
finally:
updates_module._github_rate_limit_until = 0.0
# First request reached httpx; second short-circuited on the backoff.
assert call_counter["n"] == 1
first_body = first.json()
second_body = second.json()
assert "rate limit" in (first_body.get("error") or "").lower()
assert "rate limit" in (second_body.get("error") or "").lower()
# Backoff window roughly matches the X-RateLimit-Reset header.
assert second_body.get("retry_after_seconds", 0) > 0
def test_parse_version(self):
from backend.app.api.routes.updates import parse_version
assert parse_version("0.1.5")[:3] == (0, 1, 5)
def test_is_newer_version(self):
from backend.app.api.routes.updates import is_newer_version
assert is_newer_version("0.1.5", "0.1.5b7") is True
def test_parse_github_remote_recognises_ssh_https_and_dotgit(self):
"""`_parse_github_remote` must accept the four canonical forms `git
remote -v` prints; anything else returns None so callers can treat
it as 'reset to expected URL'."""
from backend.app.api.routes.updates import _parse_github_remote
assert _parse_github_remote("git@github.com:maziggy/bambuddy.git") == (
"maziggy",
"bambuddy",
)
assert _parse_github_remote("git@github.com:maziggy/bambuddy") == (
"maziggy",
"bambuddy",
)
assert _parse_github_remote("https://github.com/maziggy/bambuddy.git") == (
"maziggy",
"bambuddy",
)
assert _parse_github_remote("https://github.com/maziggy/bambuddy") == (
"maziggy",
"bambuddy",
)
# Non-GitHub host → None (we don't claim ownership over arbitrary
# forge URLs).
assert _parse_github_remote("git@gitlab.com:maziggy/bambuddy.git") is None
# Empty / malformed → None.
assert _parse_github_remote("") is None
assert _parse_github_remote("not-a-url") is None
assert _parse_github_remote("https://github.com/maziggy") is None # no /repo
@pytest.mark.asyncio
async def test_perform_update_preserves_ssh_origin_when_pointing_at_correct_repo(self, tmp_path):
"""Regression for the developer-checkout footgun: if origin already
points at github.com/maziggy/bambuddy via SSH, the updater must
leave it alone instead of clobbering it with HTTPS. Pre-fix, every
Apply Update click rewrote `git@github.com:...` to `https://...`,
breaking subsequent `git push` for any developer testing the
upgrade flow against their own checkout."""
from backend.app.api.routes import updates as updates_module
app_dir = tmp_path / "app"
data_dir = tmp_path / "app" / "data"
app_dir.mkdir()
data_dir.mkdir()
(app_dir / "requirements.txt").write_text("fastapi\n")
calls: list[dict] = []
async def fake_create_subprocess_exec(*args, **kwargs):
calls.append({"args": args, "cwd": kwargs.get("cwd")})
proc = MagicMock()
# When the updater asks `git remote get-url origin`, return the
# SSH URL. Every other subprocess returns successfully with no
# output.
if "get-url" in args and "origin" in args:
proc.communicate = AsyncMock(return_value=(b"git@github.com:maziggy/bambuddy.git\n", b""))
else:
proc.communicate = AsyncMock(return_value=(b"", b""))
proc.returncode = 0
return proc
with (
patch.object(updates_module.settings, "base_dir", data_dir),
patch.object(updates_module.settings, "app_dir", app_dir),
patch.object(updates_module, "_find_executable", return_value="/usr/bin/git"),
patch.object(
updates_module.asyncio,
"create_subprocess_exec",
side_effect=fake_create_subprocess_exec,
),
):
await updates_module._perform_update("v0.2.4b1")
# The updater MUST NOT have run `git remote set-url origin <https>`
# because origin already pointed at the right repo over SSH.
set_url_calls = [c for c in calls if "set-url" in c["args"] and "origin" in c["args"]]
assert not set_url_calls, (
"Updater clobbered an SSH origin pointing at the correct repo. "
"Captured set-url calls: " + repr([c["args"] for c in set_url_calls])
)
@pytest.mark.asyncio
async def test_perform_update_resets_origin_when_pointing_elsewhere(self, tmp_path):
"""Defensive: if origin points at a fork or unrelated repo (or is
missing), the updater should still rewrite it to the canonical
HTTPS URL so subsequent fetch / reset works against the right
repo. This is the original behaviour that the SSH-preservation
fix above must NOT regress."""
from backend.app.api.routes import updates as updates_module
from backend.app.core.config import GITHUB_REPO
app_dir = tmp_path / "app"
data_dir = tmp_path / "app" / "data"
app_dir.mkdir()
data_dir.mkdir()
(app_dir / "requirements.txt").write_text("fastapi\n")
calls: list[dict] = []
async def fake_create_subprocess_exec(*args, **kwargs):
calls.append({"args": args, "cwd": kwargs.get("cwd")})
proc = MagicMock()
# origin is set to a fork — must be rewritten.
if "get-url" in args and "origin" in args:
proc.communicate = AsyncMock(return_value=(b"git@github.com:somefork/bambuddy.git\n", b""))
else:
proc.communicate = AsyncMock(return_value=(b"", b""))
proc.returncode = 0
return proc
with (
patch.object(updates_module.settings, "base_dir", data_dir),
patch.object(updates_module.settings, "app_dir", app_dir),
patch.object(updates_module, "_find_executable", return_value="/usr/bin/git"),
patch.object(
updates_module.asyncio,
"create_subprocess_exec",
side_effect=fake_create_subprocess_exec,
),
):
await updates_module._perform_update("v0.2.4b1")
set_url_calls = [c for c in calls if "set-url" in c["args"] and "origin" in c["args"]]
assert set_url_calls, "Updater must rewrite origin when it points at a fork."
rewritten_to = set_url_calls[0]["args"][-1]
assert rewritten_to == f"https://github.com/{GITHUB_REPO}.git", (
f"Expected origin to be reset to canonical HTTPS URL; got: {rewritten_to}"
)
@pytest.mark.asyncio
async def test_perform_update_resets_to_target_ref_not_hardcoded_main(self, tmp_path):
"""Regression for the hardcoded-`origin/main` limitation: the in-app
updater must reset to the caller-supplied target ref (typically a
release tag like `v0.2.4b1` discovered from the GitHub releases API)
so beta releases that don't live on main can actually be installed.
Pre-fix, `_perform_update` issued `git reset --hard origin/main`
verbatim and silently no-op'd whenever the latest release wasn't on
main — leaving a 0.2.3.x user clicking *Apply Update* stranded on
0.2.3.x. Also asserts the fetch step uses `--tags` so a tag ref is
actually resolvable post-fetch."""
from backend.app.api.routes import updates as updates_module
app_dir = tmp_path / "app"
data_dir = tmp_path / "app" / "data"
app_dir.mkdir()
data_dir.mkdir()
(app_dir / "requirements.txt").write_text("fastapi\n")
calls: list[dict] = []
async def fake_create_subprocess_exec(*args, **kwargs):
calls.append({"args": args, "cwd": kwargs.get("cwd")})
proc = MagicMock()
if "get-url" in args and "origin" in args:
proc.communicate = AsyncMock(return_value=(b"git@github.com:maziggy/bambuddy.git\n", b""))
else:
proc.communicate = AsyncMock(return_value=(b"", b""))
proc.returncode = 0
return proc
with (
patch.object(updates_module.settings, "base_dir", data_dir),
patch.object(updates_module.settings, "app_dir", app_dir),
patch.object(updates_module, "_find_executable", return_value="/usr/bin/git"),
patch.object(
updates_module.asyncio,
"create_subprocess_exec",
side_effect=fake_create_subprocess_exec,
),
):
await updates_module._perform_update("v0.2.4b1")
# Reset target must be the caller-supplied ref, not "origin/main".
reset_calls = [c for c in calls if "reset" in c["args"] and "--hard" in c["args"]]
assert reset_calls, "git reset must be invoked"
reset_target = reset_calls[0]["args"][-1]
assert reset_target == "v0.2.4b1", (
f"Expected reset target to be the caller-supplied ref 'v0.2.4b1'; "
f"got {reset_target!r}. Regression to a hardcoded 'origin/main' "
"would re-introduce the in-app-updater-can't-install-betas bug."
)
# Fetch must include --tags so v0.2.4b1 (a tag) is locally resolvable.
fetch_calls = [c for c in calls if "fetch" in c["args"]]
assert fetch_calls
assert "--tags" in fetch_calls[0]["args"], (
"Fetch must use --tags so release-tag refs (the production path "
"for tag-based updates) are resolvable for the subsequent reset. "
f"Captured fetch call: {fetch_calls[0]['args']}"
)
# Fetch must include --force so a re-pointed tag on the remote
# (common after re-tagging a release post-release-notes edit) doesn't
# surface as "Failed to fetch updates" to the user just because their
# local copy of the moved tag would be clobbered. The relevant target
# ref is fetched fine; we only want git's tag-clobber to be silent.
assert "--force" in fetch_calls[0]["args"], (
"Fetch must use --force so re-pointed tags on the remote don't "
"fail the whole fetch (the rest of the refs update cleanly). "
f"Captured fetch call: {fetch_calls[0]['args']}"
)
@pytest.mark.asyncio
async def test_apply_update_passes_discovered_release_to_perform_update(self, async_client: AsyncClient):
"""End-to-end glue: the route handler calls `_discover_target_release`
to pick the tag (respecting include_beta_updates), then schedules
`_perform_update` with that tag — not with no arg, not with main."""
from backend.app.api.routes import updates as updates_module
captured_ref: list[str] = []
async def fake_perform_update(target_ref):
captured_ref.append(target_ref)
async def fake_discover(_db):
return "v0.2.4b1"
with (
patch.object(updates_module, "_is_ha_addon", return_value=False),
patch.object(updates_module, "_is_docker_environment", return_value=False),
patch.object(updates_module, "_perform_update", side_effect=fake_perform_update),
patch.object(updates_module, "_discover_target_release", side_effect=fake_discover),
):
response = await async_client.post("/api/v1/updates/apply")
assert response.json()["success"] is True
assert captured_ref == ["v0.2.4b1"], (
f"apply_update must pass the discovered tag to _perform_update; captured invocations: {captured_ref}"
)
@pytest.mark.asyncio
async def test_apply_update_returns_clear_error_when_no_release_resolves(self, async_client: AsyncClient):
"""If GitHub is unreachable or no release matches the user's channel,
the route returns a useful error instead of silently kicking off an
update that can't possibly land. Avoids the previous failure mode
where in-app update appeared to succeed but did nothing."""
from backend.app.api.routes import updates as updates_module
async def fake_discover(_db):
return None
# The route guards against a concurrent update via the module-global
# `_update_status` — reset it so a previous test that left the status
# mid-flight doesn't short-circuit this one.
updates_module._update_status = {"status": "idle", "progress": 0, "message": "", "error": None}
with (
patch.object(updates_module, "_is_ha_addon", return_value=False),
patch.object(updates_module, "_is_docker_environment", return_value=False),
patch.object(updates_module, "_discover_target_release", side_effect=fake_discover),
):
response = await async_client.post("/api/v1/updates/apply")
body = response.json()
assert body["success"] is False
assert "release" in body["message"].lower()
@pytest.mark.asyncio
async def test_perform_update_runs_pip_in_app_dir_not_data_dir(self, tmp_path):
"""Native install: `requirements.txt` lives at INSTALL_PATH (the source-
code dir), NOT at DATA_DIR (where systemd sets DATA_DIR=INSTALL_PATH/data).
Pre-fix, the updater ran `pip install -r requirements.txt` with
`cwd=settings.base_dir`, which on a native install resolves to the data
dir — `requirements.txt` isn't there and pip fails with `Could not open
requirements file`. The fix: pip's cwd is `settings.app_dir` (the source
tree) so it can actually find the file.
This test mocks every subprocess so it can capture the cwd of each call
and assert that the pip step runs in app_dir while git steps continue
to run in base_dir (their existing behaviour — git walks up to find
`.git` so that path keeps working)."""
from backend.app.api.routes import updates as updates_module
# Set up fake install layout: app_dir has requirements.txt, data_dir is
# a sibling (mirroring `INSTALL_PATH=/opt/bambuddy`, `DATA_DIR=/opt/bambuddy/data`).
app_dir = tmp_path / "app"
data_dir = tmp_path / "app" / "data"
app_dir.mkdir()
data_dir.mkdir()
(app_dir / "requirements.txt").write_text("fastapi\n")
# Capture every subprocess call's cwd + the executable token.
calls: list[dict] = []
async def fake_create_subprocess_exec(*args, **kwargs):
calls.append({"args": args, "cwd": kwargs.get("cwd")})
proc = MagicMock()
proc.communicate = AsyncMock(return_value=(b"", b""))
proc.returncode = 0
return proc
with (
patch.object(updates_module.settings, "base_dir", data_dir),
patch.object(updates_module.settings, "app_dir", app_dir),
patch.object(updates_module, "_find_executable", return_value="/usr/bin/git"),
patch.object(
updates_module.asyncio,
"create_subprocess_exec",
side_effect=fake_create_subprocess_exec,
),
):
await updates_module._perform_update("v0.2.4b1")
# Find the pip invocation (sys.executable + "-m" + "pip" + "install").
pip_calls = [c for c in calls if "pip" in c["args"] and "install" in c["args"]]
assert pip_calls, "pip install was never invoked. Captured: " + repr([c["args"] for c in calls])
pip_cwd = pip_calls[0]["cwd"]
assert pip_cwd == str(app_dir), (
f"pip install must run in app_dir ({app_dir}) so it finds "
f"requirements.txt; got cwd={pip_cwd}. Regression to base_dir "
f"breaks every native-install upgrade."
)
# Sanity check: the requirements.txt that pip would read actually exists
# at the captured cwd. If this fails the cwd is wrong even if it isn't
# base_dir — useful diagnostic if someone refactors path handling.
assert (Path(pip_cwd) / "requirements.txt").exists()
@pytest.mark.asyncio
async def test_perform_update_runs_git_in_app_dir_when_data_dir_on_separate_mount(self, tmp_path):
"""Regression for #1715: when DATA_DIR is on a path separate from the
install (e.g. WorkingDirectory=/opt/bambuddy + DATA_DIR=/srv/bambuddy/data),
``base_dir`` and the repo working tree are on different mounts. Pre-fix,
every git subprocess (`remote get-url`, `remote set-url`, `fetch`,
`reset --hard`) used ``cwd=base_dir`` — and git could no longer walk up
to find ``.git`` because the data dir is not a subdir of the repo.
Every update failed with "not a git repository". The fix routes every
git step (and the embedded ``safe.directory`` config) through
``app_dir`` instead. This test pins the cwd of all four git steps so a
future refactor that re-introduces ``base_dir`` for any of them surfaces
loudly here instead of silently re-breaking native installs."""
from backend.app.api.routes import updates as updates_module
# Separate-mount layout: app_dir and data_dir are SIBLINGS, not parent/
# child. base_dir is not under app_dir, so git cannot walk up.
app_dir = tmp_path / "opt" / "bambuddy"
data_dir = tmp_path / "srv" / "bambuddy" / "data"
app_dir.mkdir(parents=True)
data_dir.mkdir(parents=True)
(app_dir / "requirements.txt").write_text("fastapi\n")
calls: list[dict] = []
async def fake_create_subprocess_exec(*args, **kwargs):
calls.append({"args": args, "cwd": kwargs.get("cwd")})
proc = MagicMock()
if "get-url" in args and "origin" in args:
proc.communicate = AsyncMock(return_value=(b"git@github.com:maziggy/bambuddy.git\n", b""))
else:
proc.communicate = AsyncMock(return_value=(b"", b""))
proc.returncode = 0
return proc
with (
patch.object(updates_module.settings, "base_dir", data_dir),
patch.object(updates_module.settings, "app_dir", app_dir),
patch.object(updates_module, "_find_executable", return_value="/usr/bin/git"),
patch.object(
updates_module.asyncio,
"create_subprocess_exec",
side_effect=fake_create_subprocess_exec,
),
):
await updates_module._perform_update("v0.2.4b1")
# Every git subprocess must run in app_dir (the working tree). A
# regression to base_dir would silently break #1715-class installs.
git_calls = [c for c in calls if c["args"] and c["args"][0] == "/usr/bin/git"]
assert git_calls, "no git subprocess was invoked; setup is wrong"
wrong_cwd = [c for c in git_calls if c["cwd"] != str(app_dir)]
assert not wrong_cwd, (
"git subprocess ran with cwd != app_dir; #1715 would resurface. "
f"Offending calls: {[(c['args'][1:5], c['cwd']) for c in wrong_cwd]}"
)
# ``safe.directory`` must equal app_dir (the repo root git discovers),
# not the data dir — otherwise git refuses with "dubious ownership"
# even when the cwd is technically correct.
safe_dir_configs = [
arg for c in git_calls for arg in c["args"] if isinstance(arg, str) and arg.startswith("safe.directory=")
]
assert safe_dir_configs, "safe.directory config was never set on git calls"
assert all(s == f"safe.directory={app_dir}" for s in safe_dir_configs), (
f"safe.directory must point at app_dir ({app_dir}); got {safe_dir_configs}"
)
# --- Windows installer update_method ---
# The Inno-Setup installer stages backend source via ``copytree`` (no
# ``.git``) and does not bundle ``git.exe``. The git-fetch update path
# therefore can't run on those installs — surface a distinct
# ``update_method`` and a release-asset download link instead.
def test_is_windows_installer_install_true_when_no_dot_git(self, tmp_path: Path):
from backend.app.api.routes import updates as updates_module
with (
patch.object(updates_module.sys, "platform", "win32"),
patch.object(updates_module.settings, "app_dir", tmp_path),
):
assert updates_module._is_windows_installer_install() is True
def test_is_windows_installer_install_false_on_dev_checkout(self, tmp_path: Path):
"""A Windows developer with a real ``git clone`` keeps the git path."""
from backend.app.api.routes import updates as updates_module
(tmp_path / ".git").mkdir()
with (
patch.object(updates_module.sys, "platform", "win32"),
patch.object(updates_module.settings, "app_dir", tmp_path),
):
assert updates_module._is_windows_installer_install() is False
def test_is_windows_installer_install_false_off_windows(self, tmp_path: Path):
from backend.app.api.routes import updates as updates_module
with (
patch.object(updates_module.sys, "platform", "linux"),
patch.object(updates_module.settings, "app_dir", tmp_path),
):
assert updates_module._is_windows_installer_install() is False
def test_find_windows_installer_asset_prefers_versioned(self):
from backend.app.api.routes.updates import _find_windows_installer_asset
release = {
"assets": [
{"name": "bambuddy-0.2.5b1-windows-x64-setup.exe", "browser_download_url": "https://x/v.exe"},
{"name": "bambuddy-windows-x64-setup.exe", "browser_download_url": "https://x/alias.exe"},
{"name": "checksums.txt", "browser_download_url": "https://x/c.txt"},
],
}
assert _find_windows_installer_asset(release) == "https://x/v.exe"
def test_find_windows_installer_asset_falls_back_to_alias(self):
from backend.app.api.routes.updates import _find_windows_installer_asset
release = {
"assets": [
{"name": "bambuddy-windows-x64-setup.exe", "browser_download_url": "https://x/alias.exe"},
],
}
assert _find_windows_installer_asset(release) == "https://x/alias.exe"
def test_find_windows_installer_asset_none_when_missing(self):
from backend.app.api.routes.updates import _find_windows_installer_asset
assert _find_windows_installer_asset({"assets": []}) is None
assert _find_windows_installer_asset({}) is None
@pytest.mark.asyncio
async def test_apply_update_windows_installer_rejection(self, async_client: AsyncClient):
"""Direct POST /apply on a Windows-installer install must be rejected
with a friendly message — the git path would error out with "git not
found" (or worse, "not a git repository") if it ran."""
with (
patch("backend.app.api.routes.updates._is_ha_addon", return_value=False),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=False),
patch(
"backend.app.api.routes.updates._is_windows_installer_install",
return_value=True,
),
):
response = await async_client.post("/api/v1/updates/apply")
result = response.json()
assert result["success"] is False
assert result["is_windows_installer"] is True
assert "installer" in result["message"].lower()
@pytest.mark.asyncio
async def test_check_windows_installer_returns_method_and_url(self, async_client: AsyncClient):
"""/updates/check must surface update_method=windows_installer plus
the installer .exe URL so the frontend can render a Download button
instead of the in-app Install button."""
import httpx as _httpx
fake_release = {
# Non-prerelease tag — beta-channel filter defaults to off, so a
# `b1` suffix would be skipped and the route would return
# "No releases found" before reaching update_method.
"tag_name": "v999.9.9",
"name": "v999.9.9",
"body": "",
"html_url": "https://github.com/maziggy/bambuddy/releases/tag/v999.9.9",
"published_at": "2099-01-01T00:00:00Z",
"assets": [
{
"name": "bambuddy-999.9.9-windows-x64-setup.exe",
"browser_download_url": "https://github.com/maziggy/bambuddy/releases/download/v999.9.9/bambuddy-999.9.9-windows-x64-setup.exe",
},
],
}
class _Resp:
status_code = 200
def raise_for_status(self):
return None
def json(self):
return [fake_release]
class _FakeClient:
async def __aenter__(self):
return self
async def __aexit__(self, *_):
return None
async def get(self, *_, **__):
return _Resp()
with (
patch.object(_httpx, "AsyncClient", _FakeClient),
patch("backend.app.api.routes.updates._is_ha_addon", return_value=False),
patch("backend.app.api.routes.updates._is_docker_environment", return_value=False),
patch(
"backend.app.api.routes.updates._is_windows_installer_install",
return_value=True,
),
):
response = await async_client.get("/api/v1/updates/check")
body = response.json()
assert "update_method" in body, f"unexpected response shape: {body}"
assert body["update_method"] == "windows_installer"
assert body["is_windows_installer"] is True
assert body["installer_download_url"].endswith("bambuddy-999.9.9-windows-x64-setup.exe")