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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
import sys
import pytest
from tests.utils import assert_pytest_passes, runpytest_with_assert_mode
@pytest.fixture
def basic_case_dir(testdir):
case_dir = testdir.mkdir('case_dir')
dict_snapshot1 = case_dir.mkdir('dict_snapshot1')
dict_snapshot1.join('obj1.txt').write_text('the value of obj1.txt', 'ascii')
subdir1 = dict_snapshot1.mkdir('subdir1')
subdir1.join('subobj1.txt').write_text('the value of subobj1.txt', 'ascii')
return case_dir
def test_assert_match_dir_success(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the value of subobj1.txt',
},
}, 'dict_snapshot1')
""")
assert_pytest_passes(testdir)
def test_assert_match_dir_failure(request, testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the INCORRECT value of subobj1.txt',
},
}, 'dict_snapshot1')
""")
result = runpytest_with_assert_mode(testdir, request, '-v', '--assert=rewrite')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
"* snapshot.assert_match_dir({",
"* 'obj1.txt': 'the value of obj1.txt',",
"* 'subdir1': {",
"* 'subobj1.txt': 'the INCORRECT value of subobj1.txt',",
"* },",
"* }, 'dict_snapshot1')",
'E* A*Error: value does not match the expected value in snapshot case_dir?dict_snapshot1?subdir1/subobj1.txt',
'E* (run pytest with --snapshot-update to update snapshots)',
])
assert result.ret == 1
def test_assert_match_dir_invalid_type(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir('NOT A DICTIONARY', 'dict_snapshot1')
""")
result = testdir.runpytest('-v')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
'E* TypeError: dir_dict must be a dictionary',
])
assert result.ret == 1
def test_assert_match_dir_missing_snapshot(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the INCORRECT value of subobj1.txt',
'new_obj.txt': 'the value of new_obj.txt',
},
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
"E* AssertionError: Values do not match snapshots in case_dir?dict_snapshot1",
'E* (run pytest with --snapshot-update to update the snapshot directory)',
'E* Values without snapshots:',
'E* subdir1?new_obj.txt',
])
assert result.ret == 1
def test_assert_match_dir_missing_value(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {},
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
"E* AssertionError: Values do not match snapshots in case_dir?dict_snapshot1",
'E* (run pytest with --snapshot-update to update the snapshot directory)',
'E* Snapshots without values:',
'E* subdir1?subobj1.txt',
])
assert result.ret == 1
def test_assert_match_dir_update_existing_snapshot_no_change(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the value of subobj1.txt',
},
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
])
assert result.ret == 0
@pytest.mark.parametrize('case_dir_repr',
["'case_dir'",
"str(Path('case_dir').absolute())",
"Path('case_dir')",
"Path('case_dir').absolute()"],
ids=['relative_string_case_dir',
'abs_string_case_dir',
'relative_path_case_dir',
'abs_path_case_dir'])
@pytest.mark.parametrize('snapshot_name_repr',
["'dict_snapshot1'",
"str(Path('case_dir/dict_snapshot1').absolute())",
"Path('case_dir/dict_snapshot1')", # TODO: support this or "Path('dict_snapshot1')"?
"Path('case_dir/dict_snapshot1').absolute()"],
ids=['relative_string_snapshot_name',
'abs_string_snapshot_name',
'relative_path_snapshot_name',
'abs_path_snapshot_name'])
def test_assert_match_dir_update_existing_snapshot(testdir, basic_case_dir, case_dir_repr, snapshot_name_repr):
"""
Tests that `Snapshot.assert_match_dir` works when updating an existing snapshot.
Also tests that `Snapshot` supports absolute/relative str/Path snapshot directories and snapshot paths.
"""
testdir.makepyfile("""
from pathlib import Path
def test_sth(snapshot):
snapshot.snapshot_dir = {case_dir_repr}
snapshot.assert_match_dir({{
'obj1.txt': 'the value of obj1.txt',
'subdir1': {{
'subobj1.txt': 'the NEW value of subobj1.txt',
}},
}}, {snapshot_name_repr})
""".format(case_dir_repr=case_dir_repr, snapshot_name_repr=snapshot_name_repr))
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
'*::test_sth ERROR*',
'* ERROR at teardown of test_sth *',
"Snapshot directory was modified: case_dir",
' Updated snapshots:',
' dict_snapshot1?subdir1?subobj1.txt',
])
assert result.ret == 1
assert_pytest_passes(testdir) # assert that snapshot update worked
def test_assert_match_dir_create_new_snapshot_file(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the value of subobj1.txt',
'new_obj.txt': 'the value of new_obj.txt',
},
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
'*::test_sth ERROR*',
'* ERROR at teardown of test_sth *',
"Snapshot directory was modified: case_dir",
' Created snapshots:',
' dict_snapshot1?subdir1?new_obj.txt',
])
assert result.ret == 1
assert_pytest_passes(testdir) # assert that snapshot update worked
def test_assert_match_dir_delete_snapshot_file(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {},
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
'*::test_sth ERROR*',
'* ERROR at teardown of test_sth *',
"Snapshot directory was modified: case_dir",
' Snapshots that should be deleted: (run pytest with --allow-snapshot-deletion to delete them)',
' dict_snapshot1?subdir1?subobj1.txt',
])
assert result.ret == 1
result = testdir.runpytest('-v', '--snapshot-update', '--allow-snapshot-deletion')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
'*::test_sth ERROR*',
'* ERROR at teardown of test_sth *',
'Snapshot directory was modified: case_dir',
' Deleted snapshots:',
' dict_snapshot1?subdir1?subobj1.txt',
])
assert result.ret == 1
assert_pytest_passes(testdir) # assert that snapshot update worked
@pytest.mark.skipif(sys.version_info < (3, 6), reason="Non-deterministic dicts in python <=3.5 make testing annoying.")
def test_assert_match_dir_create_new_snapshot_dir(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1': {
'subobj1.txt': 'the value of subobj1.txt',
},
}, 'new_dict_snapshot')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth PASSED*',
'*::test_sth ERROR*',
'* ERROR at teardown of test_sth *',
'Snapshot directory was modified: case_dir',
' Created snapshots:',
' new_dict_snapshot?obj1.txt',
' new_dict_snapshot?subdir1?subobj1.txt',
])
assert result.ret == 1
assert_pytest_passes(testdir) # assert that snapshot update worked
def test_assert_match_dir_existing_snapshot_is_not_dir(testdir, basic_case_dir):
basic_case_dir.join('file1').write_text('', 'ascii')
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({}, 'file1')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
"E* AssertionError: snapshot exists but is not a directory: case_dir?file1",
])
assert result.ret == 1
def test_assert_match_dir_empty_snapshot(testdir, basic_case_dir):
"""
When testing a empty dict, if the directory doesn't exist, the correct behaviour is to pass.
This behaviour is important since git ignores empty directories.
"""
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({}, 'nonexisting_directory')
""")
assert_pytest_passes(testdir)
def test_assert_match_dir_path_traversal_name(testdir, basic_case_dir):
testdir.makepyfile("""
def test_sth(snapshot):
snapshot.snapshot_dir = 'case_dir'
snapshot.assert_match_dir({
'obj1.txt': 'the value of obj1.txt',
'subdir1/subobj1.txt': 'the value of subobj1.txt',
}, 'dict_snapshot1')
""")
result = testdir.runpytest('-v', '--snapshot-update')
result.stdout.fnmatch_lines([
'*::test_sth FAILED*',
"E* ValueError: Key 'subdir1/subobj1.txt' in d must be a valid file name.",
])
assert result.ret == 1
|
