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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
#-----------------------------------------------------------------------------
# Copyright (c) 2005-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------
# This contains tests for the class:``TOC``, see
# https://pyinstaller.readthedocs.io/en/latest/advanced-topics.html#the-toc-and-tree-classes
import pytest
from PyInstaller.building.datastruct import TOC
ELEMS1 = (
('encodings', '/usr/lib/python2.7/encodings/__init__.py', 'PYMODULE'),
('_random', '/usr/lib/python2.7/lib-dynload/_random.so', 'EXTENSION'),
('libreadline.so.6', '/lib64/libreadline.so.6', 'BINARY'),
)
ELEMS2 = (
('li-la-lu', '/home/myself/li-la-su', 'SOMETHING'),
('schubidu', '/home/otherguy/schibidu', 'PKG'),
)
ELEMS3 = (('PIL.Image.py', '/usr/lib/python2.7/encodings/__init__.py', 'PYMODULE'),)
# Ignore deprecation warnings for the TOC class
pytestmark = pytest.mark.filterwarnings("ignore:TOC class is deprecated.")
def test_init_empty():
toc = TOC()
assert len(toc) == 0
def test_init():
toc = TOC(ELEMS1)
assert len(toc) == 3
assert toc == list(ELEMS1)
def test_append():
toc = TOC(ELEMS1)
toc.append(('li-la-lu', '/home/myself/li-la-su', 'SOMETHING'))
expected = list(ELEMS1)
expected.append(('li-la-lu', '/home/myself/li-la-su', 'SOMETHING'))
assert toc == expected
def test_append_existing():
toc = TOC(ELEMS1)
toc.append(ELEMS1[-1])
expected = list(ELEMS1)
assert toc == expected
def test_append_keep_filename():
# name in TOC should be the same as the one added
toc = TOC()
entry = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'BINARY')
toc.append(entry)
assert toc[0][0] == entry[0]
def test_insert():
toc = TOC(ELEMS1)
toc.insert(1, ('li-la-lu', '/home/myself/li-la-su', 'SOMETHING'))
expected = list(ELEMS1)
expected.insert(1, ('li-la-lu', '/home/myself/li-la-su', 'SOMETHING'))
assert toc == expected
def test_insert_existing():
toc = TOC(ELEMS1)
toc.insert(0, ELEMS1[-1])
toc.insert(1, ELEMS1[-1])
expected = list(ELEMS1)
assert toc == expected
def test_insert_keep_filename():
# name in TOC should be the same as the one added
toc = TOC()
entry = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'BINARY')
toc.insert(1, entry)
assert toc[0][0] == entry[0]
def test_extend():
toc = TOC(ELEMS1)
toc.extend(ELEMS2)
expected = list(ELEMS1)
expected.extend(ELEMS2)
assert toc == expected
def test_extend_existing():
toc = TOC(ELEMS1)
toc.extend(ELEMS1)
expected = list(ELEMS1)
assert toc == expected
def test_add_list():
toc = TOC(ELEMS1)
other = list(ELEMS2)
result = toc + other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1) + list(ELEMS2)
assert result == expected
def test_add_tuple():
toc = TOC(ELEMS1)
other = ELEMS2
result = toc + other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1) + list(ELEMS2)
assert result == expected
def test_add_toc():
toc = TOC(ELEMS1)
other = TOC(ELEMS2)
result = toc + other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1) + list(ELEMS2)
assert result == expected
def test_radd_list():
toc = TOC(ELEMS1)
other = list(ELEMS2)
result = other + toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2) + list(ELEMS1)
assert result == expected
def test_radd_tuple():
toc = TOC(ELEMS1)
other = ELEMS2
result = other + toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2) + list(ELEMS1)
assert result == expected
def test_radd_toc():
toc = TOC(ELEMS1)
other = TOC(ELEMS2)
result = other + toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2) + list(ELEMS1)
assert result == expected
def test_sub_list():
toc = TOC(ELEMS1) + ELEMS2
other = list(ELEMS2)
result = toc - other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1)
assert result == expected
def test_sub_tuple():
toc = TOC(ELEMS1) + ELEMS2
other = ELEMS2
result = toc - other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1)
assert result == expected
def test_sub_toc():
toc = TOC(ELEMS1) + ELEMS2
other = TOC(ELEMS2)
result = toc - other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1)
assert result == expected
def test_sub_non_existing():
toc = TOC(ELEMS1)
other = ELEMS3
result = toc - other
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1)
assert result == expected
def test_rsub_list():
toc = TOC(ELEMS1)
other = list(ELEMS1) + list(ELEMS2)
result = other - toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2)
assert result == expected
def test_rsub_tuple():
toc = TOC(ELEMS1)
other = tuple(list(ELEMS1) + list(ELEMS2))
result = other - toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2)
assert result == expected
def test_rsub_toc():
toc = TOC(ELEMS1)
other = TOC(ELEMS1) + ELEMS2
result = other - toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS2)
assert result == expected
def test_rsub_non_existing():
toc = TOC(ELEMS3)
other = ELEMS1
result = other - toc
assert result is not toc
assert result is not other
assert isinstance(result, TOC)
expected = list(ELEMS1)
assert result == expected
def test_sub_after_setitem():
toc = TOC(ELEMS1)
toc[1] = ('lib-dynload/_random', '/usr/lib/python2.7/lib-dynload/_random.so', 'EXTENSION')
toc -= []
assert len(toc) == 3
def test_sub_after_sub():
toc = TOC(ELEMS1)
toc -= [ELEMS1[0]]
toc -= [ELEMS1[1]]
expected = list(ELEMS1[2:])
assert toc == expected
def test_setitem_1():
toc = TOC()
toc[:] = ELEMS1
for e in ELEMS1:
assert e in toc
assert e[0] in toc.filenames
def test_setitem_2():
toc = TOC(ELEMS1)
toc[1] = ELEMS3[0]
assert ELEMS1[0] in toc
assert ELEMS1[0][0] in toc.filenames
assert ELEMS3[0] in toc
assert ELEMS3[0][0] in toc.filenames
assert ELEMS1[2] in toc
assert ELEMS1[2][0] in toc.filenames
for e in toc:
assert e[0] in toc.filenames
# The following tests verify that case-insensitive comparisons are used on Windows and only for
# appropriate TOC entry types
@pytest.mark.win32
def test_append_other_case_mixed():
# If a binary file is added with the same filename as an existing pymodule, it should not be added.
toc = TOC(ELEMS1)
elem = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'BINARY')
toc.append(elem)
expected = list(ELEMS1)
assert toc == expected
@pytest.mark.win32
def test_append_other_case_pymodule():
# Python modules should not use C-I comparisons. Both 'encodings' and 'EnCodIngs' should be added.
toc = TOC(ELEMS1)
elem = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'PYMODULE')
toc.append(elem)
expected = list(ELEMS1)
expected.append(elem)
assert toc == expected
@pytest.mark.win32
def test_append_other_case_binary():
# Binary files should use C-I comparisons. 'LiBrEADlInE.so.6' should not be added.
toc = TOC(ELEMS1)
toc.append(('LiBrEADlInE.so.6', '/lib64/libreadline.so.6', 'BINARY'))
expected = list(ELEMS1)
assert toc == expected
@pytest.mark.win32
def test_insert_other_case_mixed():
# If a binary file is added with the same filename as an existing pymodule, it should not be added.
toc = TOC(ELEMS1)
elem = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'BINARY')
toc.insert(1, elem)
expected = list(ELEMS1)
assert toc == expected
@pytest.mark.win32
def test_insert_other_case_pymodule():
# Python modules should not use C-I comparisons. Both 'encodings' and 'EnCodIngs' should be added.
toc = TOC(ELEMS1)
elem = ('EnCodIngs', '/usr/lib/python2.7/encodings.py', 'PYMODULE')
toc.insert(1, elem)
expected = list(ELEMS1)
expected.insert(1, elem)
assert toc == expected
@pytest.mark.win32
def test_insert_other_case_binary():
# Binary files should use C-I comparisons. 'LiBrEADlInE.so.6' should not be added.
toc = TOC(ELEMS1)
toc.insert(1, ('LiBrEADlInE.so.6', '/lib64/libreadline.so.6', 'BINARY'))
expected = list(ELEMS1)
assert toc == expected
|
