Moved provisioner specific schema rules to provisioner subclasses

lxdock/conf/schema.py

@@ -1,4 +1,6 @@
-from voluptuous import All, In, IsDir, Length, Required, Schema, Url
+from voluptuous import All, Any, In, IsDir, Length, Required, Schema, Url
+
+from ..provisioners import Provisioner
 
 from .validators import Hostname, LXDIdentifier
 
@@ -9,13 +11,7 @@
     'mode': In(['local', 'pull', ]),
     'privileged': bool,
     'protocol': In(['lxd', 'simplestreams', ]),
-    'provisioning': [{
-        # Common options
-        'type': str,
-
-        # Ansible specific options
-        'playbook': str,
-    }],
+    'provisioning': [],  # will be set dynamically using provisioner classes...
     'server': Url(),
     'shares': [{
         # The existence of the source directory will be checked!
@@ -33,6 +29,12 @@
     }],
 }
 
+# Inserts provisioner specific schema rules in the global schema dict.
+_top_level_and_containers_common_options['provisioning'] = [
+    Any(*[dict([('type', provisioner.name), ] + list(provisioner.schema.items()))
+          for provisioner in Provisioner.provisioners.values()]),
+]
+
 _container_options = {
     Required('name'): LXDIdentifier(),
 }

lxdock/provisioners/ansible.py

@@ -3,6 +3,8 @@
 import subprocess
 import tempfile
 
+from voluptuous import Required
+
 from ..network import get_ipv4_ip
 
 from .base import Provisioner
@@ -14,6 +16,9 @@ class AnsibleProvisioner(Provisioner):
     """ Allows to perform provisioning operations using Ansible. """
 
     name = 'ansible'
+    schema = {
+        Required('playbook'): str,
+    }
 
     def provision(self):
         """ Performs the provisioning operations using the considered provisioner. """

lxdock/provisioners/base.py

@@ -39,6 +39,9 @@ def __new__(cls, name, bases, attrs):
         if not new_provisioner.name:
             raise InvalidProvisioner(
                 "The 'name' attribute of Provisioner subclasses cannot be None")
+        if not new_provisioner.schema:
+            raise InvalidProvisioner(
+                "The 'schema' attribute of Provisioner subclasses cannot be None")
 
         return new_provisioner
 
@@ -68,6 +71,11 @@ class Provisioner(with_metaclass(_ProvisionerBase)):
     # subclasses.
     name = None
 
+    # The `schema` of a provisioner should be a dictionary using voluptuous helpers. This dictionary
+    # must define the "local" schema that should be provided in the LXDock file in order to use the
+    # considered provisioner.
+    schema = None
+
     def __init__(self, homedir, lxd_container, options):
         self.homedir = homedir
         self.lxd_container = lxd_container

tests/unit/provisioners/test_base.py

@@ -9,3 +9,10 @@ def test_subclasses_cannot_be_registered_if_they_do_not_provide_a_provisioner_na
         with pytest.raises(InvalidProvisioner):
             class InvalidDummyHost(Provisioner):
                 name = None
+                schema = {}
+
+    def test_subclasses_cannot_be_registered_if_they_do_not_provide_a_schema_dict(self):
+        with pytest.raises(InvalidProvisioner):
+            class InvalidDummyHost(Provisioner):
+                name = 'myprovisioner'
+                schema = None