Request response parameters

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.12.6
+FROM python:3.12.6-slim
 
 WORKDIR /app
 
@@ -8,6 +8,8 @@ RUN pip install --no-cache-dir poetry==1.8.4 && \
     poetry config virtualenvs.create false && \
     poetry install --no-root --no-dev
 
-COPY . /app
+COPY eq_cir_converter_service/app eq_cir_converter_service/app
 
-CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "5010"]
+ENV PYTHONPATH=eq_cir_converter_service/app
+
+CMD ["uvicorn", "eq_cir_converter_service.app.main:app", "--host", "0.0.0.0", "--port", "5010"]

Makefile

@@ -28,11 +28,12 @@ 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
+	export PYTHONPATH=eq_cir_converter_service/app && \
+	poetry run pytest -n auto --cov=eq_cir_converter_service/app ./eq_cir_converter_service/tests --cov-report term-missing --cov-fail-under=100
 
 .PHONY: mypy
 mypy:  ## Run mypy.
-	poetry run mypy src
+	poetry run mypy eq_cir_converter_service
 
 .PHONY: install
 install:  ## Install the dependencies excluding dev.
@@ -51,16 +52,17 @@ megalint:  ## Run the mega-linter.
 
 .PHONY: run
 run:  ## Start the local application.
-	poetry run uvicorn src.main:app --reload --port 5010
+	export PYTHONPATH=eq_cir_converter_service/app && \
+	poetry run uvicorn eq_cir_converter_service.app.main:app --reload --port 5010
 
 .PHONY: docker-build
 docker-build:  ## Build the docker image.
 	docker build -t cir-converter-service .
 
 .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 down
+	docker compose down

docker-compose.yml

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

eq_cir_converter_service/app/config/logging_config.py

@@ -0,0 +1,17 @@
+"""Configure the logging level for the application."""
+
+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",
+)

eq_cir_converter_service/app/main.py

@@ -0,0 +1,8 @@
+"""This module is the entry point of the FastAPI application."""
+
+import fastapi
+from routers import schema_router
+
+app = fastapi.FastAPI()
+
+app.include_router(schema_router.router)

eq_cir_converter_service/app/routers/schema_router.py

@@ -0,0 +1,41 @@
+"""This module contains the FastAPI router for the schema conversion endpoint."""
+
+from config.logging_config import logging
+from fastapi import APIRouter
+
+router = APIRouter()
+
+logger = logging.getLogger(__name__)
+
+"""The POST endpoint to convert the CIR schema from one version to another."""
+
+
+@router.post(
+    "/schema",
+    response_model=dict,
+)
+async def convert_schema(
+    current_version: str,
+    target_version: str,
+    schema: dict,
+) -> dict:
+    """Convert the CIR schema from one version to another.
+
+    Request query parameters:
+    - current_version: The current version of the schema.
+    - target_version: The target version of the schema.
+
+    Request body:
+    - schema: The schema to convert.
+
+    Returns:
+    - dict: The converted schema.
+    """
+    logger.info("Posting the cir schema...")
+
+    logger.debug("Received current version %s and target version %s", current_version, target_version)
+    logger.debug("Input body: %s", schema)
+
+    # TO DO: Implement the logic to convert the schema from one version to another
+
+    return schema

eq_cir_converter_service/tests/unit/conftest.py

@@ -0,0 +1,13 @@
+"""Configuration for unit tests."""
+
+from collections.abc import Generator
+
+import app.main as app
+import pytest
+from fastapi.testclient import TestClient
+
+
+@pytest.fixture
+def test_client() -> Generator[TestClient, None, None]:
+    """General client for hitting endpoints in tests."""
+    yield TestClient(app.app)

eq_cir_converter_service/tests/unit/routers/test_schema_router.py

@@ -0,0 +1,16 @@
+"""This module contains the unit tests for the schema router."""
+
+from fastapi import status
+from fastapi.testclient import TestClient
+
+"""Test the schema router with valid JSON."""
+
+
+def test_schema_router_with_valid_json(test_client: TestClient) -> None:
+    """Test the post schema method with valid JSON."""
+    response = test_client.post(
+        "/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"

pyproject.toml

@@ -57,22 +57,17 @@ select = [
 ]
 
 ignore = [
-    # Conflicts with google docstring style
-    "D205",
     # Allow missing docstring, remove to enforce docstrings across the board
-    "D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107",
-    # Disable line length check as it is handled by black
-    # :TODO: Remove E501 when ruff supports all black rules
+    "D100", "D104",
+    # Remove E501 when ruff supports all black rules
     "E501",
-    # indentation contains tabs
-    "W191",
 ]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = [
+"eq_cir_converter_service/tests/*" = [
     # Allow use of assert statements in tests
     "S101",
 ]