1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
# SPDX-FileCopyrightText: 2023 spdx contributors
#
# SPDX-License-Identifier: Apache-2.0
from pathlib import Path
from typing import List
from unittest import TestCase
import pytest
from spdx_tools.spdx.graph_generation import generate_relationship_graph_from_spdx
from spdx_tools.spdx.model import Document, Relationship, RelationshipType
from spdx_tools.spdx.parser.parse_anything import parse_file
from tests.spdx.fixtures import document_fixture, file_fixture, package_fixture
try:
import networkx # noqa: F401
except ImportError:
pytest.skip("Skip this module as the tests need optional dependencies to run.", allow_module_level=True)
@pytest.mark.parametrize(
"file_name, nodes_count, edges_count, relationship_node_keys",
[
(
"SPDXJSONExample-v2.3.spdx.json",
22,
22,
["SPDXRef-Package_DYNAMIC_LINK", "SPDXRef-JenaLib_CONTAINS"],
),
(
"SPDXJSONExample-v2.2.spdx.json",
20,
19,
["SPDXRef-Package_DYNAMIC_LINK", "SPDXRef-JenaLib_CONTAINS"],
),
(
"SPDXRdfExample-v2.3.spdx.rdf.xml",
22,
22,
["SPDXRef-Package_DYNAMIC_LINK", "SPDXRef-JenaLib_CONTAINS"],
),
(
"SPDXRdfExample-v2.2.spdx.rdf.xml",
20,
19,
["SPDXRef-Package_DYNAMIC_LINK", "SPDXRef-JenaLib_CONTAINS"],
),
(
"SPDXTagExample-v2.3.spdx",
22,
22,
["SPDXRef-Package_DYNAMIC_LINK", "SPDXRef-JenaLib_CONTAINS"],
),
],
)
def test_generate_graph_from_spdx(
file_name: str,
nodes_count: int,
edges_count: int,
relationship_node_keys: List[str],
) -> None:
document = parse_file(str(Path(__file__).resolve().parent.parent / "spdx" / "data" / file_name))
graph = generate_relationship_graph_from_spdx(document)
assert document.creation_info.spdx_id in graph.nodes()
assert graph.number_of_nodes() == nodes_count
assert graph.number_of_edges() == edges_count
assert "SPDXRef-DOCUMENT_DESCRIBES" in graph.nodes()
for relationship_node_key in relationship_node_keys:
assert relationship_node_key in graph.nodes()
def test_complete_connected_graph() -> None:
document = _create_minimal_document()
graph = generate_relationship_graph_from_spdx(document)
TestCase().assertCountEqual(
graph.nodes(),
[
"SPDXRef-DOCUMENT",
"SPDXRef-Package-A",
"SPDXRef-Package-B",
"SPDXRef-File",
"SPDXRef-DOCUMENT_DESCRIBES",
"SPDXRef-Package-A_CONTAINS",
"SPDXRef-Package-B_CONTAINS",
],
)
TestCase().assertCountEqual(
graph.edges(),
[
("SPDXRef-DOCUMENT", "SPDXRef-DOCUMENT_DESCRIBES"),
("SPDXRef-DOCUMENT_DESCRIBES", "SPDXRef-Package-A"),
("SPDXRef-DOCUMENT_DESCRIBES", "SPDXRef-Package-B"),
("SPDXRef-Package-A", "SPDXRef-Package-A_CONTAINS"),
("SPDXRef-Package-A_CONTAINS", "SPDXRef-File"),
("SPDXRef-Package-B", "SPDXRef-Package-B_CONTAINS"),
("SPDXRef-Package-B_CONTAINS", "SPDXRef-File"),
],
)
def test_complete_unconnected_graph() -> None:
document = _create_minimal_document()
document.packages += [package_fixture(spdx_id="SPDXRef-Package-C", name="Package without connection to document")]
graph = generate_relationship_graph_from_spdx(document)
TestCase().assertCountEqual(
graph.nodes(),
[
"SPDXRef-DOCUMENT",
"SPDXRef-Package-A",
"SPDXRef-Package-B",
"SPDXRef-File",
"SPDXRef-DOCUMENT_DESCRIBES",
"SPDXRef-Package-A_CONTAINS",
"SPDXRef-Package-B_CONTAINS",
"SPDXRef-Package-C",
],
)
TestCase().assertCountEqual(
graph.edges(),
[
("SPDXRef-DOCUMENT", "SPDXRef-DOCUMENT_DESCRIBES"),
("SPDXRef-DOCUMENT_DESCRIBES", "SPDXRef-Package-A"),
("SPDXRef-DOCUMENT_DESCRIBES", "SPDXRef-Package-B"),
("SPDXRef-Package-A", "SPDXRef-Package-A_CONTAINS"),
("SPDXRef-Package-A_CONTAINS", "SPDXRef-File"),
("SPDXRef-Package-B", "SPDXRef-Package-B_CONTAINS"),
("SPDXRef-Package-B_CONTAINS", "SPDXRef-File"),
],
)
def _create_minimal_document() -> Document:
packages = [
package_fixture(spdx_id="SPDXRef-Package-A", name="Package-A"),
package_fixture(spdx_id="SPDXRef-Package-B", name="Package-B"),
]
files = [
file_fixture(spdx_id="SPDXRef-File", name="File"),
]
relationships = [
Relationship("SPDXRef-DOCUMENT", RelationshipType.DESCRIBES, "SPDXRef-Package-A"),
Relationship("SPDXRef-DOCUMENT", RelationshipType.DESCRIBES, "SPDXRef-Package-B"),
Relationship("SPDXRef-Package-A", RelationshipType.CONTAINS, "SPDXRef-File"),
Relationship("SPDXRef-Package-B", RelationshipType.CONTAINS, "SPDXRef-File"),
]
document = document_fixture(packages=packages, files=files, relationships=relationships, snippets=[])
return document
|