Merge branch 'upstream-develop' into five-safes-on-upstream-develop

Author: elichad

tests/shared.py

@@ -98,7 +98,6 @@ def replace_uri_in_graph(graph, old_uri_str, new_uri_str):
 
     return g
 
-
 def _uses_https_schema(graph: rdflib.Graph) -> bool:
     for s, p, o in graph.triples((None, None, None)):
         for term in (s, p, o):
@@ -115,53 +114,36 @@ def _prepare_temp_rocrate(
 ) -> Path:
     # `mkdtemp` returns a stable path the test owns; `TemporaryDirectory().name`
     # was deleted on GC before copytree ran. `dirs_exist_ok=True` lets us copy
-    # into the already-created directory.
+    # into the (already-created) mkdtemp directory.
     temp_rocrate_path = Path(tempfile.mkdtemp())
-    shutil.copytree(
-        rocrate_path,
-        temp_rocrate_path,
-        dirs_exist_ok=True,
-    )
-
-    metadata_path = temp_rocrate_path / "ro-crate-metadata.json"
-
-    with metadata_path.open(encoding="utf-8") as f:
+    shutil.copytree(rocrate_path, temp_rocrate_path, dirs_exist_ok=True)
+    with (temp_rocrate_path / "ro-crate-metadata.json").open(encoding="utf-8") as f:
         rocrate = json.load(f)
-
     if rocrate_entity_patch is not None:
         for key, value in rocrate_entity_patch.items():
             for entity in rocrate["@graph"]:
                 if entity["@id"] == key:
                     entity.update(value)
                     break
-
-        with metadata_path.open("w", encoding="utf-8") as f:
+        with (temp_rocrate_path / "ro-crate-metadata.json").open("w", encoding="utf-8") as f:
             json.dump(rocrate, f)
-
     if rocrate_entity_mod_sparql is not None:
         rocrate_graph = load_graph_and_preserve_relative_ids(rocrate)
-
         if _uses_https_schema(rocrate_graph):
             rocrate_entity_mod_sparql = rocrate_entity_mod_sparql.replace(
                 "http://schema.org/",
                 "https://schema.org/",
             )
-
         rocrate_graph.update(rocrate_entity_mod_sparql)
-
-        context = rocrate.get(
-            "@context",
-            "https://w3id.org/ro/crate/1.2/context",
-        )
-
+        # preserve the original context to avoid forcing a downgrade/upgrade
+        context_uri = rocrate.get("@context", "https://w3id.org/ro/crate/1.2/context")
         rocrate_graph.serialize(
-            metadata_path,
+            Path(temp_rocrate_path, "ro-crate-metadata.json"),
             format="json-ld",
-            context=context,
+            context=context_uri,
             indent=2,
             use_native_types=True,
         )
-
     return temp_rocrate_path
 
 
@@ -201,17 +183,12 @@ def do_entity_test(  # pylint: disable=too-many-locals
         rocrate_path = Path(rocrate_path)
 
     temp_rocrate_path = None
-
     if (
         any([rocrate_entity_patch, rocrate_entity_mod_sparql])
         and isinstance(rocrate_path, Path)
         and rocrate_path.is_dir()
     ):
-        temp_rocrate_path = _prepare_temp_rocrate(
-            rocrate_path,
-            rocrate_entity_patch,
-            rocrate_entity_mod_sparql,
-        )
+        temp_rocrate_path = _prepare_temp_rocrate(rocrate_path, rocrate_entity_patch, rocrate_entity_mod_sparql)
         rocrate_path = temp_rocrate_path
 
     if expected_triggered_requirements is None:
@@ -225,8 +202,8 @@ def do_entity_test(  # pylint: disable=too-many-locals
         logger.debug("Requirement severity: %s", requirement_severity)
         logger.debug("Checks to skip: %s", skip_checks)
 
+        # validate RO-Crate
         relative_root_path = Path(rocrate_relative_root_path) if rocrate_relative_root_path is not None else None
-
         result: models.ValidationResult = services.validate(
             models.ValidationSettings(
                 rocrate_uri=models.URI(rocrate_path),
@@ -247,25 +224,23 @@ def do_entity_test(  # pylint: disable=too-many-locals
         )
 
         assert result.context is not None, "Validation context should not be None"
-
         logger.debug(
             "Expected requirement severity to be %s, got %s",
             requirement_severity,
             result.context.requirement_severity,
         )
-
         assert result.passed() == expected_validation_result, (
             f"RO-Crate should be {'valid' if expected_validation_result else 'invalid'}"
         )
 
-        failed_requirements = [requirement.name for requirement in result.failed_requirements]
+        # check requirement
+        failed_requirements = [_.name for _ in result.failed_requirements]
 
         for expected_triggered_requirement in expected_triggered_requirements:
             if expected_triggered_requirement not in failed_requirements:
                 raise AssertionError(
-                    "The expected requirement "
-                    f'"{expected_triggered_requirement}" was not found in the '
-                    "failed requirements"
+                    f"The expected requirement "
+                    f'"{expected_triggered_requirement}" was not found in the failed requirements'
                 )
 
         detected_issues = [
@@ -276,42 +251,18 @@ def do_entity_test(  # pylint: disable=too-many-locals
         logger.debug("Expected issues: %s", expected_triggered_issues)
 
         for expected_issue in expected_triggered_issues:
-            if not any(expected_issue in issue for issue in detected_issues):
+            if not any(expected_issue in issue for issue in detected_issues):  # support partial match
                 raise AssertionError(f'The expected issue "{expected_issue}" was not found in the detected issues')
-
     except Exception:
         if logger.isEnabledFor(logging.DEBUG):
-            logger.exception(
-                "Failed to validate RO-Crate @ path: %s",
-                rocrate_path,
-            )
-            logger.debug(
-                "Requirement severity: %s",
-                requirement_severity,
-            )
-            logger.debug(
-                "Expected validation result: %s",
-                expected_validation_result,
-            )
-            logger.debug(
-                "Expected triggered requirements: %s",
-                expected_triggered_requirements,
-            )
-            logger.debug(
-                "Expected triggered issues: %s",
-                expected_triggered_issues,
-            )
-            logger.debug(
-                "Failed requirements: %s",
-                failed_requirements,
-            )
-            logger.debug(
-                "Detected issues: %s",
-                detected_issues,
-            )
-
+            logger.exception("Failed to validate RO-Crate @ path: %s", rocrate_path)
+            logger.debug("Requirement severity: %s", requirement_severity)
+            logger.debug("Expected validation result: %s", expected_validation_result)
+            logger.debug("Expected triggered requirements: %s", expected_triggered_requirements)
+            logger.debug("Expected triggered issues: %s", expected_triggered_issues)
+            logger.debug("Failed requirements: %s", failed_requirements)
+            logger.debug("Detected issues: %s", detected_issues)
         raise
-
     finally:
         if temp_rocrate_path is not None:
             logger.debug(