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, is_emscripten, is_wasi
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    @unittest.skipIf(
59        is_emscripten or is_wasi,
60        "Emscripten's/WASI's umask is a stub."
61    )
62    def test_mkpath_with_custom_mode(self):
63        # Get and set the current umask value for testing mode bits.
64        umask = os.umask(0o002)
65        os.umask(umask)
66        mkpath(self.target, 0o700)
67        self.assertEqual(
68            stat.S_IMODE(os.stat(self.target).st_mode), 0o700 & ~umask)
69        mkpath(self.target2, 0o555)
70        self.assertEqual(
71            stat.S_IMODE(os.stat(self.target2).st_mode), 0o555 & ~umask)
72
73    def test_create_tree_verbosity(self):
74
75        create_tree(self.root_target, ['one', 'two', 'three'], verbose=0)
76        self.assertEqual(self._logs, [])
77        remove_tree(self.root_target, verbose=0)
78
79        wanted = ['creating %s' % self.root_target]
80        create_tree(self.root_target, ['one', 'two', 'three'], verbose=1)
81        self.assertEqual(self._logs, wanted)
82
83        remove_tree(self.root_target, verbose=0)
84
85    def test_copy_tree_verbosity(self):
86
87        mkpath(self.target, verbose=0)
88
89        copy_tree(self.target, self.target2, verbose=0)
90        self.assertEqual(self._logs, [])
91
92        remove_tree(self.root_target, verbose=0)
93
94        mkpath(self.target, verbose=0)
95        a_file = os.path.join(self.target, 'ok.txt')
96        with open(a_file, 'w') as f:
97            f.write('some content')
98
99        wanted = ['copying %s -> %s' % (a_file, self.target2)]
100        copy_tree(self.target, self.target2, verbose=1)
101        self.assertEqual(self._logs, wanted)
102
103        remove_tree(self.root_target, verbose=0)
104        remove_tree(self.target2, verbose=0)
105
106    def test_copy_tree_skips_nfs_temp_files(self):
107        mkpath(self.target, verbose=0)
108
109        a_file = os.path.join(self.target, 'ok.txt')
110        nfs_file = os.path.join(self.target, '.nfs123abc')
111        for f in a_file, nfs_file:
112            with open(f, 'w') as fh:
113                fh.write('some content')
114
115        copy_tree(self.target, self.target2)
116        self.assertEqual(os.listdir(self.target2), ['ok.txt'])
117
118        remove_tree(self.root_target, verbose=0)
119        remove_tree(self.target2, verbose=0)
120
121    def test_ensure_relative(self):
122        if os.sep == '/':
123            self.assertEqual(ensure_relative('/home/foo'), 'home/foo')
124            self.assertEqual(ensure_relative('some/path'), 'some/path')
125        else:   # \\
126            self.assertEqual(ensure_relative('c:\\home\\foo'), 'c:home\\foo')
127            self.assertEqual(ensure_relative('home\\foo'), 'home\\foo')
128
129    def test_copy_tree_exception_in_listdir(self):
130        """
131        An exception in listdir should raise a DistutilsFileError
132        """
133        with patch("os.listdir", side_effect=OSError()), \
134             self.assertRaises(errors.DistutilsFileError):
135            src = self.tempdirs[-1]
136            dir_util.copy_tree(src, None)
137
138
139def test_suite():
140    return unittest.TestLoader().loadTestsFromTestCase(DirUtilTestCase)
141
142if __name__ == "__main__":
143    run_unittest(test_suite())
144