Merge pull request #55 from Adedayo-Data/test/smoke-compose-script

test(backend): add E2E smoke script for API flows (#50)

Author: greatest0fallt1me

.github/workflows/nightly-smoke.yml

@@ -0,0 +1,35 @@
+name: Nightly Smoke Test
+
+on:
+  schedule:
+    # Runs at 00:00 UTC every day
+    - cron: '0 0 * * *'
+  workflow_dispatch: # Allows manual triggering
+
+jobs:
+  smoke-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Start services (Docker Compose)
+        run: docker-compose up -d
+
+      - name: Run Smoke Test
+        run: ./scripts/smoke.sh http://localhost:3000
+
+      - name: Stop services
+        if: always()
+        run: docker-compose down

README.md

@@ -122,3 +122,10 @@ streampay-backend/
 ## License
 
 MIT
+
+## Smoke Testing
+To run the E2E smoke tests against a local Docker stack:
+1. `docker-compose up -d`
+2. `./scripts/smoke.sh http://localhost:3000`
+
+**Prerequisites:** `curl` must be installed.

scripts/smoke.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+set -e
+
+# Configuration
+API_URL=${1:-"http://localhost:3000"}
+MAX_RETRIES=30
+RETRY_INTERVAL=2
+
+echo "Starting StreamPay Smoke Test against $API_URL..."
+
+# 1. Wait for Health Check
+echo "Waiting for API to be healthy..."
+count=0
+until $(curl -sf "$API_URL/health" | grep -q "ok"); do
+    if [ $count -eq $MAX_RETRIES ]; then
+      echo "Error: API failed to become healthy in time."
+      exit 1
+    fi
+    printf '.'
+    sleep $RETRY_INTERVAL
+    ((count++))
+done
+echo -e "\n API is healthy!"
+
+# 2. Test: List Streams (Happy Path)
+echo "Testing: List Streams..."
+LIST_RESPONSE=$(curl -s -o /dev/null -w "%{http_code}" "$API_URL/api/v1/streams")
+if [ "$LIST_RESPONSE" -ne 200 ]; then
+    echo "Error: List Streams failed with status $LIST_RESPONSE"
+    exit 1
+fi
+echo "List Streams success (200 OK)"
+
+# 3. Test: Create Stream (Happy Path)
+echo "Testing: Create Stream..."
+# Note: Using dummy data - adjust keys based on your schema
+CREATE_RESPONSE=$(curl -s -o /dev/null -w "%{http_code}" -X POST "$API_URL/api/v1/streams" \
+     -H "Content-Type: application/json" \
+     -d '{"sender": "test_user", "receiver": "dest_user", "amount": "100", "asset": "XLM"}')
+
+if [ "$CREATE_RESPONSE" -ne 201 ] && [ "$CREATE_RESPONSE" -ne 200 ]; then
+    echo "Error: Create Stream failed with status $CREATE_RESPONSE"
+    exit 1
+fi
+echo "Create Stream success ($CREATE_RESPONSE)"
+
+echo "Smoke Test Passed Successfully!"
+exit 0