Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1 | # tempfile.py unit tests. |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 2 | import tempfile |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 3 | import os |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 4 | import signal |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 5 | import sys |
| 6 | import re |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 7 | import warnings |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 8 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 9 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 10 | from test import support |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 11 | |
Fred Drake | 7633d23 | 2002-10-17 22:09:03 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 13 | if hasattr(os, 'stat'): |
| 14 | import stat |
| 15 | has_stat = 1 |
| 16 | else: |
| 17 | has_stat = 0 |
| 18 | |
| 19 | has_textmode = (tempfile._text_openflags != tempfile._bin_openflags) |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 20 | has_spawnl = hasattr(os, 'spawnl') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 21 | |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 22 | # TEST_FILES may need to be tweaked for systems depending on the maximum |
| 23 | # number of files that can be opened at one time (see ulimit -n) |
Victor Stinner | 9c3de4a | 2011-08-17 20:49:41 +0200 | [diff] [blame] | 24 | if sys.platform.startswith('openbsd'): |
Martin v. Löwis | 9996828 | 2004-09-15 06:02:54 +0000 | [diff] [blame] | 25 | TEST_FILES = 48 |
Jack Jansen | ce92147 | 2003-01-08 16:30:34 +0000 | [diff] [blame] | 26 | else: |
| 27 | TEST_FILES = 100 |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 28 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 29 | # This is organized as one test for each chunk of code in tempfile.py, |
| 30 | # in order of their appearance in the file. Testing which requires |
| 31 | # threads is not done here. |
| 32 | |
| 33 | # Common functionality. |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 34 | class BaseTestCase(unittest.TestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 35 | |
| 36 | str_check = re.compile(r"[a-zA-Z0-9_-]{6}$") |
| 37 | |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 38 | def setUp(self): |
| 39 | self._warnings_manager = support.check_warnings() |
| 40 | self._warnings_manager.__enter__() |
| 41 | warnings.filterwarnings("ignore", category=RuntimeWarning, |
| 42 | message="mktemp", module=__name__) |
| 43 | |
| 44 | def tearDown(self): |
| 45 | self._warnings_manager.__exit__(None, None, None) |
| 46 | |
| 47 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 48 | def nameCheck(self, name, dir, pre, suf): |
| 49 | (ndir, nbase) = os.path.split(name) |
| 50 | npre = nbase[:len(pre)] |
| 51 | nsuf = nbase[len(nbase)-len(suf):] |
| 52 | |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 53 | # check for equality of the absolute paths! |
| 54 | self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 55 | "file '%s' not in directory '%s'" % (name, dir)) |
| 56 | self.assertEqual(npre, pre, |
| 57 | "file '%s' does not begin with '%s'" % (nbase, pre)) |
| 58 | self.assertEqual(nsuf, suf, |
| 59 | "file '%s' does not end with '%s'" % (nbase, suf)) |
| 60 | |
| 61 | nbase = nbase[len(pre):len(nbase)-len(suf)] |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 62 | self.assertTrue(self.str_check.match(nbase), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 63 | "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/" |
| 64 | % nbase) |
| 65 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 66 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 67 | class TestExports(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 68 | def test_exports(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 69 | # There are no surprising symbols in the tempfile module |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 70 | dict = tempfile.__dict__ |
| 71 | |
| 72 | expected = { |
| 73 | "NamedTemporaryFile" : 1, |
| 74 | "TemporaryFile" : 1, |
| 75 | "mkstemp" : 1, |
| 76 | "mkdtemp" : 1, |
| 77 | "mktemp" : 1, |
| 78 | "TMP_MAX" : 1, |
| 79 | "gettempprefix" : 1, |
| 80 | "gettempdir" : 1, |
| 81 | "tempdir" : 1, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 82 | "template" : 1, |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 83 | "SpooledTemporaryFile" : 1, |
| 84 | "TemporaryDirectory" : 1, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | unexp = [] |
| 88 | for key in dict: |
| 89 | if key[0] != '_' and key not in expected: |
| 90 | unexp.append(key) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 91 | self.assertTrue(len(unexp) == 0, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 92 | "unexpected keys: %s" % unexp) |
| 93 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 94 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 95 | class TestRandomNameSequence(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 96 | """Test the internal iterator object _RandomNameSequence.""" |
| 97 | |
| 98 | def setUp(self): |
| 99 | self.r = tempfile._RandomNameSequence() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 100 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 101 | |
| 102 | def test_get_six_char_str(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 103 | # _RandomNameSequence returns a six-character string |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 104 | s = next(self.r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 105 | self.nameCheck(s, '', '', '') |
| 106 | |
| 107 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 108 | # _RandomNameSequence returns no duplicate strings (stochastic) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 109 | |
| 110 | dict = {} |
| 111 | r = self.r |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 112 | for i in range(TEST_FILES): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 113 | s = next(r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 114 | self.nameCheck(s, '', '', '') |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 115 | self.assertNotIn(s, dict) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 116 | dict[s] = 1 |
| 117 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 118 | def supports_iter(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 119 | # _RandomNameSequence supports the iterator protocol |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 120 | |
| 121 | i = 0 |
| 122 | r = self.r |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 123 | for s in r: |
| 124 | i += 1 |
| 125 | if i == 20: |
| 126 | break |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 127 | |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 128 | @unittest.skipUnless(hasattr(os, 'fork'), |
| 129 | "os.fork is required for this test") |
| 130 | def test_process_awareness(self): |
| 131 | # ensure that the random source differs between |
| 132 | # child and parent. |
| 133 | read_fd, write_fd = os.pipe() |
| 134 | pid = None |
| 135 | try: |
| 136 | pid = os.fork() |
| 137 | if not pid: |
| 138 | os.close(read_fd) |
| 139 | os.write(write_fd, next(self.r).encode("ascii")) |
| 140 | os.close(write_fd) |
| 141 | # bypass the normal exit handlers- leave those to |
| 142 | # the parent. |
| 143 | os._exit(0) |
| 144 | parent_value = next(self.r) |
| 145 | child_value = os.read(read_fd, len(parent_value)).decode("ascii") |
| 146 | finally: |
| 147 | if pid: |
| 148 | # best effort to ensure the process can't bleed out |
| 149 | # via any bugs above |
| 150 | try: |
| 151 | os.kill(pid, signal.SIGKILL) |
| 152 | except EnvironmentError: |
| 153 | pass |
| 154 | os.close(read_fd) |
| 155 | os.close(write_fd) |
| 156 | self.assertNotEqual(child_value, parent_value) |
| 157 | |
| 158 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 159 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 160 | class TestCandidateTempdirList(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 161 | """Test the internal function _candidate_tempdir_list.""" |
| 162 | |
| 163 | def test_nonempty_list(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 164 | # _candidate_tempdir_list returns a nonempty list of strings |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 165 | |
| 166 | cand = tempfile._candidate_tempdir_list() |
| 167 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 168 | self.assertFalse(len(cand) == 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 169 | for c in cand: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 170 | self.assertIsInstance(c, str) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 171 | |
| 172 | def test_wanted_dirs(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 173 | # _candidate_tempdir_list contains the expected directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 174 | |
| 175 | # Make sure the interesting environment variables are all set. |
Hirokazu Yamamoto | 7195963 | 2009-04-27 01:44:28 +0000 | [diff] [blame] | 176 | with support.EnvironmentVarGuard() as env: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 177 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 178 | dirname = os.getenv(envname) |
| 179 | if not dirname: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 180 | env[envname] = os.path.abspath(envname) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 181 | |
| 182 | cand = tempfile._candidate_tempdir_list() |
| 183 | |
| 184 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 185 | dirname = os.getenv(envname) |
| 186 | if not dirname: raise ValueError |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 187 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 188 | |
| 189 | try: |
| 190 | dirname = os.getcwd() |
| 191 | except (AttributeError, os.error): |
| 192 | dirname = os.curdir |
| 193 | |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 194 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 195 | |
| 196 | # Not practical to try to verify the presence of OS-specific |
| 197 | # paths in this list. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 198 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 199 | |
| 200 | # We test _get_default_tempdir by testing gettempdir. |
| 201 | |
| 202 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 203 | class TestGetCandidateNames(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 204 | """Test the internal function _get_candidate_names.""" |
| 205 | |
| 206 | def test_retval(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 207 | # _get_candidate_names returns a _RandomNameSequence object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 208 | obj = tempfile._get_candidate_names() |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 209 | self.assertIsInstance(obj, tempfile._RandomNameSequence) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 210 | |
| 211 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 212 | # _get_candidate_names always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 213 | a = tempfile._get_candidate_names() |
| 214 | b = tempfile._get_candidate_names() |
| 215 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 216 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 217 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 218 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 219 | class TestMkstempInner(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 220 | """Test the internal function _mkstemp_inner.""" |
| 221 | |
| 222 | class mkstemped: |
| 223 | _bflags = tempfile._bin_openflags |
| 224 | _tflags = tempfile._text_openflags |
| 225 | _close = os.close |
| 226 | _unlink = os.unlink |
| 227 | |
| 228 | def __init__(self, dir, pre, suf, bin): |
| 229 | if bin: flags = self._bflags |
| 230 | else: flags = self._tflags |
| 231 | |
| 232 | (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags) |
| 233 | |
| 234 | def write(self, str): |
| 235 | os.write(self.fd, str) |
| 236 | |
| 237 | def __del__(self): |
| 238 | self._close(self.fd) |
| 239 | self._unlink(self.name) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 240 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 241 | def do_create(self, dir=None, pre="", suf="", bin=1): |
| 242 | if dir is None: |
| 243 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 244 | file = self.mkstemped(dir, pre, suf, bin) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 245 | |
| 246 | self.nameCheck(file.name, dir, pre, suf) |
| 247 | return file |
| 248 | |
| 249 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 250 | # _mkstemp_inner can create files |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 251 | self.do_create().write(b"blat") |
| 252 | self.do_create(pre="a").write(b"blat") |
| 253 | self.do_create(suf="b").write(b"blat") |
| 254 | self.do_create(pre="a", suf="b").write(b"blat") |
| 255 | self.do_create(pre="aa", suf=".txt").write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 256 | |
| 257 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 258 | # _mkstemp_inner can create many files (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 259 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 260 | for i in extant: |
| 261 | extant[i] = self.do_create(pre="aa") |
| 262 | |
| 263 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 264 | # _mkstemp_inner can create files in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 265 | dir = tempfile.mkdtemp() |
| 266 | try: |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 267 | self.do_create(dir=dir).write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 268 | finally: |
| 269 | os.rmdir(dir) |
| 270 | |
| 271 | def test_file_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 272 | # _mkstemp_inner creates files with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 273 | if not has_stat: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 274 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 275 | |
| 276 | file = self.do_create() |
| 277 | mode = stat.S_IMODE(os.stat(file.name).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 278 | expected = 0o600 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 279 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 280 | # There's no distinction among 'user', 'group' and 'world'; |
| 281 | # replicate the 'user' bits. |
| 282 | user = expected >> 6 |
| 283 | expected = user * (1 + 8 + 64) |
| 284 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 285 | |
| 286 | def test_noinherit(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 287 | # _mkstemp_inner file handles are not inherited by child processes |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 288 | if not has_spawnl: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 289 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 290 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 291 | if support.verbose: |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 292 | v="v" |
| 293 | else: |
| 294 | v="q" |
| 295 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 296 | file = self.do_create() |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 297 | fd = "%d" % file.fd |
| 298 | |
| 299 | try: |
| 300 | me = __file__ |
| 301 | except NameError: |
| 302 | me = sys.argv[0] |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 303 | |
| 304 | # We have to exec something, so that FD_CLOEXEC will take |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 305 | # effect. The core of this test is therefore in |
| 306 | # tf_inherit_check.py, which see. |
| 307 | tester = os.path.join(os.path.dirname(os.path.abspath(me)), |
| 308 | "tf_inherit_check.py") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 309 | |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 310 | # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted, |
| 311 | # but an arg with embedded spaces should be decorated with double |
| 312 | # quotes on each end |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 313 | if sys.platform in ('win32',): |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 314 | decorated = '"%s"' % sys.executable |
| 315 | tester = '"%s"' % tester |
| 316 | else: |
| 317 | decorated = sys.executable |
| 318 | |
| 319 | retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 320 | self.assertFalse(retval < 0, |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 321 | "child process caught fatal signal %d" % -retval) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 322 | self.assertFalse(retval > 0, "child process reports failure %d"%retval) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 323 | |
| 324 | def test_textmode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 325 | # _mkstemp_inner can create files in text mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 326 | if not has_textmode: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 327 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 328 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 329 | # A text file is truncated at the first Ctrl+Z byte |
| 330 | f = self.do_create(bin=0) |
| 331 | f.write(b"blat\x1a") |
| 332 | f.write(b"extra\n") |
| 333 | os.lseek(f.fd, 0, os.SEEK_SET) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 334 | self.assertEqual(os.read(f.fd, 20), b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 335 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 336 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 337 | class TestGetTempPrefix(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 338 | """Test gettempprefix().""" |
| 339 | |
| 340 | def test_sane_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 341 | # gettempprefix returns a nonempty prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 342 | p = tempfile.gettempprefix() |
| 343 | |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 344 | self.assertIsInstance(p, str) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 345 | self.assertTrue(len(p) > 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 346 | |
| 347 | def test_usable_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 348 | # gettempprefix returns a usable prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 349 | |
| 350 | # Create a temp directory, avoiding use of the prefix. |
| 351 | # Then attempt to create a file whose name is |
| 352 | # prefix + 'xxxxxx.xxx' in that directory. |
| 353 | p = tempfile.gettempprefix() + "xxxxxx.xxx" |
| 354 | d = tempfile.mkdtemp(prefix="") |
| 355 | try: |
| 356 | p = os.path.join(d, p) |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 357 | fd = os.open(p, os.O_RDWR | os.O_CREAT) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 358 | os.close(fd) |
| 359 | os.unlink(p) |
| 360 | finally: |
| 361 | os.rmdir(d) |
| 362 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 363 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 364 | class TestGetTempDir(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 365 | """Test gettempdir().""" |
| 366 | |
| 367 | def test_directory_exists(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 368 | # gettempdir returns a directory which exists |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 369 | |
| 370 | dir = tempfile.gettempdir() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 371 | self.assertTrue(os.path.isabs(dir) or dir == os.curdir, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 372 | "%s is not an absolute path" % dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 373 | self.assertTrue(os.path.isdir(dir), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 374 | "%s is not a directory" % dir) |
| 375 | |
| 376 | def test_directory_writable(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 377 | # gettempdir returns a directory writable by the user |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 378 | |
| 379 | # sneaky: just instantiate a NamedTemporaryFile, which |
| 380 | # defaults to writing into the directory returned by |
| 381 | # gettempdir. |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 382 | file = tempfile.NamedTemporaryFile() |
| 383 | file.write(b"blat") |
| 384 | file.close() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 385 | |
| 386 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 387 | # gettempdir always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 388 | a = tempfile.gettempdir() |
| 389 | b = tempfile.gettempdir() |
| 390 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 391 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 392 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 393 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 394 | class TestMkstemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 395 | """Test mkstemp().""" |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 396 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 397 | def do_create(self, dir=None, pre="", suf=""): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 398 | if dir is None: |
| 399 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 400 | (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf) |
| 401 | (ndir, nbase) = os.path.split(name) |
| 402 | adir = os.path.abspath(dir) |
| 403 | self.assertEqual(adir, ndir, |
| 404 | "Directory '%s' incorrectly returned as '%s'" % (adir, ndir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 405 | |
| 406 | try: |
| 407 | self.nameCheck(name, dir, pre, suf) |
| 408 | finally: |
| 409 | os.close(fd) |
| 410 | os.unlink(name) |
| 411 | |
| 412 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 413 | # mkstemp can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 414 | self.do_create() |
| 415 | self.do_create(pre="a") |
| 416 | self.do_create(suf="b") |
| 417 | self.do_create(pre="a", suf="b") |
| 418 | self.do_create(pre="aa", suf=".txt") |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 419 | self.do_create(dir=".") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 420 | |
| 421 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 422 | # mkstemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 423 | dir = tempfile.mkdtemp() |
| 424 | try: |
| 425 | self.do_create(dir=dir) |
| 426 | finally: |
| 427 | os.rmdir(dir) |
| 428 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 429 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 430 | class TestMkdtemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 431 | """Test mkdtemp().""" |
| 432 | |
| 433 | def do_create(self, dir=None, pre="", suf=""): |
| 434 | if dir is None: |
| 435 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 436 | name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 437 | |
| 438 | try: |
| 439 | self.nameCheck(name, dir, pre, suf) |
| 440 | return name |
| 441 | except: |
| 442 | os.rmdir(name) |
| 443 | raise |
| 444 | |
| 445 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 446 | # mkdtemp can create directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 447 | os.rmdir(self.do_create()) |
| 448 | os.rmdir(self.do_create(pre="a")) |
| 449 | os.rmdir(self.do_create(suf="b")) |
| 450 | os.rmdir(self.do_create(pre="a", suf="b")) |
| 451 | os.rmdir(self.do_create(pre="aa", suf=".txt")) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 452 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 453 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 454 | # mkdtemp can create many directories (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 455 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 456 | try: |
| 457 | for i in extant: |
| 458 | extant[i] = self.do_create(pre="aa") |
| 459 | finally: |
| 460 | for i in extant: |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 461 | if(isinstance(i, str)): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 462 | os.rmdir(i) |
| 463 | |
| 464 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 465 | # mkdtemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 466 | dir = tempfile.mkdtemp() |
| 467 | try: |
| 468 | os.rmdir(self.do_create(dir=dir)) |
| 469 | finally: |
| 470 | os.rmdir(dir) |
| 471 | |
| 472 | def test_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 473 | # mkdtemp creates directories with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 474 | if not has_stat: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 475 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 476 | |
| 477 | dir = self.do_create() |
| 478 | try: |
| 479 | mode = stat.S_IMODE(os.stat(dir).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 480 | mode &= 0o777 # Mask off sticky bits inherited from /tmp |
| 481 | expected = 0o700 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 482 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 483 | # There's no distinction among 'user', 'group' and 'world'; |
| 484 | # replicate the 'user' bits. |
| 485 | user = expected >> 6 |
| 486 | expected = user * (1 + 8 + 64) |
| 487 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 488 | finally: |
| 489 | os.rmdir(dir) |
| 490 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 491 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 492 | class TestMktemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 493 | """Test mktemp().""" |
| 494 | |
| 495 | # For safety, all use of mktemp must occur in a private directory. |
| 496 | # We must also suppress the RuntimeWarning it generates. |
| 497 | def setUp(self): |
| 498 | self.dir = tempfile.mkdtemp() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 499 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 500 | |
| 501 | def tearDown(self): |
| 502 | if self.dir: |
| 503 | os.rmdir(self.dir) |
| 504 | self.dir = None |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 505 | super().tearDown() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 506 | |
| 507 | class mktemped: |
| 508 | _unlink = os.unlink |
| 509 | _bflags = tempfile._bin_openflags |
| 510 | |
| 511 | def __init__(self, dir, pre, suf): |
| 512 | self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf) |
| 513 | # Create the file. This will raise an exception if it's |
| 514 | # mysteriously appeared in the meanwhile. |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 515 | os.close(os.open(self.name, self._bflags, 0o600)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 516 | |
| 517 | def __del__(self): |
| 518 | self._unlink(self.name) |
| 519 | |
| 520 | def do_create(self, pre="", suf=""): |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 521 | file = self.mktemped(self.dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 522 | |
| 523 | self.nameCheck(file.name, self.dir, pre, suf) |
| 524 | return file |
| 525 | |
| 526 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 527 | # mktemp can choose usable file names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 528 | self.do_create() |
| 529 | self.do_create(pre="a") |
| 530 | self.do_create(suf="b") |
| 531 | self.do_create(pre="a", suf="b") |
| 532 | self.do_create(pre="aa", suf=".txt") |
| 533 | |
| 534 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 535 | # mktemp can choose many usable file names (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 536 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 537 | for i in extant: |
| 538 | extant[i] = self.do_create(pre="aa") |
| 539 | |
Fred Drake | 8bec483 | 2002-11-22 20:13:43 +0000 | [diff] [blame] | 540 | ## def test_warning(self): |
| 541 | ## # mktemp issues a warning when used |
| 542 | ## warnings.filterwarnings("error", |
| 543 | ## category=RuntimeWarning, |
| 544 | ## message="mktemp") |
| 545 | ## self.assertRaises(RuntimeWarning, |
| 546 | ## tempfile.mktemp, dir=self.dir) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 547 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 548 | |
| 549 | # We test _TemporaryFileWrapper by testing NamedTemporaryFile. |
| 550 | |
| 551 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 552 | class TestNamedTemporaryFile(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 553 | """Test NamedTemporaryFile().""" |
| 554 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 555 | def do_create(self, dir=None, pre="", suf="", delete=True): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 556 | if dir is None: |
| 557 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 558 | file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf, |
| 559 | delete=delete) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 560 | |
| 561 | self.nameCheck(file.name, dir, pre, suf) |
| 562 | return file |
| 563 | |
| 564 | |
| 565 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 566 | # NamedTemporaryFile can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 567 | self.do_create() |
| 568 | self.do_create(pre="a") |
| 569 | self.do_create(suf="b") |
| 570 | self.do_create(pre="a", suf="b") |
| 571 | self.do_create(pre="aa", suf=".txt") |
| 572 | |
| 573 | def test_creates_named(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 574 | # NamedTemporaryFile creates files with names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 575 | f = tempfile.NamedTemporaryFile() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 576 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 577 | "NamedTemporaryFile %s does not exist" % f.name) |
| 578 | |
| 579 | def test_del_on_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 580 | # A NamedTemporaryFile is deleted when closed |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 581 | dir = tempfile.mkdtemp() |
| 582 | try: |
| 583 | f = tempfile.NamedTemporaryFile(dir=dir) |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 584 | f.write(b'blat') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 585 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 586 | self.assertFalse(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 587 | "NamedTemporaryFile %s exists after close" % f.name) |
| 588 | finally: |
| 589 | os.rmdir(dir) |
| 590 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 591 | def test_dis_del_on_close(self): |
| 592 | # Tests that delete-on-close can be disabled |
| 593 | dir = tempfile.mkdtemp() |
| 594 | tmp = None |
| 595 | try: |
| 596 | f = tempfile.NamedTemporaryFile(dir=dir, delete=False) |
| 597 | tmp = f.name |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 598 | f.write(b'blat') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 599 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 600 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 601 | "NamedTemporaryFile %s missing after close" % f.name) |
| 602 | finally: |
| 603 | if tmp is not None: |
| 604 | os.unlink(tmp) |
| 605 | os.rmdir(dir) |
| 606 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 607 | def test_multiple_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 608 | # A NamedTemporaryFile can be closed many times without error |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 609 | f = tempfile.NamedTemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 610 | f.write(b'abc\n') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 611 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 612 | f.close() |
| 613 | f.close() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 614 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 615 | def test_context_manager(self): |
| 616 | # A NamedTemporaryFile can be used as a context manager |
| 617 | with tempfile.NamedTemporaryFile() as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 618 | self.assertTrue(os.path.exists(f.name)) |
| 619 | self.assertFalse(os.path.exists(f.name)) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 620 | def use_closed(): |
| 621 | with f: |
| 622 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 623 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 624 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 625 | # How to test the mode and bufsize parameters? |
| 626 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 627 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 628 | class TestSpooledTemporaryFile(BaseTestCase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 629 | """Test SpooledTemporaryFile().""" |
| 630 | |
| 631 | def do_create(self, max_size=0, dir=None, pre="", suf=""): |
| 632 | if dir is None: |
| 633 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 634 | file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 635 | |
| 636 | return file |
| 637 | |
| 638 | |
| 639 | def test_basic(self): |
| 640 | # SpooledTemporaryFile can create files |
| 641 | f = self.do_create() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 642 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 643 | f = self.do_create(max_size=100, pre="a", suf=".txt") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 644 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 645 | |
| 646 | def test_del_on_close(self): |
| 647 | # A SpooledTemporaryFile is deleted when closed |
| 648 | dir = tempfile.mkdtemp() |
| 649 | try: |
| 650 | f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 651 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 652 | f.write(b'blat ' * 5) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 653 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 654 | filename = f.name |
| 655 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 656 | self.assertFalse(isinstance(filename, str) and os.path.exists(filename), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 657 | "SpooledTemporaryFile %s exists after close" % filename) |
| 658 | finally: |
| 659 | os.rmdir(dir) |
| 660 | |
| 661 | def test_rewrite_small(self): |
| 662 | # A SpooledTemporaryFile can be written to multiple within the max_size |
| 663 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 664 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 665 | for i in range(5): |
| 666 | f.seek(0, 0) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 667 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 668 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 669 | |
| 670 | def test_write_sequential(self): |
| 671 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 672 | # over afterward |
| 673 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 674 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 675 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 676 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 677 | f.write(b'x' * 10) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 678 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 679 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 680 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 681 | |
R David Murray | d89ee79 | 2011-03-14 09:55:46 -0400 | [diff] [blame] | 682 | def test_writelines(self): |
| 683 | # Verify writelines with a SpooledTemporaryFile |
| 684 | f = self.do_create() |
| 685 | f.writelines((b'x', b'y', b'z')) |
| 686 | f.seek(0) |
| 687 | buf = f.read() |
| 688 | self.assertEqual(buf, b'xyz') |
| 689 | |
| 690 | def test_writelines_sequential(self): |
| 691 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 692 | # over afterward |
| 693 | f = self.do_create(max_size=35) |
| 694 | f.writelines((b'x' * 20, b'x' * 10, b'x' * 5)) |
| 695 | self.assertFalse(f._rolled) |
| 696 | f.write(b'x') |
| 697 | self.assertTrue(f._rolled) |
| 698 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 699 | def test_sparse(self): |
| 700 | # A SpooledTemporaryFile that is written late in the file will extend |
| 701 | # when that occurs |
| 702 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 703 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 704 | f.seek(100, 0) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 705 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 706 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 707 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 708 | |
| 709 | def test_fileno(self): |
| 710 | # A SpooledTemporaryFile should roll over to a real file on fileno() |
| 711 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 712 | self.assertFalse(f._rolled) |
| 713 | self.assertTrue(f.fileno() > 0) |
| 714 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 715 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 716 | def test_multiple_close_before_rollover(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 717 | # A SpooledTemporaryFile can be closed many times without error |
| 718 | f = tempfile.SpooledTemporaryFile() |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 719 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 720 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 721 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 722 | f.close() |
| 723 | f.close() |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 724 | |
| 725 | def test_multiple_close_after_rollover(self): |
| 726 | # A SpooledTemporaryFile can be closed many times without error |
| 727 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 728 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 729 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 730 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 731 | f.close() |
| 732 | f.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 733 | |
| 734 | def test_bound_methods(self): |
| 735 | # It should be OK to steal a bound method from a SpooledTemporaryFile |
| 736 | # and use it independently; when the file rolls over, those bound |
| 737 | # methods should continue to function |
| 738 | f = self.do_create(max_size=30) |
| 739 | read = f.read |
| 740 | write = f.write |
| 741 | seek = f.seek |
| 742 | |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 743 | write(b"a" * 35) |
| 744 | write(b"b" * 35) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 745 | seek(0, 0) |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 746 | self.assertEqual(read(70), b'a'*35 + b'b'*35) |
| 747 | |
| 748 | def test_text_mode(self): |
| 749 | # Creating a SpooledTemporaryFile with a text mode should produce |
| 750 | # a file object reading and writing (Unicode) text strings. |
| 751 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10) |
| 752 | f.write("abc\n") |
| 753 | f.seek(0) |
| 754 | self.assertEqual(f.read(), "abc\n") |
| 755 | f.write("def\n") |
| 756 | f.seek(0) |
| 757 | self.assertEqual(f.read(), "abc\ndef\n") |
| 758 | f.write("xyzzy\n") |
| 759 | f.seek(0) |
| 760 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\n") |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 761 | # Check that Ctrl+Z doesn't truncate the file |
| 762 | f.write("foo\x1abar\n") |
| 763 | f.seek(0) |
| 764 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n") |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 765 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 766 | def test_text_newline_and_encoding(self): |
| 767 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10, |
| 768 | newline='', encoding='utf-8') |
| 769 | f.write("\u039B\r\n") |
| 770 | f.seek(0) |
| 771 | self.assertEqual(f.read(), "\u039B\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 772 | self.assertFalse(f._rolled) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 773 | |
| 774 | f.write("\u039B" * 20 + "\r\n") |
| 775 | f.seek(0) |
| 776 | self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 777 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 778 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 779 | def test_context_manager_before_rollover(self): |
| 780 | # A SpooledTemporaryFile can be used as a context manager |
| 781 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 782 | self.assertFalse(f._rolled) |
| 783 | self.assertFalse(f.closed) |
| 784 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 785 | def use_closed(): |
| 786 | with f: |
| 787 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 788 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 789 | |
| 790 | def test_context_manager_during_rollover(self): |
| 791 | # A SpooledTemporaryFile can be used as a context manager |
| 792 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 793 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 794 | f.write(b'abc\n') |
| 795 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 796 | self.assertTrue(f._rolled) |
| 797 | self.assertFalse(f.closed) |
| 798 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 799 | def use_closed(): |
| 800 | with f: |
| 801 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 802 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 803 | |
| 804 | def test_context_manager_after_rollover(self): |
| 805 | # A SpooledTemporaryFile can be used as a context manager |
| 806 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 807 | f.write(b'abc\n') |
| 808 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 809 | self.assertTrue(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 810 | with f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 811 | self.assertFalse(f.closed) |
| 812 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 813 | def use_closed(): |
| 814 | with f: |
| 815 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 816 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 817 | |
Antoine Pitrou | 0e86a58 | 2011-11-25 18:03:09 +0100 | [diff] [blame] | 818 | def test_truncate_with_size_parameter(self): |
| 819 | # A SpooledTemporaryFile can be truncated to zero size |
| 820 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 821 | f.write(b'abcdefg\n') |
| 822 | f.seek(0) |
| 823 | f.truncate() |
| 824 | self.assertFalse(f._rolled) |
| 825 | self.assertEqual(f._file.getvalue(), b'') |
| 826 | # A SpooledTemporaryFile can be truncated to a specific size |
| 827 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 828 | f.write(b'abcdefg\n') |
| 829 | f.truncate(4) |
| 830 | self.assertFalse(f._rolled) |
| 831 | self.assertEqual(f._file.getvalue(), b'abcd') |
| 832 | # A SpooledTemporaryFile rolls over if truncated to large size |
| 833 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 834 | f.write(b'abcdefg\n') |
| 835 | f.truncate(20) |
| 836 | self.assertTrue(f._rolled) |
| 837 | if has_stat: |
| 838 | self.assertEqual(os.fstat(f.fileno()).st_size, 20) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 839 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 840 | |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 841 | if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile: |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 842 | |
| 843 | class TestTemporaryFile(BaseTestCase): |
| 844 | """Test TemporaryFile().""" |
| 845 | |
| 846 | def test_basic(self): |
| 847 | # TemporaryFile can create files |
| 848 | # No point in testing the name params - the file has no name. |
| 849 | tempfile.TemporaryFile() |
| 850 | |
| 851 | def test_has_no_name(self): |
| 852 | # TemporaryFile creates files with no names (on this system) |
| 853 | dir = tempfile.mkdtemp() |
| 854 | f = tempfile.TemporaryFile(dir=dir) |
| 855 | f.write(b'blat') |
| 856 | |
| 857 | # Sneaky: because this file has no name, it should not prevent |
| 858 | # us from removing the directory it was created in. |
| 859 | try: |
| 860 | os.rmdir(dir) |
| 861 | except: |
| 862 | # cleanup |
| 863 | f.close() |
| 864 | os.rmdir(dir) |
| 865 | raise |
| 866 | |
| 867 | def test_multiple_close(self): |
| 868 | # A TemporaryFile can be closed many times without error |
| 869 | f = tempfile.TemporaryFile() |
| 870 | f.write(b'abc\n') |
| 871 | f.close() |
| 872 | f.close() |
| 873 | f.close() |
| 874 | |
| 875 | # How to test the mode and bufsize parameters? |
| 876 | def test_mode_and_encoding(self): |
| 877 | |
| 878 | def roundtrip(input, *args, **kwargs): |
| 879 | with tempfile.TemporaryFile(*args, **kwargs) as fileobj: |
| 880 | fileobj.write(input) |
| 881 | fileobj.seek(0) |
| 882 | self.assertEqual(input, fileobj.read()) |
| 883 | |
| 884 | roundtrip(b"1234", "w+b") |
| 885 | roundtrip("abdc\n", "w+") |
| 886 | roundtrip("\u039B", "w+", encoding="utf-16") |
| 887 | roundtrip("foo\r\n", "w+", newline="") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 888 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 889 | |
| 890 | # Helper for test_del_on_shutdown |
| 891 | class NulledModules: |
| 892 | def __init__(self, *modules): |
| 893 | self.refs = [mod.__dict__ for mod in modules] |
| 894 | self.contents = [ref.copy() for ref in self.refs] |
| 895 | |
| 896 | def __enter__(self): |
| 897 | for d in self.refs: |
| 898 | for key in d: |
| 899 | d[key] = None |
| 900 | |
| 901 | def __exit__(self, *exc_info): |
| 902 | for d, c in zip(self.refs, self.contents): |
| 903 | d.clear() |
| 904 | d.update(c) |
| 905 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 906 | class TestTemporaryDirectory(BaseTestCase): |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 907 | """Test TemporaryDirectory().""" |
| 908 | |
| 909 | def do_create(self, dir=None, pre="", suf="", recurse=1): |
| 910 | if dir is None: |
| 911 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 912 | tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 913 | self.nameCheck(tmp.name, dir, pre, suf) |
| 914 | # Create a subdirectory and some files |
| 915 | if recurse: |
| 916 | self.do_create(tmp.name, pre, suf, recurse-1) |
| 917 | with open(os.path.join(tmp.name, "test.txt"), "wb") as f: |
| 918 | f.write(b"Hello world!") |
| 919 | return tmp |
| 920 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 921 | def test_mkdtemp_failure(self): |
| 922 | # Check no additional exception if mkdtemp fails |
| 923 | # Previously would raise AttributeError instead |
Nick Coghlan | 3c54ea6 | 2010-12-13 03:02:43 +0000 | [diff] [blame] | 924 | # (noted as part of Issue #10188) |
| 925 | with tempfile.TemporaryDirectory() as nonexistent: |
| 926 | pass |
| 927 | with self.assertRaises(os.error): |
| 928 | tempfile.TemporaryDirectory(dir=nonexistent) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 929 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 930 | def test_explicit_cleanup(self): |
| 931 | # A TemporaryDirectory is deleted when cleaned up |
| 932 | dir = tempfile.mkdtemp() |
| 933 | try: |
| 934 | d = self.do_create(dir=dir) |
| 935 | self.assertTrue(os.path.exists(d.name), |
| 936 | "TemporaryDirectory %s does not exist" % d.name) |
| 937 | d.cleanup() |
| 938 | self.assertFalse(os.path.exists(d.name), |
| 939 | "TemporaryDirectory %s exists after cleanup" % d.name) |
| 940 | finally: |
| 941 | os.rmdir(dir) |
| 942 | |
Charles-François Natali | def3543 | 2011-07-29 18:59:24 +0200 | [diff] [blame] | 943 | @support.skip_unless_symlink |
| 944 | def test_cleanup_with_symlink_to_a_directory(self): |
| 945 | # cleanup() should not follow symlinks to directories (issue #12464) |
| 946 | d1 = self.do_create() |
| 947 | d2 = self.do_create() |
| 948 | |
| 949 | # Symlink d1/foo -> d2 |
| 950 | os.symlink(d2.name, os.path.join(d1.name, "foo")) |
| 951 | |
| 952 | # This call to cleanup() should not follow the "foo" symlink |
| 953 | d1.cleanup() |
| 954 | |
| 955 | self.assertFalse(os.path.exists(d1.name), |
| 956 | "TemporaryDirectory %s exists after cleanup" % d1.name) |
| 957 | self.assertTrue(os.path.exists(d2.name), |
| 958 | "Directory pointed to by a symlink was deleted") |
| 959 | self.assertEqual(os.listdir(d2.name), ['test.txt'], |
| 960 | "Contents of the directory pointed to by a symlink " |
| 961 | "were deleted") |
| 962 | d2.cleanup() |
| 963 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 964 | @support.cpython_only |
| 965 | def test_del_on_collection(self): |
| 966 | # A TemporaryDirectory is deleted when garbage collected |
| 967 | dir = tempfile.mkdtemp() |
| 968 | try: |
| 969 | d = self.do_create(dir=dir) |
| 970 | name = d.name |
| 971 | del d # Rely on refcounting to invoke __del__ |
| 972 | self.assertFalse(os.path.exists(name), |
| 973 | "TemporaryDirectory %s exists after __del__" % name) |
| 974 | finally: |
| 975 | os.rmdir(dir) |
| 976 | |
| 977 | @unittest.expectedFailure # See issue #10188 |
| 978 | def test_del_on_shutdown(self): |
| 979 | # A TemporaryDirectory may be cleaned up during shutdown |
| 980 | # Make sure it works with the relevant modules nulled out |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 981 | with self.do_create() as dir: |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 982 | d = self.do_create(dir=dir) |
| 983 | # Mimic the nulling out of modules that |
| 984 | # occurs during system shutdown |
| 985 | modules = [os, os.path] |
| 986 | if has_stat: |
| 987 | modules.append(stat) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 988 | # Currently broken, so suppress the warning |
| 989 | # that is otherwise emitted on stdout |
| 990 | with support.captured_stderr() as err: |
| 991 | with NulledModules(*modules): |
| 992 | d.cleanup() |
| 993 | # Currently broken, so stop spurious exception by |
| 994 | # indicating the object has already been closed |
| 995 | d._closed = True |
| 996 | # And this assert will fail, as expected by the |
| 997 | # unittest decorator... |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 998 | self.assertFalse(os.path.exists(d.name), |
| 999 | "TemporaryDirectory %s exists after cleanup" % d.name) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1000 | |
| 1001 | def test_warnings_on_cleanup(self): |
| 1002 | # Two kinds of warning on shutdown |
| 1003 | # Issue 10888: may write to stderr if modules are nulled out |
| 1004 | # ResourceWarning will be triggered by __del__ |
| 1005 | with self.do_create() as dir: |
Nick Coghlan | e98e8a3 | 2010-12-13 16:32:51 +0000 | [diff] [blame] | 1006 | if os.sep != '\\': |
| 1007 | # Embed a backslash in order to make sure string escaping |
| 1008 | # in the displayed error message is dealt with correctly |
| 1009 | suffix = '\\check_backslash_handling' |
| 1010 | else: |
| 1011 | suffix = '' |
| 1012 | d = self.do_create(dir=dir, suf=suffix) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1013 | |
| 1014 | #Check for the Issue 10888 message |
| 1015 | modules = [os, os.path] |
| 1016 | if has_stat: |
| 1017 | modules.append(stat) |
| 1018 | with support.captured_stderr() as err: |
| 1019 | with NulledModules(*modules): |
| 1020 | d.cleanup() |
Nick Coghlan | e98e8a3 | 2010-12-13 16:32:51 +0000 | [diff] [blame] | 1021 | message = err.getvalue().replace('\\\\', '\\') |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1022 | self.assertIn("while cleaning up", message) |
| 1023 | self.assertIn(d.name, message) |
| 1024 | |
| 1025 | # Check for the resource warning |
| 1026 | with support.check_warnings(('Implicitly', ResourceWarning), quiet=False): |
| 1027 | warnings.filterwarnings("always", category=ResourceWarning) |
| 1028 | d.__del__() |
| 1029 | self.assertFalse(os.path.exists(d.name), |
| 1030 | "TemporaryDirectory %s exists after __del__" % d.name) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1031 | |
| 1032 | def test_multiple_close(self): |
| 1033 | # Can be cleaned-up many times without error |
| 1034 | d = self.do_create() |
| 1035 | d.cleanup() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1036 | d.cleanup() |
| 1037 | d.cleanup() |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1038 | |
| 1039 | def test_context_manager(self): |
| 1040 | # Can be used as a context manager |
| 1041 | d = self.do_create() |
| 1042 | with d as name: |
| 1043 | self.assertTrue(os.path.exists(name)) |
| 1044 | self.assertEqual(name, d.name) |
| 1045 | self.assertFalse(os.path.exists(name)) |
| 1046 | |
| 1047 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1048 | def test_main(): |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1049 | support.run_unittest(__name__) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1050 | |
| 1051 | if __name__ == "__main__": |
| 1052 | test_main() |