ENH: validation of configuration schema including unit tests

src/caosdb/configuration.py

@@ -24,6 +24,7 @@
 
 import os
 import yaml
+from jsonschema import validate
 
 try:
     # python2
@@ -48,7 +49,9 @@ def configure(inifile):
         _pycaosdbconf = None
     if _pycaosdbconf is None:
         _reset_config()
-    return _pycaosdbconf.read(inifile)
+    read_config = _pycaosdbconf.read(inifile)
+    validate_yaml_schema(config_to_yaml(_pycaosdbconf))
+    return read_config
 
 def get_config():
     return _pycaosdbconf
@@ -59,13 +62,18 @@ def config_to_yaml(config):
     for s in config.sections():
         valobj[s] = {}
         for key, value in config[s].items():
+            # TODO: Can the type be inferred from the config object?
+            if key in ["timeout", "debug"]:
+                valobj[s][key] = int(value)
+            elif key in ["ssl_insecure"]:
+                valobj[s][key] = bool(value)
+            else:
                 valobj[s][key] = value
 
     return valobj
 
-def validate(valobj):
-    print(__file__)
+def validate_yaml_schema(valobj):
     with open(os.path.join(os.path.dirname(__file__), "schema-pycaosdb-ini.yml")) as f:
         schema = yaml.load(f, Loader=yaml.SafeLoader)
-    validate(instance=valobj, schema=schema)
+    validate(instance=valobj, schema=schema["schema-pycaosdb-ini"])
     

src/caosdb/schema-pycaosdb-ini.yml

+schema-pycaosdb-ini:
+  type: object
+  additionalProperties: false
+  properties:
     Container:
       additionalProperties: false
       properties:
         debug:
+          default: 0
           type: integer
+          enum: [0, 1, 2]
     Connection:
       description: Settings for the connection to the CaosDB server
       additionalProperties: false
@@ -12,8 +18,6 @@ Connection:
           type: string
           pattern: https://[-a-zA-Z0-9\.]+(:[0-9]+)?/
           examples: [https://demo.indiscale.com/, https://localhost:10443/]
-    debug:
-      type: integer
         username:
           type: string
           description: User name used for authentication with the server
@@ -23,6 +27,8 @@ Connection:
           type: string
           default: input
           enum: [input, plain, pass, keyring]
+        password_identifier:
+          type: string
         password:
           type: string
           examples: [caosdb]
@@ -43,6 +49,7 @@ Connection:
         debug:
           default: 0
           type: integer
+          enum: [0, 1, 2]
           description: The debug key allows control the verbosity. Set it to 1 or 2 in case you  want to see debugging output or if you want to learn more about the internals of the protocol.  0 disables debugging output.
         socket_proxy:
           examples: [localhost:12345]
@@ -78,9 +85,3 @@ Connection:
                 const: keyring
           then:
             required: [url, username]
-
-      
-
-        
-
-

unittests/broken_configs/pycaosdb-indiscale-demo.ini

+[Connection]
+url=https://demo.indiscale.com
+username=admin
+password=caosdb
+password_method=plain
+cacert=/etc/ssl/cert.pem
+
+timeout=10000
+debug=0
+
+[Container]
+debug=0
\ No newline at end of file

unittests/broken_configs/pycaosdb1.ini

+[Connection]
+cacert=/very/long/path/to/self/signed/pem/file/caosdb.ca.pem
+url=https://hostname:8833/playground
+username=username
+password_method=pass

unittests/broken_configs/pycaosdb2.ini

+[Connection]
+url=https://0.0.0.0/
+username=username
+password_identifier=SECTION/SUBSECTION/identifier
+password_method=pass
+cacert=/etc/ssl/cert.pem
+ssl_insecure=true
+timeout=10000
+debug=9

unittests/broken_configs/pycaosdb3.ini

+[connection]
+ssl_insecure=true
+url=https://localhost:10443/
+password=caosdb
+username=admin
+password_method=plain
+
+timeout=10000
+debug=0
+
+[Container]
+debug=0

unittests/broken_configs/pycaosdb4.ini

+[Connection]
+ssl_insecure=true
+url=https://localhost:10443/
+password=caosdb
+username=admin
+password_method=plain
+
+timeout=10000
+debug=0
+key=bla
\ No newline at end of file

unittests/test_configs/pycaosdb-indiscale-demo.ini

+[Connection]
+url=https://demo.indiscale.com/
+username=admin
+password=caosdb
+password_method=plain
+cacert=/etc/ssl/cert.pem
+
+timeout=10000
+debug=0
+
+[Container]
+debug=0
\ No newline at end of file

unittests/test_configs/pycaosdb1.ini

+[Connection]
+cacert=/very/long/path/to/self/signed/pem/file/caosdb.ca.pem
+url=https://hostname:8833/playground
+password_identifier=SECTION/caosdb
+username=username
+password_method=pass

unittests/test_configs/pycaosdb2.ini

+[Connection]
+url=https://0.0.0.0/
+username=username
+password_identifier=SECTION/SUBSECTION/identifier
+password_method=pass
+cacert=/etc/ssl/cert.pem
+ssl_insecure=true
+timeout=10000
+debug=0

unittests/test_configs/pycaosdb3.ini

+[Connection]
+ssl_insecure=true
+url=https://localhost:10443/
+password=caosdb
+username=admin
+password_method=plain
+
+timeout=10000
+debug=0
+
+[Container]
+debug=0

unittests/test_schema.py

@@ -2,8 +2,26 @@
 # Test configuration schema
 # A. Schlemmer, 01/2021
 
+import yaml
+from jsonschema import validate
+from jsonschema.exceptions import ValidationError
+from pytest import raises
+from glob import glob
+import os
+from caosdb.configuration import config_to_yaml, validate_yaml_schema
+from configparser import ConfigParser
+
+
 def test_config_files():
-    pass
+    for fn in glob(os.path.join(os.path.dirname(__file__), "test_configs", "*.ini")):
+        c = ConfigParser()
+        c.read(fn)
+        validate_yaml_schema(config_to_yaml(c))
 
 def test_broken_config_files():
-    pass
+    for fn in glob(os.path.join(os.path.dirname(__file__), "broken_configs", "*.ini")):
+        print(fn)
+        with raises(ValidationError):
+            c = ConfigParser()
+            c.read(fn)
+            validate_yaml_schema(config_to_yaml(c))