Automate running locust in the CI

.github/workflows/api.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Install dependencies
         run: |
           cd src/api
-          pipenv install -d .
+          pipenv install -d
 
   lint-api:
     needs: build-api
@@ -53,6 +53,193 @@ jobs:
       - name: Lint with MyPy
         run: pipenv run mypy qualicharge tests
 
+  bench-api:
+    needs: build-api
+    runs-on: ubuntu-latest
+    services:
+      postgresql:
+        image: timescale/timescaledb-ha:pg14-ts2.14-oss
+        env:
+          POSTGRES_DB: qualicharge-api
+          POSTGRES_USER: qualicharge
+          POSTGRES_PASSWORD: pass
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    permissions:
+      pull-requests: write
+      contents: write
+    defaults:
+      run:
+        working-directory: ./src/api
+    env:
+      PORT: 8000
+      QUALICHARGE_DB_ENGINE: postgresql+psycopg
+      QUALICHARGE_DB_HOST: localhost
+      QUALICHARGE_DB_NAME: qualicharge-api
+      QUALICHARGE_TEST_DB_NAME: test-qualicharge-api
+      QUALICHARGE_OIDC_IS_ENABLED: False
+      QUALICHARGE_ALLOWED_HOSTS: '["http://localhost:8000"]'
+      QUALICHARGE_API_STATIQUE_BULK_CREATE_MAX_SIZE: 1000
+      # This is a fake setting required to run the app
+      QUALICHARGE_OIDC_PROVIDER_BASE_URL: http://localhost:8000/fake
+      QUALICHARGE_OAUTH2_TOKEN_ENCODING_KEY: thisissupersecret
+      QUALICHARGE_OAUTH2_TOKEN_ISSUER: http://test:8000
+      QUALICHARGE_EXECUTION_ENVIRONMENT: ci
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Create postgis extension
+        run: psql "postgresql://qualicharge:pass@localhost:5432/qualicharge-api" -c "create extension postgis;"
+      - name: Install pipenv
+        run: pipx install pipenv
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pipenv"
+          cache-dependency-path: "src/api/Pipfile.lock"
+      - name: Run database migrations
+        run: pipenv run alembic -c qualicharge/alembic.ini upgrade head
+      - name: Create API superuser
+        run: |
+          pipenv run python -m qualicharge create-user \
+            admin \
+            --email [email protected] \
+            --password admin \
+            --is-active \
+            --is-superuser \
+            --is-staff \
+            --force
+      - name: Seed API database
+        run: |
+          pipenv install -d --skip-lock qualicharge-client
+          pipenv run honcho start &
+          sleep 10
+          zcat ../../data/irve-statique.json.gz | \
+            head -n 500 | \
+            pipenv run qcc static bulk --chunk-size 100
+        env:
+          QCC_API_LOGIN_USERNAME: admin
+          QCC_API_LOGIN_PASSWORD: admin
+          QCC_API_ROOT_URL: "http://localhost:8000/api/v1"
+      # API server is still running here
+      - name: Run locust
+        run: |
+          pipenv run locust \
+            -f ../bench/locustfile.py \
+            --headless \
+            -u 30 \
+            -r 1 \
+            --run-time 30s \
+            -H "http://localhost:${PORT}/api/v1" \
+            --csv bench_admin \
+            APIAdminUser
+      - name: Add bench file metadata
+        run: |
+          pipenv run \
+            python ../bench/cli.py \
+              stamp bench_admin_stats.csv $(git rev-parse --short "${GITHUB_SHA}") \
+                > bench_admin_stats_stamped.csv
+      - name: Save bench CSV as artefact
+        uses: actions/upload-artifact@v4
+        with:
+          name: api-admin-benchmark
+          path: ./src/api/bench_admin_stats_stamped.csv
+      - name: Generate markdown table
+        run: |
+          echo -e "### Current benchmark\n\n" >> bench_admin_stats.md && \
+          pipenv run csvlook -I bench_admin_stats_stamped.csv >> bench_admin_stats.md && \
+          echo -e "\n### Comparison with the latest previous benchmark\n\n" >> bench_admin_stats.md && \
+          echo -e "> A lower (negative) value means the current version performs better than the previous one.\n\n" >> bench_admin_stats.md && \
+          pipenv run \
+            python ../bench/cli.py diff ../../data/bench.csv bench_admin_stats_stamped.csv | \
+            pipenv run \
+              csvlook -I >> bench_admin_stats.md
+          cat bench_admin_stats.md
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('node:fs');
+            fs.readFile('/home/runner/work/qualicharge/qualicharge/src/api/bench_admin_stats.md', 'utf8', (err, data) => {
+              if (err) {
+                console.error(err);
+                return;
+              }
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: data
+              });
+            });
+
+  # Only when a PR is merged
+  update-bench-db:
+    if: github.event.pull_request.merged == true
+    needs:
+      - build-api
+      - bench-api
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    defaults:
+      run:
+        working-directory: ./src/api
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Install pipenv
+        run: pipx install pipenv
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pipenv"
+          cache-dependency-path: "src/api/Pipfile.lock"
+      - name: Get latest bench CSV artefact
+        uses: actions/download-artifact@v4
+        with:
+          name: api-admin-benchmark
+      - name: Merge Bench database
+        run: |
+          pipenv run \
+            csvstack \
+              ../../data/bench.csv \
+              bench_admin_stats_stamped.csv \
+                > /tmp/bench.csv
+          cp -f /tmp/bench.csv ../../data/bench.csv
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          add-paths: |
+            data/bench.csv
+          commit-message: |
+            ⚡️(api) update benchmark database
+
+            Update bench database.
+          branch: update-api-bench-db
+          title: "⚡️(api) update benchmark database"
+          body: |
+            ## Purpose
+
+            Each time a PR is merged and a new benchmark has been released, the bench database is updated.
+
+            ## Proposal
+
+            - [x] update `data/bench.csv`
+
+          labels: |
+            API
+            needs review
+
   test-database-migrations:
     needs: build-api
     runs-on: ubuntu-latest

data/bench.csv

@@ -0,0 +1,5 @@
+Type,Name,Request Count,Failure Count,Median Response Time,Average Response Time,Min Response Time,Max Response Time,Average Content Size,Requests/s,Failures/s,50%,66%,75%,80%,90%,95%,98%,99%,99.9%,99.99%,100%,git,timestamp,version
+GET,/auth/whoami,449,0,41.0,190.682040076386,3.025668993359432,1548.9330790005624,160.0,15.502850350234926,0.0,41,250,290,320,530,760,920,1000,1500,1500,1500,e4bea93,2024-11-25 15:53:10.141468+00:00,0.15.0
+GET,/statique/?limit=10,415,0,190.0,309.7470774553037,15.45504099340178,1597.348899987992,13822.0,14.328915134404218,0.0,190,330,510,550,830,1000,1200,1400,1600,1600,1600,e4bea93,2024-11-25 15:53:10.141468+00:00,0.15.0
+GET,/statique/?limit=100,424,0,320.0,451.6924511111904,96.59699301118962,1808.202302985592,129002.0,14.639662691535875,0.0,320,510,590,720,1000,1100,1600,1700,1800,1800,1800,e4bea93,2024-11-25 15:53:10.141468+00:00,0.15.0
+,Aggregated,1288,0,220.0,314.9680686408331,3.025668993359432,1808.202302985592,46975.79037267081,44.47142817617502,0.0,230,320,500,540,810,1000,1200,1500,1800,1800,1800,e4bea93,2024-11-25 15:53:10.141468+00:00,0.15.0

src/api/Dockerfile

@@ -41,8 +41,7 @@ RUN mkdir /app && \
 COPY --chown="${PIPENV_USER_NAME}:${PIPENV_GROUP_NAME}" . /app
 WORKDIR /app
 USER ${PIPENV_USER_NAME}:${PIPENV_GROUP_NAME}
-RUN pipenv install -d && \
-    pipenv install -e .
+RUN pipenv install -d
 
 # -- Run --
 CMD pipenv run honcho start

src/api/Pipfile

@@ -40,6 +40,7 @@ polyfactory = "==2.17.0"
 pytest = "==8.3.3"
 pytest-cov = "==6.0.0"
 pytest-httpx = "==0.34.0"
+qualicharge = {path = ".", editable = true}
 ruff = "==0.7.4"
 types-passlib = "==1.7.7.20240819"
 types-python-jose = "==3.3.4.20240106"