Python code coverage for Lib/packaging/tests/test_manifest.py

#	count	content
1	n/a	"""Tests for packaging.manifest."""
2	n/a	import os
3	n/a	import re
4	n/a	from io import StringIO
5	n/a	from packaging.errors import PackagingTemplateError
6	n/a	from packaging.manifest import Manifest, _translate_pattern, _glob_to_re
7	n/a
8	n/a	from packaging.tests import unittest, support
9	n/a
10	n/a	MANIFEST_IN = """\
11	n/a	include ok
12	n/a	include xo
13	n/a	exclude xo
14	n/a	include foo.tmp
15	n/a	include buildout.cfg
16	n/a	global-include *.x
17	n/a	global-include *.txt
18	n/a	global-exclude *.tmp
19	n/a	recursive-include f *.oo
20	n/a	recursive-exclude global *.x
21	n/a	graft dir
22	n/a	prune dir3
23	n/a	"""
24	n/a
25	n/a	MANIFEST_IN_2 = """\
26	n/a	recursive-include foo *.py # ok
27	n/a	# nothing here
28	n/a
29	n/a	#
30	n/a
31	n/a	recursive-include bar \\
32	n/a	.dat .txt
33	n/a	"""
34	n/a
35	n/a	MANIFEST_IN_3 = """\
36	n/a	README
37	n/a	file1
38	n/a	"""
39	n/a
40	n/a
41	n/a	def make_local_path(s):
42	n/a	"""Converts '/' in a string to os.sep"""
43	n/a	return s.replace('/', os.sep)
44	n/a
45	n/a
46	n/a	class ManifestTestCase(support.TempdirManager,
47	n/a	support.LoggingCatcher,
48	n/a	unittest.TestCase):
49	n/a
50	n/a	def assertNoWarnings(self):
51	n/a	self.assertEqual(self.get_logs(), [])
52	n/a
53	n/a	def assertWarnings(self):
54	n/a	self.assertNotEqual(self.get_logs(), [])
55	n/a
56	n/a	def test_manifest_reader(self):
57	n/a	tmpdir = self.mkdtemp()
58	n/a	MANIFEST = os.path.join(tmpdir, 'MANIFEST.in')
59	n/a	with open(MANIFEST, 'w') as f:
60	n/a	f.write(MANIFEST_IN_2)
61	n/a
62	n/a	manifest = Manifest()
63	n/a	manifest.read_template(MANIFEST)
64	n/a
65	n/a	warnings = self.get_logs()
66	n/a	# the manifest should have been read and 3 warnings issued
67	n/a	# (we didn't provide the files)
68	n/a	self.assertEqual(3, len(warnings))
69	n/a	for warning in warnings:
70	n/a	self.assertIn('no files found matching', warning)
71	n/a
72	n/a	# manifest also accepts file-like objects
73	n/a	with open(MANIFEST) as f:
74	n/a	manifest.read_template(f)
75	n/a
76	n/a	# the manifest should have been read and 3 warnings issued
77	n/a	# (we didn't provide the files)
78	n/a	self.assertEqual(3, len(warnings))
79	n/a
80	n/a	def test_default_actions(self):
81	n/a	tmpdir = self.mkdtemp()
82	n/a	self.addCleanup(os.chdir, os.getcwd())
83	n/a	os.chdir(tmpdir)
84	n/a	self.write_file('README', 'xxx')
85	n/a	self.write_file('file1', 'xxx')
86	n/a	content = StringIO(MANIFEST_IN_3)
87	n/a	manifest = Manifest()
88	n/a	manifest.read_template(content)
89	n/a	self.assertEqual(['README', 'file1'], manifest.files)
90	n/a
91	n/a	def test_glob_to_re(self):
92	n/a	sep = os.sep
93	n/a	if os.sep == '\\':
94	n/a	sep = r'\\'
95	n/a
96	n/a	for glob, regex in (
97	n/a	# simple cases
98	n/a	('foo', r'foo[^%(sep)s]\Z(?ms)'),
99	n/a	('foo?', r'foo[^%(sep)s]\Z(?ms)'),
100	n/a	('foo??', r'foo[^%(sep)s][^%(sep)s]\Z(?ms)'),
101	n/a	# special cases
102	n/a	(r'foo\\', r'foo\\\\[^%(sep)s]\Z(?ms)'),
103	n/a	(r'foo\\\', r'foo\\\\\\[^%(sep)s]\Z(?ms)'),
104	n/a	('foo????', r'foo[^%(sep)s][^%(sep)s][^%(sep)s][^%(sep)s]\Z(?ms)'),
105	n/a	(r'foo\\??', r'foo\\\\[^%(sep)s][^%(sep)s]\Z(?ms)'),
106	n/a	):
107	n/a	regex = regex % {'sep': sep}
108	n/a	self.assertEqual(_glob_to_re(glob), regex)
109	n/a
110	n/a	def test_process_template_line(self):
111	n/a	# testing all MANIFEST.in template patterns
112	n/a	manifest = Manifest()
113	n/a	l = make_local_path
114	n/a
115	n/a	# simulated file list
116	n/a	manifest.allfiles = ['foo.tmp', 'ok', 'xo', 'four.txt',
117	n/a	'buildout.cfg',
118	n/a	# filelist does not filter out VCS directories,
119	n/a	# it's sdist that does
120	n/a	l('.hg/last-message.txt'),
121	n/a	l('global/one.txt'),
122	n/a	l('global/two.txt'),
123	n/a	l('global/files.x'),
124	n/a	l('global/here.tmp'),
125	n/a	l('f/o/f.oo'),
126	n/a	l('dir/graft-one'),
127	n/a	l('dir/dir2/graft2'),
128	n/a	l('dir3/ok'),
129	n/a	l('dir3/sub/ok.txt'),
130	n/a	]
131	n/a
132	n/a	for line in MANIFEST_IN.split('\n'):
133	n/a	if line.strip() == '':
134	n/a	continue
135	n/a	manifest._process_template_line(line)
136	n/a
137	n/a	wanted = ['ok',
138	n/a	'buildout.cfg',
139	n/a	'four.txt',
140	n/a	l('.hg/last-message.txt'),
141	n/a	l('global/one.txt'),
142	n/a	l('global/two.txt'),
143	n/a	l('f/o/f.oo'),
144	n/a	l('dir/graft-one'),
145	n/a	l('dir/dir2/graft2'),
146	n/a	]
147	n/a
148	n/a	self.assertEqual(manifest.files, wanted)
149	n/a
150	n/a	def test_remove_duplicates(self):
151	n/a	manifest = Manifest()
152	n/a	manifest.files = ['a', 'b', 'a', 'g', 'c', 'g']
153	n/a	# files must be sorted beforehand (like sdist does)
154	n/a	manifest.sort()
155	n/a	manifest.remove_duplicates()
156	n/a	self.assertEqual(manifest.files, ['a', 'b', 'c', 'g'])
157	n/a
158	n/a	def test_translate_pattern(self):
159	n/a	# blackbox test of a private function
160	n/a
161	n/a	# not regex
162	n/a	pattern = _translate_pattern('a', anchor=True, is_regex=False)
163	n/a	self.assertTrue(hasattr(pattern, 'search'))
164	n/a
165	n/a	# is a regex
166	n/a	regex = re.compile('a')
167	n/a	pattern = _translate_pattern(regex, anchor=True, is_regex=True)
168	n/a	self.assertEqual(pattern, regex)
169	n/a
170	n/a	# plain string flagged as regex
171	n/a	pattern = _translate_pattern('a', anchor=True, is_regex=True)
172	n/a	self.assertTrue(hasattr(pattern, 'search'))
173	n/a
174	n/a	# glob support
175	n/a	pattern = _translate_pattern('*.py', anchor=True, is_regex=False)
176	n/a	self.assertTrue(pattern.search('filelist.py'))
177	n/a
178	n/a	def test_exclude_pattern(self):
179	n/a	# return False if no match
180	n/a	manifest = Manifest()
181	n/a	self.assertFalse(manifest.exclude_pattern('*.py'))
182	n/a
183	n/a	# return True if files match
184	n/a	manifest = Manifest()
185	n/a	manifest.files = ['a.py', 'b.py']
186	n/a	self.assertTrue(manifest.exclude_pattern('*.py'))
187	n/a
188	n/a	# test excludes
189	n/a	manifest = Manifest()
190	n/a	manifest.files = ['a.py', 'a.txt']
191	n/a	manifest.exclude_pattern('*.py')
192	n/a	self.assertEqual(manifest.files, ['a.txt'])
193	n/a
194	n/a	def test_include_pattern(self):
195	n/a	# return False if no match
196	n/a	manifest = Manifest()
197	n/a	manifest.allfiles = []
198	n/a	self.assertFalse(manifest._include_pattern('*.py'))
199	n/a
200	n/a	# return True if files match
201	n/a	manifest = Manifest()
202	n/a	manifest.allfiles = ['a.py', 'b.txt']
203	n/a	self.assertTrue(manifest._include_pattern('*.py'))
204	n/a
205	n/a	# test * matches all files
206	n/a	manifest = Manifest()
207	n/a	self.assertIsNone(manifest.allfiles)
208	n/a	manifest.allfiles = ['a.py', 'b.txt']
209	n/a	manifest._include_pattern('*')
210	n/a	self.assertEqual(manifest.allfiles, ['a.py', 'b.txt'])
211	n/a
212	n/a	def test_process_template(self):
213	n/a	l = make_local_path
214	n/a	# invalid lines
215	n/a	manifest = Manifest()
216	n/a	for action in ('include', 'exclude', 'global-include',
217	n/a	'global-exclude', 'recursive-include',
218	n/a	'recursive-exclude', 'graft', 'prune'):
219	n/a	self.assertRaises(PackagingTemplateError,
220	n/a	manifest._process_template_line, action)
221	n/a
222	n/a	# implicit include
223	n/a	manifest = Manifest()
224	n/a	manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
225	n/a
226	n/a	manifest._process_template_line('*.py')
227	n/a	self.assertEqual(manifest.files, ['a.py'])
228	n/a	self.assertNoWarnings()
229	n/a
230	n/a	# include
231	n/a	manifest = Manifest()
232	n/a	manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
233	n/a
234	n/a	manifest._process_template_line('include *.py')
235	n/a	self.assertEqual(manifest.files, ['a.py'])
236	n/a	self.assertNoWarnings()
237	n/a
238	n/a	manifest._process_template_line('include *.rb')
239	n/a	self.assertEqual(manifest.files, ['a.py'])
240	n/a	self.assertWarnings()
241	n/a
242	n/a	# exclude
243	n/a	manifest = Manifest()
244	n/a	manifest.files = ['a.py', 'b.txt', l('d/c.py')]
245	n/a
246	n/a	manifest._process_template_line('exclude *.py')
247	n/a	self.assertEqual(manifest.files, ['b.txt', l('d/c.py')])
248	n/a	self.assertNoWarnings()
249	n/a
250	n/a	manifest._process_template_line('exclude *.rb')
251	n/a	self.assertEqual(manifest.files, ['b.txt', l('d/c.py')])
252	n/a	self.assertWarnings()
253	n/a
254	n/a	# global-include
255	n/a	manifest = Manifest()
256	n/a	manifest.allfiles = ['a.py', 'b.txt', l('d/c.py')]
257	n/a
258	n/a	manifest._process_template_line('global-include *.py')
259	n/a	self.assertEqual(manifest.files, ['a.py', l('d/c.py')])
260	n/a	self.assertNoWarnings()
261	n/a
262	n/a	manifest._process_template_line('global-include *.rb')
263	n/a	self.assertEqual(manifest.files, ['a.py', l('d/c.py')])
264	n/a	self.assertWarnings()
265	n/a
266	n/a	# global-exclude
267	n/a	manifest = Manifest()
268	n/a	manifest.files = ['a.py', 'b.txt', l('d/c.py')]
269	n/a
270	n/a	manifest._process_template_line('global-exclude *.py')
271	n/a	self.assertEqual(manifest.files, ['b.txt'])
272	n/a	self.assertNoWarnings()
273	n/a
274	n/a	manifest._process_template_line('global-exclude *.rb')
275	n/a	self.assertEqual(manifest.files, ['b.txt'])
276	n/a	self.assertWarnings()
277	n/a
278	n/a	# recursive-include
279	n/a	manifest = Manifest()
280	n/a	manifest.allfiles = ['a.py', l('d/b.py'), l('d/c.txt'), l('d/d/e.py')]
281	n/a
282	n/a	manifest._process_template_line('recursive-include d *.py')
283	n/a	self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
284	n/a	self.assertNoWarnings()
285	n/a
286	n/a	manifest._process_template_line('recursive-include e *.py')
287	n/a	self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
288	n/a	self.assertWarnings()
289	n/a
290	n/a	# recursive-exclude
291	n/a	manifest = Manifest()
292	n/a	manifest.files = ['a.py', l('d/b.py'), l('d/c.txt'), l('d/d/e.py')]
293	n/a
294	n/a	manifest._process_template_line('recursive-exclude d *.py')
295	n/a	self.assertEqual(manifest.files, ['a.py', l('d/c.txt')])
296	n/a	self.assertNoWarnings()
297	n/a
298	n/a	manifest._process_template_line('recursive-exclude e *.py')
299	n/a	self.assertEqual(manifest.files, ['a.py', l('d/c.txt')])
300	n/a	self.assertWarnings()
301	n/a
302	n/a	# graft
303	n/a	manifest = Manifest()
304	n/a	manifest.allfiles = ['a.py', l('d/b.py'), l('d/d/e.py'), l('f/f.py')]
305	n/a
306	n/a	manifest._process_template_line('graft d')
307	n/a	self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
308	n/a	self.assertNoWarnings()
309	n/a
310	n/a	manifest._process_template_line('graft e')
311	n/a	self.assertEqual(manifest.files, [l('d/b.py'), l('d/d/e.py')])
312	n/a	self.assertWarnings()
313	n/a
314	n/a	# prune
315	n/a	manifest = Manifest()
316	n/a	manifest.files = ['a.py', l('d/b.py'), l('d/d/e.py'), l('f/f.py')]
317	n/a
318	n/a	manifest._process_template_line('prune d')
319	n/a	self.assertEqual(manifest.files, ['a.py', l('f/f.py')])
320	n/a	self.assertNoWarnings()
321	n/a
322	n/a	manifest._process_template_line('prune e')
323	n/a	self.assertEqual(manifest.files, ['a.py', l('f/f.py')])
324	n/a	self.assertWarnings()
325	n/a
326	n/a
327	n/a	def test_suite():
328	n/a	return unittest.makeSuite(ManifestTestCase)
329	n/a
330	n/a	if __name__ == '__main__':
331	n/a	unittest.main(defaultTest='test_suite')