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