File: test_relationship_parser.py

package info (click to toggle)
python-spdx-tools 0.8.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,084 kB
  • sloc: python: 18,675; xml: 12,553; sh: 46; makefile: 7
file content (215 lines) | stat: -rw-r--r-- 7,750 bytes parent folder | download
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# SPDX-FileCopyrightText: 2022 spdx contributors
#
# SPDX-License-Identifier: Apache-2.0
from unittest import TestCase

import pytest

from spdx_tools.spdx.constants import DOCUMENT_SPDX_ID
from spdx_tools.spdx.model import Relationship, RelationshipType, SpdxNoAssertion
from spdx_tools.spdx.parser.error import SPDXParsingError
from spdx_tools.spdx.parser.jsonlikedict.relationship_parser import RelationshipParser


def test_parse_relationship():
    relationship_parser = RelationshipParser()

    relationship_dict = {
        "spdxElementId": DOCUMENT_SPDX_ID,
        "relationshipType": "CONTAINS",
        "relatedSpdxElement": "NOASSERTION",
        "comment": "Comment.",
    }

    relationship = relationship_parser.parse_relationship(relationship_dict)

    assert relationship.relationship_type == RelationshipType.CONTAINS
    assert relationship.spdx_element_id == DOCUMENT_SPDX_ID
    assert relationship.related_spdx_element_id == SpdxNoAssertion()
    assert relationship.comment == "Comment."


def test_parse_incomplete_relationship():
    relationship_parser = RelationshipParser()
    relationship_dict = {
        "spdxElementId": DOCUMENT_SPDX_ID,
        "relatedSpdxElement": "SPDXRef-Package",
        "comment": "Comment.",
    }

    with pytest.raises(SPDXParsingError):
        relationship_parser.parse_relationship(relationship_dict)


def test_parse_relationship_type():
    relationship_parser = RelationshipParser()
    relationship_type_str = "DEPENDENCY_OF"

    relationship_type = relationship_parser.parse_relationship_type(relationship_type_str)
    assert relationship_type == RelationshipType.DEPENDENCY_OF


def test_parse_document_describes():
    relationship_parser = RelationshipParser()

    document_dict = {
        "SPDXID": DOCUMENT_SPDX_ID,
        "documentDescribes": ["SPDXRef-Package", "SPDXRef-File", "SPDXRef-Snippet"],
    }

    relationships = relationship_parser.parse_document_describes(
        doc_spdx_id=DOCUMENT_SPDX_ID,
        described_spdx_ids=document_dict.get("documentDescribes"),
        existing_relationships=[],
    )

    assert len(relationships) == 3
    TestCase().assertCountEqual(
        relationships,
        [
            Relationship(DOCUMENT_SPDX_ID, RelationshipType.DESCRIBES, "SPDXRef-Package"),
            Relationship(DOCUMENT_SPDX_ID, RelationshipType.DESCRIBES, "SPDXRef-File"),
            Relationship(DOCUMENT_SPDX_ID, RelationshipType.DESCRIBES, "SPDXRef-Snippet"),
        ],
    )


@pytest.mark.parametrize(
    "document_describes,relationships,parsed_relationships",
    [
        (
            ["SPDXRef-Package", "SPDXRef-File"],
            [
                {
                    "spdxElementId": DOCUMENT_SPDX_ID,
                    "relatedSpdxElement": "SPDXRef-Package",
                    "relationshipType": "DESCRIBES",
                    "comment": "This relationship has a comment.",
                },
                {
                    "spdxElementId": "SPDXRef-File",
                    "relatedSpdxElement": DOCUMENT_SPDX_ID,
                    "relationshipType": "DESCRIBED_BY",
                    "comment": "This relationship has a comment.",
                },
            ],
            [
                Relationship(
                    related_spdx_element_id="SPDXRef-Package",
                    relationship_type=RelationshipType.DESCRIBES,
                    spdx_element_id=DOCUMENT_SPDX_ID,
                    comment="This relationship has a comment.",
                ),
                Relationship(
                    related_spdx_element_id=DOCUMENT_SPDX_ID,
                    relationship_type=RelationshipType.DESCRIBED_BY,
                    spdx_element_id="SPDXRef-File",
                    comment="This relationship has a comment.",
                ),
            ],
        ),
        (
            ["SPDXRef-Package", "SPDXRef-File", "SPDXRef-Package"],
            [],
            [
                Relationship(
                    related_spdx_element_id="SPDXRef-Package",
                    relationship_type=RelationshipType.DESCRIBES,
                    spdx_element_id=DOCUMENT_SPDX_ID,
                ),
                Relationship(
                    related_spdx_element_id="SPDXRef-File",
                    relationship_type=RelationshipType.DESCRIBES,
                    spdx_element_id=DOCUMENT_SPDX_ID,
                ),
            ],
        ),
    ],
)
def test_parse_document_describes_without_duplicating_relationships(
    document_describes, relationships, parsed_relationships
):
    relationship_parser = RelationshipParser()
    document_dict = {
        "SPDXID": DOCUMENT_SPDX_ID,
        "documentDescribes": document_describes,
        "relationships": relationships,
    }

    relationships = relationship_parser.parse_all_relationships(document_dict)

    assert len(relationships) == len(parsed_relationships)
    TestCase().assertCountEqual(relationships, parsed_relationships)


def test_parse_has_files():
    relationship_parser = RelationshipParser()
    document_dict = {"packages": [{"SPDXID": "SPDXRef-Package", "hasFiles": ["SPDXRef-File1", "SPDXRef-File2"]}]}

    relationships = relationship_parser.parse_has_files(document_dict.get("packages"), existing_relationships=[])

    assert len(relationships) == 2
    TestCase().assertCountEqual(
        relationships,
        [
            Relationship(
                spdx_element_id="SPDXRef-Package",
                relationship_type=RelationshipType.CONTAINS,
                related_spdx_element_id="SPDXRef-File1",
            ),
            Relationship(
                spdx_element_id="SPDXRef-Package",
                relationship_type=RelationshipType.CONTAINS,
                related_spdx_element_id="SPDXRef-File2",
            ),
        ],
    )


@pytest.mark.parametrize(
    "has_files,existing_relationships,contains_relationships",
    [
        # pre-requisite for parse_has_files requires that comments in relationships are stripped
        (
            ["SPDXRef-File1", "SPDXRef-File2"],
            [
                Relationship(
                    spdx_element_id="SPDXRef-Package",
                    relationship_type=RelationshipType.CONTAINS,
                    related_spdx_element_id="SPDXRef-File1",
                ),
                Relationship(
                    spdx_element_id="SPDXRef-File2",
                    relationship_type=RelationshipType.CONTAINED_BY,
                    related_spdx_element_id="SPDXRef-Package",
                ),
            ],
            [],
        ),
        (
            ["SPDXRef-File1", "SPDXRef-File2", "SPDXRef-File1"],
            [],
            [
                Relationship(
                    spdx_element_id="SPDXRef-Package",
                    relationship_type=RelationshipType.CONTAINS,
                    related_spdx_element_id="SPDXRef-File1",
                ),
                Relationship(
                    spdx_element_id="SPDXRef-Package",
                    relationship_type=RelationshipType.CONTAINS,
                    related_spdx_element_id="SPDXRef-File2",
                ),
            ],
        ),
    ],
)
def test_parse_has_files_without_duplicating_relationships(has_files, existing_relationships, contains_relationships):
    relationship_parser = RelationshipParser()
    document_dict = {"packages": [{"SPDXID": "SPDXRef-Package", "hasFiles": has_files}]}
    relationships = relationship_parser.parse_has_files(
        document_dict.get("packages"), existing_relationships=existing_relationships
    )

    assert len(relationships) == len(contains_relationships)
    TestCase().assertCountEqual(relationships, contains_relationships)