config files can be placed different places and have different names

Author: tobixen

caldav/config.py

@@ -1,4 +1,6 @@
 import json
+import logging
+import os
 
 """
 This configuration parsing code was just copied from my plann library (and will be removed from there at some point in the future).  It's lacking tests, documentation and ... generally just lacking.
@@ -71,6 +73,21 @@ def config_section(config, section="default"):
 
 
 def read_config(fn, interactive_error=False):
+    if not fn:
+        cfgdir = f"{os.environ.get('HOME', '/')}/.config/"
+        for config_file in (
+            f"{cfgdir}/caldav/calendar.conf",
+            f"{cfgdir}/caldav/calendar.yaml"
+            f"{cfgdir}/caldav/calendar.json"
+            f"{cfgdir}/calendar.conf",
+            "/etc/calendar.conf",
+            "/etc/caldav/calendar.conf",
+        ):
+            cfg = read_config(config_file)
+            if cfg:
+                return cfg
+        return None
+
     ## This can probably be refactored into fewer lines ...
     try:
         try:

caldav/davclient.py

@@ -892,7 +892,7 @@ def request(
 
 
 def auto_calendars(
-    config_file: str = f"{os.environ.get('HOME')}/.config/calendar.conf",
+    config_file: str = None,
     config_section="default",
     testconfig=False,
     environment: bool = True,
@@ -1002,23 +1002,7 @@ def get_davclient(
         if not config_section:
             config_section = "default"
 
-        if not config_file:
-            cfgdir = f"{os.environ.get('HOME', '/')}/.config/"
-            for config_file in (
-                f"{cfgdir}/caldav/calendar.conf",
-                f"{cfgdir}/caldav/calendar.yaml"
-                f"{cfgdir}/caldav/calendar.json"
-                f"{cfgdir}/calendar.conf",
-                "/etc/calendar.conf",
-                "/etc/caldav/calendar.conf",
-            ):
-                try:
-                    cfg = config.read_config(config_file)
-                    break
-                except FileNotFoundError:
-                    pass
-        else:
-            cfg = config.read_config(config_file)
+        cfg = config.read_config(config_file)
         if cfg:
             section = config.config_section(cfg, config_section)
             conn_params = {}

pyproject.toml

@@ -59,6 +59,7 @@ test = [
   "dulwich==0.20.50;python_version<'3.9'",
   "xandikos;python_version>='3.9'",
   "radicale",
+  "pyfakefs"
 ]
 
 [tool.setuptools_scm]

tests/test_caldav.py

@@ -454,7 +454,9 @@ def testTestConfig(self):
 
     def testEnvironment(self):
         os.environ["PYTHON_CALDAV_USE_TEST_SERVER"] = "1"
-        with get_davclient(environment=True, check_config_file=False, name="-1") as conn:
+        with get_davclient(
+            environment=True, check_config_file=False, name="-1"
+        ) as conn:
             assert conn.principal()
             del os.environ["PYTHON_CALDAV_USE_TEST_SERVER"]
             for key in ("url", "username", "password", "proxy"):
@@ -486,6 +488,29 @@ def testConfigfile(self):
                 ) as conn2:
                     assert conn2.principal()
 
+    def testNoConfigfile(self, fs):
+        """This is actually a unit test, not a functional test.
+        Should move it to another file probably, and make more unit
+        tests covering the config file parsing
+        """
+        assert get_davclient(testconfig=False, environment=False) is None
+        HOME = os.environ["HOME"]
+        fs.create_dir(f"{HOME}/.config/caldav")
+        fs.create_file(
+            f"{HOME}/.config/caldav/calendar.conf",
+            contents=json.dumps(
+                {
+                    "default": {
+                        "caldav_url": "https://caldav.example.com/dav",
+                        "caldav_username": "karl",
+                        "caldav_password": "hunter2",
+                    }
+                }
+            ),
+        )
+        client = get_davclient(testconfig=False, environment=False)
+        assert client.url == "https://caldav.example.com/dav"
+
 
 @pytest.mark.skipif(
     not rfc6638_users, reason="need rfc6638_users to be set in order to run this test"