ENH: setup logging and reporting for serverside execution

Summary

• crawler_run_model.yml contains a model for Records that contain informaiton on crawler jobs
• the new logging module sets up logging for serverside jobs
• crawl.py was refactored and now use the above additions

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

I suggest local-testing setup of dpz.

• set pylib to package: "git+https://gitlab.indiscale.com/caosdb/src/caosdb-pylib.git@f-validate-caoscrawler"
• set caoscrawler to package: "git+https://gitlab.indiscale.com/caosdb/src/caosdb-crawler.git@f-email-notify"
• add the data model crawler_run_model.yml
• call python runcrawler.py
• check the email folder in docker /tmp/mail/somemail
• check the CrawlerRun Record in LinkAhead

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 (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• 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 (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• 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 specifications? Are they satisfied?

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

integrationtests/test_use_case_simple_presentation.py

@@ -22,6 +22,7 @@
 # ** end header
 #
 
+import logging
 import os
 import pytest
 from subprocess import run
@@ -38,7 +39,7 @@ DATADIR = os.path.join(os.path.dirname(__file__), "test_data",
                        "extroot", "use_case_simple_presentation")
 
 
-def test_complete_crawler(clear_database):
+def test_complete_crawler(clear_database, caplog):
     # Setup the data model:
     model = parser.parse_model_from_yaml(os.path.join(DATADIR, "model.yml"))
     model.sync_data_model(noquestion=True, verbose=False)
@@ -56,16 +57,17 @@ def test_complete_crawler(clear_database):
             forceAllowSymlinks=False)
 
     # test that a bad value for "remove_prefix" leads to runtime error
-    with pytest.raises(RuntimeError) as re:
-        crawler_main(
-            crawled_directory_path=os.path.join(DATADIR),
-            cfood_file_name=os.path.join(DATADIR, "cfood.yml"),
-            identifiables_definition_file=os.path.join(DATADIR, "identifiables.yml"),
-            provenance_file=os.path.join(DATADIR, "provenance.yml"),
-            dry_run=False,
-            remove_prefix="sldkfjsldf",
-        )
-    assert "path does not start with the prefix" in str(re.value)
+    caplog.set_level(logging.DEBUG, logger="caoscrawler.crawl")
+    assert 1 == crawler_main(
+        crawled_directory_path=os.path.join(DATADIR),
+        cfood_file_name=os.path.join(DATADIR, "cfood.yml"),
+        identifiables_definition_file=os.path.join(DATADIR, "identifiables.yml"),
+        provenance_file=os.path.join(DATADIR, "provenance.yml"),
+        dry_run=False,
+        remove_prefix="sldkfjsldf",
+    )
+    assert "path does not start with the prefix" in caplog.text
+    caplog.clear()
 
     crawler_main(
         crawled_directory_path=os.path.join(DATADIR),