1"""Tests for distutils.dir_util."""
2import unittest
3import os
4import stat
5import sys
6from unittest.mock import patch
7
8from distutils import dir_util, errors
9from distutils.dir_util import (mkpath, remove_tree, create_tree, copy_tree,
10                                ensure_relative)
11
12from distutils import log
13from distutils.tests import support
14from test.support import run_unittest
15
16
17class DirUtilTestCase(support.TempdirManager, unittest.TestCase):
18
19    def _log(self, msg, *args):
20        if len(args) > 0:
21            self._logs.append(msg % args)
22        else:
23            self._logs.append(msg)
24
25    def setUp(self):
26        super(DirUtilTestCase, self).setUp()
27        self._logs = []
28        tmp_dir = self.mkdtemp()
29        self.root_target = os.path.join(tmp_dir, 'deep')
30        self.target = os.path.join(self.root_target, 'here')
31        self.target2 = os.path.join(tmp_dir, 'deep2')
32        self.old_log = log.info
33        log.info = self._log
34
35    def tearDown(self):
36        log.info = self.old_log
37        super(DirUtilTestCase, self).tearDown()
38
39    def test_mkpath_remove_tree_verbosity(self):
40
41        mkpath(self.target, verbose=0)
42        wanted = []
43        self.assertEqual(self._logs, wanted)
44        remove_tree(self.root_target, verbose=0)
45
46        mkpath(self.target, verbose=1)
47        wanted = ['creating %s' % self.root_target,
48                  'creating %s' % self.target]
49        self.assertEqual(self._logs, wanted)
50        self._logs = []
51
52        remove_tree(self.root_target, verbose=1)
53        wanted = ["removing '%s' (and everything under it)" % self.root_target]
54        self.assertEqual(self._logs, wanted)
55
56    @unittest.skipIf(sys.platform.startswith('win'),
57        "This test is only appropriate for POSIX-like systems.")
58    def test_mkpath_with_custom_mode(self):
59        # Get and set the current umask value for testing mode bits.
60        umask = os.umask(0o002)
61        os.umask(umask)
62        mkpath(self.target, 0o700)
63        self.assertEqual(
64            stat.S_IMODE(os.stat(self.target).st_mode), 0o700 & ~umask)
65        mkpath(self.target2, 0o555)
66        self.assertEqual(
67            stat.S_IMODE(os.stat(self.target2).st_mode), 0o555 & ~umask)
68
69    def test_create_tree_verbosity(self):
70
71        create_tree(self.root_target, ['one', 'two', 'three'], verbose=0)
72        self.assertEqual(self._logs, [])
73        remove_tree(self.root_target, verbose=0)
74
75        wanted = ['creating %s' % self.root_target]
76        create_tree(self.root_target, ['one', 'two', 'three'], verbose=1)
77        self.assertEqual(self._logs, wanted)
78
79        remove_tree(self.root_target, verbose=0)
80
81    def test_copy_tree_verbosity(self):
82
83        mkpath(self.target, verbose=0)
84
85        copy_tree(self.target, self.target2, verbose=0)
86        self.assertEqual(self._logs, [])
87
88        remove_tree(self.root_target, verbose=0)
89
90        mkpath(self.target, verbose=0)
91        a_file = os.path.join(self.target, 'ok.txt')
92        with open(a_file, 'w') as f:
93            f.write('some content')
94
95        wanted = ['copying %s -> %s' % (a_file, self.target2)]
96        copy_tree(self.target, self.target2, verbose=1)
97        self.assertEqual(self._logs, wanted)
98
99        remove_tree(self.root_target, verbose=0)
100        remove_tree(self.target2, verbose=0)
101
102    def test_copy_tree_skips_nfs_temp_files(self):
103        mkpath(self.target, verbose=0)
104
105        a_file = os.path.join(self.target, 'ok.txt')
106        nfs_file = os.path.join(self.target, '.nfs123abc')
107        for f in a_file, nfs_file:
108            with open(f, 'w') as fh:
109                fh.write('some content')
110
111        copy_tree(self.target, self.target2)
112        self.assertEqual(os.listdir(self.target2), ['ok.txt'])
113
114        remove_tree(self.root_target, verbose=0)
115        remove_tree(self.target2, verbose=0)
116
117    def test_ensure_relative(self):
118        if os.sep == '/':
119            self.assertEqual(ensure_relative('/home/foo'), 'home/foo')
120            self.assertEqual(ensure_relative('some/path'), 'some/path')
121        else:   # \\
122            self.assertEqual(ensure_relative('c:\\home\\foo'), 'c:home\\foo')
123            self.assertEqual(ensure_relative('home\\foo'), 'home\\foo')
124
125    def test_copy_tree_exception_in_listdir(self):
126        """
127        An exception in listdir should raise a DistutilsFileError
128        """
129        with patch("os.listdir", side_effect=OSError()), \
130             self.assertRaises(errors.DistutilsFileError):
131            src = self.tempdirs[-1]
132            dir_util.copy_tree(src, None)
133
134
135def test_suite():
136    return unittest.makeSuite(DirUtilTestCase)
137
138if __name__ == "__main__":
139    run_unittest(test_suite())
140