File: test_parser_additional.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 (291 lines) | stat: -rw-r--r-- 9,123 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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
import pytest
import headerparser
from headerparser import HeaderParser


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


def test_many_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional()
    msg = parser.parse(
        "Foo: red\nBar: green\nBaz: blue\nQUUX: purple\nglarch: orange\n"
    )
    assert dict(msg) == {
        "Foo": "red",
        "Bar": "green",
        "Baz": "blue",
        "QUUX": "purple",
        "glarch": "orange",
    }
    assert msg.body is None


def test_intermixed_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional()
    msg = parser.parse(
        "QUUX: purple\nBar: green\nglarch: orange\nFoo: red\nBaz: blue\n"
    )
    assert dict(msg) == {
        "Foo": "red",
        "Bar": "green",
        "Baz": "blue",
        "QUUX": "purple",
        "glarch": "orange",
    }
    assert msg.body is None


def test_additional_only() -> None:
    parser = HeaderParser()
    parser.add_additional()
    msg = parser.parse("Foo: red\nBar: green\nBaz: blue\n")
    assert dict(msg) == {"Foo": "red", "Bar": "green", "Baz": "blue"}
    assert msg.body is None


def test_dest_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo", dest="dest")
    parser.add_field("Bar")
    with pytest.raises(ValueError) as excinfo:
        parser.add_additional()
    assert "add_additional and `dest` are mutually exclusive" in str(excinfo.value)


def test_additional_dest() -> None:
    parser = HeaderParser()
    parser.add_additional()
    parser.add_field("Foo")
    with pytest.raises(ValueError) as excinfo:
        parser.add_field("Bar", dest="dest")
    assert "add_additional and `dest` are mutually exclusive" in str(excinfo.value)


def test_additional_bad_named_multiple() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional()
    with pytest.raises(headerparser.DuplicateFieldError) as excinfo:
        parser.parse("Foo: red\nFOO: magenta\nBar: green\n")
    assert str(excinfo.value) == "Header field 'Foo' occurs more than once"
    assert excinfo.value.name == "Foo"


def test_additional_named_multiple() -> None:
    parser = HeaderParser()
    parser.add_field("Foo", multiple=True)
    parser.add_additional()
    msg = parser.parse("Foo: red\nFOO: magenta\nBar: green\n")
    assert dict(msg) == {"Foo": ["red", "magenta"], "Bar": "green"}
    assert msg.body is None


def test_additional_bad_multiple() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional()
    with pytest.raises(headerparser.DuplicateFieldError) as excinfo:
        parser.parse("Foo: red\nBar: green\nBar: lime\n")
    assert str(excinfo.value) == "Header field 'Bar' occurs more than once"
    assert excinfo.value.name == "Bar"


def test_additional_bad_multiple_cases() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional()
    with pytest.raises(headerparser.DuplicateFieldError) as excinfo:
        parser.parse("Foo: red\nBar: green\nBAR: lime\n")
    assert str(excinfo.value) == "Header field 'BAR' occurs more than once"
    assert excinfo.value.name == "BAR"


def test_multiple_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional(multiple=True)
    msg = parser.parse("Foo: red\nBar: green\nBAR: lime\n")
    assert dict(msg) == {"Foo": "red", "Bar": ["green", "lime"]}
    assert msg.body is None


def test_one_multiple_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional(multiple=True)
    msg = parser.parse("Foo: red\nBAR: lime\n")
    assert dict(msg) == {"Foo": "red", "BAR": ["lime"]}
    assert msg.body is None


def test_multiple_additional_bad_named_multiple() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(multiple=True)
    with pytest.raises(headerparser.DuplicateFieldError) as excinfo:
        parser.parse("Foo: red\nBar: green\nBaz: blue\nFOO: magenta\n")
    assert str(excinfo.value) == "Header field 'Foo' occurs more than once"
    assert excinfo.value.name == "Foo"


def test_additional_missing_named() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional()
    msg = parser.parse("Baz: blue\nQUUX: purple\nglarch: orange\n")
    assert dict(msg) == {"Baz": "blue", "QUUX": "purple", "glarch": "orange"}
    assert msg.body is None


def test_additional_missing_required_named() -> None:
    parser = HeaderParser()
    parser.add_field("Foo", required=True)
    parser.add_field("Bar")
    parser.add_additional()
    with pytest.raises(headerparser.MissingFieldError) as excinfo:
        parser.parse("Baz: blue\nQUUX: purple\nglarch: orange\n")
    assert str(excinfo.value) == "Required header field 'Foo' is not present"
    assert excinfo.value.name == "Foo"


def test_missing_additional() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional()
    msg = parser.parse("Foo: red\nBar: green\n")
    assert dict(msg) == {"Foo": "red", "Bar": "green"}
    assert msg.body is None


def test_additional_type() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(type=int)
    msg = parser.parse("Foo: 1\nBar: 2\nBaz: 3\n")
    assert dict(msg) == {"Foo": "1", "Bar": "2", "Baz": 3}
    assert msg.body is None


def test_additional_bad_type() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(type=int)
    with pytest.raises(headerparser.FieldTypeError) as excinfo:
        parser.parse("Foo: 1\nBar: 2\nBaz: three\n")
    assert str(excinfo.value) == (
        "Error while parsing 'Baz': 'three': ValueError: "
        + str(excinfo.value.exc_value)
    )
    assert excinfo.value.name == "Baz"
    assert excinfo.value.value == "three"
    assert isinstance(excinfo.value.exc_value, ValueError)


def test_additional_choices() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(choices=["red", "green", "blue"])
    msg = parser.parse("Foo: mauve\nBar: red\nBaz: green\nQuux: blue\n")
    assert dict(msg) == {
        "Foo": "mauve",
        "Bar": "red",
        "Baz": "green",
        "Quux": "blue",
    }
    assert msg.body is None


def test_additional_bad_choices() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(choices=["red", "green", "blue"])
    with pytest.raises(headerparser.InvalidChoiceError) as excinfo:
        parser.parse("Foo: mauve\nBar: red\nBaz: green\nQuux: taupe\n")
    assert str(excinfo.value) == "'taupe' is not a valid choice for 'Quux'"
    assert excinfo.value.name == "Quux"
    assert excinfo.value.value == "taupe"


def test_additional_unfold() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_additional(unfold=True)
    msg = parser.parse(
        "Foo: This is\n"
        "   test\n"
        "  text.\n"
        "Bar: This is\n"
        "   test\n"
        "  text.\n"
    )
    assert dict(msg) == {
        "Foo": "This is\n   test\n  text.",
        "Bar": "This is test text.",
    }
    assert msg.body is None


def test_bad_additional_dest() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    with pytest.raises(TypeError):
        parser.add_additional(dest="somewhere")


def test_bad_additional_required() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    with pytest.raises(TypeError):
        parser.add_additional(required=True)


def test_bad_additional_default() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    with pytest.raises(TypeError):
        parser.add_additional(default="")


def test_additional_multiname() -> None:
    parser = HeaderParser()
    parser.add_field("Foo", "Oof")
    parser.add_field("Bar", "Baz")
    parser.add_additional()
    msg = parser.parse("Oof: red\nBar: green\nQuux: blue\n")
    assert dict(msg) == {"Foo": "red", "Bar": "green", "Quux": "blue"}
    assert msg.body is None


def test_additional_off() -> None:
    parser = HeaderParser()
    parser.add_field("Foo")
    parser.add_field("Bar")
    parser.add_additional(False)
    with pytest.raises(headerparser.UnknownFieldError) as excinfo:
        parser.parse("Foo: red\nBar: green\nBaz: blue\n")
    assert str(excinfo.value) == "Unknown header field 'Baz'"
    assert excinfo.value.name == "Baz"