Generate complete client for e2e testing

Closes #17

Author: dbanty

poetry.lock

@@ -35,6 +35,7 @@ taskipy = "^1.1.3"
 isort = "^4.3.21"
 safety = "^1.8.5"
 pytest-cov = "^2.8.1"
+fastapi = "^0.52.0"
 
 [tool.taskipy.tasks]
 check = "isort --recursive --apply && black . && safety check && mypy openapi_python_client"

pyproject.toml

@@ -0,0 +1 @@
+""" Generate a complete client and verify that it is correct """

tests/test_end_to_end/__init__.py

@@ -0,0 +1,25 @@
+""" A FastAPI app used to create an OpenAPI document for end-to-end testing """
+import json
+from pathlib import Path
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+app = FastAPI(
+    title="My Test API",
+    description="An API for testing openapi-python-client",
+)
+
+
+class PingResponse(BaseModel):
+    success: bool
+
+
+@app.get("/ping", response_model=PingResponse)
+async def ping():
+    """ A quick check to see if the system is running """
+    return {"success": True}
+
+if __name__ == '__main__':
+    path = Path(__file__).parent / "openapi.json"
+    path.write_text(json.dumps(app.openapi()))

tests/test_end_to_end/fastapi/__init__.py

@@ -0,0 +1 @@
+{"openapi": "3.0.2", "info": {"title": "My Test API", "description": "An API for testing openapi-python-client", "version": "0.1.0"}, "paths": {"/ping": {"get": {"summary": "Ping", "description": "A quick check to see if the system is running ", "operationId": "ping_ping_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PingResponse"}}}}}}}}, "components": {"schemas": {"PingResponse": {"title": "PingResponse", "required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}}}}}}

tests/test_end_to_end/fastapi/openapi.json

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

tests/test_end_to_end/golden-master/.gitignore

@@ -0,0 +1,37 @@
+# my-test-api-client
+A client library for accessing My Test API
+
+## Usage
+First, create a client:
+
+```python
+from my_test_api_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from my_test_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from my_test_api_client.models import MyDataModel
+from my_test_api_client.api.my_tag import get_my_data_model
+
+my_data: MyDataModel = get_my_data_model(client=client)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python function with type annotations. 
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `my_test_api_client.api.default`
+1. If the API returns a response code that was not declared in the OpenAPI document, a 
+    `my_test_api_client.api.errors.ApiResponseError` wil be raised 
+    with the `response` attribute set to the `httpx.Response` that was received.

tests/test_end_to_end/golden-master/README.md

@@ -0,0 +1,2 @@
+""" A client library for accessing My Test API """
+from .client import AuthenticatedClient, Client

tests/test_end_to_end/golden-master/my_test_api_client/__init__.py

@@ -0,0 +1 @@
+""" Contains all methods for accessing the API """

tests/test_end_to_end/golden-master/my_test_api_client/api/__init__.py

@@ -0,0 +1,30 @@
+from dataclasses import asdict
+from typing import Dict, List, Optional, Union
+
+import httpx
+
+from ..client import AuthenticatedClient, Client
+from .errors import ApiResponseError
+
+from ..models.ping_response import PingResponse
+
+
+def ping_ping_get(
+    *,
+    client: Client,
+) -> Union[
+    PingResponse,
+]:
+    """ A quick check to see if the system is running  """
+    url = f"{client.base_url}/ping"
+
+
+    response = httpx.get(
+        url=url,
+        headers=client.get_headers(),
+    )
+
+    if response.status_code == 200:
+        return PingResponse.from_dict(response.json())
+    else:
+        raise ApiResponseError(response=response)

tests/test_end_to_end/golden-master/my_test_api_client/api/default.py

@@ -0,0 +1,8 @@
+from httpx import Response
+
+class ApiResponseError(Exception):
+    """ An exception raised when an unknown response occurs """
+
+    def __init__(self, *, response: Response):
+        super().__init__()
+        self.response: Response = response

tests/test_end_to_end/golden-master/my_test_api_client/api/errors.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from typing import Dict
+
+@dataclass
+class Client:
+    """ A class for keeping track of data related to the API """
+
+    base_url: str
+
+    def get_headers(self) -> Dict[str, str]:
+        """ Get headers to be used in all endpoints """
+        return {}
+
+@dataclass
+class AuthenticatedClient(Client):
+    """ A Client which has been authenticated for use on secured endpoints """
+
+    token: str
+
+    def get_headers(self) -> Dict[str, str]:
+        """ Get headers to be used in authenticated endpoints """
+        return {"Authorization": f"Bearer {self.token}"}

tests/test_end_to_end/golden-master/my_test_api_client/client.py

@@ -0,0 +1,3 @@
+""" Contains all the data models used in inputs/outputs """
+
+from .ping_response import PingResponse

tests/test_end_to_end/golden-master/my_test_api_client/models/__init__.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Dict, List, Optional, cast
+
+
+
+@dataclass
+class PingResponse:
+    """  """
+    success: bool
+
+    def to_dict(self) -> Dict:
+        return {
+            "success": self.success,
+        }
+
+    @staticmethod
+    def from_dict(d: Dict) -> PingResponse:
+
+        success = d["success"]
+        return PingResponse(
+            success=success,
+        )

tests/test_end_to_end/golden-master/my_test_api_client/models/ping_response.py

@@ -0,0 +1 @@
+# Marker file for PEP 561

tests/test_end_to_end/golden-master/my_test_api_client/py.typed

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "my-test-api-client"
+version = "0.1.0"
+description = "A client library for accessing My Test API"
+
+authors = []
+
+readme = "README.md"
+packages = [
+    {include = "my_test_api_client"},
+]
+include = ["CHANGELOG.md", "my_test_api_client/py.typed"]
+
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = "^0.12.1"

tests/test_end_to_end/golden-master/pyproject.toml

@@ -0,0 +1,36 @@
+import os
+import shutil
+from filecmp import dircmp, cmpfiles
+from pathlib import Path
+
+import pytest
+from typer.testing import CliRunner
+from openapi_python_client.cli import app
+
+
+def _compare_directories(first: Path, second: Path, /):
+    first_printable = first.relative_to(Path.cwd())
+    second_printable = second.relative_to(Path.cwd())
+    dc = dircmp(first, second)
+    missing_files = dc.left_only + dc.right_only
+    if missing_files:
+        pytest.fail(f"{first_printable} or {second_printable} was missing: {missing_files}", pytrace=False)
+
+    match, mismatch, errors = cmpfiles(first, second, dc.common_files, shallow=False)
+    if mismatch:
+        pytest.fail(f"{first_printable} and {second_printable} had differing files: {mismatch}", pytrace=False)
+
+    for sub_path in dc.common_dirs:
+        _compare_directories(first / sub_path, second / sub_path)
+
+
+def test_end_to_end(capsys):
+    runner = CliRunner()
+    openapi_path = Path(__file__).parent / "fastapi" / "openapi.json"
+    gm_path = Path(__file__).parent / "golden-master"
+    output_path = Path.cwd() / "my-test-api-client"
+
+    runner.invoke(app, ["generate", f"--path={openapi_path}"])
+
+    _compare_directories(gm_path, output_path)
+    shutil.rmtree(output_path)