style + compacting the changelog

Author: tobixen

CHANGELOG.md

@@ -41,7 +41,7 @@ Also, the RFC6764 discovery may not always be robust, causing fallbacks and henc
 ### Deprecations
 
 * `Event.expand_rrule` will be removed in some future release, unless someone protests.
-* `Event.split_expanded` too.  Both of them were used internally, now it's not.  It's dead code, most lkely nobody and nothing is using them.
+* `Event.split_expanded` too.  Both of them were used internally, now it's not.  It's dead code, most likely nobody and nothing is using them.
 
 ### Changed
 
@@ -50,30 +50,25 @@ Also, the RFC6764 discovery may not always be robust, causing fallbacks and henc
 
 ### Added
 
-* **Automated Baikal Docker testing framework**: Complete automated testing setup for Baikal CalDAV server (v0.10.1) using Docker containers. The framework automatically detects docker-compose availability, starts containers when needed, and gracefully skips tests when Docker is unavailable. Works seamlessly in both local development and CI/CD environments (GitHub Actions).
-  - Automatic container lifecycle management (setup/teardown)
-  - Pre-configured database with test user credentials
-  - Auto-appends `/dav.php` to base URL for correct CalDAV endpoint
-  - Uses official Baikal 0.10.1 SQLite schema with all required tables
-  - YAML configuration support for Baikal 0.7.0+ compatibility
-  - Graceful degradation on systems without Docker
-  - Updated compatibility hints for Baikal 0.10.1
-* **RFC 6764 DNS-based service discovery**: Automatic CalDAV/CardDAV service discovery using DNS SRV/TXT records and well-known URIs. Users can now provide just a domain name or email address (e.g., `DAVClient(username='user@example.com')`) and the library will automatically discover the CalDAV service endpoint. The discovery process follows RFC 6764 specification.  This involves a new required dependency: `dnspython` for DNS queries.  DNS-based discovery can be disabled in the davclient connection settings, but I've opted against implementing a fallback if the dns library is not installed.
-  - **SECURITY**: DNS-based discovery has security implications. By default, `require_tls=True` prevents downgrade attacks by only accepting HTTPS connections. See security documentation for details.
+* **New ways to configure the client connection, new parameters**
+  - **RFC 6764 DNS-based service discovery**: Automatic CalDAV/CardDAV service discovery using DNS SRV/TXT records and well-known URIs. Users can now provide just a domain name or email address (e.g., `DAVClient(username='user@example.com')`) and the library will automatically discover the CalDAV service endpoint. The discovery process follows RFC 6764 specification.  This involves a new required dependency: `dnspython` for DNS queries.  DNS-based discovery can be disabled in the davclient connection settings, but I've opted against implementing a fallback if the dns library is not installed.
   - New `require_tls` parameter (default: `True`) prevents DNS-based downgrade attacks
-  - Username extraction from email addresses (`user@example.com` → username: `user`)
-  - Discovery from username parameter when URL is omitted
-* The client connection parameter `features` may now simply be a string label referencing a well-known server or cloud solution - like `features: posteo`.  https://github.com/python-caldav/caldav/pull/561
-* The client connection parameter `url` is no longer needed when referencing a well-known cloud solution. https://github.com/python-caldav/caldav/pull/561
-* The client connection parameter `url` may contain just the domain name (without any slashes) and the URL will be constructed, if referencing a well-known caldav server implementation. https://github.com/python-caldav/caldav/pull/561
-* New interface for searches.  `mysearcher = caldav.CalDAVSearcher(...) ; mysearcher.add_property_filter(...) ; mysearcher.search(calendar)`.  May be useful for complicated searches.
+  - The client connection parameter `features` may now simply be a string label referencing a well-known server or cloud solution - like `features: posteo`.  https://github.com/python-caldav/caldav/pull/561
+  - The client connection parameter `url` is no longer needed when referencing a well-known cloud solution. https://github.com/python-caldav/caldav/pull/561
+  * The client connection parameter `url` may contain just the domain name (without any slashes).  It may then either look up the URL path in the known caldav server database, or through RFC6764
+* **New interface for searches**  `mysearcher = caldav.CalDAVSearcher(...) ; mysearcher.add_property_filter(...) ; mysearcher.search(calendar)`.  It's a bit harder to use, but opens up the possibility to do more complicated searches.
 * **Collation support for CalDAV text-match queries (RFC 4791 § 9.7.5)**: CalDAV searches now properly pass collation attributes to the server, enabling case-insensitive searches and Unicode-aware text matching. The `CalDAVSearcher.add_property_filter()` method now accepts `case_sensitive` and `collation` parameters. Supported collations include:
   - `i;octet` (case-sensitive, binary comparison) - default
   - `i;ascii-casemap` (case-insensitive for ASCII characters, RFC 4790)
   - `i;unicode-casemap` (Unicode case-insensitive, RFC 5051 - server support may vary)
 * Client-side filtering method: `CalDAVSearcher.filter()` provides comprehensive client-side filtering, expansion, and sorting of calendar objects with full timezone preservation support.
 * Example code: New `examples/collation_usage.py` demonstrates case-sensitive and case-insensitive calendar searches.
 
+### Test suite
+
+* **Automated Baikal Docker testing framework** using Docker containers.   Will only run if docker is available.
+* Since the new search code now can work around different server quirks, quite some of the test code has been simplified.  Many cases of "make a search, if server supports this, then assert correct number of events returned" could be collapsed to "make a search, then assert correct number of events returned" - meaning that **the library is tested rather than the server**.
+
 ## [2.1.2] - [2025-11-08]
 
 Version 2.1.0 comes without niquests in the dependency file.  Version 2.1.2 come with niquests in the dependency file.  Also fixed up some minor mistakes in the CHANGELOG.

tests/conf.py

@@ -113,7 +113,11 @@
                 timeout=5,
             )
             test_baikal = True
-        except (subprocess.CalledProcessError, FileNotFoundError, subprocess.TimeoutExpired):
+        except (
+            subprocess.CalledProcessError,
+            FileNotFoundError,
+            subprocess.TimeoutExpired,
+        ):
             test_baikal = False
 
 #####################
@@ -280,12 +284,16 @@ def silly_request():
     import subprocess
     from pathlib import Path
 
-    baikal_base_url = os.environ.get("BAIKAL_URL", f"http://{baikal_host}:{baikal_port}")
+    baikal_base_url = os.environ.get(
+        "BAIKAL_URL", f"http://{baikal_host}:{baikal_port}"
+    )
     # Ensure the URL includes /dav.php/ for CalDAV endpoint
-    if not baikal_base_url.endswith('/dav.php') and not baikal_base_url.endswith('/dav.php/'):
+    if not baikal_base_url.endswith("/dav.php") and not baikal_base_url.endswith(
+        "/dav.php/"
+    ):
         baikal_url = f"{baikal_base_url}/dav.php"
     else:
-        baikal_url = baikal_base_url.rstrip('/')
+        baikal_url = baikal_base_url.rstrip("/")
 
     baikal_username = os.environ.get("BAIKAL_USERNAME", "testuser")
     baikal_password = os.environ.get("BAIKAL_PASSWORD", "testpass")
@@ -313,7 +321,11 @@ def setup_baikal(self) -> None:
                 check=True,
                 timeout=5,
             )
-        except (subprocess.CalledProcessError, FileNotFoundError, subprocess.TimeoutExpired) as e:
+        except (
+            subprocess.CalledProcessError,
+            FileNotFoundError,
+            subprocess.TimeoutExpired,
+        ) as e:
             raise RuntimeError(
                 "docker-compose is not available. Baikal tests require Docker. "
                 "Please install Docker or skip Baikal tests by setting "
@@ -325,9 +337,7 @@ def setup_baikal(self) -> None:
 
         # Check if docker-compose.yml exists
         if not (baikal_dir / "docker-compose.yml").exists():
-            raise FileNotFoundError(
-                f"docker-compose.yml not found in {baikal_dir}"
-            )
+            raise FileNotFoundError(f"docker-compose.yml not found in {baikal_dir}")
 
         # Start the container but don't wait for full startup
         print(f"Starting Baikal container from {baikal_dir}...")
@@ -345,15 +355,25 @@ def setup_baikal(self) -> None:
         config_dir = baikal_dir / "config"
 
         subprocess.run(
-            ["docker", "cp", f"{specific_dir}/.", "baikal-test:/var/www/baikal/Specific/"],
+            [
+                "docker",
+                "cp",
+                f"{specific_dir}/.",
+                "baikal-test:/var/www/baikal/Specific/",
+            ],
             check=True,
             capture_output=True,
         )
 
         # Copy YAML config for newer Baikal versions
         if config_dir.exists():
             subprocess.run(
-                ["docker", "cp", f"{config_dir}/.", "baikal-test:/var/www/baikal/config/"],
+                [
+                    "docker",
+                    "cp",
+                    f"{config_dir}/.",
+                    "baikal-test:/var/www/baikal/config/",
+                ],
                 check=True,
                 capture_output=True,
             )
@@ -379,9 +399,7 @@ def setup_baikal(self) -> None:
                 pass
             time.sleep(1)
 
-        raise TimeoutError(
-            f"Baikal did not become ready after {max_attempts} seconds"
-        )
+        raise TimeoutError(f"Baikal did not become ready after {max_attempts} seconds")
 
     def teardown_baikal(self) -> None:
         """Stop Baikal Docker container."""

tests/docker-test-servers/baikal/create_baikal_db.py

@@ -10,14 +10,15 @@
 Usage:
     python create_baikal_db.py
 """
-
 import hashlib
 import os
 import sqlite3
 from pathlib import Path
 
 
-def create_baikal_db(db_path: Path, username: str = "testuser", password: str = "testpass") -> None:
+def create_baikal_db(
+    db_path: Path, username: str = "testuser", password: str = "testpass"
+) -> None:
     """Create a Baikal SQLite database with a test user using official schema."""
 
     # Ensure directory exists
@@ -192,21 +193,20 @@ def create_baikal_db(db_path: Path, username: str = "testuser", password: str =
     ha1 = hashlib.md5(f"{username}:{realm}:{password}".encode()).hexdigest()
 
     cursor.execute(
-        "INSERT INTO users (username, digesta1) VALUES (?, ?)",
-        (username, ha1)
+        "INSERT INTO users (username, digesta1) VALUES (?, ?)", (username, ha1)
     )
 
     # Create principal for user
     principal_uri = f"principals/{username}"
     cursor.execute(
         "INSERT INTO principals (uri, email, displayname) VALUES (?, ?, ?)",
-        (principal_uri, f"{username}@baikal.test", f"Test User ({username})")
+        (principal_uri, f"{username}@baikal.test", f"Test User ({username})"),
     )
 
     # Create default calendar
     cursor.execute(
         "INSERT INTO calendars (synctoken, components) VALUES (?, ?)",
-        (1, "VEVENT,VTODO,VJOURNAL")
+        (1, "VEVENT,VTODO,VJOURNAL"),
     )
     calendar_id = cursor.lastrowid
 
@@ -215,15 +215,15 @@ def create_baikal_db(db_path: Path, username: str = "testuser", password: str =
         """INSERT INTO calendarinstances
            (calendarid, principaluri, access, displayname, uri, calendarorder, calendarcolor)
            VALUES (?, ?, ?, ?, ?, ?, ?)""",
-        (calendar_id, principal_uri, 1, "Default Calendar", "default", 0, "#3a87ad")
+        (calendar_id, principal_uri, 1, "Default Calendar", "default", 0, "#3a87ad"),
     )
 
     # Create default addressbook for user
     cursor.execute(
         """INSERT INTO addressbooks
            (principaluri, displayname, uri, synctoken)
            VALUES (?, ?, ?, ?)""",
-        (principal_uri, "Default Address Book", "default", 1)
+        (principal_uri, "Default Address Book", "default", 1),
     )
 
     conn.commit()
@@ -353,7 +353,9 @@ def create_baikal_yaml(yaml_path: Path) -> None:
   mysql_dbname: 'baikal'
   mysql_username: 'baikal'
   mysql_password: 'baikal'
-""".format(admin_hash=admin_hash)
+""".format(
+        admin_hash=admin_hash
+    )
 
     yaml_path.write_text(yaml_content)
     print(f"✓ Created Baikal YAML config at {yaml_path}")
@@ -377,9 +379,9 @@ def create_baikal_yaml(yaml_path: Path) -> None:
     yaml_path = script_dir / "config" / "baikal.yaml"
     create_baikal_yaml(yaml_path)
 
-    print("\n" + "="*70)
+    print("\n" + "=" * 70)
     print("Baikal pre-configuration complete!")
-    print("="*70)
+    print("=" * 70)
     print("\nYou can now start Baikal with: docker-compose up -d")
     print("\nCredentials:")
     print("  Admin: admin / admin")