[issue-578] remove hasFiles output from json writer

Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>

Author: armintaenzertng

README.md

@@ -102,7 +102,7 @@ instead of `bin`.
     * Note: in-place manipulations like `list.append(item)` will circumvent the type checking (a `TypeError` will still be raised when reading `list` again). We recommend using `list = list + [item]` instead.
   * The main entry point of an SPDX document is the `Document` class, which links to all other classes.
   * For license handling, the [license_expression](https://github.com/nexB/license-expression) library is used.
-  * Note on `documentDescribes` and `hasFiles`: These fields will be converted to relationships in the internal data model. During serialization, they will be written again where appropriate.
+  * Note on `documentDescribes` and `hasFiles`: These fields will be converted to relationships in the internal data model. As they are deprecated, these fields will not be written in the output.
 2. **PARSING**
   * Use `parse_file(file_name)` from the `parse_anything.py` module to parse an arbitrary file with one of the supported file endings.
   * Successful parsing will return a `Document` instance. Unsuccessful parsing will raise `SPDXParsingError` with a list of all encountered problems.

src/spdx/jsonschema/package_converter.py

@@ -15,10 +15,6 @@
 from spdx.model.actor import Actor
 from spdx.model.document import Document
 from spdx.model.package import Package
-from spdx.model.relationship_filters import (
-    find_file_contained_by_package_relationships,
-    find_package_contains_file_relationships,
-)
 
 
 class PackageConverter(TypedConverter[Package]):
@@ -71,16 +67,6 @@ def _get_property_value(
             ] or None
         elif package_property == PackageProperty.FILES_ANALYZED:
             return package.files_analyzed
-        elif package_property == PackageProperty.HAS_FILES:
-            package_contains_file_ids = [
-                relationship.related_spdx_element_id
-                for relationship in find_package_contains_file_relationships(document, package)
-            ]
-            file_contained_in_package_ids = [
-                relationship.spdx_element_id
-                for relationship in find_file_contained_by_package_relationships(document, package)
-            ]
-            return package_contains_file_ids + file_contained_in_package_ids or None
         elif package_property == PackageProperty.HOMEPAGE:
             return apply_if_present(str, package.homepage)
         elif package_property == PackageProperty.LICENSE_COMMENTS:

src/spdx/jsonschema/package_properties.py

@@ -18,7 +18,6 @@ class PackageProperty(JsonProperty):
     DOWNLOAD_LOCATION = auto()
     EXTERNAL_REFS = auto()
     FILES_ANALYZED = auto()
-    HAS_FILES = auto()
     HOMEPAGE = auto()
     LICENSE_COMMENTS = auto()
     LICENSE_CONCLUDED = auto()

tests/spdx/jsonschema/test_package_converter.py

@@ -17,18 +17,14 @@
 from spdx.model.checksum import Checksum, ChecksumAlgorithm
 from spdx.model.document import Document
 from spdx.model.package import Package, PackagePurpose, PackageVerificationCode
-from spdx.model.relationship import RelationshipType
 from spdx.model.spdx_no_assertion import SPDX_NO_ASSERTION_STRING, SpdxNoAssertion
 from spdx.model.spdx_none import SPDX_NONE_STRING, SpdxNone
 from tests.spdx.fixtures import (
     annotation_fixture,
     creation_info_fixture,
     document_fixture,
     external_package_ref_fixture,
-    file_fixture,
     package_fixture,
-    relationship_fixture,
-    snippet_fixture,
 )
 from tests.spdx.mock_utils import assert_mock_method_called_with_arguments
 
@@ -66,7 +62,6 @@ def converter(
         (PackageProperty.DOWNLOAD_LOCATION, "downloadLocation"),
         (PackageProperty.EXTERNAL_REFS, "externalRefs"),
         (PackageProperty.FILES_ANALYZED, "filesAnalyzed"),
-        (PackageProperty.HAS_FILES, "hasFiles"),
         (PackageProperty.HOMEPAGE, "homepage"),
         (PackageProperty.LICENSE_COMMENTS, "licenseComments"),
         (PackageProperty.LICENSE_CONCLUDED, "licenseConcluded"),
@@ -230,7 +225,6 @@ def test_null_values(converter: PackageConverter):
     assert converter.json_property_name(PackageProperty.ATTRIBUTION_TEXTS) not in converted_dict
     assert converter.json_property_name(PackageProperty.CHECKSUMS) not in converted_dict
     assert converter.json_property_name(PackageProperty.EXTERNAL_REFS) not in converted_dict
-    assert converter.json_property_name(PackageProperty.HAS_FILES) not in converted_dict
     assert converter.json_property_name(PackageProperty.LICENSE_INFO_FROM_FILES) not in converted_dict
 
 
@@ -314,45 +308,3 @@ def test_package_annotations(converter: PackageConverter):
     )
     converted_file_annotations = converted_dict.get(converter.json_property_name(PackageProperty.ANNOTATIONS))
     assert converted_file_annotations == ["mock_converted_annotation", "mock_converted_annotation"]
-
-
-def test_has_files(converter: PackageConverter):
-    package = package_fixture()
-    first_contained_file = file_fixture(spdx_id="firstFileId")
-    second_contained_file = file_fixture(spdx_id="secondFileId")
-    non_contained_file = file_fixture(spdx_id="otherFileId")
-    snippet = snippet_fixture()
-    document = document_fixture(
-        packages=[package], files=[first_contained_file, second_contained_file, non_contained_file], snippets=[snippet]
-    )
-    package_contains_file_relationship = relationship_fixture(
-        spdx_element_id=package.spdx_id,
-        relationship_type=RelationshipType.CONTAINS,
-        related_spdx_element_id=first_contained_file.spdx_id,
-    )
-    file_contained_in_package_relationship = relationship_fixture(
-        spdx_element_id=second_contained_file.spdx_id,
-        relationship_type=RelationshipType.CONTAINED_BY,
-        related_spdx_element_id=package.spdx_id,
-    )
-    package_contains_snippet_relationship = relationship_fixture(
-        spdx_element_id=package.spdx_id,
-        relationship_type=RelationshipType.CONTAINS,
-        related_spdx_element_id=snippet.spdx_id,
-    )
-    package_describes_file_relationship = relationship_fixture(
-        spdx_element_id=package.spdx_id,
-        relationship_type=RelationshipType.DESCRIBES,
-        related_spdx_element_id=non_contained_file.spdx_id,
-    )
-    document.relationships = [
-        package_contains_file_relationship,
-        file_contained_in_package_relationship,
-        package_contains_snippet_relationship,
-        package_describes_file_relationship,
-    ]
-
-    converted_dict = converter.convert(package, document)
-
-    has_files = converted_dict.get(converter.json_property_name(PackageProperty.HAS_FILES))
-    assert has_files == [first_contained_file.spdx_id, second_contained_file.spdx_id]