MAINT: further tests and docs

Summary

The extern keyword of the yml model parser is now better tested and documented.

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.

integrationtests/insert_model.py

@@ -5,18 +5,29 @@ from caosadvancedtools.cfoods.h5 import H5CFood
 from caosadvancedtools.models.data_model import DataModel
 from caosadvancedtools.models.parser import parse_model_from_yaml
 
-model = parse_model_from_yaml("model.yml")
-model.sync_data_model(noquestion=True)
-
-if len(db.execute_query("FIND Property alias")) == 0:
-    al = db.Property(name="alias")
-    al.add_parent(name="name")
-    al.insert()
-
-h5model = db.Container()
-h5file = h5py.File('extroot/ExperimentalData/2010_TestProject/2019-02-03/hdf5_dummy_file.hdf5', 'r')
-H5CFood.create_structure(h5file, create_recordTypes=True, collection=h5model,
-                         root_name="ExampleH5")
-print(h5model)
-h5model = DataModel(h5model)
-h5model.sync_data_model(noquestion=True)
+
+def main():
+
+    # for testing existing data model parts with the YAML Interface
+    db.RecordType(name="TestRT1", datatype=db.TEXT).insert()
+    db.Property(name="TestP1", datatype=db.TEXT).insert()
+
+    model = parse_model_from_yaml("model.yml")
+    model.sync_data_model(noquestion=True)
+
+    if len(db.execute_query("FIND Property alias")) == 0:
+        al = db.Property(name="alias")
+        al.add_parent(name="name")
+        al.insert()
+
+    h5model = db.Container()
+    h5file = h5py.File(
+        'extroot/ExperimentalData/2010_TestProject/2019-02-03/hdf5_dummy_file.hdf5', 'r')
+    H5CFood.create_structure(h5file, create_recordTypes=True, collection=h5model,
+                             root_name="ExampleH5")
+    h5model = DataModel(h5model)
+    h5model.sync_data_model(noquestion=True)
+
+
+if __name__ == "__main__":
+    main()