File: test_validate_request.py

package info (click to toggle)
flask-openapi3 4.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,224 kB
  • sloc: python: 4,807; makefile: 14; javascript: 5
file content (108 lines) | stat: -rw-r--r-- 3,262 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
from functools import wraps

import pytest
from flask import request
from pydantic import BaseModel, Field

from flask_openapi3 import APIView, Info, OpenAPI, Tag
from flask_openapi3.request import validate_request


class BookNamePath(BaseModel):
    name: str


class BookBody(BaseModel):
    age: int | None = Field(..., ge=2, le=4, description="Age")
    author: str = Field(None, min_length=2, max_length=4, description="Author")
    name: str


def login_required():
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            if not request.headers.get("Authorization"):
                return {"error": "Unauthorized"}, 401
            kwargs["client_id"] = "client1234565"
            return func(*args, **kwargs)

        return wrapper

    return decorator


@pytest.fixture
def app():
    app = OpenAPI(__name__)
    app.config["TESTING"] = True

    info = Info(title="book API", version="1.0.0")
    jwt = {"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}
    security_schemes = {"jwt": jwt}

    app = OpenAPI(__name__, info=info, security_schemes=security_schemes)
    app.config["TESTING"] = True
    security = [{"jwt": []}]

    api_view = APIView(url_prefix="/v1/books", view_tags=[Tag(name="book")], view_security=security)

    @api_view.route("")
    class BookListAPIView:
        @api_view.doc(summary="get book list", responses={204: None}, doc_ui=False)
        @login_required()
        @validate_request()
        def get(self, client_id: str):
            return {"books": ["book1", "book2"], "client_id": client_id}

        @api_view.doc(summary="create book")
        @login_required()
        @validate_request()
        def post(self, body: BookBody, client_id):
            """description for a created book"""
            return body.model_dump_json()

    @api_view.route("/<name>")
    class BookNameAPIView:
        @api_view.doc(summary="get book by name")
        @login_required()
        @validate_request()
        def get(self, path: BookNamePath, client_id):
            return {"name": path.name, "client_id": client_id}

    app.register_api_view(api_view)
    return app


@pytest.fixture
def client(app):
    client = app.test_client()

    return client


def test_get_book_list_happy(app, client):
    response = client.get("/v1/books", headers={"Authorization": "Bearer sometoken"})
    assert response.status_code == 200
    assert response.json == {"books": ["book1", "book2"], "client_id": "client1234565"}


def test_get_book_list_not_auth(app, client):
    response = client.get("/v1/books", headers={"Nope": "Bearer sometoken"})
    assert response.status_code == 401
    assert response.json == {"error": "Unauthorized"}


def test_create_book_happy(app, client):
    response = client.post(
        "/v1/books",
        json={"age": 3, "author": "John", "name": "some_book_name"},
        headers={"Authorization": "Bearer sometoken"},
    )
    assert response.status_code == 200


def test_get_book_detail_happy(app, client):
    response = client.get("/v1/books/some_book_name", headers={"Authorization": "Bearer sometoken"})
    assert response.status_code == 200
    assert response.json == {"name": "some_book_name", "client_id": "client1234565"}