codekingpro/portable-devtools

1"""Tests for distutils.dir_util."""2 3import os4import pathlib5import stat6import sys7import unittest.mock as mock8from distutils import dir_util, errors9from distutils.dir_util import (10    copy_tree,11    create_tree,12    ensure_relative,13    mkpath,14    remove_tree,15)16from distutils.tests import support17 18import jaraco.path19import path20import pytest21 22 23@pytest.fixture(autouse=True)24def stuff(request, monkeypatch, distutils_managed_tempdir):25    self = request.instance26    tmp_dir = self.mkdtemp()27    self.root_target = os.path.join(tmp_dir, 'deep')28    self.target = os.path.join(self.root_target, 'here')29    self.target2 = os.path.join(tmp_dir, 'deep2')30 31 32class TestDirUtil(support.TempdirManager):33    def test_mkpath_remove_tree_verbosity(self, caplog):34        mkpath(self.target, verbose=False)35        assert not caplog.records36        remove_tree(self.root_target, verbose=False)37 38        mkpath(self.target, verbose=True)39        wanted = [f'creating {self.target}']40        assert caplog.messages == wanted41        caplog.clear()42 43        remove_tree(self.root_target, verbose=True)44        wanted = [f"removing '{self.root_target}' (and everything under it)"]45        assert caplog.messages == wanted46 47    @pytest.mark.skipif("platform.system() == 'Windows'")48    def test_mkpath_with_custom_mode(self):49        # Get and set the current umask value for testing mode bits.50        umask = os.umask(0o002)51        os.umask(umask)52        mkpath(self.target, 0o700)53        assert stat.S_IMODE(os.stat(self.target).st_mode) == 0o700 & ~umask54        mkpath(self.target2, 0o555)55        assert stat.S_IMODE(os.stat(self.target2).st_mode) == 0o555 & ~umask56 57    def test_create_tree_verbosity(self, caplog):58        create_tree(self.root_target, ['one', 'two', 'three'], verbose=False)59        assert caplog.messages == []60        remove_tree(self.root_target, verbose=False)61 62        wanted = [f'creating {self.root_target}']63        create_tree(self.root_target, ['one', 'two', 'three'], verbose=True)64        assert caplog.messages == wanted65 66        remove_tree(self.root_target, verbose=False)67 68    def test_copy_tree_verbosity(self, caplog):69        mkpath(self.target, verbose=False)70 71        copy_tree(self.target, self.target2, verbose=False)72        assert caplog.messages == []73 74        remove_tree(self.root_target, verbose=False)75 76        mkpath(self.target, verbose=False)77        a_file = path.Path(self.target) / 'ok.txt'78        jaraco.path.build({'ok.txt': 'some content'}, self.target)79 80        wanted = [f'copying {a_file} -> {self.target2}']81        copy_tree(self.target, self.target2, verbose=True)82        assert caplog.messages == wanted83 84        remove_tree(self.root_target, verbose=False)85        remove_tree(self.target2, verbose=False)86 87    def test_copy_tree_skips_nfs_temp_files(self):88        mkpath(self.target, verbose=False)89 90        jaraco.path.build({'ok.txt': 'some content', '.nfs123abc': ''}, self.target)91 92        copy_tree(self.target, self.target2)93        assert os.listdir(self.target2) == ['ok.txt']94 95        remove_tree(self.root_target, verbose=False)96        remove_tree(self.target2, verbose=False)97 98    def test_ensure_relative(self):99        if os.sep == '/':100            assert ensure_relative('/home/foo') == 'home/foo'101            assert ensure_relative('some/path') == 'some/path'102        else:  # \\103            assert ensure_relative('c:\\home\\foo') == 'c:home\\foo'104            assert ensure_relative('home\\foo') == 'home\\foo'105 106    def test_copy_tree_exception_in_listdir(self):107        """108        An exception in listdir should raise a DistutilsFileError109        """110        with (111            mock.patch("os.listdir", side_effect=OSError()),112            pytest.raises(errors.DistutilsFileError),113        ):114            src = self.tempdirs[-1]115            dir_util.copy_tree(src, None)116 117    def test_mkpath_exception_uncached(self, monkeypatch, tmp_path):118        """119        Caching should not remember failed attempts.120 121        pypa/distutils#304122        """123 124        class FailPath(pathlib.Path):125            def mkdir(self, *args, **kwargs):126                raise OSError("Failed to create directory")127 128            if sys.version_info < (3, 12):129                _flavour = pathlib.Path()._flavour130 131        target = tmp_path / 'foodir'132 133        with pytest.raises(errors.DistutilsFileError):134            mkpath(FailPath(target))135 136        assert not target.exists()137 138        mkpath(target)139        assert target.exists()140