feat/docker/add-health-check-endpoint

Author: codespearhead

.github/workflows/ci.yml

@@ -83,3 +83,15 @@ jobs:
         run: |
           source .venv/bin/activate
           poetry run python tasks/format.py --dry-run
+
+      - name: Start Docker Compose
+        run: |
+          docker compose up -d
+
+      - name: Install test dependencies
+        run: |
+          docker exec flask_api poetry install --with test
+
+      - name: Run tests in container
+        run: |
+          docker exec flask_api poetry run pytest -rfsxE --capture=no --log-cli-level=DEBUG --maxfail=1 ./test

docker-compose.yml

@@ -10,3 +10,9 @@ services:
     command: python ./src/server.py
     volumes:
       - ./:/app:rw
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:5000/health"]
+      interval: 5s
+      timeout: 3s
+      retries: 60
+      start_period: 5s

src/server.py

@@ -7,6 +7,11 @@
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
 
+@app.route("/health", methods=["GET"])
+def health():
+    return jsonify({"status": "ok"}), 200
+
+
 @app.route("/doc_to_pdf", methods=["GET", "POST"])
 def upload_file():
     if request.method == "GET":