tests.test_rmtree_error_uses_callback()

Complexity

Conditions

7

Size

Total Lines

36

Duplication

Lines	0
Ratio	0 %

1 Method

Rating	Name	Duplication	Size	Complexity
A	tests.fail_if_readonly()	0	4	2

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
test_utils
------------

Tests for `cookiecutter.utils` module.
"""

import os
import pytest
import stat
import sys

from cookiecutter import utils


def make_readonly(path):
    """Helper function that is called in the tests to change the access
    permissions of the given file.
    """
    mode = os.stat(path).st_mode
    os.chmod(path, mode & ~stat.S_IWRITE)


def test_rmtree():
    os.mkdir('foo')
    with open('foo/bar', "w") as f:
        f.write("Test data")
    make_readonly('foo/bar')
    utils.rmtree('foo')
    assert not os.path.exists('foo')


def test_rmtree_error_uses_callback(mocker):
    """
    Test that on system who fails deleting files when those files
    are read only, the workaround that sets them to writable first
    works.
    """

    # Setting up mocks to check if callbacks were really called
    real_force_delete = utils.force_delete
    force_delete = mocker.patch("cookiecutter.utils.force_delete")
    force_delete.side_effect = real_force_delete

    real_unlink = os.unlink
    # python 2.7 uses os.remove, python3.+ uses os.unlink
    unlink = mocker.patch("os.unlink")
    mocker.patch("os.remove", new=unlink)

    def fail_if_readonly(*args, **kwargs):
        if not os.stat("foo/bar").st_mode & stat.S_IWRITE:
            raise OSError
        real_unlink(*args, **kwargs)

    unlink.side_effect = fail_if_readonly

    # Doing the same as in test_rmtree
    os.mkdir('foo')
    with open('foo/bar', "w") as f:
        f.write("Test data")
    make_readonly('foo/bar')
    utils.rmtree('foo')
    assert not os.path.exists('foo')

    # Validating that it's really the callback that helped
    # having the desired behaviour
    assert len(unlink.mock_calls) == 2
    assert len(force_delete.mock_calls) == 1


def test_make_sure_path_exists():
    if sys.platform.startswith('win'):
        existing_directory = os.path.abspath(os.curdir)
        uncreatable_directory = 'a*b'
    else:
        existing_directory = '/usr/'
        uncreatable_directory = '/this-doesnt-exist-and-cant-be-created/'

    assert utils.make_sure_path_exists(existing_directory)
    assert utils.make_sure_path_exists('tests/blah')
    assert utils.make_sure_path_exists('tests/trailingslash/')
    assert not utils.make_sure_path_exists(uncreatable_directory)
    utils.rmtree('tests/blah/')
    utils.rmtree('tests/trailingslash/')


def test_workin():
    cwd = os.getcwd()
    ch_to = 'tests/files'

    class TestException(Exception):
        pass

    def test_work_in():
        with utils.work_in(ch_to):
            test_dir = os.path.join(cwd, ch_to).replace("/", os.sep)
            assert test_dir == os.getcwd()
            raise TestException()

    # Make sure we return to the correct folder
    assert cwd == os.getcwd()

    # Make sure that exceptions are still bubbled up
    with pytest.raises(TestException):
        test_work_in()