File: test_parser_action.py

package info (click to toggle)
python-headerparser 0.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 404 kB
  • sloc: python: 3,133; makefile: 6; sh: 4
file content (276 lines) | stat: -rw-r--r-- 9,486 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
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
from unittest.mock import ANY, Mock
import pytest
from pytest_mock import MockerFixture
import headerparser
from headerparser import BOOL, HeaderParser, NormalizedDict


@pytest.fixture
def use_as_body() -> Mock:
    def _use(nd: NormalizedDict, _name: str, value: str) -> None:
        nd.body = value

    return Mock(side_effect=_use)


def test_action(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Foo: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_missing(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Bar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    assert not stub.called


def test_action_type(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, type=BOOL)
    parser.add_field("Bar")
    msg = parser.parse("Foo: yes\nBar: green\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", True)


def test_action_type_error(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, type=BOOL)
    parser.add_field("Bar")
    with pytest.raises(headerparser.FieldTypeError):
        parser.parse("Foo: maybe\nBar: green\n")
    assert not stub.called


def test_action_required(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, required=True)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Foo: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_required_missing(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, required=True)
    parser.add_field("Bar")
    parser.add_field("Baz")
    with pytest.raises(headerparser.MissingFieldError):
        parser.parse("Bar: green\nBaz: blue\n")
    assert not stub.called


def test_action_choices(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, choices=["red", "green", "blue"])
    parser.add_field("Bar")
    msg = parser.parse("Foo: red\nBar: green\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_bad_choice(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, choices=["red", "green", "blue"])
    parser.add_field("Bar")
    with pytest.raises(headerparser.InvalidChoiceError):
        parser.parse("Foo: taupe\nBar: green\n")
    assert not stub.called


def test_action_unfold(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, unfold=True)
    parser.add_field("Bar")
    msg = parser.parse("Foo:  folded\n  text \nBar: green\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "folded text")


def test_action_no_unfold(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub)
    parser.add_field("Bar")
    msg = parser.parse("Foo:  folded\n  text \nBar: green\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "folded\n  text ")


def test_action_default(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, default="orange")
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Foo: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_default_missing(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, default="orange")
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Bar: green\nBaz: blue\n")
    assert dict(msg) == {"Foo": "orange", "Bar": "green", "Baz": "blue"}
    assert msg.body is None
    assert not stub.called


def test_action_different_case(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("FOO: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_multiname(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", "Quux", action=stub)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("quux: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    stub.assert_called_once_with(msg, "Foo", "red")


def test_action_multiple(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo", action=stub, multiple=True)
    parser.add_field("Bar")
    parser.add_field("Baz")
    msg = parser.parse("Foo: red\nBar: green\nFOO: purple\nBaz: blue\nfoo: orange\n")
    assert dict(msg) == {"Bar": "green", "Baz": "blue"}
    assert msg.body is None
    assert stub.call_args_list == [
        mocker.call(msg, "Foo", "red"),
        mocker.call(msg, "Foo", "purple"),
        mocker.call(msg, "Foo", "orange"),
    ]


def test_action_dest(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    with pytest.raises(ValueError) as excinfo:
        parser.add_field("Foo", action=stub, dest="bar")
    assert "`action` and `dest` are mutually exclusive" in str(excinfo.value)
    assert not stub.called


def test_action_normalized_dest(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    with pytest.raises(ValueError) as excinfo:
        parser.add_field("Foo", action=stub, dest="foo")
    assert "`action` and `dest` are mutually exclusive" in str(excinfo.value)
    assert not stub.called


def test_action_additional(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional(action=stub)
    msg = parser.parse("Bar: green\nFoo: red\nBaz: blue\n")
    assert dict(msg) == {"Foo": "red"}
    assert msg.body is None
    assert stub.call_args_list == [
        mocker.call(msg, "Bar", "green"),
        mocker.call(msg, "Baz", "blue"),
    ]


def test_action_multiple_additional(mocker: MockerFixture) -> None:
    stub = mocker.stub()
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional(action=stub, multiple=True)
    msg = parser.parse("Bar: green\nFoo: red\nBaz: blue\nbaz: mauve\nBAR: taupe\n")
    assert dict(msg) == {"Foo": "red"}
    assert msg.body is None
    assert stub.call_args_list == [
        mocker.call(msg, "Bar", "green"),
        mocker.call(msg, "Baz", "blue"),
        mocker.call(msg, "baz", "mauve"),
        mocker.call(msg, "BAR", "taupe"),
    ]


@pytest.mark.parametrize("body", [True, None])
def test_action_set_body_overwritten(body: bool, use_as_body: Mock) -> None:
    parser = HeaderParser(body=body)
    parser.add_field("Foo", action=use_as_body)
    parser.add_field("Bar")
    msg = parser.parse("Foo: red\nBar: green\n\nThis is the body.\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body == "This is the body.\n"
    use_as_body.assert_called_once_with(msg, "Foo", "red")


def test_action_set_body_forbidden(use_as_body: Mock) -> None:
    parser = HeaderParser(body=False)
    parser.add_field("Foo", action=use_as_body)
    parser.add_field("Bar")
    with pytest.raises(headerparser.BodyNotAllowedError):
        parser.parse("Foo: red\nBar: green\n\nThis is the body.\n")
    use_as_body.assert_called_once_with(ANY, "Foo", "red")


@pytest.mark.parametrize("body", [False, None])
def test_action_set_body(body: bool, use_as_body: Mock) -> None:
    parser = HeaderParser(body=body)
    parser.add_field("Foo", action=use_as_body)
    parser.add_field("Bar")
    msg = parser.parse("Foo: red\nBar: green\n")
    assert dict(msg) == {"Bar": "green"}
    assert msg.body == "red"
    use_as_body.assert_called_once_with(msg, "Foo", "red")


def test_action_set_body_missing(use_as_body: Mock) -> None:
    parser = HeaderParser(body=True)
    parser.add_field("Foo", action=use_as_body)
    parser.add_field("Bar")
    with pytest.raises(headerparser.MissingBodyError):
        parser.parse("Foo: red\nBar: green\n")
    use_as_body.assert_called_once_with(ANY, "Foo", "red")