Python code coverage for Lib/test/test_tools.py

#	count	content
1	n/a	"""Tests for scripts in the Tools directory.
2	n/a
3	n/a	This file contains regression tests for some of the scripts found in the
4	n/a	Tools directory of a Python checkout or tarball, such as reindent.py.
5	n/a	"""
6	n/a
7	n/a	import os
8	n/a	import sys
9	n/a	import importlib.machinery
10	n/a	import unittest
11	n/a	from unittest import mock
12	n/a	import shutil
13	n/a	import subprocess
14	n/a	import sysconfig
15	n/a	import tempfile
16	n/a	import textwrap
17	n/a	from test import support
18	n/a	from test.script_helper import assert_python_ok, temp_dir
19	n/a
20	n/a	if not sysconfig.is_python_build():
21	n/a	# XXX some installers do contain the tools, should we detect that
22	n/a	# and run the tests in that case too?
23	n/a	raise unittest.SkipTest('test irrelevant for an installed Python')
24	n/a
25	n/a	basepath = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))),
26	n/a	'Tools')
27	n/a	scriptsdir = os.path.join(basepath, 'scripts')
28	n/a
29	n/a
30	n/a	class ReindentTests(unittest.TestCase):
31	n/a	script = os.path.join(scriptsdir, 'reindent.py')
32	n/a
33	n/a	def test_noargs(self):
34	n/a	assert_python_ok(self.script)
35	n/a
36	n/a	def test_help(self):
37	n/a	rc, out, err = assert_python_ok(self.script, '-h')
38	n/a	self.assertEqual(out, b'')
39	n/a	self.assertGreater(err, b'')
40	n/a
41	n/a
42	n/a	class PindentTests(unittest.TestCase):
43	n/a	script = os.path.join(scriptsdir, 'pindent.py')
44	n/a
45	n/a	def assertFileEqual(self, fn1, fn2):
46	n/a	with open(fn1) as f1, open(fn2) as f2:
47	n/a	self.assertEqual(f1.readlines(), f2.readlines())
48	n/a
49	n/a	def pindent(self, source, *args):
50	n/a	with subprocess.Popen(
51	n/a	(sys.executable, self.script) + args,
52	n/a	stdin=subprocess.PIPE, stdout=subprocess.PIPE,
53	n/a	universal_newlines=True) as proc:
54	n/a	out, err = proc.communicate(source)
55	n/a	self.assertIsNone(err)
56	n/a	return out
57	n/a
58	n/a	def lstriplines(self, data):
59	n/a	return '\n'.join(line.lstrip() for line in data.splitlines()) + '\n'
60	n/a
61	n/a	def test_selftest(self):
62	n/a	self.maxDiff = None
63	n/a	with temp_dir() as directory:
64	n/a	data_path = os.path.join(directory, '_test.py')
65	n/a	with open(self.script) as f:
66	n/a	closed = f.read()
67	n/a	with open(data_path, 'w') as f:
68	n/a	f.write(closed)
69	n/a
70	n/a	rc, out, err = assert_python_ok(self.script, '-d', data_path)
71	n/a	self.assertEqual(out, b'')
72	n/a	self.assertEqual(err, b'')
73	n/a	backup = data_path + '~'
74	n/a	self.assertTrue(os.path.exists(backup))
75	n/a	with open(backup) as f:
76	n/a	self.assertEqual(f.read(), closed)
77	n/a	with open(data_path) as f:
78	n/a	clean = f.read()
79	n/a	compile(clean, '_test.py', 'exec')
80	n/a	self.assertEqual(self.pindent(clean, '-c'), closed)
81	n/a	self.assertEqual(self.pindent(closed, '-d'), clean)
82	n/a
83	n/a	rc, out, err = assert_python_ok(self.script, '-c', data_path)
84	n/a	self.assertEqual(out, b'')
85	n/a	self.assertEqual(err, b'')
86	n/a	with open(backup) as f:
87	n/a	self.assertEqual(f.read(), clean)
88	n/a	with open(data_path) as f:
89	n/a	self.assertEqual(f.read(), closed)
90	n/a
91	n/a	broken = self.lstriplines(closed)
92	n/a	with open(data_path, 'w') as f:
93	n/a	f.write(broken)
94	n/a	rc, out, err = assert_python_ok(self.script, '-r', data_path)
95	n/a	self.assertEqual(out, b'')
96	n/a	self.assertEqual(err, b'')
97	n/a	with open(backup) as f:
98	n/a	self.assertEqual(f.read(), broken)
99	n/a	with open(data_path) as f:
100	n/a	indented = f.read()
101	n/a	compile(indented, '_test.py', 'exec')
102	n/a	self.assertEqual(self.pindent(broken, '-r'), indented)
103	n/a
104	n/a	def pindent_test(self, clean, closed):
105	n/a	self.assertEqual(self.pindent(clean, '-c'), closed)
106	n/a	self.assertEqual(self.pindent(closed, '-d'), clean)
107	n/a	broken = self.lstriplines(closed)
108	n/a	self.assertEqual(self.pindent(broken, '-r', '-e', '-s', '4'), closed)
109	n/a
110	n/a	def test_statements(self):
111	n/a	clean = textwrap.dedent("""\
112	n/a	if a:
113	n/a	pass
114	n/a
115	n/a	if a:
116	n/a	pass
117	n/a	else:
118	n/a	pass
119	n/a
120	n/a	if a:
121	n/a	pass
122	n/a	elif:
123	n/a	pass
124	n/a	else:
125	n/a	pass
126	n/a
127	n/a	while a:
128	n/a	break
129	n/a
130	n/a	while a:
131	n/a	break
132	n/a	else:
133	n/a	pass
134	n/a
135	n/a	for i in a:
136	n/a	break
137	n/a
138	n/a	for i in a:
139	n/a	break
140	n/a	else:
141	n/a	pass
142	n/a
143	n/a	try:
144	n/a	pass
145	n/a	finally:
146	n/a	pass
147	n/a
148	n/a	try:
149	n/a	pass
150	n/a	except TypeError:
151	n/a	pass
152	n/a	except ValueError:
153	n/a	pass
154	n/a	else:
155	n/a	pass
156	n/a
157	n/a	try:
158	n/a	pass
159	n/a	except TypeError:
160	n/a	pass
161	n/a	except ValueError:
162	n/a	pass
163	n/a	finally:
164	n/a	pass
165	n/a
166	n/a	with a:
167	n/a	pass
168	n/a
169	n/a	class A:
170	n/a	pass
171	n/a
172	n/a	def f():
173	n/a	pass
174	n/a	""")
175	n/a
176	n/a	closed = textwrap.dedent("""\
177	n/a	if a:
178	n/a	pass
179	n/a	# end if
180	n/a
181	n/a	if a:
182	n/a	pass
183	n/a	else:
184	n/a	pass
185	n/a	# end if
186	n/a
187	n/a	if a:
188	n/a	pass
189	n/a	elif:
190	n/a	pass
191	n/a	else:
192	n/a	pass
193	n/a	# end if
194	n/a
195	n/a	while a:
196	n/a	break
197	n/a	# end while
198	n/a
199	n/a	while a:
200	n/a	break
201	n/a	else:
202	n/a	pass
203	n/a	# end while
204	n/a
205	n/a	for i in a:
206	n/a	break
207	n/a	# end for
208	n/a
209	n/a	for i in a:
210	n/a	break
211	n/a	else:
212	n/a	pass
213	n/a	# end for
214	n/a
215	n/a	try:
216	n/a	pass
217	n/a	finally:
218	n/a	pass
219	n/a	# end try
220	n/a
221	n/a	try:
222	n/a	pass
223	n/a	except TypeError:
224	n/a	pass
225	n/a	except ValueError:
226	n/a	pass
227	n/a	else:
228	n/a	pass
229	n/a	# end try
230	n/a
231	n/a	try:
232	n/a	pass
233	n/a	except TypeError:
234	n/a	pass
235	n/a	except ValueError:
236	n/a	pass
237	n/a	finally:
238	n/a	pass
239	n/a	# end try
240	n/a
241	n/a	with a:
242	n/a	pass
243	n/a	# end with
244	n/a
245	n/a	class A:
246	n/a	pass
247	n/a	# end class A
248	n/a
249	n/a	def f():
250	n/a	pass
251	n/a	# end def f
252	n/a	""")
253	n/a	self.pindent_test(clean, closed)
254	n/a
255	n/a	def test_multilevel(self):
256	n/a	clean = textwrap.dedent("""\
257	n/a	def foobar(a, b):
258	n/a	if a == b:
259	n/a	a = a+1
260	n/a	elif a < b:
261	n/a	b = b-1
262	n/a	if b > a: a = a-1
263	n/a	else:
264	n/a	print 'oops!'
265	n/a	""")
266	n/a	closed = textwrap.dedent("""\
267	n/a	def foobar(a, b):
268	n/a	if a == b:
269	n/a	a = a+1
270	n/a	elif a < b:
271	n/a	b = b-1
272	n/a	if b > a: a = a-1
273	n/a	# end if
274	n/a	else:
275	n/a	print 'oops!'
276	n/a	# end if
277	n/a	# end def foobar
278	n/a	""")
279	n/a	self.pindent_test(clean, closed)
280	n/a
281	n/a	def test_preserve_indents(self):
282	n/a	clean = textwrap.dedent("""\
283	n/a	if a:
284	n/a	if b:
285	n/a	pass
286	n/a	""")
287	n/a	closed = textwrap.dedent("""\
288	n/a	if a:
289	n/a	if b:
290	n/a	pass
291	n/a	# end if
292	n/a	# end if
293	n/a	""")
294	n/a	self.assertEqual(self.pindent(clean, '-c'), closed)
295	n/a	self.assertEqual(self.pindent(closed, '-d'), clean)
296	n/a	broken = self.lstriplines(closed)
297	n/a	self.assertEqual(self.pindent(broken, '-r', '-e', '-s', '9'), closed)
298	n/a	clean = textwrap.dedent("""\
299	n/a	if a:
300	n/a	\tif b:
301	n/a	\t\tpass
302	n/a	""")
303	n/a	closed = textwrap.dedent("""\
304	n/a	if a:
305	n/a	\tif b:
306	n/a	\t\tpass
307	n/a	\t# end if
308	n/a	# end if
309	n/a	""")
310	n/a	self.assertEqual(self.pindent(clean, '-c'), closed)
311	n/a	self.assertEqual(self.pindent(closed, '-d'), clean)
312	n/a	broken = self.lstriplines(closed)
313	n/a	self.assertEqual(self.pindent(broken, '-r'), closed)
314	n/a
315	n/a	def test_escaped_newline(self):
316	n/a	clean = textwrap.dedent("""\
317	n/a	class\\
318	n/a	\\
319	n/a	A:
320	n/a	def\
321	n/a	\\
322	n/a	f:
323	n/a	pass
324	n/a	""")
325	n/a	closed = textwrap.dedent("""\
326	n/a	class\\
327	n/a	\\
328	n/a	A:
329	n/a	def\
330	n/a	\\
331	n/a	f:
332	n/a	pass
333	n/a	# end def f
334	n/a	# end class A
335	n/a	""")
336	n/a	self.assertEqual(self.pindent(clean, '-c'), closed)
337	n/a	self.assertEqual(self.pindent(closed, '-d'), clean)
338	n/a
339	n/a	def test_empty_line(self):
340	n/a	clean = textwrap.dedent("""\
341	n/a	if a:
342	n/a
343	n/a	pass
344	n/a	""")
345	n/a	closed = textwrap.dedent("""\
346	n/a	if a:
347	n/a
348	n/a	pass
349	n/a	# end if
350	n/a	""")
351	n/a	self.pindent_test(clean, closed)
352	n/a
353	n/a	def test_oneline(self):
354	n/a	clean = textwrap.dedent("""\
355	n/a	if a: pass
356	n/a	""")
357	n/a	closed = textwrap.dedent("""\
358	n/a	if a: pass
359	n/a	# end if
360	n/a	""")
361	n/a	self.pindent_test(clean, closed)
362	n/a
363	n/a
364	n/a	class TestSundryScripts(unittest.TestCase):
365	n/a	# At least make sure the rest don't have syntax errors. When tests are
366	n/a	# added for a script it should be added to the whitelist below.
367	n/a
368	n/a	# scripts that have independent tests.
369	n/a	whitelist = ['reindent.py', 'pdeps.py', 'gprof2html']
370	n/a	# scripts that can't be imported without running
371	n/a	blacklist = ['make_ctype.py']
372	n/a	# scripts that use windows-only modules
373	n/a	windows_only = ['win_add2path.py']
374	n/a	# blacklisted for other reasons
375	n/a	other = ['analyze_dxp.py']
376	n/a
377	n/a	skiplist = blacklist + whitelist + windows_only + other
378	n/a
379	n/a	def setUp(self):
380	n/a	cm = support.DirsOnSysPath(scriptsdir)
381	n/a	cm.__enter__()
382	n/a	self.addCleanup(cm.__exit__)
383	n/a
384	n/a	def test_sundry(self):
385	n/a	for fn in os.listdir(scriptsdir):
386	n/a	if fn.endswith('.py') and fn not in self.skiplist:
387	n/a	__import__(fn[:-3])
388	n/a
389	n/a	@unittest.skipIf(sys.platform != "win32", "Windows-only test")
390	n/a	def test_sundry_windows(self):
391	n/a	for fn in self.windows_only:
392	n/a	__import__(fn[:-3])
393	n/a
394	n/a	@unittest.skipIf(not support.threading, "test requires _thread module")
395	n/a	def test_analyze_dxp_import(self):
396	n/a	if hasattr(sys, 'getdxp'):
397	n/a	import analyze_dxp
398	n/a	else:
399	n/a	with self.assertRaises(RuntimeError):
400	n/a	import analyze_dxp
401	n/a
402	n/a
403	n/a	class PdepsTests(unittest.TestCase):
404	n/a
405	n/a	@classmethod
406	n/a	def setUpClass(self):
407	n/a	path = os.path.join(scriptsdir, 'pdeps.py')
408	n/a	loader = importlib.machinery.SourceFileLoader('pdeps', path)
409	n/a	self.pdeps = loader.load_module()
410	n/a
411	n/a	@classmethod
412	n/a	def tearDownClass(self):
413	n/a	if 'pdeps' in sys.modules:
414	n/a	del sys.modules['pdeps']
415	n/a
416	n/a	def test_process_errors(self):
417	n/a	# Issue #14492: m_import.match(line) can be None.
418	n/a	with tempfile.TemporaryDirectory() as tmpdir:
419	n/a	fn = os.path.join(tmpdir, 'foo')
420	n/a	with open(fn, 'w') as stream:
421	n/a	stream.write("#!/this/will/fail")
422	n/a	self.pdeps.process(fn, {})
423	n/a
424	n/a	def test_inverse_attribute_error(self):
425	n/a	# Issue #14492: this used to fail with an AttributeError.
426	n/a	self.pdeps.inverse({'a': []})
427	n/a
428	n/a
429	n/a	class Gprof2htmlTests(unittest.TestCase):
430	n/a
431	n/a	def setUp(self):
432	n/a	path = os.path.join(scriptsdir, 'gprof2html.py')
433	n/a	loader = importlib.machinery.SourceFileLoader('gprof2html', path)
434	n/a	self.gprof = loader.load_module()
435	n/a	oldargv = sys.argv
436	n/a	def fixup():
437	n/a	sys.argv = oldargv
438	n/a	self.addCleanup(fixup)
439	n/a	sys.argv = []
440	n/a
441	n/a	def test_gprof(self):
442	n/a	# Issue #14508: this used to fail with an NameError.
443	n/a	with mock.patch.object(self.gprof, 'webbrowser') as wmock, \
444	n/a	tempfile.TemporaryDirectory() as tmpdir:
445	n/a	fn = os.path.join(tmpdir, 'abc')
446	n/a	open(fn, 'w').close()
447	n/a	sys.argv = ['gprof2html', fn]
448	n/a	self.gprof.main()
449	n/a	self.assertTrue(wmock.open.called)
450	n/a
451	n/a
452	n/a	# Run the tests in Tools/parser/test_unparse.py
453	n/a	with support.DirsOnSysPath(os.path.join(basepath, 'parser')):
454	n/a	from test_unparse import UnparseTestCase
455	n/a	from test_unparse import DirectoryTestCase
456	n/a
457	n/a
458	n/a	def test_main():
459	n/a	support.run_unittest(*[obj for obj in globals().values()
460	n/a	if isinstance(obj, type)])
461	n/a
462	n/a
463	n/a	if __name__ == '__main__':
464	n/a	unittest.main()