test: support server-side unit testing (#2485)

Author: michaelhthomas

.github/workflows/ci.yml

@@ -127,6 +127,51 @@ jobs:
       - name: Build
         run: pnpm build
 
+  unit-test:
+    name: Unit Tests
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-24.04
+    container: node:22.22.0-alpine3.22@sha256:0c49915657c1c77c64c8af4d91d2f13fe96853bbd957993ed00dd592cbecc284
+    permissions:
+      checks: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
+        with:
+          persist-credentials: false
+
+      - name: Pnpm Setup
+        uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
+
+      - name: Get pnpm store directory
+        shell: sh
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        env:
+          CI: true
+        run: pnpm install
+
+      - name: Run tests
+        env:
+          CI: true
+        run: pnpm test
+
+      - name: Publish test report
+        uses: mikepenz/action-junit-report@74626db7353a25a20a72816467ebf035f674c5f8 # v6.2.0
+        if: success() || failure() # always run even if the previous step fails
+        with:
+          report_paths: 'report.xml'
+
   build:
     name: Build (per-arch, native runners)
     if: github.ref == 'refs/heads/develop'

.gitignore

@@ -5,6 +5,7 @@
 
 # testing
 /coverage
+lcov.info
 
 # next.js
 /.next/

.vscode/extensions.json

@@ -16,6 +16,7 @@
 
     "stylelint.vscode-stylelint",
 
-    "bradlc.vscode-tailwindcss"
+    "bradlc.vscode-tailwindcss",
+    "firsttris.vscode-jest-runner"
   ]
 }

.vscode/settings.json

@@ -23,5 +23,12 @@
   "i18n-ally.localesPaths": [
     "src/i18n/locale"
   ],
-  "yaml.format.singleQuote": true
+  "yaml.format.singleQuote": true,
+  "jestrunner.enableTestExplorer": true,
+  "jestrunner.defaultTestPatterns": [
+    "server/**/*.{test,spec}.?(c|m)[jt]s?(x)",
+  ],
+  "jestrunner.nodeTestCommand": "pnpm test",
+  "jestrunner.changeDirectoryToWorkspaceRoot": true,
+  "jestrunner.projectPath": "."
 }

package.json

@@ -12,6 +12,7 @@
     "build": "pnpm build:next && pnpm build:server",
     "lint": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --cache",
     "lintfix": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --fix",
+    "test": "node server/test/index.mts",
     "start": "NODE_ENV=production node dist/index.js",
     "i18n:extract": "ts-node --project server/tsconfig.json src/i18n/extractMessages.ts",
     "migration:generate": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:generate -d server/datasource.ts",
@@ -137,6 +138,7 @@
     "@types/react-transition-group": "4.4.12",
     "@types/secure-random-password": "0.2.1",
     "@types/semver": "7.7.1",
+    "@types/supertest": "^6.0.3",
     "@types/swagger-ui-express": "4.1.8",
     "@types/validator": "^13.15.10",
     "@types/web-push": "3.6.4",
@@ -147,6 +149,7 @@
     "@typescript-eslint/parser": "7.18.0",
     "autoprefixer": "^10.4.23",
     "baseline-browser-mapping": "^2.8.32",
+    "commander": "^14.0.3",
     "commitizen": "4.3.1",
     "copyfiles": "2.4.1",
     "cy-mobile-commands": "0.3.0",
@@ -168,6 +171,7 @@
     "prettier": "3.8.1",
     "prettier-plugin-organize-imports": "4.3.0",
     "prettier-plugin-tailwindcss": "0.6.14",
+    "supertest": "^7.2.2",
     "tailwindcss": "3.4.19",
     "ts-node": "10.9.2",
     "tsc-alias": "1.8.16",