Draft: F json schema

Summary

See #69 (closed).

This MR is supposed to provide a json schema for the yaml model sync interface.

See also: https://docs.indiscale.com//caosdb-advanced-user-tools/yaml_interface.html

Focus

Point the reviewer to the core of the code change. Where should they start
reading? What should they focus on (e.g. security, performance,
maintainability, user-friendliness, compliance with the specs, finding more
corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related Issues
• Up-to-date CHANGELOG.md
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosadvancedtools/models/parser.py

@@ -17,10 +17,12 @@ Parents can be provided under the 'inherit_from_xxxx' keywords. The value needs
 to be a list with the names. Here, NO NEW entities can be defined.
 """
 import re
+import os
 import sys
 
 import caosdb as db
 import yaml
+from jsonschema import validate
 
 from .data_model import DataModel
 
@@ -128,6 +130,8 @@ class Parser(object):
         with open(filename, 'r') as outfile:
             ymlmodel = yaml.load(outfile, Loader=SafeLineLoader)
 
+        self._validate(ymlmodel)
+
         return self._create_model_from_dict(ymlmodel)
 
     def parse_model_from_string(self, string):
@@ -144,9 +148,21 @@ class Parser(object):
           The created DataModel
         """
         ymlmodel = yaml.load(string, Loader=SafeLineLoader)
+        self._validate(ymlmodel)
 
         return self._create_model_from_dict(ymlmodel)
 
+    def _validate(self, valobj):
+        """Run validation of the profile against schema-model.yml residing
+        in the linkahead script folder.
+
+        """
+
+        with open(os.path.join(os.path.dirname(__file__), "schema-model.yml")) as f:
+            schema = yaml.load(f, Loader=yaml.SafeLoader)
+        validate(instance=valobj,
+                 schema=schema)
+
     def _create_model_from_dict(self, ymlmodel):
         """Create and return a data model out of the YAML dict `ymlmodel`.