File: test_flask_views.py

package info (click to toggle)
python-openapi-core 0.22.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,104 kB
  • sloc: python: 19,979; makefile: 44
file content (212 lines) | stat: -rw-r--r-- 6,673 bytes parent folder | download | duplicates (2)
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
import pytest
from flask import jsonify
from flask import make_response

from openapi_core import Config
from openapi_core import OpenAPI
from openapi_core.contrib.flask.views import FlaskOpenAPIView


@pytest.fixture(scope="session")
def view_factory(schema_path):
    def create(
        methods=None,
        extra_media_type_deserializers=None,
        extra_format_validators=None,
    ):
        if methods is None:

            def get(view, id):
                return make_response("success", 200)

            methods = {
                "get": get,
            }
        MyView = type("MyView", (FlaskOpenAPIView,), methods)
        extra_media_type_deserializers = extra_media_type_deserializers or {}
        extra_format_validators = extra_format_validators or {}
        config = Config(
            extra_media_type_deserializers=extra_media_type_deserializers,
            extra_format_validators=extra_format_validators,
        )
        openapi = OpenAPI(schema_path, config=config)
        return MyView.as_view(
            "myview",
            openapi,
        )

    return create


class TestFlaskOpenAPIView:
    @pytest.fixture
    def client(self, client_factory, app):
        client = client_factory(app)
        with app.app_context():
            yield client

    def test_invalid_content_type(self, client, app, view_factory):
        def get(view, id):
            view_response = make_response("success", 200)
            view_response.headers["X-Rate-Limit"] = "12"
            return view_response

        view_func = view_factory({"get": get})
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.get("/browse/12/")

        assert result.status_code == 415
        assert result.json == {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.templating.media_types."
                        "exceptions.MediaTypeNotFound'>"
                    ),
                    "status": 415,
                    "title": (
                        "Content for the following mimetype not found: "
                        "text/html. Valid mimetypes: ['application/json']"
                    ),
                }
            ]
        }

    def test_server_error(self, client, app, view_factory):
        view_func = view_factory()
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.get("/browse/12/", base_url="https://localhost")

        expected_data = {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.templating.paths.exceptions."
                        "ServerNotFound'>"
                    ),
                    "status": 400,
                    "title": (
                        "Server not found for "
                        "https://localhost/browse/{id}/"
                    ),
                }
            ]
        }
        assert result.status_code == 400
        assert result.json == expected_data

    def test_operation_error(self, client, app, view_factory):
        def put(view, id):
            return make_response("success", 200)

        view_func = view_factory({"put": put})
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.put("/browse/12/")

        expected_data = {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.templating.paths.exceptions."
                        "OperationNotFound'>"
                    ),
                    "status": 405,
                    "title": (
                        "Operation put not found for "
                        "http://localhost/browse/{id}/"
                    ),
                }
            ]
        }
        assert result.status_code == 405
        assert result.json == expected_data

    def test_path_error(self, client, app, view_factory):
        view_func = view_factory()
        app.add_url_rule("/browse/", view_func=view_func)

        result = client.get("/browse/")

        expected_data = {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.templating.paths.exceptions."
                        "PathNotFound'>"
                    ),
                    "status": 404,
                    "title": (
                        "Path not found for " "http://localhost/browse/"
                    ),
                }
            ]
        }
        assert result.status_code == 404
        assert result.json == expected_data

    def test_endpoint_error(self, client, app, view_factory):
        view_func = view_factory()
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.get("/browse/invalidparameter/")

        expected_data = {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.casting.schemas.exceptions."
                        "CastError'>"
                    ),
                    "status": 400,
                    "title": (
                        "Failed to cast value to integer type: "
                        "invalidparameter"
                    ),
                }
            ]
        }
        assert result.status_code == 400
        assert result.json == expected_data

    def test_missing_required_header(self, client, app, view_factory):
        def get(view, id):
            return jsonify(data="data")

        view_func = view_factory({"get": get})
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.get("/browse/12/")

        expected_data = {
            "errors": [
                {
                    "class": (
                        "<class 'openapi_core.validation.response.exceptions."
                        "MissingRequiredHeader'>"
                    ),
                    "status": 400,
                    "title": ("Missing required header: X-Rate-Limit"),
                }
            ]
        }
        assert result.status_code == 400
        assert result.json == expected_data

    def test_valid(self, client, app, view_factory):
        def get(view, id):
            resp = jsonify(data="data")
            resp.headers["X-Rate-Limit"] = "12"
            return resp

        view_func = view_factory({"get": get})
        app.add_url_rule("/browse/<id>/", view_func=view_func)

        result = client.get("/browse/12/")

        assert result.status_code == 200
        assert result.json == {
            "data": "data",
        }