feat(router): define dummy password generator router(#6)

* fix(workflows): fix pythonpath

.github/workflows/auto-tag-and-release.yml

@@ -24,6 +24,9 @@ jobs:
         uses: py-actions/py-dependency-install@v3
         with:
           path: "requirements-dev.txt"
+      - name: set pythonpath
+        run: |
+          echo "PYTHONPATH=src/" >> $GITHUB_ENV
       - name: Test with pytest
         run: |
           pytest

.github/workflows/run-tests.yml

@@ -20,6 +20,9 @@ jobs:
         uses: py-actions/py-dependency-install@v3
         with:
           path: "requirements-dev.txt"
+      - name: set pythonpath
+        run: |
+          echo "PYTHONPATH=src/" >> $GITHUB_ENV
       - name: Test with pytest
         run: |
           pytest --cov=src/app --cov=src/tests --cov-report xml:coverage.xml src

requirements-dev.txt

@@ -1,3 +1,5 @@
 -r requirements.txt
+httpx
 pytest
+pytest-asyncio
 pytest-cov

src/app/main.py

@@ -4,6 +4,7 @@
 from fastapi import FastAPI, APIRouter
 from fastapi.openapi.utils import get_openapi
 
+from app.routers import router
 
 APP_VERSION = 1.0
 SERVICE_NAME = 'Password Generator'
@@ -16,6 +17,7 @@
 router_api_v1 = APIRouter()
 # Registration of routes
 
+router_api_v1.include_router(router, prefix='/passwords')
 
 # Finalizing setup of router with FastAPI app
 router_api.include_router(router_api_v1, prefix="/v1")

src/app/routers/__init__.py

@@ -0,0 +1,5 @@
+from fastapi import APIRouter
+
+router: APIRouter = APIRouter()
+
+from .password_generation_router import generate_password

src/app/routers/models/requests.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class GeneratePasswordRequest(BaseModel):
+    pass

src/app/routers/models/responses.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class GeneratedPasswordResponse(BaseModel):
+    password: str

src/app/routers/password_generation_router.py

@@ -0,0 +1,14 @@
+from starlette import status
+
+from app.routers import router
+from app.routers.models.requests import GeneratePasswordRequest
+from app.routers.models.responses import GeneratedPasswordResponse
+
+
+@router.post(
+    path='/generate/',
+    status_code=status.HTTP_200_OK,
+    response_model=GeneratedPasswordResponse,
+)
+async def generate_password(request: GeneratePasswordRequest) -> GeneratedPasswordResponse:
+    return GeneratedPasswordResponse(password="something")

src/tests/conftest.py

@@ -0,0 +1,11 @@
+from typing import Generator
+
+import pytest
+from httpx import AsyncClient
+
+from app.main import app, SERVICE_NAME
+
+
+@pytest.fixture(scope="function")
+def mocked_client() -> Generator[AsyncClient, None, None]:
+    yield AsyncClient(app=app, base_url=f'http://{SERVICE_NAME}:9001')

src/tests/unit/routers/test_password_generate_router.py

@@ -0,0 +1,19 @@
+import pytest
+from httpx import AsyncClient
+
+
+@pytest.mark.asyncio
+async def test_generate_password(mocked_client: AsyncClient):
+    async with mocked_client as client:
+        response = await client.post("/api/v1/passwords/generate/", json={})
+
+    assert response.status_code == 200
+    assert response.json() == {"password": "something"}
+
+
+@pytest.mark.asyncio
+async def test_generate_password_but_input_is_not_valid(mocked_client: AsyncClient):
+    async with mocked_client as client:
+        response = await client.post("/api/v1/passwords/generate/", data={})
+
+    assert response.status_code == 422