blob: 1b219c871703eea2e8a9f8cf44ba8837781141c4 [file] [log] [blame]
Guido van Rossum0e548712002-08-09 16:14:33 +00001# tempfile.py unit tests.
Tim Petersc57a2852001-10-29 21:46:08 +00002import tempfile
Guido van Rossum0e548712002-08-09 16:14:33 +00003import os
Antoine Pitroua5d5bb92011-11-25 21:28:15 +01004import signal
Guido van Rossum0e548712002-08-09 16:14:33 +00005import sys
6import re
Guido van Rossum0e548712002-08-09 16:14:33 +00007import warnings
Tim Petersc57a2852001-10-29 21:46:08 +00008
Guido van Rossum0e548712002-08-09 16:14:33 +00009import unittest
10from test import test_support
11
Fred Drake7633d232002-10-17 22:09:03 +000012warnings.filterwarnings("ignore",
13 category=RuntimeWarning,
14 message="mktemp", module=__name__)
15
Guido van Rossum0e548712002-08-09 16:14:33 +000016if hasattr(os, 'stat'):
17 import stat
18 has_stat = 1
19else:
20 has_stat = 0
21
22has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000023has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000024
Neal Norwitz68ee0122002-08-16 19:28:59 +000025# 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)
Ronald Oussoren9545a232010-05-05 19:09:31 +000027if sys.platform in ('openbsd3', 'openbsd4'):
Martin v. Löwis99968282004-09-15 06:02:54 +000028 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000029else:
30 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000031
Guido van Rossum0e548712002-08-09 16:14:33 +000032# 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.
37class TC(unittest.TestCase):
38
39 str_check = re.compile(r"[a-zA-Z0-9_-]{6}$")
40
41 def failOnException(self, what, ei=None):
42 if ei is None:
43 ei = sys.exc_info()
44 self.fail("%s raised %s: %s" % (what, ei[0], ei[1]))
45
46 def nameCheck(self, name, dir, pre, suf):
47 (ndir, nbase) = os.path.split(name)
48 npre = nbase[:len(pre)]
49 nsuf = nbase[len(nbase)-len(suf):]
50
Martin v. Löwisd6625482003-10-12 17:37:01 +000051 # check for equality of the absolute paths!
52 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +000053 "file '%s' not in directory '%s'" % (name, dir))
54 self.assertEqual(npre, pre,
55 "file '%s' does not begin with '%s'" % (nbase, pre))
56 self.assertEqual(nsuf, suf,
57 "file '%s' does not end with '%s'" % (nbase, suf))
58
59 nbase = nbase[len(pre):len(nbase)-len(suf)]
Benjamin Peterson5c8da862009-06-30 22:57:08 +000060 self.assertTrue(self.str_check.match(nbase),
Guido van Rossum0e548712002-08-09 16:14:33 +000061 "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/"
62 % nbase)
63
64test_classes = []
65
66class test_exports(TC):
67 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +000068 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +000069 dict = tempfile.__dict__
70
71 expected = {
72 "NamedTemporaryFile" : 1,
73 "TemporaryFile" : 1,
74 "mkstemp" : 1,
75 "mkdtemp" : 1,
76 "mktemp" : 1,
77 "TMP_MAX" : 1,
78 "gettempprefix" : 1,
79 "gettempdir" : 1,
80 "tempdir" : 1,
Collin Wintera8785cc2007-03-19 18:52:08 +000081 "template" : 1,
82 "SpooledTemporaryFile" : 1
Guido van Rossum0e548712002-08-09 16:14:33 +000083 }
84
85 unexp = []
86 for key in dict:
87 if key[0] != '_' and key not in expected:
88 unexp.append(key)
Benjamin Peterson5c8da862009-06-30 22:57:08 +000089 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +000090 "unexpected keys: %s" % unexp)
91
92test_classes.append(test_exports)
93
94
Guido van Rossum0e548712002-08-09 16:14:33 +000095class test__RandomNameSequence(TC):
96 """Test the internal iterator object _RandomNameSequence."""
97
98 def setUp(self):
99 self.r = tempfile._RandomNameSequence()
100
101 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000102 # _RandomNameSequence returns a six-character string
Guido van Rossum0e548712002-08-09 16:14:33 +0000103 s = self.r.next()
104 self.nameCheck(s, '', '', '')
105
106 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000107 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000108
109 dict = {}
110 r = self.r
Neal Norwitz68ee0122002-08-16 19:28:59 +0000111 for i in xrange(TEST_FILES):
Guido van Rossum0e548712002-08-09 16:14:33 +0000112 s = r.next()
113 self.nameCheck(s, '', '', '')
Ezio Melottiaa980582010-01-23 23:04:36 +0000114 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000115 dict[s] = 1
116
117 def test_supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000118 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000119
120 i = 0
121 r = self.r
122 try:
123 for s in r:
124 i += 1
125 if i == 20:
126 break
127 except:
Georg Brandld10d8ee2010-02-06 23:18:00 +0000128 self.failOnException("iteration")
Guido van Rossum0e548712002-08-09 16:14:33 +0000129
Antoine Pitroua5d5bb92011-11-25 21:28:15 +0100130 @unittest.skipUnless(hasattr(os, 'fork'),
131 "os.fork is required for this test")
132 def test_process_awareness(self):
133 # ensure that the random source differs between
134 # child and parent.
135 read_fd, write_fd = os.pipe()
136 pid = None
137 try:
138 pid = os.fork()
139 if not pid:
140 os.close(read_fd)
141 os.write(write_fd, next(self.r).encode("ascii"))
142 os.close(write_fd)
143 # bypass the normal exit handlers- leave those to
144 # the parent.
145 os._exit(0)
146 parent_value = next(self.r)
147 child_value = os.read(read_fd, len(parent_value)).decode("ascii")
148 finally:
149 if pid:
150 # best effort to ensure the process can't bleed out
151 # via any bugs above
152 try:
153 os.kill(pid, signal.SIGKILL)
154 except EnvironmentError:
155 pass
156 os.close(read_fd)
157 os.close(write_fd)
158 self.assertNotEqual(child_value, parent_value)
159
160
Guido van Rossum0e548712002-08-09 16:14:33 +0000161test_classes.append(test__RandomNameSequence)
162
163
164class test__candidate_tempdir_list(TC):
165 """Test the internal function _candidate_tempdir_list."""
166
167 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000168 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000169
170 cand = tempfile._candidate_tempdir_list()
171
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000172 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000173 for c in cand:
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000174 self.assertIsInstance(c, basestring)
Guido van Rossum0e548712002-08-09 16:14:33 +0000175
176 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000177 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000178
179 # Make sure the interesting environment variables are all set.
Walter Dörwald4b965f62009-04-26 20:51:44 +0000180 with test_support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000181 for envname in 'TMPDIR', 'TEMP', 'TMP':
182 dirname = os.getenv(envname)
183 if not dirname:
Walter Dörwald6733bed2009-05-01 17:35:37 +0000184 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000185
186 cand = tempfile._candidate_tempdir_list()
187
188 for envname in 'TMPDIR', 'TEMP', 'TMP':
189 dirname = os.getenv(envname)
190 if not dirname: raise ValueError
Ezio Melottiaa980582010-01-23 23:04:36 +0000191 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000192
193 try:
194 dirname = os.getcwd()
195 except (AttributeError, os.error):
196 dirname = os.curdir
197
Ezio Melottiaa980582010-01-23 23:04:36 +0000198 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000199
200 # Not practical to try to verify the presence of OS-specific
201 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000202
203test_classes.append(test__candidate_tempdir_list)
204
205
206# We test _get_default_tempdir by testing gettempdir.
207
208
209class test__get_candidate_names(TC):
210 """Test the internal function _get_candidate_names."""
211
212 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000213 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000214 obj = tempfile._get_candidate_names()
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000215 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000216
217 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000218 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000219 a = tempfile._get_candidate_names()
220 b = tempfile._get_candidate_names()
221
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000222 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000223
224test_classes.append(test__get_candidate_names)
225
226
227class test__mkstemp_inner(TC):
228 """Test the internal function _mkstemp_inner."""
229
230 class mkstemped:
231 _bflags = tempfile._bin_openflags
232 _tflags = tempfile._text_openflags
233 _close = os.close
234 _unlink = os.unlink
235
236 def __init__(self, dir, pre, suf, bin):
237 if bin: flags = self._bflags
238 else: flags = self._tflags
239
240 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
241
242 def write(self, str):
243 os.write(self.fd, str)
244
245 def __del__(self):
246 self._close(self.fd)
247 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000248
Guido van Rossum0e548712002-08-09 16:14:33 +0000249 def do_create(self, dir=None, pre="", suf="", bin=1):
250 if dir is None:
251 dir = tempfile.gettempdir()
252 try:
253 file = self.mkstemped(dir, pre, suf, bin)
254 except:
255 self.failOnException("_mkstemp_inner")
256
257 self.nameCheck(file.name, dir, pre, suf)
258 return file
259
260 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000261 # _mkstemp_inner can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000262 self.do_create().write("blat")
263 self.do_create(pre="a").write("blat")
264 self.do_create(suf="b").write("blat")
265 self.do_create(pre="a", suf="b").write("blat")
266 self.do_create(pre="aa", suf=".txt").write("blat")
267
268 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000269 # _mkstemp_inner can create many files (stochastic)
Neal Norwitz68ee0122002-08-16 19:28:59 +0000270 extant = range(TEST_FILES)
Guido van Rossum0e548712002-08-09 16:14:33 +0000271 for i in extant:
272 extant[i] = self.do_create(pre="aa")
273
274 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000275 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000276 dir = tempfile.mkdtemp()
277 try:
278 self.do_create(dir=dir).write("blat")
279 finally:
280 os.rmdir(dir)
281
282 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000283 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000284 if not has_stat:
Benjamin Peterson888a39b2009-03-26 20:48:25 +0000285 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000286
287 file = self.do_create()
288 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Tim Petersca3ac7f2002-08-09 18:13:51 +0000289 expected = 0600
Ronald Oussoren9545a232010-05-05 19:09:31 +0000290 if sys.platform in ('win32', 'os2emx'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000291 # There's no distinction among 'user', 'group' and 'world';
292 # replicate the 'user' bits.
293 user = expected >> 6
294 expected = user * (1 + 8 + 64)
295 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000296
297 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000298 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000299 if not has_spawnl:
Benjamin Peterson888a39b2009-03-26 20:48:25 +0000300 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000301
Guido van Rossum78741062002-08-17 11:41:01 +0000302 if test_support.verbose:
303 v="v"
304 else:
305 v="q"
306
Guido van Rossum0e548712002-08-09 16:14:33 +0000307 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000308 fd = "%d" % file.fd
309
310 try:
311 me = __file__
312 except NameError:
313 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000314
315 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000316 # effect. The core of this test is therefore in
317 # tf_inherit_check.py, which see.
318 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
319 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000320
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000321 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
322 # but an arg with embedded spaces should be decorated with double
323 # quotes on each end
Armin Rigo66d41b22007-12-07 19:19:55 +0000324 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000325 decorated = '"%s"' % sys.executable
326 tester = '"%s"' % tester
327 else:
328 decorated = sys.executable
329
330 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000331 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000332 "child process caught fatal signal %d" % -retval)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000333 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000334
335 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000336 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000337 if not has_textmode:
Benjamin Peterson888a39b2009-03-26 20:48:25 +0000338 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000339
340 self.do_create(bin=0).write("blat\n")
341 # XXX should test that the file really is a text file
342
343test_classes.append(test__mkstemp_inner)
344
345
346class test_gettempprefix(TC):
347 """Test gettempprefix()."""
348
349 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000350 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000351 p = tempfile.gettempprefix()
352
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000353 self.assertIsInstance(p, basestring)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000354 self.assertTrue(len(p) > 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000355
356 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000357 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000358
359 # Create a temp directory, avoiding use of the prefix.
360 # Then attempt to create a file whose name is
361 # prefix + 'xxxxxx.xxx' in that directory.
362 p = tempfile.gettempprefix() + "xxxxxx.xxx"
363 d = tempfile.mkdtemp(prefix="")
364 try:
365 p = os.path.join(d, p)
366 try:
367 fd = os.open(p, os.O_RDWR | os.O_CREAT)
368 except:
369 self.failOnException("os.open")
370 os.close(fd)
371 os.unlink(p)
372 finally:
373 os.rmdir(d)
374
375test_classes.append(test_gettempprefix)
376
377
378class test_gettempdir(TC):
379 """Test gettempdir()."""
380
381 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000382 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000383
384 dir = tempfile.gettempdir()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000385 self.assertTrue(os.path.isabs(dir) or dir == os.curdir,
Guido van Rossum0e548712002-08-09 16:14:33 +0000386 "%s is not an absolute path" % dir)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000387 self.assertTrue(os.path.isdir(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +0000388 "%s is not a directory" % dir)
389
390 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000391 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000392
393 # sneaky: just instantiate a NamedTemporaryFile, which
394 # defaults to writing into the directory returned by
395 # gettempdir.
396 try:
397 file = tempfile.NamedTemporaryFile()
398 file.write("blat")
399 file.close()
400 except:
401 self.failOnException("create file in %s" % tempfile.gettempdir())
402
403 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000404 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000405 a = tempfile.gettempdir()
406 b = tempfile.gettempdir()
407
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000408 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000409
410test_classes.append(test_gettempdir)
411
412
413class test_mkstemp(TC):
414 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000415
Martin Blais215f13d2006-06-06 12:46:55 +0000416 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000417 if dir is None:
418 dir = tempfile.gettempdir()
419 try:
420 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000421 (ndir, nbase) = os.path.split(name)
422 adir = os.path.abspath(dir)
423 self.assertEqual(adir, ndir,
424 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000425 except:
426 self.failOnException("mkstemp")
427
428 try:
429 self.nameCheck(name, dir, pre, suf)
430 finally:
431 os.close(fd)
432 os.unlink(name)
433
434 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000435 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000436 self.do_create()
437 self.do_create(pre="a")
438 self.do_create(suf="b")
439 self.do_create(pre="a", suf="b")
440 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000441 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000442
443 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000444 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000445 dir = tempfile.mkdtemp()
446 try:
447 self.do_create(dir=dir)
448 finally:
449 os.rmdir(dir)
450
451test_classes.append(test_mkstemp)
452
453
454class test_mkdtemp(TC):
455 """Test mkdtemp()."""
456
457 def do_create(self, dir=None, pre="", suf=""):
458 if dir is None:
459 dir = tempfile.gettempdir()
460 try:
461 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
462 except:
463 self.failOnException("mkdtemp")
464
465 try:
466 self.nameCheck(name, dir, pre, suf)
467 return name
468 except:
469 os.rmdir(name)
470 raise
471
472 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000473 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000474 os.rmdir(self.do_create())
475 os.rmdir(self.do_create(pre="a"))
476 os.rmdir(self.do_create(suf="b"))
477 os.rmdir(self.do_create(pre="a", suf="b"))
478 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000479
Guido van Rossum0e548712002-08-09 16:14:33 +0000480 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000481 # mkdtemp can create many directories (stochastic)
Neal Norwitz68ee0122002-08-16 19:28:59 +0000482 extant = range(TEST_FILES)
Guido van Rossum0e548712002-08-09 16:14:33 +0000483 try:
484 for i in extant:
485 extant[i] = self.do_create(pre="aa")
486 finally:
487 for i in extant:
488 if(isinstance(i, basestring)):
489 os.rmdir(i)
490
491 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000492 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000493 dir = tempfile.mkdtemp()
494 try:
495 os.rmdir(self.do_create(dir=dir))
496 finally:
497 os.rmdir(dir)
498
499 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000500 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000501 if not has_stat:
Benjamin Peterson888a39b2009-03-26 20:48:25 +0000502 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000503
504 dir = self.do_create()
505 try:
506 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossum59db96f2004-03-31 18:53:29 +0000507 mode &= 0777 # Mask off sticky bits inherited from /tmp
Tim Petersca3ac7f2002-08-09 18:13:51 +0000508 expected = 0700
Ronald Oussoren9545a232010-05-05 19:09:31 +0000509 if sys.platform in ('win32', 'os2emx'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000510 # There's no distinction among 'user', 'group' and 'world';
511 # replicate the 'user' bits.
512 user = expected >> 6
513 expected = user * (1 + 8 + 64)
514 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000515 finally:
516 os.rmdir(dir)
517
518test_classes.append(test_mkdtemp)
519
520
521class test_mktemp(TC):
522 """Test mktemp()."""
523
524 # For safety, all use of mktemp must occur in a private directory.
525 # We must also suppress the RuntimeWarning it generates.
526 def setUp(self):
527 self.dir = tempfile.mkdtemp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000528
529 def tearDown(self):
530 if self.dir:
531 os.rmdir(self.dir)
532 self.dir = None
Guido van Rossum0e548712002-08-09 16:14:33 +0000533
534 class mktemped:
535 _unlink = os.unlink
536 _bflags = tempfile._bin_openflags
537
538 def __init__(self, dir, pre, suf):
539 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
540 # Create the file. This will raise an exception if it's
541 # mysteriously appeared in the meanwhile.
542 os.close(os.open(self.name, self._bflags, 0600))
543
544 def __del__(self):
545 self._unlink(self.name)
546
547 def do_create(self, pre="", suf=""):
548 try:
549 file = self.mktemped(self.dir, pre, suf)
550 except:
551 self.failOnException("mktemp")
552
553 self.nameCheck(file.name, self.dir, pre, suf)
554 return file
555
556 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000557 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000558 self.do_create()
559 self.do_create(pre="a")
560 self.do_create(suf="b")
561 self.do_create(pre="a", suf="b")
562 self.do_create(pre="aa", suf=".txt")
563
564 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000565 # mktemp can choose many usable file names (stochastic)
Neal Norwitz68ee0122002-08-16 19:28:59 +0000566 extant = range(TEST_FILES)
Guido van Rossum0e548712002-08-09 16:14:33 +0000567 for i in extant:
568 extant[i] = self.do_create(pre="aa")
569
Fred Drake8bec4832002-11-22 20:13:43 +0000570## def test_warning(self):
571## # mktemp issues a warning when used
572## warnings.filterwarnings("error",
573## category=RuntimeWarning,
574## message="mktemp")
575## self.assertRaises(RuntimeWarning,
576## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000577
578test_classes.append(test_mktemp)
579
580
581# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
582
583
584class test_NamedTemporaryFile(TC):
585 """Test NamedTemporaryFile()."""
586
Georg Brandl35ef9c12007-03-13 18:31:49 +0000587 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000588 if dir is None:
589 dir = tempfile.gettempdir()
590 try:
Georg Brandl35ef9c12007-03-13 18:31:49 +0000591 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
Georg Brandl4168c042007-03-13 19:18:18 +0000592 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000593 except:
594 self.failOnException("NamedTemporaryFile")
595
596 self.nameCheck(file.name, dir, pre, suf)
597 return file
598
599
600 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000601 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000602 self.do_create()
603 self.do_create(pre="a")
604 self.do_create(suf="b")
605 self.do_create(pre="a", suf="b")
606 self.do_create(pre="aa", suf=".txt")
607
608 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000609 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000610 f = tempfile.NamedTemporaryFile()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000611 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000612 "NamedTemporaryFile %s does not exist" % f.name)
613
614 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000615 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000616 dir = tempfile.mkdtemp()
617 try:
618 f = tempfile.NamedTemporaryFile(dir=dir)
619 f.write('blat')
620 f.close()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000621 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000622 "NamedTemporaryFile %s exists after close" % f.name)
623 finally:
624 os.rmdir(dir)
625
Georg Brandl35ef9c12007-03-13 18:31:49 +0000626 def test_dis_del_on_close(self):
627 # Tests that delete-on-close can be disabled
628 dir = tempfile.mkdtemp()
Georg Brandl4168c042007-03-13 19:18:18 +0000629 tmp = None
Georg Brandl35ef9c12007-03-13 18:31:49 +0000630 try:
631 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
632 tmp = f.name
633 f.write('blat')
634 f.close()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000635 self.assertTrue(os.path.exists(f.name),
Georg Brandl35ef9c12007-03-13 18:31:49 +0000636 "NamedTemporaryFile %s missing after close" % f.name)
637 finally:
638 if tmp is not None:
639 os.unlink(tmp)
640 os.rmdir(dir)
641
Guido van Rossum0e548712002-08-09 16:14:33 +0000642 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000643 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000644 f = tempfile.NamedTemporaryFile()
645 f.write('abc\n')
646 f.close()
647 try:
648 f.close()
649 f.close()
650 except:
651 self.failOnException("close")
652
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000653 def test_context_manager(self):
654 # A NamedTemporaryFile can be used as a context manager
655 with tempfile.NamedTemporaryFile() as f:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000656 self.assertTrue(os.path.exists(f.name))
657 self.assertFalse(os.path.exists(f.name))
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000658 def use_closed():
659 with f:
660 pass
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000661 self.assertRaises(ValueError, use_closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000662
Guido van Rossum0e548712002-08-09 16:14:33 +0000663 # How to test the mode and bufsize parameters?
664
665test_classes.append(test_NamedTemporaryFile)
666
Collin Wintera8785cc2007-03-19 18:52:08 +0000667class test_SpooledTemporaryFile(TC):
668 """Test SpooledTemporaryFile()."""
669
670 def do_create(self, max_size=0, dir=None, pre="", suf=""):
671 if dir is None:
672 dir = tempfile.gettempdir()
673 try:
674 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
675 except:
676 self.failOnException("SpooledTemporaryFile")
677
678 return file
679
680
681 def test_basic(self):
682 # SpooledTemporaryFile can create files
683 f = self.do_create()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000684 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000685 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000686 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000687
688 def test_del_on_close(self):
689 # A SpooledTemporaryFile is deleted when closed
690 dir = tempfile.mkdtemp()
691 try:
692 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000693 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000694 f.write('blat ' * 5)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000695 self.assertTrue(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000696 filename = f.name
697 f.close()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000698 self.assertFalse(os.path.exists(filename),
Collin Wintera8785cc2007-03-19 18:52:08 +0000699 "SpooledTemporaryFile %s exists after close" % filename)
700 finally:
701 os.rmdir(dir)
702
703 def test_rewrite_small(self):
704 # A SpooledTemporaryFile can be written to multiple within the max_size
705 f = self.do_create(max_size=30)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000706 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000707 for i in range(5):
708 f.seek(0, 0)
709 f.write('x' * 20)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000710 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000711
712 def test_write_sequential(self):
713 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
714 # over afterward
715 f = self.do_create(max_size=30)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000716 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000717 f.write('x' * 20)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000718 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000719 f.write('x' * 10)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000720 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000721 f.write('x')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000722 self.assertTrue(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000723
R David Murrayb44e1842011-03-14 10:01:12 -0400724 def test_writelines(self):
725 # Verify writelines with a SpooledTemporaryFile
726 f = self.do_create()
727 f.writelines((b'x', b'y', b'z'))
728 f.seek(0)
729 buf = f.read()
730 self.assertEqual(buf, b'xyz')
731
732 def test_writelines_sequential(self):
733 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
734 # over afterward
735 f = self.do_create(max_size=35)
736 f.writelines((b'x' * 20, b'x' * 10, b'x' * 5))
737 self.assertFalse(f._rolled)
738 f.write(b'x')
739 self.assertTrue(f._rolled)
740
Serhiy Storchakabeaa3ad2013-02-09 12:20:18 +0200741 def test_xreadlines(self):
742 f = self.do_create(max_size=20)
743 f.write(b'abc\n' * 5)
744 f.seek(0)
745 self.assertFalse(f._rolled)
746 self.assertEqual(list(f.xreadlines()), [b'abc\n'] * 5)
747 f.write(b'x\ny')
748 self.assertTrue(f._rolled)
749 f.seek(0)
750 self.assertEqual(list(f.xreadlines()), [b'abc\n'] * 5 + [b'x\n', b'y'])
751
Collin Wintera8785cc2007-03-19 18:52:08 +0000752 def test_sparse(self):
753 # A SpooledTemporaryFile that is written late in the file will extend
754 # when that occurs
755 f = self.do_create(max_size=30)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000756 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000757 f.seek(100, 0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000758 self.assertFalse(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000759 f.write('x')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000760 self.assertTrue(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000761
762 def test_fileno(self):
763 # A SpooledTemporaryFile should roll over to a real file on fileno()
764 f = self.do_create(max_size=30)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000765 self.assertFalse(f._rolled)
766 self.assertTrue(f.fileno() > 0)
767 self.assertTrue(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000768
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000769 def test_multiple_close_before_rollover(self):
Collin Wintera8785cc2007-03-19 18:52:08 +0000770 # A SpooledTemporaryFile can be closed many times without error
771 f = tempfile.SpooledTemporaryFile()
772 f.write('abc\n')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000773 self.assertFalse(f._rolled)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000774 f.close()
775 try:
776 f.close()
777 f.close()
778 except:
779 self.failOnException("close")
780
781 def test_multiple_close_after_rollover(self):
782 # A SpooledTemporaryFile can be closed many times without error
783 f = tempfile.SpooledTemporaryFile(max_size=1)
784 f.write('abc\n')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000785 self.assertTrue(f._rolled)
Collin Wintera8785cc2007-03-19 18:52:08 +0000786 f.close()
787 try:
788 f.close()
789 f.close()
790 except:
791 self.failOnException("close")
792
793 def test_bound_methods(self):
794 # It should be OK to steal a bound method from a SpooledTemporaryFile
795 # and use it independently; when the file rolls over, those bound
796 # methods should continue to function
797 f = self.do_create(max_size=30)
798 read = f.read
799 write = f.write
800 seek = f.seek
801
802 write("a" * 35)
803 write("b" * 35)
804 seek(0, 0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000805 self.assertTrue(read(70) == 'a'*35 + 'b'*35)
Collin Wintera8785cc2007-03-19 18:52:08 +0000806
Serhiy Storchakabeaa3ad2013-02-09 12:20:18 +0200807 def test_properties(self):
808 f = tempfile.SpooledTemporaryFile(max_size=10)
809 f.write(b'x' * 10)
810 self.assertFalse(f._rolled)
811 self.assertEqual(f.mode, 'w+b')
812 self.assertIsNone(f.name)
813 with self.assertRaises(AttributeError):
814 f.newlines
815 with self.assertRaises(AttributeError):
816 f.encoding
817
818 f.write(b'x')
819 self.assertTrue(f._rolled)
820 self.assertEqual(f.mode, 'w+b')
821 self.assertIsNotNone(f.name)
822 with self.assertRaises(AttributeError):
823 f.newlines
824 with self.assertRaises(AttributeError):
825 f.encoding
826
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000827 def test_context_manager_before_rollover(self):
828 # A SpooledTemporaryFile can be used as a context manager
829 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000830 self.assertFalse(f._rolled)
831 self.assertFalse(f.closed)
832 self.assertTrue(f.closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000833 def use_closed():
834 with f:
835 pass
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000836 self.assertRaises(ValueError, use_closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000837
838 def test_context_manager_during_rollover(self):
839 # A SpooledTemporaryFile can be used as a context manager
840 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000841 self.assertFalse(f._rolled)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000842 f.write('abc\n')
843 f.flush()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000844 self.assertTrue(f._rolled)
845 self.assertFalse(f.closed)
846 self.assertTrue(f.closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000847 def use_closed():
848 with f:
849 pass
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000850 self.assertRaises(ValueError, use_closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000851
852 def test_context_manager_after_rollover(self):
853 # A SpooledTemporaryFile can be used as a context manager
854 f = tempfile.SpooledTemporaryFile(max_size=1)
855 f.write('abc\n')
856 f.flush()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000857 self.assertTrue(f._rolled)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000858 with f:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000859 self.assertFalse(f.closed)
860 self.assertTrue(f.closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000861 def use_closed():
862 with f:
863 pass
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000864 self.assertRaises(ValueError, use_closed)
Nick Coghlan97fac3e2008-02-09 15:28:09 +0000865
866
Collin Wintera8785cc2007-03-19 18:52:08 +0000867test_classes.append(test_SpooledTemporaryFile)
868
Guido van Rossum0e548712002-08-09 16:14:33 +0000869
870class test_TemporaryFile(TC):
871 """Test TemporaryFile()."""
872
873 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000874 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000875 # No point in testing the name params - the file has no name.
876 try:
877 tempfile.TemporaryFile()
878 except:
879 self.failOnException("TemporaryFile")
880
881 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000882 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000883 dir = tempfile.mkdtemp()
884 f = tempfile.TemporaryFile(dir=dir)
885 f.write('blat')
886
887 # Sneaky: because this file has no name, it should not prevent
888 # us from removing the directory it was created in.
889 try:
890 os.rmdir(dir)
891 except:
892 ei = sys.exc_info()
893 # cleanup
894 f.close()
895 os.rmdir(dir)
896 self.failOnException("rmdir", ei)
897
898 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000899 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000900 f = tempfile.TemporaryFile()
901 f.write('abc\n')
902 f.close()
903 try:
904 f.close()
905 f.close()
906 except:
907 self.failOnException("close")
908
909 # How to test the mode and bufsize parameters?
910
Guido van Rossum0e548712002-08-09 16:14:33 +0000911
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000912if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000913 test_classes.append(test_TemporaryFile)
914
915def test_main():
Walter Dörwald21d3a322003-05-01 17:45:56 +0000916 test_support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000917
918if __name__ == "__main__":
919 test_main()