Add e2e tests to starter templates (#2868)

Author: FranjoMindek

waspc/packages/wasp-config/tsconfig.json

@@ -9,7 +9,6 @@
     "moduleDetection": "force",
     "isolatedModules": true,
 
-    // linting
     "strict": true,
     "noUncheckedIndexedAccess": true,
     "noImplicitOverride": true,

waspc/starters-e2e-tests/.gitignore

@@ -0,0 +1,3 @@
+dist
+test-results
+playwright-report

waspc/starters-e2e-tests/README.md

@@ -0,0 +1,56 @@
+# Wasp starters E2E tests
+
+This project provides automated headless end-to-end testing for Wasp starter templates using Playwright.
+
+## Overview
+
+The test suite automatically (for each starter):
+
+1. Sets up the test environment in a temporary directory
+2. Creates a new Wasp projects from the starter template
+3. Configures the Wasp project for headless E2E testing
+4. Runs the Wasp project in both development and build
+5. Validates the project functionality using Playwright
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+### Run tests with production Wasp CLI
+
+```bash
+npm run test
+```
+
+This uses the `wasp` command.
+
+### Run tests with development Wasp CLI
+
+```bash
+npm run test:dev
+```
+
+This uses the `wasp-cli` command (typically used for development builds).
+
+### Run tests with custom Wasp CLI command
+
+```bash
+npm run build
+npm run start -- --wasp-cli-command custom-command-here
+```
+
+## Project tests structure
+
+```
+├── tests/
+│   ├── health-check.spec.ts             # Basic health check tests run for every starter
+│   └── starter/                         # Starter-specific test files
+```
+
+## License
+
+MIT

waspc/starters-e2e-tests/package-lock.json

@@ -0,0 +1,22 @@
+{
+  "name": "starters-e2e-tests",
+  "version": "1.0.0",
+  "type": "module",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "start": "node ./dist/src/main.js",
+    "test": "npm run build && DEBUG=pw:webserver npm run start -- --wasp-cli-command wasp",
+    "test:dev": "npm run build && DEBUG=pw:webserver npm run start -- --wasp-cli-command wasp-cli"
+  },
+  "dependencies": {
+    "@commander-js/extra-typings": "^14.0.0",
+    "@playwright/test": "1.51.1",
+    "@wasp.sh/wasp-app-runner": "^0.0.7",
+    "commander": "^14.0.0",
+    "zx": "^8.8.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.1"
+  }
+}

waspc/starters-e2e-tests/package.json

@@ -0,0 +1,55 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * 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: "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",
+
+    /* If you want to debug what's happening in the browser during the tests, set this to false. */
+    headless: true,
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+    // {
+    //   name: "firefox",
+    //   use: { ...devices["Desktop Firefox"] },
+    // },
+    // {
+    //   name: "webkit",
+    //   use: { ...devices["Desktop Safari"] },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: `run-wasp-app ${process.env.WASP_RUN_MODE} --path-to-app=${process.env.WASP_APP_PATH} --wasp-cli-cmd=${process.env.WASP_CLI_CMD}`,
+    // Wait for the backend to start
+    url: "http://localhost:3001",
+    reuseExistingServer: false,
+    timeout: 240 * 1000,
+    gracefulShutdown: { signal: "SIGTERM", timeout: 2000 },
+  },
+});

waspc/starters-e2e-tests/playwright.config.ts

@@ -0,0 +1,24 @@
+import { program } from "@commander-js/extra-typings";
+import packageJson from "../package.json" with { type: "json" };
+
+export type WaspCliCommand = string;
+
+interface StartersE2ETestsArgs {
+  waspCliCommand: WaspCliCommand;
+}
+
+export function parseArgs(args: string[]): StartersE2ETestsArgs {
+  const command = program
+    .name("starters-e2e-tests")
+    .description(
+      "Run end-to-end tests for Wasp starter templates (except `ai`)",
+    )
+    .version(packageJson.version)
+    .requiredOption(
+      "--wasp-cli-command <command>",
+      "Path or command name for the Wasp CLI executable to test against",
+    )
+    .parse(args);
+
+  return command.opts();
+}