Python code coverage for Lib/test/script_helper.py

#	count	content
1	n/a	# Common utility functions used by various script execution tests
2	n/a	# e.g. test_cmd_line, test_cmd_line_script and test_runpy
3	n/a
4	n/a	import importlib
5	n/a	import sys
6	n/a	import os
7	n/a	import os.path
8	n/a	import tempfile
9	n/a	import subprocess
10	n/a	import py_compile
11	n/a	import contextlib
12	n/a	import shutil
13	n/a	import zipfile
14	n/a
15	n/a	from importlib.util import source_from_cache
16	n/a	from test.support import make_legacy_pyc, strip_python_stderr, temp_dir
17	n/a
18	n/a	# Executing the interpreter in a subprocess
19	n/a	def _assert_python(expected_success, args, *env_vars):
20	n/a	cmd_line = [sys.executable, '-X', 'faulthandler']
21	n/a	if not env_vars:
22	n/a	cmd_line.append('-E')
23	n/a	# Need to preserve the original environment, for in-place testing of
24	n/a	# shared library builds.
25	n/a	env = os.environ.copy()
26	n/a	# But a special flag that can be set to override -- in this case, the
27	n/a	# caller is responsible to pass the full environment.
28	n/a	if env_vars.pop('__cleanenv', None):
29	n/a	env = {}
30	n/a	env.update(env_vars)
31	n/a	cmd_line.extend(args)
32	n/a	p = subprocess.Popen(cmd_line, stdin=subprocess.PIPE,
33	n/a	stdout=subprocess.PIPE, stderr=subprocess.PIPE,
34	n/a	env=env)
35	n/a	try:
36	n/a	out, err = p.communicate()
37	n/a	finally:
38	n/a	subprocess._cleanup()
39	n/a	p.stdout.close()
40	n/a	p.stderr.close()
41	n/a	rc = p.returncode
42	n/a	err = strip_python_stderr(err)
43	n/a	if (rc and expected_success) or (not rc and not expected_success):
44	n/a	raise AssertionError(
45	n/a	"Process return code is %d, "
46	n/a	"stderr follows:\n%s" % (rc, err.decode('ascii', 'ignore')))
47	n/a	return rc, out, err
48	n/a
49	n/a	def assert_python_ok(args, *env_vars):
50	n/a	"""
51	n/a	Assert that running the interpreter with `args` and optional environment
52	n/a	variables `env_vars` succeeds (rc == 0) and return a (return code, stdout,
53	n/a	stderr) tuple.
54	n/a	"""
55	n/a	return _assert_python(True, args, *env_vars)
56	n/a
57	n/a	def assert_python_failure(args, *env_vars):
58	n/a	"""
59	n/a	Assert that running the interpreter with `args` and optional environment
60	n/a	variables `env_vars` fails (rc != 0) and return a (return code, stdout,
61	n/a	stderr) tuple.
62	n/a	"""
63	n/a	return _assert_python(False, args, *env_vars)
64	n/a
65	n/a	def spawn_python(args, *kw):
66	n/a	"""Run a Python subprocess with the given arguments.
67	n/a
68	n/a	kw is extra keyword args to pass to subprocess.Popen. Returns a Popen
69	n/a	object.
70	n/a	"""
71	n/a	cmd_line = [sys.executable, '-E']
72	n/a	cmd_line.extend(args)
73	n/a	return subprocess.Popen(cmd_line, stdin=subprocess.PIPE,
74	n/a	stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
75	n/a	**kw)
76	n/a
77	n/a	def kill_python(p):
78	n/a	"""Run the given Popen process until completion and return stdout."""
79	n/a	p.stdin.close()
80	n/a	data = p.stdout.read()
81	n/a	p.stdout.close()
82	n/a	# try to cleanup the child so we don't appear to leak when running
83	n/a	# with regrtest -R.
84	n/a	p.wait()
85	n/a	subprocess._cleanup()
86	n/a	return data
87	n/a
88	n/a	def make_script(script_dir, script_basename, source):
89	n/a	script_filename = script_basename+os.extsep+'py'
90	n/a	script_name = os.path.join(script_dir, script_filename)
91	n/a	# The script should be encoded to UTF-8, the default string encoding
92	n/a	script_file = open(script_name, 'w', encoding='utf-8')
93	n/a	script_file.write(source)
94	n/a	script_file.close()
95	n/a	importlib.invalidate_caches()
96	n/a	return script_name
97	n/a
98	n/a	def make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None):
99	n/a	zip_filename = zip_basename+os.extsep+'zip'
100	n/a	zip_name = os.path.join(zip_dir, zip_filename)
101	n/a	zip_file = zipfile.ZipFile(zip_name, 'w')
102	n/a	if name_in_zip is None:
103	n/a	parts = script_name.split(os.sep)
104	n/a	if len(parts) >= 2 and parts[-2] == '__pycache__':
105	n/a	legacy_pyc = make_legacy_pyc(source_from_cache(script_name))
106	n/a	name_in_zip = os.path.basename(legacy_pyc)
107	n/a	script_name = legacy_pyc
108	n/a	else:
109	n/a	name_in_zip = os.path.basename(script_name)
110	n/a	zip_file.write(script_name, name_in_zip)
111	n/a	zip_file.close()
112	n/a	#if test.support.verbose:
113	n/a	# zip_file = zipfile.ZipFile(zip_name, 'r')
114	n/a	# print 'Contents of %r:' % zip_name
115	n/a	# zip_file.printdir()
116	n/a	# zip_file.close()
117	n/a	return zip_name, os.path.join(zip_name, name_in_zip)
118	n/a
119	n/a	def make_pkg(pkg_dir, init_source=''):
120	n/a	os.mkdir(pkg_dir)
121	n/a	make_script(pkg_dir, '__init__', init_source)
122	n/a
123	n/a	def make_zip_pkg(zip_dir, zip_basename, pkg_name, script_basename,
124	n/a	source, depth=1, compiled=False):
125	n/a	unlink = []
126	n/a	init_name = make_script(zip_dir, '__init__', '')
127	n/a	unlink.append(init_name)
128	n/a	init_basename = os.path.basename(init_name)
129	n/a	script_name = make_script(zip_dir, script_basename, source)
130	n/a	unlink.append(script_name)
131	n/a	if compiled:
132	n/a	init_name = py_compile(init_name, doraise=True)
133	n/a	script_name = py_compile(script_name, doraise=True)
134	n/a	unlink.extend((init_name, script_name))
135	n/a	pkg_names = [os.sep.join([pkg_name]*i) for i in range(1, depth+1)]
136	n/a	script_name_in_zip = os.path.join(pkg_names[-1], os.path.basename(script_name))
137	n/a	zip_filename = zip_basename+os.extsep+'zip'
138	n/a	zip_name = os.path.join(zip_dir, zip_filename)
139	n/a	zip_file = zipfile.ZipFile(zip_name, 'w')
140	n/a	for name in pkg_names:
141	n/a	init_name_in_zip = os.path.join(name, init_basename)
142	n/a	zip_file.write(init_name, init_name_in_zip)
143	n/a	zip_file.write(script_name, script_name_in_zip)
144	n/a	zip_file.close()
145	n/a	for name in unlink:
146	n/a	os.unlink(name)
147	n/a	#if test.support.verbose:
148	n/a	# zip_file = zipfile.ZipFile(zip_name, 'r')
149	n/a	# print 'Contents of %r:' % zip_name
150	n/a	# zip_file.printdir()
151	n/a	# zip_file.close()
152	n/a	return zip_name, os.path.join(zip_name, script_name_in_zip)