(fix) add logic to test for message forwarding

app/test_main.py aktualisiert
(fix) remove unnecessary print statement
2025-07-18 09:58:48 +02:00 · 2025-07-16 17:48:32 +00:00 · 2025-07-16 10:48:46 +02:00 · 2025-07-16 10:31:57 +02:00 · 2025-07-16 10:11:48 +02:00 · 2025-07-16 10:07:53 +02:00
10 changed files with 325 additions and 13 deletions
--- a/.python-version
+++ b/.python-version
@@ -1 +1 @@
-3.12
+3.12.6
--- a/16
+++ b/16
@@ -0,0 +1,16 @@
+FROM python:3.12.6
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+ENV UV_COMPILE_BYTECODE=1
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+# Copy the project into the image
+ADD . /app
+
+# Sync the project into a new environment, asserting the lockfile is up to date
+WORKDIR /app
+RUN uv sync --locked
+
+ENV PATH="/app/.venv/bin:$PATH"
+
+CMD ["fastapi", "run", "app/main.py", "--port", "80"]
--- a/README.md
+++ b/README.md
@@ -0,0 +1,39 @@
+# Simple Notification Forwarding Application
+
+This Application is a simple REST-API for forwarding notifications.
+
+## Preperations for Virtual Environment
+
+```bash
+git clone https://git.n-schuler.dev/nicolas/challenge_cloud_accelerator.git
+cd challenge_cloud_accelerator
+uv venv .venv && source .venv/bin/activate
+uv sync
+```
+
+## Usage
+
+```bash
+  fastapi run app/main.py
+```
+
+## Build Docker Image
+
+```bash
+  docker build -t stack:latest .
+```
+
+## Use Docker Image
+```bash
+  docker run -d --name mycontainer -p 80:80 stack:latest
+```
+
+## Testing
+```bash
+  source .venv/bin/activate
+  pytest
+```
+
+## Documentation
+
+The OpenAPI Documentation is available at `0.0.0.0:8000/docs`.
--- a/app/init.py
+++ b/app/init.py
--- a/app/base_types.py
+++ b/app/base_types.py
@@ -3,11 +3,15 @@ from pydantic import BaseModel


 class NotificationType(StrEnum):
+    """Notification Types"""
+
    INFO = "Info"
    WARNING = "Warning"


 class Notification(BaseModel):
-    type: NotificationType
-    name: str
-    description: str
+    """Notification"""
+
+    Type: NotificationType
+    Name: str
+    Description: str
--- a/app/main.py
+++ b/app/main.py
@@ -0,0 +1,37 @@
+from fastapi import FastAPI, HTTPException, BackgroundTasks
+from .base_types import Notification, NotificationType
+import logging
+
+app = FastAPI(
+    title="Cloud Accelerator Coding Challenge",
+    description="Simple Notification App for the Coding Challenge.",
+    version="0.0.1",
+    terms_of_service="TOS",
+    contact={
+        "name": "Nicolas Sebastian Schuler",
+        "url": "https://n-schuler.dev",
+        "email": "mail@n-schuler.dev",
+    },
+    license_info={"name": "MIT", "identifier": "MIT"},
+)
+
+
+def log_notification(ntfy: Notification):
+    """Log Notification."""
+    logging.warning(ntfy)
+
+
+@app.post("/notification", status_code=204)
+async def notification(ntfy: Notification, background_tasks: BackgroundTasks):
+    """Forward Notification
+
+    * Forwards Notification if `Type: Warning`.
+    """
+    match ntfy.Type:
+        case NotificationType.INFO:
+            pass
+        case NotificationType.WARNING:
+            background_tasks.add_task(log_notification, ntfy)
+        case _:
+            # Already catched by Pydantic
+            raise HTTPException(status_code=400, detail="Malformed Request Body")
--- a/app/test_main.py
+++ b/app/test_main.py
@@ -0,0 +1,90 @@
+import pytest
+import logging
+import json
+from httpx import ASGITransport, AsyncClient
+from pydantic import ValidationError
+
+from .main import app
+from .base_types import NotificationType, Notification
+
+LOGGER = logging.getLogger(__name__)
+
+forward_notification_success_req = {
+    "warning": {
+        "Type": "Warning",
+        "Name": "Backup Failure",
+        "Description": "The backup failed due to a database problem",
+    },
+    "info": {
+        "Type": "Info",
+        "Name": "Quota Exceeded",
+        "Description": "Compute Quota exceeded",
+    },
+}
+
+forward_notification_fail_req = {
+    "type unknown": {
+        "Type": "Garbage",
+        "Name": "Quota Exceeded",
+        "Description": "Compute Quota exceeded",
+    },
+    "type lower case": {
+        "Type": "warning",
+        "Name": "Backup Failure",
+        "Description": "The backup failed due to a database problem",
+    },
+    "key lower cases": {
+        "type": "warning",
+        "name": "Backup Failure",
+        "description": "The backup failed due to a database problem",
+    },
+    "type missing": {
+        "Name": "Quota Exceeded",
+        "Description": "Compute Quota exceeded",
+    },
+    "name missing": {
+        "Type": "Info",
+        "Description": "Compute Quota exceeded",
+    },
+    "description missing": {
+        "Type": "Info",
+        "Name": "Quota Exceeded",
+    },
+}
+
+
+@pytest.mark.anyio
+async def test_forward_notification_success(caplog):
+    for description, req in forward_notification_success_req.items():
+        async with AsyncClient(
+            transport=ASGITransport(app=app), base_url="http://test"
+        ) as ac:
+            response = await ac.post("/notification", json=req)
+            assert response.status_code == 204, description
+
+            match req["Type"]:
+                case NotificationType.INFO:
+                    pass
+                case NotificationType.WARNING:
+                    # Check forwarding to logger
+                    try:
+                        res = Notification.model_validate_json(
+                            json_data=json.dumps(req)
+                        )
+                    except ValidationError:
+                        raise Exception(
+                            "Model could not be serialized. Check dummy data"
+                        )
+                    assert str(res) in caplog.text
+
+
+@pytest.mark.anyio
+async def test_forward_notification_failure():
+    for description, req in forward_notification_fail_req.items():
+        async with AsyncClient(
+            transport=ASGITransport(app=app), base_url="http://test"
+        ) as ac:
+            response = await ac.post("/notification", json=req)
+            assert response.status_code >= 400 and response.status_code < 500, (
+                description
+            )
--- a/main.py
+++ b/main.py
@@ -1,9 +0,0 @@
-from fastapi import FastAPI
-from base_types import Notification
-
-app = FastAPI()
-
-
-@app.post("/notification")
-async def notification(ntfy: Notification):
-    print(ntfy)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -7,3 +7,10 @@ requires-python = ">=3.12"
 dependencies = [
    "fastapi[standard]>=0.116.1",
 ]
+
+[tool.uv]
+dev-dependencies = [
+    "httpx>=0.28.1",
+    "pytest>=8.4.1",
+    "trio>=0.30.0",
+]
--- a/uv.lock
+++ b/uv.lock
@@ -24,6 +24,15 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/a1/ee/48ca1a7c89ffec8b6a0c5d02b89c305671d5ffd8d3c94acf8b8c408575bb/anyio-4.9.0-py3-none-any.whl", hash = "sha256:9f76d541cad6e36af7beb62e978876f3b41e3e04f2c1fbf0884604c0a9c4d93c", size = 100916 },
 ]

+[[package]]
+name = "attrs"
+version = "25.3.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/5a/b0/1367933a8532ee6ff8d63537de4f1177af4bff9f3e829baf7331f595bb24/attrs-25.3.0.tar.gz", hash = "sha256:75d7cefc7fb576747b2c81b4442d4d4a1ce0900973527c011d1030fd3bf4af1b", size = 812032 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/77/06/bb80f5f86020c4551da315d78b3ab75e8228f89f0162f2c3a819e407941a/attrs-25.3.0-py3-none-any.whl", hash = "sha256:427318ce031701fea540783410126f03899a97ffc6f61596ad581ac2e40e3bc3", size = 63815 },
+]
+
 [[package]]
 name = "certifi"
 version = "2025.7.14"
@@ -33,6 +42,21 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/4f/52/34c6cf5bb9285074dc3531c437b3919e825d976fde097a7a73f79e726d03/certifi-2025.7.14-py3-none-any.whl", hash = "sha256:6b31f564a415d79ee77df69d757bb49a5bb53bd9f756cbbe24394ffd6fc1f4b2", size = 162722 },
 ]

+[[package]]
+name = "cffi"
+version = "1.17.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "pycparser" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/fc/97/c783634659c2920c3fc70419e3af40972dbaf758daa229a7d6ea6135c90d/cffi-1.17.1.tar.gz", hash = "sha256:1c39c6016c32bc48dd54561950ebd6836e1670f2ae46128f67cf49e789c52824", size = 516621 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/86/c5/28b2d6f799ec0bdecf44dced2ec5ed43e0eb63097b0f58c293583b406582/cffi-1.17.1-cp312-cp312-win32.whl", hash = "sha256:a08d7e755f8ed21095a310a693525137cfe756ce62d066e53f502a83dc550f65", size = 172448 },
+    { url = "https://files.pythonhosted.org/packages/50/b9/db34c4755a7bd1cb2d1603ac3863f22bcecbd1ba29e5ee841a4bc510b294/cffi-1.17.1-cp312-cp312-win_amd64.whl", hash = "sha256:51392eae71afec0d0c8fb1a53b204dbb3bcabcb3c9b807eedf3e1e6ccf2de903", size = 181976 },
+    { url = "https://files.pythonhosted.org/packages/bf/ee/f94057fa6426481d663b88637a9a10e859e492c73d0384514a17d78ee205/cffi-1.17.1-cp313-cp313-win32.whl", hash = "sha256:e03eab0a8677fa80d646b5ddece1cbeaf556c313dcfac435ba11f107ba117b5d", size = 172475 },
+    { url = "https://files.pythonhosted.org/packages/7c/fc/6a8cb64e5f0324877d503c854da15d76c1e50eb722e320b15345c4d0c6de/cffi-1.17.1-cp313-cp313-win_amd64.whl", hash = "sha256:f6a16c31041f09ead72d69f583767292f750d24913dadacf5756b966aacb3f1a", size = 182009 },
+]
+
 [[package]]
 name = "challenge-cloud-accelerator"
 version = "0.1.0"
@@ -41,9 +65,23 @@ dependencies = [
    { name = "fastapi", extra = ["standard"] },
 ]

+[package.dev-dependencies]
+dev = [
+    { name = "httpx" },
+    { name = "pytest" },
+    { name = "trio" },
+]
+
 [package.metadata]
 requires-dist = [{ name = "fastapi", extras = ["standard"], specifier = ">=0.116.1" }]

+[package.metadata.requires-dev]
+dev = [
+    { name = "httpx", specifier = ">=0.28.1" },
+    { name = "pytest", specifier = ">=8.4.1" },
+    { name = "trio", specifier = ">=0.30.0" },
+]
+
 [[package]]
 name = "click"
 version = "8.2.1"
@@ -217,6 +255,15 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442 },
 ]

+[[package]]
+name = "iniconfig"
+version = "2.1.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/f2/97/ebf4da567aa6827c909642694d71c9fcf53e5b504f2d96afea02718862f3/iniconfig-2.1.0.tar.gz", hash = "sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7", size = 4793 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/2c/e1/e6716421ea10d38022b952c159d5161ca1193197fb744506875fbb87ea7b/iniconfig-2.1.0-py3-none-any.whl", hash = "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760", size = 6050 },
+]
+
 [[package]]
 name = "jinja2"
 version = "3.1.6"
@@ -288,6 +335,45 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979 },
 ]

+[[package]]
+name = "outcome"
+version = "1.3.0.post0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "attrs" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/98/df/77698abfac98571e65ffeb0c1fba8ffd692ab8458d617a0eed7d9a8d38f2/outcome-1.3.0.post0.tar.gz", hash = "sha256:9dcf02e65f2971b80047b377468e72a268e15c0af3cf1238e6ff14f7f91143b8", size = 21060 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/55/8b/5ab7257531a5d830fc8000c476e63c935488d74609b50f9384a643ec0a62/outcome-1.3.0.post0-py2.py3-none-any.whl", hash = "sha256:e771c5ce06d1415e356078d3bdd68523f284b4ce5419828922b6871e65eda82b", size = 10692 },
+]
+
+[[package]]
+name = "packaging"
+version = "25.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/a1/d4/1fc4078c65507b51b96ca8f8c3ba19e6a61c8253c72794544580a7b6c24d/packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f", size = 165727 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/20/12/38679034af332785aac8774540895e234f4d07f7545804097de4b666afd8/packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", size = 66469 },
+]
+
+[[package]]
+name = "pluggy"
+version = "1.6.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538 },
+]
+
+[[package]]
+name = "pycparser"
+version = "2.22"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/1d/b2/31537cf4b1ca988837256c910a668b553fceb8f069bedc4b1c826024b52c/pycparser-2.22.tar.gz", hash = "sha256:491c8be9c040f5390f5bf44a5b07752bd07f56edf992381b05c701439eec10f6", size = 172736 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/13/a3/a812df4e2dd5696d1f351d58b8fe16a405b234ad2886a0dab9183fb78109/pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc", size = 117552 },
+]
+
 [[package]]
 name = "pydantic"
 version = "2.11.7"
@@ -359,6 +445,22 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217 },
 ]

+[[package]]
+name = "pytest"
+version = "8.4.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "iniconfig" },
+    { name = "packaging" },
+    { name = "pluggy" },
+    { name = "pygments" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/08/ba/45911d754e8eba3d5a841a5ce61a65a685ff1798421ac054f85aa8747dfb/pytest-8.4.1.tar.gz", hash = "sha256:7c67fd69174877359ed9371ec3af8a3d2b04741818c51e5e99cc1742251fa93c", size = 1517714 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/29/16/c8a903f4c4dffe7a12843191437d7cd8e32751d5de349d45d3fe69544e87/pytest-8.4.1-py3-none-any.whl", hash = "sha256:539c70ba6fcead8e78eebbf1115e8b589e7565830d7d006a8723f19ac8a0afb7", size = 365474 },
+]
+
 [[package]]
 name = "python-dotenv"
 version = "1.1.1"
@@ -507,6 +609,15 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/e9/44/75a9c9421471a6c4805dbf2356f7c181a29c1879239abab1ea2cc8f38b40/sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2", size = 10235 },
 ]

+[[package]]
+name = "sortedcontainers"
+version = "2.4.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/e8/c4/ba2f8066cceb6f23394729afe52f3bf7adec04bf9ed2c820b39e19299111/sortedcontainers-2.4.0.tar.gz", hash = "sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88", size = 30594 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/32/46/9cb0e58b2deb7f82b84065f37f3bffeb12413f947f9388e4cac22c4621ce/sortedcontainers-2.4.0-py2.py3-none-any.whl", hash = "sha256:a163dcaede0f1c021485e957a39245190e74249897e2ae4b2aa38595db237ee0", size = 29575 },
+]
+
 [[package]]
 name = "starlette"
 version = "0.47.1"
@@ -520,6 +631,23 @@ wheels = [
    { url = "https://files.pythonhosted.org/packages/82/95/38ef0cd7fa11eaba6a99b3c4f5ac948d8bc6ff199aabd327a29cc000840c/starlette-0.47.1-py3-none-any.whl", hash = "sha256:5e11c9f5c7c3f24959edbf2dffdc01bba860228acf657129467d8a7468591527", size = 72747 },
 ]

+[[package]]
+name = "trio"
+version = "0.30.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "attrs" },
+    { name = "cffi", marker = "implementation_name != 'pypy' and os_name == 'nt'" },
+    { name = "idna" },
+    { name = "outcome" },
+    { name = "sniffio" },
+    { name = "sortedcontainers" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/01/c1/68d582b4d3a1c1f8118e18042464bb12a7c1b75d64d75111b297687041e3/trio-0.30.0.tar.gz", hash = "sha256:0781c857c0c81f8f51e0089929a26b5bb63d57f927728a5586f7e36171f064df", size = 593776 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/69/8e/3f6dfda475ecd940e786defe6df6c500734e686c9cd0a0f8ef6821e9b2f2/trio-0.30.0-py3-none-any.whl", hash = "sha256:3bf4f06b8decf8d3cf00af85f40a89824669e2d033bb32469d34840edcfc22a5", size = 499194 },
+]
+
 [[package]]
 name = "typer"
 version = "0.16.0"
Author	SHA1	Message	Date
Nicolas Sebastian Schuler	8763e7f741	(fix) add logic to test for message forwarding	2025-07-18 09:58:48 +02:00
nicolas	8d1f6774b2	app/test_main.py aktualisiert (fix) remove unnecessary print statement	2025-07-16 17:48:32 +00:00
Nicolas Sebastian Schuler	eaa96ef6ce	(feat) add Dockerfile	2025-07-16 10:48:46 +02:00
Nicolas Sebastian Schuler	7f1034a22f	(doc,chore) added readme, pin python version	2025-07-16 10:31:57 +02:00
Nicolas Sebastian Schuler	7cbcafbf6e	(fix) test case should through error only in range[400,500)	2025-07-16 10:11:48 +02:00
Nicolas Sebastian Schuler	9644cc7fe9	(feat) change directory structure and add test cases	2025-07-16 10:07:53 +02:00
Nicolas Sebastian Schuler	8b13bdbb6d	(feat) use background tasks forwarding and add missing documentation	2025-07-16 09:48:37 +02:00
@@ -1 +1 @@
 .12
 .12.6