Add a proper smoke test for all platforms

Author: pimterry

.github/workflows/ci.yml

@@ -81,6 +81,19 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           USE_SYSTEM_FPM: ${{ matrix.platform == 'linux' && matrix.arch == 'arm64' }}
 
+      - name: Run smoke tests
+        run: |
+          # We manually start ADB, so the tests don't (because if they do, they fail
+          # to exit, due to the hanging process)
+          "$ANDROID_HOME/platform-tools/adb" start-server 2>/dev/null || true
+
+          if [ "$RUNNER_OS" == "Linux" ]; then
+            xvfb-run --auto-servernum npm test
+          else
+            npm test
+          fi
+        shell: bash
+
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.platform }}-${{ matrix.arch }}-distributables

.gitignore

@@ -4,3 +4,4 @@ build/
 dist/
 httptoolkit-server/
 appveyor-tools/
+.playwright/

package-lock.json

@@ -17,7 +17,8 @@
     "build:dir-only": "npm run server:setup && electron-builder --dir",
     "start": "npm run server:setup && npm run start:app",
     "start:dev": "tsx ./skip-server.ts && cross-env HTK_DEV=true APP_URL='http://localhost:8080' npm run start:app",
-    "start:app": "tsc-watch --onSuccess \"electron .\""
+    "start:app": "tsc-watch --onSuccess \"electron .\"",
+    "test": "npm run server:setup && npm run build:src && playwright test"
   },
   "keywords": [],
   "author": "Tim Perry",
@@ -141,6 +142,7 @@
     "yargs": "^15.1.0"
   },
   "devDependencies": {
+    "@playwright/test": "^1.56.1",
     "@types/lodash": "^4.14.149",
     "@types/node-fetch": "^2.1.4",
     "@types/semver": "^7.3.4",

package.json

@@ -0,0 +1,10 @@
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+    testDir: './test',
+    timeout: 20000,
+    workers: 1,
+    retries: 0,
+    reporter: 'list',
+    outputDir: '.playwright'
+});

playwright.config.ts

@@ -0,0 +1,46 @@
+import { test, expect, _electron as electron } from '@playwright/test';
+import * as path from 'path';
+
+async function launchApp() {
+    const app = await electron.launch({
+        cwd: path.join(import.meta.dirname, '..'),
+        args: [
+            '.',
+            // On Linux ARM64 CI, sandboxing doesn't work, so we have to skip it:
+            ...(process.env.CI && process.platform === 'linux' && process.arch === 'arm64' ?
+                [
+                '--no-sandbox',
+                '--disable-setuid-sandbox'
+                ] : []
+            )
+        ],
+        timeout: 10000,
+        env: {
+            ...process.env,
+            // Disable auto-update during tests
+            'HTTPTOOLKIT_SERVER_DISABLE_AUTOUPDATE': '1'
+        }
+    });
+
+    app.process().stdout?.on('data', (data) => {
+        console.log('[stdout]', data.toString().trim());
+    });
+    app.process().stderr?.on('data', (data) => {
+        console.error('[stderr]', data.toString().trim());
+    });
+
+    return app;
+}
+
+test('app launches and loads UI from server', async () => {
+    const electronApp = await launchApp();
+    const window = await electronApp.firstWindow();
+
+    // Has the UI loaded & initialized (connected to the server) successfully?
+    await expect(window.locator('h1:has-text("Intercept HTTP")')).toBeVisible({ timeout: 15000 });
+
+    // Has the preload injected the desktop APIs successfully?
+    await expect(window.evaluate(() => typeof (window as any).desktopApi !== 'undefined')).resolves.toBe(true);
+
+    await electronApp.close();
+});