Vinay Sajip | 4221142 | 2012-05-26 20:36:12 +0100 | [diff] [blame] | 1 | """ |
| 2 | Test harness for the venv module. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 3 | |
Vinay Sajip | 4221142 | 2012-05-26 20:36:12 +0100 | [diff] [blame] | 4 | Copyright (C) 2011-2012 Vinay Sajip. |
Vinay Sajip | 2895244 | 2012-06-25 00:47:46 +0100 | [diff] [blame] | 5 | Licensed to the PSF under a contributor agreement. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 6 | """ |
| 7 | |
Nick Coghlan | 1b1b178 | 2013-11-30 15:56:58 +1000 | [diff] [blame] | 8 | import ensurepip |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 9 | import os |
| 10 | import os.path |
Victor Stinner | 87d6e13 | 2016-03-14 18:21:58 +0100 | [diff] [blame] | 11 | import re |
Miss Islington (bot) | 63eefc3 | 2019-09-11 08:55:57 -0700 | [diff] [blame] | 12 | import shutil |
Vinay Sajip | 1e53f8d | 2014-04-15 11:18:10 +0100 | [diff] [blame] | 13 | import struct |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 14 | import subprocess |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 15 | import sys |
| 16 | import tempfile |
Serhiy Storchaka | 5e0df74 | 2017-11-10 12:09:39 +0200 | [diff] [blame] | 17 | from test.support import (captured_stdout, captured_stderr, requires_zlib, |
xdegaye | 5437ccc | 2019-05-30 23:42:29 +0200 | [diff] [blame] | 18 | can_symlink, EnvironmentVarGuard, rmtree, |
| 19 | import_module) |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 20 | import threading |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 21 | import unittest |
| 22 | import venv |
Nick Coghlan | ae2ee96 | 2013-12-23 23:07:07 +1000 | [diff] [blame] | 23 | |
Victor Stinner | b347788 | 2016-03-25 12:27:02 +0100 | [diff] [blame] | 24 | try: |
| 25 | import ctypes |
| 26 | except ImportError: |
| 27 | ctypes = None |
| 28 | |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 29 | # Platforms that set sys._base_executable can create venvs from within |
| 30 | # another venv, so no need to skip tests that require venv.create(). |
| 31 | requireVenvCreate = unittest.skipUnless( |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 32 | sys.prefix == sys.base_prefix |
| 33 | or sys._base_executable != sys.executable, |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 34 | 'cannot run venv.create from within a venv on this platform') |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 35 | |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 36 | def check_output(cmd, encoding=None): |
| 37 | p = subprocess.Popen(cmd, |
| 38 | stdout=subprocess.PIPE, |
| 39 | stderr=subprocess.PIPE, |
| 40 | encoding=encoding) |
| 41 | out, err = p.communicate() |
| 42 | if p.returncode: |
| 43 | raise subprocess.CalledProcessError( |
Pablo Galindo | b939250 | 2018-11-07 22:21:17 +0000 | [diff] [blame] | 44 | p.returncode, cmd, out, err) |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 45 | return out, err |
| 46 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 47 | class BaseTest(unittest.TestCase): |
| 48 | """Base class for venv tests.""" |
Victor Stinner | bdc337b | 2016-03-25 12:30:40 +0100 | [diff] [blame] | 49 | maxDiff = 80 * 50 |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 50 | |
| 51 | def setUp(self): |
Ned Deily | 045bd53 | 2012-07-13 15:48:04 -0700 | [diff] [blame] | 52 | self.env_dir = os.path.realpath(tempfile.mkdtemp()) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 53 | if os.name == 'nt': |
| 54 | self.bindir = 'Scripts' |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 55 | self.lib = ('Lib',) |
| 56 | self.include = 'Include' |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 57 | else: |
| 58 | self.bindir = 'bin' |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 59 | self.lib = ('lib', 'python%d.%d' % sys.version_info[:2]) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 60 | self.include = 'include' |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 61 | executable = sys._base_executable |
Vinay Sajip | 382a7c0 | 2012-05-28 16:34:47 +0100 | [diff] [blame] | 62 | self.exe = os.path.split(executable)[-1] |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 63 | if (sys.platform == 'win32' |
| 64 | and os.path.lexists(executable) |
| 65 | and not os.path.exists(executable)): |
| 66 | self.cannot_link_exe = True |
| 67 | else: |
| 68 | self.cannot_link_exe = False |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 69 | |
| 70 | def tearDown(self): |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 71 | rmtree(self.env_dir) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 72 | |
| 73 | def run_with_capture(self, func, *args, **kwargs): |
| 74 | with captured_stdout() as output: |
| 75 | with captured_stderr() as error: |
| 76 | func(*args, **kwargs) |
| 77 | return output.getvalue(), error.getvalue() |
| 78 | |
| 79 | def get_env_file(self, *args): |
| 80 | return os.path.join(self.env_dir, *args) |
| 81 | |
| 82 | def get_text_file_contents(self, *args): |
| 83 | with open(self.get_env_file(*args), 'r') as f: |
| 84 | result = f.read() |
| 85 | return result |
| 86 | |
| 87 | class BasicTest(BaseTest): |
| 88 | """Test venv module functionality.""" |
| 89 | |
Vinay Sajip | b3b49cd | 2012-05-27 18:39:22 +0100 | [diff] [blame] | 90 | def isdir(self, *args): |
| 91 | fn = self.get_env_file(*args) |
| 92 | self.assertTrue(os.path.isdir(fn)) |
| 93 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 94 | def test_defaults(self): |
| 95 | """ |
| 96 | Test the create function with default arguments. |
| 97 | """ |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 98 | rmtree(self.env_dir) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 99 | self.run_with_capture(venv.create, self.env_dir) |
Vinay Sajip | b3b49cd | 2012-05-27 18:39:22 +0100 | [diff] [blame] | 100 | self.isdir(self.bindir) |
| 101 | self.isdir(self.include) |
| 102 | self.isdir(*self.lib) |
Vinay Sajip | 1e53f8d | 2014-04-15 11:18:10 +0100 | [diff] [blame] | 103 | # Issue 21197 |
| 104 | p = self.get_env_file('lib64') |
| 105 | conditions = ((struct.calcsize('P') == 8) and (os.name == 'posix') and |
| 106 | (sys.platform != 'darwin')) |
| 107 | if conditions: |
| 108 | self.assertTrue(os.path.islink(p)) |
| 109 | else: |
| 110 | self.assertFalse(os.path.exists(p)) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 111 | data = self.get_text_file_contents('pyvenv.cfg') |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 112 | executable = sys._base_executable |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 113 | path = os.path.dirname(executable) |
| 114 | self.assertIn('home = %s' % path, data) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 115 | fn = self.get_env_file(self.bindir, self.exe) |
Vinay Sajip | 7e20349 | 2012-05-27 17:30:09 +0100 | [diff] [blame] | 116 | if not os.path.exists(fn): # diagnostics for Windows buildbot failures |
Vinay Sajip | b3b49cd | 2012-05-27 18:39:22 +0100 | [diff] [blame] | 117 | bd = self.get_env_file(self.bindir) |
| 118 | print('Contents of %r:' % bd) |
| 119 | print(' %r' % os.listdir(bd)) |
Vinay Sajip | 7e20349 | 2012-05-27 17:30:09 +0100 | [diff] [blame] | 120 | self.assertTrue(os.path.exists(fn), 'File %r should exist.' % fn) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 121 | |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 122 | def test_prompt(self): |
| 123 | env_name = os.path.split(self.env_dir)[1] |
| 124 | |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 125 | rmtree(self.env_dir) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 126 | builder = venv.EnvBuilder() |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 127 | self.run_with_capture(builder.create, self.env_dir) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 128 | context = builder.ensure_directories(self.env_dir) |
Cheryl Sabella | d5a70c6 | 2019-03-08 17:01:27 -0500 | [diff] [blame] | 129 | data = self.get_text_file_contents('pyvenv.cfg') |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 130 | self.assertEqual(context.prompt, '(%s) ' % env_name) |
Cheryl Sabella | d5a70c6 | 2019-03-08 17:01:27 -0500 | [diff] [blame] | 131 | self.assertNotIn("prompt = ", data) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 132 | |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 133 | rmtree(self.env_dir) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 134 | builder = venv.EnvBuilder(prompt='My prompt') |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 135 | self.run_with_capture(builder.create, self.env_dir) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 136 | context = builder.ensure_directories(self.env_dir) |
Cheryl Sabella | d5a70c6 | 2019-03-08 17:01:27 -0500 | [diff] [blame] | 137 | data = self.get_text_file_contents('pyvenv.cfg') |
Cheryl Sabella | 839b925 | 2019-03-12 20:15:47 -0400 | [diff] [blame] | 138 | self.assertEqual(context.prompt, '(My prompt) ') |
Cheryl Sabella | d5a70c6 | 2019-03-08 17:01:27 -0500 | [diff] [blame] | 139 | self.assertIn("prompt = 'My prompt'\n", data) |
Vinay Sajip | fd0f84b | 2016-08-06 10:43:44 +0100 | [diff] [blame] | 140 | |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 141 | @requireVenvCreate |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 142 | def test_prefixes(self): |
| 143 | """ |
| 144 | Test that the prefix values are as expected. |
| 145 | """ |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 146 | # check a venv's prefixes |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 147 | rmtree(self.env_dir) |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 148 | self.run_with_capture(venv.create, self.env_dir) |
| 149 | envpy = os.path.join(self.env_dir, self.bindir, self.exe) |
| 150 | cmd = [envpy, '-c', None] |
| 151 | for prefix, expected in ( |
| 152 | ('prefix', self.env_dir), |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 153 | ('exec_prefix', self.env_dir), |
| 154 | ('base_prefix', sys.base_prefix), |
| 155 | ('base_exec_prefix', sys.base_exec_prefix)): |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 156 | cmd[2] = 'import sys; print(sys.%s)' % prefix |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 157 | out, err = check_output(cmd) |
Antoine Pitrou | 9c92a69 | 2012-08-05 00:33:10 +0200 | [diff] [blame] | 158 | self.assertEqual(out.strip(), expected.encode()) |
Vinay Sajip | 3874e54 | 2012-07-03 16:56:40 +0100 | [diff] [blame] | 159 | |
Vinay Sajip | bd40d3e | 2012-10-11 17:22:45 +0100 | [diff] [blame] | 160 | if sys.platform == 'win32': |
| 161 | ENV_SUBDIRS = ( |
| 162 | ('Scripts',), |
| 163 | ('Include',), |
| 164 | ('Lib',), |
| 165 | ('Lib', 'site-packages'), |
| 166 | ) |
| 167 | else: |
| 168 | ENV_SUBDIRS = ( |
| 169 | ('bin',), |
| 170 | ('include',), |
| 171 | ('lib',), |
| 172 | ('lib', 'python%d.%d' % sys.version_info[:2]), |
| 173 | ('lib', 'python%d.%d' % sys.version_info[:2], 'site-packages'), |
| 174 | ) |
| 175 | |
| 176 | def create_contents(self, paths, filename): |
| 177 | """ |
| 178 | Create some files in the environment which are unrelated |
| 179 | to the virtual environment. |
| 180 | """ |
| 181 | for subdirs in paths: |
| 182 | d = os.path.join(self.env_dir, *subdirs) |
| 183 | os.mkdir(d) |
| 184 | fn = os.path.join(d, filename) |
| 185 | with open(fn, 'wb') as f: |
| 186 | f.write(b'Still here?') |
| 187 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 188 | def test_overwrite_existing(self): |
| 189 | """ |
Vinay Sajip | bd40d3e | 2012-10-11 17:22:45 +0100 | [diff] [blame] | 190 | Test creating environment in an existing directory. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 191 | """ |
Vinay Sajip | bd40d3e | 2012-10-11 17:22:45 +0100 | [diff] [blame] | 192 | self.create_contents(self.ENV_SUBDIRS, 'foo') |
| 193 | venv.create(self.env_dir) |
| 194 | for subdirs in self.ENV_SUBDIRS: |
| 195 | fn = os.path.join(self.env_dir, *(subdirs + ('foo',))) |
| 196 | self.assertTrue(os.path.exists(fn)) |
| 197 | with open(fn, 'rb') as f: |
| 198 | self.assertEqual(f.read(), b'Still here?') |
| 199 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 200 | builder = venv.EnvBuilder(clear=True) |
| 201 | builder.create(self.env_dir) |
Vinay Sajip | bd40d3e | 2012-10-11 17:22:45 +0100 | [diff] [blame] | 202 | for subdirs in self.ENV_SUBDIRS: |
| 203 | fn = os.path.join(self.env_dir, *(subdirs + ('foo',))) |
| 204 | self.assertFalse(os.path.exists(fn)) |
| 205 | |
| 206 | def clear_directory(self, path): |
| 207 | for fn in os.listdir(path): |
| 208 | fn = os.path.join(path, fn) |
| 209 | if os.path.islink(fn) or os.path.isfile(fn): |
| 210 | os.remove(fn) |
| 211 | elif os.path.isdir(fn): |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 212 | rmtree(fn) |
Vinay Sajip | bd40d3e | 2012-10-11 17:22:45 +0100 | [diff] [blame] | 213 | |
| 214 | def test_unoverwritable_fails(self): |
| 215 | #create a file clashing with directories in the env dir |
| 216 | for paths in self.ENV_SUBDIRS[:3]: |
| 217 | fn = os.path.join(self.env_dir, *paths) |
| 218 | with open(fn, 'wb') as f: |
| 219 | f.write(b'') |
| 220 | self.assertRaises((ValueError, OSError), venv.create, self.env_dir) |
| 221 | self.clear_directory(self.env_dir) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 222 | |
Vinay Sajip | b3b49cd | 2012-05-27 18:39:22 +0100 | [diff] [blame] | 223 | def test_upgrade(self): |
| 224 | """ |
| 225 | Test upgrading an existing environment directory. |
| 226 | """ |
Vinay Sajip | b9b965f | 2014-06-03 16:47:51 +0100 | [diff] [blame] | 227 | # See Issue #21643: the loop needs to run twice to ensure |
| 228 | # that everything works on the upgrade (the first run just creates |
| 229 | # the venv). |
| 230 | for upgrade in (False, True): |
| 231 | builder = venv.EnvBuilder(upgrade=upgrade) |
| 232 | self.run_with_capture(builder.create, self.env_dir) |
| 233 | self.isdir(self.bindir) |
| 234 | self.isdir(self.include) |
| 235 | self.isdir(*self.lib) |
| 236 | fn = self.get_env_file(self.bindir, self.exe) |
| 237 | if not os.path.exists(fn): |
| 238 | # diagnostics for Windows buildbot failures |
| 239 | bd = self.get_env_file(self.bindir) |
| 240 | print('Contents of %r:' % bd) |
| 241 | print(' %r' % os.listdir(bd)) |
| 242 | self.assertTrue(os.path.exists(fn), 'File %r should exist.' % fn) |
Vinay Sajip | b3b49cd | 2012-05-27 18:39:22 +0100 | [diff] [blame] | 243 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 244 | def test_isolation(self): |
| 245 | """ |
| 246 | Test isolation from system site-packages |
| 247 | """ |
| 248 | for ssp, s in ((True, 'true'), (False, 'false')): |
| 249 | builder = venv.EnvBuilder(clear=True, system_site_packages=ssp) |
| 250 | builder.create(self.env_dir) |
| 251 | data = self.get_text_file_contents('pyvenv.cfg') |
| 252 | self.assertIn('include-system-site-packages = %s\n' % s, data) |
| 253 | |
| 254 | @unittest.skipUnless(can_symlink(), 'Needs symlinks') |
| 255 | def test_symlinking(self): |
| 256 | """ |
| 257 | Test symlinking works as expected |
| 258 | """ |
| 259 | for usl in (False, True): |
| 260 | builder = venv.EnvBuilder(clear=True, symlinks=usl) |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 261 | builder.create(self.env_dir) |
| 262 | fn = self.get_env_file(self.bindir, self.exe) |
| 263 | # Don't test when False, because e.g. 'python' is always |
| 264 | # symlinked to 'python3.3' in the env, even when symlinking in |
| 265 | # general isn't wanted. |
| 266 | if usl: |
Steve Dower | 323e743 | 2019-06-29 14:28:59 -0700 | [diff] [blame] | 267 | if self.cannot_link_exe: |
| 268 | # Symlinking is skipped when our executable is already a |
| 269 | # special app symlink |
| 270 | self.assertFalse(os.path.islink(fn)) |
| 271 | else: |
| 272 | self.assertTrue(os.path.islink(fn)) |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 273 | |
| 274 | # If a venv is created from a source build and that venv is used to |
| 275 | # run the test, the pyvenv.cfg in the venv created in the test will |
| 276 | # point to the venv being used to run the test, and we lose the link |
| 277 | # to the source build - so Python can't initialise properly. |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 278 | @requireVenvCreate |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 279 | def test_executable(self): |
| 280 | """ |
| 281 | Test that the sys.executable value is as expected. |
| 282 | """ |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 283 | rmtree(self.env_dir) |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 284 | self.run_with_capture(venv.create, self.env_dir) |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 285 | envpy = os.path.join(os.path.realpath(self.env_dir), |
| 286 | self.bindir, self.exe) |
| 287 | out, err = check_output([envpy, '-c', |
| 288 | 'import sys; print(sys.executable)']) |
Antoine Pitrou | 9c92a69 | 2012-08-05 00:33:10 +0200 | [diff] [blame] | 289 | self.assertEqual(out.strip(), envpy.encode()) |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 290 | |
| 291 | @unittest.skipUnless(can_symlink(), 'Needs symlinks') |
| 292 | def test_executable_symlinks(self): |
| 293 | """ |
| 294 | Test that the sys.executable value is as expected. |
| 295 | """ |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 296 | rmtree(self.env_dir) |
Vinay Sajip | 90db661 | 2012-07-17 17:33:46 +0100 | [diff] [blame] | 297 | builder = venv.EnvBuilder(clear=True, symlinks=True) |
| 298 | builder.create(self.env_dir) |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 299 | envpy = os.path.join(os.path.realpath(self.env_dir), |
| 300 | self.bindir, self.exe) |
| 301 | out, err = check_output([envpy, '-c', |
| 302 | 'import sys; print(sys.executable)']) |
Antoine Pitrou | 9c92a69 | 2012-08-05 00:33:10 +0200 | [diff] [blame] | 303 | self.assertEqual(out.strip(), envpy.encode()) |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 304 | |
Steve Dower | 6240917 | 2018-02-19 17:25:24 -0800 | [diff] [blame] | 305 | @unittest.skipUnless(os.name == 'nt', 'only relevant on Windows') |
| 306 | def test_unicode_in_batch_file(self): |
| 307 | """ |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 308 | Test handling of Unicode paths |
Steve Dower | 6240917 | 2018-02-19 17:25:24 -0800 | [diff] [blame] | 309 | """ |
| 310 | rmtree(self.env_dir) |
| 311 | env_dir = os.path.join(os.path.realpath(self.env_dir), 'ϼўТλФЙ') |
| 312 | builder = venv.EnvBuilder(clear=True) |
| 313 | builder.create(env_dir) |
| 314 | activate = os.path.join(env_dir, self.bindir, 'activate.bat') |
| 315 | envpy = os.path.join(env_dir, self.bindir, self.exe) |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 316 | out, err = check_output( |
| 317 | [activate, '&', self.exe, '-c', 'print(0)'], |
| 318 | encoding='oem', |
| 319 | ) |
Steve Dower | 6240917 | 2018-02-19 17:25:24 -0800 | [diff] [blame] | 320 | self.assertEqual(out.strip(), '0') |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 321 | |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 322 | @requireVenvCreate |
Steve Dower | 4e02f8f8 | 2019-01-25 14:59:12 -0800 | [diff] [blame] | 323 | def test_multiprocessing(self): |
| 324 | """ |
| 325 | Test that the multiprocessing is able to spawn. |
| 326 | """ |
xdegaye | 5437ccc | 2019-05-30 23:42:29 +0200 | [diff] [blame] | 327 | # Issue bpo-36342: Instanciation of a Pool object imports the |
| 328 | # multiprocessing.synchronize module. Skip the test if this module |
| 329 | # cannot be imported. |
| 330 | import_module('multiprocessing.synchronize') |
Steve Dower | 4e02f8f8 | 2019-01-25 14:59:12 -0800 | [diff] [blame] | 331 | rmtree(self.env_dir) |
| 332 | self.run_with_capture(venv.create, self.env_dir) |
| 333 | envpy = os.path.join(os.path.realpath(self.env_dir), |
| 334 | self.bindir, self.exe) |
| 335 | out, err = check_output([envpy, '-c', |
Victor Stinner | bc6469f | 2019-06-04 19:03:13 +0200 | [diff] [blame] | 336 | 'from multiprocessing import Pool; ' |
| 337 | 'pool = Pool(1); ' |
| 338 | 'print(pool.apply_async("Python".lower).get(3)); ' |
| 339 | 'pool.terminate()']) |
Steve Dower | 4e02f8f8 | 2019-01-25 14:59:12 -0800 | [diff] [blame] | 340 | self.assertEqual(out.strip(), "python".encode()) |
| 341 | |
Miss Islington (bot) | 63eefc3 | 2019-09-11 08:55:57 -0700 | [diff] [blame] | 342 | @unittest.skipIf(os.name == 'nt', 'not relevant on Windows') |
| 343 | def test_deactivate_with_strict_bash_opts(self): |
| 344 | bash = shutil.which("bash") |
| 345 | if bash is None: |
| 346 | self.skipTest("bash required for this test") |
| 347 | rmtree(self.env_dir) |
| 348 | builder = venv.EnvBuilder(clear=True) |
| 349 | builder.create(self.env_dir) |
| 350 | activate = os.path.join(self.env_dir, self.bindir, "activate") |
| 351 | test_script = os.path.join(self.env_dir, "test_strict.sh") |
| 352 | with open(test_script, "w") as f: |
| 353 | f.write("set -euo pipefail\n" |
| 354 | f"source {activate}\n" |
| 355 | "deactivate\n") |
| 356 | out, err = check_output([bash, test_script]) |
| 357 | self.assertEqual(out, "".encode()) |
| 358 | self.assertEqual(err, "".encode()) |
| 359 | |
| 360 | |
Steve Dower | 8bba81f | 2019-03-21 10:04:21 -0700 | [diff] [blame] | 361 | @requireVenvCreate |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 362 | class EnsurePipTest(BaseTest): |
| 363 | """Test venv module installation of pip.""" |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 364 | def assert_pip_not_installed(self): |
| 365 | envpy = os.path.join(os.path.realpath(self.env_dir), |
| 366 | self.bindir, self.exe) |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 367 | out, err = check_output([envpy, '-c', |
| 368 | 'try:\n import pip\nexcept ImportError:\n print("OK")']) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 369 | # We force everything to text, so unittest gives the detailed diff |
| 370 | # if we get unexpected results |
| 371 | err = err.decode("latin-1") # Force to text, prevent decoding errors |
| 372 | self.assertEqual(err, "") |
| 373 | out = out.decode("latin-1") # Force to text, prevent decoding errors |
| 374 | self.assertEqual(out.strip(), "OK") |
| 375 | |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 376 | |
| 377 | def test_no_pip_by_default(self): |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 378 | rmtree(self.env_dir) |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 379 | self.run_with_capture(venv.create, self.env_dir) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 380 | self.assert_pip_not_installed() |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 381 | |
| 382 | def test_explicit_no_pip(self): |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 383 | rmtree(self.env_dir) |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 384 | self.run_with_capture(venv.create, self.env_dir, with_pip=False) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 385 | self.assert_pip_not_installed() |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 386 | |
Victor Stinner | bdc337b | 2016-03-25 12:30:40 +0100 | [diff] [blame] | 387 | def test_devnull(self): |
Nick Coghlan | 456ab5d | 2014-02-05 23:54:55 +1000 | [diff] [blame] | 388 | # Fix for issue #20053 uses os.devnull to force a config file to |
Nick Coghlan | 11c5afd | 2014-02-07 23:46:38 +1000 | [diff] [blame] | 389 | # appear empty. However http://bugs.python.org/issue20541 means |
| 390 | # that doesn't currently work properly on Windows. Once that is |
| 391 | # fixed, the "win_location" part of test_with_pip should be restored |
Nick Coghlan | 456ab5d | 2014-02-05 23:54:55 +1000 | [diff] [blame] | 392 | with open(os.devnull, "rb") as f: |
| 393 | self.assertEqual(f.read(), b"") |
| 394 | |
Steve Dower | 9eb3d54 | 2019-08-21 15:52:42 -0700 | [diff] [blame] | 395 | self.assertTrue(os.path.exists(os.devnull)) |
Victor Stinner | bdc337b | 2016-03-25 12:30:40 +0100 | [diff] [blame] | 396 | |
Vinay Sajip | db6322c | 2017-02-02 19:05:19 +0000 | [diff] [blame] | 397 | def do_test_with_pip(self, system_site_packages): |
Victor Stinner | 866c4e2 | 2014-10-10 14:23:00 +0200 | [diff] [blame] | 398 | rmtree(self.env_dir) |
Nick Coghlan | d76cdc1 | 2013-11-23 11:37:28 +1000 | [diff] [blame] | 399 | with EnvironmentVarGuard() as envvars: |
| 400 | # pip's cross-version compatibility may trigger deprecation |
| 401 | # warnings in current versions of Python. Ensure related |
| 402 | # environment settings don't cause venv to fail. |
| 403 | envvars["PYTHONWARNINGS"] = "e" |
Nick Coghlan | 6256fcb | 2013-12-23 16:16:07 +1000 | [diff] [blame] | 404 | # ensurepip is different enough from a normal pip invocation |
| 405 | # that we want to ensure it ignores the normal pip environment |
| 406 | # variable settings. We set PIP_NO_INSTALL here specifically |
| 407 | # to check that ensurepip (and hence venv) ignores it. |
Nick Coghlan | 6edd82a | 2014-02-04 23:02:36 +1000 | [diff] [blame] | 408 | # See http://bugs.python.org/issue19734 |
Nick Coghlan | 6256fcb | 2013-12-23 16:16:07 +1000 | [diff] [blame] | 409 | envvars["PIP_NO_INSTALL"] = "1" |
Nick Coghlan | 6edd82a | 2014-02-04 23:02:36 +1000 | [diff] [blame] | 410 | # Also check that we ignore the pip configuration file |
| 411 | # See http://bugs.python.org/issue20053 |
| 412 | with tempfile.TemporaryDirectory() as home_dir: |
| 413 | envvars["HOME"] = home_dir |
| 414 | bad_config = "[global]\nno-install=1" |
| 415 | # Write to both config file names on all platforms to reduce |
| 416 | # cross-platform variation in test code behaviour |
| 417 | win_location = ("pip", "pip.ini") |
| 418 | posix_location = (".pip", "pip.conf") |
Nick Coghlan | 11c5afd | 2014-02-07 23:46:38 +1000 | [diff] [blame] | 419 | # Skips win_location due to http://bugs.python.org/issue20541 |
| 420 | for dirname, fname in (posix_location,): |
Nick Coghlan | 6edd82a | 2014-02-04 23:02:36 +1000 | [diff] [blame] | 421 | dirpath = os.path.join(home_dir, dirname) |
| 422 | os.mkdir(dirpath) |
| 423 | fpath = os.path.join(dirpath, fname) |
| 424 | with open(fpath, 'w') as f: |
| 425 | f.write(bad_config) |
| 426 | |
| 427 | # Actually run the create command with all that unhelpful |
| 428 | # config in place to ensure we ignore it |
| 429 | try: |
| 430 | self.run_with_capture(venv.create, self.env_dir, |
Vinay Sajip | db6322c | 2017-02-02 19:05:19 +0000 | [diff] [blame] | 431 | system_site_packages=system_site_packages, |
Nick Coghlan | 6edd82a | 2014-02-04 23:02:36 +1000 | [diff] [blame] | 432 | with_pip=True) |
| 433 | except subprocess.CalledProcessError as exc: |
| 434 | # The output this produces can be a little hard to read, |
| 435 | # but at least it has all the details |
| 436 | details = exc.output.decode(errors="replace") |
| 437 | msg = "{}\n\n**Subprocess Output**\n{}" |
| 438 | self.fail(msg.format(exc, details)) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 439 | # Ensure pip is available in the virtual environment |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 440 | envpy = os.path.join(os.path.realpath(self.env_dir), self.bindir, self.exe) |
Victor Stinner | 895862a | 2017-11-20 09:47:03 -0800 | [diff] [blame] | 441 | # Ignore DeprecationWarning since pip code is not part of Python |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 442 | out, err = check_output([envpy, '-W', 'ignore::DeprecationWarning', '-I', |
| 443 | '-m', 'pip', '--version']) |
Nick Coghlan | 6fd12f2 | 2013-11-24 11:36:31 +1000 | [diff] [blame] | 444 | # We force everything to text, so unittest gives the detailed diff |
| 445 | # if we get unexpected results |
| 446 | err = err.decode("latin-1") # Force to text, prevent decoding errors |
| 447 | self.assertEqual(err, "") |
| 448 | out = out.decode("latin-1") # Force to text, prevent decoding errors |
Nick Coghlan | 1b1b178 | 2013-11-30 15:56:58 +1000 | [diff] [blame] | 449 | expected_version = "pip {}".format(ensurepip.version()) |
| 450 | self.assertEqual(out[:len(expected_version)], expected_version) |
Nick Coghlan | 6fd12f2 | 2013-11-24 11:36:31 +1000 | [diff] [blame] | 451 | env_dir = os.fsencode(self.env_dir).decode("latin-1") |
Nick Coghlan | 6fd12f2 | 2013-11-24 11:36:31 +1000 | [diff] [blame] | 452 | self.assertIn(env_dir, out) |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 453 | |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 454 | # http://bugs.python.org/issue19728 |
| 455 | # Check the private uninstall command provided for the Windows |
| 456 | # installers works (at least in a virtual environment) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 457 | with EnvironmentVarGuard() as envvars: |
Steve Dower | f14c28f | 2018-09-20 13:38:34 -0700 | [diff] [blame] | 458 | out, err = check_output([envpy, |
| 459 | '-W', 'ignore::DeprecationWarning', '-I', |
| 460 | '-m', 'ensurepip._uninstall']) |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 461 | # We force everything to text, so unittest gives the detailed diff |
| 462 | # if we get unexpected results |
| 463 | err = err.decode("latin-1") # Force to text, prevent decoding errors |
Victor Stinner | 87d6e13 | 2016-03-14 18:21:58 +0100 | [diff] [blame] | 464 | # Ignore the warning: |
| 465 | # "The directory '$HOME/.cache/pip/http' or its parent directory |
| 466 | # is not owned by the current user and the cache has been disabled. |
| 467 | # Please check the permissions and owner of that directory. If |
| 468 | # executing pip with sudo, you may want sudo's -H flag." |
| 469 | # where $HOME is replaced by the HOME environment variable. |
Miss Islington (bot) | c503390 | 2019-07-26 09:24:43 -0700 | [diff] [blame] | 470 | err = re.sub("^(WARNING: )?The directory .* or its parent directory " |
| 471 | "is not owned by the current user .*$", "", |
| 472 | err, flags=re.MULTILINE) |
Victor Stinner | 87d6e13 | 2016-03-14 18:21:58 +0100 | [diff] [blame] | 473 | self.assertEqual(err.rstrip(), "") |
Nick Coghlan | 8ddd59e | 2013-11-30 18:35:32 +1000 | [diff] [blame] | 474 | # Being fairly specific regarding the expected behaviour for the |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 475 | # initial bundling phase in Python 3.4. If the output changes in |
Nick Coghlan | 8ddd59e | 2013-11-30 18:35:32 +1000 | [diff] [blame] | 476 | # future pip versions, this test can likely be relaxed further. |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 477 | out = out.decode("latin-1") # Force to text, prevent decoding errors |
Nick Coghlan | 8ddd59e | 2013-11-30 18:35:32 +1000 | [diff] [blame] | 478 | self.assertIn("Successfully uninstalled pip", out) |
| 479 | self.assertIn("Successfully uninstalled setuptools", out) |
Vinay Sajip | db6322c | 2017-02-02 19:05:19 +0000 | [diff] [blame] | 480 | # Check pip is now gone from the virtual environment. This only |
| 481 | # applies in the system_site_packages=False case, because in the |
| 482 | # other case, pip may still be available in the system site-packages |
| 483 | if not system_site_packages: |
| 484 | self.assert_pip_not_installed() |
Nick Coghlan | fdf3a62 | 2013-11-30 17:15:09 +1000 | [diff] [blame] | 485 | |
Vinay Sajip | db6322c | 2017-02-02 19:05:19 +0000 | [diff] [blame] | 486 | # Issue #26610: pip/pep425tags.py requires ctypes |
| 487 | @unittest.skipUnless(ctypes, 'pip requires ctypes') |
Serhiy Storchaka | 5e0df74 | 2017-11-10 12:09:39 +0200 | [diff] [blame] | 488 | @requires_zlib |
Vinay Sajip | db6322c | 2017-02-02 19:05:19 +0000 | [diff] [blame] | 489 | def test_with_pip(self): |
| 490 | self.do_test_with_pip(False) |
| 491 | self.do_test_with_pip(True) |
Nick Coghlan | 8fbdb09 | 2013-11-23 00:30:34 +1000 | [diff] [blame] | 492 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 493 | if __name__ == "__main__": |
Zachary Ware | 38c707e | 2015-04-13 15:00:43 -0500 | [diff] [blame] | 494 | unittest.main() |