dockerized backend, tests and lint checks

README.md

@@ -0,0 +1,16 @@
+# Application that allows authenticated users to upload files of any size (hardware resources permitting)
+
+## BE
+- Implement an API endpoint that allows users to upload files of any size (hardware resources permitting).
+- Efficiently handle large file uploads, make sure to prevent memory issues.
+- Implement a way to authenticate users before allowing them to upload files.
+  (For simplicity, you can hard-code a set of valid usernames and passwords.)
+- Dockerize the application.
+- Write test cases covering critical backend functionalities. Focus on testing file upload endpoint.
+
+## FE
+TODO
+
+
+## Notes
+- Used a single docker image for both api and test containers

backend/.dockerignore

@@ -0,0 +1,22 @@
+# Exclude Python bytecode files
+*.pyc
+
+# Exclude system-specific files
+__pycache__
+
+# Exclude development files
+.DS_Store
+.idea/
+*.log
+*.bak
+
+# Exclude version control files
+.git
+.gitignore
+
+.venv
+venv
+
+# Exclude pytest cache directories
+__pycache__/
+.pytest_cache/

backend/Dockerfile

@@ -0,0 +1,33 @@
+FROM python:3.12-slim
+
+ENV PYTHONFAULTHANDLER=1 \
+  PYTHONUNBUFFERED=1 \
+  PYTHONHASHSEED=random \
+  PIP_NO_CACHE_DIR=off \
+  PIP_DISABLE_PIP_VERSION_CHECK=on \
+  PIP_DEFAULT_TIMEOUT=100
+
+RUN groupadd user && useradd --create-home --home-dir /home/user -g user user
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /home/user/app/
+ENV PYTHONPATH=/home/user/app/
+
+COPY pyproject.toml poetry.lock /home/user/app/
+RUN pip install 'uvicorn[standard]'
+RUN pip install --no-cache-dir poetry
+
+RUN poetry config virtualenvs.create false
+RUN poetry install --with dev --no-root --no-interaction --no-ansi
+
+
+RUN mkdir -p /home/user/app/uploaded_files/ && chown -R user:user /home/user/app/uploaded_files/
+
+USER user
+
+COPY --chown=user:user . /home/user/app/
+
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

backend/README.md

@@ -18,12 +18,22 @@ poetry install --with dev
 ```
 
 ### Testing
-#### Run lint checks
+#### Locally
+Run lint checks
 ```commandline
 poetry run task lint
 ```
-
-#### Run tests locally
+Run tests
 ```commandline
 poetry run task test
 ```
+
+#### Docker
+Run tests in docker using poetry task 
+```commandline
+poetry run task compose-test
+```
+Or using plain `docker-compose`
+```commandline
+docker compose run --rm test
+```

backend/app/main.py

@@ -1,8 +1,6 @@
-from fastapi import FastAPI, Response
-
-app = FastAPI()
+from fastapi import FastAPI
 
+from app.routers import router
 
-@app.get("/")
-def index() -> Response:
-    return Response(content='{"message": "OK"}', media_type="application/json")
+app = FastAPI()
+app.include_router(router)

backend/app/routers/__init__.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+
+from app.routers.health import router as health_router
+from app.routers.index import router as index_router
+
+__all__ = ["router"]
+
+router = APIRouter(prefix="/api")
+
+router.include_router(health_router)
+router.include_router(index_router)

backend/app/routers/health.py

@@ -0,0 +1,10 @@
+from http import HTTPStatus
+
+from fastapi import APIRouter, Response
+
+router = APIRouter(prefix="/health")
+
+
+@router.get("", name="health", description="Health check")
+async def health() -> Response:
+    return Response(status_code=HTTPStatus.OK, content="OK")

backend/app/routers/index.py

@@ -0,0 +1,8 @@
+from fastapi import APIRouter, Response
+
+router = APIRouter()
+
+
+@router.get("/", name="index", description="Index page")
+def index() -> Response:
+    return Response(content="index page")

backend/pyproject.toml

@@ -9,6 +9,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.12"
 fastapi = "^0.115.2"
+uvloop = "^0.21.0"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -24,6 +25,12 @@ lint = "task lint_black && task lint_mypy"
 lint_black = "black --check app tests"
 lint_mypy = "mypy app tests"
 test = "pytest"
+format = "black app tests"
+ci = "task lint && task test"
+
+compose-clean = "docker compose down --volumes --remove-orphans"
+compose-up = "docker compose up"
+compose-test = "docker compose run --rm test"
 
 
 [tool.mypy]

backend/tests/test_api/conftest.py

@@ -0,0 +1,21 @@
+import pytest
+from fastapi import FastAPI, APIRouter
+from starlette.testclient import TestClient
+
+from app.main import app as api_app
+from app.routers import router as api_router
+
+
+@pytest.fixture
+def app() -> FastAPI:
+    return api_app
+
+
+@pytest.fixture
+def router() -> APIRouter:
+    return api_router
+
+
+@pytest.fixture
+def client(app: FastAPI) -> TestClient:
+    return TestClient(app)

backend/tests/test_api/test_health.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+from starlette.testclient import TestClient
+from http import HTTPStatus
+
+
+def test_health(client: TestClient, router: APIRouter) -> None:
+    url = router.url_path_for("health")
+    response = client.get(url)
+
+    assert response.status_code == HTTPStatus.OK
+    assert response.text == "OK"

backend/tests/test_api/test_index.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter
+from starlette.testclient import TestClient
+from http import HTTPStatus
+
+
+def test_index(client: TestClient, router: APIRouter) -> None:
+    url = router.url_path_for("index")
+    response = client.get(url)
+
+    assert response.status_code == HTTPStatus.OK
+    assert response.text == "index page"

docker-compose.yaml

@@ -0,0 +1,20 @@
+
+services:
+  api: &api
+    container_name: virtuo-api
+    build:
+      context: ./backend
+    ports:
+      - "8000:8000"
+    volumes:
+      - uploaded-files-data:/home/user/app/uploaded_files
+
+  test:
+      <<: *api
+      container_name: virtuo-api-test
+      profiles: ["test"]
+      command: poetry run task ci
+
+
+volumes:
+  uploaded-files-data: