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 |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 8 | from test.support import TestSkipped, run_unittest, TESTFN |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 9 | import builtins |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 10 | import os |
| 11 | import sys |
| 12 | import encodings |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 13 | import subprocess |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 14 | # Need to make sure to not import 'site' if someone specified ``-S`` at the |
| 15 | # command-line. Detect this by just making sure 'site' has not been imported |
| 16 | # already. |
| 17 | if "site" in sys.modules: |
| 18 | import site |
| 19 | else: |
| 20 | raise TestSkipped("importation of site.py suppressed") |
| 21 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 22 | if not os.path.isdir(site.USER_SITE): |
| 23 | # need to add user site directory for tests |
| 24 | os.makedirs(site.USER_SITE) |
| 25 | site.addsitedir(site.USER_SITE) |
| 26 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 27 | class HelperFunctionsTests(unittest.TestCase): |
| 28 | """Tests for helper functions. |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 29 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 30 | The setting of the encoding (set using sys.setdefaultencoding) used by |
| 31 | the Unicode implementation is not tested. |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 32 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 33 | """ |
| 34 | |
| 35 | def setUp(self): |
| 36 | """Save a copy of sys.path""" |
| 37 | self.sys_path = sys.path[:] |
| 38 | |
Alexandre Vassalotti | e9f305f | 2008-05-16 04:39:54 +0000 | [diff] [blame] | 39 | def tearDown(self): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 40 | """Restore sys.path""" |
| 41 | sys.path = self.sys_path |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 42 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 43 | def test_makepath(self): |
| 44 | # Test makepath() have an absolute path for its first return value |
| 45 | # and a case-normalized version of the absolute path for its |
| 46 | # second value. |
| 47 | path_parts = ("Beginning", "End") |
| 48 | original_dir = os.path.join(*path_parts) |
| 49 | abs_dir, norm_dir = site.makepath(*path_parts) |
| 50 | self.failUnlessEqual(os.path.abspath(original_dir), abs_dir) |
| 51 | if original_dir == os.path.normcase(original_dir): |
| 52 | self.failUnlessEqual(abs_dir, norm_dir) |
| 53 | else: |
| 54 | self.failUnlessEqual(os.path.normcase(abs_dir), norm_dir) |
| 55 | |
| 56 | def test_init_pathinfo(self): |
| 57 | dir_set = site._init_pathinfo() |
| 58 | for entry in [site.makepath(path)[1] for path in sys.path |
| 59 | if path and os.path.isdir(path)]: |
| 60 | self.failUnless(entry in dir_set, |
| 61 | "%s from sys.path not found in set returned " |
| 62 | "by _init_pathinfo(): %s" % (entry, dir_set)) |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 63 | |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 64 | def pth_file_tests(self, pth_file): |
| 65 | """Contain common code for testing results of reading a .pth file""" |
| 66 | self.failUnless(pth_file.imported in sys.modules, |
| 67 | "%s not in sys.path" % pth_file.imported) |
| 68 | self.failUnless(site.makepath(pth_file.good_dir_path)[0] in sys.path) |
| 69 | self.failUnless(not os.path.exists(pth_file.bad_dir_path)) |
| 70 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 71 | def test_addpackage(self): |
| 72 | # Make sure addpackage() imports if the line starts with 'import', |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 73 | # adds directories to sys.path for any line in the file that is not a |
| 74 | # comment or import that is a valid directory name for where the .pth |
| 75 | # file resides; invalid directories are not added |
| 76 | pth_file = PthFile() |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 77 | pth_file.cleanup(prep=True) # to make sure that nothing is |
| 78 | # pre-existing that shouldn't be |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 79 | try: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 80 | pth_file.create() |
| 81 | site.addpackage(pth_file.base_dir, pth_file.filename, set()) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 82 | self.pth_file_tests(pth_file) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 83 | finally: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 84 | pth_file.cleanup() |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 85 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 86 | def test_addsitedir(self): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 87 | # Same tests for test_addpackage since addsitedir() essentially just |
| 88 | # calls addpackage() for every .pth file in the directory |
| 89 | pth_file = PthFile() |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 90 | pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing |
| 91 | # that is tested for |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 92 | try: |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 93 | pth_file.create() |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 94 | site.addsitedir(pth_file.base_dir, set()) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 95 | self.pth_file_tests(pth_file) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 96 | finally: |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 97 | pth_file.cleanup() |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 98 | |
Christian Heimes | 8dc226f | 2008-05-06 23:45:46 +0000 | [diff] [blame] | 99 | def test_s_option(self): |
| 100 | usersite = site.USER_SITE |
| 101 | self.assert_(usersite in sys.path) |
| 102 | |
| 103 | rc = subprocess.call([sys.executable, '-c', |
| 104 | 'import sys; sys.exit("%s" in sys.path)' % usersite]) |
| 105 | self.assertEqual(rc, 1) |
| 106 | |
| 107 | rc = subprocess.call([sys.executable, '-s', '-c', |
| 108 | 'import sys; sys.exit("%s" in sys.path)' % usersite]) |
| 109 | self.assertEqual(rc, 0) |
| 110 | |
| 111 | env = os.environ.copy() |
| 112 | env["PYTHONNOUSERSITE"] = "1" |
| 113 | rc = subprocess.call([sys.executable, '-c', |
| 114 | 'import sys; sys.exit("%s" in sys.path)' % usersite], |
| 115 | env=env) |
| 116 | self.assertEqual(rc, 0) |
| 117 | |
| 118 | env = os.environ.copy() |
| 119 | env["PYTHONUSERBASE"] = "/tmp" |
| 120 | rc = subprocess.call([sys.executable, '-c', |
| 121 | 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'], |
| 122 | env=env) |
| 123 | self.assertEqual(rc, 1) |
| 124 | |
| 125 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 126 | class PthFile(object): |
| 127 | """Helper class for handling testing of .pth files""" |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 128 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 129 | def __init__(self, filename_base=TESTFN, imported="time", |
| 130 | good_dirname="__testdir__", bad_dirname="__bad"): |
| 131 | """Initialize instance variables""" |
| 132 | self.filename = filename_base + ".pth" |
| 133 | self.base_dir = os.path.abspath('') |
| 134 | self.file_path = os.path.join(self.base_dir, self.filename) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 135 | self.imported = imported |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 136 | self.good_dirname = good_dirname |
| 137 | self.bad_dirname = bad_dirname |
| 138 | self.good_dir_path = os.path.join(self.base_dir, self.good_dirname) |
| 139 | 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] | 140 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 141 | def create(self): |
| 142 | """Create a .pth file with a comment, blank lines, an ``import |
| 143 | <self.imported>``, a line with self.good_dirname, and a line with |
| 144 | self.bad_dirname. |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame] | 145 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 146 | Creation of the directory for self.good_dir_path (based off of |
| 147 | self.good_dirname) is also performed. |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 148 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 149 | 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] | 150 | |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 151 | """ |
Michael W. Hudson | ff52286 | 2005-05-27 14:58:06 +0000 | [diff] [blame] | 152 | FILE = open(self.file_path, 'w') |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 153 | try: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 154 | print("#import @bad module name", file=FILE) |
| 155 | print("\n", file=FILE) |
| 156 | print("import %s" % self.imported, file=FILE) |
| 157 | print(self.good_dirname, file=FILE) |
| 158 | print(self.bad_dirname, file=FILE) |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 159 | finally: |
| 160 | FILE.close() |
| 161 | os.mkdir(self.good_dir_path) |
| 162 | |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 163 | def cleanup(self, prep=False): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 164 | """Make sure that the .pth file is deleted, self.imported is not in |
| 165 | sys.modules, and that both self.good_dirname and self.bad_dirname are |
| 166 | not existing directories.""" |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 167 | if os.path.exists(self.file_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 168 | os.remove(self.file_path) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 169 | if prep: |
| 170 | self.imported_module = sys.modules.get(self.imported) |
| 171 | if self.imported_module: |
| 172 | del sys.modules[self.imported] |
| 173 | else: |
| 174 | if self.imported_module: |
| 175 | sys.modules[self.imported] = self.imported_module |
| 176 | if os.path.exists(self.good_dir_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 177 | os.rmdir(self.good_dir_path) |
Brett Cannon | ee86a66 | 2004-07-13 07:12:25 +0000 | [diff] [blame] | 178 | if os.path.exists(self.bad_dir_path): |
Brett Cannon | 64a8470 | 2004-07-10 02:10:45 +0000 | [diff] [blame] | 179 | os.rmdir(self.bad_dir_path) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 180 | |
| 181 | class ImportSideEffectTests(unittest.TestCase): |
| 182 | """Test side-effects from importing 'site'.""" |
| 183 | |
| 184 | def setUp(self): |
| 185 | """Make a copy of sys.path""" |
| 186 | self.sys_path = sys.path[:] |
| 187 | |
| 188 | def tearDown(self): |
| 189 | """Restore sys.path""" |
| 190 | sys.path = self.sys_path |
| 191 | |
| 192 | def test_abs__file__(self): |
| 193 | # Make sure all imported modules have their __file__ attribute |
| 194 | # as an absolute path. |
| 195 | # Handled by abs__file__() |
| 196 | site.abs__file__() |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 197 | for module in (sys, os, builtins): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 198 | try: |
Brett Cannon | 0b70cca | 2006-08-25 02:59:59 +0000 | [diff] [blame] | 199 | self.failUnless(os.path.isabs(module.__file__), repr(module)) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 200 | except AttributeError: |
| 201 | continue |
Raymond Hettinger | ebd9522 | 2004-06-27 03:02:18 +0000 | [diff] [blame] | 202 | # We could try everything in sys.modules; however, when regrtest.py |
| 203 | # runs something like test_frozen before test_site, then we will |
| 204 | # be testing things loaded *after* test_site did path normalization |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 205 | |
| 206 | def test_no_duplicate_paths(self): |
| 207 | # No duplicate paths should exist in sys.path |
| 208 | # Handled by removeduppaths() |
| 209 | site.removeduppaths() |
| 210 | seen_paths = set() |
| 211 | for path in sys.path: |
| 212 | self.failUnless(path not in seen_paths) |
| 213 | seen_paths.add(path) |
| 214 | |
| 215 | def test_add_build_dir(self): |
| 216 | # Test that the build directory's Modules directory is used when it |
| 217 | # should be. |
| 218 | # XXX: implement |
| 219 | pass |
| 220 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 221 | def test_setting_quit(self): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 222 | # 'quit' and 'exit' should be injected into builtins |
| 223 | self.failUnless(hasattr(builtins, "quit")) |
| 224 | self.failUnless(hasattr(builtins, "exit")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 225 | |
| 226 | def test_setting_copyright(self): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 227 | # 'copyright' and 'credits' should be in builtins |
| 228 | self.failUnless(hasattr(builtins, "copyright")) |
| 229 | self.failUnless(hasattr(builtins, "credits")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 230 | |
| 231 | def test_setting_help(self): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 232 | # 'help' should be set in builtins |
| 233 | self.failUnless(hasattr(builtins, "help")) |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 234 | |
| 235 | def test_aliasing_mbcs(self): |
| 236 | if sys.platform == "win32": |
| 237 | import locale |
| 238 | if locale.getdefaultlocale()[1].startswith('cp'): |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 239 | for value in encodings.aliases.aliases.values(): |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 240 | if value == "mbcs": |
| 241 | break |
| 242 | else: |
| 243 | self.fail("did not alias mbcs") |
| 244 | |
| 245 | def test_setdefaultencoding_removed(self): |
| 246 | # Make sure sys.setdefaultencoding is gone |
| 247 | self.failUnless(not hasattr(sys, "setdefaultencoding")) |
| 248 | |
| 249 | def test_sitecustomize_executed(self): |
| 250 | # If sitecustomize is available, it should have been imported. |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 251 | if "sitecustomize" not in sys.modules: |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 252 | try: |
| 253 | import sitecustomize |
| 254 | except ImportError: |
| 255 | pass |
| 256 | else: |
| 257 | self.fail("sitecustomize not imported automatically") |
| 258 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 259 | def test_main(): |
| 260 | run_unittest(HelperFunctionsTests, ImportSideEffectTests) |
| 261 | |
Brett Cannon | 0096e26 | 2004-06-05 01:12:51 +0000 | [diff] [blame] | 262 | if __name__ == "__main__": |
| 263 | test_main() |