Skip to content

fix: Tolerate 500-errors on calendar existtence probing #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tobixen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Tolerate 500-errors on calendar existtence probing #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 34 additions & 26 deletions src/caldav_server_tester/checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,19 @@ class CheckMakeDeleteCalendar(Check):
}
depends_on = {CheckGetCurrentUserPrincipal}

@staticmethod
def _calendar_is_accessible(cal) -> bool:
"""Probe whether a calendar is accessible by calling events().

Returns True if events() succeeds, False if the server returns any DAV
error (404 Not Found, 403 Forbidden, 500 Internal Server Error, etc.).
"""
try:
cal.events()
return True
except DAVError:
return False

def _try_make_calendar(self, cal_id, **kwargs):
"""
Does some attempts on creating and deleting calendars, and sets some
Expand Down Expand Up @@ -125,29 +138,23 @@ def _try_make_calendar(self, cal_id, **kwargs):
except Exception:
self.set_feature("create-calendar.set-displayname", False)

except DAVError as e:
except DAVError:
## calendar creation created an exception. Maybe the calendar exists?
## in any case, return exception
cal = self.checker.principal.calendar(cal_id=cal_id)
try:
cal.events()
except Exception:
if not self._calendar_is_accessible(cal):
cal = None
if not cal:
## cal not made and does not exist, exception thrown.
## Caller to decide why the calendar was not made
return (False, e)
return False

assert cal

try:
## Use DAVObject.delete directly to bypass Calendar.delete()
## workarounds - we want to test the server's raw DELETE behavior
DAVObject.delete(cal)
try:
cal = self.checker.principal.calendar(cal_id=cal_id)
events = cal.events()
except NotFoundError:
cal = self.checker.principal.calendar(cal_id=cal_id)
if not self._calendar_is_accessible(cal):
cal = None
## Delete throw no exceptions, but was the calendar deleted?
if not cal or self.checker.features_checked.is_supported("create-calendar.auto"):
Expand All @@ -160,24 +167,22 @@ def _try_make_calendar(self, cal_id, **kwargs):
## Calendar not deleted.
## Perhaps the server needs some time to delete the calendar
time.sleep(10)
try:
cal = self.checker.principal.calendar(cal_id=cal_id)
assert cal
cal.events()
cal = self.checker.principal.calendar(cal_id=cal_id)
if self._calendar_is_accessible(cal):
## Calendar not deleted, but no exception thrown.
## Perhaps it's a "move to thrashbin"-regime on the server
self.set_feature(
"delete-calendar",
{"support": "unknown", "behaviour": "move to trashbin?"},
)
except NotFoundError as e:
else:
## Calendar was deleted, it just took some time.
self.set_feature(
"delete-calendar",
{"support": "fragile", "behaviour": "delayed deletion"},
)
return (calmade, e)
return (calmade, None)
return calmade
return calmade
except DAVError as e:
time.sleep(10)
try:
Expand All @@ -191,7 +196,7 @@ def _try_make_calendar(self, cal_id, **kwargs):
)
except DAVError as e2:
self.set_feature("delete-calendar", False)
return (calmade, None)
return calmade

def _run_check(self):
try:
Expand All @@ -201,7 +206,10 @@ def _run_check(self):
except (
NotFoundError,
AuthorizationError,
): ## robur throws a 403 .. and that's ok
ReportError,
): ## robur throws a 403 .. and that's ok.
## Some unknown server throws 500 internal server error ... well, we should survive that, too
## (perhaps we should do an `except Exception` instead?)
self.set_feature("create-calendar.auto", False)

## Check on "no_default_calendar" flag
Expand All @@ -213,37 +221,37 @@ def _run_check(self):
self.set_feature("get-current-user-principal.has-calendar", False)

makeret = self._try_make_calendar(name="Yep", cal_id="caldav-server-checker-mkdel-test")
if makeret[0]:
if makeret:
## calendar created
## TODO: this is a lie - we haven't really verified this, only on second script run we will be sure
if self.checker.features_checked.is_supported("delete-calendar"):
self.set_feature("delete-calendar.free-namespace", True)
return
makeret = self._try_make_calendar(name=str(uuid.uuid4()), cal_id="pythoncaldav-test")
if makeret[0]:
if makeret:
self.set_feature("create-calendar.set-displayname", True)
self.set_feature("delete-calendar.free-namespace", False)
return
makeret = self._try_make_calendar(cal_id="pythoncaldav-test")
if makeret[0]:
if makeret:
self.set_feature("create-calendar.set-displayname", False)
if self.checker.features_checked.is_supported("delete-calendar"):
self.set_feature("delete-calendar.free-namespace", True)
return
unique_id1 = "testcalendar-" + str(uuid.uuid4())
makeret = self._try_make_calendar(cal_id=unique_id1, name=str(uuid.uuid4()))
if makeret[0]:
if makeret:
self.set_feature("delete-calendar.free-namespace", False)
self.set_feature("create-calendar.set-displayname", True)
return
unique_id = "testcalendar-" + str(uuid.uuid4())
makeret = self._try_make_calendar(cal_id=unique_id)
if makeret[0]:
if makeret:
self.set_feature("create-calendar.set-displayname", False)
self.set_feature("delete-calendar.free-namespace", False)
return
makeret = self._try_make_calendar(cal_id=unique_id, method="mkcol")
if makeret[0]:
if makeret:
self.set_feature("create-calendar", {"support": "quirk", "behaviour": "mkcol-required"})
else:
self.set_feature("create-calendar", False)
Expand Down
Loading