[issue-359] Extract common method to get all spdx element ids inside a document

Signed-off-by: Nicolaus Weidner <nicolaus.weidner@tngtech.com>

Author: Nicolaus Weidner

src/document_utils.py

@@ -0,0 +1,20 @@
+#  Copyright (c) 2022 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 List
+
+from src.model.document import Document
+
+
+def get_contained_spdx_element_ids(document: Document) -> List[str]:
+    element_ids = [file.spdx_id for file in document.files]
+    element_ids.extend([package.spdx_id for package in document.packages])
+    element_ids.extend([snippet.spdx_id for snippet in document.snippets])
+    return element_ids

src/jsonschema/document_converter.py

@@ -10,6 +10,7 @@
 #  limitations under the License.
 from typing import Type, Any
 
+from src.document_utils import get_contained_spdx_element_ids
 from src.jsonschema.annotation_converter import AnnotationConverter
 from src.jsonschema.converter import TypedConverter
 from src.jsonschema.creation_info_converter import CreationInfoConverter
@@ -65,9 +66,7 @@ def _get_property_value(self, document: Document, document_property: DocumentPro
             return document.creation_info.spdx_id
         elif document_property == DocumentProperty.ANNOTATIONS:
             # annotations referencing files, packages or snippets will be added to those elements directly
-            element_ids = [file.spdx_id for file in document.files]
-            element_ids.extend([package.spdx_id for package in document.packages])
-            element_ids.extend([snippet.spdx_id for snippet in document.snippets])
+            element_ids = get_contained_spdx_element_ids(document)
             document_annotations = filter(lambda annotation: annotation.spdx_id not in element_ids,
                                           document.annotations)
             return [self.annotation_converter.convert(annotation) for annotation in document_annotations] or None

src/validation/spdx_id_validators.py

@@ -12,6 +12,7 @@
 import re
 from typing import List
 
+from src.document_utils import get_contained_spdx_element_ids
 from src.model.document import Document
 from src.model.file import File
 
@@ -36,10 +37,7 @@ def is_spdx_id_present_in_document(spdx_id: str, document: Document) -> bool:
 
 def get_list_of_all_spdx_ids(document: Document) -> List[str]:
     all_spdx_ids_in_document: List[str] = [document.creation_info.spdx_id]
-
-    all_spdx_ids_in_document.extend([package.spdx_id for package in document.packages])
-    all_spdx_ids_in_document.extend([file.spdx_id for file in document.files])
-    all_spdx_ids_in_document.extend([snippet.spdx_id for snippet in document.snippets])
+    all_spdx_ids_in_document.extend(get_contained_spdx_element_ids(document))
 
     return all_spdx_ids_in_document