test(dashboard): add Playwright e2e scaffolding with smoke spec
Milestone A of the frontend test plan. Sets up the test rig — config, globalSetup that probes the backend and seeds an admin session into storageState, lightweight fixtures, and a 3-test smoke spec — without yet covering any user journeys (those land in Milestone B). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
47
dashboard/tests/e2e/fixtures/api.ts
Normal file
47
dashboard/tests/e2e/fixtures/api.ts
Normal file
@@ -0,0 +1,47 @@
|
||||
import { request, type APIRequestContext } from '@playwright/test';
|
||||
import { promises as fs } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
const API_BASE = process.env.E2E_API_BASE ?? 'http://127.0.0.1:18080';
|
||||
const STATE_PATH = path.join(__dirname, '..', '.auth', 'admin.json');
|
||||
|
||||
interface StoredState {
|
||||
origins: Array<{
|
||||
origin: string;
|
||||
localStorage: Array<{ name: string; value: string }>;
|
||||
}>;
|
||||
}
|
||||
|
||||
let cachedToken: string | null = null;
|
||||
|
||||
async function readAdminToken(): Promise<string> {
|
||||
if (cachedToken) return cachedToken;
|
||||
const raw = await fs.readFile(STATE_PATH, 'utf8');
|
||||
const state = JSON.parse(raw) as StoredState;
|
||||
for (const origin of state.origins) {
|
||||
const entry = origin.localStorage.find((e) => e.name === 'picloud.admin.token');
|
||||
if (entry) {
|
||||
cachedToken = entry.value;
|
||||
return entry.value;
|
||||
}
|
||||
}
|
||||
throw new Error(`No picloud.admin.token in ${STATE_PATH} — did globalSetup run?`);
|
||||
}
|
||||
|
||||
// Thin wrapper around Playwright's request context that injects the
|
||||
// admin bearer token from the shared storageState. Use this for
|
||||
// setup/teardown shortcuts when the *test itself* is about something
|
||||
// else (e.g., a script-editor test that just needs an app to exist).
|
||||
export async function adminApi(): Promise<APIRequestContext> {
|
||||
const token = await readAdminToken();
|
||||
return request.newContext({
|
||||
baseURL: API_BASE,
|
||||
extraHTTPHeaders: {
|
||||
authorization: `Bearer ${token}`,
|
||||
'content-type': 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
21
dashboard/tests/e2e/fixtures/auth.ts
Normal file
21
dashboard/tests/e2e/fixtures/auth.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import type { Page } from '@playwright/test';
|
||||
import { expect } from '@playwright/test';
|
||||
|
||||
const ADMIN_USERNAME = process.env.E2E_ADMIN_USERNAME ?? 'admin';
|
||||
const ADMIN_PASSWORD = process.env.E2E_ADMIN_PASSWORD ?? 'admin';
|
||||
|
||||
// Drive the login form like a real user. globalSetup already saves a
|
||||
// storageState for the shared admin, so most tests don't need this —
|
||||
// it's reserved for specs that explicitly cover the login UI.
|
||||
export async function loginAsAdmin(page: Page): Promise<void> {
|
||||
await page.goto('/admin/login');
|
||||
await page.getByLabel('Username').fill(ADMIN_USERNAME);
|
||||
await page.getByLabel('Password').fill(ADMIN_PASSWORD);
|
||||
await page.getByRole('button', { name: /sign in/i }).click();
|
||||
await expect(page).toHaveURL(/\/admin\/apps$/);
|
||||
}
|
||||
|
||||
export async function logout(page: Page): Promise<void> {
|
||||
await page.getByRole('button', { name: /logout/i }).click();
|
||||
await expect(page).toHaveURL(/\/admin\/login$/);
|
||||
}
|
||||
48
dashboard/tests/e2e/fixtures/cleanup.ts
Normal file
48
dashboard/tests/e2e/fixtures/cleanup.ts
Normal file
@@ -0,0 +1,48 @@
|
||||
import type { APIRequestContext } from '@playwright/test';
|
||||
import { adminApi } from './api';
|
||||
|
||||
// Resources to delete after a test, in LIFO order. Tests register
|
||||
// their creations and the registry tears everything down in
|
||||
// `cleanupRegistered` — typically called from `test.afterEach`.
|
||||
|
||||
type Cleanup = (api: APIRequestContext) => Promise<void>;
|
||||
|
||||
export class CleanupRegistry {
|
||||
private items: Cleanup[] = [];
|
||||
|
||||
app(slugOrId: string): void {
|
||||
this.items.push(async (api) => {
|
||||
await api.delete(`/api/v1/admin/apps/${encodeURIComponent(slugOrId)}?force=true`);
|
||||
});
|
||||
}
|
||||
|
||||
adminUser(userId: string): void {
|
||||
this.items.push(async (api) => {
|
||||
await api.delete(`/api/v1/admin/admins/${userId}`);
|
||||
});
|
||||
}
|
||||
|
||||
apiKey(keyId: string): void {
|
||||
this.items.push(async (api) => {
|
||||
await api.delete(`/api/v1/admin/api-keys/${keyId}`);
|
||||
});
|
||||
}
|
||||
|
||||
async run(): Promise<void> {
|
||||
if (this.items.length === 0) return;
|
||||
const api = await adminApi();
|
||||
try {
|
||||
for (const item of this.items.reverse()) {
|
||||
try {
|
||||
await item(api);
|
||||
} catch {
|
||||
// Best-effort cleanup — a missing resource (already
|
||||
// deleted by the test) shouldn't fail the suite.
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
await api.dispose();
|
||||
this.items = [];
|
||||
}
|
||||
}
|
||||
}
|
||||
42
dashboard/tests/e2e/fixtures/ids.ts
Normal file
42
dashboard/tests/e2e/fixtures/ids.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
/* eslint-disable no-empty-pattern -- Playwright fixtures require an
|
||||
object-pattern first arg; these fixtures don't depend on any other
|
||||
fixture so the pattern is intentionally empty. */
|
||||
import { test as base } from '@playwright/test';
|
||||
import { randomBytes } from 'node:crypto';
|
||||
|
||||
// Tests share a single backend/Postgres. To avoid collisions we tag
|
||||
// every resource the test creates with a short random suffix plus the
|
||||
// Playwright worker index. This way two workers running the same spec
|
||||
// in parallel never fight over the same slug or username.
|
||||
|
||||
export function shortId(): string {
|
||||
return randomBytes(3).toString('hex');
|
||||
}
|
||||
|
||||
export function uniqueSlug(prefix: string, workerIndex: number): string {
|
||||
const cleaned = prefix
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, '-')
|
||||
.replace(/^-|-$/g, '');
|
||||
return `e2e-${cleaned}-w${workerIndex}-${shortId()}`;
|
||||
}
|
||||
|
||||
export function uniqueUsername(prefix: string, workerIndex: number): string {
|
||||
// Username regex is [a-z0-9._-]{2,32}. Mirror the slug format.
|
||||
const cleaned = prefix.toLowerCase().replace(/[^a-z0-9]+/g, '');
|
||||
return `e2e${cleaned}w${workerIndex}${shortId()}`.slice(0, 32);
|
||||
}
|
||||
|
||||
export const test = base.extend<{
|
||||
uniqueSlug: (prefix: string) => string;
|
||||
uniqueUsername: (prefix: string) => string;
|
||||
}>({
|
||||
uniqueSlug: async ({}, use, testInfo) => {
|
||||
await use((prefix) => uniqueSlug(prefix, testInfo.workerIndex));
|
||||
},
|
||||
uniqueUsername: async ({}, use, testInfo) => {
|
||||
await use((prefix) => uniqueUsername(prefix, testInfo.workerIndex));
|
||||
}
|
||||
});
|
||||
|
||||
export { expect } from '@playwright/test';
|
||||
Reference in New Issue
Block a user