blob: cbf0c1647d34dc3e283858bd17019b07b8ef6606 [file] [log] [blame]
Fred Drake38c2ef02001-07-17 20:52:51 +00001# As a test suite for the os module, this is woefully inadequate, but this
2# does add tests for a few functions which have been determined to be more
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00003# portable than they had been thought to be.
Fred Drake38c2ef02001-07-17 20:52:51 +00004
5import os
Benjamin Peterson5c6d7872009-02-06 02:40:07 +00006import errno
Fred Drake38c2ef02001-07-17 20:52:51 +00007import unittest
Jeremy Hyltona7fc21b2001-08-20 20:10:01 +00008import warnings
Thomas Wouters477c8d52006-05-27 19:21:47 +00009import sys
Martin v. Löwis011e8422009-05-05 04:43:17 +000010import shutil
Benjamin Petersonee8712c2008-05-20 21:35:26 +000011from test import support
Fred Drake38c2ef02001-07-17 20:52:51 +000012
Mark Dickinson466e9262010-04-16 16:32:49 +000013# Detect whether we're on a Linux system that uses the (now outdated
14# and unmaintained) linuxthreads threading library. There's an issue
15# when combining linuxthreads with a failed execv call: see
16# http://bugs.python.org/issue4970.
17if (hasattr(os, "confstr_names") and
18 "CS_GNU_LIBPTHREAD_VERSION" in os.confstr_names):
19 libpthread = os.confstr("CS_GNU_LIBPTHREAD_VERSION")
20 USING_LINUXTHREADS= libpthread.startswith("linuxthreads")
21else:
22 USING_LINUXTHREADS= False
23
Thomas Wouters0e3f5912006-08-11 14:57:12 +000024# Tests creating TESTFN
25class FileTests(unittest.TestCase):
26 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000027 if os.path.exists(support.TESTFN):
28 os.unlink(support.TESTFN)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000029 tearDown = setUp
30
31 def test_access(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000032 f = os.open(support.TESTFN, os.O_CREAT|os.O_RDWR)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000033 os.close(f)
Georg Brandlab91fde2009-08-13 08:51:18 +000034 self.assertTrue(os.access(support.TESTFN, os.W_OK))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000035
Christian Heimesfdab48e2008-01-20 09:06:41 +000036 def test_closerange(self):
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000037 first = os.open(support.TESTFN, os.O_CREAT|os.O_RDWR)
38 # We must allocate two consecutive file descriptors, otherwise
39 # it will mess up other file descriptors (perhaps even the three
40 # standard ones).
41 second = os.dup(first)
42 try:
43 retries = 0
44 while second != first + 1:
45 os.close(first)
46 retries += 1
47 if retries > 10:
48 # XXX test skipped
Benjamin Petersonfa0d7032009-06-01 22:42:33 +000049 self.skipTest("couldn't allocate two consecutive fds")
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000050 first, second = second, os.dup(second)
51 finally:
52 os.close(second)
Christian Heimesfdab48e2008-01-20 09:06:41 +000053 # close a fd that is open, and one that isn't
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000054 os.closerange(first, first + 2)
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000055 self.assertRaises(OSError, os.write, first, b"a")
Thomas Wouters0e3f5912006-08-11 14:57:12 +000056
Hirokazu Yamamoto4c19e6e2008-09-08 23:41:21 +000057 def test_rename(self):
58 path = support.TESTFN
59 old = sys.getrefcount(path)
60 self.assertRaises(TypeError, os.rename, path, 0)
61 new = sys.getrefcount(path)
62 self.assertEqual(old, new)
63
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000064 def test_read(self):
65 with open(support.TESTFN, "w+b") as fobj:
66 fobj.write(b"spam")
67 fobj.flush()
68 fd = fobj.fileno()
69 os.lseek(fd, 0, 0)
70 s = os.read(fd, 4)
71 self.assertEqual(type(s), bytes)
72 self.assertEqual(s, b"spam")
73
74 def test_write(self):
75 # os.write() accepts bytes- and buffer-like objects but not strings
76 fd = os.open(support.TESTFN, os.O_CREAT | os.O_WRONLY)
77 self.assertRaises(TypeError, os.write, fd, "beans")
78 os.write(fd, b"bacon\n")
79 os.write(fd, bytearray(b"eggs\n"))
80 os.write(fd, memoryview(b"spam\n"))
81 os.close(fd)
82 with open(support.TESTFN, "rb") as fobj:
Antoine Pitroud62269f2008-09-15 23:54:52 +000083 self.assertEqual(fobj.read().splitlines(),
84 [b"bacon", b"eggs", b"spam"])
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000085
86
Christian Heimesdd15f6c2008-03-16 00:07:10 +000087class TemporaryFileTests(unittest.TestCase):
88 def setUp(self):
89 self.files = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +000090 os.mkdir(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000091
92 def tearDown(self):
93 for name in self.files:
94 os.unlink(name)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000095 os.rmdir(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000096
97 def check_tempfile(self, name):
98 # make sure it doesn't already exist:
Georg Brandlab91fde2009-08-13 08:51:18 +000099 self.assertFalse(os.path.exists(name),
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000100 "file already exists for temporary file")
101 # make sure we can create the file
102 open(name, "w")
103 self.files.append(name)
104
105 def test_tempnam(self):
106 if not hasattr(os, "tempnam"):
107 return
108 warnings.filterwarnings("ignore", "tempnam", RuntimeWarning,
109 r"test_os$")
110 self.check_tempfile(os.tempnam())
111
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000112 name = os.tempnam(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000113 self.check_tempfile(name)
114
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000115 name = os.tempnam(support.TESTFN, "pfx")
Georg Brandlab91fde2009-08-13 08:51:18 +0000116 self.assertTrue(os.path.basename(name)[:3] == "pfx")
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000117 self.check_tempfile(name)
118
119 def test_tmpfile(self):
120 if not hasattr(os, "tmpfile"):
121 return
122 # As with test_tmpnam() below, the Windows implementation of tmpfile()
123 # attempts to create a file in the root directory of the current drive.
124 # On Vista and Server 2008, this test will always fail for normal users
125 # as writing to the root directory requires elevated privileges. With
126 # XP and below, the semantics of tmpfile() are the same, but the user
127 # running the test is more likely to have administrative privileges on
128 # their account already. If that's the case, then os.tmpfile() should
129 # work. In order to make this test as useful as possible, rather than
130 # trying to detect Windows versions or whether or not the user has the
131 # right permissions, just try and create a file in the root directory
132 # and see if it raises a 'Permission denied' OSError. If it does, then
133 # test that a subsequent call to os.tmpfile() raises the same error. If
134 # it doesn't, assume we're on XP or below and the user running the test
135 # has administrative privileges, and proceed with the test as normal.
136 if sys.platform == 'win32':
137 name = '\\python_test_os_test_tmpfile.txt'
138 if os.path.exists(name):
139 os.remove(name)
140 try:
141 fp = open(name, 'w')
142 except IOError as first:
143 # open() failed, assert tmpfile() fails in the same way.
144 # Although open() raises an IOError and os.tmpfile() raises an
145 # OSError(), 'args' will be (13, 'Permission denied') in both
146 # cases.
147 try:
148 fp = os.tmpfile()
149 except OSError as second:
150 self.assertEqual(first.args, second.args)
151 else:
152 self.fail("expected os.tmpfile() to raise OSError")
153 return
154 else:
155 # open() worked, therefore, tmpfile() should work. Close our
156 # dummy file and proceed with the test as normal.
157 fp.close()
158 os.remove(name)
159
160 fp = os.tmpfile()
161 fp.write("foobar")
162 fp.seek(0,0)
163 s = fp.read()
164 fp.close()
Georg Brandlab91fde2009-08-13 08:51:18 +0000165 self.assertTrue(s == "foobar")
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000166
167 def test_tmpnam(self):
168 import sys
169 if not hasattr(os, "tmpnam"):
170 return
171 warnings.filterwarnings("ignore", "tmpnam", RuntimeWarning,
172 r"test_os$")
173 name = os.tmpnam()
174 if sys.platform in ("win32",):
175 # The Windows tmpnam() seems useless. From the MS docs:
176 #
177 # The character string that tmpnam creates consists of
178 # the path prefix, defined by the entry P_tmpdir in the
179 # file STDIO.H, followed by a sequence consisting of the
180 # digit characters '0' through '9'; the numerical value
181 # of this string is in the range 1 - 65,535. Changing the
182 # definitions of L_tmpnam or P_tmpdir in STDIO.H does not
183 # change the operation of tmpnam.
184 #
185 # The really bizarre part is that, at least under MSVC6,
186 # P_tmpdir is "\\". That is, the path returned refers to
187 # the root of the current drive. That's a terrible place to
188 # put temp files, and, depending on privileges, the user
189 # may not even be able to open a file in the root directory.
Georg Brandlab91fde2009-08-13 08:51:18 +0000190 self.assertFalse(os.path.exists(name),
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000191 "file already exists for temporary file")
192 else:
193 self.check_tempfile(name)
194
Amaury Forgeot d'Arce2e36ba2008-08-01 00:14:22 +0000195 def fdopen_helper(self, *args):
196 fd = os.open(support.TESTFN, os.O_RDONLY)
197 fp2 = os.fdopen(fd, *args)
198 fp2.close()
199
200 def test_fdopen(self):
201 self.fdopen_helper()
202 self.fdopen_helper('r')
203 self.fdopen_helper('r', 100)
204
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000205# Test attributes on return values from os.*stat* family.
206class StatAttributeTests(unittest.TestCase):
207 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000208 os.mkdir(support.TESTFN)
209 self.fname = os.path.join(support.TESTFN, "f1")
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000210 f = open(self.fname, 'wb')
Guido van Rossum26d95c32007-08-27 23:18:54 +0000211 f.write(b"ABC")
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000212 f.close()
Tim Peterse0c446b2001-10-18 21:57:37 +0000213
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000214 def tearDown(self):
215 os.unlink(self.fname)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000216 os.rmdir(support.TESTFN)
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000217
218 def test_stat_attributes(self):
219 if not hasattr(os, "stat"):
220 return
221
222 import stat
223 result = os.stat(self.fname)
224
225 # Make sure direct access works
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000226 self.assertEqual(result[stat.ST_SIZE], 3)
227 self.assertEqual(result.st_size, 3)
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000228
229 import sys
230
231 # Make sure all the attributes are there
232 members = dir(result)
233 for name in dir(stat):
234 if name[:3] == 'ST_':
235 attr = name.lower()
Martin v. Löwis4d394df2005-01-23 09:19:22 +0000236 if name.endswith("TIME"):
237 def trunc(x): return int(x)
238 else:
239 def trunc(x): return x
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000240 self.assertEqual(trunc(getattr(result, attr)),
241 result[getattr(stat, name)])
Georg Brandlab91fde2009-08-13 08:51:18 +0000242 self.assertTrue(attr in members)
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000243
244 try:
245 result[200]
246 self.fail("No exception thrown")
247 except IndexError:
248 pass
249
250 # Make sure that assignment fails
251 try:
252 result.st_mode = 1
253 self.fail("No exception thrown")
Collin Winter42dae6a2007-03-28 21:44:53 +0000254 except AttributeError:
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000255 pass
256
257 try:
258 result.st_rdev = 1
259 self.fail("No exception thrown")
Guido van Rossum1fff8782001-10-18 21:19:31 +0000260 except (AttributeError, TypeError):
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000261 pass
262
263 try:
264 result.parrot = 1
265 self.fail("No exception thrown")
266 except AttributeError:
267 pass
268
269 # Use the stat_result constructor with a too-short tuple.
270 try:
271 result2 = os.stat_result((10,))
272 self.fail("No exception thrown")
273 except TypeError:
274 pass
275
Ezio Melotti42da6632011-03-15 05:18:48 +0200276 # Use the constructor with a too-long tuple.
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000277 try:
278 result2 = os.stat_result((0,1,2,3,4,5,6,7,8,9,10,11,12,13,14))
279 except TypeError:
280 pass
281
Tim Peterse0c446b2001-10-18 21:57:37 +0000282
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000283 def test_statvfs_attributes(self):
284 if not hasattr(os, "statvfs"):
285 return
286
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000287 try:
288 result = os.statvfs(self.fname)
Guido van Rossumb940e112007-01-10 16:19:56 +0000289 except OSError as e:
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000290 # On AtheOS, glibc always returns ENOSYS
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000291 if e.errno == errno.ENOSYS:
292 return
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000293
294 # Make sure direct access works
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000295 self.assertEqual(result.f_bfree, result[3])
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000296
Brett Cannoncfaf10c2008-05-16 00:45:35 +0000297 # Make sure all the attributes are there.
298 members = ('bsize', 'frsize', 'blocks', 'bfree', 'bavail', 'files',
299 'ffree', 'favail', 'flag', 'namemax')
300 for value, member in enumerate(members):
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000301 self.assertEqual(getattr(result, 'f_' + member), result[value])
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000302
303 # Make sure that assignment really fails
304 try:
305 result.f_bfree = 1
306 self.fail("No exception thrown")
Collin Winter42dae6a2007-03-28 21:44:53 +0000307 except AttributeError:
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000308 pass
309
310 try:
311 result.parrot = 1
312 self.fail("No exception thrown")
313 except AttributeError:
314 pass
315
316 # Use the constructor with a too-short tuple.
317 try:
318 result2 = os.statvfs_result((10,))
319 self.fail("No exception thrown")
320 except TypeError:
321 pass
322
Ezio Melotti42da6632011-03-15 05:18:48 +0200323 # Use the constructor with a too-long tuple.
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000324 try:
325 result2 = os.statvfs_result((0,1,2,3,4,5,6,7,8,9,10,11,12,13,14))
326 except TypeError:
327 pass
Fred Drake38c2ef02001-07-17 20:52:51 +0000328
Thomas Wouters89f507f2006-12-13 04:49:30 +0000329 def test_utime_dir(self):
330 delta = 1000000
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000331 st = os.stat(support.TESTFN)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000332 # round to int, because some systems may support sub-second
333 # time stamps in stat, but not in utime.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000334 os.utime(support.TESTFN, (st.st_atime, int(st.st_mtime-delta)))
335 st2 = os.stat(support.TESTFN)
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000336 self.assertEqual(st2.st_mtime, int(st.st_mtime-delta))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000337
338 # Restrict test to Win32, since there is no guarantee other
339 # systems support centiseconds
340 if sys.platform == 'win32':
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000341 def get_file_system(path):
Hirokazu Yamamoto5ef6d182008-08-20 04:17:24 +0000342 root = os.path.splitdrive(os.path.abspath(path))[0] + '\\'
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000343 import ctypes
Hirokazu Yamamotoca765d52008-08-20 16:18:19 +0000344 kernel32 = ctypes.windll.kernel32
Hirokazu Yamamoto5ef6d182008-08-20 04:17:24 +0000345 buf = ctypes.create_unicode_buffer("", 100)
Hirokazu Yamamotoca765d52008-08-20 16:18:19 +0000346 if kernel32.GetVolumeInformationW(root, None, 0, None, None, None, buf, len(buf)):
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000347 return buf.value
348
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000349 if get_file_system(support.TESTFN) == "NTFS":
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000350 def test_1565150(self):
351 t1 = 1159195039.25
352 os.utime(self.fname, (t1, t1))
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000353 self.assertEqual(os.stat(self.fname).st_mtime, t1)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000354
Amaury Forgeot d'Arc32e8aab2011-01-03 00:40:04 +0000355 def test_large_time(self):
356 t1 = 5000000000 # some day in 2128
357 os.utime(self.fname, (t1, t1))
358 self.assertEqual(os.stat(self.fname).st_mtime, t1)
359
Guido van Rossumd8faa362007-04-27 19:54:29 +0000360 def test_1686475(self):
361 # Verify that an open file can be stat'ed
362 try:
363 os.stat(r"c:\pagefile.sys")
364 except WindowsError as e:
Benjamin Petersonc4fe6f32008-08-19 18:57:56 +0000365 if e.errno == 2: # file does not exist; cannot run test
Guido van Rossumd8faa362007-04-27 19:54:29 +0000366 return
367 self.fail("Could not stat pagefile.sys")
368
Walter Dörwald0a6d0ff2004-05-31 16:29:04 +0000369from test import mapping_tests
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000370
Walter Dörwald0a6d0ff2004-05-31 16:29:04 +0000371class EnvironTests(mapping_tests.BasicTestMappingProtocol):
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000372 """check that os.environ object conform to mapping protocol"""
Walter Dörwald118f9312004-06-02 18:42:25 +0000373 type2test = None
Christian Heimes90333392007-11-01 19:08:42 +0000374
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000375 def setUp(self):
376 self.__save = dict(os.environ)
Christian Heimes90333392007-11-01 19:08:42 +0000377 for key, value in self._reference().items():
378 os.environ[key] = value
379
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000380 def tearDown(self):
381 os.environ.clear()
382 os.environ.update(self.__save)
383
Christian Heimes90333392007-11-01 19:08:42 +0000384 def _reference(self):
385 return {"KEY1":"VALUE1", "KEY2":"VALUE2", "KEY3":"VALUE3"}
386
387 def _empty_mapping(self):
388 os.environ.clear()
389 return os.environ
390
Martin v. Löwis1d11de62005-01-29 13:29:23 +0000391 # Bug 1110478
Martin v. Löwis5510f652005-02-17 21:23:20 +0000392 def test_update2(self):
Christian Heimes90333392007-11-01 19:08:42 +0000393 os.environ.clear()
Martin v. Löwis1d11de62005-01-29 13:29:23 +0000394 if os.path.exists("/bin/sh"):
395 os.environ.update(HELLO="World")
Brian Curtin32105f42010-10-30 21:27:07 +0000396 with os.popen("/bin/sh -c 'echo $HELLO'") as popen:
397 value = popen.read().strip()
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000398 self.assertEqual(value, "World")
Martin v. Löwis1d11de62005-01-29 13:29:23 +0000399
Christian Heimes1a13d592007-11-08 14:16:55 +0000400 def test_os_popen_iter(self):
401 if os.path.exists("/bin/sh"):
Brian Curtin32105f42010-10-30 21:27:07 +0000402 with os.popen(
403 "/bin/sh -c 'echo \"line1\nline2\nline3\"'") as popen:
404 it = iter(popen)
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000405 self.assertEqual(next(it), "line1\n")
406 self.assertEqual(next(it), "line2\n")
407 self.assertEqual(next(it), "line3\n")
Brian Curtin32105f42010-10-30 21:27:07 +0000408 self.assertRaises(StopIteration, next, it)
Christian Heimes1a13d592007-11-08 14:16:55 +0000409
Guido van Rossum67aca9e2007-06-13 21:51:27 +0000410 # Verify environ keys and values from the OS are of the
411 # correct str type.
412 def test_keyvalue_types(self):
413 for key, val in os.environ.items():
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000414 self.assertEqual(type(key), str)
415 self.assertEqual(type(val), str)
Guido van Rossum67aca9e2007-06-13 21:51:27 +0000416
Christian Heimes90333392007-11-01 19:08:42 +0000417 def test_items(self):
418 for key, value in self._reference().items():
419 self.assertEqual(os.environ.get(key), value)
420
Ezio Melottid2a577d2010-02-22 16:01:22 +0000421 # Issue 7310
422 def test___repr__(self):
423 """Check that the repr() of os.environ looks like environ({...})."""
424 env = os.environ
425 self.assertTrue(isinstance(env.data, dict))
426 self.assertEqual(repr(env), 'environ({!r})'.format(env.data))
427
428
Tim Petersc4e09402003-04-25 07:11:48 +0000429class WalkTests(unittest.TestCase):
430 """Tests for os.walk()."""
431
432 def test_traversal(self):
433 import os
434 from os.path import join
435
436 # Build:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000437 # TESTFN/
438 # TEST1/ a file kid and two directory kids
Tim Petersc4e09402003-04-25 07:11:48 +0000439 # tmp1
440 # SUB1/ a file kid and a directory kid
Guido van Rossumd8faa362007-04-27 19:54:29 +0000441 # tmp2
442 # SUB11/ no kids
443 # SUB2/ a file kid and a dirsymlink kid
444 # tmp3
445 # link/ a symlink to TESTFN.2
446 # TEST2/
447 # tmp4 a lone file
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000448 walk_path = join(support.TESTFN, "TEST1")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000449 sub1_path = join(walk_path, "SUB1")
Tim Petersc4e09402003-04-25 07:11:48 +0000450 sub11_path = join(sub1_path, "SUB11")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000451 sub2_path = join(walk_path, "SUB2")
452 tmp1_path = join(walk_path, "tmp1")
Tim Petersc4e09402003-04-25 07:11:48 +0000453 tmp2_path = join(sub1_path, "tmp2")
454 tmp3_path = join(sub2_path, "tmp3")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000455 link_path = join(sub2_path, "link")
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000456 t2_path = join(support.TESTFN, "TEST2")
457 tmp4_path = join(support.TESTFN, "TEST2", "tmp4")
Tim Petersc4e09402003-04-25 07:11:48 +0000458
459 # Create stuff.
460 os.makedirs(sub11_path)
461 os.makedirs(sub2_path)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000462 os.makedirs(t2_path)
463 for path in tmp1_path, tmp2_path, tmp3_path, tmp4_path:
Alex Martelli01c77c62006-08-24 02:58:11 +0000464 f = open(path, "w")
Tim Petersc4e09402003-04-25 07:11:48 +0000465 f.write("I'm " + path + " and proud of it. Blame test_os.\n")
466 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000467 if hasattr(os, "symlink"):
468 os.symlink(os.path.abspath(t2_path), link_path)
469 sub2_tree = (sub2_path, ["link"], ["tmp3"])
470 else:
471 sub2_tree = (sub2_path, [], ["tmp3"])
Tim Petersc4e09402003-04-25 07:11:48 +0000472
473 # Walk top-down.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000474 all = list(os.walk(walk_path))
Tim Petersc4e09402003-04-25 07:11:48 +0000475 self.assertEqual(len(all), 4)
476 # We can't know which order SUB1 and SUB2 will appear in.
477 # Not flipped: TESTFN, SUB1, SUB11, SUB2
478 # flipped: TESTFN, SUB2, SUB1, SUB11
479 flipped = all[0][1][0] != "SUB1"
480 all[0][1].sort()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000481 self.assertEqual(all[0], (walk_path, ["SUB1", "SUB2"], ["tmp1"]))
Tim Petersc4e09402003-04-25 07:11:48 +0000482 self.assertEqual(all[1 + flipped], (sub1_path, ["SUB11"], ["tmp2"]))
483 self.assertEqual(all[2 + flipped], (sub11_path, [], []))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000484 self.assertEqual(all[3 - 2 * flipped], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000485
486 # Prune the search.
487 all = []
Guido van Rossumd8faa362007-04-27 19:54:29 +0000488 for root, dirs, files in os.walk(walk_path):
Tim Petersc4e09402003-04-25 07:11:48 +0000489 all.append((root, dirs, files))
490 # Don't descend into SUB1.
491 if 'SUB1' in dirs:
492 # Note that this also mutates the dirs we appended to all!
493 dirs.remove('SUB1')
494 self.assertEqual(len(all), 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000495 self.assertEqual(all[0], (walk_path, ["SUB2"], ["tmp1"]))
496 self.assertEqual(all[1], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000497
498 # Walk bottom-up.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000499 all = list(os.walk(walk_path, topdown=False))
Tim Petersc4e09402003-04-25 07:11:48 +0000500 self.assertEqual(len(all), 4)
501 # We can't know which order SUB1 and SUB2 will appear in.
502 # Not flipped: SUB11, SUB1, SUB2, TESTFN
503 # flipped: SUB2, SUB11, SUB1, TESTFN
504 flipped = all[3][1][0] != "SUB1"
505 all[3][1].sort()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000506 self.assertEqual(all[3], (walk_path, ["SUB1", "SUB2"], ["tmp1"]))
Tim Petersc4e09402003-04-25 07:11:48 +0000507 self.assertEqual(all[flipped], (sub11_path, [], []))
508 self.assertEqual(all[flipped + 1], (sub1_path, ["SUB11"], ["tmp2"]))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000509 self.assertEqual(all[2 - 2 * flipped], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000510
Guido van Rossumd8faa362007-04-27 19:54:29 +0000511 if hasattr(os, "symlink"):
512 # Walk, following symlinks.
513 for root, dirs, files in os.walk(walk_path, followlinks=True):
514 if root == link_path:
515 self.assertEqual(dirs, [])
516 self.assertEqual(files, ["tmp4"])
517 break
518 else:
519 self.fail("Didn't follow symlink with followlinks=True")
520
521 def tearDown(self):
Tim Petersc4e09402003-04-25 07:11:48 +0000522 # Tear everything down. This is a decent use for bottom-up on
523 # Windows, which doesn't have a recursive delete command. The
524 # (not so) subtlety is that rmdir will fail unless the dir's
525 # kids are removed first, so bottom up is essential.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000526 for root, dirs, files in os.walk(support.TESTFN, topdown=False):
Tim Petersc4e09402003-04-25 07:11:48 +0000527 for name in files:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000528 os.remove(os.path.join(root, name))
Tim Petersc4e09402003-04-25 07:11:48 +0000529 for name in dirs:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000530 dirname = os.path.join(root, name)
531 if not os.path.islink(dirname):
532 os.rmdir(dirname)
533 else:
534 os.remove(dirname)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000535 os.rmdir(support.TESTFN)
Tim Petersc4e09402003-04-25 07:11:48 +0000536
Guido van Rossume7ba4952007-06-06 23:52:48 +0000537class MakedirTests(unittest.TestCase):
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000538 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000539 os.mkdir(support.TESTFN)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000540
541 def test_makedir(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000542 base = support.TESTFN
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000543 path = os.path.join(base, 'dir1', 'dir2', 'dir3')
544 os.makedirs(path) # Should work
545 path = os.path.join(base, 'dir1', 'dir2', 'dir3', 'dir4')
546 os.makedirs(path)
547
548 # Try paths with a '.' in them
Georg Brandlab91fde2009-08-13 08:51:18 +0000549 self.assertRaises(OSError, os.makedirs, os.curdir)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000550 path = os.path.join(base, 'dir1', 'dir2', 'dir3', 'dir4', 'dir5', os.curdir)
551 os.makedirs(path)
552 path = os.path.join(base, 'dir1', os.curdir, 'dir2', 'dir3', 'dir4',
553 'dir5', 'dir6')
554 os.makedirs(path)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000555
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000556 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000557 path = os.path.join(support.TESTFN, 'dir1', 'dir2', 'dir3',
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000558 'dir4', 'dir5', 'dir6')
559 # If the tests failed, the bottom-most directory ('../dir6')
560 # may not have been created, so we look for the outermost directory
561 # that exists.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000562 while not os.path.exists(path) and path != support.TESTFN:
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000563 path = os.path.dirname(path)
564
565 os.removedirs(path)
566
Guido van Rossume7ba4952007-06-06 23:52:48 +0000567class DevNullTests(unittest.TestCase):
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000568 def test_devnull(self):
Alex Martelli01c77c62006-08-24 02:58:11 +0000569 f = open(os.devnull, 'w')
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000570 f.write('hello')
571 f.close()
Alex Martelli01c77c62006-08-24 02:58:11 +0000572 f = open(os.devnull, 'r')
Tim Peters4182cfd2004-06-08 20:34:34 +0000573 self.assertEqual(f.read(), '')
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000574 f.close()
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000575
Guido van Rossume7ba4952007-06-06 23:52:48 +0000576class URandomTests(unittest.TestCase):
Martin v. Löwisdc3883f2004-08-29 15:46:35 +0000577 def test_urandom(self):
578 try:
579 self.assertEqual(len(os.urandom(1)), 1)
580 self.assertEqual(len(os.urandom(10)), 10)
581 self.assertEqual(len(os.urandom(100)), 100)
582 self.assertEqual(len(os.urandom(1000)), 1000)
583 except NotImplementedError:
584 pass
585
Guido van Rossume7ba4952007-06-06 23:52:48 +0000586class ExecTests(unittest.TestCase):
Mark Dickinson466e9262010-04-16 16:32:49 +0000587 @unittest.skipIf(USING_LINUXTHREADS,
588 "avoid triggering a linuxthreads bug: see issue #4970")
Guido van Rossume7ba4952007-06-06 23:52:48 +0000589 def test_execvpe_with_bad_program(self):
Mark Dickinson466e9262010-04-16 16:32:49 +0000590 self.assertRaises(OSError, os.execvpe, 'no such app-',
591 ['no such app-'], None)
Guido van Rossume7ba4952007-06-06 23:52:48 +0000592
Thomas Heller6790d602007-08-30 17:15:14 +0000593 def test_execvpe_with_bad_arglist(self):
594 self.assertRaises(ValueError, os.execvpe, 'notepad', [], None)
595
Antoine Pitrou1b643312010-01-17 12:19:45 +0000596class ArgTests(unittest.TestCase):
597 def test_bytearray(self):
598 # Issue #7561: posix module didn't release bytearray exports properly.
599 b = bytearray(os.sep.encode('ascii'))
600 self.assertRaises(OSError, os.mkdir, b)
601 # Check object is still resizable.
602 b[:] = b''
603
Thomas Wouters477c8d52006-05-27 19:21:47 +0000604class Win32ErrorTests(unittest.TestCase):
605 def test_rename(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000606 self.assertRaises(WindowsError, os.rename, support.TESTFN, support.TESTFN+".bak")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000607
608 def test_remove(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000609 self.assertRaises(WindowsError, os.remove, support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000610
611 def test_chdir(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000612 self.assertRaises(WindowsError, os.chdir, support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000613
614 def test_mkdir(self):
Amaury Forgeot d'Arc2fc224f2009-02-19 23:23:47 +0000615 f = open(support.TESTFN, "w")
Benjamin Petersonf91df042009-02-13 02:50:59 +0000616 try:
617 self.assertRaises(WindowsError, os.mkdir, support.TESTFN)
618 finally:
619 f.close()
Amaury Forgeot d'Arc2fc224f2009-02-19 23:23:47 +0000620 os.unlink(support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000621
622 def test_utime(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000623 self.assertRaises(WindowsError, os.utime, support.TESTFN, None)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624
Thomas Wouters477c8d52006-05-27 19:21:47 +0000625 def test_chmod(self):
Benjamin Petersonf91df042009-02-13 02:50:59 +0000626 self.assertRaises(WindowsError, os.chmod, support.TESTFN, 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000628class TestInvalidFD(unittest.TestCase):
Benjamin Peterson05e782f2009-01-19 15:15:02 +0000629 singles = ["fchdir", "dup", "fdopen", "fdatasync", "fstat",
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000630 "fstatvfs", "fsync", "tcgetpgrp", "ttyname"]
631 #singles.append("close")
632 #We omit close because it doesn'r raise an exception on some platforms
633 def get_single(f):
634 def helper(self):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000635 if hasattr(os, f):
636 self.check(getattr(os, f))
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000637 return helper
638 for f in singles:
639 locals()["test_"+f] = get_single(f)
640
Benjamin Peterson7522c742009-01-19 21:00:09 +0000641 def check(self, f, *args):
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000642 try:
643 f(support.make_bad_fd(), *args)
644 except OSError as e:
645 self.assertEqual(e.errno, errno.EBADF)
646 else:
647 self.fail("%r didn't raise a OSError with a bad file descriptor"
648 % f)
Benjamin Peterson7522c742009-01-19 21:00:09 +0000649
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000650 def test_isatty(self):
651 if hasattr(os, "isatty"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000652 self.assertEqual(os.isatty(support.make_bad_fd()), False)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000653
654 def test_closerange(self):
655 if hasattr(os, "closerange"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000656 fd = support.make_bad_fd()
R. David Murray1f1b9a42009-07-22 15:23:36 +0000657 # Make sure none of the descriptors we are about to close are
658 # currently valid (issue 6542).
659 for i in range(10):
660 try: os.fstat(fd+i)
661 except OSError:
662 pass
663 else:
664 break
665 if i < 2:
666 raise unittest.SkipTest(
667 "Unable to acquire a range of invalid file descriptors")
668 self.assertEqual(os.closerange(fd, fd + i-1), None)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000669
670 def test_dup2(self):
671 if hasattr(os, "dup2"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000672 self.check(os.dup2, 20)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000673
674 def test_fchmod(self):
675 if hasattr(os, "fchmod"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000676 self.check(os.fchmod, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000677
678 def test_fchown(self):
679 if hasattr(os, "fchown"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000680 self.check(os.fchown, -1, -1)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000681
682 def test_fpathconf(self):
683 if hasattr(os, "fpathconf"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000684 self.check(os.fpathconf, "PC_NAME_MAX")
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000685
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000686 def test_ftruncate(self):
687 if hasattr(os, "ftruncate"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000688 self.check(os.ftruncate, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000689
690 def test_lseek(self):
691 if hasattr(os, "lseek"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000692 self.check(os.lseek, 0, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000693
694 def test_read(self):
695 if hasattr(os, "read"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000696 self.check(os.read, 1)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000697
698 def test_tcsetpgrpt(self):
699 if hasattr(os, "tcsetpgrp"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000700 self.check(os.tcsetpgrp, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000701
702 def test_write(self):
703 if hasattr(os, "write"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000704 self.check(os.write, b" ")
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000705
Thomas Wouters477c8d52006-05-27 19:21:47 +0000706if sys.platform != 'win32':
707 class Win32ErrorTests(unittest.TestCase):
708 pass
709
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000710 class PosixUidGidTests(unittest.TestCase):
711 if hasattr(os, 'setuid'):
712 def test_setuid(self):
713 if os.getuid() != 0:
714 self.assertRaises(os.error, os.setuid, 0)
715 self.assertRaises(OverflowError, os.setuid, 1<<32)
716
717 if hasattr(os, 'setgid'):
718 def test_setgid(self):
719 if os.getuid() != 0:
720 self.assertRaises(os.error, os.setgid, 0)
721 self.assertRaises(OverflowError, os.setgid, 1<<32)
722
723 if hasattr(os, 'seteuid'):
724 def test_seteuid(self):
725 if os.getuid() != 0:
726 self.assertRaises(os.error, os.seteuid, 0)
727 self.assertRaises(OverflowError, os.seteuid, 1<<32)
728
729 if hasattr(os, 'setegid'):
730 def test_setegid(self):
731 if os.getuid() != 0:
732 self.assertRaises(os.error, os.setegid, 0)
733 self.assertRaises(OverflowError, os.setegid, 1<<32)
734
735 if hasattr(os, 'setreuid'):
736 def test_setreuid(self):
737 if os.getuid() != 0:
738 self.assertRaises(os.error, os.setreuid, 0, 0)
739 self.assertRaises(OverflowError, os.setreuid, 1<<32, 0)
740 self.assertRaises(OverflowError, os.setreuid, 0, 1<<32)
Benjamin Petersonc48b0552010-03-06 20:37:32 +0000741
742 def test_setreuid_neg1(self):
743 # Needs to accept -1. We run this in a subprocess to avoid
744 # altering the test runner's process state (issue8045).
745 import subprocess
746 subprocess.check_call([
747 sys.executable, '-c',
748 'import os,sys;os.setreuid(-1,-1);sys.exit(0)'])
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000749
750 if hasattr(os, 'setregid'):
751 def test_setregid(self):
752 if os.getuid() != 0:
753 self.assertRaises(os.error, os.setregid, 0, 0)
754 self.assertRaises(OverflowError, os.setregid, 1<<32, 0)
755 self.assertRaises(OverflowError, os.setregid, 0, 1<<32)
Benjamin Petersonc48b0552010-03-06 20:37:32 +0000756
757 def test_setregid_neg1(self):
758 # Needs to accept -1. We run this in a subprocess to avoid
759 # altering the test runner's process state (issue8045).
760 import subprocess
761 subprocess.check_call([
762 sys.executable, '-c',
763 'import os,sys;os.setregid(-1,-1);sys.exit(0)'])
Martin v. Löwis011e8422009-05-05 04:43:17 +0000764
Mark Dickinson70613682009-05-05 21:34:59 +0000765 @unittest.skipIf(sys.platform == 'darwin', "tests don't apply to OS X")
Martin v. Löwis011e8422009-05-05 04:43:17 +0000766 class Pep383Tests(unittest.TestCase):
767 filenames = [b'foo\xf6bar', 'foo\xf6bar'.encode("utf-8")]
768
769 def setUp(self):
770 self.fsencoding = sys.getfilesystemencoding()
771 sys.setfilesystemencoding("utf-8")
772 self.dir = support.TESTFN
Martin v. Löwis43c57782009-05-10 08:15:24 +0000773 self.bdir = self.dir.encode("utf-8", "surrogateescape")
Martin v. Löwis011e8422009-05-05 04:43:17 +0000774 os.mkdir(self.dir)
775 self.unicodefn = []
776 for fn in self.filenames:
777 f = open(os.path.join(self.bdir, fn), "w")
778 f.close()
Martin v. Löwis43c57782009-05-10 08:15:24 +0000779 self.unicodefn.append(fn.decode("utf-8", "surrogateescape"))
Martin v. Löwis011e8422009-05-05 04:43:17 +0000780
781 def tearDown(self):
782 shutil.rmtree(self.dir)
783 sys.setfilesystemencoding(self.fsencoding)
784
785 def test_listdir(self):
786 expected = set(self.unicodefn)
787 found = set(os.listdir(support.TESTFN))
Ezio Melotti19f2aeb2010-11-21 01:30:29 +0000788 self.assertEqual(found, expected)
Martin v. Löwis011e8422009-05-05 04:43:17 +0000789
790 def test_open(self):
791 for fn in self.unicodefn:
792 f = open(os.path.join(self.dir, fn))
793 f.close()
794
795 def test_stat(self):
796 for fn in self.unicodefn:
797 os.stat(os.path.join(self.dir, fn))
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000798else:
799 class PosixUidGidTests(unittest.TestCase):
800 pass
Martin v. Löwis011e8422009-05-05 04:43:17 +0000801 class Pep383Tests(unittest.TestCase):
802 pass
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000803
Fred Drake2e2be372001-09-20 21:33:42 +0000804def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000805 support.run_unittest(
Antoine Pitrou1b643312010-01-17 12:19:45 +0000806 ArgTests,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000807 FileTests,
Walter Dörwald21d3a322003-05-01 17:45:56 +0000808 StatAttributeTests,
809 EnvironTests,
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000810 WalkTests,
811 MakedirTests,
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000812 DevNullTests,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000813 URandomTests,
Guido van Rossume7ba4952007-06-06 23:52:48 +0000814 ExecTests,
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000815 Win32ErrorTests,
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000816 TestInvalidFD,
Martin v. Löwis011e8422009-05-05 04:43:17 +0000817 PosixUidGidTests,
818 Pep383Tests
Walter Dörwald21d3a322003-05-01 17:45:56 +0000819 )
Fred Drake2e2be372001-09-20 21:33:42 +0000820
821if __name__ == "__main__":
822 test_main()