add serializated arguments and parameters to request object.

Author: flask-pro

pyproject.toml

@@ -23,15 +23,15 @@ license = {file = "LICENSE"}
 name = "Flask-First"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.17.0"
+version = "0.18.0"
 
 [project.optional-dependencies]
 dev = [
   "bandit==1.7.7",
   "build==1.1.1",
   "mypy==1.8.0",
   "pre-commit==3.6.2",
-  "pytest==8.0.2",
+  "pytest==8.1.2",
   "pytest-cov==4.1.0",
   "python-dotenv==1.0.1",
   "tox==4.13.0",

tests/conftest.py

@@ -1,8 +1,10 @@
 import os
 from collections.abc import Iterable
+from copy import deepcopy
 from pathlib import Path
 
 import pytest
+import yaml
 from flask import Flask
 from flask.testing import FlaskClient
 from flask_first import First
@@ -59,3 +61,90 @@ def _create_app(path_to_spec: str, routes_functions: Iterable):
             return test_client
 
     return _create_app
+
+
+@pytest.fixture
+def fx_make_minimal_spec() -> dict:
+    return {
+        'openapi': '3.1.0',
+        'info': {'title': 'API for testing Flask-First', 'version': '1.0.0'},
+        'paths': {
+            '/endpoint': {
+                'get': {
+                    'operationId': 'get_endpoint',
+                    'responses': {
+                        '200': {
+                            'description': 'OK',
+                            'content': {
+                                'application/json': {
+                                    'schema': {
+                                        'type': 'object',
+                                        'properties': {'message': {'type': 'string'}},
+                                    }
+                                }
+                            },
+                        }
+                    },
+                },
+                'post': {
+                    'operationId': 'post_endpoint',
+                    'requestBody': {
+                        'content': {
+                            'application/json': {
+                                'schema': {
+                                    'type': 'object',
+                                    'properties': {'message': {'type': 'string'}},
+                                }
+                            }
+                        }
+                    },
+                    'responses': {
+                        '201': {
+                            'description': 'OK',
+                            'content': {
+                                'application/json': {
+                                    'schema': {
+                                        'type': 'object',
+                                        'properties': {'message': {'type': 'string'}},
+                                    }
+                                }
+                            },
+                        },
+                        'default': {
+                            'description': 'OK',
+                            'content': {
+                                'application/json': {
+                                    'schema': {
+                                        'type': 'object',
+                                        'properties': {'message': {'type': 'string'}},
+                                    }
+                                }
+                            },
+                        },
+                    },
+                },
+            }
+        },
+    }
+
+
+@pytest.fixture
+def fx_make_spec_file(tmp_path, fx_make_minimal_spec):
+    def _make_spec(paths: dict = None, url: str = None, parameters: list = None) -> Path:
+        spec = deepcopy(fx_make_minimal_spec)
+
+        if paths:
+            spec['paths'] = paths
+        if parameters:
+            spec['paths']['/endpoint']['parameters'] = parameters
+        if url:
+            spec['paths'][url] = deepcopy(spec['paths']['/endpoint'])
+            spec['paths'].pop('/endpoint')
+
+        spec_file_path = tmp_path / 'openapi.yaml'
+        with open(spec_file_path, 'w') as file:
+            yaml.dump(spec, file)
+
+        return spec_file_path
+
+    return _make_spec

tests/test_spec_validator.py

@@ -43,3 +43,20 @@ def test_spec_not_valid(spec):
 
     with pytest.raises(FirstOpenAPIValidation):
         First(spec, app=app, swagger_ui_path='/docs')
+
+
+def test_spec_validator(fx_make_spec_file):
+    spec = fx_make_spec_file()
+    app = Flask('check_v30_specs')
+    app.config['FIRST_RESPONSE_VALIDATION'] = True
+    app.config['FIRST_EXPERIMENTAL_VALIDATOR'] = True
+    first = First(spec, app=app, swagger_ui_path='/docs')
+
+    def get_endpoint() -> dict:
+        return {'message': 'OK'}
+
+    first.add_view_func(get_endpoint)
+
+    r = app.test_client().get('/endpoint', follow_redirects=True)
+    assert r.status_code == 200
+    assert r.json['message'] == 'OK'

tests/test_tools.py

@@ -0,0 +1,46 @@
+from flask_first import request
+
+
+def test_tools__json(fx_make_spec_file, fx_create_app):
+    spec_path = fx_make_spec_file()
+
+    def post_endpoint() -> tuple[dict, int]:
+        json = request.extensions['first']['json']
+        return json, 201
+
+    test_client = fx_create_app(spec_path, [post_endpoint])
+
+    r = test_client.post('/endpoint', json={'message': 'OK'})
+    assert r.status_code == 201
+    assert r.json == {'message': 'OK'}
+
+
+def test_tools__args(fx_make_spec_file, fx_create_app):
+    parameters = [{'name': 'message', 'in': 'query', 'schema': {'type': 'string'}}]
+    spec_path = fx_make_spec_file(parameters=parameters)
+
+    def get_endpoint() -> tuple[dict, int]:
+        args = request.extensions['first']['args']
+        return args
+
+    test_client = fx_create_app(spec_path, [get_endpoint])
+
+    r = test_client.get('/endpoint', query_string={'message': 'OK'})
+    assert r.status_code == 200
+    assert r.json == {'message': 'OK'}
+
+
+def test_tools__view_args(fx_make_spec_file, fx_create_app):
+    url = '/endpoint/{message}'
+    parameters = [{'name': 'message', 'in': 'path', 'required': True, 'schema': {'type': 'string'}}]
+    spec_path = fx_make_spec_file(url=url, parameters=parameters)
+
+    def get_endpoint(message) -> tuple[dict, int]:
+        view_args = request.extensions['first']['view_args']
+        return view_args
+
+    test_client = fx_create_app(spec_path, [get_endpoint])
+
+    r = test_client.get('/endpoint/OK')
+    assert r.status_code == 200
+    assert r.json == {'message': 'OK'}