Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 1 | """Tests for 'site'. |
| 2 | |
| 3 | Tests assume the initial paths in sys.path once the interpreter has begun |
| 4 | executing have not been removed. |
| 5 | |
| 6 | """ |
| 7 | import unittest |
Senthil Kumaran | 8ef519b | 2013-09-07 13:59:17 -0700 | [diff] [blame] | 8 | import test.support |
Zachary Ware | 36193e7 | 2013-12-11 16:59:44 -0600 | [diff] [blame] | 9 | from test.support import captured_stderr, TESTFN, EnvironmentVarGuard |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 10 | import builtins |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 11 | import os |
| 12 | import sys |
R. David Murray | ab9d8d6 | 2010-12-27 00:03:13 +0000 | [diff] [blame] | 13 | import re |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 14 | import encodings |
R David Murray | 1bc6ceb | 2013-09-14 13:28:37 -0400 | [diff] [blame] | 15 | import urllib.request |
| 16 | import urllib.error |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 17 | import subprocess |
Tarek Ziadé | edacea3 | 2010-01-29 11:41:03 +0000 | [diff] [blame] | 18 | import sysconfig |
| 19 | from copy import copy |
| 20 | |
Zachary Ware | 36193e7 | 2013-12-11 16:59:44 -0600 | [diff] [blame] | 21 | # These tests are not particularly useful if Python was invoked with -S. |
| 22 | # If you add tests that are useful under -S, this skip should be moved |
| 23 | # to the class level. |
| 24 | if sys.flags.no_site: |
| 25 | raise unittest.SkipTest("Python was invoked with -S") |
| 26 | |
| 27 | import site |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 28 | |
Ned Deily | 316f573 | 2011-10-31 16:16:35 -0700 | [diff] [blame] | 29 | if site.ENABLE_USER_SITE and not os.path.isdir(site.USER_SITE): |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 30 | # need to add user site directory for tests |
Victor Stinner | 21d0e1b | 2016-03-14 17:47:03 +0100 | [diff] [blame] | 31 | try: |
| 32 | os.makedirs(site.USER_SITE) |
| 33 | site.addsitedir(site.USER_SITE) |
| 34 | except PermissionError as exc: |
| 35 | raise unittest.SkipTest('unable to create user site directory (%r): %s' |
| 36 | % (site.USER_SITE, exc)) |
| 37 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 38 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 39 | class HelperFunctionsTests(unittest.TestCase): |
| 40 | """Tests for helper functions. |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 41 | """ |
| 42 | |
| 43 | def setUp(self): |
| 44 | """Save a copy of sys.path""" |
| 45 | self.sys_path = sys.path[:] |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 46 | self.old_base = site.USER_BASE |
| 47 | self.old_site = site.USER_SITE |
| 48 | self.old_prefixes = site.PREFIXES |
Brett Cannon | 8ac95ee | 2012-04-04 17:31:16 -0400 | [diff] [blame] | 49 | self.original_vars = sysconfig._CONFIG_VARS |
Tarek Ziadé | edacea3 | 2010-01-29 11:41:03 +0000 | [diff] [blame] | 50 | self.old_vars = copy(sysconfig._CONFIG_VARS) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 51 | |
Alexandre Vassalotti | e9f305f | 2008-05-16 04:39:54 +0000 | [diff] [blame] | 52 | def tearDown(self): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 53 | """Restore sys.path""" |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 54 | sys.path[:] = self.sys_path |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 55 | site.USER_BASE = self.old_base |
| 56 | site.USER_SITE = self.old_site |
| 57 | site.PREFIXES = self.old_prefixes |
Brett Cannon | 8ac95ee | 2012-04-04 17:31:16 -0400 | [diff] [blame] | 58 | sysconfig._CONFIG_VARS = self.original_vars |
| 59 | sysconfig._CONFIG_VARS.clear() |
| 60 | sysconfig._CONFIG_VARS.update(self.old_vars) |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 61 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 62 | def test_makepath(self): |
| 63 | # Test makepath() have an absolute path for its first return value |
| 64 | # and a case-normalized version of the absolute path for its |
| 65 | # second value. |
| 66 | path_parts = ("Beginning", "End") |
| 67 | original_dir = os.path.join(*path_parts) |
| 68 | abs_dir, norm_dir = site.makepath(*path_parts) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 69 | self.assertEqual(os.path.abspath(original_dir), abs_dir) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 70 | if original_dir == os.path.normcase(original_dir): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 71 | self.assertEqual(abs_dir, norm_dir) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 72 | else: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 73 | self.assertEqual(os.path.normcase(abs_dir), norm_dir) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 74 | |
| 75 | def test_init_pathinfo(self): |
| 76 | dir_set = site._init_pathinfo() |
| 77 | for entry in [site.makepath(path)[1] for path in sys.path |
Brett Cannon | 5f0507d | 2016-04-08 15:04:28 -0700 | [diff] [blame] | 78 | if path and os.path.exists(path)]: |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 79 | self.assertIn(entry, dir_set, |
| 80 | "%s from sys.path not found in set returned " |
| 81 | "by _init_pathinfo(): %s" % (entry, dir_set)) |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 82 | |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 83 | def pth_file_tests(self, pth_file): |
| 84 | """Contain common code for testing results of reading a .pth file""" |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 85 | self.assertIn(pth_file.imported, sys.modules, |
| 86 | "%s not in sys.modules" % pth_file.imported) |
Antoine Pitrou | 9166e6a | 2009-11-01 23:55:40 +0000 | [diff] [blame] | 87 | self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path) |
| 88 | self.assertFalse(os.path.exists(pth_file.bad_dir_path)) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 89 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 90 | def test_addpackage(self): |
| 91 | # Make sure addpackage() imports if the line starts with 'import', |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 92 | # adds directories to sys.path for any line in the file that is not a |
| 93 | # comment or import that is a valid directory name for where the .pth |
| 94 | # file resides; invalid directories are not added |
| 95 | pth_file = PthFile() |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 96 | pth_file.cleanup(prep=True) # to make sure that nothing is |
| 97 | # pre-existing that shouldn't be |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 98 | try: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 99 | pth_file.create() |
| 100 | site.addpackage(pth_file.base_dir, pth_file.filename, set()) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 101 | self.pth_file_tests(pth_file) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 102 | finally: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 103 | pth_file.cleanup() |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 104 | |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 105 | def make_pth(self, contents, pth_dir='.', pth_name=TESTFN): |
| 106 | # Create a .pth file and return its (abspath, basename). |
| 107 | pth_dir = os.path.abspath(pth_dir) |
| 108 | pth_basename = pth_name + '.pth' |
| 109 | pth_fn = os.path.join(pth_dir, pth_basename) |
| 110 | pth_file = open(pth_fn, 'w', encoding='utf-8') |
| 111 | self.addCleanup(lambda: os.remove(pth_fn)) |
| 112 | pth_file.write(contents) |
| 113 | pth_file.close() |
| 114 | return pth_dir, pth_basename |
| 115 | |
| 116 | def test_addpackage_import_bad_syntax(self): |
| 117 | # Issue 10642 |
| 118 | pth_dir, pth_fn = self.make_pth("import bad)syntax\n") |
| 119 | with captured_stderr() as err_out: |
| 120 | site.addpackage(pth_dir, pth_fn, set()) |
| 121 | self.assertRegex(err_out.getvalue(), "line 1") |
R. David Murray | ab9d8d6 | 2010-12-27 00:03:13 +0000 | [diff] [blame] | 122 | self.assertRegex(err_out.getvalue(), |
| 123 | re.escape(os.path.join(pth_dir, pth_fn))) |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 124 | # XXX: the previous two should be independent checks so that the |
| 125 | # order doesn't matter. The next three could be a single check |
| 126 | # but my regex foo isn't good enough to write it. |
| 127 | self.assertRegex(err_out.getvalue(), 'Traceback') |
| 128 | self.assertRegex(err_out.getvalue(), r'import bad\)syntax') |
| 129 | self.assertRegex(err_out.getvalue(), 'SyntaxError') |
| 130 | |
| 131 | def test_addpackage_import_bad_exec(self): |
| 132 | # Issue 10642 |
| 133 | pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n") |
| 134 | with captured_stderr() as err_out: |
| 135 | site.addpackage(pth_dir, pth_fn, set()) |
| 136 | self.assertRegex(err_out.getvalue(), "line 2") |
R. David Murray | ab9d8d6 | 2010-12-27 00:03:13 +0000 | [diff] [blame] | 137 | self.assertRegex(err_out.getvalue(), |
| 138 | re.escape(os.path.join(pth_dir, pth_fn))) |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 139 | # XXX: ditto previous XXX comment. |
| 140 | self.assertRegex(err_out.getvalue(), 'Traceback') |
Eric Snow | 46f97b8 | 2016-09-07 16:56:15 -0700 | [diff] [blame] | 141 | self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError') |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 142 | |
R. David Murray | ad4ccfd | 2010-12-27 04:31:48 +0000 | [diff] [blame] | 143 | @unittest.skipIf(sys.platform == "win32", "Windows does not raise an " |
| 144 | "error for file paths containing null characters") |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 145 | def test_addpackage_import_bad_pth_file(self): |
| 146 | # Issue 5258 |
| 147 | pth_dir, pth_fn = self.make_pth("abc\x00def\n") |
| 148 | with captured_stderr() as err_out: |
| 149 | site.addpackage(pth_dir, pth_fn, set()) |
| 150 | self.assertRegex(err_out.getvalue(), "line 1") |
R. David Murray | ab9d8d6 | 2010-12-27 00:03:13 +0000 | [diff] [blame] | 151 | self.assertRegex(err_out.getvalue(), |
| 152 | re.escape(os.path.join(pth_dir, pth_fn))) |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 153 | # XXX: ditto previous XXX comment. |
| 154 | self.assertRegex(err_out.getvalue(), 'Traceback') |
Serhiy Storchaka | d8a1447 | 2014-09-06 20:07:17 +0300 | [diff] [blame] | 155 | self.assertRegex(err_out.getvalue(), 'ValueError') |
R. David Murray | b4ca59b | 2010-12-26 19:54:29 +0000 | [diff] [blame] | 156 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 157 | def test_addsitedir(self): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 158 | # Same tests for test_addpackage since addsitedir() essentially just |
| 159 | # calls addpackage() for every .pth file in the directory |
| 160 | pth_file = PthFile() |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 161 | pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing |
| 162 | # that is tested for |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 163 | try: |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 164 | pth_file.create() |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 165 | site.addsitedir(pth_file.base_dir, set()) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 166 | self.pth_file_tests(pth_file) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 167 | finally: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 168 | pth_file.cleanup() |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 169 | |
Ned Deily | 316f573 | 2011-10-31 16:16:35 -0700 | [diff] [blame] | 170 | @unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 " |
| 171 | "user-site (site.ENABLE_USER_SITE)") |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 172 | def test_s_option(self): |
| 173 | usersite = site.USER_SITE |
Antoine Pitrou | 9166e6a | 2009-11-01 23:55:40 +0000 | [diff] [blame] | 174 | self.assertIn(usersite, sys.path) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 175 | |
Éric Araujo | 63ebe1c | 2011-01-03 17:51:11 +0000 | [diff] [blame] | 176 | env = os.environ.copy() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 177 | rc = subprocess.call([sys.executable, '-c', |
Éric Araujo | 63ebe1c | 2011-01-03 17:51:11 +0000 | [diff] [blame] | 178 | 'import sys; sys.exit(%r in sys.path)' % usersite], |
| 179 | env=env) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 180 | self.assertEqual(rc, 1) |
| 181 | |
Éric Araujo | 63ebe1c | 2011-01-03 17:51:11 +0000 | [diff] [blame] | 182 | env = os.environ.copy() |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 183 | rc = subprocess.call([sys.executable, '-s', '-c', |
Éric Araujo | 63ebe1c | 2011-01-03 17:51:11 +0000 | [diff] [blame] | 184 | 'import sys; sys.exit(%r in sys.path)' % usersite], |
| 185 | env=env) |
Antoine Pitrou | a1782e1 | 2013-10-23 22:03:22 +0200 | [diff] [blame] | 186 | if usersite == site.getsitepackages()[0]: |
| 187 | self.assertEqual(rc, 1) |
| 188 | else: |
| 189 | self.assertEqual(rc, 0) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 190 | |
| 191 | env = os.environ.copy() |
| 192 | env["PYTHONNOUSERSITE"] = "1" |
| 193 | rc = subprocess.call([sys.executable, '-c', |
Benjamin Peterson | fea6a94 | 2008-07-02 16:11:42 +0000 | [diff] [blame] | 194 | 'import sys; sys.exit(%r in sys.path)' % usersite], |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 195 | env=env) |
Antoine Pitrou | a1782e1 | 2013-10-23 22:03:22 +0200 | [diff] [blame] | 196 | if usersite == site.getsitepackages()[0]: |
| 197 | self.assertEqual(rc, 1) |
| 198 | else: |
| 199 | self.assertEqual(rc, 0) |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 200 | |
| 201 | env = os.environ.copy() |
| 202 | env["PYTHONUSERBASE"] = "/tmp" |
| 203 | rc = subprocess.call([sys.executable, '-c', |
| 204 | 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'], |
| 205 | env=env) |
| 206 | self.assertEqual(rc, 1) |
| 207 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 208 | def test_getuserbase(self): |
| 209 | site.USER_BASE = None |
| 210 | user_base = site.getuserbase() |
| 211 | |
| 212 | # the call sets site.USER_BASE |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 213 | self.assertEqual(site.USER_BASE, user_base) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 214 | |
| 215 | # let's set PYTHONUSERBASE and see if it uses it |
| 216 | site.USER_BASE = None |
Tarek Ziadé | edacea3 | 2010-01-29 11:41:03 +0000 | [diff] [blame] | 217 | import sysconfig |
| 218 | sysconfig._CONFIG_VARS = None |
| 219 | |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 220 | with EnvironmentVarGuard() as environ: |
| 221 | environ['PYTHONUSERBASE'] = 'xoxo' |
Antoine Pitrou | 9166e6a | 2009-11-01 23:55:40 +0000 | [diff] [blame] | 222 | self.assertTrue(site.getuserbase().startswith('xoxo'), |
| 223 | site.getuserbase()) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 224 | |
| 225 | def test_getusersitepackages(self): |
| 226 | site.USER_SITE = None |
| 227 | site.USER_BASE = None |
| 228 | user_site = site.getusersitepackages() |
| 229 | |
| 230 | # the call sets USER_BASE *and* USER_SITE |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 231 | self.assertEqual(site.USER_SITE, user_site) |
Antoine Pitrou | 9166e6a | 2009-11-01 23:55:40 +0000 | [diff] [blame] | 232 | self.assertTrue(user_site.startswith(site.USER_BASE), user_site) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 233 | |
| 234 | def test_getsitepackages(self): |
| 235 | site.PREFIXES = ['xoxo'] |
| 236 | dirs = site.getsitepackages() |
| 237 | |
Christian Heimes | de0b962 | 2012-11-19 00:59:39 +0100 | [diff] [blame] | 238 | if (sys.platform == "darwin" and |
Ned Deily | d531b29 | 2012-02-06 00:58:18 +0100 | [diff] [blame] | 239 | sysconfig.get_config_var("PYTHONFRAMEWORK")): |
| 240 | # OS X framework builds |
| 241 | site.PREFIXES = ['Python.framework'] |
| 242 | dirs = site.getsitepackages() |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 243 | self.assertEqual(len(dirs), 2) |
Ned Deily | d531b29 | 2012-02-06 00:58:18 +0100 | [diff] [blame] | 244 | wanted = os.path.join('/Library', |
| 245 | sysconfig.get_config_var("PYTHONFRAMEWORK"), |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 246 | '%d.%d' % sys.version_info[:2], |
Ned Deily | d531b29 | 2012-02-06 00:58:18 +0100 | [diff] [blame] | 247 | 'site-packages') |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 248 | self.assertEqual(dirs[1], wanted) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 249 | elif os.sep == '/': |
Ned Deily | d531b29 | 2012-02-06 00:58:18 +0100 | [diff] [blame] | 250 | # OS X non-framwework builds, Linux, FreeBSD, etc |
Antoine Pitrou | 9e82b17 | 2014-06-12 19:41:30 -0400 | [diff] [blame] | 251 | self.assertEqual(len(dirs), 1) |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 252 | wanted = os.path.join('xoxo', 'lib', |
| 253 | 'python%d.%d' % sys.version_info[:2], |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 254 | 'site-packages') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 255 | self.assertEqual(dirs[0], wanted) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 256 | else: |
Ned Deily | d531b29 | 2012-02-06 00:58:18 +0100 | [diff] [blame] | 257 | # other platforms |
Ezio Melotti | fc8b205 | 2010-08-17 08:35:41 +0000 | [diff] [blame] | 258 | self.assertEqual(len(dirs), 2) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 259 | self.assertEqual(dirs[0], 'xoxo') |
Tarek Ziadé | 8c0e217 | 2009-10-27 21:24:21 +0000 | [diff] [blame] | 260 | wanted = os.path.join('xoxo', 'lib', 'site-packages') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 261 | self.assertEqual(dirs[1], wanted) |
Tarek Ziadé | 4a608c0 | 2009-08-20 21:28:05 +0000 | [diff] [blame] | 262 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 263 | class PthFile(object): |
| 264 | """Helper class for handling testing of .pth files""" |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 265 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 266 | def __init__(self, filename_base=TESTFN, imported="time", |
| 267 | good_dirname="__testdir__", bad_dirname="__bad"): |
| 268 | """Initialize instance variables""" |
| 269 | self.filename = filename_base + ".pth" |
| 270 | self.base_dir = os.path.abspath('') |
| 271 | self.file_path = os.path.join(self.base_dir, self.filename) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 272 | self.imported = imported |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 273 | self.good_dirname = good_dirname |
| 274 | self.bad_dirname = bad_dirname |
| 275 | self.good_dir_path = os.path.join(self.base_dir, self.good_dirname) |
| 276 | self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 277 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 278 | def create(self): |
| 279 | """Create a .pth file with a comment, blank lines, an ``import |
| 280 | <self.imported>``, a line with self.good_dirname, and a line with |
| 281 | self.bad_dirname. |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame] | 282 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 283 | Creation of the directory for self.good_dir_path (based off of |
| 284 | self.good_dirname) is also performed. |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 285 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 286 | Make sure to call self.cleanup() to undo anything done by this method. |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame] | 287 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 288 | """ |
Michael W. Hudson | ff52286 | 2005-05-27 14:58:06 +0000 | [diff] [blame] | 289 | FILE = open(self.file_path, 'w') |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 290 | try: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 291 | print("#import @bad module name", file=FILE) |
| 292 | print("\n", file=FILE) |
| 293 | print("import %s" % self.imported, file=FILE) |
| 294 | print(self.good_dirname, file=FILE) |
| 295 | print(self.bad_dirname, file=FILE) |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 296 | finally: |
| 297 | FILE.close() |
| 298 | os.mkdir(self.good_dir_path) |
| 299 | |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 300 | def cleanup(self, prep=False): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 301 | """Make sure that the .pth file is deleted, self.imported is not in |
| 302 | sys.modules, and that both self.good_dirname and self.bad_dirname are |
| 303 | not existing directories.""" |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 304 | if os.path.exists(self.file_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 305 | os.remove(self.file_path) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 306 | if prep: |
| 307 | self.imported_module = sys.modules.get(self.imported) |
| 308 | if self.imported_module: |
| 309 | del sys.modules[self.imported] |
| 310 | else: |
| 311 | if self.imported_module: |
| 312 | sys.modules[self.imported] = self.imported_module |
| 313 | if os.path.exists(self.good_dir_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 314 | os.rmdir(self.good_dir_path) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 315 | if os.path.exists(self.bad_dir_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 316 | os.rmdir(self.bad_dir_path) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 317 | |
| 318 | class ImportSideEffectTests(unittest.TestCase): |
| 319 | """Test side-effects from importing 'site'.""" |
| 320 | |
| 321 | def setUp(self): |
| 322 | """Make a copy of sys.path""" |
| 323 | self.sys_path = sys.path[:] |
| 324 | |
| 325 | def tearDown(self): |
| 326 | """Restore sys.path""" |
Nick Coghlan | 6ead552 | 2009-10-18 13:19:33 +0000 | [diff] [blame] | 327 | sys.path[:] = self.sys_path |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 328 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 329 | def test_abs_paths(self): |
| 330 | # Make sure all imported modules have their __file__ and __cached__ |
| 331 | # attributes as absolute paths. Arranging to put the Lib directory on |
| 332 | # PYTHONPATH would cause the os module to have a relative path for |
| 333 | # __file__ if abs_paths() does not get run. sys and builtins (the |
| 334 | # only other modules imported before site.py runs) do not have |
| 335 | # __file__ or __cached__ because they are built-in. |
| 336 | parent = os.path.relpath(os.path.dirname(os.__file__)) |
| 337 | env = os.environ.copy() |
| 338 | env['PYTHONPATH'] = parent |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 339 | code = ('import os, sys', |
| 340 | # use ASCII to avoid locale issues with non-ASCII directories |
| 341 | 'os_file = os.__file__.encode("ascii", "backslashreplace")', |
| 342 | r'sys.stdout.buffer.write(os_file + b"\n")', |
| 343 | 'os_cached = os.__cached__.encode("ascii", "backslashreplace")', |
| 344 | r'sys.stdout.buffer.write(os_cached + b"\n")') |
| 345 | command = '\n'.join(code) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 346 | # First, prove that with -S (no 'import site'), the paths are |
| 347 | # relative. |
| 348 | proc = subprocess.Popen([sys.executable, '-S', '-c', command], |
| 349 | env=env, |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 350 | stdout=subprocess.PIPE) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 351 | stdout, stderr = proc.communicate() |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 352 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 353 | self.assertEqual(proc.returncode, 0) |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 354 | os__file__, os__cached__ = stdout.splitlines()[:2] |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 355 | self.assertFalse(os.path.isabs(os__file__)) |
| 356 | self.assertFalse(os.path.isabs(os__cached__)) |
| 357 | # Now, with 'import site', it works. |
| 358 | proc = subprocess.Popen([sys.executable, '-c', command], |
| 359 | env=env, |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 360 | stdout=subprocess.PIPE) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 361 | stdout, stderr = proc.communicate() |
| 362 | self.assertEqual(proc.returncode, 0) |
Victor Stinner | f3bc258 | 2010-04-18 07:59:53 +0000 | [diff] [blame] | 363 | os__file__, os__cached__ = stdout.splitlines()[:2] |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 364 | self.assertTrue(os.path.isabs(os__file__), |
Eric Snow | 00607e9 | 2015-05-04 11:48:39 -0600 | [diff] [blame] | 365 | "expected absolute path, got {}" |
| 366 | .format(os__file__.decode('ascii'))) |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 367 | self.assertTrue(os.path.isabs(os__cached__), |
Eric Snow | 00607e9 | 2015-05-04 11:48:39 -0600 | [diff] [blame] | 368 | "expected absolute path, got {}" |
| 369 | .format(os__cached__.decode('ascii'))) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 370 | |
| 371 | def test_no_duplicate_paths(self): |
| 372 | # No duplicate paths should exist in sys.path |
| 373 | # Handled by removeduppaths() |
| 374 | site.removeduppaths() |
| 375 | seen_paths = set() |
| 376 | for path in sys.path: |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 377 | self.assertNotIn(path, seen_paths) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 378 | seen_paths.add(path) |
| 379 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 380 | @unittest.skip('test not implemented') |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 381 | def test_add_build_dir(self): |
| 382 | # Test that the build directory's Modules directory is used when it |
| 383 | # should be. |
| 384 | # XXX: implement |
| 385 | pass |
| 386 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 387 | def test_setting_quit(self): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 388 | # 'quit' and 'exit' should be injected into builtins |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 389 | self.assertTrue(hasattr(builtins, "quit")) |
| 390 | self.assertTrue(hasattr(builtins, "exit")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 391 | |
| 392 | def test_setting_copyright(self): |
Senthil Kumaran | 8ef519b | 2013-09-07 13:59:17 -0700 | [diff] [blame] | 393 | # 'copyright', 'credits', and 'license' should be in builtins |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 394 | self.assertTrue(hasattr(builtins, "copyright")) |
| 395 | self.assertTrue(hasattr(builtins, "credits")) |
Senthil Kumaran | 8ef519b | 2013-09-07 13:59:17 -0700 | [diff] [blame] | 396 | self.assertTrue(hasattr(builtins, "license")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 397 | |
| 398 | def test_setting_help(self): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 399 | # 'help' should be set in builtins |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 400 | self.assertTrue(hasattr(builtins, "help")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 401 | |
| 402 | def test_aliasing_mbcs(self): |
| 403 | if sys.platform == "win32": |
| 404 | import locale |
| 405 | if locale.getdefaultlocale()[1].startswith('cp'): |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 406 | for value in encodings.aliases.aliases.values(): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 407 | if value == "mbcs": |
| 408 | break |
| 409 | else: |
| 410 | self.fail("did not alias mbcs") |
| 411 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 412 | def test_sitecustomize_executed(self): |
| 413 | # If sitecustomize is available, it should have been imported. |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 414 | if "sitecustomize" not in sys.modules: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 415 | try: |
| 416 | import sitecustomize |
| 417 | except ImportError: |
| 418 | pass |
| 419 | else: |
| 420 | self.fail("sitecustomize not imported automatically") |
| 421 | |
R David Murray | 1bc6ceb | 2013-09-14 13:28:37 -0400 | [diff] [blame] | 422 | @test.support.requires_resource('network') |
Benjamin Peterson | 337578b | 2015-02-01 20:16:59 -0500 | [diff] [blame] | 423 | @test.support.system_must_validate_cert |
Georg Brandl | 78abc9d | 2013-10-27 09:41:57 +0100 | [diff] [blame] | 424 | @unittest.skipUnless(sys.version_info[3] == 'final', |
| 425 | 'only for released versions') |
Ned Deily | 5a507f0 | 2014-03-26 23:31:39 -0700 | [diff] [blame] | 426 | @unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"), |
| 427 | 'need SSL support to download license') |
R David Murray | 1bc6ceb | 2013-09-14 13:28:37 -0400 | [diff] [blame] | 428 | def test_license_exists_at_url(self): |
Ned Deily | 944d597 | 2014-03-26 23:43:26 -0700 | [diff] [blame] | 429 | # This test is a bit fragile since it depends on the format of the |
R David Murray | 1bc6ceb | 2013-09-14 13:28:37 -0400 | [diff] [blame] | 430 | # string displayed by license in the absence of a LICENSE file. |
| 431 | url = license._Printer__data.split()[1] |
| 432 | req = urllib.request.Request(url, method='HEAD') |
| 433 | try: |
Senthil Kumaran | 8ef519b | 2013-09-07 13:59:17 -0700 | [diff] [blame] | 434 | with test.support.transient_internet(url): |
R David Murray | 1bc6ceb | 2013-09-14 13:28:37 -0400 | [diff] [blame] | 435 | with urllib.request.urlopen(req) as data: |
| 436 | code = data.getcode() |
| 437 | except urllib.error.HTTPError as e: |
| 438 | code = e.code |
| 439 | self.assertEqual(code, 200, msg="Can't find " + url) |
Senthil Kumaran | 8ef519b | 2013-09-07 13:59:17 -0700 | [diff] [blame] | 440 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 441 | |
Christian Heimes | 8c9cd5a | 2013-10-12 00:24:55 +0200 | [diff] [blame] | 442 | class StartupImportTests(unittest.TestCase): |
| 443 | |
| 444 | def test_startup_imports(self): |
| 445 | # This tests checks which modules are loaded by Python when it |
| 446 | # initially starts upon startup. |
Christian Heimes | 179a3db | 2013-10-12 12:32:21 +0200 | [diff] [blame] | 447 | popen = subprocess.Popen([sys.executable, '-I', '-v', '-c', |
| 448 | 'import sys; print(set(sys.modules))'], |
| 449 | stdout=subprocess.PIPE, |
| 450 | stderr=subprocess.PIPE) |
| 451 | stdout, stderr = popen.communicate() |
| 452 | stdout = stdout.decode('utf-8') |
| 453 | stderr = stderr.decode('utf-8') |
| 454 | modules = eval(stdout) |
| 455 | |
Christian Heimes | 8c9cd5a | 2013-10-12 00:24:55 +0200 | [diff] [blame] | 456 | self.assertIn('site', modules) |
| 457 | |
Christian Heimes | 2582762 | 2013-10-12 01:27:08 +0200 | [diff] [blame] | 458 | # http://bugs.python.org/issue19205 |
Christian Heimes | 8c9cd5a | 2013-10-12 00:24:55 +0200 | [diff] [blame] | 459 | re_mods = {'re', '_sre', 'sre_compile', 'sre_constants', 'sre_parse'} |
Christian Heimes | f403f50 | 2013-10-12 15:08:42 +0200 | [diff] [blame] | 460 | # _osx_support uses the re module in many placs |
| 461 | if sys.platform != 'darwin': |
| 462 | self.assertFalse(modules.intersection(re_mods), stderr) |
Christian Heimes | 2582762 | 2013-10-12 01:27:08 +0200 | [diff] [blame] | 463 | # http://bugs.python.org/issue9548 |
Christian Heimes | 179a3db | 2013-10-12 12:32:21 +0200 | [diff] [blame] | 464 | self.assertNotIn('locale', modules, stderr) |
Christian Heimes | 86823a5 | 2013-10-17 13:40:00 +0200 | [diff] [blame] | 465 | if sys.platform != 'darwin': |
| 466 | # http://bugs.python.org/issue19209 |
| 467 | self.assertNotIn('copyreg', modules, stderr) |
Christian Heimes | f1dc3ee | 2013-10-13 02:04:20 +0200 | [diff] [blame] | 468 | # http://bugs.python.org/issue19218> |
| 469 | collection_mods = {'_collections', 'collections', 'functools', |
| 470 | 'heapq', 'itertools', 'keyword', 'operator', |
doko@ubuntu.com | 9574355 | 2014-04-15 20:37:54 +0200 | [diff] [blame] | 471 | 'reprlib', 'types', 'weakref' |
| 472 | }.difference(sys.builtin_module_names) |
Ned Deily | b795aa8 | 2013-10-17 15:21:40 -0700 | [diff] [blame] | 473 | self.assertFalse(modules.intersection(collection_mods), stderr) |
Christian Heimes | 1a5fb4e | 2013-10-12 01:00:51 +0200 | [diff] [blame] | 474 | |
Christian Heimes | 8c9cd5a | 2013-10-12 00:24:55 +0200 | [diff] [blame] | 475 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 476 | if __name__ == "__main__": |
Brett Cannon | 3e9a9ae | 2013-06-12 21:25:59 -0400 | [diff] [blame] | 477 | unittest.main() |