implement version checks

Author: elichad

rocrate_validator/profiles/five-safes-crate/must/15_metadata_file.py

@@ -0,0 +1,57 @@
+# Copyright (c) 2024-2025 CRS4
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Any
+import re
+
+import rocrate_validator.log as logging
+from rocrate_validator.models import Severity, ValidationContext
+from rocrate_validator.requirements.python import (PyFunctionCheck, check,
+                                                   requirement)
+from rocrate_validator.utils import HttpRequester
+
+# set up logging
+logger = logging.getLogger(__name__)
+
+
+@requirement(name="RO-Crate context version")
+class FileDescriptorExistence(PyFunctionCheck):
+    """The RO-Crate metadata file MUST include the RO-Crate context version 1.2 (or later minor version) in `@context`"""
+
+    @check(name="RO-Crate context version", severity=Severity.REQUIRED)
+    def test_existence(self, context: ValidationContext) -> bool:
+        """
+        The RO-Crate metadata file MUST include the RO-Crate context version 1.2 (or later minor version) in `@context`
+        """
+        try:
+            json_dict = context.ro_crate.metadata.as_dict()
+            context_value = json_dict["@context"]
+            pattern = re.compile(r"https://w3id\.org/ro/crate/1\.[2-9](-DRAFT)?/context")
+            passed = True
+            if isinstance(context_value, list):
+                if not any(pattern.match(item) for item in context_value if isinstance(item, str)):
+                    passed = False
+            else:
+                if not pattern.match(context_value):
+                    passed = False
+            if not passed:
+                context.result.add_issue(
+                    f"The RO-Crate metadata file MUST include the RO-Crate context "
+                    "version 1.2 (or later minor version) in `@context`", self)
+            return passed
+
+        except Exception as e:
+            if logger.isEnabledFor(logging.DEBUG):
+                logger.exception(e)
+        return True

rocrate_validator/profiles/five-safes-crate/must/15_metadata_file.ttl

@@ -0,0 +1,39 @@
+# Copyright (c) 2025 eScience Lab, The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+@prefix ro-crate: <https://github.com/crs4/rocrate-validator/profiles/ro-crate/> .
+@prefix five-safes-crate: <https://github.com/eScienceLab/rocrate-validator/profiles/five-safes-crate/> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix schema: <http://schema.org/> .
+@prefix purl: <http://purl.org/dc/terms/> .
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix validator: <https://github.com/crs4/rocrate-validator/> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix dct: <http://purl.org/dc/terms/> .
+
+five-safes-crate:MetadataFileDescriptorProperties a sh:NodeShape ;
+    sh:name "RO-Crate conforms to 1.2 or later minor version" ;
+    sh:description """The RO-Crate metadata file descriptor MUST have a `conformsTo` property with RO-Crate specification version 1.2 or later minor version""";
+    sh:targetClass ro-crate:ROCrateMetadataFileDescriptor ;
+    sh:property [
+        a sh:PropertyShape ;
+        sh:name "RO-Crate conforms to 1.2 or later minor version" ;
+        sh:description "The RO-Crate metadata file descriptor MUST have a `conformsTo` property with RO-Crate specification version 1.2 or later minor version" ;
+        sh:minCount 1 ;
+        sh:nodeKind sh:IRI ;
+        sh:path dct:conformsTo ;
+        sh:pattern "https://w3id\\.org/ro/crate/(1\\.[2-9](-DRAFT)?)" ;
+        sh:severity sh:Violation;
+        sh:message "The RO-Crate metadata file descriptor MUST have a `conformsTo` property with RO-Crate specification version 1.2 or later minor version" ;
+    ] .