cyclonedx-python-lib/tests/test_factory_license.py at 701e09e4df553e1b2b5a634ab81ec59e3191988a · CycloneDX/cyclonedx-python-lib · GitHub

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
# encoding: utf-8

# This file is part of CycloneDX Python Lib
#
# 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.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.

import unittest
import unittest.mock

from cyclonedx.exception.factory import InvalidLicenseExpressionException, InvalidSpdxLicenseException
from cyclonedx.factory.license import LicenseChoiceFactory, LicenseFactory
from cyclonedx.model import AttachedText, License, LicenseChoice, XsUri


class TestFactoryLicense(unittest.TestCase):

    def test_make_from_string_with_id(self) -> None:
        text = unittest.mock.NonCallableMock(spec=AttachedText)
        url = unittest.mock.NonCallableMock(spec=XsUri)
        expected = License(id='bar', text=text, url=url)

        with unittest.mock.patch('cyclonedx.factory.license.spdx_fixup', return_value='bar'):
            actual = LicenseFactory().make_from_string(name_or_spdx='foo', license_text=text, license_url=url)

        self.assertEqual(expected, actual)

    def test_make_from_string_with_name(self) -> None:
        text = unittest.mock.NonCallableMock(spec=AttachedText)
        url = unittest.mock.NonCallableMock(spec=XsUri)
        expected = License(name='foo', text=text, url=url)

        with unittest.mock.patch('cyclonedx.factory.license.spdx_fixup', return_value=None):
            actual = LicenseFactory().make_from_string(name_or_spdx='foo', license_text=text, license_url=url)

        self.assertEqual(expected, actual)

    def test_make_with_id(self) -> None:
        text = unittest.mock.NonCallableMock(spec=AttachedText)
        url = unittest.mock.NonCallableMock(spec=XsUri)
        expected = License(id='bar', text=text, url=url)

        with unittest.mock.patch('cyclonedx.factory.license.spdx_fixup', return_value='bar'):
            actual = LicenseFactory().make_with_id(spdx_id='foo', text=text, url=url)

        self.assertEqual(expected, actual)

    def test_make_with_id_raises(self) -> None:
        with self.assertRaises(InvalidSpdxLicenseException, msg='foo'):
            with unittest.mock.patch('cyclonedx.factory.license.spdx_fixup', return_value=None):
                LicenseFactory().make_with_id(spdx_id='foo')

    def test_make_with_name(self) -> None:
        text = unittest.mock.NonCallableMock(spec=AttachedText)
        url = unittest.mock.NonCallableMock(spec=XsUri)
        expected = License(name='foo', text=text, url=url)
        actual = LicenseFactory().make_with_name(name='foo', text=text, url=url)
        self.assertEqual(expected, actual)


class TestFactoryLicenseChoice(unittest.TestCase):

    def test_make_from_string_with_license_id(self) -> None:
        license_ = unittest.mock.NonCallableMock(spec=License)
        expected = LicenseChoice(license=license_)
        license_factory = unittest.mock.MagicMock(spec=LicenseFactory)
        license_factory.make_with_id.return_value = license_
        factory = LicenseChoiceFactory(license_factory=license_factory)

        actual = factory.make_from_string('foo')

        self.assertEqual(expected, actual)
        self.assertIs(license_, actual.license)
        license_factory.make_with_id.assert_called_once_with('foo')

    def test_make_from_string_with_compound_expression(self) -> None:
        expected = LicenseChoice(expression='foo')
        license_factory = unittest.mock.MagicMock(spec=LicenseFactory)
        license_factory.make_with_id.side_effect = InvalidSpdxLicenseException('foo')
        factory = LicenseChoiceFactory(license_factory=license_factory)

        with unittest.mock.patch('cyclonedx.factory.license.is_spdx_compound_expression', return_value=True):
            actual = factory.make_from_string('foo')

        self.assertEqual(expected, actual)
        license_factory.make_with_id.assert_called_once_with('foo')

    def test_make_from_string_with_license_name(self) -> None:
        license_ = unittest.mock.NonCallableMock(spec=License)
        expected = LicenseChoice(license=license_)
        license_factory = unittest.mock.MagicMock(spec=LicenseFactory)
        license_factory.make_with_id.side_effect = InvalidSpdxLicenseException('foo')
        license_factory.make_with_name.return_value = license_
        factory = LicenseChoiceFactory(license_factory=license_factory)

        with unittest.mock.patch('cyclonedx.factory.license.is_spdx_compound_expression', return_value=False):
            actual = factory.make_from_string('foo')

        self.assertEqual(expected, actual)
        self.assertIs(license_, actual.license)
        license_factory.make_with_id.assert_called_once_with('foo')
        license_factory.make_with_name.assert_called_once_with('foo')

    def test_make_with_compound_expression(self) -> None:
        expected = LicenseChoice(expression='foo')
        factory = LicenseChoiceFactory(license_factory=unittest.mock.MagicMock(spec=LicenseFactory))

        with unittest.mock.patch('cyclonedx.factory.license.is_spdx_compound_expression', return_value=True):
            actual = factory.make_with_compound_expression('foo')

        self.assertEqual(expected, actual)

    def test_make_with_compound_expression_raises(self) -> None:
        factory = LicenseChoiceFactory(license_factory=unittest.mock.MagicMock(spec=LicenseFactory))
        with unittest.mock.patch('cyclonedx.factory.license.is_spdx_compound_expression', return_value=False):
            with self.assertRaises(InvalidLicenseExpressionException, msg='foo'):
                factory.make_with_compound_expression('foo')

    def test_make_with_license(self) -> None:
        text = unittest.mock.NonCallableMock(spec=AttachedText)
        url = unittest.mock.NonCallableMock(spec=XsUri)
        license_ = unittest.mock.NonCallableMock(spec=License)
        expected = LicenseChoice(license=license_)
        license_factory = unittest.mock.MagicMock(spec=LicenseFactory)
        license_factory.make_from_string.return_value = license_
        factory = LicenseChoiceFactory(license_factory=license_factory)

        actual = factory.make_with_license('foo', license_text=text, license_url=url)

        self.assertEqual(expected, actual)
        self.assertIs(license_, actual.license)
        license_factory.make_from_string.assert_called_once_with('foo', license_text=text, license_url=url)