1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
"""Tests around cloning repositories and detection of errors at it."""
import os
import subprocess
import pytest
from cookiecutter import exceptions, vcs
def test_clone_should_raise_if_vcs_not_installed(mocker, clone_dir):
"""In `clone()`, a `VCSNotInstalled` exception should be raised if no VCS \
is installed."""
mocker.patch('cookiecutter.vcs.is_vcs_installed', autospec=True, return_value=False)
repo_url = 'https://github.com/pytest-dev/cookiecutter-pytest-plugin.git'
with pytest.raises(exceptions.VCSNotInstalled):
vcs.clone(repo_url, clone_to_dir=str(clone_dir))
def test_clone_should_rstrip_trailing_slash_in_repo_url(mocker, clone_dir):
"""In `clone()`, repo URL's trailing slash should be stripped if one is \
present."""
mocker.patch('cookiecutter.vcs.is_vcs_installed', autospec=True, return_value=True)
mock_subprocess = mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
)
vcs.clone('https://github.com/foo/bar/', clone_to_dir=clone_dir, no_input=True)
mock_subprocess.assert_called_once_with(
['git', 'clone', 'https://github.com/foo/bar'],
cwd=clone_dir,
stderr=subprocess.STDOUT,
)
def test_clone_should_abort_if_user_does_not_want_to_reclone(mocker, clone_dir):
"""In `clone()`, if user doesn't want to reclone, Cookiecutter should exit \
without cloning anything."""
mocker.patch('cookiecutter.vcs.is_vcs_installed', autospec=True, return_value=True)
mocker.patch(
'cookiecutter.vcs.prompt_and_delete', side_effect=SystemExit, autospec=True
)
mock_subprocess = mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
)
# Create repo_dir to trigger prompt_and_delete
repo_dir = clone_dir.joinpath('cookiecutter-pytest-plugin')
repo_dir.mkdir()
repo_url = 'https://github.com/pytest-dev/cookiecutter-pytest-plugin.git'
with pytest.raises(SystemExit):
vcs.clone(repo_url, clone_to_dir=str(clone_dir))
assert not mock_subprocess.called
def test_clone_should_silent_exit_if_ok_to_reuse(mocker, tmpdir):
"""In `clone()`, if user doesn't want to reclone, Cookiecutter should exit \
without cloning anything."""
mocker.patch('cookiecutter.vcs.is_vcs_installed', autospec=True, return_value=True)
mocker.patch(
'cookiecutter.vcs.prompt_and_delete', return_value=False, autospec=True
)
mock_subprocess = mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
)
clone_to_dir = tmpdir.mkdir('clone')
# Create repo_dir to trigger prompt_and_delete
clone_to_dir.mkdir('cookiecutter-pytest-plugin')
repo_url = 'https://github.com/pytest-dev/cookiecutter-pytest-plugin.git'
vcs.clone(repo_url, clone_to_dir=str(clone_to_dir))
assert not mock_subprocess.called
@pytest.mark.parametrize(
'repo_type, repo_url, repo_name',
[
('git', 'https://github.com/hello/world.git', 'world'),
('hg', 'https://bitbucket.org/foo/bar', 'bar'),
('git', 'git@host:gitoliterepo', 'gitoliterepo'),
('git', 'git@gitlab.com:cookiecutter/cookiecutter.git', 'cookiecutter'),
('git', 'git@github.com:cookiecutter/cookiecutter.git', 'cookiecutter'),
],
)
def test_clone_should_invoke_vcs_command(
mocker, clone_dir, repo_type, repo_url, repo_name
):
"""When `clone()` is called with a git/hg repo, the corresponding VCS \
command should be run via `subprocess.check_output()`.
This should take place:
* In the correct dir
* With the correct args.
"""
mocker.patch('cookiecutter.vcs.is_vcs_installed', autospec=True, return_value=True)
mock_subprocess = mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
)
expected_repo_dir = os.path.normpath(os.path.join(clone_dir, repo_name))
branch = 'foobar'
repo_dir = vcs.clone(
repo_url, checkout=branch, clone_to_dir=clone_dir, no_input=True
)
assert repo_dir == expected_repo_dir
mock_subprocess.assert_any_call(
[repo_type, 'clone', repo_url], cwd=clone_dir, stderr=subprocess.STDOUT
)
branch_info = [branch]
# We sanitize branch information for Mercurial
if repo_type == "hg":
branch_info.insert(0, "--")
mock_subprocess.assert_any_call(
[repo_type, 'checkout', *branch_info],
cwd=expected_repo_dir,
stderr=subprocess.STDOUT,
)
@pytest.mark.parametrize(
'error_message',
[
(b"fatal: repository 'https://github.com/hackebro/cookiedozer' not found"),
b'hg: abort: HTTP Error 404: Not Found',
],
)
def test_clone_handles_repo_typo(mocker, clone_dir, error_message):
"""In `clone()`, repository not found errors should raise an \
appropriate exception."""
# side_effect is set to an iterable here (and below),
# because of a Python 3.4 unittest.mock regression
# http://bugs.python.org/issue23661
mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
side_effect=[subprocess.CalledProcessError(-1, 'cmd', output=error_message)],
)
repository_url = 'https://github.com/hackebro/cookiedozer'
with pytest.raises(exceptions.RepositoryNotFound) as err:
vcs.clone(repository_url, clone_to_dir=str(clone_dir), no_input=True)
assert str(err.value) == (
f'The repository {repository_url} could not be found, have you made a typo?'
)
@pytest.mark.parametrize(
'error_message',
[
b"error: pathspec 'unknown_branch' did not match any file(s) known to git",
b"hg: abort: unknown revision 'unknown_branch'!",
],
)
def test_clone_handles_branch_typo(mocker, clone_dir, error_message):
"""In `clone()`, branch not found errors should raise an \
appropriate exception."""
mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
side_effect=[subprocess.CalledProcessError(-1, 'cmd', output=error_message)],
)
repository_url = 'https://github.com/pytest-dev/cookiecutter-pytest-plugin'
with pytest.raises(exceptions.RepositoryCloneFailed) as err:
vcs.clone(
repository_url,
clone_to_dir=str(clone_dir),
checkout='unknown_branch',
no_input=True,
)
assert str(err.value) == (
'The unknown_branch branch of repository '
f'{repository_url} could not found, have you made a typo?'
)
def test_clone_unknown_subprocess_error(mocker, clone_dir):
"""In `clone()`, unknown subprocess errors should be raised."""
mocker.patch(
'cookiecutter.vcs.subprocess.check_output',
autospec=True,
side_effect=[
subprocess.CalledProcessError(-1, 'cmd', output=b'Something went wrong')
],
)
with pytest.raises(subprocess.CalledProcessError):
vcs.clone(
'https://github.com/pytest-dev/cookiecutter-pytest-plugin',
clone_to_dir=str(clone_dir),
no_input=True,
)
|