blob: cdbc9983747afed4e96bf4099eb509d6c7304d9e [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
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013# Tests creating TESTFN
14class FileTests(unittest.TestCase):
15 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000016 if os.path.exists(support.TESTFN):
17 os.unlink(support.TESTFN)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000018 tearDown = setUp
19
20 def test_access(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000021 f = os.open(support.TESTFN, os.O_CREAT|os.O_RDWR)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000022 os.close(f)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000023 self.assertTrue(os.access(support.TESTFN, os.W_OK))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000024
Christian Heimesfdab48e2008-01-20 09:06:41 +000025 def test_closerange(self):
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000026 first = os.open(support.TESTFN, os.O_CREAT|os.O_RDWR)
27 # We must allocate two consecutive file descriptors, otherwise
28 # it will mess up other file descriptors (perhaps even the three
29 # standard ones).
30 second = os.dup(first)
31 try:
32 retries = 0
33 while second != first + 1:
34 os.close(first)
35 retries += 1
36 if retries > 10:
37 # XXX test skipped
Benjamin Petersonfa0d7032009-06-01 22:42:33 +000038 self.skipTest("couldn't allocate two consecutive fds")
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000039 first, second = second, os.dup(second)
40 finally:
41 os.close(second)
Christian Heimesfdab48e2008-01-20 09:06:41 +000042 # close a fd that is open, and one that isn't
Antoine Pitroub9ee06c2008-08-16 22:03:17 +000043 os.closerange(first, first + 2)
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000044 self.assertRaises(OSError, os.write, first, b"a")
Thomas Wouters0e3f5912006-08-11 14:57:12 +000045
Hirokazu Yamamoto4c19e6e2008-09-08 23:41:21 +000046 def test_rename(self):
47 path = support.TESTFN
48 old = sys.getrefcount(path)
49 self.assertRaises(TypeError, os.rename, path, 0)
50 new = sys.getrefcount(path)
51 self.assertEqual(old, new)
52
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000053 def test_read(self):
54 with open(support.TESTFN, "w+b") as fobj:
55 fobj.write(b"spam")
56 fobj.flush()
57 fd = fobj.fileno()
58 os.lseek(fd, 0, 0)
59 s = os.read(fd, 4)
60 self.assertEqual(type(s), bytes)
61 self.assertEqual(s, b"spam")
62
63 def test_write(self):
64 # os.write() accepts bytes- and buffer-like objects but not strings
65 fd = os.open(support.TESTFN, os.O_CREAT | os.O_WRONLY)
66 self.assertRaises(TypeError, os.write, fd, "beans")
67 os.write(fd, b"bacon\n")
68 os.write(fd, bytearray(b"eggs\n"))
69 os.write(fd, memoryview(b"spam\n"))
70 os.close(fd)
71 with open(support.TESTFN, "rb") as fobj:
Antoine Pitroud62269f2008-09-15 23:54:52 +000072 self.assertEqual(fobj.read().splitlines(),
73 [b"bacon", b"eggs", b"spam"])
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +000074
75
Christian Heimesdd15f6c2008-03-16 00:07:10 +000076class TemporaryFileTests(unittest.TestCase):
77 def setUp(self):
78 self.files = []
Benjamin Petersonee8712c2008-05-20 21:35:26 +000079 os.mkdir(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080
81 def tearDown(self):
82 for name in self.files:
83 os.unlink(name)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000084 os.rmdir(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000085
86 def check_tempfile(self, name):
87 # make sure it doesn't already exist:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000088 self.assertFalse(os.path.exists(name),
Christian Heimesdd15f6c2008-03-16 00:07:10 +000089 "file already exists for temporary file")
90 # make sure we can create the file
91 open(name, "w")
92 self.files.append(name)
93
94 def test_tempnam(self):
95 if not hasattr(os, "tempnam"):
96 return
97 warnings.filterwarnings("ignore", "tempnam", RuntimeWarning,
98 r"test_os$")
99 self.check_tempfile(os.tempnam())
100
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000101 name = os.tempnam(support.TESTFN)
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000102 self.check_tempfile(name)
103
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000104 name = os.tempnam(support.TESTFN, "pfx")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000105 self.assertTrue(os.path.basename(name)[:3] == "pfx")
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000106 self.check_tempfile(name)
107
108 def test_tmpfile(self):
109 if not hasattr(os, "tmpfile"):
110 return
111 # As with test_tmpnam() below, the Windows implementation of tmpfile()
112 # attempts to create a file in the root directory of the current drive.
113 # On Vista and Server 2008, this test will always fail for normal users
114 # as writing to the root directory requires elevated privileges. With
115 # XP and below, the semantics of tmpfile() are the same, but the user
116 # running the test is more likely to have administrative privileges on
117 # their account already. If that's the case, then os.tmpfile() should
118 # work. In order to make this test as useful as possible, rather than
119 # trying to detect Windows versions or whether or not the user has the
120 # right permissions, just try and create a file in the root directory
121 # and see if it raises a 'Permission denied' OSError. If it does, then
122 # test that a subsequent call to os.tmpfile() raises the same error. If
123 # it doesn't, assume we're on XP or below and the user running the test
124 # has administrative privileges, and proceed with the test as normal.
125 if sys.platform == 'win32':
126 name = '\\python_test_os_test_tmpfile.txt'
127 if os.path.exists(name):
128 os.remove(name)
129 try:
130 fp = open(name, 'w')
131 except IOError as first:
132 # open() failed, assert tmpfile() fails in the same way.
133 # Although open() raises an IOError and os.tmpfile() raises an
134 # OSError(), 'args' will be (13, 'Permission denied') in both
135 # cases.
136 try:
137 fp = os.tmpfile()
138 except OSError as second:
139 self.assertEqual(first.args, second.args)
140 else:
141 self.fail("expected os.tmpfile() to raise OSError")
142 return
143 else:
144 # open() worked, therefore, tmpfile() should work. Close our
145 # dummy file and proceed with the test as normal.
146 fp.close()
147 os.remove(name)
148
149 fp = os.tmpfile()
150 fp.write("foobar")
151 fp.seek(0,0)
152 s = fp.read()
153 fp.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000154 self.assertTrue(s == "foobar")
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000155
156 def test_tmpnam(self):
157 import sys
158 if not hasattr(os, "tmpnam"):
159 return
160 warnings.filterwarnings("ignore", "tmpnam", RuntimeWarning,
161 r"test_os$")
162 name = os.tmpnam()
163 if sys.platform in ("win32",):
164 # The Windows tmpnam() seems useless. From the MS docs:
165 #
166 # The character string that tmpnam creates consists of
167 # the path prefix, defined by the entry P_tmpdir in the
168 # file STDIO.H, followed by a sequence consisting of the
169 # digit characters '0' through '9'; the numerical value
170 # of this string is in the range 1 - 65,535. Changing the
171 # definitions of L_tmpnam or P_tmpdir in STDIO.H does not
172 # change the operation of tmpnam.
173 #
174 # The really bizarre part is that, at least under MSVC6,
175 # P_tmpdir is "\\". That is, the path returned refers to
176 # the root of the current drive. That's a terrible place to
177 # put temp files, and, depending on privileges, the user
178 # may not even be able to open a file in the root directory.
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000179 self.assertFalse(os.path.exists(name),
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000180 "file already exists for temporary file")
181 else:
182 self.check_tempfile(name)
183
Amaury Forgeot d'Arce2e36ba2008-08-01 00:14:22 +0000184 def fdopen_helper(self, *args):
185 fd = os.open(support.TESTFN, os.O_RDONLY)
186 fp2 = os.fdopen(fd, *args)
187 fp2.close()
188
189 def test_fdopen(self):
190 self.fdopen_helper()
191 self.fdopen_helper('r')
192 self.fdopen_helper('r', 100)
193
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000194# Test attributes on return values from os.*stat* family.
195class StatAttributeTests(unittest.TestCase):
196 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000197 os.mkdir(support.TESTFN)
198 self.fname = os.path.join(support.TESTFN, "f1")
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000199 f = open(self.fname, 'wb')
Guido van Rossum26d95c32007-08-27 23:18:54 +0000200 f.write(b"ABC")
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000201 f.close()
Tim Peterse0c446b2001-10-18 21:57:37 +0000202
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000203 def tearDown(self):
204 os.unlink(self.fname)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000205 os.rmdir(support.TESTFN)
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000206
207 def test_stat_attributes(self):
208 if not hasattr(os, "stat"):
209 return
210
211 import stat
212 result = os.stat(self.fname)
213
214 # Make sure direct access works
215 self.assertEquals(result[stat.ST_SIZE], 3)
216 self.assertEquals(result.st_size, 3)
217
218 import sys
219
220 # Make sure all the attributes are there
221 members = dir(result)
222 for name in dir(stat):
223 if name[:3] == 'ST_':
224 attr = name.lower()
Martin v. Löwis4d394df2005-01-23 09:19:22 +0000225 if name.endswith("TIME"):
226 def trunc(x): return int(x)
227 else:
228 def trunc(x): return x
229 self.assertEquals(trunc(getattr(result, attr)),
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000230 result[getattr(stat, name)])
Benjamin Peterson577473f2010-01-19 00:09:57 +0000231 self.assertIn(attr, members)
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000232
233 try:
234 result[200]
235 self.fail("No exception thrown")
236 except IndexError:
237 pass
238
239 # Make sure that assignment fails
240 try:
241 result.st_mode = 1
242 self.fail("No exception thrown")
Collin Winter42dae6a2007-03-28 21:44:53 +0000243 except AttributeError:
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000244 pass
245
246 try:
247 result.st_rdev = 1
248 self.fail("No exception thrown")
Guido van Rossum1fff8782001-10-18 21:19:31 +0000249 except (AttributeError, TypeError):
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000250 pass
251
252 try:
253 result.parrot = 1
254 self.fail("No exception thrown")
255 except AttributeError:
256 pass
257
258 # Use the stat_result constructor with a too-short tuple.
259 try:
260 result2 = os.stat_result((10,))
261 self.fail("No exception thrown")
262 except TypeError:
263 pass
264
265 # Use the constructr with a too-long tuple.
266 try:
267 result2 = os.stat_result((0,1,2,3,4,5,6,7,8,9,10,11,12,13,14))
268 except TypeError:
269 pass
270
Tim Peterse0c446b2001-10-18 21:57:37 +0000271
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000272 def test_statvfs_attributes(self):
273 if not hasattr(os, "statvfs"):
274 return
275
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000276 try:
277 result = os.statvfs(self.fname)
Guido van Rossumb940e112007-01-10 16:19:56 +0000278 except OSError as e:
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000279 # On AtheOS, glibc always returns ENOSYS
Martin v. Löwisf90ae202002-06-11 06:22:31 +0000280 if e.errno == errno.ENOSYS:
281 return
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000282
283 # Make sure direct access works
Brett Cannoncfaf10c2008-05-16 00:45:35 +0000284 self.assertEquals(result.f_bfree, result[3])
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000285
Brett Cannoncfaf10c2008-05-16 00:45:35 +0000286 # Make sure all the attributes are there.
287 members = ('bsize', 'frsize', 'blocks', 'bfree', 'bavail', 'files',
288 'ffree', 'favail', 'flag', 'namemax')
289 for value, member in enumerate(members):
290 self.assertEquals(getattr(result, 'f_' + member), result[value])
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000291
292 # Make sure that assignment really fails
293 try:
294 result.f_bfree = 1
295 self.fail("No exception thrown")
Collin Winter42dae6a2007-03-28 21:44:53 +0000296 except AttributeError:
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000297 pass
298
299 try:
300 result.parrot = 1
301 self.fail("No exception thrown")
302 except AttributeError:
303 pass
304
305 # Use the constructor with a too-short tuple.
306 try:
307 result2 = os.statvfs_result((10,))
308 self.fail("No exception thrown")
309 except TypeError:
310 pass
311
312 # Use the constructr with a too-long tuple.
313 try:
314 result2 = os.statvfs_result((0,1,2,3,4,5,6,7,8,9,10,11,12,13,14))
315 except TypeError:
316 pass
Fred Drake38c2ef02001-07-17 20:52:51 +0000317
Thomas Wouters89f507f2006-12-13 04:49:30 +0000318 def test_utime_dir(self):
319 delta = 1000000
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000320 st = os.stat(support.TESTFN)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000321 # round to int, because some systems may support sub-second
322 # time stamps in stat, but not in utime.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000323 os.utime(support.TESTFN, (st.st_atime, int(st.st_mtime-delta)))
324 st2 = os.stat(support.TESTFN)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000325 self.assertEquals(st2.st_mtime, int(st.st_mtime-delta))
326
327 # Restrict test to Win32, since there is no guarantee other
328 # systems support centiseconds
329 if sys.platform == 'win32':
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000330 def get_file_system(path):
Hirokazu Yamamoto5ef6d182008-08-20 04:17:24 +0000331 root = os.path.splitdrive(os.path.abspath(path))[0] + '\\'
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000332 import ctypes
Hirokazu Yamamotoca765d52008-08-20 16:18:19 +0000333 kernel32 = ctypes.windll.kernel32
Hirokazu Yamamoto5ef6d182008-08-20 04:17:24 +0000334 buf = ctypes.create_unicode_buffer("", 100)
Hirokazu Yamamotoca765d52008-08-20 16:18:19 +0000335 if kernel32.GetVolumeInformationW(root, None, 0, None, None, None, buf, len(buf)):
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000336 return buf.value
337
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000338 if get_file_system(support.TESTFN) == "NTFS":
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000339 def test_1565150(self):
340 t1 = 1159195039.25
341 os.utime(self.fname, (t1, t1))
342 self.assertEquals(os.stat(self.fname).st_mtime, t1)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000343
Guido van Rossumd8faa362007-04-27 19:54:29 +0000344 def test_1686475(self):
345 # Verify that an open file can be stat'ed
346 try:
347 os.stat(r"c:\pagefile.sys")
348 except WindowsError as e:
Benjamin Petersonc4fe6f32008-08-19 18:57:56 +0000349 if e.errno == 2: # file does not exist; cannot run test
Guido van Rossumd8faa362007-04-27 19:54:29 +0000350 return
351 self.fail("Could not stat pagefile.sys")
352
Walter Dörwald0a6d0ff2004-05-31 16:29:04 +0000353from test import mapping_tests
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000354
Walter Dörwald0a6d0ff2004-05-31 16:29:04 +0000355class EnvironTests(mapping_tests.BasicTestMappingProtocol):
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000356 """check that os.environ object conform to mapping protocol"""
Walter Dörwald118f9312004-06-02 18:42:25 +0000357 type2test = None
Christian Heimes90333392007-11-01 19:08:42 +0000358
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000359 def setUp(self):
360 self.__save = dict(os.environ)
Christian Heimes90333392007-11-01 19:08:42 +0000361 for key, value in self._reference().items():
362 os.environ[key] = value
363
Raymond Hettinger2c2d3222003-03-09 07:05:43 +0000364 def tearDown(self):
365 os.environ.clear()
366 os.environ.update(self.__save)
367
Christian Heimes90333392007-11-01 19:08:42 +0000368 def _reference(self):
369 return {"KEY1":"VALUE1", "KEY2":"VALUE2", "KEY3":"VALUE3"}
370
371 def _empty_mapping(self):
372 os.environ.clear()
373 return os.environ
374
Martin v. Löwis1d11de62005-01-29 13:29:23 +0000375 # Bug 1110478
Martin v. Löwis5510f652005-02-17 21:23:20 +0000376 def test_update2(self):
Christian Heimes90333392007-11-01 19:08:42 +0000377 os.environ.clear()
Martin v. Löwis1d11de62005-01-29 13:29:23 +0000378 if os.path.exists("/bin/sh"):
379 os.environ.update(HELLO="World")
380 value = os.popen("/bin/sh -c 'echo $HELLO'").read().strip()
381 self.assertEquals(value, "World")
382
Christian Heimes1a13d592007-11-08 14:16:55 +0000383 def test_os_popen_iter(self):
384 if os.path.exists("/bin/sh"):
385 popen = os.popen("/bin/sh -c 'echo \"line1\nline2\nline3\"'")
386 it = iter(popen)
387 self.assertEquals(next(it), "line1\n")
388 self.assertEquals(next(it), "line2\n")
389 self.assertEquals(next(it), "line3\n")
390 self.assertRaises(StopIteration, next, it)
391
Guido van Rossum67aca9e2007-06-13 21:51:27 +0000392 # Verify environ keys and values from the OS are of the
393 # correct str type.
394 def test_keyvalue_types(self):
395 for key, val in os.environ.items():
396 self.assertEquals(type(key), str)
397 self.assertEquals(type(val), str)
398
Christian Heimes90333392007-11-01 19:08:42 +0000399 def test_items(self):
400 for key, value in self._reference().items():
401 self.assertEqual(os.environ.get(key), value)
402
Tim Petersc4e09402003-04-25 07:11:48 +0000403class WalkTests(unittest.TestCase):
404 """Tests for os.walk()."""
405
406 def test_traversal(self):
407 import os
408 from os.path import join
409
410 # Build:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000411 # TESTFN/
412 # TEST1/ a file kid and two directory kids
Tim Petersc4e09402003-04-25 07:11:48 +0000413 # tmp1
414 # SUB1/ a file kid and a directory kid
Guido van Rossumd8faa362007-04-27 19:54:29 +0000415 # tmp2
416 # SUB11/ no kids
417 # SUB2/ a file kid and a dirsymlink kid
418 # tmp3
419 # link/ a symlink to TESTFN.2
420 # TEST2/
421 # tmp4 a lone file
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000422 walk_path = join(support.TESTFN, "TEST1")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000423 sub1_path = join(walk_path, "SUB1")
Tim Petersc4e09402003-04-25 07:11:48 +0000424 sub11_path = join(sub1_path, "SUB11")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000425 sub2_path = join(walk_path, "SUB2")
426 tmp1_path = join(walk_path, "tmp1")
Tim Petersc4e09402003-04-25 07:11:48 +0000427 tmp2_path = join(sub1_path, "tmp2")
428 tmp3_path = join(sub2_path, "tmp3")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000429 link_path = join(sub2_path, "link")
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000430 t2_path = join(support.TESTFN, "TEST2")
431 tmp4_path = join(support.TESTFN, "TEST2", "tmp4")
Tim Petersc4e09402003-04-25 07:11:48 +0000432
433 # Create stuff.
434 os.makedirs(sub11_path)
435 os.makedirs(sub2_path)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000436 os.makedirs(t2_path)
437 for path in tmp1_path, tmp2_path, tmp3_path, tmp4_path:
Alex Martelli01c77c62006-08-24 02:58:11 +0000438 f = open(path, "w")
Tim Petersc4e09402003-04-25 07:11:48 +0000439 f.write("I'm " + path + " and proud of it. Blame test_os.\n")
440 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000441 if hasattr(os, "symlink"):
442 os.symlink(os.path.abspath(t2_path), link_path)
443 sub2_tree = (sub2_path, ["link"], ["tmp3"])
444 else:
445 sub2_tree = (sub2_path, [], ["tmp3"])
Tim Petersc4e09402003-04-25 07:11:48 +0000446
447 # Walk top-down.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000448 all = list(os.walk(walk_path))
Tim Petersc4e09402003-04-25 07:11:48 +0000449 self.assertEqual(len(all), 4)
450 # We can't know which order SUB1 and SUB2 will appear in.
451 # Not flipped: TESTFN, SUB1, SUB11, SUB2
452 # flipped: TESTFN, SUB2, SUB1, SUB11
453 flipped = all[0][1][0] != "SUB1"
454 all[0][1].sort()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000455 self.assertEqual(all[0], (walk_path, ["SUB1", "SUB2"], ["tmp1"]))
Tim Petersc4e09402003-04-25 07:11:48 +0000456 self.assertEqual(all[1 + flipped], (sub1_path, ["SUB11"], ["tmp2"]))
457 self.assertEqual(all[2 + flipped], (sub11_path, [], []))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000458 self.assertEqual(all[3 - 2 * flipped], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000459
460 # Prune the search.
461 all = []
Guido van Rossumd8faa362007-04-27 19:54:29 +0000462 for root, dirs, files in os.walk(walk_path):
Tim Petersc4e09402003-04-25 07:11:48 +0000463 all.append((root, dirs, files))
464 # Don't descend into SUB1.
465 if 'SUB1' in dirs:
466 # Note that this also mutates the dirs we appended to all!
467 dirs.remove('SUB1')
468 self.assertEqual(len(all), 2)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000469 self.assertEqual(all[0], (walk_path, ["SUB2"], ["tmp1"]))
470 self.assertEqual(all[1], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000471
472 # Walk bottom-up.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000473 all = list(os.walk(walk_path, topdown=False))
Tim Petersc4e09402003-04-25 07:11:48 +0000474 self.assertEqual(len(all), 4)
475 # We can't know which order SUB1 and SUB2 will appear in.
476 # Not flipped: SUB11, SUB1, SUB2, TESTFN
477 # flipped: SUB2, SUB11, SUB1, TESTFN
478 flipped = all[3][1][0] != "SUB1"
479 all[3][1].sort()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000480 self.assertEqual(all[3], (walk_path, ["SUB1", "SUB2"], ["tmp1"]))
Tim Petersc4e09402003-04-25 07:11:48 +0000481 self.assertEqual(all[flipped], (sub11_path, [], []))
482 self.assertEqual(all[flipped + 1], (sub1_path, ["SUB11"], ["tmp2"]))
Guido van Rossumd8faa362007-04-27 19:54:29 +0000483 self.assertEqual(all[2 - 2 * flipped], sub2_tree)
Tim Petersc4e09402003-04-25 07:11:48 +0000484
Guido van Rossumd8faa362007-04-27 19:54:29 +0000485 if hasattr(os, "symlink"):
486 # Walk, following symlinks.
487 for root, dirs, files in os.walk(walk_path, followlinks=True):
488 if root == link_path:
489 self.assertEqual(dirs, [])
490 self.assertEqual(files, ["tmp4"])
491 break
492 else:
493 self.fail("Didn't follow symlink with followlinks=True")
494
495 def tearDown(self):
Tim Petersc4e09402003-04-25 07:11:48 +0000496 # Tear everything down. This is a decent use for bottom-up on
497 # Windows, which doesn't have a recursive delete command. The
498 # (not so) subtlety is that rmdir will fail unless the dir's
499 # kids are removed first, so bottom up is essential.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000500 for root, dirs, files in os.walk(support.TESTFN, topdown=False):
Tim Petersc4e09402003-04-25 07:11:48 +0000501 for name in files:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000502 os.remove(os.path.join(root, name))
Tim Petersc4e09402003-04-25 07:11:48 +0000503 for name in dirs:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000504 dirname = os.path.join(root, name)
505 if not os.path.islink(dirname):
506 os.rmdir(dirname)
507 else:
508 os.remove(dirname)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000509 os.rmdir(support.TESTFN)
Tim Petersc4e09402003-04-25 07:11:48 +0000510
Guido van Rossume7ba4952007-06-06 23:52:48 +0000511class MakedirTests(unittest.TestCase):
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000512 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000513 os.mkdir(support.TESTFN)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000514
515 def test_makedir(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000516 base = support.TESTFN
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000517 path = os.path.join(base, 'dir1', 'dir2', 'dir3')
518 os.makedirs(path) # Should work
519 path = os.path.join(base, 'dir1', 'dir2', 'dir3', 'dir4')
520 os.makedirs(path)
521
522 # Try paths with a '.' in them
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000523 self.assertRaises(OSError, os.makedirs, os.curdir)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000524 path = os.path.join(base, 'dir1', 'dir2', 'dir3', 'dir4', 'dir5', os.curdir)
525 os.makedirs(path)
526 path = os.path.join(base, 'dir1', os.curdir, 'dir2', 'dir3', 'dir4',
527 'dir5', 'dir6')
528 os.makedirs(path)
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000529
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000530 def tearDown(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000531 path = os.path.join(support.TESTFN, 'dir1', 'dir2', 'dir3',
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000532 'dir4', 'dir5', 'dir6')
533 # If the tests failed, the bottom-most directory ('../dir6')
534 # may not have been created, so we look for the outermost directory
535 # that exists.
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000536 while not os.path.exists(path) and path != support.TESTFN:
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000537 path = os.path.dirname(path)
538
539 os.removedirs(path)
540
Guido van Rossume7ba4952007-06-06 23:52:48 +0000541class DevNullTests(unittest.TestCase):
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000542 def test_devnull(self):
Alex Martelli01c77c62006-08-24 02:58:11 +0000543 f = open(os.devnull, 'w')
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000544 f.write('hello')
545 f.close()
Alex Martelli01c77c62006-08-24 02:58:11 +0000546 f = open(os.devnull, 'r')
Tim Peters4182cfd2004-06-08 20:34:34 +0000547 self.assertEqual(f.read(), '')
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000548 f.close()
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000549
Guido van Rossume7ba4952007-06-06 23:52:48 +0000550class URandomTests(unittest.TestCase):
Martin v. Löwisdc3883f2004-08-29 15:46:35 +0000551 def test_urandom(self):
552 try:
553 self.assertEqual(len(os.urandom(1)), 1)
554 self.assertEqual(len(os.urandom(10)), 10)
555 self.assertEqual(len(os.urandom(100)), 100)
556 self.assertEqual(len(os.urandom(1000)), 1000)
557 except NotImplementedError:
558 pass
559
Guido van Rossume7ba4952007-06-06 23:52:48 +0000560class ExecTests(unittest.TestCase):
561 def test_execvpe_with_bad_program(self):
Thomas Hellerbd315c52007-08-30 17:57:21 +0000562 self.assertRaises(OSError, os.execvpe, 'no such app-', ['no such app-'], None)
Guido van Rossume7ba4952007-06-06 23:52:48 +0000563
Thomas Heller6790d602007-08-30 17:15:14 +0000564 def test_execvpe_with_bad_arglist(self):
565 self.assertRaises(ValueError, os.execvpe, 'notepad', [], None)
566
Antoine Pitrou1119a642010-01-17 12:16:23 +0000567class ArgTests(unittest.TestCase):
568 def test_bytearray(self):
569 # Issue #7561: posix module didn't release bytearray exports properly.
570 b = bytearray(os.sep.encode('ascii'))
571 self.assertRaises(OSError, os.mkdir, b)
572 # Check object is still resizable.
573 b[:] = b''
574
Thomas Wouters477c8d52006-05-27 19:21:47 +0000575class Win32ErrorTests(unittest.TestCase):
576 def test_rename(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000577 self.assertRaises(WindowsError, os.rename, support.TESTFN, support.TESTFN+".bak")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000578
579 def test_remove(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000580 self.assertRaises(WindowsError, os.remove, support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000581
582 def test_chdir(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000583 self.assertRaises(WindowsError, os.chdir, support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000584
585 def test_mkdir(self):
Amaury Forgeot d'Arc2fc224f2009-02-19 23:23:47 +0000586 f = open(support.TESTFN, "w")
Benjamin Petersonf91df042009-02-13 02:50:59 +0000587 try:
588 self.assertRaises(WindowsError, os.mkdir, support.TESTFN)
589 finally:
590 f.close()
Amaury Forgeot d'Arc2fc224f2009-02-19 23:23:47 +0000591 os.unlink(support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000592
593 def test_utime(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000594 self.assertRaises(WindowsError, os.utime, support.TESTFN, None)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000595
Thomas Wouters477c8d52006-05-27 19:21:47 +0000596 def test_chmod(self):
Benjamin Petersonf91df042009-02-13 02:50:59 +0000597 self.assertRaises(WindowsError, os.chmod, support.TESTFN, 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000598
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000599class TestInvalidFD(unittest.TestCase):
Benjamin Peterson05e782f2009-01-19 15:15:02 +0000600 singles = ["fchdir", "dup", "fdopen", "fdatasync", "fstat",
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000601 "fstatvfs", "fsync", "tcgetpgrp", "ttyname"]
602 #singles.append("close")
603 #We omit close because it doesn'r raise an exception on some platforms
604 def get_single(f):
605 def helper(self):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000606 if hasattr(os, f):
607 self.check(getattr(os, f))
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000608 return helper
609 for f in singles:
610 locals()["test_"+f] = get_single(f)
611
Benjamin Peterson7522c742009-01-19 21:00:09 +0000612 def check(self, f, *args):
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000613 try:
614 f(support.make_bad_fd(), *args)
615 except OSError as e:
616 self.assertEqual(e.errno, errno.EBADF)
617 else:
618 self.fail("%r didn't raise a OSError with a bad file descriptor"
619 % f)
Benjamin Peterson7522c742009-01-19 21:00:09 +0000620
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000621 def test_isatty(self):
622 if hasattr(os, "isatty"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000623 self.assertEqual(os.isatty(support.make_bad_fd()), False)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000624
625 def test_closerange(self):
626 if hasattr(os, "closerange"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000627 fd = support.make_bad_fd()
R. David Murray630cc482009-07-22 15:20:27 +0000628 # Make sure none of the descriptors we are about to close are
629 # currently valid (issue 6542).
630 for i in range(10):
631 try: os.fstat(fd+i)
632 except OSError:
633 pass
634 else:
635 break
636 if i < 2:
637 raise unittest.SkipTest(
638 "Unable to acquire a range of invalid file descriptors")
639 self.assertEqual(os.closerange(fd, fd + i-1), None)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000640
641 def test_dup2(self):
642 if hasattr(os, "dup2"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000643 self.check(os.dup2, 20)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000644
645 def test_fchmod(self):
646 if hasattr(os, "fchmod"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000647 self.check(os.fchmod, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000648
649 def test_fchown(self):
650 if hasattr(os, "fchown"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000651 self.check(os.fchown, -1, -1)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000652
653 def test_fpathconf(self):
654 if hasattr(os, "fpathconf"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000655 self.check(os.fpathconf, "PC_NAME_MAX")
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000656
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000657 def test_ftruncate(self):
658 if hasattr(os, "ftruncate"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000659 self.check(os.ftruncate, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000660
661 def test_lseek(self):
662 if hasattr(os, "lseek"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000663 self.check(os.lseek, 0, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000664
665 def test_read(self):
666 if hasattr(os, "read"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000667 self.check(os.read, 1)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000668
669 def test_tcsetpgrpt(self):
670 if hasattr(os, "tcsetpgrp"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000671 self.check(os.tcsetpgrp, 0)
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000672
673 def test_write(self):
674 if hasattr(os, "write"):
Benjamin Peterson7522c742009-01-19 21:00:09 +0000675 self.check(os.write, b" ")
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000676
Thomas Wouters477c8d52006-05-27 19:21:47 +0000677if sys.platform != 'win32':
678 class Win32ErrorTests(unittest.TestCase):
679 pass
680
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000681 class PosixUidGidTests(unittest.TestCase):
682 if hasattr(os, 'setuid'):
683 def test_setuid(self):
684 if os.getuid() != 0:
685 self.assertRaises(os.error, os.setuid, 0)
686 self.assertRaises(OverflowError, os.setuid, 1<<32)
687
688 if hasattr(os, 'setgid'):
689 def test_setgid(self):
690 if os.getuid() != 0:
691 self.assertRaises(os.error, os.setgid, 0)
692 self.assertRaises(OverflowError, os.setgid, 1<<32)
693
694 if hasattr(os, 'seteuid'):
695 def test_seteuid(self):
696 if os.getuid() != 0:
697 self.assertRaises(os.error, os.seteuid, 0)
698 self.assertRaises(OverflowError, os.seteuid, 1<<32)
699
700 if hasattr(os, 'setegid'):
701 def test_setegid(self):
702 if os.getuid() != 0:
703 self.assertRaises(os.error, os.setegid, 0)
704 self.assertRaises(OverflowError, os.setegid, 1<<32)
705
706 if hasattr(os, 'setreuid'):
707 def test_setreuid(self):
708 if os.getuid() != 0:
709 self.assertRaises(os.error, os.setreuid, 0, 0)
710 self.assertRaises(OverflowError, os.setreuid, 1<<32, 0)
711 self.assertRaises(OverflowError, os.setreuid, 0, 1<<32)
712
713 if hasattr(os, 'setregid'):
714 def test_setregid(self):
715 if os.getuid() != 0:
716 self.assertRaises(os.error, os.setregid, 0, 0)
717 self.assertRaises(OverflowError, os.setregid, 1<<32, 0)
718 self.assertRaises(OverflowError, os.setregid, 0, 1<<32)
Martin v. Löwis011e8422009-05-05 04:43:17 +0000719
Mark Dickinson70613682009-05-05 21:34:59 +0000720 @unittest.skipIf(sys.platform == 'darwin', "tests don't apply to OS X")
Martin v. Löwis011e8422009-05-05 04:43:17 +0000721 class Pep383Tests(unittest.TestCase):
722 filenames = [b'foo\xf6bar', 'foo\xf6bar'.encode("utf-8")]
723
724 def setUp(self):
725 self.fsencoding = sys.getfilesystemencoding()
726 sys.setfilesystemencoding("utf-8")
727 self.dir = support.TESTFN
Martin v. Löwis43c57782009-05-10 08:15:24 +0000728 self.bdir = self.dir.encode("utf-8", "surrogateescape")
Martin v. Löwis011e8422009-05-05 04:43:17 +0000729 os.mkdir(self.dir)
730 self.unicodefn = []
731 for fn in self.filenames:
732 f = open(os.path.join(self.bdir, fn), "w")
733 f.close()
Martin v. Löwis43c57782009-05-10 08:15:24 +0000734 self.unicodefn.append(fn.decode("utf-8", "surrogateescape"))
Martin v. Löwis011e8422009-05-05 04:43:17 +0000735
736 def tearDown(self):
737 shutil.rmtree(self.dir)
738 sys.setfilesystemencoding(self.fsencoding)
739
740 def test_listdir(self):
741 expected = set(self.unicodefn)
742 found = set(os.listdir(support.TESTFN))
743 self.assertEquals(found, expected)
744
745 def test_open(self):
746 for fn in self.unicodefn:
747 f = open(os.path.join(self.dir, fn))
748 f.close()
749
750 def test_stat(self):
751 for fn in self.unicodefn:
752 os.stat(os.path.join(self.dir, fn))
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000753else:
754 class PosixUidGidTests(unittest.TestCase):
755 pass
Martin v. Löwis011e8422009-05-05 04:43:17 +0000756 class Pep383Tests(unittest.TestCase):
757 pass
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000758
Fred Drake2e2be372001-09-20 21:33:42 +0000759def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000760 support.run_unittest(
Antoine Pitrou1119a642010-01-17 12:16:23 +0000761 ArgTests,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000762 FileTests,
Walter Dörwald21d3a322003-05-01 17:45:56 +0000763 StatAttributeTests,
764 EnvironTests,
Andrew M. Kuchlingb386f6a2003-12-23 16:36:11 +0000765 WalkTests,
766 MakedirTests,
Martin v. Löwisbdec50f2004-06-08 08:29:33 +0000767 DevNullTests,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000768 URandomTests,
Guido van Rossume7ba4952007-06-06 23:52:48 +0000769 ExecTests,
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000770 Win32ErrorTests,
Benjamin Petersonef3e4c22009-04-11 19:48:14 +0000771 TestInvalidFD,
Martin v. Löwis011e8422009-05-05 04:43:17 +0000772 PosixUidGidTests,
773 Pep383Tests
Walter Dörwald21d3a322003-05-01 17:45:56 +0000774 )
Fred Drake2e2be372001-09-20 21:33:42 +0000775
776if __name__ == "__main__":
777 test_main()