-
-
Notifications
You must be signed in to change notification settings - Fork 72
/
test_plugin_flask.py
216 lines (168 loc) · 5.44 KB
/
test_plugin_flask.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
import json
from random import randint
import pytest
from flask import Flask, jsonify, request
from spectree import Response, SpecTree
from .common import (
JSON,
SECURITY_SCHEMAS,
Cookies,
Headers,
Query,
Resp,
StrDict,
api_tag,
)
def before_handler(req, resp, err, _):
if err:
resp.headers["X-Error"] = "Validation Error"
def after_handler(req, resp, err, _):
resp.headers["X-Validation"] = "Pass"
def api_after_handler(req, resp, err, _):
resp.headers["X-API"] = "OK"
api = SpecTree("flask", before=before_handler, after=after_handler, annotations=True)
app = Flask(__name__)
app.config["TESTING"] = True
api_secure = SpecTree("flask", security_schemes=SECURITY_SCHEMAS)
app_secure = Flask(__name__)
app_secure.config["TESTING"] = True
@app.route("/ping")
@api.validate(headers=Headers, resp=Response(HTTP_200=StrDict), tags=["test", "health"])
def ping():
"""summary
description"""
return jsonify(msg="pong")
@app.route("/api/user/<name>", methods=["POST"])
@api.validate(
query=Query,
json=JSON,
cookies=Cookies,
resp=Response(HTTP_200=Resp, HTTP_401=None),
tags=[api_tag, "test"],
after=api_after_handler,
)
def user_score(name):
score = [randint(0, request.context.json.limit) for _ in range(5)]
score.sort(reverse=request.context.query.order)
assert request.context.cookies.pub == "abcdefg"
assert request.cookies["pub"] == "abcdefg"
return jsonify(name=request.context.json.name, score=score)
@app.route("/api/user_annotated/<name>", methods=["POST"])
@api.validate(
resp=Response(HTTP_200=Resp, HTTP_401=None),
tags=[api_tag, "test"],
after=api_after_handler,
)
def user_score_annotated(name, query: Query, json: JSON, cookies: Cookies):
score = [randint(0, json.limit) for _ in range(5)]
score.sort(reverse=query.order)
assert cookies.pub == "abcdefg"
assert request.cookies["pub"] == "abcdefg"
return jsonify(name=json.name, score=score)
# INFO: ensures that spec is calculated and cached _after_ registering
# view functions for validations. This enables tests to access `api.spec`
# without app_context.
with app.app_context():
api.spec
api.register(app)
@pytest.fixture
def client():
with app.test_client() as client:
yield client
def test_flask_validate(client):
resp = client.get("/ping")
assert resp.status_code == 422
assert resp.headers.get("X-Error") == "Validation Error"
resp = client.get("/ping", headers={"lang": "en-US"})
assert resp.json == {"msg": "pong"}
assert resp.headers.get("X-Error") is None
assert resp.headers.get("X-Validation") == "Pass"
resp = client.post("api/user/flask")
assert resp.status_code == 422
assert resp.headers.get("X-Error") == "Validation Error"
client.set_cookie("flask", "pub", "abcdefg")
for fragment in ("user", "user_annotated"):
resp = client.post(
f"/api/{fragment}/flask?order=1",
data=json.dumps(dict(name="flask", limit=10)),
content_type="application/json",
)
assert resp.status_code == 200, resp.json
assert resp.headers.get("X-Validation") is None
assert resp.headers.get("X-API") == "OK"
assert resp.json["name"] == "flask"
assert resp.json["score"] == sorted(resp.json["score"], reverse=True)
resp = client.post(
f"/api/{fragment}/flask?order=0",
data=json.dumps(dict(name="flask", limit=10)),
content_type="application/json",
)
assert resp.json["score"] == sorted(resp.json["score"], reverse=False)
resp = client.post(
f"/api/{fragment}/flask?order=0",
data="name=flask&limit=10",
content_type="application/x-www-form-urlencoded",
)
assert resp.json["score"] == sorted(resp.json["score"], reverse=False)
def test_flask_doc(client):
resp = client.get("/apidoc/openapi.json")
assert resp.json == api.spec
resp = client.get("/apidoc/redoc")
assert resp.status_code == 200
resp = client.get("/apidoc/swagger")
assert resp.status_code == 200
"""
Secure param check
"""
@app_secure.route("/no-secure-ping", methods=["GET"])
@api_secure.validate(
resp=Response(HTTP_200=StrDict),
)
def no_secure_ping():
"""
No auth type is set
"""
return jsonify(msg="pong")
@app_secure.route("/apiKey-ping", methods=["GET"])
@api_secure.validate(
resp=Response(HTTP_200=StrDict),
security={"auth_apiKey": []},
)
def apiKey_ping():
"""
apiKey auth type
"""
return jsonify(msg="pong")
@app_secure.route("/apiKey-BasicAuth-ping", methods=["GET"])
@api_secure.validate(
resp=Response(HTTP_200=StrDict),
security={"auth_apiKey": [], "auth_BasicAuth": []},
)
def apiKey_BasicAuth_ping():
"""
Multiple auth types is set - apiKey and BasicAuth
"""
return jsonify(msg="pong")
@app_secure.route("/BasicAuth-ping", methods=["GET"])
@api_secure.validate(
resp=Response(HTTP_200=StrDict),
security={"auth_BasicAuth": []},
)
def BasicAuth_ping():
"""
BasicAuth auth type
"""
return jsonify(msg="pong")
@app_secure.route("/oauth2-flows-ping", methods=["GET"])
@api_secure.validate(
resp=Response(HTTP_200=StrDict),
security={"auth_oauth2": ["admin", "read"]},
)
def oauth_two_ping():
"""
oauth2 auth type with flow
"""
return jsonify(msg="pong")
with app_secure.app_context():
api_secure.spec
api_secure.register(app_secure)