Properly handle Foxx service configuration and dependencies and update docs

Author: joowani

arango/foxx.py

@@ -49,11 +49,15 @@ def __repr__(self):
         return '<Foxx in {}>'.format(self._conn.db_name)
 
     # noinspection PyMethodMayBeStatic
-    def _encode_file(self, filename):
-        """Encode file into multipart data.
+    def _encode(self, filename, config, deps):
+        """Encode file, configuration and dependencies into multipart data.
 
         :param filename: Full path to the javascript file or zip bundle.
         :type filename: str
+        :param config: Configuration values.
+        :type config: dict
+        :param deps: Dependency settings.
+        :type deps: dict
         :return: Multipart encoder object
         :rtype: requests_toolbelt.MultipartEncoder
         """
@@ -65,9 +69,16 @@ def _encode_file(self, filename):
         else:
             raise ValueError('File extension must be .zip or .js')
 
-        return MultipartEncoder(
-            fields={'source': (None, open(filename, 'rb'), source_type)}
-        )
+        fields = {'source': (None, open(filename, 'rb'), source_type)}
+
+        if config is not None:
+            fields['configuration'] = \
+                self._conn.serialize(config).encode('utf-8')
+        if deps is not None:
+            fields['dependencies'] = \
+                self._conn.serialize(deps).encode('utf-8')
+
+        return MultipartEncoder(fields=fields)
 
     def services(self, exclude_system=False):
         """List installed services.
@@ -182,7 +193,9 @@ def create_service_with_file(self,
                                  filename,
                                  development=None,
                                  setup=None,
-                                 legacy=None):
+                                 legacy=None,
+                                 config=None,
+                                 dependencies=None):
         """Install a new service using a javascript file or zip bundle.
 
         :param mount: Service mount path (e.g "/_admin/aardvark").
@@ -195,6 +208,10 @@ def create_service_with_file(self,
         :type setup: bool
         :param legacy: Install the service in 2.8 legacy compatibility mode.
         :type legacy: bool
+        :param config: Configuration values.
+        :type config: dict
+        :param dependencies: Dependency settings.
+        :type dependencies: dict
         :return: Service metadata.
         :rtype: dict
         :raise arango.exceptions.FoxxServiceCreateError: If install fails.
@@ -207,7 +224,7 @@ def create_service_with_file(self,
         if legacy is not None:
             params['legacy'] = legacy
 
-        data = self._encode_file(filename)
+        data = self._encode(filename, config, dependencies)
         request = Request(
             method='post',
             endpoint='/_api/foxx',
@@ -294,7 +311,9 @@ def update_service_with_file(self,
                                  teardown=None,
                                  setup=None,
                                  legacy=None,
-                                 force=None):
+                                 force=None,
+                                 config=None,
+                                 dependencies=None):
         """Update (upgrade) a service using a javascript file or zip bundle.
 
         :param mount: Service mount path (e.g "/_admin/aardvark").
@@ -309,6 +328,10 @@ def update_service_with_file(self,
         :type legacy: bool
         :param force: Force update if no service is found.
         :type force: bool
+        :param config: Configuration values.
+        :type config: dict
+        :param dependencies: Dependency settings.
+        :type dependencies: dict
         :return: Updated service metadata.
         :rtype: dict
         :raise arango.exceptions.FoxxServiceUpdateError: If update fails.
@@ -323,7 +346,7 @@ def update_service_with_file(self,
         if force is not None:
             params['force'] = force
 
-        data = self._encode_file(filename)
+        data = self._encode(filename, config, dependencies)
         request = Request(
             method='patch',
             endpoint='/_api/foxx/service',
@@ -410,7 +433,9 @@ def replace_service_with_file(self,
                                   teardown=None,
                                   setup=None,
                                   legacy=None,
-                                  force=None):
+                                  force=None,
+                                  config=None,
+                                  dependencies=None):
         """Replace a service using a javascript file or zip bundle.
 
         :param mount: Service mount path (e.g "/_admin/aardvark").
@@ -425,6 +450,10 @@ def replace_service_with_file(self,
         :type legacy: bool
         :param force: Force install if no service is found.
         :type force: bool
+        :param config: Configuration values.
+        :type config: dict
+        :param dependencies: Dependency settings.
+        :type dependencies: dict
         :return: Replaced service metadata.
         :rtype: dict
         :raise arango.exceptions.FoxxServiceReplaceError: If replace fails.
@@ -439,7 +468,7 @@ def replace_service_with_file(self,
         if force is not None:
             params['force'] = force
 
-        data = self._encode_file(filename)
+        data = self._encode(filename, config, dependencies)
         request = Request(
             method='put',
             endpoint='/_api/foxx/service',

docs/schema.rst

@@ -17,22 +17,26 @@ parameter.
     # Connect to "test" database as root user.
     db = client.db('test', username='root', password='passwd')
 
-    # Create a new collection named "employees".
     if db.has_collection('employees'):
         db.delete_collection('employees')
 
-    employees = db.create_collection(
-        name='employees',
-        schema={
-            'rule': {
-                'type': 'object',
-                'properties': {
-                    'name': {'type': 'string'},
-                    'email': {'type': 'string'}
-                },
-                'required': ['name', 'email']
+    # Create a new collection named "employees" with custom schema.
+    my_schema = {
+        'rule': {
+            'type': 'object',
+            'properties': {
+                'name': {'type': 'string'},
+                'email': {'type': 'string'}
             },
-            'level': 'moderate',
-            'message': 'Schema Validation Failed.'
-        }
-    )
+            'required': ['name', 'email']
+        },
+        'level': 'moderate',
+        'message': 'Schema Validation Failed.'
+    }
+    employees = db.create_collection(name='employees', schema=my_schema)
+
+    # Modify the schema.
+    employees.configure(schema=my_schema)
+
+    # Remove the schema.
+    employees.configure(schema={})

tests/test_collection.py

@@ -44,6 +44,7 @@ def test_collection_misc_methods(col, bad_col, cluster):
     prev_sync = properties['sync']
     properties = col.configure(
         sync=not prev_sync,
+        schema={}
     )
     assert properties['name'] == col.name
     assert properties['system'] is False

tests/test_foxx.py

@@ -37,6 +37,7 @@
 )
 
 service_file = '/tmp/service.zip'
+service_name = 'test'
 
 
 def test_foxx_attributes(db):
@@ -76,7 +77,7 @@ def test_foxx_service_management_json(db, bad_db, cluster):
         legacy=True
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['development'] is True
     assert service['legacy'] is True
     assert service['manifest']['configuration'] == {}
@@ -90,7 +91,7 @@ def test_foxx_service_management_json(db, bad_db, cluster):
     # Test get service
     service = db.foxx.service(service_mount)
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['development'] is True
     assert service['manifest']['configuration'] == {}
     assert service['manifest']['dependencies'] == {}
@@ -116,7 +117,7 @@ def test_foxx_service_management_json(db, bad_db, cluster):
         force=False
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['legacy'] is False
 
     # Test update missing service
@@ -136,7 +137,7 @@ def test_foxx_service_management_json(db, bad_db, cluster):
         force=False
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['legacy'] is True
 
     # Test replace missing service
@@ -173,10 +174,12 @@ def test_foxx_service_management_file(db, cluster):
         filename=path,
         development=True,
         setup=True,
-        legacy=True
+        legacy=True,
+        config={'foo': 'bar'},
+        dependencies={}
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['development'] is True
     assert service['legacy'] is True
     assert service['manifest']['configuration'] == {}
@@ -198,11 +201,15 @@ def test_foxx_service_management_file(db, cluster):
         teardown=False,
         setup=False,
         legacy=False,
-        force=False
+        force=False,
+        config={},
+        dependencies={}
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['legacy'] is False
+    assert service['manifest']['configuration'] == {}
+    assert service['manifest']['dependencies'] == {}
 
     # Test update missing service
     with assert_raises(FoxxServiceUpdateError) as err:
@@ -216,11 +223,15 @@ def test_foxx_service_management_file(db, cluster):
         teardown=True,
         setup=True,
         legacy=True,
-        force=False
+        force=False,
+        config={},
+        dependencies={}
     )
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['legacy'] is True
+    assert service['manifest']['configuration'] == {}
+    assert service['manifest']['dependencies'] == {}
 
     # Test replace missing service
     with assert_raises(FoxxServiceReplaceError) as err:
@@ -326,7 +337,7 @@ def test_foxx_development_toggle(db, cluster):
     # Test enable development mode
     service = db.foxx.enable_development(service_mount)
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['development'] is True
 
     # Test enable development mode for missing service
@@ -337,7 +348,7 @@ def test_foxx_development_toggle(db, cluster):
     # Test disable development mode
     service = db.foxx.disable_development(service_mount)
     assert service['mount'] == service_mount
-    assert service['name'] == 'test'
+    assert service['name'] == service_name
     assert service['development'] is False
 
     # Test disable development mode for missing service