Add backend test coverage support with c8 and CI integration

.dockerignore

@@ -2,3 +2,5 @@ node_modules
 */node_modules
 .env
 .development.env
+coverage
+*/coverage

.github/workflows/backend.yml

@@ -15,9 +15,70 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: extractions/setup-just@v1
-      - name: run tests
-        run: just test
+      # `just test` under c8 (backend/.c8rc.json): same suite, plus the report copied out of the
+      # container to backend/coverage/ for the two steps below.
+      - name: run tests (with coverage)
+        run: just test-coverage
         timeout-minutes: 50
+      - name: coverage summary
+        run: node scripts/coverage-report.mjs markdown backend backend/coverage/coverage-summary.json >> "$GITHUB_STEP_SUMMARY"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-backend
+          path: |
+            backend/coverage/coverage-summary.json
+            backend/coverage/lcov.info
+            backend/coverage/lcov-report
+          if-no-files-found: error
+
+  # Turns the coverage artifact into an SVG badge (scripts/coverage-report.mjs, no dependencies,
+  # no external service) and force-pushes it — plus the raw summary — to the orphan `badges`
+  # branch as a single commit, with the workflow's own GITHUB_TOKEN. README.md embeds it from
+  # https://github.com/rocket-admin/rocketadmin/raw/badges/backend-coverage.svg.
+  coverage-badge:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: coverage-badge
+      cancel-in-progress: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: coverage-backend
+          path: coverage-artifact
+      - name: render badge
+        run: |
+          set -euo pipefail
+          mkdir -p badges
+          node scripts/coverage-report.mjs badge coverage-artifact/coverage-summary.json badges/backend-coverage.svg "backend coverage"
+          cp coverage-artifact/coverage-summary.json badges/backend-coverage-summary.json
+          pct=$(node -e "console.log(require('./badges/backend-coverage-summary.json').total.lines.pct.toFixed(1))")
+          {
+            echo "# Coverage badges"
+            echo
+            echo "Generated by \`.github/workflows/backend.yml\` (job \`coverage-badge\`) for"
+            echo "\`${GITHUB_SHA}\` on $(date -u +%Y-%m-%dT%H:%M:%SZ). Do not edit — every run replaces this branch."
+            echo
+            echo "| Package | Lines |"
+            echo "| --- | --- |"
+            echo "| backend | ${pct}% |"
+          } > badges/README.md
+      - name: publish to the badges branch
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          cd badges
+          git init -b badges
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -q -m "coverage badge for ${GITHUB_SHA}"
+          git push --force "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" badges:badges
   license:
     runs-on: ubuntu-latest
     steps:

AGENTS.md

@@ -44,10 +44,29 @@ The project uses `just` for test orchestration:
 ```bash
 just test               # Run all backend tests with Docker Compose
 just test "path/to/test.ts"  # Run specific test file
+just test-coverage      # Same suite under c8; report copied out to backend/coverage/ (what CI runs)
 ```
 
 This spins up test databases (MySQL, PostgreSQL, MSSQL, Oracle, MongoDB, DynamoDB) via `docker-compose.tst.yml`.
 
+### Backend test coverage
+
+`just test-coverage` runs the same compose stack with `TEST_SCRIPT=test-all-parallel:coverage`, i.e. the
+AVA suite under [c8](https://github.com/bcoe/c8) (V8 native coverage, no instrumented build). `backend/.c8rc.json`
+counts every file under `backend/src/` whether loaded or not (`all: true`) except `main.ts`, `migrations/` and
+`*.spec.ts`; the suite executes `dist/src/**/*.js`, so `exclude-after-remap` is set for the patterns to match the
+source paths the `.js.map` files point back to (`shared-code` is outside `src/` and is not counted). The container
+runs as `appuser`, which is why the `Dockerfile` pre-creates `/app/backend/coverage`. The recipe copies
+`coverage-summary.json`, `lcov.info` and `lcov-report/` (per-file HTML) out of the stopped container to
+`backend/coverage/` (git-ignored) — only those, because `coverage/tmp` holds ~1 GB of raw V8 dumps.
+
+CI (`.github/workflows/backend.yml`): the `test` job runs `just test-coverage`, writes a lines / statements /
+functions / branches table to the job summary (`scripts/coverage-report.mjs markdown`) and uploads
+`coverage-backend` as an artifact; on push to `main` the `coverage-badge` job renders the SVG badge at the top of
+`README.md` (`scripts/coverage-report.mjs badge`) and force-pushes it to the orphan `badges` branch using the
+workflow's own `GITHUB_TOKEN` — no external service or secret. No minimum coverage is enforced; a gate is
+`"check-coverage": true` plus `"lines": <percent>` in `backend/.c8rc.json`.
+
 ### Migrations
 
 ```bash

CLAUDE.md

@@ -44,10 +44,29 @@ The project uses `just` for test orchestration:
 ```bash
 just test               # Run all backend tests with Docker Compose
 just test "path/to/test.ts"  # Run specific test file
+just test-coverage      # Same suite under c8; report copied out to backend/coverage/ (what CI runs)
 ```
 
 This spins up test databases (MySQL, PostgreSQL, MSSQL, Oracle, MongoDB, DynamoDB) via `docker-compose.tst.yml`.
 
+### Backend test coverage
+
+`just test-coverage` runs the same compose stack with `TEST_SCRIPT=test-all-parallel:coverage`, i.e. the
+AVA suite under [c8](https://github.com/bcoe/c8) (V8 native coverage, no instrumented build). `backend/.c8rc.json`
+counts every file under `backend/src/` whether loaded or not (`all: true`) except `main.ts`, `migrations/` and
+`*.spec.ts`; the suite executes `dist/src/**/*.js`, so `exclude-after-remap` is set for the patterns to match the
+source paths the `.js.map` files point back to (`shared-code` is outside `src/` and is not counted). The container
+runs as `appuser`, which is why the `Dockerfile` pre-creates `/app/backend/coverage`. The recipe copies
+`coverage-summary.json`, `lcov.info` and `lcov-report/` (per-file HTML) out of the stopped container to
+`backend/coverage/` (git-ignored) — only those, because `coverage/tmp` holds ~1 GB of raw V8 dumps.
+
+CI (`.github/workflows/backend.yml`): the `test` job runs `just test-coverage`, writes a lines / statements /
+functions / branches table to the job summary (`scripts/coverage-report.mjs markdown`) and uploads
+`coverage-backend` as an artifact; on push to `main` the `coverage-badge` job renders the SVG badge at the top of
+`README.md` (`scripts/coverage-report.mjs badge`) and force-pushes it to the orphan `badges` branch using the
+workflow's own `GITHUB_TOKEN` — no external service or secret. No minimum coverage is enforced; a gate is
+`"check-coverage": true` plus `"lines": <percent>` in `backend/.c8rc.json`.
+
 ### Migrations
 
 ```bash

Dockerfile

@@ -46,6 +46,8 @@ RUN cd backend && ../node_modules/.bin/tsc && pnpm exec nest build
 COPY --from=front_builder /app/frontend/dist/rocketadmin/browser /var/www/html
 COPY frontend/nginx/default.conf /etc/nginx/sites-enabled/default
 RUN mkdir -p /app/backend/node_modules/.cache && chown -R appuser:appuser /app/backend/node_modules/.cache
+# c8 report dir for `just test-coverage` (the test compose runs this image as appuser)
+RUN mkdir -p /app/backend/coverage && chown appuser:appuser /app/backend/coverage
 RUN chown -R appuser:appuser  /var/lib/nginx
 RUN chown -R appuser:appuser  /var/log/nginx
 RUN chown -R appuser:appuser  /run

README.md

@@ -1,5 +1,7 @@
 ## Rocket Admin
 
+[![backend test coverage](https://github.com/rocket-admin/rocketadmin/raw/badges/backend-coverage.svg)](https://github.com/rocket-admin/rocketadmin/actions/workflows/backend.yml)
+
 ![720](https://github.com/rocket-admin/rocketadmin/assets/75169/31f1ac1b-ded0-40b6-984a-e50a3ddc4ee2)
 
 Create admin panel for your service with a few clicks

backend/.c8rc.json

@@ -0,0 +1,9 @@
+{
+	"all": true,
+	"src": ["src"],
+	"include": ["src/**/*.ts"],
+	"exclude": ["src/main.ts", "src/migrations/**", "src/**/*.spec.ts", "src/**/*.d.ts"],
+	"exclude-after-remap": true,
+	"reporter": ["text-summary", "lcov", "json-summary"],
+	"reports-dir": "coverage"
+}

backend/package.json

@@ -18,6 +18,7 @@
 		"test": "node _run-with-timing.mjs ava test/ava-tests/non-saas-tests/* --serial",
 		"test-all": "node _run-with-timing.mjs ava --timeout=5m",
 		"test-all-parallel": "AVA_CONCURRENCY=8 node _run-with-timing.mjs ava --timeout=5m",
+		"test-all-parallel:coverage": "AVA_CONCURRENCY=8 c8 node _run-with-timing.mjs ava --timeout=5m",
 		"test-saas": "node _run-with-timing.mjs ava test/ava-tests/saas-tests/*",
 		"test-fast": "AVA_CONCURRENCY=6 node _run-with-timing.mjs ava --timeout=5m 'test/ava-tests/non-saas-tests/!(*oracle*|*cassandra*|*elasticsearch*).test.ts' 'test/ava-tests/saas-tests/!(*oracle*|*cassandra*|*elasticsearch*).test.ts'",
 		"typeorm": "ts-node -r tsconfig-paths/register ../node_modules/.bin/typeorm",
@@ -113,6 +114,7 @@
 		"@types/supertest": "^7.2.1",
 		"@types/validator": "^13.15.10",
 		"ava": "8.0.1",
+		"c8": "^12.0.0",
 		"knip": "^6.41.0",
 		"nock": "^15.0.1",
 		"redis": "^6.3.0",

docker-compose.tst.yml

@@ -19,7 +19,9 @@ services:
         condition: service_healthy
     # $EXTRA_ARGS is a single ava glob (quoted so the extglob reaches ava
     # intact instead of being expanded by the container's dash shell).
-    command: ["/bin/sh", "-c", "pnpm test-all-parallel \"$EXTRA_ARGS\""]
+    # $TEST_SCRIPT picks the package script: `just test-coverage` sets it to
+    # test-all-parallel:coverage (same suite under c8, report in /app/backend/coverage).
+    command: ["/bin/sh", "-c", "pnpm ${TEST_SCRIPT:-test-all-parallel} \"$EXTRA_ARGS\""]
     develop:
       watch:
         - action: rebuild

justfile

@@ -3,5 +3,25 @@
 # DynamoDB, ClickHouse, Elasticsearch) are excluded so their heavy containers
 # aren't needed. Pass an explicit glob to run a different subset locally, e.g.
 #   just test 'test/ava-tests/non-saas-tests/*mongo*.test.ts'
-test args='test/ava-tests/non-saas-tests/!(*oracle*|*cassandra*|*elasticsearch*|*mssql*|*mongo*|*redis*|*dynamodb*|*clickhouse*).test.ts':
+default_tests := 'test/ava-tests/non-saas-tests/!(*oracle*|*cassandra*|*elasticsearch*|*mssql*|*mongo*|*redis*|*dynamodb*|*clickhouse*).test.ts'
+
+test args=default_tests:
   EXTRA_ARGS="{{args}}" docker compose  -f docker-compose.tst.yml up --abort-on-container-exit --force-recreate --build --attach=backend --no-log-prefix
+
+# Coverage: TEST_SCRIPT switches the container to the package's
+# test-all-parallel:coverage script (same suite under c8, backend/.c8rc.json).
+# The report — coverage-summary.json, lcov.info, lcov-report/ — is copied out of
+# the stopped backend container to backend/coverage/; only those items, because
+# coverage/tmp (raw V8 dumps) runs to ~1 GB. The suite's exit status is kept.
+
+# `just test` under c8; report copied out to backend/coverage/ (what CI runs)
+test-coverage args=default_tests:
+  #!/usr/bin/env bash
+  set -uo pipefail
+  TEST_SCRIPT=test-all-parallel:coverage EXTRA_ARGS="{{args}}" docker compose -f docker-compose.tst.yml up --abort-on-container-exit --force-recreate --build --attach=backend --no-log-prefix
+  status=$?
+  rm -rf backend/coverage && mkdir -p backend/coverage
+  for item in coverage-summary.json lcov.info lcov-report; do
+    docker compose -f docker-compose.tst.yml cp "backend:/app/backend/coverage/$item" "backend/coverage/$item" || status=1
+  done
+  exit "$status"