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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#############################################################################
#
# Copyright (C) 2022 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 os
import unittest
from pathlib import Path
from tempfile import TemporaryDirectory
from ddt import data, ddt # type: ignore
from bld_utils import is_windows
from bldinstallercommon import (
locate_executable,
locate_path,
locate_paths,
replace_in_files,
search_for_files,
)
from installer_utils import PackagingError
@ddt
class TestCommon(unittest.TestCase):
@data(
(
"%TAG_VERSION%%TAG_EDITION%",
[("%TAG_VERSION%", "6.3.0"), ("%TAG_EDITION%", "opensource"), ("foo", "bar")],
"6.3.0opensource",
),
(
"QT_VERSION=%TAG_VERSION%\n%TAG_EDITION%=QT_EDITION",
[("%TAG_VERSION%", "6.3.0"), ("%TAG_EDITION%", "opensource")],
"QT_VERSION=6.3.0\nopensource=QT_EDITION",
),
(
"%foo%",
[("%foo%", "%bar%"), ("%bar%", "foo"), ("", "bar"), ("barfbarobarobar", "foo")],
"foo",
),
(
"%=%foo%foo%foo%foo%%\n",
[("%foo%", "%foo"), ("%foo%", "foo%"), ("%%", "foo%")],
"%=%foofoo%foofoofoo%\n",
),
("%foo\nbar%foo", [("%foobar%", "foobar"), ("%foo%", "")], "%foo\nbar%foo"),
)
def test_replace_in_files(self, data):
# unpack data
file_contents, replacements, expected_file_content = data
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
# run tag substitution with data
tmp_file = Path(tmp_base_dir) / "test"
with open(tmp_file, "a", encoding="utf-8") as f:
f.write(file_contents)
for key, value in replacements:
replace_in_files([tmp_file], key, value)
with open(tmp_file, "r", encoding="utf-8") as f:
file_contents = f.read()
# check that file contents match
self.assertEqual(file_contents, expected_file_content)
def test_replace_in_files_invalid_path(self):
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
# invalid file path should raise FileNotFoundError
invalid_path = Path(tmp_base_dir) / "invalid"
with self.assertRaises(FileNotFoundError):
replace_in_files([invalid_path], "foo", "bar")
def test_replace_in_files_not_array(self):
# non-array should raise TypeError
with self.assertRaises(TypeError):
replace_in_files(None, "foo", "bar")
def test_replace_in_files_empty_array(self):
# empty file array should not raise exception
replace_in_files([], "foo", "bar")
@data(
(
("script.py", "content\n foo bar\n"),
(["*.prl", ".pri"], "foo"),
[],
),
(
("file.pc", "content\n foo bar\n"),
(["*.pc"], "foo"),
["file.pc"],
),
(
("file.la", "content\n foo bar\n"),
(["*.la"], "foobar"),
[],
),
(
("file.x", "foobar"),
(["*.x"], ""),
["file.x"],
),
(
("file.x", "foobar"),
([], "foobar"),
["file.x"],
),
(
("subfolder/file.x", "foobar"),
(["*.x"], "foobar"),
["file.x"],
),
)
def test_search_for_files(self, data):
file, params, expected_files = data
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
path, content = file
tmp_file = Path(tmp_base_dir) / path
tmp_file.parents[0].mkdir(parents=True, exist_ok=True)
with open(tmp_file, "a", encoding="utf-8") as f:
f.write(content)
extensions, rgx = params
result = search_for_files(tmp_base_dir, extensions, rgx)
self.assertEqual(len(result), len(expected_files))
for result_path, expected_path in zip(result, expected_files):
self.assertEqual(Path(result_path).name, expected_path)
@data(
(([], [], ['d', '.d', 'tst.y', '.t', 'tst.t', 'tempty', 'd/tst.t', 'd/n', '.d/.t'])),
((["*"], [], ['d', '.d', 'tst.y', '.t', 'tst.t', 'tempty', 'd/tst.t', 'd/n', '.d/.t'])),
((["tst*"], [os.path.isfile], ['tst.y', 'tst.t', 'd/tst.t'])),
((["*"], [os.path.isdir], ['d', '.d', 'tempty', 'd/n'])),
((["*y"], [], ['tst.y', 'tempty'])),
((["tst.t"], [], ['tst.t', 'd/tst.t'])),
((["wontmatch"], [], [])),
((["*.t", "*.y"], [], ['tst.y', '.t', 'tst.t', 'd/tst.t', '.d/.t'])),
(([".t", ".d"], [], ['.d', '.t', '.d/.t']))
)
def test_locate_paths(self, data):
pattern, filters, expected_results = data
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
# Create files and folders
test_folders = ["/tempty", "/d/n", "/.d"]
test_files = ["/tst.t", "/tst.y", "/d/tst.t", "/.t", "/.d/.t"]
for folder in test_folders:
Path(tmp_base_dir + folder).mkdir(parents=True)
for file in test_files:
Path(tmp_base_dir + file).touch()
result = locate_paths(tmp_base_dir, pattern, filters)
result = [str(Path(p).relative_to(tmp_base_dir)) for p in result]
self.assertEqual(expected_results, result)
def test_locate_path(self):
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
test_file = tmp_base_dir + "/test"
Path(test_file).touch()
self.assertEqual(test_file, locate_path(tmp_base_dir, ["test"], [os.path.isfile]))
def test_locate_path_no_matches(self):
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
with self.assertRaises(PackagingError):
locate_path(tmp_base_dir, ["test"], [os.path.isfile])
def test_locate_path_multiple_matches(self):
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
Path(tmp_base_dir + "/file").touch()
Path(tmp_base_dir + "/file2").touch()
with self.assertRaises(PackagingError):
locate_path(tmp_base_dir, ["file", "file2"])
@unittest.skipIf(is_windows(), "Windows not supported for this test")
def test_locate_executable(self):
with TemporaryDirectory(dir=os.getcwd()) as tmp_base_dir:
Path(tmp_base_dir + "/test_file").touch()
Path(tmp_base_dir + "/test_file2").touch(0o755)
# File with executable bit not set should throw an error
with self.assertRaises(PackagingError):
locate_executable(tmp_base_dir, ["test_file"])
self.assertEqual(
locate_executable(tmp_base_dir, ["test_file2"]),
tmp_base_dir + "/test_file2")
if __name__ == "__main__":
unittest.main()
|
