Issue 456 add rdf parser

.github/workflows/install_and_test.yml

@@ -23,7 +23,6 @@ jobs:
           python -m build -nwx .
           python -m pip install --upgrade ./dist/*.whl
           python -m pip install pytest
-          python -m pip install rdflib
         shell: bash
       - name: Run tests
         run: pytest

pyproject.toml

@@ -28,8 +28,7 @@ dependencies = ["click", "pyyaml", "xmltodict", "rdflib", "typeguard", "uritools
 dynamic = ["version"]
 
 [project.optional-dependencies]
-test = ["pytest", "rdflib"]
-rdf = ["rdflib"]
+test = ["pytest"]
 
 [project.scripts]
 pyspdxtools = "spdx.clitools.pyspdxtools:main"

src/spdx/writer/casing_tools.py → src/spdx/casing_tools.py

@@ -14,3 +14,8 @@
 def snake_case_to_camel_case(snake_case_string: str) -> str:
     each_word_capitalized = sub(r"[_\-]+", " ", snake_case_string).title().replace(" ", "")
     return each_word_capitalized[0].lower() + each_word_capitalized[1:]
+
+
+def camel_case_to_snake_case(camel_case_string: str) -> str:
+    snake_case_string = sub("(?!^)([A-Z]+)", r"_\1", camel_case_string).lower()
+    return snake_case_string

src/spdx/jsonschema/converter.py

@@ -13,7 +13,7 @@
 
 from spdx.jsonschema.json_property import JsonProperty
 from spdx.model.document import Document
-from spdx.writer.casing_tools import snake_case_to_camel_case
+from spdx.casing_tools import snake_case_to_camel_case
 
 MISSING_IMPLEMENTATION_MESSAGE = "Must be implemented"
 

src/spdx/parser/jsonlikedict/actor_parser.py → src/spdx/parser/actor_parser.py

@@ -13,7 +13,7 @@
 
 from spdx.model.actor import Actor, ActorType
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.dict_parsing_functions import construct_or_raise_parsing_error
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error
 
 
 class ActorParser:

src/spdx/parser/jsonlikedict/annotation_parser.py

@@ -14,9 +14,9 @@
 from spdx.model.actor import Actor
 from spdx.model.annotation import Annotation, AnnotationType
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.actor_parser import ActorParser
-from spdx.parser.jsonlikedict.dict_parsing_functions import construct_or_raise_parsing_error, \
-    parse_field_or_log_error, append_parsed_field_or_log_error, raise_parsing_error_if_logger_has_messages
+from spdx.parser.actor_parser import ActorParser
+from spdx.parser.jsonlikedict.dict_parsing_functions import parse_field_or_log_error, append_parsed_field_or_log_error
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.datetime_conversions import datetime_from_str
 from spdx.parser.logger import Logger
 

src/spdx/parser/jsonlikedict/checksum_parser.py

@@ -11,8 +11,8 @@
 from typing import Dict, Optional
 
 from spdx.model.checksum import Checksum, ChecksumAlgorithm
-from spdx.parser.jsonlikedict.dict_parsing_functions import raise_parsing_error_if_logger_has_messages, json_str_to_enum_name, \
-    construct_or_raise_parsing_error
+from spdx.parser.jsonlikedict.dict_parsing_functions import json_str_to_enum_name
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.parser.logger import Logger
 
 

src/spdx/parser/jsonlikedict/creation_info_parser.py

@@ -17,11 +17,12 @@
 from spdx.model.external_document_ref import ExternalDocumentRef
 from spdx.model.version import Version
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.actor_parser import ActorParser
+from spdx.parser.actor_parser import ActorParser
 from spdx.parser.jsonlikedict.checksum_parser import ChecksumParser
 from spdx.parser.jsonlikedict.dict_parsing_functions import append_parsed_field_or_log_error, \
-    raise_parsing_error_if_logger_has_messages, construct_or_raise_parsing_error, parse_field_or_log_error, \
+    parse_field_or_log_error, \
     parse_field_or_no_assertion
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.datetime_conversions import datetime_from_str
 from spdx.parser.logger import Logger
 

src/spdx/parser/jsonlikedict/dict_parsing_functions.py

@@ -12,9 +12,9 @@
 
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
-from common.typing.constructor_type_errors import ConstructorTypeErrors
 from spdx.parser.error import SPDXParsingError
 from spdx.parser.logger import Logger
+from spdx.parser.parsing_functions import raise_parsing_error_if_logger_has_messages
 
 
 def json_str_to_enum_name(json_str: str) -> str:
@@ -23,14 +23,6 @@ def json_str_to_enum_name(json_str: str) -> str:
     return json_str.replace("-", "_").upper()
 
 
-def construct_or_raise_parsing_error(object_to_construct: Any, args_for_construction: Dict) -> Any:
-    try:
-        constructed_object = object_to_construct(**args_for_construction)
-    except ConstructorTypeErrors as err:
-        raise SPDXParsingError([f"Error while constructing {object_to_construct.__name__}: {err.get_messages()}"])
-    return constructed_object
-
-
 def parse_field_or_log_error(logger: Logger, field: Any, parsing_method: Callable = lambda x: x, default: Any = None,
                              field_is_list: bool = False) -> Any:
     if not field:
@@ -59,14 +51,6 @@ def append_parsed_field_or_log_error(logger: Logger, list_to_append_to: List[Any
     return list_to_append_to
 
 
-def raise_parsing_error_if_logger_has_messages(logger: Logger, parsed_object_name: str = None):
-    if logger.has_messages():
-        if parsed_object_name:
-            raise SPDXParsingError([f"Error while parsing {parsed_object_name}: {logger.get_messages()}"])
-        else:
-            raise SPDXParsingError(logger.get_messages())
-
-
 def parse_field_or_no_assertion_or_none(field: Optional[str], method_for_field: Callable = lambda x: x) -> Any:
     if field == SpdxNoAssertion().__str__():
         return SpdxNoAssertion()

src/spdx/parser/jsonlikedict/extracted_licensing_info_parser.py

@@ -12,7 +12,8 @@
 
 from spdx.model.extracted_licensing_info import ExtractedLicensingInfo
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
-from spdx.parser.jsonlikedict.dict_parsing_functions import construct_or_raise_parsing_error, parse_field_or_no_assertion
+from spdx.parser.jsonlikedict.dict_parsing_functions import parse_field_or_no_assertion
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error
 from spdx.parser.logger import Logger
 
 

src/spdx/parser/jsonlikedict/file_parser.py

@@ -16,9 +16,9 @@
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.parser.jsonlikedict.checksum_parser import ChecksumParser
-from spdx.parser.jsonlikedict.dict_parsing_functions import raise_parsing_error_if_logger_has_messages, \
-    construct_or_raise_parsing_error, parse_field_or_log_error, \
+from spdx.parser.jsonlikedict.dict_parsing_functions import parse_field_or_log_error, \
     parse_field_or_no_assertion_or_none
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.parser.jsonlikedict.license_expression_parser import LicenseExpressionParser
 from spdx.parser.logger import Logger
 

src/spdx/parser/jsonlikedict/json_like_dict_parser.py

@@ -14,8 +14,8 @@
 from spdx.parser.error import SPDXParsingError
 from spdx.parser.jsonlikedict.annotation_parser import AnnotationParser
 from spdx.parser.jsonlikedict.creation_info_parser import CreationInfoParser
-from spdx.parser.jsonlikedict.dict_parsing_functions import raise_parsing_error_if_logger_has_messages, \
-    construct_or_raise_parsing_error, parse_list_of_elements
+from spdx.parser.jsonlikedict.dict_parsing_functions import parse_list_of_elements
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.parser.jsonlikedict.extracted_licensing_info_parser import ExtractedLicensingInfoParser
 from spdx.parser.jsonlikedict.file_parser import FileParser
 from spdx.parser.logger import Logger

src/spdx/parser/jsonlikedict/license_expression_parser.py

@@ -15,8 +15,8 @@
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.dict_parsing_functions import append_parsed_field_or_log_error, \
-    raise_parsing_error_if_logger_has_messages
+from spdx.parser.jsonlikedict.dict_parsing_functions import append_parsed_field_or_log_error
+from spdx.parser.parsing_functions import raise_parsing_error_if_logger_has_messages
 from spdx.parser.logger import Logger
 
 

src/spdx/parser/jsonlikedict/package_parser.py

@@ -18,11 +18,11 @@
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.actor_parser import ActorParser
+from spdx.parser.actor_parser import ActorParser
 from spdx.parser.jsonlikedict.checksum_parser import ChecksumParser
 from spdx.parser.jsonlikedict.dict_parsing_functions import append_parsed_field_or_log_error, \
-    raise_parsing_error_if_logger_has_messages, json_str_to_enum_name, construct_or_raise_parsing_error, \
-    parse_field_or_log_error, parse_field_or_no_assertion_or_none, parse_field_or_no_assertion
+    json_str_to_enum_name, parse_field_or_log_error, parse_field_or_no_assertion_or_none, parse_field_or_no_assertion
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.datetime_conversions import datetime_from_str
 from spdx.parser.jsonlikedict.license_expression_parser import LicenseExpressionParser
 from spdx.parser.logger import Logger

src/spdx/parser/jsonlikedict/relationship_parser.py

@@ -13,10 +13,9 @@
 from spdx.model.relationship import Relationship, RelationshipType
 from common.typing.constructor_type_errors import ConstructorTypeErrors
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.dict_parsing_functions import raise_parsing_error_if_logger_has_messages, \
-    json_str_to_enum_name, \
-    construct_or_raise_parsing_error, \
+from spdx.parser.jsonlikedict.dict_parsing_functions import json_str_to_enum_name, \
     parse_field_or_log_error, parse_field_or_no_assertion_or_none, delete_duplicates_from_list
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
 from spdx.parser.logger import Logger
 
 

src/spdx/parser/jsonlikedict/snippet_parser.py

@@ -16,8 +16,9 @@
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.dict_parsing_functions import construct_or_raise_parsing_error, parse_field_or_log_error, \
+from spdx.parser.jsonlikedict.dict_parsing_functions import parse_field_or_log_error, \
     parse_field_or_no_assertion_or_none
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error
 
 from spdx.parser.jsonlikedict.license_expression_parser import LicenseExpressionParser
 from spdx.parser.logger import Logger

src/spdx/parser/parse_anything.py

@@ -10,14 +10,15 @@
 # limitations under the License.
 from spdx.formats import file_name_to_format, FileFormat
 from spdx.parser.json import json_parser
+from spdx.parser.rdf import rdf_parser
 from spdx.parser.xml import xml_parser
 from spdx.parser.yaml import yaml_parser
 
 
 def parse_file(file_name: str):
     input_format = file_name_to_format(file_name)
     if input_format == FileFormat.RDF_XML:
-        raise NotImplementedError("Currently, the rdf parser is not implemented")
+        return rdf_parser.parse_from_file(file_name)
     elif input_format == FileFormat.TAG_VALUE:
         raise NotImplementedError("Currently, the tag-value parser is not implemented")
     elif input_format == FileFormat.JSON:

src/spdx/parser/parsing_functions.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2023 spdx contributors
+# 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, Dict
+
+from common.typing.constructor_type_errors import ConstructorTypeErrors
+from spdx.parser.error import SPDXParsingError
+from spdx.parser.logger import Logger
+
+
+def construct_or_raise_parsing_error(object_to_construct: Any, args_for_construction: Dict) -> Any:
+    try:
+        constructed_object = object_to_construct(**args_for_construction)
+    except ConstructorTypeErrors as err:
+        raise SPDXParsingError([f"Error while constructing {object_to_construct.__name__}: {err.get_messages()}"])
+    return constructed_object
+
+
+def raise_parsing_error_if_logger_has_messages(logger: Logger, parsed_object_name: str = None):
+    if logger.has_messages():
+        if parsed_object_name:
+            raise SPDXParsingError([f"Error while parsing {parsed_object_name}: {logger.get_messages()}"])
+        else:
+            raise SPDXParsingError(logger.get_messages())

src/spdx/parser/rdf/annotation_parser.py

@@ -0,0 +1,39 @@
+# Copyright (c) 2023 spdx contributors
+# 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 rdflib import URIRef, Graph, RDFS
+
+from spdx.datetime_conversions import datetime_from_str
+from spdx.model.annotation import Annotation, AnnotationType
+from spdx.parser.actor_parser import ActorParser
+from spdx.parser.logger import Logger
+from spdx.parser.parsing_functions import raise_parsing_error_if_logger_has_messages, construct_or_raise_parsing_error
+from spdx.parser.rdf.graph_parsing_functions import parse_literal, parse_spdx_id, parse_enum_value
+from spdx.rdfschema.namespace import SPDX_NAMESPACE
+
+
+def parse_annotation(annotation_node: URIRef, graph: Graph, parent_node: URIRef, doc_namespace: str) -> Annotation:
+    logger = Logger()
+    spdx_id = parse_spdx_id(parent_node, doc_namespace, graph)
+    annotator = parse_literal(logger, graph, annotation_node, SPDX_NAMESPACE.annotator,
+                              parsing_method=ActorParser.parse_actor)
+    annotation_type = parse_literal(logger, graph, annotation_node, SPDX_NAMESPACE.annotationType,
+                                    parsing_method=lambda x: parse_enum_value(x, AnnotationType,
+                                                                              SPDX_NAMESPACE.annotationType_))
+    annotation_date = parse_literal(logger, graph, annotation_node, SPDX_NAMESPACE.annotationDate,
+                                    parsing_method=datetime_from_str)
+    annotation_comment = parse_literal(logger, graph, annotation_node, RDFS.comment)
+
+    raise_parsing_error_if_logger_has_messages(logger, "Annotation")
+    annotation = construct_or_raise_parsing_error(Annotation, dict(spdx_id=spdx_id, annotation_type=annotation_type,
+                                                                   annotator=annotator, annotation_date=annotation_date,
+                                                                   annotation_comment=annotation_comment))
+
+    return annotation

src/spdx/parser/rdf/checksum_parser.py

@@ -0,0 +1,40 @@
+# Copyright (c) 2023 spdx contributors
+# 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 rdflib import Graph, URIRef
+from spdx.parser.error import SPDXParsingError
+
+from spdx.model.checksum import Checksum, ChecksumAlgorithm
+from spdx.parser.logger import Logger
+from spdx.parser.parsing_functions import construct_or_raise_parsing_error, raise_parsing_error_if_logger_has_messages
+from spdx.parser.rdf.graph_parsing_functions import parse_literal, remove_prefix
+from spdx.rdfschema.namespace import SPDX_NAMESPACE
+
+
+def parse_checksum(parent_node: URIRef, graph: Graph) -> Checksum:
+    logger = Logger()
+    algorithm = parse_literal(logger, graph, parent_node, SPDX_NAMESPACE.algorithm,
+                              parsing_method=convert_rdf_to_algorithm)
+    value = parse_literal(logger, graph, parent_node, SPDX_NAMESPACE.checksumValue)
+
+    raise_parsing_error_if_logger_has_messages(logger, "Checksum")
+    checksum = construct_or_raise_parsing_error(Checksum, dict(algorithm=algorithm, value=value))
+    return checksum
+
+
+def convert_rdf_to_algorithm(algorithm: str) -> ChecksumAlgorithm:
+    algorithm = remove_prefix(algorithm, SPDX_NAMESPACE.checksumAlgorithm_).upper()
+    if "BLAKE2B" in algorithm:
+        algorithm = algorithm.replace("BLAKE2B", "BLAKE2B_")
+    try:
+        checksum = ChecksumAlgorithm[algorithm]
+    except KeyError:
+        raise SPDXParsingError([f"Invalid value for ChecksumAlgorithm: {algorithm}"])
+    return checksum