Files
SnapOtter/tests/e2e/rbac.spec.ts
T
SnapOtterandGitHub 44f5aea326 fix(ci): repair the chronically-failing nightly workflow (#624)
The scheduled Nightly had been red for over a week across nearly every job. This
root-causes and fixes each one. All were pre-existing: missing CI provisioning,
specs that drifted as the app grew, a job too heavy for its timeout, and a fuzz
that was never configured for file-upload endpoints. None came from the recent
security merge.

- Coverage + Docker Container E2E: install tesseract and its language packs so
  the built-in Fast OCR tests stop throwing spawn ENOENT; gate two repo-file and
  release-workflow tests that cannot run inside the slimmed container image.
- E2E (Full, Serial, Cross-Browser, Device Matrix): refresh specs that drifted
  behind the app (tool renames, the now admin-only Tools tab, dropped About copy,
  locator collisions scoped to the right region). One real product fix rode
  along: /config/auth was refetched six times per tool-page load, so cache it
  behind a single shared fetch, dropping the tool page from 13 to 8 API calls.
- Extended Matrix + Fuzz: shard the integration suite four ways so the full
  format x tool matrix plus property fuzz fits its budget instead of overrunning
  the 90-minute ceiling every night.
- Schemathesis: exclude the tools with bespoke handlers that process
  synchronously in-request (they hang the fuzz on adversarial input) and suppress
  Hypothesis's data-generation health checks, which fire because file-upload
  endpoints reject the fuzzer's random bytes. not_a_server_error still runs on
  every generated case (5000+ per run).
- Stabilize two long-tail flakes: raise the avif matrix per-test cap from 240s to
  600s, and assert toHaveCount(0) on the deleted user row so a transient success
  toast no longer trips a strict-mode violation.

Verified end to end: the full Nightly workflow is green on this branch (all 14
jobs), and PR CI is green.
2026-07-24 03:54:50 +08:00

287 lines
11 KiB
TypeScript

import { test as base, expect } from "@playwright/test";
import { authFile } from "../../playwright.config";
import { login, openSettings } from "./helpers";
const API = process.env.API_URL || "http://localhost:13490";
const TEST_USER = "rbactest";
const TEST_PASSWORD = "RbacTest1";
/** Auth header only (GET, DELETE). */
function authOnly(token: string): Record<string, string> {
return { Authorization: `Bearer ${token}` };
}
/** Auth + JSON content-type (POST, PUT). */
function authJson(token: string): Record<string, string> {
return { Authorization: `Bearer ${token}`, "Content-Type": "application/json" };
}
async function getAdminToken(): Promise<string> {
const res = await fetch(`${API}/api/auth/login`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "admin" }),
});
const data = await res.json();
return data.token;
}
/**
* Create the test user with role "user" and clear the mustChangePassword flag
* so the browser login redirects to "/" instead of "/change-password".
*/
async function ensureTestUser(adminToken: string): Promise<void> {
// Create - ignore 409 if already exists
const createRes = await fetch(`${API}/api/auth/register`, {
method: "POST",
headers: authJson(adminToken),
body: JSON.stringify({
username: TEST_USER,
password: TEST_PASSWORD,
role: "user",
}),
});
if (createRes.status !== 201 && createRes.status !== 409) {
throw new Error(`Failed to create test user: ${createRes.status}`);
}
// Login as the test user to get a token
const loginRes = await fetch(`${API}/api/auth/login`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: TEST_USER, password: TEST_PASSWORD }),
});
if (!loginRes.ok) {
throw new Error(`Failed to login as test user: ${loginRes.status}`);
}
const loginData = await loginRes.json();
// Change password (same value) to clear mustChangePassword flag
const changeRes = await fetch(`${API}/api/auth/change-password`, {
method: "POST",
headers: authJson(loginData.token),
body: JSON.stringify({
currentPassword: TEST_PASSWORD,
newPassword: TEST_PASSWORD,
}),
});
if (!changeRes.ok) {
throw new Error(`Failed to clear mustChangePassword: ${changeRes.status}`);
}
}
/** Delete the test user if it exists. */
async function cleanupTestUser(adminToken: string): Promise<void> {
const listRes = await fetch(`${API}/api/auth/users`, {
headers: authOnly(adminToken),
});
if (!listRes.ok) return;
const { users } = await listRes.json();
const testUser = users.find((u: { username: string }) => u.username === TEST_USER);
if (testUser) {
await fetch(`${API}/api/auth/users/${testUser.id}`, {
method: "DELETE",
headers: authOnly(adminToken),
});
}
}
// ── Admin sees all tabs ─────────────────────────────────────────────
base.describe("RBAC - Admin sees all tabs", () => {
base.use({
storageState: authFile,
});
base.test("admin sees all settings tabs", async ({ page }) => {
await page.goto("/");
await openSettings(page);
// Admin has every permission, so all 12 nav items are visible.
await expect(page.getByRole("button", { name: /general/i })).toBeVisible();
await expect(page.getByRole("button", { name: /system settings/i })).toBeVisible();
await expect(page.getByRole("button", { name: /security/i })).toBeVisible();
await expect(page.getByRole("button", { name: /people/i })).toBeVisible();
await expect(page.getByRole("button", { name: /teams/i })).toBeVisible();
await expect(page.getByRole("button", { name: /^roles$/i })).toBeVisible();
await expect(page.getByRole("button", { name: /audit log/i })).toBeVisible();
await expect(page.getByRole("button", { name: /^usage$/i })).toBeVisible();
await expect(page.getByRole("button", { name: /api keys/i })).toBeVisible();
await expect(page.getByRole("button", { name: /ai features/i })).toBeVisible();
await expect(page.getByRole("button", { name: /tools/i })).toBeVisible();
await expect(page.getByRole("button", { name: /about/i })).toBeVisible();
// Exactly 12 nav buttons in the settings sidebar.
expect(await page.locator(".w-48 button").count()).toBe(12);
});
});
// ── User sees restricted tabs ───────────────────────────────────────
base.describe("RBAC - User sees restricted tabs", () => {
let adminToken: string;
base.beforeAll(async () => {
adminToken = await getAdminToken();
await ensureTestUser(adminToken);
});
base.afterAll(async () => {
await cleanupTestUser(adminToken);
});
base.test("user role only sees permitted settings tabs", async ({ page }) => {
await login(page, TEST_USER, TEST_PASSWORD);
await openSettings(page);
// Should see these 4 tabs (no permission gate, or authRequired only)
await expect(page.getByRole("button", { name: /general/i })).toBeVisible();
await expect(page.getByRole("button", { name: /security/i })).toBeVisible();
await expect(page.getByRole("button", { name: /api keys/i })).toBeVisible();
await expect(page.getByRole("button", { name: /about/i })).toBeVisible();
// Should NOT see admin-only tabs
await expect(page.getByRole("button", { name: /system settings/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /people/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /teams/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /^roles$/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /audit log/i })).not.toBeVisible();
// Usage now requires audit:read, so it is admin-only.
await expect(page.getByRole("button", { name: /^usage$/i })).not.toBeVisible();
// AI Features requires settings:write.
await expect(page.getByRole("button", { name: /ai features/i })).not.toBeVisible();
// Tools requires settings:write, so it is admin-only.
await expect(page.getByRole("button", { name: /tools/i })).not.toBeVisible();
// Exactly 4 nav buttons for the user role.
expect(await page.locator(".w-48 button").count()).toBe(4);
});
base.test("user role gets 403 on admin API endpoints", async ({ page }) => {
await login(page, TEST_USER, TEST_PASSWORD);
// Extract token from localStorage
const token = await page.evaluate(() => localStorage.getItem("snapotter-token"));
expect(token).toBeTruthy();
const bearerToken = token as string;
// GET /api/auth/users requires users:manage
const usersRes = await fetch(`${API}/api/auth/users`, {
headers: authOnly(bearerToken),
});
expect(usersRes.status).toBe(403);
// PUT /api/v1/settings requires settings:write
const settingsRes = await fetch(`${API}/api/v1/settings`, {
method: "PUT",
headers: authJson(bearerToken),
body: JSON.stringify({ defaultTheme: "dark" }),
});
expect(settingsRes.status).toBe(403);
});
});
// ── Editor sees collaborative tabs ─────────────────────────────────
base.describe("RBAC - Editor sees collaborative tabs", () => {
let adminToken: string;
base.beforeAll(async () => {
adminToken = await getAdminToken();
// Create editor user
const createRes = await fetch(`${API}/api/auth/register`, {
method: "POST",
headers: authJson(adminToken),
body: JSON.stringify({
username: "editortest",
password: "EditorTest1",
role: "editor",
}),
});
if (createRes.status !== 201 && createRes.status !== 409) {
throw new Error(`Failed to create editor user: ${createRes.status}`);
}
// Clear mustChangePassword
const loginRes = await fetch(`${API}/api/auth/login`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "editortest", password: "EditorTest1" }),
});
if (!loginRes.ok) throw new Error(`Editor login failed: ${loginRes.status}`);
const loginData = await loginRes.json();
await fetch(`${API}/api/auth/change-password`, {
method: "POST",
headers: authJson(loginData.token),
body: JSON.stringify({
currentPassword: "EditorTest1",
newPassword: "EditorTest1",
}),
});
});
base.afterAll(async () => {
const listRes = await fetch(`${API}/api/auth/users`, {
headers: authOnly(adminToken),
});
if (!listRes.ok) return;
const { users } = await listRes.json();
const editor = users.find((u: { username: string }) => u.username === "editortest");
if (editor) {
await fetch(`${API}/api/auth/users/${editor.id}`, {
method: "DELETE",
headers: authOnly(adminToken),
});
}
});
base.test(
"editor sees general, security, api-keys, about but not admin tabs",
async ({ page }) => {
await login(page, "editortest", "EditorTest1");
await openSettings(page);
// Should see these 4 tabs (editor lacks settings:write, users:manage,
// teams:manage, and audit:read).
await expect(page.getByRole("button", { name: /general/i })).toBeVisible();
await expect(page.getByRole("button", { name: /security/i })).toBeVisible();
await expect(page.getByRole("button", { name: /api keys/i })).toBeVisible();
await expect(page.getByRole("button", { name: /about/i })).toBeVisible();
// Should NOT see admin tabs
await expect(page.getByRole("button", { name: /system settings/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /people/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /teams/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /^roles$/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /audit log/i })).not.toBeVisible();
// Usage requires audit:read, AI Features and Tools require settings:write.
await expect(page.getByRole("button", { name: /^usage$/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /ai features/i })).not.toBeVisible();
await expect(page.getByRole("button", { name: /tools/i })).not.toBeVisible();
// Exactly 4 nav buttons for the editor role.
expect(await page.locator(".w-48 button").count()).toBe(4);
},
);
base.test("editor gets 403 on admin API endpoints", async ({ page }) => {
await login(page, "editortest", "EditorTest1");
const token = await page.evaluate(() => localStorage.getItem("snapotter-token"));
expect(token).toBeTruthy();
const usersRes = await fetch(`${API}/api/auth/users`, {
headers: authOnly(token as string),
});
expect(usersRes.status).toBe(403);
const settingsRes = await fetch(`${API}/api/v1/settings`, {
method: "PUT",
headers: authJson(token as string),
body: JSON.stringify({ defaultTheme: "dark" }),
});
expect(settingsRes.status).toBe(403);
});
});