Ticket #136: extensible_config.patch

config.py

@@ -20 +20 @@
 import copy
 
 from twisted.python import log
+from twisted.python.reflect import namedClass
 
 from twistedcaldav.py.plistlib import readPlist
 
+def _loadDirectoryService(klass):
+    """
+    Loads a directory service class at runtime, raising a ConfigurationError
+    on failure.
+    """
+    try:
+        return namedClass(klass)
+    except (ImportError, AttributeError):
+        raise ConfigurationError(
+            "Unable to load directory service %s" % klass)
+
 defaultConfigFile = "/etc/caldavd/caldavd.plist"
 
-serviceDefaultParams = {
-    "twistedcaldav.directory.xmlfile.XMLDirectoryService": {
-        "xmlFile": "/etc/caldavd/accounts.xml",
-    },
-    "twistedcaldav.directory.appleopendirectory.OpenDirectoryService": {
-        "node": "/Search",
-        "requireComputerRecord": True,
-    },
-}
+defaultDirectoryService = \
+    "twistedcaldav.directory.xmlfile.XMLDirectoryService"
 
+defaultDirectoryServiceParams = \
+    copy.deepcopy(_loadDirectoryService(defaultDirectoryService).defaultParams)
+
 defaultConfig = {
     #
     # Public network address information
@@ -75 +83 @@
     #    users, groups, locations and resources) to the server.
     #
     "DirectoryService": {
-        "type": "twistedcaldav.directory.xmlfile.XMLDirectoryService",
-        "params": serviceDefaultParams["twistedcaldav.directory.xmlfile.XMLDirectoryService"],
+        "type": defaultDirectoryService,
+        "params": defaultDirectoryServiceParams,
     },
 
     #
@@ -189 +197 @@
         return str(self._data)
 
     def update(self, items):
+        dsData = self._data["DirectoryService"]
         dsType = items.get("DirectoryService", {}).get("type", None)
         if dsType is None:
-            dsType = self._data["DirectoryService"]["type"]
-        else:
-            if dsType == self._data["DirectoryService"]["type"]:
-                oldParams = self._data["DirectoryService"]["params"]
-                newParams = items["DirectoryService"].get("params", {})
-                _mergeData(oldParams, newParams)
-            else:
-                if dsType in serviceDefaultParams:
-                    self._data["DirectoryService"]["params"] = copy.deepcopy(serviceDefaultParams[dsType])
-                else:
-                    self._data["DirectoryService"]["params"] = {}
+            dsType = dsData["type"]
+        dsClass = _loadDirectoryService(dsType)
 
+        # Copy the default parameters from the directory service class, if the
+        # directory service we've been given is different than the one we
+        # already have. This ensures that at the very least the directory 
+        # service is configured using the specified defaults and that the
+        # update method may be called more than once with specific parameters
+        # for configuration.
+        try:
+            if dsData["type"] != dsType:
+                dsData["type"] = dsType
+                dsData["params"] = copy.deepcopy(dsClass.defaultParams)
+        except AttributeError:
+            raise ConfigurationError(
+                "Default service parameters must be specified in %s " \
+                "using the 'defaultParams' class variable." % dsType)
+        # Ensure that the parameters defined in the configuration file are
+        # acceptable for the directory service.
         for param in items.get("DirectoryService", {}).get("params", {}):
-            if param not in serviceDefaultParams[dsType]:
-                raise ConfigurationError("Parameter %s is not supported by service %s" % (param, dsType))
+            if param not in dsClass.defaultParams:
+                raise ConfigurationError(
+                    "Parameter %s is not supported by service %s" % \
+                    (param, dsType))
 
         _mergeData(self._data, items)
 
-        for param in tuple(self._data["DirectoryService"]["params"]):
-            if param not in serviceDefaultParams[self._data["DirectoryService"]["type"]]:
-                del self._data["DirectoryService"]["params"][param]
+        # Cleeanup parameters which may have been left around after a switch
+        # in directory service type.
+        for param in tuple(dsData["params"]):
+            if param not in dsClass.defaultParams:
+                del dsData["params"][param]
 
         self.updateServerCapabilities()
 

directory/xmlfile.py

@@ -39 +39 @@
 
     realmName = None
 
+    defaultParams = {
+        "xmlFile": "/etc/caldavd/accounts.xml",
+    }
+
     def __repr__(self):
         return "<%s %r: %r>" % (self.__class__.__name__, self.realmName, self.xmlFile)
 

directory/appleopendirectory.py

@@ -56 +56 @@
     """
     baseGUID = "891F8321-ED02-424C-BA72-89C32F215C1E"
 
+    defaultParams = {
+        "node": "/Search",
+        "requireComputerRecord": True,
+    }
+
     def __repr__(self):
         return "<%s %r: %r>" % (self.__class__.__name__, self.realmName, self.node)
 

directory/idirectory.py

@@ -34 +34 @@
     realmName = Attribute("The name of the authentication realm this service represents.")
     guid = Attribute("A GUID for this service.")
 
+    defaultParams = Attribute("Default configuration parameters for this service.")
+
     def recordTypes():
         """
         @return: a sequence of strings denoting the record types that are kept

test/test_config.py

@@ -21 +21 @@
 from twistedcaldav.py.plistlib import writePlist
 
 from twistedcaldav.config import config, defaultConfig, ConfigurationError
+from twistedcaldav.directory.directory import DirectoryService
 
 testConfig = """<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -34 +35 @@
 </plist>
 """
 
+XML_DIRECTORY_SERVICE = \
+    "twistedcaldav.directory.xmlfile.XMLDirectoryService"
+
+OPEN_DIRECTORY_SERVICE = \
+    "twistedcaldav.directory.appleopendirectory.OpenDirectoryService"
+
+SUPER_DUPER_DIRECTORY_SERVICE = \
+    "twistedcaldav.test.test_config.SuperDuperService"
+
+class SuperDuperService(DirectoryService):
+    """
+    A super duper directory service that's super duper effective at being
+    used for testing but not awesome.
+    """
+    defaultParams = {
+        "superLevel": "super",
+        "duperLevel": "duper",
+    }
+
 def _testVerbose(testCase):
     from twistedcaldav.config import config
     testCase.assertEquals(config.Verbose, True)
@@ -44 +64 @@
         config.update(defaultConfig)
         self.testConfig = self.mktemp()
         open(self.testConfig, 'w').write(testConfig)
+        self.ds = config.DirectoryService
 
     def tearDown(self):
         config.setDefaults(defaultConfig)
         config.loadConfig(None)
         config.reload()
 
+    def _checkXMLDefaults(self):
+        """
+        Checks that the base XML directory service defaults are correct.
+        """
+        self.assertEquals(self.ds["type"], XML_DIRECTORY_SERVICE)
+        self.assertEquals(self.ds["params"]["xmlFile"],
+                          "/etc/caldavd/accounts.xml")
+
+    def _checkODDefaults(self):
+        """
+        Checks that the base Apple open directory service defaults are correct.
+        """
+        self.assertEquals(self.ds["type"], OPEN_DIRECTORY_SERVICE)
+        self.assertNotIn("xmlFile", self.ds["params"])
+        self.assertEquals(self.ds["params"]["node"], "/Search")
+        self.assertEquals(self.ds["params"]["requireComputerRecord"], True)
+
+    def _checkSuperDuperDefaults(self):
+        """
+        Checks that the base super duper test-only directory service defaults
+        are correct.
+        """
+        self.assertEquals(self.ds["type"], SUPER_DUPER_DIRECTORY_SERVICE)
+        self.assertNotIn("xmlFile", self.ds["params"])
+        self.assertEquals(self.ds["params"]["superLevel"], "super")
+        self.assertEquals(self.ds["params"]["duperLevel"], "duper")
+
+
     def testDefaults(self):
         for key, value in defaultConfig.iteritems():
             self.assertEquals(getattr(config, key), value)
@@ -122 +171 @@
         self.assertEquals(config.MultiProcess["LoadBalancer"]["Enabled"], True)
 
     def testDirectoryService_noChange(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
-
+        self._checkXMLDefaults()
         config.update({"DirectoryService": {}})
+        self._checkXMLDefaults()
 
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
-
     def testDirectoryService_sameType(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
+        self._checkXMLDefaults()
+        config.update({"DirectoryService": {"type": XML_DIRECTORY_SERVICE}})
+        self._checkXMLDefaults()
 
-        config.update({"DirectoryService": {"type": "twistedcaldav.directory.xmlfile.XMLDirectoryService"}})
-
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
-
     def testDirectoryService_newType(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
+        self._checkXMLDefaults()
+        config.update({
+            "DirectoryService": {
+                "type": SUPER_DUPER_DIRECTORY_SERVICE
+            }
+        })
+        self._checkSuperDuperDefaults()
 
-        config.update({"DirectoryService": {"type": "twistedcaldav.directory.appleopendirectory.OpenDirectoryService"}})
-
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.appleopendirectory.OpenDirectoryService")
-        self.assertNotIn("xmlFile", config.DirectoryService["params"])
-        self.assertEquals(config.DirectoryService["params"]["node"], "/Search")
-        self.assertEquals(config.DirectoryService["params"]["requireComputerRecord"], True)
-
     def testDirectoryService_newParam(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
+        self._checkXMLDefaults()
+        config.update({
+            "DirectoryService": {
+                "type": SUPER_DUPER_DIRECTORY_SERVICE
+            }
+        })
+        config.update({
+            "DirectoryService": {
+                "params": {"superLevel": "!super" }
+            }
+        })
+        self.assertEquals(self.ds["type"], SUPER_DUPER_DIRECTORY_SERVICE)
+        self.assertNotIn("xmlFile", self.ds["params"])
+        self.assertEquals(self.ds["params"]["superLevel"], "!super")
+        self.assertEquals(self.ds["params"]["duperLevel"], "duper")
+    
+    def testDirectoryService_newBadParam(self):
+        self._checkXMLDefaults()
+        self.assertRaises(ConfigurationError, config.update, {
+            "DirectoryService": {
+                "type": SUPER_DUPER_DIRECTORY_SERVICE,
+                "params": {
+                    "xmlFile": "/etc/caldavd/accounts.xml"
+                }
+            }
+        })
+    
+    def testDirectoryService_twoNewParams(self):
+        self._checkXMLDefaults()
+        config.update({
+            "DirectoryService": {
+                "type": SUPER_DUPER_DIRECTORY_SERVICE
+            }
+        })
+        config.update({
+            "DirectoryService": {
+                "params": {"superLevel": "!super" }
+            }
+        })
+        config.update({
+            "DirectoryService": {
+                "params": {"duperLevel": "!duper" }
+            }
+        })
+        self.assertEquals(self.ds["type"], SUPER_DUPER_DIRECTORY_SERVICE)
+        self.assertNotIn("xmlFile", self.ds["params"])
+        self.assertEquals(self.ds["params"]["superLevel"], "!super")
+        self.assertEquals(self.ds["params"]["duperLevel"], "!duper")
 
-        config.update({"DirectoryService": {"type": "twistedcaldav.directory.appleopendirectory.OpenDirectoryService"}})
-        config.update({"DirectoryService": {"params": {"requireComputerRecord": False}}})
+    def testDirectoryService_newTypeOD(self):
+        self._checkXMLDefaults()
+        config.update({"DirectoryService": {"type": OPEN_DIRECTORY_SERVICE}})
+        self._checkODDefaults()
 
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.appleopendirectory.OpenDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["node"], "/Search")
-        self.assertEquals(config.DirectoryService["params"]["requireComputerRecord"], False)
+    def testDirectoryService_newParamOD(self):
+        self._checkXMLDefaults()
+        config.update({"DirectoryService": {"type": OPEN_DIRECTORY_SERVICE}})
+        config.update({
+            "DirectoryService": {
+                "params": {"requireComputerRecord": False}
+            }
+        })
+        self.assertEquals(self.ds["type"], OPEN_DIRECTORY_SERVICE)
+        self.assertEquals(self.ds["params"]["node"], "/Search")
+        self.assertEquals(self.ds["params"]["requireComputerRecord"], False)
 
     def testDirectoryService_badParam(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
+        self._checkXMLDefaults()
+        self.assertRaises(ConfigurationError, config.update, {
+            "DirectoryService": {
+                "params": {"requireComputerRecord": False}
+            }
+        })
 
-        self.assertRaises(ConfigurationError, config.update, {"DirectoryService": {"params": {"requireComputerRecord": False}}})
-
     def testDirectoryService_unknownType(self):
-        self.assertEquals(config.DirectoryService["type"], "twistedcaldav.directory.xmlfile.XMLDirectoryService")
-        self.assertEquals(config.DirectoryService["params"]["xmlFile"], "/etc/caldavd/accounts.xml")
+        self._checkXMLDefaults()
+        self.assertRaises(ConfigurationError, config.update, {
+            "DirectoryService": {
+                "type": "twistedcaldav.test.test_config.SuperDuperAwesomeService"
+            }
+        })
 
-        config.update({"DirectoryService": {"type": "twistedcaldav.test.test_config.SuperDuperAwesomeService"}})
-
-        self.assertEquals(
-            config.DirectoryService["params"],
-            SuperDuperAwesomeService.defaultParameters
-        )
-
-    testDirectoryService_unknownType.todo = "unimplemented"
-
     def testUpdateDefaults(self):
         self.assertEquals(config.SSLPort, 0)