Merge pull request #19 from davidsilva/feature/load-testing

Try running k6 load tests on the backend

Author: davidsilva

.github/workflows/ci.yml

@@ -188,3 +188,22 @@ jobs:
       - name: Update ECS service for frontend
         run: |
           aws ecs update-service --cluster ${{ secrets.ECS_CLUSTER_NAME }} --service ${{ secrets.FRONTEND_SERVICE_NAME }} --force-new-deployment
+
+      - name: Wait for ECS backend service update
+        run: |
+          aws ecs wait services-stable --cluster ${{ secrets.ECS_CLUSTER_NAME }} --services ${{ secrets.BACKEND_SERVICE_NAME }}
+
+  load-test:
+    runs-on: ubuntu-latest
+    needs: deploy
+
+    steps:
+        - name: Checkout code
+          uses: actions/checkout@v2
+
+        - name: Run load tests with k6
+          uses: k6io/action@v0.1
+          with:
+              filename: ./backend/load-test.js
+          env:
+            BASE_URL: https://api.dev.interviewprep.onyxdevtutorials.com

backend/load-test.js

@@ -0,0 +1,27 @@
+import http from 'k6/http';
+import { check, sleep } from 'k6';
+
+// Possible test types include smoke, stress, spike, soak and load.
+// Smoke: verify system can habdle a minimal load w/o issues.
+// Stress: determine breaking point by increading number of VUs until the API starts returning errors or response times degrade significantly.
+// Spike: test how the system handles sudden spikes in load. A sudden increase in the number of VUs to simulate a traffic spike, followed by a return to normal load.
+// Soak (endurance): test the system's stability and performance over an extended period. Running a constant load for several hours or days to identify memory leaks or performance degradation over time.
+// Load: test the system under expected peak load conditions. Running a constant load for a period of time to verify that the system can handle the expected number of users.
+export let options = {
+  stages: [
+    { duration: '1m', target: 10 }, // Ramp-up to 10 users over 1 minute
+    { duration: '3m', target: 10 }, // Stay at 10 users for 3 minutes
+    { duration: '1m', target: 0 },  // Ramp-down to 0 users over 1 minute
+  ],
+};
+
+const BASE_URL = __ENV.BASE_URL || 'https://localhost:3000';
+
+export default function () {
+  let res = http.get(`${BASE_URL}/api/v0/users`);
+  check(res, {
+    'status was 200': (r) => r.status == 200,
+    'response time was < 500ms': (r) => r.timings.duration < 500,
+});
+  sleep(1);
+}

backend/package.json

@@ -13,7 +13,8 @@
     "test:clearCache": "jest --clearCache",
     "test:users": "jest --config ./jest.config.ts --testPathPattern=users.integration.test.ts",
     "test:products": "jest --config ./jest.config.ts --testPathPattern=products.integration.test.ts",
-    "test:unit": "jest --config ./jest.config.ts --testPathPattern=unit"
+    "test:unit": "jest --config ./jest.config.ts --testPathPattern=unit",
+    "load-test": "k6 run load-test.js"
   },
   "_moduleAliases": {},
   "keywords": [],