File: test_misc.py

package info (click to toggle)
pytest-snapshot 0.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 236 kB
  • sloc: python: 1,005; sh: 17; makefile: 16
file content (173 lines) | stat: -rw-r--r-- 4,800 bytes parent folder | download
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
import sys
from unittest import mock
from unittest.mock import Mock

import pytest

from pytest_snapshot._utils import shorten_path, might_be_valid_filename, simple_version_parse, \
    _pytest_expected_on_right, flatten_dict, flatten_filesystem_dict
from tests.utils import assert_pytest_passes, runpytest_with_assert_mode

from pathlib import Path


def test_help_message(testdir):
    result = testdir.runpytest('--help')
    result.stdout.fnmatch_lines([
        'snapshot:',
        '*--snapshot-update*Update snapshot files instead of testing against them.',
    ])


def test_default_snapshot_dir_without_parametrize(testdir):
    testdir.makepyfile("""
        from pathlib import Path

        def test_sth(snapshot):
            assert snapshot.snapshot_dir == \
                Path('snapshots/test_default_snapshot_dir_without_parametrize/test_sth').absolute()
    """)
    assert_pytest_passes(testdir)


def test_default_snapshot_dir_with_parametrize(testdir):
    testdir.makepyfile("""
        import pytest
        from pathlib import Path

        @pytest.mark.parametrize('param', ['a', 'b'])
        def test_sth(snapshot, param):
            assert snapshot.snapshot_dir == \
                Path('snapshots/test_default_snapshot_dir_with_parametrize/test_sth/{}'.format(param)).absolute()
    """)
    result = testdir.runpytest('-v')
    result.stdout.fnmatch_lines([
        '*::test_sth?a? PASSED*',
        '*::test_sth?b? PASSED*',
    ])
    assert result.ret == 0


def test_shorten_path_in_cwd():
    assert shorten_path(Path('a/b').absolute()) == Path('a/b')


def test_shorten_path_outside_cwd():
    path_outside_cwd = Path().absolute().parent.joinpath('a/b')
    assert shorten_path(path_outside_cwd) == path_outside_cwd


@pytest.mark.parametrize('s, expected', [
    ('snapshot.txt', True),
    ('snapshot', True),
    ('.snapshot', True),
    ('snapshot.', True),
    ('', False),
    ('.', False),
    ('..', False),
    ('/', False),
    ('\\', False),
    ('a/b', False),
    ('a\\b', False),
    ('a:b', False),
    ('a"b', False),
])
def test_might_be_valid_filename(s, expected):
    assert might_be_valid_filename(s) == expected


@pytest.mark.parametrize('version_str, version', [
    ('0.0.0', (0, 0, 0)),
    ('55.2312.123132', (55, 2312, 123132)),
    ('1.2.3rc', (1, 2, 3)),
])
def test_simple_version_parse_success(version_str, version):
    assert simple_version_parse(version_str) == version


@pytest.mark.parametrize('version_str', [
    '',
    'rc1.2.3',
    '1!2.3.4',
    'a.b.c',
    '1.2',
    '1.2.',
])
def test_simple_version_parse_error(version_str):
    with pytest.raises(ValueError):
        simple_version_parse(version_str)


@pytest.mark.parametrize('version_str, expected_on_right', [
    ('4.9.9', False),
    ('5.3.9', False),
    ('5.4.0', True),
    ('5.4.1', True),
    ('5.5.0', True),
    ('6.0.0', True),
    ('badversion', True),
])
def test_pytest_expected_on_right(version_str, expected_on_right):
    with mock.patch('pytest.__version__', version_str):
        assert _pytest_expected_on_right() == expected_on_right


def test_flatten_dict():
    result = flatten_dict({
        'a': 1,
        'b': {
            'ba': 2,
            'bb': {
                'bba': 3,
                'bbb': 4,
            },
        },
        'empty': {},
    })
    result = sorted(result)  # Needed to support python 3.5
    assert result == [(['a'], 1), (['b', 'ba'], 2), (['b', 'bb', 'bba'], 3), (['b', 'bb', 'bbb'], 4)]


def test_flatten_filesystem_dict_success():
    result = flatten_filesystem_dict({
        'file1': 'file1_contents',
        'dir1': {
            'file2': 'file2_contents',
            'dir2': {
                'file3': 'file3_contents',
            },
        },
        'empty_dir': {},
    })
    assert result == {
        'file1': 'file1_contents',
        'dir1/file2': 'file2_contents',
        'dir1/dir2/file3': 'file3_contents',
    }


@pytest.mark.parametrize('illegal_filename', [
    'a/b',
    '.',
    '',
])
def test_flatten_filesystem_dict_illegal_filename(illegal_filename):
    with pytest.raises(ValueError):
        flatten_filesystem_dict({
            illegal_filename: 'contents'
        })


@pytest.mark.skipif(sys.version_info < (3, 6), reason="assert_called_once doesn't exist in Python <3.6")
def test_runpytest_with_assert_mode(request):
    testdir = Mock()
    runpytest_with_assert_mode(testdir, request, '--assert=plain')
    runpytest_with_assert_mode(testdir, request, '--assert=rewrite')
    testdir.runpytest.assert_called_once()
    testdir.runpytest_subprocess.assert_called_once()


def test_runpytest_with_assert_mode_without_assert_mode(request):
    testdir = Mock()
    with pytest.raises(ValueError):
        runpytest_with_assert_mode(testdir, request)