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