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
|
"""test_dump."""
import json
import os
import pytest
from cookiecutter import replay
@pytest.fixture
def template_name():
"""Fixture to return a valid template_name."""
return 'cookiedozer'
@pytest.fixture
def replay_file(replay_test_dir, template_name):
"""Fixture to return a actual file name of the dump."""
file_name = f'{template_name}.json'
return os.path.join(replay_test_dir, file_name)
@pytest.fixture(autouse=True)
def remove_replay_dump(request, replay_file):
"""Remove the replay file created by tests."""
def fin_remove_replay_file():
if os.path.exists(replay_file):
os.remove(replay_file)
request.addfinalizer(fin_remove_replay_file)
def test_type_error_if_no_template_name(replay_test_dir, context):
"""Test that replay.dump raises if the template_name is not a valid str."""
with pytest.raises(TypeError):
replay.dump(replay_test_dir, None, context)
def test_type_error_if_not_dict_context(replay_test_dir, template_name):
"""Test that replay.dump raises if the context is not of type dict."""
with pytest.raises(TypeError):
replay.dump(replay_test_dir, template_name, 'not_a_dict')
def test_value_error_if_key_missing_in_context(replay_test_dir, template_name):
"""Test that replay.dump raises if the context does not contain a key \
named 'cookiecutter'."""
with pytest.raises(ValueError):
replay.dump(replay_test_dir, template_name, {'foo': 'bar'})
@pytest.fixture
def mock_ensure_failure(mocker):
"""Replace cookiecutter.replay.make_sure_path_exists function.
Used to mock internal function and limit test scope.
Always return expected value: False
"""
return mocker.patch(
'cookiecutter.replay.make_sure_path_exists', side_effect=OSError
)
@pytest.fixture
def mock_ensure_success(mocker):
"""Replace cookiecutter.replay.make_sure_path_exists function.
Used to mock internal function and limit test scope.
Always return expected value: True
"""
return mocker.patch('cookiecutter.replay.make_sure_path_exists', return_value=True)
def test_ioerror_if_replay_dir_creation_fails(mock_ensure_failure, replay_test_dir):
"""Test that replay.dump raises when the replay_dir cannot be created."""
with pytest.raises(OSError):
replay.dump(replay_test_dir, 'foo', {'cookiecutter': {'hello': 'world'}})
mock_ensure_failure.assert_called_once_with(replay_test_dir)
def test_run_json_dump(
mocker,
mock_ensure_success,
mock_user_config,
template_name,
context,
replay_test_dir,
replay_file,
):
"""Test that replay.dump runs json.dump under the hood and that the context \
is correctly written to the expected file in the replay_dir."""
spy_get_replay_file = mocker.spy(replay, 'get_file_name')
mock_json_dump = mocker.patch('json.dump', side_effect=json.dump)
replay.dump(replay_test_dir, template_name, context)
assert not mock_user_config.called
mock_ensure_success.assert_called_once_with(replay_test_dir)
spy_get_replay_file.assert_called_once_with(replay_test_dir, template_name)
assert mock_json_dump.call_count == 1
(dumped_context, outfile_handler), kwargs = mock_json_dump.call_args
assert outfile_handler.name == replay_file
assert dumped_context == context
|
