Request response parameters

Makefile

@@ -28,7 +28,7 @@ lint:  ## Run all linters (black/ruff/pylint/mypy).
 
 .PHONY: test
 test:  ## Run the tests and check coverage.
-	poetry run pytest -n auto --cov=src --cov-report term-missing --cov-fail-under=100
+	poetry run pytest -vv -n auto --cov=src --cov-report term-missing --cov-fail-under=100
 
 .PHONY: mypy
 mypy:  ## Run mypy.
@@ -59,7 +59,7 @@ docker-build:  ## Build the docker image.
 
 .PHONY: docker-compose-up
 docker-compose-up:  ## Start the docker container using docker-compose.
-	docker-compose up -d
+	docker-compose up --build -d
 
 .PHONY: docker-compose-down
 docker-compose-down:  ## Stop the docker container using docker-compose.

docker-compose.yml

@@ -5,3 +5,5 @@ services:
       - "5010:5010"
     volumes:
       - .:/app
+    environment:
+      - LOG_LEVEL=DEBUG

src/logging_config.py

@@ -0,0 +1,15 @@
+import logging
+import os
+from typing import Any
+
+
+def get_log_level() -> Any:
+    """Get the logging level from the LOG_LEVEL environment variable, or use the default value of INFO."""
+    log_level = os.environ.get("LOG_LEVEL", "INFO")
+    return getattr(logging, log_level)
+
+
+logging.basicConfig(
+    level=get_log_level(),
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+)

src/main.py

@@ -1,9 +1,14 @@
 import fastapi
 
+from src.routers import schema_router
+
 app = fastapi.FastAPI()
 
 
 # Simple hello world endpoint
 @app.get("/")
 def index() -> dict:
     return {"message": "Hello World!"}
+
+
+app.include_router(schema_router.router)

src/routers/schema_router.py

@@ -0,0 +1,25 @@
+from fastapi import APIRouter
+
+from src.logging_config import logging
+
+router = APIRouter()
+
+logger = logging.getLogger(__name__)
+
+
+# The POST endpoint to convert the CIR schema from one version to another
+@router.post(
+    "/convert/schema",
+    response_model=dict,
+)
+async def post_schema(
+    current_version: str,
+    target_version: str,
+    schema: dict,
+) -> dict:
+    logger.info("Posting the cir schema...")
+    logger.debug(f"Input body: {{{schema}}}")
+
+    # TO DO: Implement the logic to convert the schema from one version to another
+
+    return schema

tests/unit/conftest.py

@@ -1,8 +1,11 @@
-# import pytest
+import pytest
+from fastapi.testclient import TestClient
 
 
-# @pytest.fixture()
-# def calculator():
-#     # Create a new instance of the Calculator class for each test session.
-#     yield Calculator()
-#     # Clean up after the test session is complete.
+@pytest.fixture
+def test_client():
+    """General client for hitting endpoints in tests."""
+    import src.main as app
+
+    test_client = TestClient(app.app)
+    yield test_client

tests/unit/test_post_schema.py

@@ -0,0 +1,18 @@
+from unittest import TestCase
+
+import pytest
+from fastapi import status
+
+
+class PostSchemaTest(TestCase):
+    @pytest.fixture(autouse=True)
+    def prepare_fixture(self, test_client):
+        self.test_client = test_client
+
+    def test_post_schema_with_valid_json(self):
+        response = self.test_client.post(
+            "/convert/schema?current_version=1&target_version=2",
+            json={"valid_json": "valid_json"},
+        )
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json()["valid_json"] == "valid_json"