aboutsummaryrefslogtreecommitdiffstats
path: root/packaging-tools/tests/test_release_task_reader.py
blob: e57819e86eb90987effc11905cf3d7ab5a46c0e4 (plain)
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
283
284
285
286
287
288
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

#############################################################################
#
# Copyright (C) 2023 The Qt Company Ltd.
# Contact: https://www.qt.io/licensing/
#
# This file is part of the release tools of the Qt Toolkit.
#
# $QT_BEGIN_LICENSE:GPL-EXCEPT$
# Commercial License Usage
# Licensees holding valid commercial Qt licenses may use this file in
# accordance with the commercial license agreement provided with the
# Software or, alternatively, in accordance with the terms contained in
# a written agreement between you and The Qt Company. For licensing terms
# and conditions see https://www.qt.io/terms-conditions. For further
# information use the contact form at https://www.qt.io/contact-us.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 3 as published by the Free Software
# Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
# included in the packaging of this file. Please review the following
# information to ensure the GNU General Public License requirements will
# be met: https://www.gnu.org/licenses/gpl-3.0.html.
#
# $QT_END_LICENSE$
#
#############################################################################

import unittest
from configparser import ConfigParser
from typing import List

from ddt import data, ddt, unpack  # type: ignore

from release_task_reader import (
    QBSPReleaseTask,
    ReleaseTaskError,
    TaskType,
    get_filter_parts,
    parse_data,
)
from tests.testhelpers import asyncio_test, asyncio_test_parallel_data


@ddt
class TestReleaseTaskReader(unittest.TestCase):
    @asyncio_test_parallel_data(  # type: ignore
        ("linux,x64,common", ["linux", "x64", "common"]),
        ("linux, x64,  common ", ["linux", "x64", "common"]),
        ("linux; , x64  common ", ["linux", "x64", "common"]),
        (": ,,; linux x64   common ", ["linux", "x64", "common"]),
    )
    async def test_get_filter_parts(self, task_filters: str, expected_result: List[str]) -> None:
        self.assertEqual(get_filter_parts(task_filters), expected_result)

    @data(  # type: ignore
        ("""
            [task.ifw.repository.linux.x86_64]
            config_file:  foobar-file-repository
            substitutions: arg1, arg2, arg3
            repo_path: foo/bar/path
            rta_key_list: key1
        """, ["ifw,repository,linux"], TaskType.IFW_TASK_TYPE, True),
        ("""
            [task.ifw.repository.linux2.x64.common]
            config_file:  foobar-file-repository
            repo_path: foo/bar/path

            [task.ifw.repository.linux.exclude.common]
            config_file:  foobar-file-repository
            repo_path: foo/bar/path
        """, ["common, x64"], TaskType.IFW_TASK_TYPE, True),
        ("""
            [task.ifw.repository.linux.x64.no_repo_path]
            substitutions: arg1, arg2, arg3
        """, ["no_repo_path"], TaskType.IFW_TASK_TYPE, False),
        ("""
            [task.ifw.repository.linux.x64.no_config_file]
            repo_path: foo/bar/path
        """, ["no_config_file"], TaskType.IFW_TASK_TYPE, False),
        ("""
            [task.deb.repository.linux.x64]
            repo_path: foo/bar/path
        """, ["deb,linux"], TaskType.DEB_TASK_TYPE, True),
        ("""
            [task.deb.repository.linux.x64]
        """, ["deb"], TaskType.DEB_TASK_TYPE, False),
        ("""
            [task.ifw.offline.linux.x64.no_config_file]
        """, ["ifw,offline"], TaskType.IFW_TASK_TYPE, False),
        ("""
            [task.ifw.offline.linux.x64]
            config_file:  foobar-file-repository
        """, ["ifw,offline"], TaskType.IFW_TASK_TYPE, True)
    )
    @unpack  # type: ignore
    def test_release_task_validity(
        self,
        sample_config: str,
        filters: List[str],
        task_type: TaskType,
        is_valid: bool,
    ) -> None:
        config = ConfigParser()
        config.read_string(sample_config)
        if is_valid:
            self.assertIsNotNone(parse_data(config, task_types=[task_type], task_filters=filters))
        else:
            with self.assertRaises(ReleaseTaskError):
                parse_data(config, task_types=[task_type], task_filters=filters)

    @data(  # type: ignore
        ("""
            [task.ifw.repository.linux.x86_64]
            config_file:  foobar-file-repository
            substitutions: arg1, arg2, arg3
            repo_path: foo/bar/path
            rta_key_list: key1, key2,key3   , key4

            [task.ifw.offline.linux.x86_64.foobar]
            config_file:  foobar-file-repository-2
            substitutions: arg1, arg2, arg3
            repo_path: foo/bar/path2
            rta_key_list: key1, key2,key3   , key4

            [task.ifw.offline.linux.x86_64]
            config_file:  foobar-file-offline
            substitutions: arg11, arg21, arg31
            repo_path: foo/bar/path
            rta_key_list: keyA, keyB

            [task.ifw.online.linux.x86_64]
            config_file:  foobar-file-online
            substitutions: arg12, arg22, arg32
            repo_path: foo/bar/path
            rta_key_list: key12, key22

            [foo.ifw.online.linux.x86_64]
            config_file:  foobar-file-online
            substitutions: arg13, arg23, arg33
            repo_path: foo/bar/path
            rta_key_list: key13, key23
        """,)
    )
    @unpack  # type: ignore
    def test_release_task_reader_ifw(self, sample_config: str) -> None:
        config = ConfigParser()
        config.read_string(sample_config)
        # parse all tasks i.e. no filters
        tasks = parse_data(config, task_types=[TaskType.IFW_TASK_TYPE], task_filters=[])
        self.assertTrue(
            len(tasks[TaskType.IFW_TASK_TYPE]) == 4, "Did not parse all tasks from sample config"
        )
        # parse only "repository" tasks
        tasks = parse_data(
            config, task_types=[TaskType.IFW_TASK_TYPE], task_filters=["repository"]
        )
        self.assertTrue(len(tasks[TaskType.IFW_TASK_TYPE]) == 1)
        self.assertEqual(
            tasks[TaskType.IFW_TASK_TYPE][0].config_file, "foobar-file-repository"
        )
        self.assertEqual(
            tasks[TaskType.IFW_TASK_TYPE][0].substitutions, ["arg1", "arg2", "arg3"]
        )
        self.assertEqual(
            tasks[TaskType.IFW_TASK_TYPE][0].rta_key_list, ["key1", "key2", "key3", "key4"]
        )
        self.assertEqual(tasks[TaskType.IFW_TASK_TYPE][0].repo_path, "foo/bar/path")
        self.assertEqual(sorted(tasks[TaskType.IFW_TASK_TYPE][0].rta_key_list), sorted(["key1", "key2", "key3", "key4"]))

        # parse only "offline" tasks with multiple filters
        tasks = parse_data(
            config,
            task_types=[TaskType.IFW_TASK_TYPE],
            task_filters=["offline,linux,x86_64"],
        )
        self.assertTrue(len(tasks[TaskType.IFW_TASK_TYPE]) == 2)
        tasks = parse_data(
            config,
            task_types=[TaskType.IFW_TASK_TYPE],
            task_filters=["offline,linux,x86_64,foobar"],
        )
        self.assertTrue(len(tasks[TaskType.IFW_TASK_TYPE]) == 1)

        # parse "offline" tasks with multiple filters and "online" tasks
        tasks = parse_data(
            config,
            task_types=[TaskType.IFW_TASK_TYPE],
            task_filters=["offline,linux,x86_64", "online,linux,x86_64"],
        )
        self.assertTrue(len(tasks[TaskType.IFW_TASK_TYPE]) == 3)

    @asyncio_test
    async def test_release_task_reader_deb(self) -> None:
        sample_config = """
            [task.deb.repository.linux.amd64]
            repo_path: test_repo/amd64
            distribution:  foobar-file-repository-amd64
            component: main
            architectures: amd64
            content_sources: http://foo.com/content1, http://foo.com/content2
            substitutions: foo=bar, aaa=bbb
            rta_key_list: key1, key2

            [task.deb.repository.linux.arm64]
            repo_path: test_repo/arm64
            distribution:  foobar-file-repository-arm64
            component: main
            architectures: arm64
            content_sources: http://foo.com/content3, http://foo.com/content4
            substitutions: foo=bar, aaa=bbb
            rta_key_list: key3, key4
        """
        config = ConfigParser()
        config.read_string(sample_config)

        # parse all tasks i.e. no filters
        tasks = parse_data(config, task_types=[TaskType.DEB_TASK_TYPE], task_filters=[])
        self.assertTrue(len(tasks[TaskType.DEB_TASK_TYPE]) == 2, "Did not parse all tasks from sample config")

        # parse only "repository" tasks
        tasks = parse_data(config, task_types=[TaskType.DEB_TASK_TYPE], task_filters=["amd64"])
        self.assertTrue(len(tasks[TaskType.DEB_TASK_TYPE]) == 1)
        self.assertEqual(tasks[TaskType.DEB_TASK_TYPE][0].substitutions, ["foo=bar", "aaa=bbb"])
        self.assertEqual(tasks[TaskType.DEB_TASK_TYPE][0].repo_path, "test_repo/amd64")
        self.assertEqual(
            tasks[TaskType.DEB_TASK_TYPE][0].distribution,  # type: ignore
            "barbar-file-repository-amd64"
        )
        self.assertEqual(tasks[TaskType.DEB_TASK_TYPE][0].component, "main")  # type: ignore
        self.assertEqual(tasks[TaskType.DEB_TASK_TYPE][0].architectures, ["amd64"])  # type: ignore
        self.assertEqual(
            tasks[TaskType.DEB_TASK_TYPE][0].content_sources,  # type: ignore
            ["http://bar.com/content1", "http://bar.com/content2"]
        )
        self.assertEqual(
            sorted(tasks[TaskType.DEB_TASK_TYPE][0].rta_key_list), sorted(["key1", "key2"])
        )

    @asyncio_test
    async def test_release_task_reader_qbsp(self) -> None:
        sample_config = """
            [task.qbsp.repository.linux.foo]
            qbsp_file: https://foo.com/path1/foo.qbsp
            repo_path: test_repo/temp1
            rta_key_list: key1, key2

            [task.qbsp.repository.linux.bar]
            qbsp_file: https://foo.com/path2/bar.qbsp
            repo_path: test_repo/temp2
            rta_key_list: key3, key4
        """
        config = ConfigParser()
        config.read_string(sample_config)

        # parse all tasks i.e. no filters
        tasks = parse_data(config, task_types=[TaskType.QBSP_TASK_TYPE], task_filters=[])
        self.assertTrue(len(tasks[TaskType.QBSP_TASK_TYPE]) == 2, "Did not parse all tasks from sample config")

        # parse only "foo" tasks
        tasks = parse_data(config, task_types=[TaskType.QBSP_TASK_TYPE], task_filters=["foo"])
        self.assertTrue(len(tasks[TaskType.QBSP_TASK_TYPE]) == 1)
        task = tasks[TaskType.QBSP_TASK_TYPE].pop()
        assert isinstance(task, QBSPReleaseTask)
        self.assertEqual(task.qbsp_file, "https://foo.com/path1/foo.qbsp")
        self.assertEqual(task.repo_path, "test_repo/temp1")
        self.assertEqual(sorted(task.rta_key_list), sorted(["key1", "key2"]))

    @asyncio_test
    async def test_release_task_reader_invalid_config(self) -> None:
        sample_config = """
            [task.ifw.repository]
            config_file:  foobar-file-repository
            substitutions: arg1, arg2, arg3
            repo_path: foo/bar/path
            rta_key_list: key1, key2
        """
        config = ConfigParser()
        config.read_string(sample_config)
        with self.assertRaises(ReleaseTaskError):
            parse_data(config, task_types=[TaskType.IFW_TASK_TYPE], task_filters=[])


if __name__ == '__main__':
    unittest.main()