test: add integration tests

Author: felixschndr

.github/workflows/test.yml

@@ -48,8 +48,14 @@ jobs:
         run: poetry install --no-interaction
 
       - name: Run tests
-        run: |
-          poetry run pytest
+        run: poetry run pytest
+
+      - name: Run integration tests
+        env:
+          BRING_USERNAME: ${{ secrets.BRING_TESTING_USERNAME}}
+          BRING_PASSWORD: ${{ secrets.BRING_TESTING_PASSWORD}}
+          BRING_LIST_NAME: Zuhause
+        run: poetry run pytest tests/test_integration.py
 
   validate-docker-image:
     runs-on: ubuntu-latest
@@ -63,34 +69,35 @@ jobs:
       - name: Run Docker container and validate successful startup
         run: |
           readonly TIMEOUT=20
-          
+
           CONTAINER_ID=$(docker run \
             -e BRING_USERNAME=${{ secrets.BRING_TESTING_USERNAME}} \
             -e BRING_PASSWORD=${{ secrets.BRING_TESTING_PASSWORD}} \
             -e BRING_LIST_NAME=Zuhause \
             -d mealie-bring-api:test)
-      
+
           echo "Started container: ${CONTAINER_ID}"
           echo "Waiting up to ${TIMEOUT} seconds for expected output ..."
-      
+
           FOUND=0
           for i in $(seq 1 ${TIMEOUT}); do
             LOGS=$(docker logs "${CONTAINER_ID}" 2>&1 || true)
-      
+
             if echo "${LOGS}" | grep -q "Listening on 0.0.0.0:8742"; then
               echo "✅ Expected output found!"
               FOUND=1
               break
             fi
-      
+
             sleep 1
           done
-      
+
           docker stop "${CONTAINER_ID}" >/dev/null
-      
+          
+          echo "---- Container logs ----"
+          echo "${LOGS}"
+
           if [ "${FOUND}" -ne 1 ]; then
             echo "❌ Expected output not found!"
             exit 1
           fi
-          echo "---- Container logs ----"
-          echo "${LOGS}"

tests/conftest.py

@@ -51,7 +51,9 @@ def ingredient_raw_base_data(food_name_singular: str, food_name_plural: str, uni
 @pytest.fixture
 def example_request(ingredient_raw_base_data: dict, unit: dict) -> dict:
     return {
+        "action": {"action_type": "post"},
         "content": {
+            "name": "My testing recipe",
             "recipe_servings": 5.0,
             "recipe_yield_quantity": 0.0,
             "recipe_yield": None,
@@ -65,7 +67,7 @@ def example_request(ingredient_raw_base_data: dict, unit: dict) -> dict:
                         "plural_name": None,
                     },
                     "note": "",
-                    "display": "1 Agavendicksaft",
+                    "display": "1 Apple",
                 },
                 {
                     "quantity": 5.0,

tests/test_integration.py

@@ -0,0 +1,69 @@
+import asyncio
+import os
+import subprocess  # nosec B404
+import time
+
+import pytest
+import requests
+from source.bring_handler import BringHandler
+
+
+@pytest.mark.skipif(
+    not os.getenv("BRING_USERNAME") or not os.getenv("BRING_PASSWORD") or not os.getenv("BRING_LIST_NAME"),
+    reason="The necessary environment variables are not set.",
+)
+def test_example_request_against_server(example_request):
+    server_process = subprocess.Popen(  # nosec B603, B607
+        ["python", "-m", "source.mealie_bring_api"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        text=True,
+        env=os.environ.copy(),
+    )
+
+    timeout_seconds = 10
+    start = time.time()
+    response = None
+    while time.time() - start < timeout_seconds:
+        try:
+            response = requests.post("http://localhost:8742/", json=example_request, timeout=5)
+            break
+        except requests.exceptions.ConnectionError:
+            print("Waiting for server to start...")
+            time.sleep(1)
+
+    assert response is not None, f"Server did not respond within {timeout_seconds}s"
+    response.raise_for_status()
+    assert response.status_code == 200
+    assert response.text == "OK"
+
+    server_process.terminate()
+    stdout, _ = server_process.communicate(timeout=10)
+
+    for message_to_find in [
+        "Listening on 0.0.0.0:8742",
+        "Adding ingredients to Bring:",
+        "Received SIGTERM. Exiting now...",
+    ]:
+        assert message_to_find in stdout, f"Expected message {message_to_find} not found in server output"
+    for message_not_to_find in ["[WARNING]", "[ERROR]", "[FATAL]"]:
+        assert message_not_to_find not in stdout, f"Unexpected log level {message_not_to_find} found in server output"
+
+    clean_bring_list()
+
+
+def clean_bring_list():
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+
+    bring_handler = BringHandler(loop)
+
+    for item in loop.run_until_complete(bring_handler.bring.get_list(bring_handler.list_uuid)).items.purchase:
+        loop.run_until_complete(
+            bring_handler.bring.remove_item(
+                list_uuid=bring_handler.list_uuid, item_name="placeholder", item_uuid=item.uuid
+            )
+        )
+
+    loop.run_until_complete(bring_handler.logout())
+    loop.close()