ask-the-documents: Add CI testing

.github/workflows/ci-examples-test.yaml

@@ -19,6 +19,7 @@ jobs:
           - waspello
           - waspleau
           - websockets-realtime-voting
+          - ask-the-documents
 
     steps:
       - uses: "actions/checkout@v5"

examples/ask-the-documents/e2e-tests/playwright.config.ts

@@ -0,0 +1,58 @@
+import { defineConfig, devices } from "@playwright/test";
+
+const WASP_RUN_MODE = process.env.WASP_RUN_MODE ?? "dev";
+const WASP_CLI_CMD = process.env.WASP_CLI_CMD ?? "wasp-cli";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./tests",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: process.env.CI ? "dot" : "list",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: "http://localhost:3000",
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+    /* Test against mobile viewports. */
+    {
+      name: "Mobile Chrome",
+      use: { ...devices["Pixel 5"] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: `run-wasp-app ${WASP_RUN_MODE} --path-to-app=../ --wasp-cli-cmd=${WASP_CLI_CMD} --db-image pgvector/pgvector:pg17`,
+
+    // Wait for the backend to start
+    url: "http://localhost:3001",
+    reuseExistingServer: !process.env.CI,
+    timeout: 180 * 1000,
+    gracefulShutdown: { signal: "SIGTERM", timeout: 500 },
+  },
+});

examples/ask-the-documents/e2e-tests/tests/simple.spec.ts

@@ -0,0 +1,11 @@
+import { expect, test } from "@playwright/test";
+
+test.describe("loads successfully", () => {
+  test.describe.configure({ mode: "serial" });
+
+  test("shows the search bar", async ({ page }) => {
+    await page.goto("/");
+    await page.waitForSelector("input[type='search']");
+    await expect(page.locator("input[type='search']")).toBeVisible();
+  });
+});

examples/ask-the-documents/package.json

@@ -3,7 +3,8 @@
   "type": "module",
   "scripts": {
     "env:pull": "npx dotenv-vault@latest pull development .env.server",
-    "env:push": "npx dotenv-vault@latest push development .env.server"
+    "env:push": "npx dotenv-vault@latest push development .env.server",
+    "test": "DEBUG=pw:webserver playwright test --config e2e-tests/"
   },
   "dependencies": {
     "@heroui/react": "2.7.5",
@@ -22,7 +23,9 @@
     "wasp": "file:.wasp/out/sdk/wasp"
   },
   "devDependencies": {
+    "@playwright/test": "1.51.1",
     "@types/react": "^18.0.37",
+    "@wasp.sh/wasp-app-runner": "^0.0.9",
     "prisma": "5.19.1",
     "typescript": "5.8.2",
     "vite": "^7.0.6"

waspc/run

@@ -49,6 +49,7 @@ function run_examples_e2e_tests() {
     "examples/waspello"
     "examples/waspleau"
     "examples/websockets-realtime-voting"
+    "examples/ask-the-documents"
   )
 
   for path in "${paths[@]}"; do