Playwright E2E in GitHub-Aktionen als obligatorischer Schritt vor der Bereitstellung in Vercel
Problem mit der Standardbereitstellung
Das mit GitHub verbundene Vercel-Projekt stellt jeden Push in main direkt in der Produktion bereit. Tests in GitHub Actions laufen parallel, und wenn sie fehlschlagen, steht den Benutzern bereits die fehlerhafte Version zur Verfügung. Wir brauchen Ordnung: zuerst Tests, dann Bereitstellung und Bereitstellung genau der Assembly, die getestet wurde.
Es gibt zwei Arbeitsschemata.
Schema A. CI erstellt die Anwendung, führt sie lokal aus, führt Playwright aus und sendet bei Erfolg das zusammengestellte Artefakt über die CLI an Vercel.
Schema B. Vercel erstellt eine Vorschaubereitstellung, CI testet sie anhand der URL und bei Erfolg wird dieselbe Bereitstellung in die Produktion hochgestuft.
Schema A ist einfacher zu konfigurieren und hängt nicht von der Verfügbarkeit der Vorschau ab. Circuit B testet die tatsächliche Vercel-Infrastruktur (Middleware, Edge-Funktionen, Vorschau-Umgebungsvariablen). Nachfolgend finden Sie die Vollversion von Schema A und die Unterschiede für B.
Deaktivieren Sie die automatische Bereitstellung von Git
In vercel.json:
{
"git": {
"deploymentEnabled": false
}
}Kann nur für einzelne Zweige deaktiviert werden: "deploymentEnabled": { "main": false }. Dann werden weiterhin automatisch Vorschauen für Pull Requests erstellt.
Playwright-Konfiguration
// playwright.config.ts
import { defineConfig, devices } from "@playwright/test";
const baseURL = process.env.E2E_BASE_URL ?? "http://localhost:3000";
export default defineConfig({
testDir: "./e2e",
fullyParallel: true,
forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0,
reporter: process.env.CI ? [["html", { open: "never" }], ["github"]] : "list",
use: {
baseURL,
trace: "on-first-retry",
extraHTTPHeaders: process.env.VERCEL_AUTOMATION_BYPASS_SECRET
? { "x-vercel-protection-bypass": process.env.VERCEL_AUTOMATION_BYPASS_SECRET }
: undefined,
},
projects: [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }],
webServer: process.env.E2E_BASE_URL
? undefined
: {
command: "npm run start",
url: "http://localhost:3000",
reuseExistingServer: !process.env.CI,
timeout: 120_000,
},
});forbidOnly verhindert, dass ein versehentlich begangener test.only andere Tests überspringt. trace: "on-first-retry" speichert nur Traces für instabile Tests, um aufblähende Artefakte zu vermeiden.
Was zu testen ist
E2E vor der Bereitstellung ist nicht der richtige Ort für eine vollständige Abdeckung. Nehmen Sie Szenarien, die Geld kosten oder die Benutzer kaputt machen:
// e2e/critical.spec.ts
import { test, expect } from "@playwright/test";
test("главная отдаёт контент и навигацию", async ({ page }) => {
await page.goto("/");
await expect(page.getByRole("navigation")).toBeVisible();
await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
});
test("вход с тестовым пользователем", async ({ page }) => {
await page.goto("/login");
await page.getByLabel("Email").fill(process.env.E2E_USER_EMAIL!);
await page.getByLabel("Пароль").fill(process.env.E2E_USER_PASSWORD!);
await page.getByRole("button", { name: "Войти" }).click();
await expect(page).toHaveURL(/\/dashboard/);
});
test("страница статьи открывается при клиентской навигации", async ({ page }) => {
await page.goto("/forum");
await page.locator('a[href*="/forum/"]').first().click();
await expect(page.locator("article")).toBeVisible();
});Der letzte Test fängt eine Klasse von Fehlern ab, die beim direkten Laden der Seite nicht sichtbar sind: Abstürze beim Durchlaufen von <Link>. Ein Testbenutzer darf nur in der Test- oder Vorschaudatenbank vorhanden sein.
Workflow für Diagramm A
# .github/workflows/deploy.yml
name: test-and-deploy
on:
push:
branches: [main]
jobs:
e2e-deploy:
runs-on: ubuntu-latest
env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm i -g vercel@latest
- run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
- run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
- run: npm run build
- run: npx playwright install --with-deps chromium
- run: npx playwright test
env:
E2E_USER_EMAIL: ${{ secrets.E2E_USER_EMAIL }}
E2E_USER_PASSWORD: ${{ secrets.E2E_USER_PASSWORD }}
- uses: actions/upload-artifact@v4
if: failure()
with:
name: playwright-report
path: playwright-report/
retention-days: 7
- run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}vercel pull lädt Projekteinstellungen und Umgebungsvariablen, vercel build sammelt die Ausgabe in .vercel/output und deploy --prebuilt sendet sie ohne erneute Zusammenstellung auf der Vercel-Seite. Der Bereitstellungsschritt wird nur ausgeführt, wenn alle vorherigen Schritte erfolgreich waren.
Hier wird die Anwendung zweimal erstellt: vercel build für die Bereitstellung und npm run build für den lokalen Start. Wenn eine Testassembly in die Produktionsdatenbank geht, ist dies gefährlich – verwenden Sie separate Testumgebungsvariablen für npm run build und next start.
Unterschiede in Schema B
Legen Sie anstelle des lokalen Servers E2E_BASE_URL mit der Adresse der Vorschaubereitstellung fest (vercel deploy --token=... druckt sie auf stdout). Die Vorschau wird normalerweise durch den Bereitstellungsschutz geschlossen. Aktivieren Sie für die Automatisierung „Protection Bypass for Automation“ in den Projekteinstellungen und übergeben Sie das Geheimnis im Header x-vercel-protection-bypass – die obige Konfiguration erledigt dies bereits. Führen Sie nach erfolgreichen Tests vercel promote <url> --token=... aus.
Wie man mit Abstürzen umgeht
- Laden Sie das Artefakt
playwright-reportherunter und öffnen Sienpx playwright show-report. Der Trace zeigt bei jedem Schritt das DOM, das Netzwerk und die Konsole. - Der Test stürzt nur in CI ab: Die häufigste Ursache sind Zeitüberschreitungen beim Kaltstart oder bei unterschiedlichen Zeitzonen. Vergleichen Sie
TZundlocaleinuse. - Instabiler Test wird nicht durch Erhöhen von
retriesbehandelt. Suchen Sie nach einer Wartezeit überwaitForTimeoutund ersetzen Sie diese durch eine Statusprüfung überexpect.
Wenn es unnötig ist
Für eine statische Site ohne Formulare und Autorisierung reicht das Erstellen und Überprüfen von Links. Wenn Tests länger als 10–15 Minuten dauern, teilen Sie sie auf: Ein kurzer Rauchsatz blockiert den Einsatz, ein vollständiger Satz verläuft wie geplant.