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