/
test_core.py
1062 lines (777 loc) · 34 KB
/
test_core.py
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
import itertools
import mock
import sys
import pytest
from marshmallow import Schema, post_load, class_registry, validates_schema
from werkzeug.datastructures import MultiDict as WerkMultiDict
from django.utils.datastructures import MultiValueDict as DjMultiDict
from bottle import MultiDict as BotMultiDict
from webargs import fields, missing, ValidationError
from webargs.core import (
Parser,
get_value,
argmap2schema,
is_json,
get_mimetype,
MARSHMALLOW_VERSION_INFO,
)
strict_kwargs = {"strict": True} if MARSHMALLOW_VERSION_INFO[0] < 3 else {}
class MockRequestParser(Parser):
"""A minimal parser implementation that parses mock requests."""
def parse_querystring(self, req, name, field):
return get_value(req.query, name, field)
def parse_json(self, req, name, field):
return get_value(req.json, name, field)
def parse_cookies(self, req, name, field):
return get_value(req.cookies, name, field)
@pytest.yield_fixture(scope="function")
def web_request():
req = mock.Mock()
req.query = {}
yield req
req.query = {}
@pytest.fixture
def parser():
return MockRequestParser()
# Parser tests
@mock.patch("webargs.core.Parser.parse_json")
def test_parse_json_called_by_parse_arg(parse_json, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request)
parse_json.assert_called_with(web_request, "foo", field)
@mock.patch("webargs.core.Parser.parse_querystring")
def test_parse_querystring_called_by_parse_arg(parse_querystring, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request)
assert parse_querystring.called_once()
@mock.patch("webargs.core.Parser.parse_form")
def test_parse_form_called_by_parse_arg(parse_form, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request)
assert parse_form.called_once()
@mock.patch("webargs.core.Parser.parse_json")
def test_parse_json_not_called_when_json_not_a_location(parse_json, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request, locations=("form", "querystring"))
assert parse_json.call_count == 0
@mock.patch("webargs.core.Parser.parse_headers")
def test_parse_headers_called_when_headers_is_a_location(parse_headers, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request)
assert parse_headers.call_count == 0
p.parse_arg("foo", field, web_request, locations=("headers",))
parse_headers.assert_called()
@mock.patch("webargs.core.Parser.parse_cookies")
def test_parse_cookies_called_when_cookies_is_a_location(parse_cookies, web_request):
field = fields.Field()
p = Parser()
p.parse_arg("foo", field, web_request)
assert parse_cookies.call_count == 0
p.parse_arg("foo", field, web_request, locations=("cookies",))
parse_cookies.assert_called()
@mock.patch("webargs.core.Parser.parse_json")
def test_parse(parse_json, web_request):
parse_json.return_value = 42
argmap = {"username": fields.Field(), "password": fields.Field()}
p = Parser()
ret = p.parse(argmap, web_request)
assert {"username": 42, "password": 42} == ret
def test_parse_required_arg_raises_validation_error(parser, web_request):
web_request.json = {}
args = {"foo": fields.Field(required=True)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert "Missing data for required field." in str(excinfo)
exc = excinfo.value
assert exc.status_code == 422
# https://github.com/sloria/webargs/issues/180#issuecomment-394869645
def test_overriding_default_status_code(web_request):
class MockRequestParserThatReturns400s(MockRequestParser):
DEFAULT_VALIDATION_STATUS = 400
parser = MockRequestParserThatReturns400s()
web_request.json = {}
args = {"foo": fields.Field(required=True)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert "Missing data for required field." in str(excinfo)
exc = excinfo.value
assert exc.status_code == 400
def test_arg_not_required_excluded_in_parsed_output(parser, web_request):
web_request.json = {"first": "Steve"}
args = {"first": fields.Str(), "last": fields.Str()}
result = parser.parse(args, web_request)
assert result == {"first": "Steve"}
def test_arg_allow_none(parser, web_request):
web_request.json = {"first": "Steve", "last": None}
args = {"first": fields.Str(), "last": fields.Str(allow_none=True)}
result = parser.parse(args, web_request)
assert result == {"first": "Steve", "last": None}
@mock.patch("webargs.core.Parser.parse_json")
def test_parse_required_arg(parse_json, web_request):
arg = fields.Field(required=True)
parse_json.return_value = 42
p = Parser()
result = p.parse_arg("foo", arg, web_request, locations=("json",))
assert result == 42
def test_parse_required_list(parser, web_request):
web_request.json = {"bar": []}
args = {"foo": fields.List(fields.Field(), required=True)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert excinfo.value.messages["foo"][0] == "Missing data for required field."
# Regression test for https://github.com/sloria/webargs/issues/107
def test_parse_list_allow_none(parser, web_request):
web_request.json = {"foo": None}
args = {"foo": fields.List(fields.Field(allow_none=True), allow_none=True)}
assert parser.parse(args, web_request) == {"foo": None}
def test_parse_list_dont_allow_none(parser, web_request):
web_request.json = {"foo": None}
args = {"foo": fields.List(fields.Field(), allow_none=False)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert excinfo.value.messages["foo"][0] == "Field may not be null."
def test_parse_empty_list(parser, web_request):
web_request.json = {"things": []}
args = {"things": fields.List(fields.Field())}
assert parser.parse(args, web_request) == {"things": []}
def test_parse_missing_list(parser, web_request):
web_request.json = {}
args = {"things": fields.List(fields.Field())}
assert parser.parse(args, web_request) == {}
def test_default_locations():
assert set(Parser.DEFAULT_LOCATIONS) == set(["json", "querystring", "form"])
def test_missing_with_default(parser, web_request):
web_request.json = {}
args = {"val": fields.Field(missing="pizza")}
result = parser.parse(args, web_request, locations=("json",))
assert result["val"] == "pizza"
def test_default_can_be_none(parser, web_request):
web_request.json = {}
args = {"val": fields.Field(missing=None, allow_none=True)}
result = parser.parse(args, web_request, locations=("json",))
assert result["val"] is None
# Regression test for issue #11
def test_arg_with_default_and_location(parser, web_request):
web_request.json = {}
args = {
"p": fields.Int(
missing=1,
validate=lambda p: p > 0,
error=u"La page demandée n'existe pas",
location="querystring",
)
}
assert parser.parse(args, web_request) == {"p": 1}
def test_value_error_raised_if_parse_arg_called_with_invalid_location(web_request):
field = fields.Field()
p = Parser()
with pytest.raises(ValueError) as excinfo:
p.parse_arg("foo", field, web_request, locations=("invalidlocation", "headers"))
assert "Invalid locations arguments: {0}".format(["invalidlocation"]) in str(
excinfo
)
def test_value_error_raised_if_invalid_location_on_field(web_request, parser):
with pytest.raises(ValueError) as excinfo:
parser.parse({"foo": fields.Field(location="invalidlocation")}, web_request)
assert "Invalid locations arguments: {0}".format(["invalidlocation"]) in str(
excinfo
)
@mock.patch("webargs.core.Parser.handle_error")
@mock.patch("webargs.core.Parser.parse_json")
def test_handle_error_called_when_parsing_raises_error(
parse_json, handle_error, web_request
):
val_err = ValidationError("error occurred")
parse_json.side_effect = val_err
p = Parser()
p.parse({"foo": fields.Field()}, web_request, locations=("json",))
handle_error.assert_called
parse_json.side_effect = ValidationError("another exception")
p.parse({"foo": fields.Field()}, web_request, locations=("json",))
assert handle_error.call_count == 2
def test_handle_error_reraises_errors(web_request):
p = Parser()
with pytest.raises(ValidationError):
p.handle_error(ValidationError("error raised"), web_request, Schema())
@mock.patch("webargs.core.Parser.parse_headers")
def test_locations_as_init_arguments(parse_headers, web_request):
p = Parser(locations=("headers",))
p.parse({"foo": fields.Field()}, web_request)
assert parse_headers.called
@mock.patch("webargs.core.Parser.parse_files")
def test_parse_files(parse_files, web_request):
p = Parser()
p.parse({"foo": fields.Field()}, web_request, locations=("files",))
assert parse_files.called
@mock.patch("webargs.core.Parser.parse_json")
def test_custom_error_handler(parse_json, web_request):
class CustomError(Exception):
pass
def error_handler(error, req, schema):
assert isinstance(schema, Schema)
raise CustomError(error)
parse_json.side_effect = ValidationError("parse_json failed")
p = Parser(error_handler=error_handler)
with pytest.raises(CustomError):
p.parse({"foo": fields.Field()}, web_request)
@mock.patch("webargs.core.Parser.parse_json")
def test_custom_error_handler_decorator(parse_json, web_request):
class CustomError(Exception):
pass
parse_json.side_effect = ValidationError("parse_json failed")
parser = Parser()
@parser.error_handler
def handle_error(error, req, schema):
assert isinstance(schema, Schema)
raise CustomError(error)
with pytest.raises(CustomError):
parser.parse({"foo": fields.Field()}, web_request)
def test_custom_location_handler(web_request):
web_request.data = {"foo": 42}
parser = Parser()
@parser.location_handler("data")
def parse_data(req, name, arg):
return req.data.get(name, missing)
result = parser.parse({"foo": fields.Int()}, web_request, locations=("data",))
assert result["foo"] == 42
def test_custom_location_handler_with_data_key(web_request):
web_request.data = {"X-Foo": 42}
parser = Parser()
@parser.location_handler("data")
def parse_data(req, name, arg):
return req.data.get(name, missing)
data_key_kwarg = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "X-Foo"
}
result = parser.parse(
{"x_foo": fields.Int(**data_key_kwarg)}, web_request, locations=("data",)
)
assert result["x_foo"] == 42
def test_full_input_validation(web_request):
web_request.json = {"foo": 41, "bar": 42}
parser = MockRequestParser()
args = {"foo": fields.Int(), "bar": fields.Int()}
with pytest.raises(ValidationError):
# Test that `validate` receives dictionary of args
parser.parse(
args,
web_request,
locations=("json",),
validate=lambda args: args["foo"] > args["bar"],
)
def test_full_input_validation_with_multiple_validators(web_request, parser):
def validate1(args):
if args["a"] > args["b"]:
raise ValidationError("b must be > a")
def validate2(args):
if args["b"] > args["a"]:
raise ValidationError("a must be > b")
args = {"a": fields.Int(), "b": fields.Int()}
web_request.json = {"a": 2, "b": 1}
validators = [validate1, validate2]
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request, locations=("json",), validate=validators)
assert "b must be > a" in str(excinfo)
web_request.json = {"a": 1, "b": 2}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request, locations=("json",), validate=validators)
assert "a must be > b" in str(excinfo)
def test_required_with_custom_error(web_request):
web_request.json = {}
parser = MockRequestParser()
args = {
"foo": fields.Str(required=True, error_messages={"required": "We need foo"})
}
with pytest.raises(ValidationError) as excinfo:
# Test that `validate` receives dictionary of args
parser.parse(args, web_request, locations=("json",))
assert "We need foo" in excinfo.value.messages["foo"]
assert "foo" in excinfo.value.field_names
def test_required_with_custom_error_and_validation_error(web_request):
web_request.json = {"foo": ""}
parser = MockRequestParser()
args = {
"foo": fields.Str(
required="We need foo",
validate=lambda s: len(s) > 1,
error_messages={"validator_failed": "foo required length is 3"},
)
}
with pytest.raises(ValidationError) as excinfo:
# Test that `validate` receives dictionary of args
parser.parse(args, web_request, locations=("json",))
assert "foo required length is 3" in excinfo.value.args[0]["foo"]
assert "foo" in excinfo.value.field_names
def test_full_input_validator_receives_nonascii_input(web_request):
def validate(val):
return False
text = u"øœ∑∆∑"
web_request.json = {"text": text}
parser = MockRequestParser()
args = {"text": fields.Str()}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request, locations=("json",), validate=validate)
assert excinfo.value.messages == ["Invalid value."]
def test_invalid_argument_for_validate(web_request, parser):
with pytest.raises(ValueError) as excinfo:
parser.parse({}, web_request, validate="notcallable")
assert "not a callable or list of callables." in excinfo.value.args[0]
def test_get_value_basic():
assert get_value({"foo": 42}, "foo", False) == 42
assert get_value({"foo": 42}, "bar", False) is missing
assert get_value({"foos": ["a", "b"]}, "foos", True) == ["a", "b"]
# https://github.com/sloria/webargs/pull/30
assert get_value({"foos": ["a", "b"]}, "bar", True) is missing
def create_bottle_multi_dict():
d = BotMultiDict()
d["foos"] = "a"
d["foos"] = "b"
return d
multidicts = [
WerkMultiDict([("foos", "a"), ("foos", "b")]),
create_bottle_multi_dict(),
DjMultiDict({"foos": ["a", "b"]}),
]
@pytest.mark.parametrize("input_dict", multidicts)
def test_get_value_multidict(input_dict):
field = fields.List(fields.Str())
assert get_value(input_dict, "foos", field) == ["a", "b"]
def test_parse_with_data_key(web_request):
web_request.json = {"Content-Type": "application/json"}
parser = MockRequestParser()
data_key_kwargs = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "Content-Type"
}
args = {"content_type": fields.Field(**data_key_kwargs)}
parsed = parser.parse(args, web_request, locations=("json",))
assert parsed == {"content_type": "application/json"}
# https://github.com/sloria/webargs/issues/118
@pytest.mark.skipif(
MARSHMALLOW_VERSION_INFO[0] >= 3, reason="Behaviour changed in marshmallow 3"
)
# https://github.com/marshmallow-code/marshmallow/pull/714
def test_load_from_is_checked_after_given_key(web_request):
web_request.json = {"content_type": "application/json"}
parser = MockRequestParser()
args = {"content_type": fields.Field(load_from="Content-Type")}
parsed = parser.parse(args, web_request, locations=("json",))
assert parsed == {"content_type": "application/json"}
def test_parse_with_data_key_retains_field_name_in_error(web_request):
web_request.json = {"Content-Type": 12345}
parser = MockRequestParser()
data_key_kwargs = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "Content-Type"
}
args = {"content_type": fields.Str(**data_key_kwargs)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request, locations=("json",))
assert "Content-Type" in excinfo.value.messages
assert excinfo.value.messages["Content-Type"] == ["Not a valid string."]
def test_parse_with_force_all(web_request, parser):
web_request.json = {"foo": 42}
args = {"foo": fields.Int(), "bar": fields.Int(required=False)}
parsed = parser.parse(args, web_request, force_all=True)
assert parsed["foo"] == 42
assert parsed["bar"] is missing
def test_parse_nested_with_data_key(web_request):
parser = MockRequestParser()
web_request.json = {"nested_arg": {"wrong": "OK"}}
data_key_kwarg = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "wrong"
}
args = {"nested_arg": fields.Nested({"right": fields.Field(**data_key_kwarg)})}
parsed = parser.parse(args, web_request, locations=("json",))
assert parsed == {"nested_arg": {"right": "OK"}}
def test_parse_nested_with_missing_key_and_data_key(web_request):
parser = MockRequestParser()
web_request.json = {"nested_arg": {"payload": "OK"}}
data_key_kwargs = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "miss"
}
args = {
"nested_arg": fields.Nested(
{"found": fields.Field(missing=None, allow_none=True, **data_key_kwargs)}
)
}
parsed = parser.parse(args, web_request, locations=("json",))
assert parsed == {"nested_arg": {"found": None}}
def test_parse_nested_with_default(web_request):
parser = MockRequestParser()
web_request.json = {"nested_arg": {}}
args = {"nested_arg": fields.Nested({"miss": fields.Field(missing="<foo>")})}
parsed = parser.parse(args, web_request, locations=("json",))
assert parsed == {"nested_arg": {"miss": "<foo>"}}
def test_nested_many(web_request, parser):
web_request.json = {"pets": [{"name": "Pips"}, {"name": "Zula"}]}
args = {"pets": fields.Nested({"name": fields.Str()}, required=True, many=True)}
parsed = parser.parse(args, web_request)
assert parsed == {"pets": [{"name": "Pips"}, {"name": "Zula"}]}
web_request.json = {}
with pytest.raises(ValidationError):
parser.parse(args, web_request)
def test_use_args(web_request, parser):
user_args = {"username": fields.Str(), "password": fields.Str()}
web_request.json = {"username": "foo", "password": "bar"}
@parser.use_args(user_args, web_request)
def viewfunc(args):
return args
assert viewfunc() == {"username": "foo", "password": "bar"}
def test_use_args_stacked(web_request, parser):
query_args = {"page": fields.Int()}
json_args = {"username": fields.Str()}
web_request.json = {"username": "foo"}
web_request.query = {"page": 42}
@parser.use_args(query_args, web_request, locations=("query",))
@parser.use_args(json_args, web_request, locations=("json",))
def viewfunc(query_parsed, json_parsed):
return {"json": json_parsed, "query": query_parsed}
assert viewfunc() == {"json": {"username": "foo"}, "query": {"page": 42}}
def test_use_kwargs_stacked(web_request, parser):
query_args = {
"page": fields.Int(error_messages={"invalid": "{input} not a valid integer"})
}
json_args = {"username": fields.Str()}
web_request.json = {"username": "foo"}
web_request.query = {"page": 42}
@parser.use_kwargs(query_args, web_request, locations=("query",))
@parser.use_kwargs(json_args, web_request, locations=("json",))
def viewfunc(page, username):
return {"json": {"username": username}, "query": {"page": page}}
assert viewfunc() == {"json": {"username": "foo"}, "query": {"page": 42}}
def test_use_args_doesnt_change_docstring(parser):
@parser.use_args({"val": fields.Int()})
def viewfunc(args):
"""View docstring"""
pass
assert viewfunc.__doc__ == "View docstring"
def test_use_kwargs_doesnt_change_docstring(parser):
@parser.use_kwargs({"val": fields.Int()})
def viewfunc(val):
"""View docstring"""
pass
assert viewfunc.__doc__ == "View docstring"
def test_list_allowed_missing(web_request, parser):
args = {"name": fields.List(fields.Str())}
web_request.json = {"fakedata": True}
result = parser.parse(args, web_request)
assert result == {}
def test_int_list_allowed_missing(web_request, parser):
args = {"name": fields.List(fields.Int())}
web_request.json = {"fakedata": True}
result = parser.parse(args, web_request)
assert result == {}
def test_multiple_arg_required_with_int_conversion(web_request, parser):
args = {"ids": fields.List(fields.Int(), required=True)}
web_request.json = {"fakedata": True}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert excinfo.value.messages == {"ids": ["Missing data for required field."]}
def test_parse_with_callable(web_request, parser):
web_request.json = {"foo": 42}
class MySchema(Schema):
foo = fields.Field()
if MARSHMALLOW_VERSION_INFO[0] < 3:
class Meta:
strict = True
def make_schema(req):
assert req is web_request
return MySchema(context={"request": req})
result = parser.parse(make_schema, web_request)
assert result == {"foo": 42}
def test_use_args_callable(web_request, parser):
class HelloSchema(Schema):
name = fields.Str()
if MARSHMALLOW_VERSION_INFO[0] < 3:
class Meta:
strict = True
@post_load
def request_data(self, item):
item["data"] = self.context["request"].data
return item
web_request.json = {"name": "foo"}
web_request.data = "request-data"
def make_schema(req):
assert req is web_request
return HelloSchema(context={"request": req})
@parser.use_args(make_schema, web_request)
def viewfunc(args):
return args
assert viewfunc() == {"name": "foo", "data": "request-data"}
class TestPassingSchema:
class UserSchema(Schema):
id = fields.Int(dump_only=True)
email = fields.Email()
password = fields.Str(load_only=True)
if MARSHMALLOW_VERSION_INFO[0] < 3:
class Meta:
strict = True
def test_passing_schema_to_parse(self, parser, web_request):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
result = parser.parse(self.UserSchema(**strict_kwargs), web_request)
assert result == {"email": "foo@bar.com", "password": "bar"}
def test_use_args_can_be_passed_a_schema(self, web_request, parser):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
@parser.use_args(self.UserSchema(**strict_kwargs), web_request)
def viewfunc(args):
return args
assert viewfunc() == {"email": "foo@bar.com", "password": "bar"}
def test_passing_schema_factory_to_parse(self, parser, web_request):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
def factory(req):
assert req is web_request
return self.UserSchema(context={"request": req}, **strict_kwargs)
result = parser.parse(factory, web_request)
assert result == {"email": "foo@bar.com", "password": "bar"}
def test_use_args_can_be_passed_a_schema_factory(self, web_request, parser):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
def factory(req):
assert req is web_request
return self.UserSchema(context={"request": req}, **strict_kwargs)
@parser.use_args(factory, web_request)
def viewfunc(args):
return args
assert viewfunc() == {"email": "foo@bar.com", "password": "bar"}
def test_use_kwargs_can_be_passed_a_schema(self, web_request, parser):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
@parser.use_kwargs(self.UserSchema(**strict_kwargs), web_request)
def viewfunc(email, password):
return {"email": email, "password": password}
assert viewfunc() == {"email": "foo@bar.com", "password": "bar"}
def test_use_kwargs_can_be_passed_a_schema_factory(self, web_request, parser):
web_request.json = {"id": 12, "email": "foo@bar.com", "password": "bar"}
def factory(req):
assert req is web_request
return self.UserSchema(context={"request": req}, **strict_kwargs)
@parser.use_kwargs(factory, web_request)
def viewfunc(email, password):
return {"email": email, "password": password}
assert viewfunc() == {"email": "foo@bar.com", "password": "bar"}
# Must skip on older versions of python due to
# https://github.com/pytest-dev/pytest/issues/840
@pytest.mark.skipif(
sys.version_info < (3, 4),
reason="Skipping due to a bug in pytest's warning recording",
)
@pytest.mark.skipif(
MARSHMALLOW_VERSION_INFO[0] >= 3,
reason='"strict" parameter is removed in marshmallow 3',
)
def test_warning_raised_if_schema_is_not_in_strict_mode(self, web_request, parser):
with pytest.warns(UserWarning) as record:
parser.parse(self.UserSchema(strict=False), web_request)
warning = record[0]
assert "strict=True" in str(warning.message)
def test_use_kwargs_stacked(self, web_request, parser):
web_request.json = {
"id": 12,
"email": "foo@bar.com",
"password": "bar",
"page": 42,
}
@parser.use_kwargs({"page": fields.Int()}, web_request)
@parser.use_kwargs(self.UserSchema(**strict_kwargs), web_request)
def viewfunc(email, password, page):
return {"email": email, "password": password, "page": page}
assert viewfunc() == {"email": "foo@bar.com", "password": "bar", "page": 42}
# Regression test for https://github.com/sloria/webargs/issues/146
def test_parse_does_not_add_missing_values_to_schema_validator(
self, web_request, parser
):
class UserSchema(Schema):
name = fields.Str()
location = fields.Field(required=False)
if MARSHMALLOW_VERSION_INFO[0] < 3:
class Meta:
strict = True
@validates_schema(pass_original=True)
def validate_schema(self, data, original_data):
assert "location" not in original_data
return True
web_request.json = {"name": "Eric Cartman"}
res = parser.parse(UserSchema, web_request, locations=("json",))
assert res == {"name": "Eric Cartman"}
def test_use_args_with_custom_locations_in_parser(web_request, parser):
custom_args = {"foo": fields.Str()}
web_request.json = {}
parser.locations = ("custom",)
@parser.location_handler("custom")
def parse_custom(req, name, arg):
return "bar"
@parser.use_args(custom_args, web_request)
def viewfunc(args):
return args
assert viewfunc() == {"foo": "bar"}
def test_use_kwargs(web_request, parser):
user_args = {"username": fields.Str(), "password": fields.Str()}
web_request.json = {"username": "foo", "password": "bar"}
@parser.use_kwargs(user_args, web_request)
def viewfunc(username, password):
return {"username": username, "password": password}
assert viewfunc() == {"username": "foo", "password": "bar"}
def test_use_kwargs_with_arg_missing(web_request, parser):
user_args = {"username": fields.Str(), "password": fields.Str()}
web_request.json = {"username": "foo"}
@parser.use_kwargs(user_args, web_request)
def viewfunc(username, password):
return {"username": username, "password": password}
assert viewfunc() == {"username": "foo", "password": missing}
def test_delimited_list_default_delimiter(web_request, parser):
web_request.json = {"ids": "1,2,3"}
schema_cls = argmap2schema({"ids": fields.DelimitedList(fields.Int())})
schema = schema_cls()
parsed = parser.parse(schema, web_request)
assert parsed["ids"] == [1, 2, 3]
dumped = schema.dump(parsed)
data = dumped.data if MARSHMALLOW_VERSION_INFO[0] < 3 else dumped
assert data["ids"] == [1, 2, 3]
def test_delimited_list_as_string(web_request, parser):
web_request.json = {"ids": "1,2,3"}
schema_cls = argmap2schema(
{"ids": fields.DelimitedList(fields.Int(), as_string=True)}
)
schema = schema_cls()
parsed = parser.parse(schema, web_request)
assert parsed["ids"] == [1, 2, 3]
dumped = schema.dump(parsed)
data = dumped.data if MARSHMALLOW_VERSION_INFO[0] < 3 else dumped
assert data["ids"] == "1,2,3"
def test_delimited_list_custom_delimiter(web_request, parser):
web_request.json = {"ids": "1|2|3"}
schema_cls = argmap2schema(
{"ids": fields.DelimitedList(fields.Int(), delimiter="|")}
)
schema = schema_cls()
parsed = parser.parse(schema, web_request)
assert parsed["ids"] == [1, 2, 3]
def test_delimited_list_load_list(web_request, parser):
web_request.json = {"ids": [1, 2, 3]}
schema_cls = argmap2schema({"ids": fields.DelimitedList(fields.Int())})
schema = schema_cls()
parsed = parser.parse(schema, web_request)
assert parsed["ids"] == [1, 2, 3]
# Regresion test for https://github.com/sloria/webargs/issues/149
def test_delimited_list_passed_invalid_type(web_request, parser):
web_request.json = {"ids": 1}
schema_cls = argmap2schema({"ids": fields.DelimitedList(fields.Int())})
schema = schema_cls()
with pytest.raises(ValidationError) as excinfo:
parser.parse(schema, web_request)
assert excinfo.value.messages == {"ids": ["Not a valid list."]}
def test_missing_list_argument_not_in_parsed_result(web_request, parser):
# arg missing in request
web_request.json = {}
args = {"ids": fields.List(fields.Int())}
result = parser.parse(args, web_request)
assert "ids" not in result
def test_type_conversion_with_multiple_required(web_request, parser):
web_request.json = {}
args = {"ids": fields.List(fields.Int(), required=True)}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
assert "Missing data for required field." in str(excinfo)
def test_arg_location_param(web_request, parser):
web_request.json = {"foo": 24}
web_request.cookies = {"foo": 42}
args = {"foo": fields.Field(location="cookies")}
parsed = parser.parse(args, web_request)
assert parsed["foo"] == 42
def test_validation_errors_in_validator_are_passed_to_handle_error(parser, web_request):
def validate(value):
raise ValidationError("Something went wrong.")
args = {"name": fields.Field(validate=validate, location="json")}
web_request.json = {"name": "invalid"}
with pytest.raises(ValidationError) as excinfo:
parser.parse(args, web_request)
exc = excinfo.value
assert isinstance(exc, ValidationError)
errors = exc.args[0]
assert errors["name"] == ["Something went wrong."]
class TestValidationError:
def test_can_store_status_code(self):
err = ValidationError("foo", status_code=401)
assert err.status_code == 401
def test_can_store_headers(self):
err = ValidationError("foo", headers={"X-Food-Header": "pizza"})
assert err.headers == {"X-Food-Header": "pizza"}
def test_str(self):
err = ValidationError("foo", status_code=403)
assert str(err) == "foo"
def test_repr(self):
err = ValidationError("foo", status_code=403)
assert repr(err) == (
"ValidationError({0!r}, " "status_code=403, headers=None)".format("foo")
)
def test_parse_basic(web_request, parser):
web_request.json = {"foo": "42"}
args = {"foo": fields.Int()}
result = parser.parse(args, web_request)
assert result == {"foo": 42}
def test_parse_raises_validation_error_if_data_invalid(web_request, parser):
args = {"email": fields.Email()}
web_request.json = {"email": "invalid"}
with pytest.raises(ValidationError):
parser.parse(args, web_request)
def test_argmap2schema():
data_key_kwargs = {
"load_from" if (MARSHMALLOW_VERSION_INFO[0] < 3) else "data_key": "content-type"
}
argmap = {
"id": fields.Int(required=True),
"title": fields.Str(),