blob: dfa6f9ff30152b87e4bc726c4e23361b757314f8 [file] [log] [blame]
Barry Warsaw7fc2cca2003-01-24 17:34:13 +00001# Copyright (C) 2003 Python Software Foundation
2
3import unittest
4import shutil
5import tempfile
Johannes Gijsbers8e6f2de2004-11-23 09:27:27 +00006import sys
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +00007import stat
Brett Cannon1c3fa182004-06-19 21:11:35 +00008import os
9import os.path
Benjamin Petersonee8712c2008-05-20 21:35:26 +000010from test import support
11from test.support import TESTFN
Tarek Ziadé396fad72010-02-23 05:30:31 +000012from os.path import splitdrive
13from distutils.spawn import find_executable, spawn
14from shutil import (_make_tarball, _make_zipfile, make_archive,
15 register_archive_format, unregister_archive_format,
16 get_archive_formats)
17import tarfile
18import warnings
19
20from test import support
21from test.support import TESTFN, check_warnings, captured_stdout
22
Antoine Pitrou7fff0962009-05-01 21:09:44 +000023TESTFN2 = TESTFN + "2"
Barry Warsaw7fc2cca2003-01-24 17:34:13 +000024
Tarek Ziadé396fad72010-02-23 05:30:31 +000025try:
26 import grp
27 import pwd
28 UID_GID_SUPPORT = True
29except ImportError:
30 UID_GID_SUPPORT = False
31
32try:
33 import zlib
34except ImportError:
35 zlib = None
36
37try:
38 import zipfile
39 ZIP_SUPPORT = True
40except ImportError:
41 ZIP_SUPPORT = find_executable('zip')
42
Barry Warsaw7fc2cca2003-01-24 17:34:13 +000043class TestShutil(unittest.TestCase):
Tarek Ziadé396fad72010-02-23 05:30:31 +000044
45 def setUp(self):
46 super(TestShutil, self).setUp()
47 self.tempdirs = []
48
49 def tearDown(self):
50 super(TestShutil, self).tearDown()
51 while self.tempdirs:
52 d = self.tempdirs.pop()
53 shutil.rmtree(d, os.name in ('nt', 'cygwin'))
54
55 def write_file(self, path, content='xxx'):
56 """Writes a file in the given path.
57
58
59 path can be a string or a sequence.
60 """
61 if isinstance(path, (list, tuple)):
62 path = os.path.join(*path)
63 f = open(path, 'w')
64 try:
65 f.write(content)
66 finally:
67 f.close()
68
69 def mkdtemp(self):
70 """Create a temporary directory that will be cleaned up.
71
72 Returns the path of the directory.
73 """
74 d = tempfile.mkdtemp()
75 self.tempdirs.append(d)
76 return d
Tarek Ziadé5340db32010-04-19 22:30:51 +000077
Barry Warsaw7fc2cca2003-01-24 17:34:13 +000078 def test_rmtree_errors(self):
79 # filename is guaranteed not to exist
80 filename = tempfile.mktemp()
81 self.assertRaises(OSError, shutil.rmtree, filename)
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +000082
Johannes Gijsbersb8b09d02004-12-06 20:50:15 +000083 # See bug #1071513 for why we don't run this on cygwin
84 # and bug #1076467 for why we don't run this as root.
85 if (hasattr(os, 'chmod') and sys.platform[:6] != 'cygwin'
Johannes Gijsbers6b220b02004-12-12 15:52:57 +000086 and not (hasattr(os, 'geteuid') and os.geteuid() == 0)):
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +000087 def test_on_error(self):
88 self.errorState = 0
89 os.mkdir(TESTFN)
Tim Peters4590c002004-11-01 02:40:52 +000090 self.childpath = os.path.join(TESTFN, 'a')
91 f = open(self.childpath, 'w')
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +000092 f.close()
Tim Peters4590c002004-11-01 02:40:52 +000093 old_dir_mode = os.stat(TESTFN).st_mode
94 old_child_mode = os.stat(self.childpath).st_mode
95 # Make unwritable.
96 os.chmod(self.childpath, stat.S_IREAD)
97 os.chmod(TESTFN, stat.S_IREAD)
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +000098
99 shutil.rmtree(TESTFN, onerror=self.check_args_to_onerror)
Johannes Gijsbers8e6f2de2004-11-23 09:27:27 +0000100 # Test whether onerror has actually been called.
Johannes Gijsbersb8b09d02004-12-06 20:50:15 +0000101 self.assertEqual(self.errorState, 2,
102 "Expected call to onerror function did not happen.")
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +0000103
Tim Peters4590c002004-11-01 02:40:52 +0000104 # Make writable again.
105 os.chmod(TESTFN, old_dir_mode)
106 os.chmod(self.childpath, old_child_mode)
107
108 # Clean up.
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +0000109 shutil.rmtree(TESTFN)
110
111 def check_args_to_onerror(self, func, arg, exc):
Benjamin Peterson25c95f12009-05-08 20:42:26 +0000112 # test_rmtree_errors deliberately runs rmtree
113 # on a directory that is chmod 400, which will fail.
114 # This function is run when shutil.rmtree fails.
115 # 99.9% of the time it initially fails to remove
116 # a file in the directory, so the first time through
117 # func is os.remove.
118 # However, some Linux machines running ZFS on
119 # FUSE experienced a failure earlier in the process
120 # at os.listdir. The first failure may legally
121 # be either.
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +0000122 if self.errorState == 0:
Benjamin Peterson25c95f12009-05-08 20:42:26 +0000123 if func is os.remove:
124 self.assertEqual(arg, self.childpath)
125 else:
126 self.assertIs(func, os.listdir,
127 "func must be either os.remove or os.listdir")
128 self.assertEqual(arg, TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000129 self.assertTrue(issubclass(exc[0], OSError))
Johannes Gijsbersef5ffc42004-10-31 12:05:31 +0000130 self.errorState = 1
131 else:
132 self.assertEqual(func, os.rmdir)
133 self.assertEqual(arg, TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000134 self.assertTrue(issubclass(exc[0], OSError))
Johannes Gijsbers8e6f2de2004-11-23 09:27:27 +0000135 self.errorState = 2
Barry Warsaw7fc2cca2003-01-24 17:34:13 +0000136
Johannes Gijsbersd60e92a2004-09-11 21:26:21 +0000137 def test_rmtree_dont_delete_file(self):
138 # When called on a file instead of a directory, don't delete it.
139 handle, path = tempfile.mkstemp()
140 os.fdopen(handle).close()
141 self.assertRaises(OSError, shutil.rmtree, path)
142 os.remove(path)
143
Tarek Ziadé5340db32010-04-19 22:30:51 +0000144 def _write_data(self, path, data):
145 f = open(path, "w")
146 f.write(data)
147 f.close()
148
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000149 def test_copytree_simple(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000150
151 def read_data(path):
152 f = open(path)
153 data = f.read()
154 f.close()
155 return data
156
157 src_dir = tempfile.mkdtemp()
158 dst_dir = os.path.join(tempfile.mkdtemp(), 'destination')
Tarek Ziadé5340db32010-04-19 22:30:51 +0000159 self._write_data(os.path.join(src_dir, 'test.txt'), '123')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000160 os.mkdir(os.path.join(src_dir, 'test_dir'))
Tarek Ziadé5340db32010-04-19 22:30:51 +0000161 self._write_data(os.path.join(src_dir, 'test_dir', 'test.txt'), '456')
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000162
163 try:
164 shutil.copytree(src_dir, dst_dir)
165 self.assertTrue(os.path.isfile(os.path.join(dst_dir, 'test.txt')))
166 self.assertTrue(os.path.isdir(os.path.join(dst_dir, 'test_dir')))
167 self.assertTrue(os.path.isfile(os.path.join(dst_dir, 'test_dir',
168 'test.txt')))
169 actual = read_data(os.path.join(dst_dir, 'test.txt'))
170 self.assertEqual(actual, '123')
171 actual = read_data(os.path.join(dst_dir, 'test_dir', 'test.txt'))
172 self.assertEqual(actual, '456')
173 finally:
174 for path in (
175 os.path.join(src_dir, 'test.txt'),
176 os.path.join(dst_dir, 'test.txt'),
177 os.path.join(src_dir, 'test_dir', 'test.txt'),
178 os.path.join(dst_dir, 'test_dir', 'test.txt'),
179 ):
180 if os.path.exists(path):
181 os.remove(path)
Christian Heimese052dd82007-11-20 03:20:04 +0000182 for path in (src_dir,
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000183 os.path.dirname(dst_dir)
Christian Heimese052dd82007-11-20 03:20:04 +0000184 ):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000185 if os.path.exists(path):
Christian Heimes94140152007-11-20 01:45:17 +0000186 shutil.rmtree(path)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000187
Georg Brandl2ee470f2008-07-16 12:55:28 +0000188 def test_copytree_with_exclude(self):
189
Georg Brandl2ee470f2008-07-16 12:55:28 +0000190 def read_data(path):
191 f = open(path)
192 data = f.read()
193 f.close()
194 return data
195
196 # creating data
197 join = os.path.join
198 exists = os.path.exists
199 src_dir = tempfile.mkdtemp()
Georg Brandl2ee470f2008-07-16 12:55:28 +0000200 try:
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000201 dst_dir = join(tempfile.mkdtemp(), 'destination')
Tarek Ziadé5340db32010-04-19 22:30:51 +0000202 self._write_data(join(src_dir, 'test.txt'), '123')
203 self._write_data(join(src_dir, 'test.tmp'), '123')
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000204 os.mkdir(join(src_dir, 'test_dir'))
Tarek Ziadé5340db32010-04-19 22:30:51 +0000205 self._write_data(join(src_dir, 'test_dir', 'test.txt'), '456')
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000206 os.mkdir(join(src_dir, 'test_dir2'))
Tarek Ziadé5340db32010-04-19 22:30:51 +0000207 self._write_data(join(src_dir, 'test_dir2', 'test.txt'), '456')
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000208 os.mkdir(join(src_dir, 'test_dir2', 'subdir'))
209 os.mkdir(join(src_dir, 'test_dir2', 'subdir2'))
Tarek Ziadé5340db32010-04-19 22:30:51 +0000210 self._write_data(join(src_dir, 'test_dir2', 'subdir', 'test.txt'),
211 '456')
212 self._write_data(join(src_dir, 'test_dir2', 'subdir2', 'test.py'),
213 '456')
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000214
215
216 # testing glob-like patterns
217 try:
218 patterns = shutil.ignore_patterns('*.tmp', 'test_dir2')
219 shutil.copytree(src_dir, dst_dir, ignore=patterns)
220 # checking the result: some elements should not be copied
221 self.assertTrue(exists(join(dst_dir, 'test.txt')))
222 self.assertTrue(not exists(join(dst_dir, 'test.tmp')))
223 self.assertTrue(not exists(join(dst_dir, 'test_dir2')))
224 finally:
225 if os.path.exists(dst_dir):
226 shutil.rmtree(dst_dir)
227 try:
228 patterns = shutil.ignore_patterns('*.tmp', 'subdir*')
229 shutil.copytree(src_dir, dst_dir, ignore=patterns)
230 # checking the result: some elements should not be copied
231 self.assertTrue(not exists(join(dst_dir, 'test.tmp')))
232 self.assertTrue(not exists(join(dst_dir, 'test_dir2', 'subdir2')))
233 self.assertTrue(not exists(join(dst_dir, 'test_dir2', 'subdir')))
234 finally:
235 if os.path.exists(dst_dir):
236 shutil.rmtree(dst_dir)
237
238 # testing callable-style
239 try:
240 def _filter(src, names):
241 res = []
242 for name in names:
243 path = os.path.join(src, name)
244
245 if (os.path.isdir(path) and
246 path.split()[-1] == 'subdir'):
247 res.append(name)
248 elif os.path.splitext(path)[-1] in ('.py'):
249 res.append(name)
250 return res
251
252 shutil.copytree(src_dir, dst_dir, ignore=_filter)
253
254 # checking the result: some elements should not be copied
255 self.assertTrue(not exists(join(dst_dir, 'test_dir2', 'subdir2',
256 'test.py')))
257 self.assertTrue(not exists(join(dst_dir, 'test_dir2', 'subdir')))
258
259 finally:
260 if os.path.exists(dst_dir):
261 shutil.rmtree(dst_dir)
Georg Brandl2ee470f2008-07-16 12:55:28 +0000262 finally:
Antoine Pitrou97c81ef2009-11-04 00:57:15 +0000263 shutil.rmtree(src_dir)
264 shutil.rmtree(os.path.dirname(dst_dir))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000265
Johannes Gijsbers46f14592004-08-14 13:30:02 +0000266 if hasattr(os, "symlink"):
267 def test_dont_copy_file_onto_link_to_itself(self):
268 # bug 851123.
269 os.mkdir(TESTFN)
Johannes Gijsbers68128712004-08-14 13:57:08 +0000270 src = os.path.join(TESTFN, 'cheese')
271 dst = os.path.join(TESTFN, 'shop')
Johannes Gijsbers46f14592004-08-14 13:30:02 +0000272 try:
Johannes Gijsbers68128712004-08-14 13:57:08 +0000273 f = open(src, 'w')
Johannes Gijsbers46f14592004-08-14 13:30:02 +0000274 f.write('cheddar')
275 f.close()
Johannes Gijsbers68128712004-08-14 13:57:08 +0000276
277 os.link(src, dst)
278 self.assertRaises(shutil.Error, shutil.copyfile, src, dst)
279 self.assertEqual(open(src,'r').read(), 'cheddar')
280 os.remove(dst)
281
282 # Using `src` here would mean we end up with a symlink pointing
283 # to TESTFN/TESTFN/cheese, while it should point at
284 # TESTFN/cheese.
285 os.symlink('cheese', dst)
286 self.assertRaises(shutil.Error, shutil.copyfile, src, dst)
287 self.assertEqual(open(src,'r').read(), 'cheddar')
288 os.remove(dst)
Johannes Gijsbers46f14592004-08-14 13:30:02 +0000289 finally:
290 try:
291 shutil.rmtree(TESTFN)
292 except OSError:
293 pass
Brett Cannon1c3fa182004-06-19 21:11:35 +0000294
Christian Heimes9bd667a2008-01-20 15:14:11 +0000295 def test_rmtree_on_symlink(self):
296 # bug 1669.
297 os.mkdir(TESTFN)
298 try:
299 src = os.path.join(TESTFN, 'cheese')
300 dst = os.path.join(TESTFN, 'shop')
301 os.mkdir(src)
302 os.symlink(src, dst)
303 self.assertRaises(OSError, shutil.rmtree, dst)
304 finally:
305 shutil.rmtree(TESTFN, ignore_errors=True)
306
Antoine Pitrou7fff0962009-05-01 21:09:44 +0000307 if hasattr(os, "mkfifo"):
308 # Issue #3002: copyfile and copytree block indefinitely on named pipes
309 def test_copyfile_named_pipe(self):
310 os.mkfifo(TESTFN)
311 try:
312 self.assertRaises(shutil.SpecialFileError,
313 shutil.copyfile, TESTFN, TESTFN2)
314 self.assertRaises(shutil.SpecialFileError,
315 shutil.copyfile, __file__, TESTFN)
316 finally:
317 os.remove(TESTFN)
318
319 def test_copytree_named_pipe(self):
320 os.mkdir(TESTFN)
321 try:
322 subdir = os.path.join(TESTFN, "subdir")
323 os.mkdir(subdir)
324 pipe = os.path.join(subdir, "mypipe")
325 os.mkfifo(pipe)
326 try:
327 shutil.copytree(TESTFN, TESTFN2)
328 except shutil.Error as e:
329 errors = e.args[0]
330 self.assertEqual(len(errors), 1)
331 src, dst, error_msg = errors[0]
332 self.assertEqual("`%s` is a named pipe" % pipe, error_msg)
333 else:
334 self.fail("shutil.Error should have been raised")
335 finally:
336 shutil.rmtree(TESTFN, ignore_errors=True)
337 shutil.rmtree(TESTFN2, ignore_errors=True)
338
Tarek Ziadé5340db32010-04-19 22:30:51 +0000339 def test_copytree_special_func(self):
340
341 src_dir = self.mkdtemp()
342 dst_dir = os.path.join(self.mkdtemp(), 'destination')
343 self._write_data(os.path.join(src_dir, 'test.txt'), '123')
344 os.mkdir(os.path.join(src_dir, 'test_dir'))
345 self._write_data(os.path.join(src_dir, 'test_dir', 'test.txt'), '456')
346
347 copied = []
348 def _copy(src, dst):
349 copied.append((src, dst))
350
351 shutil.copytree(src_dir, dst_dir, copy_function=_copy)
352 self.assertEquals(len(copied), 2)
353
Tarek Ziadé396fad72010-02-23 05:30:31 +0000354 @unittest.skipUnless(zlib, "requires zlib")
355 def test_make_tarball(self):
356 # creating something to tar
357 tmpdir = self.mkdtemp()
358 self.write_file([tmpdir, 'file1'], 'xxx')
359 self.write_file([tmpdir, 'file2'], 'xxx')
360 os.mkdir(os.path.join(tmpdir, 'sub'))
361 self.write_file([tmpdir, 'sub', 'file3'], 'xxx')
362
363 tmpdir2 = self.mkdtemp()
364 unittest.skipUnless(splitdrive(tmpdir)[0] == splitdrive(tmpdir2)[0],
365 "source and target should be on same drive")
366
367 base_name = os.path.join(tmpdir2, 'archive')
368
369 # working with relative paths to avoid tar warnings
370 old_dir = os.getcwd()
371 os.chdir(tmpdir)
372 try:
373 _make_tarball(splitdrive(base_name)[1], '.')
374 finally:
375 os.chdir(old_dir)
376
377 # check if the compressed tarball was created
378 tarball = base_name + '.tar.gz'
379 self.assertTrue(os.path.exists(tarball))
380
381 # trying an uncompressed one
382 base_name = os.path.join(tmpdir2, 'archive')
383 old_dir = os.getcwd()
384 os.chdir(tmpdir)
385 try:
386 _make_tarball(splitdrive(base_name)[1], '.', compress=None)
387 finally:
388 os.chdir(old_dir)
389 tarball = base_name + '.tar'
390 self.assertTrue(os.path.exists(tarball))
391
392 def _tarinfo(self, path):
393 tar = tarfile.open(path)
394 try:
395 names = tar.getnames()
396 names.sort()
397 return tuple(names)
398 finally:
399 tar.close()
400
401 def _create_files(self):
402 # creating something to tar
403 tmpdir = self.mkdtemp()
404 dist = os.path.join(tmpdir, 'dist')
405 os.mkdir(dist)
406 self.write_file([dist, 'file1'], 'xxx')
407 self.write_file([dist, 'file2'], 'xxx')
408 os.mkdir(os.path.join(dist, 'sub'))
409 self.write_file([dist, 'sub', 'file3'], 'xxx')
410 os.mkdir(os.path.join(dist, 'sub2'))
411 tmpdir2 = self.mkdtemp()
412 base_name = os.path.join(tmpdir2, 'archive')
413 return tmpdir, tmpdir2, base_name
414
415 @unittest.skipUnless(zlib, "Requires zlib")
416 @unittest.skipUnless(find_executable('tar') and find_executable('gzip'),
417 'Need the tar command to run')
418 def test_tarfile_vs_tar(self):
419 tmpdir, tmpdir2, base_name = self._create_files()
420 old_dir = os.getcwd()
421 os.chdir(tmpdir)
422 try:
423 _make_tarball(base_name, 'dist')
424 finally:
425 os.chdir(old_dir)
426
427 # check if the compressed tarball was created
428 tarball = base_name + '.tar.gz'
429 self.assertTrue(os.path.exists(tarball))
430
431 # now create another tarball using `tar`
432 tarball2 = os.path.join(tmpdir, 'archive2.tar.gz')
433 tar_cmd = ['tar', '-cf', 'archive2.tar', 'dist']
434 gzip_cmd = ['gzip', '-f9', 'archive2.tar']
435 old_dir = os.getcwd()
436 os.chdir(tmpdir)
437 try:
438 with captured_stdout() as s:
439 spawn(tar_cmd)
440 spawn(gzip_cmd)
441 finally:
442 os.chdir(old_dir)
443
444 self.assertTrue(os.path.exists(tarball2))
445 # let's compare both tarballs
446 self.assertEquals(self._tarinfo(tarball), self._tarinfo(tarball2))
447
448 # trying an uncompressed one
449 base_name = os.path.join(tmpdir2, 'archive')
450 old_dir = os.getcwd()
451 os.chdir(tmpdir)
452 try:
453 _make_tarball(base_name, 'dist', compress=None)
454 finally:
455 os.chdir(old_dir)
456 tarball = base_name + '.tar'
457 self.assertTrue(os.path.exists(tarball))
458
459 # now for a dry_run
460 base_name = os.path.join(tmpdir2, 'archive')
461 old_dir = os.getcwd()
462 os.chdir(tmpdir)
463 try:
464 _make_tarball(base_name, 'dist', compress=None, dry_run=True)
465 finally:
466 os.chdir(old_dir)
467 tarball = base_name + '.tar'
468 self.assertTrue(os.path.exists(tarball))
469
470 @unittest.skipUnless(find_executable('compress'),
471 'The compress program is required')
472 def test_compress_deprecated(self):
473 tmpdir, tmpdir2, base_name = self._create_files()
474
475 # using compress and testing the PendingDeprecationWarning
476 old_dir = os.getcwd()
477 os.chdir(tmpdir)
478 try:
Florent Xicluna8fbddf12010-03-17 20:29:51 +0000479 with captured_stdout() as s, check_warnings(quiet=False) as w:
480 _make_tarball(base_name, 'dist', compress='compress')
Tarek Ziadé396fad72010-02-23 05:30:31 +0000481 finally:
482 os.chdir(old_dir)
483 tarball = base_name + '.tar.Z'
484 self.assertTrue(os.path.exists(tarball))
Florent Xicluna8fbddf12010-03-17 20:29:51 +0000485 self.assertEqual(len(w.warnings), 1)
Tarek Ziadé396fad72010-02-23 05:30:31 +0000486
487 # same test with dry_run
488 os.remove(tarball)
489 old_dir = os.getcwd()
490 os.chdir(tmpdir)
491 try:
Florent Xicluna8fbddf12010-03-17 20:29:51 +0000492 with captured_stdout() as s, check_warnings(quiet=False) as w:
493 _make_tarball(base_name, 'dist', compress='compress',
494 dry_run=True)
Tarek Ziadé396fad72010-02-23 05:30:31 +0000495 finally:
496 os.chdir(old_dir)
Florent Xicluna8fbddf12010-03-17 20:29:51 +0000497 self.assertFalse(os.path.exists(tarball))
498 self.assertEqual(len(w.warnings), 1)
Tarek Ziadé396fad72010-02-23 05:30:31 +0000499
500 @unittest.skipUnless(zlib, "Requires zlib")
501 @unittest.skipUnless(ZIP_SUPPORT, 'Need zip support to run')
502 def test_make_zipfile(self):
503 # creating something to tar
504 tmpdir = self.mkdtemp()
505 self.write_file([tmpdir, 'file1'], 'xxx')
506 self.write_file([tmpdir, 'file2'], 'xxx')
507
508 tmpdir2 = self.mkdtemp()
509 base_name = os.path.join(tmpdir2, 'archive')
510 _make_zipfile(base_name, tmpdir)
511
512 # check if the compressed tarball was created
513 tarball = base_name + '.zip'
514
515
516 def test_make_archive(self):
517 tmpdir = self.mkdtemp()
518 base_name = os.path.join(tmpdir, 'archive')
519 self.assertRaises(ValueError, make_archive, base_name, 'xxx')
520
521 @unittest.skipUnless(zlib, "Requires zlib")
522 def test_make_archive_owner_group(self):
523 # testing make_archive with owner and group, with various combinations
524 # this works even if there's not gid/uid support
525 if UID_GID_SUPPORT:
526 group = grp.getgrgid(0)[0]
527 owner = pwd.getpwuid(0)[0]
528 else:
529 group = owner = 'root'
530
531 base_dir, root_dir, base_name = self._create_files()
532 base_name = os.path.join(self.mkdtemp() , 'archive')
533 res = make_archive(base_name, 'zip', root_dir, base_dir, owner=owner,
534 group=group)
535 self.assertTrue(os.path.exists(res))
536
537 res = make_archive(base_name, 'zip', root_dir, base_dir)
538 self.assertTrue(os.path.exists(res))
539
540 res = make_archive(base_name, 'tar', root_dir, base_dir,
541 owner=owner, group=group)
542 self.assertTrue(os.path.exists(res))
543
544 res = make_archive(base_name, 'tar', root_dir, base_dir,
545 owner='kjhkjhkjg', group='oihohoh')
546 self.assertTrue(os.path.exists(res))
547
548 @unittest.skipUnless(zlib, "Requires zlib")
549 @unittest.skipUnless(UID_GID_SUPPORT, "Requires grp and pwd support")
550 def test_tarfile_root_owner(self):
551 tmpdir, tmpdir2, base_name = self._create_files()
552 old_dir = os.getcwd()
553 os.chdir(tmpdir)
554 group = grp.getgrgid(0)[0]
555 owner = pwd.getpwuid(0)[0]
556 try:
557 archive_name = _make_tarball(base_name, 'dist', compress=None,
558 owner=owner, group=group)
559 finally:
560 os.chdir(old_dir)
561
562 # check if the compressed tarball was created
563 self.assertTrue(os.path.exists(archive_name))
564
565 # now checks the rights
566 archive = tarfile.open(archive_name)
567 try:
568 for member in archive.getmembers():
569 self.assertEquals(member.uid, 0)
570 self.assertEquals(member.gid, 0)
571 finally:
572 archive.close()
573
574 def test_make_archive_cwd(self):
575 current_dir = os.getcwd()
576 def _breaks(*args, **kw):
577 raise RuntimeError()
578
579 register_archive_format('xxx', _breaks, [], 'xxx file')
580 try:
581 try:
582 make_archive('xxx', 'xxx', root_dir=self.mkdtemp())
583 except Exception:
584 pass
585 self.assertEquals(os.getcwd(), current_dir)
586 finally:
587 unregister_archive_format('xxx')
588
589 def test_register_archive_format(self):
590
591 self.assertRaises(TypeError, register_archive_format, 'xxx', 1)
592 self.assertRaises(TypeError, register_archive_format, 'xxx', lambda: x,
593 1)
594 self.assertRaises(TypeError, register_archive_format, 'xxx', lambda: x,
595 [(1, 2), (1, 2, 3)])
596
597 register_archive_format('xxx', lambda: x, [(1, 2)], 'xxx file')
598 formats = [name for name, params in get_archive_formats()]
599 self.assertIn('xxx', formats)
600
601 unregister_archive_format('xxx')
602 formats = [name for name, params in get_archive_formats()]
603 self.assertNotIn('xxx', formats)
604
Christian Heimes9bd667a2008-01-20 15:14:11 +0000605
Christian Heimesada8c3b2008-03-18 18:26:33 +0000606class TestMove(unittest.TestCase):
607
608 def setUp(self):
609 filename = "foo"
610 self.src_dir = tempfile.mkdtemp()
611 self.dst_dir = tempfile.mkdtemp()
612 self.src_file = os.path.join(self.src_dir, filename)
613 self.dst_file = os.path.join(self.dst_dir, filename)
614 # Try to create a dir in the current directory, hoping that it is
615 # not located on the same filesystem as the system tmp dir.
616 try:
617 self.dir_other_fs = tempfile.mkdtemp(
618 dir=os.path.dirname(__file__))
619 self.file_other_fs = os.path.join(self.dir_other_fs,
620 filename)
621 except OSError:
622 self.dir_other_fs = None
623 with open(self.src_file, "wb") as f:
624 f.write(b"spam")
625
626 def tearDown(self):
627 for d in (self.src_dir, self.dst_dir, self.dir_other_fs):
628 try:
629 if d:
630 shutil.rmtree(d)
631 except:
632 pass
633
634 def _check_move_file(self, src, dst, real_dst):
635 contents = open(src, "rb").read()
636 shutil.move(src, dst)
637 self.assertEqual(contents, open(real_dst, "rb").read())
638 self.assertFalse(os.path.exists(src))
639
640 def _check_move_dir(self, src, dst, real_dst):
641 contents = sorted(os.listdir(src))
642 shutil.move(src, dst)
643 self.assertEqual(contents, sorted(os.listdir(real_dst)))
644 self.assertFalse(os.path.exists(src))
645
646 def test_move_file(self):
647 # Move a file to another location on the same filesystem.
648 self._check_move_file(self.src_file, self.dst_file, self.dst_file)
649
650 def test_move_file_to_dir(self):
651 # Move a file inside an existing dir on the same filesystem.
652 self._check_move_file(self.src_file, self.dst_dir, self.dst_file)
653
654 def test_move_file_other_fs(self):
655 # Move a file to an existing dir on another filesystem.
656 if not self.dir_other_fs:
657 # skip
658 return
659 self._check_move_file(self.src_file, self.file_other_fs,
660 self.file_other_fs)
661
662 def test_move_file_to_dir_other_fs(self):
663 # Move a file to another location on another filesystem.
664 if not self.dir_other_fs:
665 # skip
666 return
667 self._check_move_file(self.src_file, self.dir_other_fs,
668 self.file_other_fs)
669
670 def test_move_dir(self):
671 # Move a dir to another location on the same filesystem.
672 dst_dir = tempfile.mktemp()
673 try:
674 self._check_move_dir(self.src_dir, dst_dir, dst_dir)
675 finally:
676 try:
677 shutil.rmtree(dst_dir)
678 except:
679 pass
680
681 def test_move_dir_other_fs(self):
682 # Move a dir to another location on another filesystem.
683 if not self.dir_other_fs:
684 # skip
685 return
686 dst_dir = tempfile.mktemp(dir=self.dir_other_fs)
687 try:
688 self._check_move_dir(self.src_dir, dst_dir, dst_dir)
689 finally:
690 try:
691 shutil.rmtree(dst_dir)
692 except:
693 pass
694
695 def test_move_dir_to_dir(self):
696 # Move a dir inside an existing dir on the same filesystem.
697 self._check_move_dir(self.src_dir, self.dst_dir,
698 os.path.join(self.dst_dir, os.path.basename(self.src_dir)))
699
700 def test_move_dir_to_dir_other_fs(self):
701 # Move a dir inside an existing dir on another filesystem.
702 if not self.dir_other_fs:
703 # skip
704 return
705 self._check_move_dir(self.src_dir, self.dir_other_fs,
706 os.path.join(self.dir_other_fs, os.path.basename(self.src_dir)))
707
708 def test_existing_file_inside_dest_dir(self):
709 # A file with the same name inside the destination dir already exists.
710 with open(self.dst_file, "wb"):
711 pass
712 self.assertRaises(shutil.Error, shutil.move, self.src_file, self.dst_dir)
713
714 def test_dont_move_dir_in_itself(self):
715 # Moving a dir inside itself raises an Error.
716 dst = os.path.join(self.src_dir, "bar")
717 self.assertRaises(shutil.Error, shutil.move, self.src_dir, dst)
718
Antoine Pitrou0dcc3cd2009-01-29 20:26:59 +0000719 def test_destinsrc_false_negative(self):
720 os.mkdir(TESTFN)
721 try:
722 for src, dst in [('srcdir', 'srcdir/dest')]:
723 src = os.path.join(TESTFN, src)
724 dst = os.path.join(TESTFN, dst)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000725 self.assertTrue(shutil._destinsrc(src, dst),
Benjamin Peterson247a9b82009-02-20 04:09:19 +0000726 msg='_destinsrc() wrongly concluded that '
Antoine Pitrou0dcc3cd2009-01-29 20:26:59 +0000727 'dst (%s) is not in src (%s)' % (dst, src))
728 finally:
729 shutil.rmtree(TESTFN, ignore_errors=True)
Christian Heimesada8c3b2008-03-18 18:26:33 +0000730
Antoine Pitrou0dcc3cd2009-01-29 20:26:59 +0000731 def test_destinsrc_false_positive(self):
732 os.mkdir(TESTFN)
733 try:
734 for src, dst in [('srcdir', 'src/dest'), ('srcdir', 'srcdir.new')]:
735 src = os.path.join(TESTFN, src)
736 dst = os.path.join(TESTFN, dst)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000737 self.assertFalse(shutil._destinsrc(src, dst),
Benjamin Peterson247a9b82009-02-20 04:09:19 +0000738 msg='_destinsrc() wrongly concluded that '
Antoine Pitrou0dcc3cd2009-01-29 20:26:59 +0000739 'dst (%s) is in src (%s)' % (dst, src))
740 finally:
741 shutil.rmtree(TESTFN, ignore_errors=True)
Christian Heimes9bd667a2008-01-20 15:14:11 +0000742
Tarek Ziadé5340db32010-04-19 22:30:51 +0000743
Barry Warsaw7fc2cca2003-01-24 17:34:13 +0000744def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000745 support.run_unittest(TestShutil, TestMove)
Barry Warsaw7fc2cca2003-01-24 17:34:13 +0000746
Barry Warsaw7fc2cca2003-01-24 17:34:13 +0000747if __name__ == '__main__':
Walter Dörwald21d3a322003-05-01 17:45:56 +0000748 test_main()