Files
odysseus/tests/test_caldav_google_principal_url.py
T
tanmayraut45 e6d9d68729 CalDAV: close the DAVClient on sync and write-back paths (#4793)
_sync_blocking (src/caldav_sync.py) and _writeback_blocking
(src/caldav_writeback.py) each open their own caldav.DAVClient via
_build_dav_client, but never close it. The client owns an HTTP session
with a pooled connection; without a close() that connection is held until
process exit.

Previously the fix added explicit client.close() calls before each early
return and at the end of the DB finally block. This still leaked the
client when SessionLocal() raised before the DB try/finally was entered.

Now _sync_blocking wraps the entire post-construction path in an outer
try/finally that calls client.close() unconditionally, covering:
  - AuthorizationError / NotFoundError early return
  - URL-fallback failure early return
  - no-calendars early return
  - normal return after sync
  - SessionLocal() construction failure (new regression coverage)

_writeback_blocking already used a try/finally (unchanged).

- src/caldav_sync.py: replace scattered client.close() calls with a
  single outer try/finally block around the discovery + DB sync path
- tests/test_caldav_client_cleanup.py: add CalendarDeletedEvent to the
  database stub; add regression test for SessionLocal() failure path

Closes #4593
2026-07-11 13:03:24 +01:00

170 lines
5.8 KiB
Python

"""Google Calendar over CalDAV must surface events, not come back empty (#2507).
Google's CalDAV principal lives at ``.../caldav/v2/<id>/user`` but events are
served from ``.../caldav/v2/<id>/events``. When the `caldav` library's
principal discovery yields no calendars for Google's ``/user`` endpoint,
``_sync_blocking`` fell back to ``client.calendar(url=url)`` — i.e. it queried
the principal URL itself, which returns a clean but empty 200 for every date
range. Auth succeeded, the calendar stayed empty.
These tests inject a fake ``caldav`` module that mimics Google's behaviour
(principal discovery returns no calendars; the ``/user`` collection holds no
events; the ``/events`` collection holds one VEVENT) and assert the sync now
maps the principal URL to its events collection and pulls the event. No live
Google account is required.
"""
import sys
import tempfile
import types
from datetime import datetime, timedelta
import pytest
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.pool import NullPool
import core.database as cdb
from core.database import CalendarCal, CalendarEvent
from src import caldav_sync
_TMPDB = tempfile.NamedTemporaryFile(suffix=".db", delete=False)
_ENGINE = create_engine(
f"sqlite:///{_TMPDB.name}",
connect_args={"check_same_thread": False},
poolclass=NullPool,
)
cdb.Base.metadata.create_all(_ENGINE)
_TS = sessionmaker(bind=_ENGINE, autoflush=False, autocommit=False)
_GOOGLE_PRINCIPAL = "https://apidata.googleusercontent.com/caldav/v2/me@gmail.com/user"
_GOOGLE_EVENTS = "https://apidata.googleusercontent.com/caldav/v2/me@gmail.com/events"
def _ics_one_event():
# An event inside the sync window (now-90d .. now+365d).
dt = datetime.utcnow() + timedelta(days=2)
stamp = dt.strftime("%Y%m%dT%H%M%SZ")
return (
"BEGIN:VCALENDAR\r\n"
"VERSION:2.0\r\n"
"BEGIN:VEVENT\r\n"
"UID:evt-1@google\r\n"
f"DTSTART:{stamp}\r\n"
f"DTEND:{stamp}\r\n"
"SUMMARY:Standup\r\n"
"END:VEVENT\r\n"
"END:VCALENDAR\r\n"
)
class _FakeObj:
def __init__(self, data):
self.data = data
class _FakeCalendar:
def __init__(self, url):
self.url = url
self.name = "Primary"
def date_search(self, start, end, expand=False):
# Google's /user principal holds no events; the /events collection does.
if str(self.url).rstrip("/").endswith("/events"):
return [_FakeObj(_ics_one_event())]
return []
class _FakePrincipal:
def calendars(self):
# Simulate Google's /user endpoint yielding no calendars from discovery.
return []
class _FakeClient:
def __init__(self, url=None, username=None, password=None):
self.url = url
# Mirror the real DAVClient: _build_dav_client sets
# session.max_redirects = 0 right after construction.
self.session = types.SimpleNamespace(max_redirects=30)
def principal(self):
return _FakePrincipal()
def calendar(self, url=None):
return _FakeCalendar(url)
def close(self):
# Mirror the real DAVClient: sync now closes the client on every path.
self.closed = True
def _install_fake_caldav(monkeypatch):
fake = types.ModuleType("caldav")
fake.DAVClient = _FakeClient
err = types.ModuleType("caldav.lib.error")
class AuthorizationError(Exception):
pass
class NotFoundError(Exception):
pass
err.AuthorizationError = AuthorizationError
err.NotFoundError = NotFoundError
lib = types.ModuleType("caldav.lib")
lib.error = err
fake.lib = lib
monkeypatch.setitem(sys.modules, "caldav", fake)
monkeypatch.setitem(sys.modules, "caldav.lib", lib)
monkeypatch.setitem(sys.modules, "caldav.lib.error", err)
monkeypatch.setattr(caldav_sync, "SessionLocal", _TS, raising=False)
monkeypatch.setattr(cdb, "SessionLocal", _TS, raising=False)
def _clear_db():
db = _TS()
try:
db.query(CalendarEvent).delete()
db.query(CalendarCal).delete()
db.commit()
finally:
db.close()
def test_maps_google_principal_url_to_events_collection():
assert caldav_sync._google_caldav_events_url(_GOOGLE_PRINCIPAL) == _GOOGLE_EVENTS
# Trailing slash tolerated.
assert caldav_sync._google_caldav_events_url(_GOOGLE_PRINCIPAL + "/") == _GOOGLE_EVENTS
# Non-Google or non-principal URLs are left untouched (None => caller keeps URL).
assert caldav_sync._google_caldav_events_url("https://calendar.example.com/dav") is None
assert caldav_sync._google_caldav_events_url(_GOOGLE_EVENTS) is None
def test_maps_legacy_google_calendar_dav_url():
# Google's older endpoint (some accounts authenticate only against this one).
legacy_user = "https://www.google.com/calendar/dav/me@gmail.com/user"
legacy_events = "https://www.google.com/calendar/dav/me@gmail.com/events"
assert caldav_sync._google_caldav_events_url(legacy_user) == legacy_events
assert caldav_sync._google_caldav_events_url(legacy_user + "/") == legacy_events
# A non-CalDAV www.google.com /user path must NOT be rewritten.
assert caldav_sync._google_caldav_events_url("https://www.google.com/accounts/user") is None
def test_google_sync_pulls_events_instead_of_empty(monkeypatch):
_install_fake_caldav(monkeypatch)
_clear_db()
result = caldav_sync._sync_blocking("alice", _GOOGLE_PRINCIPAL, "me@gmail.com", "app-pw")
# The fix routes discovery-less Google sync to the /events collection, so
# the VEVENT is pulled. Pre-fix this queried /user and returned 0 events.
assert result["events"] == 1, result
assert not result["errors"], result["errors"]
db = _TS()
try:
ev = db.query(CalendarEvent).filter(CalendarEvent.uid == "evt-1@google").first()
assert ev is not None and ev.summary == "Standup"
finally:
db.close()