现象:网页触发同步报 "EOF when reading a line"。 原因:garth 的默认 MFA 提示是 input(),向 stdin 索取验证码。 gunicorn worker 没有 stdin,于是抛出 EOFError——错误信息本身 完全没提到 MFA,看不出该做什么。 方案:把"输验证码"和"日常同步"拆开。 - 新增 garmin_tokens 表存 garth 令牌(Client.dumps/loads 序列化) - garmin_login.py:在终端里跑一次,可正常输入验证码, 成功后令牌存库 - _connect() 优先加载令牌并 refresh_oauth2(),命中则完全跳过登录, 既不需要密码也不需要验证码(令牌有效期约一年) - 无令牌且密码登录撞上 MFA 时,抛 MFARequired 并给出具体该执行 哪条命令,而不是把 EOFError 原样抛给用户 接口: - GET /api/garmin/auth-status 返回是否已有令牌 - /api/garmin/sync 在已有令牌时不再强制要求密码 前端: - 有令牌时隐藏密码输入框,提示无需密码 - 同步返回 mfaRequired 时,展示需要在 NAS 上执行的具体命令 - 同步请求超时放宽到 180s(一周的天数 + 运动是多次上游调用) - 成功消息补上运动记录条数 tests (test_garmin_sync.py 新增 12 条,共 35): - 令牌存取、覆盖不累积、按用户隔离 - 有令牌时绝不调用 login() - MFA 的 EOFError 转成带操作指引的 MFARequired - 普通 401 不会被误标成 mfaRequired - 无令牌且无密码时给出明确拒绝 NAS 真机: 252 passed Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
411 lines
15 KiB
Python
411 lines
15 KiB
Python
"""
|
|
Unit tests for the Garmin sync service.
|
|
|
|
A stub client stands in for `garminconnect`, so the suite runs without the
|
|
library, without credentials and without touching Garmin.
|
|
|
|
The stub mirrors the real 0.2.8 API shapes on purpose — the original code
|
|
called `get_activities(date)` when that method actually takes `(start, limit)`
|
|
pagination arguments, a mistake that only surfaces once something exercises it.
|
|
"""
|
|
import datetime
|
|
|
|
import pytest
|
|
|
|
from services import garmin as garmin_svc
|
|
from services import health as health_svc
|
|
|
|
|
|
def day(offset=0):
|
|
return (datetime.date.today() - datetime.timedelta(days=offset)).isoformat()
|
|
|
|
|
|
def summary(steps=8000, rhr=60, stress=40, kcal=2200):
|
|
return {
|
|
"totalSteps": steps,
|
|
"restingHeartRate": rhr,
|
|
"averageStressLevel": stress,
|
|
"totalKilocalories": kcal,
|
|
}
|
|
|
|
|
|
def sleep(hours=7.5, score=82):
|
|
return {
|
|
"dailySleepDTO": {
|
|
"sleepTimeSeconds": int(hours * 3600),
|
|
"sleepScores": {"overall": {"value": score}},
|
|
}
|
|
}
|
|
|
|
|
|
def hrv(value=48):
|
|
return {"hrvSummary": {"lastNightAvg": value}}
|
|
|
|
|
|
def activity(activity_id=1001, type_key="running", duration=1800):
|
|
return {
|
|
"activityId": activity_id,
|
|
"activityType": {"typeKey": type_key},
|
|
"startTimeLocal": f"{day()}T07:00:00",
|
|
"duration": duration,
|
|
"distance": 5000.0,
|
|
"calories": 320.0,
|
|
"averageHR": 145,
|
|
"maxHR": 168,
|
|
}
|
|
|
|
|
|
class StubClient:
|
|
"""Stands in for garminconnect.Garmin, recording how it was called."""
|
|
|
|
def __init__(self, summaries=None, sleeps=None, hrvs=None, activities=None,
|
|
fail_days=(), fail_activities=False):
|
|
self._summaries = summaries if summaries is not None else {}
|
|
self._sleeps = sleeps if sleeps is not None else {}
|
|
self._hrvs = hrvs if hrvs is not None else {}
|
|
self._activities = activities if activities is not None else []
|
|
self._fail_days = set(fail_days)
|
|
self._fail_activities = fail_activities
|
|
self.calls = []
|
|
|
|
def get_user_summary(self, cdate):
|
|
self.calls.append(("summary", cdate))
|
|
if cdate in self._fail_days:
|
|
raise RuntimeError(f"upstream error for {cdate}")
|
|
return self._summaries.get(cdate, summary())
|
|
|
|
def get_sleep_data(self, cdate):
|
|
self.calls.append(("sleep", cdate))
|
|
return self._sleeps.get(cdate, sleep())
|
|
|
|
def get_hrv_data(self, cdate):
|
|
self.calls.append(("hrv", cdate))
|
|
return self._hrvs.get(cdate, hrv())
|
|
|
|
def get_activities_by_date(self, startdate, enddate, activitytype=None):
|
|
self.calls.append(("activities", startdate, enddate))
|
|
if self._fail_activities:
|
|
raise RuntimeError("activities endpoint down")
|
|
return self._activities
|
|
|
|
|
|
CREDS = {"garminEmail": "g@example.com", "garminPassword": "pw"}
|
|
|
|
|
|
class TestHappyPath:
|
|
def test_reports_success(self, db, user):
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=3, client=StubClient())
|
|
assert out["status"] == "success"
|
|
assert out["recordsSynced"] == 3
|
|
|
|
def test_stores_the_days(self, db, user):
|
|
garmin_svc.sync_data(user["id"], CREDS, days=3, client=StubClient())
|
|
rows = health_svc.get_summary(user["id"])
|
|
assert len(rows) == 3
|
|
|
|
def test_maps_every_metric(self, db, user):
|
|
client = StubClient(
|
|
summaries={day(): summary(steps=9500, rhr=57, stress=33, kcal=2450)},
|
|
sleeps={day(): sleep(hours=8.0, score=91)},
|
|
hrvs={day(): hrv(52)},
|
|
)
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
row = health_svc.get_summary(user["id"])[0]
|
|
|
|
assert row["steps"] == 9500
|
|
assert row["heartRate"] == 57
|
|
assert row["stress"] == 33
|
|
assert row["caloriesBurned"] == 2450
|
|
assert row["heartRateVariability"] == 52
|
|
assert row["sleep"] == {"duration": 8.0, "quality": 91}
|
|
|
|
def test_sleep_and_hrv_come_from_their_own_endpoints(self, db, user):
|
|
"""Regression: both live outside get_user_summary. Reading only the
|
|
summary recorded every night as having no sleep data."""
|
|
client = StubClient()
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
|
|
kinds = {c[0] for c in client.calls}
|
|
assert "sleep" in kinds
|
|
assert "hrv" in kinds
|
|
|
|
def test_seconds_are_converted_to_hours(self, db, user):
|
|
client = StubClient(sleeps={day(): sleep(hours=6.5)})
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
assert health_svc.get_summary(user["id"])[0]["sleep"]["duration"] == 6.5
|
|
|
|
|
|
class TestActivities:
|
|
def test_fetched_by_date_range_in_one_call(self, db, user):
|
|
"""Regression: the old code called get_activities(date), but that
|
|
method takes (start, limit) pagination arguments, not a date."""
|
|
client = StubClient(activities=[activity()])
|
|
garmin_svc.sync_data(user["id"], CREDS, days=7, client=client)
|
|
|
|
activity_calls = [c for c in client.calls if c[0] == "activities"]
|
|
assert len(activity_calls) == 1, "one range call, not one call per day"
|
|
_, start, end = activity_calls[0]
|
|
assert start == day(6) and end == day(0)
|
|
|
|
def test_stored_with_fields_mapped(self, db, user):
|
|
garmin_svc.sync_data(
|
|
user["id"], CREDS, days=1, client=StubClient(activities=[activity()])
|
|
)
|
|
rows = health_svc.get_activities(user["id"])
|
|
assert len(rows) == 1
|
|
assert rows[0]["activity_type"] == "running"
|
|
assert rows[0]["heart_rate_average"] == 145
|
|
|
|
def test_count_is_reported(self, db, user):
|
|
client = StubClient(activities=[activity(1), activity(2)])
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
assert out["activitiesSynced"] == 2
|
|
|
|
def test_resync_does_not_duplicate(self, db, user):
|
|
"""Garmin activity ids are stable, so a re-synced window must skip
|
|
what is already stored."""
|
|
client = StubClient(activities=[activity(1001)])
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
|
|
assert len(health_svc.get_activities(user["id"])) == 1
|
|
assert out["activitiesSynced"] == 0
|
|
|
|
def test_end_time_derived_from_duration(self, db, user):
|
|
client = StubClient(activities=[activity(duration=1800)])
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
row = health_svc.get_activities(user["id"])[0]
|
|
assert row["start_time"] != row["end_time"]
|
|
|
|
def test_failure_does_not_lose_the_daily_data(self, db, user):
|
|
out = garmin_svc.sync_data(
|
|
user["id"], CREDS, days=2, client=StubClient(fail_activities=True)
|
|
)
|
|
assert out["status"] == "success"
|
|
assert len(health_svc.get_summary(user["id"])) == 2
|
|
|
|
|
|
class TestResync:
|
|
def test_same_day_is_updated_not_duplicated(self, db, user):
|
|
garmin_svc.sync_data(
|
|
user["id"], CREDS, days=1,
|
|
client=StubClient(summaries={day(): summary(steps=5000)}),
|
|
)
|
|
garmin_svc.sync_data(
|
|
user["id"], CREDS, days=1,
|
|
client=StubClient(summaries={day(): summary(steps=9000)}),
|
|
)
|
|
rows = health_svc.get_summary(user["id"])
|
|
assert len(rows) == 1
|
|
assert rows[0]["steps"] == 9000
|
|
|
|
|
|
class TestPartialAndTotalFailure:
|
|
def test_one_bad_day_is_skipped_not_fatal(self, db, user):
|
|
client = StubClient(fail_days=[day(1)])
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=3, client=client)
|
|
|
|
assert out["status"] == "success"
|
|
assert out["recordsSynced"] == 2
|
|
assert "跳过" in out["message"]
|
|
|
|
def test_every_day_failing_is_reported_as_an_error(self, db, user):
|
|
"""A systemic failure reported as a clean success would hide it."""
|
|
client = StubClient(fail_days=[day(0), day(1), day(2)])
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=3, client=client)
|
|
|
|
assert out["status"] == "error"
|
|
assert out["recordsSynced"] == 0
|
|
|
|
def test_login_failure_is_reported(self, db, user, monkeypatch):
|
|
def boom(_creds, _uid=None):
|
|
raise RuntimeError("401 Unauthorized")
|
|
|
|
monkeypatch.setattr(garmin_svc, "_connect", boom)
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=1)
|
|
|
|
assert out["status"] == "error"
|
|
assert "401" in out["message"]
|
|
|
|
def test_days_without_data_are_not_stored(self, db, user):
|
|
"""Garmin returns all-None for a day it has nothing for; an empty row
|
|
would just have to be filtered back out by every read endpoint."""
|
|
client = StubClient(
|
|
summaries={day(): {}}, sleeps={day(): {}}, hrvs={day(): {}}
|
|
)
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=1, client=client)
|
|
assert out["recordsSynced"] == 0
|
|
assert health_svc.get_summary(user["id"]) == []
|
|
|
|
|
|
class TestSyncStatus:
|
|
def test_idle_before_any_sync(self, db, user):
|
|
assert garmin_svc.get_sync_status(user["id"])["status"] == "idle"
|
|
|
|
def test_success_leaves_status_idle(self, db, user):
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=StubClient())
|
|
status = garmin_svc.get_sync_status(user["id"])
|
|
assert status["status"] == "idle"
|
|
assert status["recordsSynced"] == 1
|
|
assert status["lastSyncTime"]
|
|
|
|
def test_total_failure_leaves_status_error(self, db, user):
|
|
garmin_svc.sync_data(
|
|
user["id"], CREDS, days=2, client=StubClient(fail_days=[day(0), day(1)])
|
|
)
|
|
status = garmin_svc.get_sync_status(user["id"])
|
|
assert status["status"] == "error"
|
|
assert status["lastError"]
|
|
|
|
def test_a_later_success_clears_the_error(self, db, user):
|
|
garmin_svc.sync_data(
|
|
user["id"], CREDS, days=1, client=StubClient(fail_days=[day(0)])
|
|
)
|
|
garmin_svc.sync_data(user["id"], CREDS, days=1, client=StubClient())
|
|
status = garmin_svc.get_sync_status(user["id"])
|
|
assert status["status"] == "idle"
|
|
assert not status["lastError"]
|
|
|
|
|
|
class TestEndpoint:
|
|
def test_requires_auth(self, client):
|
|
assert client.post("/api/garmin/sync", json={}).status_code == 401
|
|
|
|
def test_missing_password_is_refused_with_a_reason(self, client, auth):
|
|
r = client.post("/api/garmin/sync", headers=auth, json={})
|
|
assert r.status_code == 400
|
|
assert "garminPassword" in r.get_json()["message"]
|
|
|
|
def test_status_endpoint(self, client, auth):
|
|
r = client.get("/api/garmin/status", headers=auth)
|
|
assert r.status_code == 200
|
|
assert r.get_json()["status"] == "idle"
|
|
|
|
|
|
class TestTokenStore:
|
|
"""Tokens are what make unattended sync possible on an MFA-protected
|
|
account: the web worker has no stdin to type a code into."""
|
|
|
|
def test_absent_before_any_login(self, db, user):
|
|
assert garmin_svc.has_token(user["id"]) is False
|
|
|
|
def test_saved_token_round_trips(self, db, user):
|
|
garmin_svc.save_token(user["id"], "token-blob", "g@example.com")
|
|
assert garmin_svc.has_token(user["id"]) is True
|
|
assert garmin_svc.load_token(user["id"]) == "token-blob"
|
|
|
|
def test_re_login_replaces_rather_than_accumulates(self, db, user):
|
|
garmin_svc.save_token(user["id"], "first", "g@example.com")
|
|
garmin_svc.save_token(user["id"], "second", "g@example.com")
|
|
|
|
rows = db.query_all(
|
|
"SELECT * FROM garmin_tokens WHERE user_id = ?", [user["id"]]
|
|
)
|
|
assert len(rows) == 1
|
|
assert garmin_svc.load_token(user["id"]) == "second"
|
|
|
|
def test_tokens_are_per_user(self, db, user, client):
|
|
garmin_svc.save_token(user["id"], "mine", "g@example.com")
|
|
other = client.post(
|
|
"/api/auth/register",
|
|
json={"email": "o@example.com", "garminEmail": "og@example.com",
|
|
"garminPassword": "pw123456"},
|
|
).get_json()
|
|
assert garmin_svc.has_token(other["id"]) is False
|
|
|
|
|
|
class TestMfaHandling:
|
|
def test_eof_from_the_mfa_prompt_becomes_an_actionable_error(
|
|
self, db, user, monkeypatch
|
|
):
|
|
"""garth's default MFA prompt calls input(); with no stdin that raises
|
|
a bare EOFError, which says nothing about what to do about it."""
|
|
class StubGarth:
|
|
def loads(self, s): pass
|
|
def refresh_oauth2(self): pass
|
|
|
|
class StubGarmin:
|
|
def __init__(self, *a, **k):
|
|
self.garth = StubGarth()
|
|
self.username = None
|
|
self.password = None
|
|
|
|
def login(self, *a, **k):
|
|
raise EOFError("EOF when reading a line")
|
|
|
|
monkeypatch.setattr(garmin_svc, "_import_garmin", lambda: StubGarmin)
|
|
with pytest.raises(garmin_svc.MFARequired, match="两步验证"):
|
|
garmin_svc._connect(CREDS, user["id"])
|
|
|
|
def test_sync_flags_mfa_so_the_ui_can_explain(self, db, user, monkeypatch):
|
|
def boom(_creds, _uid=None):
|
|
raise garmin_svc.MFARequired("需要两步验证")
|
|
|
|
monkeypatch.setattr(garmin_svc, "_connect", boom)
|
|
out = garmin_svc.sync_data(user["id"], CREDS, days=1)
|
|
|
|
assert out["status"] == "error"
|
|
assert out["mfaRequired"] is True
|
|
|
|
def test_ordinary_failures_are_not_flagged_as_mfa(self, db, user, monkeypatch):
|
|
def boom(_creds, _uid=None):
|
|
raise RuntimeError("401 Unauthorized")
|
|
|
|
monkeypatch.setattr(garmin_svc, "_connect", boom)
|
|
assert garmin_svc.sync_data(user["id"], CREDS, days=1)["mfaRequired"] is False
|
|
|
|
def test_stored_token_is_used_instead_of_logging_in(self, db, user, monkeypatch):
|
|
garmin_svc.save_token(user["id"], "saved-blob", "g@example.com")
|
|
loaded = {}
|
|
|
|
class StubGarth:
|
|
profile = {"displayName": "Tester"}
|
|
|
|
def loads(self, s):
|
|
loaded["blob"] = s
|
|
|
|
def refresh_oauth2(self):
|
|
loaded["refreshed"] = True
|
|
|
|
class StubGarmin:
|
|
def __init__(self, *a, **k):
|
|
self.garth = StubGarth()
|
|
|
|
def login(self, *a, **k):
|
|
raise AssertionError("must not log in when a token exists")
|
|
|
|
monkeypatch.setattr(garmin_svc, "_import_garmin", lambda: StubGarmin)
|
|
garmin_svc._connect({}, user["id"])
|
|
|
|
assert loaded["blob"] == "saved-blob"
|
|
assert loaded["refreshed"] is True
|
|
|
|
def test_no_token_and_no_password_is_refused_clearly(self, db, user, monkeypatch):
|
|
class StubGarmin:
|
|
def __init__(self, *a, **k):
|
|
self.garth = None
|
|
|
|
monkeypatch.setattr(garmin_svc, "_import_garmin", lambda: StubGarmin)
|
|
with pytest.raises(RuntimeError, match="缺少 Garmin 密码"):
|
|
garmin_svc._connect({}, user["id"])
|
|
|
|
|
|
class TestAuthStatusEndpoint:
|
|
def test_requires_auth(self, client):
|
|
assert client.get("/api/garmin/auth-status").status_code == 401
|
|
|
|
def test_reports_false_then_true(self, client, auth, user, db):
|
|
assert client.get("/api/garmin/auth-status", headers=auth).get_json()[
|
|
"hasToken"] is False
|
|
garmin_svc.save_token(user["id"], "blob", "g@example.com")
|
|
assert client.get("/api/garmin/auth-status", headers=auth).get_json()[
|
|
"hasToken"] is True
|
|
|
|
def test_sync_without_password_allowed_once_a_token_exists(
|
|
self, client, auth, user, db
|
|
):
|
|
"""The password field exists only because no token is stored yet."""
|
|
garmin_svc.save_token(user["id"], "blob", "g@example.com")
|
|
r = client.post("/api/garmin/sync", headers=auth, json={})
|
|
assert r.status_code != 400
|