Add code coverage

Add a command line tool to generate OAS in a file

.gitignore

@@ -1,6 +1,9 @@
+.coverage
 .idea/
 .pytest_cache
 __pycache__
 aiohttp_pydantic.egg-info/
 build/
+coverage.xml
 dist/
+

.travis.yml

@@ -2,11 +2,14 @@ language: python
 python:
 - '3.8'
 script:
-- pytest tests/
+- pytest --cov-report=xml --cov=aiohttp_pydantic tests/
 install:
 - pip install -U setuptools wheel pip
-- pip install -r test_requirements.txt
+- pip install -r requirements/test.txt
+- pip install -r requirements/ci.txt
 - pip install .
+after_success:
+  - codecov
 deploy:
   provider: pypi
   username: __token__
@@ -16,4 +19,4 @@ deploy:
   on:
     tags: true
     branch: main
-    python: '3.8'
+    python: '3.8'

README.rst

@@ -1,6 +1,28 @@
 Aiohttp pydantic - Aiohttp View to validate and parse request
 =============================================================
 
+.. image:: https://travis-ci.org/Maillol/aiohttp-pydantic.svg?branch=main
+  :target: https://travis-ci.org/Maillol/aiohttp-pydantic
+
+.. image:: https://img.shields.io/pypi/v/aiohttp-pydantic
+  :target: https://img.shields.io/pypi/v/aiohttp-pydantic
+  :alt: Latest PyPI package version
+
+.. image:: https://codecov.io/gh/Maillol/aiohttp-pydantic/branch/add_code_coverage/graph/badge.svg
+  :target: https://codecov.io/gh/Maillol/aiohttp-pydantic
+  :alt: codecov.io status for master branch
+
+Aiohttp pydantic is an `aiohttp view`_ to easily parse and validate request.
+You define using the function annotations what your methods for handling HTTP verbs expects and Aiohttp pydantic parses the HTTP request
+for you, validates the data, and injects that you want as parameters.
+
+
+Features:
+
+- Query string, request body, URL path and HTTP headers validation.
+- Open API Specification generation.
+
+
 How to install
 --------------
 
@@ -145,8 +167,8 @@ To declare a HTTP headers parameters, you must declare your argument as a `keywo
 .. _pydantic Model: https://pydantic-docs.helpmanual.io/usage/models/
 .. _keyword-only argument: https://www.python.org/dev/peps/pep-3102/
 
-Add route to generate Open Api Specification
+Add route to generate Open Api Specification (OAS)
---------------------------------------------
+--------------------------------------------------
 
 aiohttp_pydantic provides a sub-application to serve a route to generate Open Api Specification
 reading annotation in your PydanticView. Use *aiohttp_pydantic.oas.setup()* to add the sub-application
@@ -168,8 +190,8 @@ By default, the route to display the Open Api Specification is /oas but you can
 
     oas.setup(app, url_prefix='/spec-api')
 
-If you want generate the Open Api Specification from several aiohttp sub-application.
+If you want generate the Open Api Specification from specific aiohttp sub-applications.
-on the same route, you must use *apps_to_expose* parameters
+on the same route, you must use *apps_to_expose* parameter.
 
 
 .. code-block:: python3
@@ -179,9 +201,9 @@ on the same route, you must use *apps_to_expose* parameters
 
     app = web.Application()
     sub_app_1 = web.Application()
+    sub_app_2 = web.Application()
 
-    oas.setup(app, apps_to_expose=[app, sub_app_1])
+    oas.setup(app, apps_to_expose=[sub_app_1, sub_app_2])
-
 
 Add annotation to define response content
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -232,7 +254,6 @@ defined using a pydantic.BaseModel
             self.request.app["model"].remove_pet(id)
             return web.Response(status=204)
 
-
 Demo
 ----
 
@@ -247,5 +268,12 @@ Have a look at `demo`_ for a complete example
 
 Go to http://127.0.0.1:8080/oas
 
+You can generate the OAS in a json file using the command:
+
+.. code-block:: bash
+
+    python -m aiohttp_pydantic.oas demo.main
+
 
 .. _demo: https://github.com/Maillol/aiohttp-pydantic/tree/main/demo
+.. _aiohttp view: https://docs.aiohttp.org/en/stable/web_quickstart.html#class-based-views

aiohttp_pydantic/__init__.py

@@ -1,5 +1,5 @@
 from .view import PydanticView
 
-__version__ = "1.3.0"
+__version__ = "1.4.1"
 
 __all__ = ("PydanticView", "__version__")

aiohttp_pydantic/injectors.py

@@ -1,10 +1,14 @@
 import abc
 from inspect import signature
+from json.decoder import JSONDecodeError
 from typing import Callable, Tuple
 
+from aiohttp.web_exceptions import HTTPBadRequest
 from aiohttp.web_request import BaseRequest
 from pydantic import BaseModel
 
+from .utils import is_pydantic_base_model
+
 
 class AbstractInjector(metaclass=abc.ABCMeta):
     """
@@ -45,7 +49,13 @@ class BodyGetter(AbstractInjector):
         self.arg_name, self.model = next(iter(args_spec.items()))
 
     async def inject(self, request: BaseRequest, args_view: list, kwargs_view: dict):
-        body = await request.json()
+        try:
+            body = await request.json()
+        except JSONDecodeError:
+            raise HTTPBadRequest(
+                text='{"error": "Malformed JSON"}', content_type="application/json"
+            )
+
         kwargs_view[self.arg_name] = self.model(**body)
 
 
@@ -98,7 +108,7 @@ def _parse_func_signature(func: Callable) -> Tuple[dict, dict, dict, dict]:
         if param_spec.kind is param_spec.POSITIONAL_ONLY:
             path_args[param_name] = param_spec.annotation
         elif param_spec.kind is param_spec.POSITIONAL_OR_KEYWORD:
-            if issubclass(param_spec.annotation, BaseModel):
+            if is_pydantic_base_model(param_spec.annotation):
                 body_args[param_name] = param_spec.annotation
             else:
                 qs_args[param_name] = param_spec.annotation

aiohttp_pydantic/oas/__main__.py

@@ -0,0 +1,8 @@
+import argparse
+
+from .cmd import setup
+
+parser = argparse.ArgumentParser(description="Generate Open API Specification")
+setup(parser)
+args = parser.parse_args()
+args.func(args)

aiohttp_pydantic/oas/cmd.py

@@ -0,0 +1,45 @@
+import argparse
+import importlib
+import json
+
+from .view import generate_oas
+
+
+def application_type(value):
+    """
+    Return aiohttp application defined in the value.
+    """
+    try:
+        module_name, app_name = value.split(":")
+    except ValueError:
+        module_name, app_name = value, "app"
+
+    module = importlib.import_module(module_name)
+    try:
+        if app_name.endswith("()"):
+            app_name = app_name.strip("()")
+            factory_app = getattr(module, app_name)
+            return factory_app()
+        return getattr(module, app_name)
+
+    except AttributeError as error:
+        raise argparse.ArgumentTypeError(error) from error
+
+
+def setup(parser: argparse.ArgumentParser):
+    parser.add_argument(
+        "apps",
+        metavar="APP",
+        type=application_type,
+        nargs="*",
+        help="The name of the module containing the asyncio.web.Application."
+        " By default the variable named 'app' is loaded but you can define"
+        " an other variable name ending the name of module with : characters"
+        " and the name of variable. Example: my_package.my_module:my_app",
+    )
+
+    parser.set_defaults(func=show_oas)
+
+
+def show_oas(args: argparse.Namespace):
+    print(json.dumps(generate_oas(args.apps), sort_keys=True, indent=4))

aiohttp_pydantic/oas/view.py

@@ -1,28 +1,20 @@
+from inspect import getdoc
 import typing
-from typing import Type
+from typing import List, Type
 
 from aiohttp.web import Response, json_response
-from pydantic import BaseModel
+from aiohttp.web_app import Application
 
 from aiohttp_pydantic.oas.struct import OpenApiSpec3, OperationObject, PathItem
 
 from ..injectors import _parse_func_signature
+from ..utils import is_pydantic_base_model
 from ..view import PydanticView, is_pydantic_view
 from .typing import is_status_code_type
 
 JSON_SCHEMA_TYPES = {float: "number", str: "string", int: "integer"}
 
 
-def _is_pydantic_base_model(obj):
-    """
-    Return true is obj is a pydantic.BaseModel subclass.
-    """
-    try:
-        return issubclass(obj, BaseModel)
-    except TypeError:
-        return False
-
-
 class _OASResponseBuilder:
     """
     Parse the type annotated as returned by a function and
@@ -34,7 +26,7 @@ class _OASResponseBuilder:
 
     @staticmethod
     def _handle_pydantic_base_model(obj):
-        if _is_pydantic_base_model(obj):
+        if is_pydantic_base_model(obj):
             return obj.schema()
         return {}
 
@@ -76,6 +68,9 @@ def _add_http_method_to_oas(
     oas_operation: OperationObject = getattr(oas_path, http_method)
     handler = getattr(view, http_method)
     path_args, body_args, qs_args, header_args = _parse_func_signature(handler)
+    description = getdoc(handler)
+    if description:
+        oas_operation.description = description
 
     if body_args:
         oas_operation.request_body.content = {
@@ -106,11 +101,10 @@ def _add_http_method_to_oas(
         _OASResponseBuilder(oas_operation).build(return_type)
 
 
-async def get_oas(request):
+def generate_oas(apps: List[Application]) -> dict:
     """
-    Generate Open Api Specification from PydanticView in application.
+    Generate and return Open Api Specification from PydanticView in application.
     """
-    apps = request.app["apps to expose"]
     oas = OpenApiSpec3()
     for app in apps:
         for resources in app.router.resources():
@@ -125,7 +119,15 @@ async def get_oas(request):
                     else:
                         _add_http_method_to_oas(path, resource_route.method, view)
 
-    return json_response(oas.spec)
+    return oas.spec
+
+
+async def get_oas(request):
+    """
+    View to generate the Open Api Specification from PydanticView in application.
+    """
+    apps = request.app["apps to expose"]
+    return json_response(generate_oas(apps))
 
 
 async def oas_ui(request):

aiohttp_pydantic/utils.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+def is_pydantic_base_model(obj):
+    """
+    Return true is obj is a pydantic.BaseModel subclass.
+    """
+    try:
+        return issubclass(obj, BaseModel)
+    except TypeError:
+        return False

aiohttp_pydantic/view.py

@@ -9,8 +9,14 @@ from aiohttp.web_exceptions import HTTPMethodNotAllowed
 from aiohttp.web_response import StreamResponse
 from pydantic import ValidationError
 
-from .injectors import (AbstractInjector, BodyGetter, HeadersGetter,
+from .injectors import (
-                        MatchInfoGetter, QueryGetter, _parse_func_signature)
+    AbstractInjector,
+    BodyGetter,
+    HeadersGetter,
+    MatchInfoGetter,
+    QueryGetter,
+    _parse_func_signature,
+)
 
 
 class PydanticView(AbstractView):

demo/__main__.py

@@ -1,25 +1,5 @@
 from aiohttp import web
-from aiohttp.web import middleware
 
-from aiohttp_pydantic import oas
+from .main import app
-
-from .model import Model
-from .view import PetCollectionView, PetItemView
-
-
-@middleware
-async def pet_not_found_to_404(request, handler):
-    try:
-        return await handler(request)
-    except Model.NotFound as key:
-        return web.json_response({"error": f"Pet {key} does not exist"}, status=404)
-
-
-app = web.Application(middlewares=[pet_not_found_to_404])
-oas.setup(app)
-
-app["model"] = Model()
-app.router.add_view("/pets", PetCollectionView)
-app.router.add_view("/pets/{id}", PetItemView)
 
 web.run_app(app)

demo/main.py

@@ -0,0 +1,22 @@
+from aiohttp.web import Application, json_response, middleware
+
+from aiohttp_pydantic import oas
+
+from .model import Model
+from .view import PetCollectionView, PetItemView
+
+
+@middleware
+async def pet_not_found_to_404(request, handler):
+    try:
+        return await handler(request)
+    except Model.NotFound as key:
+        return json_response({"error": f"Pet {key} does not exist"}, status=404)
+
+
+app = Application(middlewares=[pet_not_found_to_404])
+oas.setup(app)
+
+app["model"] = Model()
+app.router.add_view("/pets", PetCollectionView)
+app.router.add_view("/pets/{id}", PetItemView)

demo/model.py

@@ -4,6 +4,7 @@ from pydantic import BaseModel
 class Pet(BaseModel):
     id: int
     name: str
+    age: int
 
 
 class Error(BaseModel):

demo/view.py

@@ -1,4 +1,4 @@
-from typing import List, Union
+from typing import List, Optional, Union
 
 from aiohttp import web
 
@@ -9,9 +9,11 @@ from .model import Error, Pet
 
 
 class PetCollectionView(PydanticView):
-    async def get(self) -> r200[List[Pet]]:
+    async def get(self, age: Optional[int] = None) -> r200[List[Pet]]:
         pets = self.request.app["model"].list_pets()
-        return web.json_response([pet.dict() for pet in pets])
+        return web.json_response(
+            [pet.dict() for pet in pets if age is None or age == pet.age]
+        )
 
     async def post(self, pet: Pet) -> r201[Pet]:
         self.request.app["model"].add_pet(pet)

requirements/ci.txt

@@ -0,0 +1,7 @@
+certifi==2020.11.8
+chardet==3.0.4
+codecov==2.1.10
+coverage==5.3
+idna==2.10
+requests==2.25.0
+urllib3==1.26.2

requirements/test.txt

@@ -0,0 +1,13 @@
+attrs==20.3.0
+coverage==5.3
+iniconfig==1.1.1
+packaging==20.4
+pluggy==0.13.1
+py==1.9.0
+pyparsing==2.4.7
+pytest==6.1.2
+pytest-aiohttp==0.3.0
+pytest-cov==2.10.1
+six==1.15.0
+toml==0.10.2
+typing-extensions==3.7.4.3

setup.cfg

@@ -35,8 +35,8 @@ install_requires =
     swagger-ui-bundle
 
 [options.extras_require]
-test = pytest; pytest-aiohttp
+test = pytest==6.1.2; pytest-aiohttp==0.3.0; pytest-cov==2.10.1
-
+ci = pytest==6.1.2; pytest-aiohttp==0.3.0; pytest-cov==2.10.1; codecov==2.1.10
 
 [options.packages.find]
 exclude =

test_requirements.txt

@@ -1,3 +0,0 @@
-pytest==6.1.1
-pytest-aiohttp==0.3.0
-typing_extensions>=3.6.5

tests/test_oas/test_cmd/sample.py

@@ -0,0 +1,27 @@
+from aiohttp import web
+
+from aiohttp_pydantic import PydanticView
+
+
+class View1(PydanticView):
+    async def get(self, a: int, /):
+        return web.json_response()
+
+
+class View2(PydanticView):
+    async def post(self, b: int, /):
+        return web.json_response()
+
+
+sub_app = web.Application()
+sub_app.router.add_view("/route-2/{b}", View2)
+
+app = web.Application()
+app.router.add_view("/route-1/{a}", View1)
+app.add_subapp("/sub-app", sub_app)
+
+
+def make_app():
+    app = web.Application()
+    app.router.add_view("/route-3/{a}", View1)
+    return app

tests/test_oas/test_cmd/test_cmd.py

@@ -0,0 +1,120 @@
+import argparse
+from textwrap import dedent
+
+import pytest
+
+from aiohttp_pydantic.oas import cmd
+
+
+@pytest.fixture
+def cmd_line():
+    parser = argparse.ArgumentParser()
+    cmd.setup(parser)
+    return parser
+
+
+def test_show_oad_of_app(cmd_line, capfd):
+    args = cmd_line.parse_args(["tests.test_oas.test_cmd.sample"])
+    args.func(args)
+    captured = capfd.readouterr()
+    expected = dedent(
+        """
+        {
+        "openapi": "3.0.0",
+        "paths": {
+            "/route-1/{a}": {
+                "get": {
+                    "parameters": [
+                        {
+                            "in": "path",
+                            "name": "a",
+                            "required": true,
+                            "schema": {
+                                "type": "integer"
+                            }
+                        }
+                    ]
+                }
+            },
+            "/sub-app/route-2/{b}": {
+                "post": {
+                    "parameters": [
+                        {
+                            "in": "path",
+                            "name": "b",
+                            "required": true,
+                            "schema": {
+                                "type": "integer"
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    }
+    """
+    )
+
+    assert captured.out.strip() == expected.strip()
+
+
+def test_show_oad_of_sub_app(cmd_line, capfd):
+    args = cmd_line.parse_args(["tests.test_oas.test_cmd.sample:sub_app"])
+    args.func(args)
+    captured = capfd.readouterr()
+    expected = dedent(
+        """
+        {
+        "openapi": "3.0.0",
+        "paths": {
+            "/sub-app/route-2/{b}": {
+                "post": {
+                    "parameters": [
+                        {
+                            "in": "path",
+                            "name": "b",
+                            "required": true,
+                            "schema": {
+                                "type": "integer"
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    }
+    """
+    )
+
+    assert captured.out.strip() == expected.strip()
+
+
+def test_show_oad_of_a_callable(cmd_line, capfd):
+    args = cmd_line.parse_args(["tests.test_oas.test_cmd.sample:make_app()"])
+    args.func(args)
+    captured = capfd.readouterr()
+    expected = dedent(
+        """
+        {
+        "openapi": "3.0.0",
+        "paths": {
+            "/route-3/{a}": {
+                "get": {
+                    "parameters": [
+                        {
+                            "in": "path",
+                            "name": "a",
+                            "required": true,
+                            "schema": {
+                                "type": "integer"
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    }
+    """
+    )
+
+    assert captured.out.strip() == expected.strip()

tests/test_oas/test_view.py

@@ -15,9 +15,13 @@ class Pet(BaseModel):
 
 class PetCollectionView(PydanticView):
     async def get(self) -> r200[List[Pet]]:
+        """
+        Get a list of pets
+        """
         return web.json_response()
 
     async def post(self, pet: Pet) -> r201[Pet]:
+        """Create a Pet"""
         return web.json_response()
 
 
@@ -52,6 +56,7 @@ async def test_generated_oas_should_have_pets_paths(generated_oas):
 
 async def test_pets_route_should_have_get_method(generated_oas):
     assert generated_oas["paths"]["/pets"]["get"] == {
+        "description": "Get a list of pets",
         "responses": {
             "200": {
                 "content": {
@@ -71,12 +76,13 @@ async def test_pets_route_should_have_get_method(generated_oas):
                     }
                 }
             }
-        }
+        },
     }
 
 
 async def test_pets_route_should_have_post_method(generated_oas):
     assert generated_oas["paths"]["/pets"]["post"] == {
+        "description": "Create a Pet",
         "requestBody": {
             "content": {
                 "application/json": {

tests/test_validation_query_string.py

@@ -1,11 +1,13 @@
+from typing import Optional
+
 from aiohttp import web
 
 from aiohttp_pydantic import PydanticView
 
 
 class ArticleView(PydanticView):
-    async def get(self, with_comments: bool):
+    async def get(self, with_comments: bool, age: Optional[int] = None):
-        return web.json_response({"with_comments": with_comments})
+        return web.json_response({"with_comments": with_comments, "age": age})
 
 
 async def test_get_article_without_required_qs_should_return_an_error_message(
@@ -53,7 +55,22 @@ async def test_get_article_with_valid_qs_should_return_the_parsed_type(
     app.router.add_view("/article", ArticleView)
 
     client = await aiohttp_client(app)
+
+    resp = await client.get("/article", params={"with_comments": "yes", "age": 3})
+    assert resp.status == 200
+    assert resp.content_type == "application/json"
+    assert await resp.json() == {"with_comments": True, "age": 3}
+
+
+async def test_get_article_with_valid_qs_and_omitted_optional_should_return_none(
+    aiohttp_client, loop
+):
+    app = web.Application()
+    app.router.add_view("/article", ArticleView)
+
+    client = await aiohttp_client(app)
+
     resp = await client.get("/article", params={"with_comments": "yes"})
     assert resp.status == 200
     assert resp.content_type == "application/json"
-    assert await resp.json() == {"with_comments": True}
+    assert await resp.json() == {"with_comments": True, "age": None}