Merge pull request #1 from fastapi-mvc/improve_template

Improve controller template

Author: rszamszur

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 This file documents changes to [fastapi-mvc/copier-controller](https://github.com/fastapi-mvc/copier-controller). The release numbering uses [semantic versioning](http://semver.org).
 
+## 0.2.0 (01.01.2023)
+
+* Improve controller template. PR [#1](https://github.com/fastapi-mvc/copier-controller/pull/1)
 
 ## 0.1.0 (09.10.2022)
 

template/tests/unit/app/controllers/test_{{controller_name}}.py.jinja

@@ -1,26 +1,24 @@
 import pytest
 from fastapi.testclient import TestClient
-from {{package_name}}.app.asgi import get_app
+from {{package_name}}.app import get_application
 
 
-@pytest.fixture
-def client():
-    # This is an example fixture for generated test sake.
-    # By default there should be a 'app' fixture just like this under:
-    # tests/unit/app/conftest.py
-    app = get_app()
-    with TestClient(app) as client:
-        yield client
-{%- for endpoint, method in endpoints.items() %}
+class Test{{ controller_name.capitalize() }}Controller:
 
+    @pytest.fixture
+    def client(self):
+        # This is an example fixture for generated test sake.
+        # By default there should be a 'app_runner' fixture just like this under:
+        # tests/unit/app/conftest.py
+        app = get_application()
+        with TestClient(app) as client:
+            yield client
+{% for endpoint, method in endpoints.items() %}
+    def test_should{{ endpoint.lower().replace('-','_') }}_return_ok(self, client):
+        # given / when
+        response = client.{{ method.lower() }}("/api/{{ controller_name }}/{{ endpoint.lower().replace('-','_') }}")
 
-def test_{{ endpoint.lower().replace('-','_') }}(client):
-    response = client.{{ method.lower() }}("/{{ controller_name }}/{{ endpoint.lower().replace('-','_') }}")
-    assert response.status_code == 200
-    assert response.json() == {"hello": "world"}
-
-
-{%- endfor %}
-{%- raw %}
-
-{% endraw %}
+        # then
+        assert response.status_code == 200
+        assert response.json() == {"hello": "world"}
+{% endfor %}

template/{{package_name}}/app/controllers/{{controller_name}}.py.jinja

@@ -4,12 +4,9 @@ import logging
 from fastapi import APIRouter
 
 
-router = APIRouter(
-    prefix="/{{ controller_name }}"
-)
+router = APIRouter(prefix="/{{ controller_name }}")
 log = logging.getLogger(__name__)
-{%- for endpoint, method in endpoints.items() %}
-
+{% for endpoint, method in endpoints.items() %}
 
 @router.{{ method.lower() }}(
     "/{{ endpoint.lower().replace('-','_') }}",
@@ -18,11 +15,7 @@ log = logging.getLogger(__name__)
     # https://fastapi.tiangolo.com/tutorial/path-operation-configuration/
 )
 async def {{ endpoint.lower().replace('-','_') }}():
+    """Define {{ controller_name.lower().replace('_', ' ') }} {{ endpoint.lower() }} endpoint."""
     # Implement endpoint logic here.
     return {"hello": "world"}
-
-
-{%- endfor %}
-{%- raw %}
-
-{% endraw %}
+{% endfor %}