Fix breakpoint() in production code, clean up stale TODO comments

- Replace bare breakpoint() in CheckMakeDeleteCalendar with a proper
  warning log and set create-calendar.set-displayname to False when
  the server returns a calendar for a display name that cannot exist
- Remove duplicate stale "collector framework" TODO comment from
  checks.py and checks_base.py (feature-to-check mapping is now
  implemented in the CLI via _feature_to_check_name)
- Remove stale "record what features are checked" TODO from
  checks_base.py run_check (already implemented via keys_before/after)
- Mark TODO item as done; add note about orphaned caldav_server_tester_old.py

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: tobixen

docs/TODO.md

@@ -1,7 +1,8 @@
-* [x] Currently there is some differences in the logic dependent on if it can find a caldav test directory or not.  If it can find it, then it seems to disregard the ordinary servers in the caldav configuration.  I don't want this - the only thing I want is to have extra servers avaiable through the `--name` option if caldav test servers are found.
+* [x] Currently there is some differences in the logic dependent on if it can find a caldav test directory or not.  If it can find it, then it seems to disregard the ordinary servers in the caldav configuration.  I don't want this - the only thing I want is to have extra servers available through the `--name` option if caldav test servers are found.
 * [x] The default action now is "run towards all servers".  I think it should default to "don't run anything", with a `--all` flag that can be used if one wants this kind of behaviour.  Change of mind: we skip `--all` and the default is to connect to the default calendar server.
 * [x] Currently, by default it shows all "non-full features".  It should rather show all features deviating from the default.
 * [x] New TODO-items have been added to USAGE.md.  They should be fixed and removed from this file prior to the v1.0-release
-* [] Search for other TODO-notes in the project
+* [x] Search for other TODO-notes in the project
+* [x] `src/caldav_server_tester/caldav_server_tester_old.py` is 1028 lines, not imported anywhere - consider deleting it
 * [] It's needed to test it towards a server that does not allow calendars to be created
 * [] The text-based description should be prettified

src/caldav_server_tester/checker.py

@@ -188,7 +188,7 @@ def report(self, verbose=False, show_diff=False, return_what=str):
                 f"Server: {ret['name']} ({ret['url']})",
                 f"caldav library version: {ret['caldav_version']}",
                 "",
-                "Feature compatibility (non-verbose: showing only deviations from expected):"
+                "Feature compatibility (non-verbose: showing only deviations from the standard):"
                 if not verbose
                 else "Feature compatibility:",
             ]

src/caldav_server_tester/checks.py

@@ -44,13 +44,6 @@ def d(obj):
     return (x for x in objects if date(2000, 1, 1) <= d(x) <= date(2001, 1, 1))
 
 
-## WORK IN PROGRESS
-
-## TODO: We need some collector framework that can collect all checks,
-## build a dependency graph and mapping from a feature to the relevant
-## check.
-
-
 class CheckGetCurrentUserPrincipal(Check):
     """
     Checks support for get-current-user-principal
@@ -112,7 +105,15 @@ def _try_make_calendar(self, cal_id, **kwargs):
                 try:
                     name = "A calendar with this name should not exist"
                     self.checker.principal.calendar(name=name).events()
-                    breakpoint()  ## TODO - do something better here
+                    ## Server returned a calendar for a name that cannot exist;
+                    ## display-name lookup is unreliable on this server.
+                    import logging
+
+                    logging.warning(
+                        "Server returned a calendar for a display name that should not exist; "
+                        "cannot verify create-calendar.set-displayname"
+                    )
+                    self.set_feature("create-calendar.set-displayname", False)
                 except:
                     ## This is not the exception, this is the normal
                     try:

src/caldav_server_tester/checks_base.py

@@ -1,12 +1,6 @@
 import copy
 import logging
 
-## WORK IN PROGRESS
-
-## TODO: We need some collector framework that can collect all checks,
-## build a dependency graph and mapping from a feature to the relevant
-## check.
-
 
 class Check:
     """
@@ -36,20 +30,23 @@ def set_feature(self, feature, value=True):
             return
 
         feat_def = self.checker._features_checked.find_feature(feature)
-        feat_type = feat_def.get('type', 'server-feature')
+        feat_type = feat_def.get("type", "server-feature")
 
-        if feat_type not in ('server-peculiarity', 'server-feature'):
+        if feat_type not in ("server-peculiarity", "server-feature"):
             ## client-behaviour, tests-behaviour or client-feature
             ## cannot be checked for reliably (and is not supposed to
             ## be checked by the script).  server-observation is unreliable.
-            assert(feat_type in ('server-observation',))
+            assert feat_type in ("server-observation",)
             return
 
         value_str = fs.is_supported(feature, str)
 
         ## Fragile support is ... fragile and should be ignored
         ## same with unknown
-        if value_str in ('fragile', 'unknown') or self.expected_features.is_supported(feature, str) in ('fragile', 'unknown'):
+        if value_str in ("fragile", "unknown") or self.expected_features.is_supported(feature, str) in (
+            "fragile",
+            "unknown",
+        ):
             return
 
         expected_ = self.expected_features.is_supported(feature, dict)
@@ -59,21 +56,23 @@ def set_feature(self, feature, value=True):
 
         ## Strip all free-text information from both observed and expected
         for stripdict in observed, expected:
-                for y in ("behaviour", "description"):
-                    if y in stripdict:
-                        stripdict.pop(y)
+            for y in ("behaviour", "description"):
+                if y in stripdict:
+                    stripdict.pop(y)
 
-        if self.checker.debug_mode == 'assert':
-            assert(observed == expected)
+        if self.checker.debug_mode == "assert":
+            assert observed == expected
             return
 
         if observed != expected:
-            if self.checker.debug_mode == 'logging':
-                logging.error(f"Server checker found something unexpected for {feature}.  Expected: {expected_}, observed: {observed_}")
-            elif self.checker.debug_mode == 'pdb':
+            if self.checker.debug_mode == "logging":
+                logging.error(
+                    f"Server checker found something unexpected for {feature}.  Expected: {expected_}, observed: {observed_}"
+                )
+            elif self.checker.debug_mode == "pdb":
                 breakpoint()
             else:
-                assert(False)
+                assert False
 
     def feature_checked(self, feature, return_type=bool):
         return self.checker._features_checked.is_supported(feature, return_type)
@@ -85,12 +84,7 @@ def run_check(self, only_once=True):
         for foo in self.depends_on:
             foo(self.checker).run_check(only_once=only_once)
 
-        ## TODO: record what new features are checked.  Everything in
-        ## self.features_checked should be covered, everyhing not in
-        ## self.features_checked should not be checked.
-        keys_before = set(
-            self.checker._features_checked.dotted_feature_set_list().keys()
-        )
+        keys_before = set(self.checker._features_checked.dotted_feature_set_list().keys())
 
         ## expected_features is the preconfigured feature set for this server.
         self.expected_features = self.checker._client_obj.features
@@ -104,9 +98,7 @@ def run_check(self, only_once=True):
             self.checker._client_obj.features = self.expected_features
 
         ## Check that all the declared checking has been done
-        keys_after = set(
-            self.checker._features_checked.dotted_feature_set_list().keys()
-        )
+        keys_after = set(self.checker._features_checked.dotted_feature_set_list().keys())
         new_keys = keys_after - keys_before
         missing_keys = self.features_to_be_checked - new_keys
         parent_keys = ()
@@ -135,6 +127,4 @@ def run_check(self, only_once=True):
         self.checker._checks_run.add(self.__class__)
 
     def _run_check(self):
-        raise NotImplementedError(
-            f"A subclass {self.__class__} hasn't implemented the _run_check method"
-        )
+        raise NotImplementedError(f"A subclass {self.__class__} hasn't implemented the _run_check method")