File: test_package_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 (282 lines) | stat: -rw-r--r-- 11,472 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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# SPDX-FileCopyrightText: 2022 spdx contributors
#
# SPDX-License-Identifier: Apache-2.0
from datetime import datetime
from unittest import TestCase

import pytest

from spdx_tools.common.spdx_licensing import spdx_licensing
from spdx_tools.spdx.model import (
    Actor,
    ActorType,
    Checksum,
    ChecksumAlgorithm,
    ExternalPackageRef,
    ExternalPackageRefCategory,
    PackagePurpose,
    PackageVerificationCode,
    SpdxNoAssertion,
    SpdxNone,
)
from spdx_tools.spdx.parser.error import SPDXParsingError
from spdx_tools.spdx.parser.jsonlikedict.dict_parsing_functions import parse_list_of_elements
from spdx_tools.spdx.parser.jsonlikedict.package_parser import PackageParser


@pytest.mark.parametrize(
    "homepage, expected_homepage, download_location, expected_download_location, "
    "copyright_text, expected_copyright_text, originator, expected_originator, supplier, expected_supplier",
    [
        (
            "http://ftp.gnu.org/gnu/glibc",
            "http://ftp.gnu.org/gnu/glibc",
            "NOASSERTION",
            SpdxNoAssertion(),
            "NONE",
            SpdxNone(),
            "Organization: ExampleCodeInspect (contact@example.com)",
            Actor(ActorType.ORGANIZATION, "ExampleCodeInspect", "contact@example.com"),
            "NOASSERTION",
            SpdxNoAssertion(),
        ),
        (
            "NOASSERTION",
            SpdxNoAssertion(),
            "NONE",
            SpdxNone(),
            "Copyright 2008-2010 John Smith",
            "Copyright 2008-2010 John Smith",
            None,
            None,
            None,
            None,
        ),
        (
            "NONE",
            SpdxNone(),
            "http://ftp.gnu.org/gnu/glibc/glibc-ports-2.15.tar.gz",
            "http://ftp.gnu.org/gnu/glibc/glibc-ports-2.15.tar.gz",
            "NOASSERTION",
            SpdxNoAssertion(),
            "NOASSERTION",
            SpdxNoAssertion(),
            "Person: Jane Doe (jane.doe@example.com)",
            Actor(ActorType.PERSON, "Jane Doe", "jane.doe@example.com"),
        ),
    ],
)
def test_parse_package(
    homepage,
    expected_homepage,
    download_location,
    expected_download_location,
    copyright_text,
    expected_copyright_text,
    originator,
    expected_originator,
    supplier,
    expected_supplier,
):
    package_parser = PackageParser()

    package_dict = {
        "SPDXID": "SPDXRef-Package",
        "attributionTexts": [
            "The GNU C Library is free software.  See the file COPYING.LIB for copying conditions, and LICENSES for "
            "notices about a few contributions that require these additional notices to be distributed.  License "
            "copyright years may be listed using range notation, e.g., 1996-2015, indicating that every year in the "
            "range, inclusive, is a copyrightable year that would otherwise be listed individually."
        ],
        "builtDate": "2011-01-29T18:30:22Z",
        "checksums": [
            {"algorithm": "MD5", "checksumValue": "624c1abb3664f4b35547e7c73864ad24"},
            {"algorithm": "SHA1", "checksumValue": "85ed0817af83a24ad8da68c2b5094de69833983c"},
            {
                "algorithm": "SHA256",
                "checksumValue": "11b6d3ee554eedf79299905a98f9b9a04e498210b59f15094c916c91d150efcd",
            },
            {
                "algorithm": "BLAKE2b-384",
                "checksumValue": "aaabd89c926ab525c242e6621f2f5fa73aa4afe3d9e24aed727faaadd6af38b620bdb623dd2b4788b1c8"
                "086984af8706",
            },
        ],
        "comment": "This is a comment.",
        "copyrightText": copyright_text,
        "description": "The GNU C Library defines functions that are specified by the ISO C standard, as well as "
        "additional features specific to POSIX and other derivatives of the Unix operating system, and "
        "extensions specific to GNU systems.",
        "downloadLocation": download_location,
        "externalRefs": [
            {
                "referenceCategory": "SECURITY",
                "referenceLocator": "cpe:2.3:a:pivotal_software:spring_framework:4.1.0:*:*:*:*:*:*:*",
                "referenceType": "cpe23Type",
            },
            {
                "comment": "This is the external ref for Acme",
                "referenceCategory": "OTHER",
                "referenceLocator": "acmecorp/acmenator/4.1.3-alpha",
                "referenceType": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301"
                "#LocationRef-acmeforge",
            },
        ],
        "filesAnalyzed": True,
        "homepage": homepage,
        "licenseComments": "The license for this project changed with the release of version x.y.  The version of the "
        "project included here post-dates the license change.",
        "licenseConcluded": "(LGPL-2.0-only OR LicenseRef-3)",
        "licenseDeclared": "(LGPL-2.0-only AND LicenseRef-3)",
        "licenseInfoFromFiles": ["GPL-2.0-only", "LicenseRef-2", "LicenseRef-1", "NOASSERTION"],
        "name": "glibc",
        "originator": originator,
        "packageFileName": "glibc-2.11.1.tar.gz",
        "packageVerificationCode": {
            "packageVerificationCodeExcludedFiles": ["./package.spdx"],
            "packageVerificationCodeValue": "d6a770ba38583ed4bb4525bd96e50461655d2758",
        },
        "primaryPackagePurpose": "SOURCE",
        "releaseDate": "2012-01-29T18:30:22Z",
        "sourceInfo": "uses glibc-2_11-branch from git://sourceware.org/git/glibc.git.",
        "summary": "GNU C library.",
        "supplier": supplier,
        "validUntilDate": "2014-01-29T18:30:22Z",
        "versionInfo": "2.11.1",
    }

    package = package_parser.parse_package(package_dict)

    assert package.spdx_id == "SPDXRef-Package"
    assert package.name == "glibc"
    assert package.download_location == expected_download_location
    assert package.version == "2.11.1"
    assert package.file_name == "glibc-2.11.1.tar.gz"
    assert package.supplier == expected_supplier
    assert package.originator == expected_originator
    assert package.files_analyzed is True
    assert package.verification_code == PackageVerificationCode(
        value="d6a770ba38583ed4bb4525bd96e50461655d2758", excluded_files=["./package.spdx"]
    )
    assert len(package.checksums) == 4
    TestCase().assertCountEqual(
        package.checksums,
        [
            Checksum(ChecksumAlgorithm.MD5, "624c1abb3664f4b35547e7c73864ad24"),
            Checksum(ChecksumAlgorithm.SHA1, "85ed0817af83a24ad8da68c2b5094de69833983c"),
            Checksum(ChecksumAlgorithm.SHA256, "11b6d3ee554eedf79299905a98f9b9a04e498210b59f15094c916c91d150efcd"),
            Checksum(
                ChecksumAlgorithm.BLAKE2B_384,
                "aaabd89c926ab525c242e6621f2f5fa73aa4afe3d9e24aed727faaadd6af38b620bdb623dd2b4788b1c8086984af8706",
            ),
        ],
    )
    assert package.homepage == expected_homepage
    assert package.source_info == "uses glibc-2_11-branch from git://sourceware.org/git/glibc.git."
    assert package.license_concluded == spdx_licensing.parse("(LGPL-2.0-only OR LicenseRef-3)")
    TestCase().assertCountEqual(
        package.license_info_from_files,
        [
            spdx_licensing.parse("GPL-2.0-only"),
            spdx_licensing.parse("LicenseRef-2"),
            spdx_licensing.parse("LicenseRef-1"),
            SpdxNoAssertion(),
        ],
    )
    assert package.license_declared == spdx_licensing.parse("(LGPL-2.0-only AND LicenseRef-3)")
    assert (
        package.license_comment
        == "The license for this project changed with the release of version x.y.  The version of the project included"
        " here post-dates the license change."
    )
    assert package.copyright_text == expected_copyright_text
    assert package.summary == "GNU C library."
    assert (
        package.description
        == "The GNU C Library defines functions that are specified by the ISO C standard, as well as additional "
        "features specific to POSIX and other derivatives of the Unix operating system, and extensions specific "
        "to GNU systems."
    )
    assert package.comment == "This is a comment."
    assert len(package.external_references) == 2
    TestCase().assertCountEqual(
        package.external_references,
        [
            ExternalPackageRef(
                ExternalPackageRefCategory.SECURITY,
                "cpe23Type",
                "cpe:2.3:a:pivotal_software:spring_framework:4.1.0:*:*:*:*:*:*:*",
            ),
            ExternalPackageRef(
                ExternalPackageRefCategory.OTHER,
                "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301#LocationRef-acmeforge",
                locator="acmecorp/acmenator/4.1.3-alpha",
                comment="This is the external ref for Acme",
            ),
        ],
    )
    assert package.attribution_texts == [
        "The GNU C Library is free software.  See the file COPYING.LIB for copying conditions, and LICENSES for "
        "notices about a few contributions that require these additional notices to be distributed.  License "
        "copyright years may be listed using range notation, e.g., 1996-2015, indicating that every year in the "
        "range, inclusive, is a copyrightable year that would otherwise be listed individually."
    ]
    assert package.primary_package_purpose == PackagePurpose.SOURCE
    assert package.release_date == datetime(2012, 1, 29, 18, 30, 22)
    assert package.built_date == datetime(2011, 1, 29, 18, 30, 22)
    assert package.valid_until_date == datetime(2014, 1, 29, 18, 30, 22)


@pytest.mark.parametrize(
    "incomplete_package_dict",
    [
        {"SPDXID": "SPDXRef-Package"},
        {"SPDXID": "SPDXRef-Package", "name": 5, "downloadLocation": "NONE"},
        {
            "SPDXID": "SPDXRef-Package",
            "name": "Example Package",
            "downloadLocation": "NONE",
            "checksums": [{"algorithm": "SHA", "value": "1234"}],
        },
    ],
)
def test_parse_invalid_package(incomplete_package_dict):
    package_parser = PackageParser()

    with pytest.raises(SPDXParsingError):
        package_parser.parse_package(incomplete_package_dict)


def test_parse_packages():
    package_parser = PackageParser()
    packages_list = [
        {
            "SPDXID": "SPDXRef-Package",
            "name": "Example Package",
            "downloadLocation": "NONE",
            "checksums": [{"algorithm": "SHA", "value": "1234"}],
        },
        {"SPDXID": "SPDXRef-Package", "name": 5, "downloadLocation": "NONE"},
        {"SPDXID": "SPDXRef-Package", "name": "Example Package", "downloadLocation": "NONE"},
    ]

    with pytest.raises(SPDXParsingError):
        parse_list_of_elements(packages_list, package_parser.parse_package)


def test_parse_external_ref():
    package_parser = PackageParser()
    external_ref = {"referenceType": "fix"}

    with pytest.raises(SPDXParsingError):
        package_parser.parse_external_ref(external_ref)


def test_parse_invalid_external_package_ref_category():
    package_parser = PackageParser()
    external_package_ref_category = "TEST"

    with pytest.raises(SPDXParsingError) as err:
        package_parser.parse_external_ref_category(external_package_ref_category)

    TestCase().assertCountEqual(err.value.get_messages(), ["Invalid ExternalPackageRefCategory: TEST"])