Add some tests for the async_endpoint_module template

Author: dbanty

end_to_end_tests/golden-master/my_test_api_client/async_api/default.py

@@ -10,7 +10,7 @@
 async def ping_ping_get(*, client: Client,) -> bool:
 
     """ A quick check to see if the system is running  """
-    url = "{}/ping".format(client.base_url)
+    url = "{}/ping".format(client.base_url,)
 
     async with httpx.AsyncClient() as _client:
         response = await _client.get(url=url, headers=client.get_headers(),)

end_to_end_tests/golden-master/my_test_api_client/async_api/users.py

@@ -19,7 +19,7 @@ async def get_user_list(
 ]:
 
     """ Get a list of things  """
-    url = "{}/tests/".format(client.base_url)
+    url = "{}/tests/".format(client.base_url,)
 
     json_an_enum_value = []
     for an_enum_value_item_data in an_enum_value:
@@ -56,7 +56,7 @@ async def upload_file_tests_upload_post(
 ]:
 
     """ Upload a file  """
-    url = "{}/tests/upload".format(client.base_url)
+    url = "{}/tests/upload".format(client.base_url,)
 
     async with httpx.AsyncClient() as _client:
         response = await _client.post(url=url, headers=client.get_headers(), files=multipart_data.to_dict(),)

openapi_python_client/templates/async_endpoint_module.pyi

@@ -44,14 +44,13 @@ async def {{ endpoint.name | snakecase }}(
 {{ return_type(endpoint) }}
     """ {{ endpoint.description }} """
     url = "{}{{ endpoint.path }}".format(
-        client.base_url
-        {%- for parameter in endpoint.path_parameters -%}
-        ,{{parameter.name}}={{parameter.python_name}}
-        {%- endfor -%}
+        client.base_url,
+        {% for parameter in endpoint.path_parameters %}
+        {{parameter.name}}={{parameter.python_name}},
+        {% endfor %}
     )
 
     {{ query_params(endpoint) | indent(4) }}
-
     {{ json_body(endpoint) | indent(4) }}
 
     async with httpx.AsyncClient() as _client:
@@ -61,7 +60,6 @@ async def {{ endpoint.name | snakecase }}(
             {% if endpoint.form_body_reference %}
             data=asdict(form_data),
             {% endif %}
-
             {% if endpoint.multipart_body_reference %}
             files=multipart_data.to_dict(),
             {% endif %}

pyproject.toml

@@ -66,6 +66,7 @@ exclude = '''
     | \.venv
     | \.mypy_cache
     | openapi_python_client/templates
+    | tests/test_templates
   )/
 )
 '''
@@ -74,3 +75,4 @@ exclude = '''
 line_length = 120
 multi_line_output = 3
 include_trailing_comma = true
+skip = ["tests/test_templates"]

tests/test___init__.py

@@ -484,6 +484,9 @@ def test_load_config(mocker):
     fake_path = mocker.MagicMock(autospec=pathlib.Path)
 
     from openapi_python_client import load_config
+    from openapi_python_client.openapi_parser import reference
+
+    reference.class_overrides = {}
 
     load_config(path=fake_path)
 

tests/test_templates/__init__.py

@@ -0,0 +1,72 @@
+from dataclasses import asdict
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ..client import AuthenticatedClient, Client
+from ..errors import ApiResponseError
+
+import this
+from __future__ import braces
+
+
+async def pascal_case(
+    *,
+    client: Client,
+    path_param_1: str,
+    query_param_1: str,
+) -> str:
+
+    """ GET endpoint """
+    url = "{}/get/{pathParam1}".format(
+        client.base_url,
+        pathParam1=path_param_1,
+    )
+
+    params: Dict[str, Any] = {
+        "queryParam": query_param_1,
+    }
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(
+            url=url,
+            headers=client.get_headers(),
+            params=params,
+        )
+
+    if response.status_code == 200:
+        return str(response.text)
+    else:
+        raise ApiResponseError(response=response)
+
+
+async def camel_case(
+    *,
+    client: AuthenticatedClient,
+    form_data: FormBody,
+    multipart_data: MultiPartBody,
+    json_body: Json,
+) -> Union[
+    str,
+    int,
+]:
+
+    """ POST endpoint """
+    url = "{}/post/".format(
+        client.base_url,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.post(
+            url=url,
+            headers=client.get_headers(),
+            data=asdict(form_data),
+            files=multipart_data.to_dict(),
+            json=json_body,
+        )
+
+    if response.status_code == 200:
+        return str(response.text)
+    if response.status_code == 201:
+        return int(response.text)
+    else:
+        raise ApiResponseError(response=response)

tests/test_templates/async_endpoint_module.py

@@ -0,0 +1,12 @@
+import pytest
+from jinja2 import Environment, PackageLoader
+
+
+@pytest.fixture(scope="session")
+def env() -> Environment:
+    from openapi_python_client import utils
+
+    TEMPLATE_FILTERS = {"snakecase": utils.snake_case}
+    env = Environment(loader=PackageLoader("openapi_python_client"), trim_blocks=True, lstrip_blocks=True)
+    env.filters.update(TEMPLATE_FILTERS)
+    return env

tests/test_templates/conftest.py

@@ -0,0 +1,68 @@
+from pathlib import Path
+
+import pytest
+from jinja2 import Template
+
+
+@pytest.fixture(scope="session")
+def template(env) -> Template:
+    return env.get_template("async_endpoint_module.pyi")
+
+
+def test_async_endpoint_module(template, mocker):
+    path_param = mocker.MagicMock(python_name="path_param_1")
+    path_param.name = "pathParam1"
+    path_param.to_string.return_value = "path_param_1: str"
+    query_param = mocker.MagicMock(template=None, python_name="query_param_1")
+    query_param.name = "queryParam"
+    query_param.to_string.return_value = "query_param_1: str"
+    get_response = mocker.MagicMock(status_code=200)
+    get_response.return_string.return_value = "str"
+    get_response.constructor.return_value = "str(response.text)"
+    get_endpoint = mocker.MagicMock(
+        requires_security=False,
+        path_parameters=[path_param],
+        query_parameters=[query_param],
+        form_body_reference=None,
+        multipart_body_reference=None,
+        json_body=None,
+        responses=[get_response],
+        description="GET endpoint",
+        path="/get/{pathParam1}",
+        method="get",
+    )
+    get_endpoint.name = "PascalCase"
+
+    form_body_reference = mocker.MagicMock(class_name="FormBody")
+    multipart_body_reference = mocker.MagicMock(class_name="MultiPartBody")
+    json_body = mocker.MagicMock(template=None, python_name="json_body")
+    json_body.get_type_string.return_value = "Json"
+    post_response_1 = mocker.MagicMock(status_code=200)
+    post_response_1.return_string.return_value = "str"
+    post_response_1.constructor.return_value = "str(response.text)"
+    post_response_2 = mocker.MagicMock(status_code=201)
+    post_response_2.return_string.return_value = "int"
+    post_response_2.constructor.return_value = "int(response.text)"
+    post_endpoint = mocker.MagicMock(
+        name="camelCase",
+        requires_security=True,
+        path_parameters=[],
+        query_parameters=[],
+        form_body_reference=form_body_reference,
+        multipart_body_reference=multipart_body_reference,
+        json_body=json_body,
+        responses=[post_response_1, post_response_2],
+        description="POST endpoint",
+        path="/post/",
+        method="post",
+    )
+    post_endpoint.name = "camelCase"
+
+    collection = mocker.MagicMock(
+        relative_imports=["import this", "from __future__ import braces"], endpoints=[get_endpoint, post_endpoint],
+    )
+
+    result = template.render(collection=collection)
+    import black
+    expected = (Path(__file__).parent / "async_endpoint_module.py").read_text()
+    black.assert_equivalent(result, expected)