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
|
"""Tests for packaging.manifest."""
import os
import re
from io import StringIO
from packaging.errors import PackagingTemplateError
from packaging.manifest import Manifest, _translate_pattern, _glob_to_re
from packaging.tests import unittest, support
MANIFEST_IN = """\
include ok
include xo
exclude xo
include foo.tmp
include buildout.cfg
global-include *.x
global-include *.txt
global-exclude *.tmp
recursive-include f *.oo
recursive-exclude global *.x
graft dir
prune dir3
"""
MANIFEST_IN_2 = """\
recursive-include foo *.py # ok
# nothing here
#
recursive-include bar \\
*.dat *.txt
"""
MANIFEST_IN_3 = """\
README
file1
"""
def make_local_path(s):
"""Converts '/' in a string to os.sep"""
return s.replace('/', os.sep)
class ManifestTestCase(support.TempdirManager,
support.LoggingCatcher,
unittest.TestCase):
def assertNoWarnings(self):
self.assertEqual(self.get_logs(), [])
def assertWarnings(self):
self.assertNotEqual(self.get_logs(), [])
def test_manifest_reader(self):
tmpdir = self.mkdtemp()
MANIFEST = os.path.join(tmpdir, 'MANIFEST.in')
with open(MANIFEST, 'w') as f:
f.write(MANIFEST_IN_2)
manifest = Manifest()
manifest.read_template(MANIFEST)
warnings = self.get_logs()
# the manifest should have been read and 3 warnings issued
# (we didn't provide the files)
self.assertEqual(3, len(warnings))
for warning in warnings:
self.assertIn('no files found matching', warning)
# manifest also accepts file-like objects
with open(MANIFEST) as f:
manifest.read_template(f)
# the manifest should have been read and 3 warnings issued
# (we didn't provide the files)
self.assertEqual(3, len(warnings))
def test_default_actions(self):
tmpdir = self.mkdtemp()
self.addCleanup(os.chdir, os.getcwd())
os.chdir(tmpdir)
self.write_file('README', 'xxx')
self.write_file('file1', 'xxx')
content = StringIO(MANIFEST_IN_3)
manifest = Manifest()
manifest.read_template(content)
self.assertEqual(['README', 'file1'], manifest.files)
def test_glob_to_re(self):
sep = os.sep
if os.sep == '\\':
sep = r'\\'
for glob, regex in (
# simple cases
('foo*', r'foo[^%(sep)s]*\Z(?ms)'),
('foo?', r'foo[^%(sep)s]\Z(?ms)'),
('foo??', r'foo[^%(sep)s][^%(sep)s]\Z(?ms)'),
# special cases
(r'foo\\*', r'foo\\\\[^%(sep)s]*\Z(?ms)'),
(r'foo\\\*', r'foo\\\\\\[^%(sep)s]*\Z(?ms)'),
('foo????', r'foo[^%(sep)s][^%(sep)s][^%(sep)s][^%(sep)s]\Z(?ms)'),
(r'foo\\??', r'foo\\\\[^%(sep)s][^%(sep)s]\Z(?ms)'),
):
regex = regex % {'sep': sep}
self.assertEqual(_glob_to_re(glob), regex)
def test_process_template_line(self):
# testing all MANIFEST.in template patterns
manifest = Manifest()
l = make_local_path
# simulated file list
manifest.allfiles = ['foo.tmp', 'ok', 'xo', 'four.txt',
'buildout.cfg',
# filelist does not filter out VCS directories,
# it's sdist that does
l('.hg/last-message.txt'),
l('global/one.txt'),
l('global/two.txt'),
l('global/files.x'),
l('global/here.tmp'),
l('f/o/f.oo'),
l('dir/graft-one'),
l('dir/dir2/graft2'),
l('dir3/ok'),
l('dir3/sub/ok.txt'),
]
for line in MANIFEST_IN.split('\n'):
if line.strip() == '':
continue
manifest._process_template_line(line)
wanted = ['ok',
'buildout.cfg',
'four.txt',
l('.hg/last-message.txt'),
l('global/one.txt'),
l('global/two.txt'),
l('f/o/f.oo'),
l('dir/graft-one'),
l('dir/dir2/graft2'),
]
self.assertEqual(manifest.files, wanted)
def test_remove_duplicates(self):
manifest = Manifest()
manifest.files = ['a', 'b', 'a', 'g', 'c', 'g']
# files must be sorted beforehand (like sdist does)
manifest.sort()
manifest.remove_duplicates()
self.assertEqual(manifest.files, ['a', 'b', 'c', 'g'])
def test_translate_pattern(self):
# blackbox test of a private function
# not regex
pattern = _translate_pattern('a', anchor=True, is_regex=False)
self.assertTrue(hasattr(pattern, 'search'))
# is a regex
regex = re.compile('a')
pattern = _translate_pattern(regex, anchor=True, is_regex=True)
self.assertEqual(pattern, regex)
# plain string flagged as regex
pattern = _translate_pattern('a', anchor=True, is_regex=True)
self.assertTrue(hasattr(pattern, 'search'))
# glob support
pattern = _translate_pattern('*.py', anchor=True, is_regex=False)
self.assertTrue(pattern.search('filelist.py'))
def test_exclude_pattern(self):
# return False if no match
manifest = Manifest()
self.assertFalse(manifest.exclude_pattern('*.py'))
# return True if files match
manifest = Manifest()
manifest.files = ['a.py', 'b.py']
self.assertTrue(manifest.exclude_pattern('*.py'))
# test excludes
manifest = Manifest()
manifest.files = ['a.py', 'a.txt']
manifest.exclude_pattern('*.py')
self.assertEqual(manifest.files, ['a.txt'])
def test_include_pattern(self):
# return False if no match
manifest = Manifest()
manifest.allfiles = []
self.assertFalse(manifest._include_pattern('*.py'))
# return True if files match
manifest = Manifest()
manifest.allfiles = ['a.py', 'b.txt']
self.assertTrue(manifest._include_pattern('*.py'))
# test * matches all files
manifest = Manifest()
self.assertIsNone(manifest.allfiles)
manifest.allfiles = ['a.py', 'b.txt']
manifest._include_pattern('*')
self.assertEqual(manifest.allfiles, ['a.py', 'b.txt'])
def test_process_template(self):
l = make_local_path
# invalid lines
manifest = Manifest()
for action in ('include', 'exclude', 'global-include',
'global-exclude', 'recursive-include',
'recursive-exclude', 'graft', 'prune'):
self.assertRaises(PackagingTemplateError,
manifest._process_template_line, action)
# implicit include
manifest = Manifest()
manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
manifest._process_template_line('*.py')
self.assertEqual(manifest.files, ['a.py'])
self.assertNoWarnings()
# include
manifest = Manifest()
manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
manifest._process_template_line('include *.py')
self.assertEqual(manifest.files, ['a.py'])
self.assertNoWarnings()
manifest._process_template_line('include *.rb')
self.assertEqual(manifest.files, ['a.py'])
self.assertWarnings()
# exclude
manifest = Manifest()
manifest.files = ['a.py', 'b.txt', l('d/c.py')]
manifest._process_template_line('exclude *.py')
self.assertEqual(manifest.files, ['b.txt', l('d/c.py')])
self.assertNoWarnings()
manifest._process_template_line('exclude *.rb')
self.assertEqual(manifest.files, ['b.txt', l('d/c.py')])
self.assertWarnings()
# global-include
manifest = Manifest()
manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
manifest._process_template_line('global-include *.py')
self.assertEqual(manifest.files, ['a.py', l('d/c.py')])
self.assertNoWarnings()
manifest._process_template_line('global-include *.rb')
self.assertEqual(manifest.files, ['a.py', l('d/c.py')])
self.assertWarnings()
# global-exclude
manifest = Manifest()
manifest.files = ['a.py', 'b.txt', l('d/c.py')]
manifest._process_template_line('global-exclude *.py')
self.assertEqual(manifest.files, ['b.txt'])
self.assertNoWarnings()
manifest._process_template_line('global-exclude *.rb')
self.assertEqual(manifest.files, ['b.txt'])
self.assertWarnings()
# recursive-include
manifest = Manifest()
manifest.allfiles = ['a.py', l('d/b.py'), l('d/c.txt'), l('d/d/e.py')]
manifest._process_template_line('recursive-include d *.py')
self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
self.assertNoWarnings()
manifest._process_template_line('recursive-include e *.py')
self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
self.assertWarnings()
# recursive-exclude
manifest = Manifest()
manifest.files = ['a.py', l('d/b.py'), l('d/c.txt'), l('d/d/e.py')]
manifest._process_template_line('recursive-exclude d *.py')
self.assertEqual(manifest.files, ['a.py', l('d/c.txt')])
self.assertNoWarnings()
manifest._process_template_line('recursive-exclude e *.py')
self.assertEqual(manifest.files, ['a.py', l('d/c.txt')])
self.assertWarnings()
# graft
manifest = Manifest()
manifest.allfiles = ['a.py', l('d/b.py'), l('d/d/e.py'), l('f/f.py')]
manifest._process_template_line('graft d')
self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
self.assertNoWarnings()
manifest._process_template_line('graft e')
self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
self.assertWarnings()
# prune
manifest = Manifest()
manifest.files = ['a.py', l('d/b.py'), l('d/d/e.py'), l('f/f.py')]
manifest._process_template_line('prune d')
self.assertEqual(manifest.files, ['a.py', l('f/f.py')])
self.assertNoWarnings()
manifest._process_template_line('prune e')
self.assertEqual(manifest.files, ['a.py', l('f/f.py')])
self.assertWarnings()
def test_suite():
return unittest.makeSuite(ManifestTestCase)
if __name__ == '__main__':
unittest.main(defaultTest='test_suite')
|
