Files
SnapOtter/tests/integration/custom-roles.test.ts
T
AshimandGitHub 5a45bcbc8f feat: production-grade RBAC with editor role, custom roles, API key scoping, and audit log (#89)
* feat(rbac): add editor role, 3 new permissions, ownership helper

* feat(rbac): add audit_log table, apiKeys.permissions column, editor role to schema

* feat(rbac): wire requirePermission into all routes, add editor role support

* refactor(rbac): replace ad-hoc role checks with permission-based ownership

* feat(rbac): add audit log DB writes + query endpoint

Dual-write audit events to stdout (existing) and SQLite audit_log table.
Add GET /api/v1/audit-log with pagination, action filter, and date range
filtering, gated behind audit:read permission.

* feat(rbac): add API key permission scoping with ceiling enforcement

* feat(rbac): add escalation prevention and last-admin protection

* feat(rbac): add editor role to UI, API key permission scoping in settings

* test(rbac): add full permission matrix integration test

* test(rbac): add editor role E2E tests

* feat(rbac): add custom roles with CRUD API and DB-backed permission lookup

* feat(rbac): add API key expiration

* feat(rbac): add roles management UI and API key expiration to settings

* feat(rbac): add audit log UI to settings

* fix: remove any cast in API key permission validation

* test(rbac): add unit tests for username validation rules

* test(rbac): add unit tests for effective permissions and ownership

* test(rbac): add comprehensive route permission matrix (all routes × all roles)

* test(rbac): add auth route edge case tests (login failures, session expiry, password side effects)

* test(rbac): add escalation prevention tests (register, update, self-demote, last-admin)

* test(rbac): add ownership enforcement tests (files, pipelines, editor access, cross-user isolation)

* test(rbac): add API key edge cases (name validation, delete behavior, key revocation)

* test(rbac): add audit log edge cases (all events, pagination clamping, structure)

* test(rbac): add custom roles edge case tests (validation, CRUD, functional permissions)

* test(rbac): add comprehensive E2E tests (roles UI, audit log, custom role, API key scoping)
2026-04-22 18:10:04 +08:00

161 lines
5.4 KiB
TypeScript

import { eq } from "drizzle-orm";
import { afterAll, beforeAll, describe, expect, it } from "vitest";
import { db, schema } from "../../apps/api/src/db/index.js";
import { buildTestApp, loginAsAdmin, type TestApp } from "./test-server.js";
let testApp: TestApp;
let adminToken: string;
beforeAll(async () => {
testApp = await buildTestApp();
adminToken = await loginAsAdmin(testApp.app);
}, 30_000);
afterAll(async () => {
await testApp.cleanup();
}, 10_000);
describe("custom roles", () => {
let customRoleId: string;
it("lists built-in roles", async () => {
const res = await testApp.app.inject({
method: "GET",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${adminToken}` },
});
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.roles.length).toBeGreaterThanOrEqual(3);
expect(body.roles.some((r: any) => r.name === "admin" && r.isBuiltin)).toBe(true);
expect(body.roles.some((r: any) => r.name === "editor" && r.isBuiltin)).toBe(true);
expect(body.roles.some((r: any) => r.name === "user" && r.isBuiltin)).toBe(true);
});
it("creates a custom role", async () => {
const res = await testApp.app.inject({
method: "POST",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${adminToken}` },
payload: {
name: "reviewer",
description: "Can view all files and pipelines",
permissions: ["files:all", "pipelines:all", "settings:read"],
},
});
expect(res.statusCode).toBe(201);
const body = JSON.parse(res.body);
expect(body.name).toBe("reviewer");
expect(body.permissions).toEqual(["files:all", "pipelines:all", "settings:read"]);
customRoleId = body.id;
});
it("cannot create duplicate role name", async () => {
const res = await testApp.app.inject({
method: "POST",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${adminToken}` },
payload: { name: "admin", permissions: ["tools:use"] },
});
expect(res.statusCode).toBe(409);
});
it("can assign custom role to user", async () => {
await testApp.app.inject({
method: "POST",
url: "/api/auth/register",
headers: { authorization: `Bearer ${adminToken}` },
payload: { username: "customroleuser", password: "CustomRole1", role: "reviewer" },
});
db.update(schema.users)
.set({ mustChangePassword: false })
.where(eq(schema.users.username, "customroleuser"))
.run();
const loginRes = await testApp.app.inject({
method: "POST",
url: "/api/auth/login",
payload: { username: "customroleuser", password: "CustomRole1" },
});
const body = JSON.parse(loginRes.body);
expect(body.user.role).toBe("reviewer");
expect(body.user.permissions).toContain("files:all");
expect(body.user.permissions).not.toContain("tools:use");
});
it("updates custom role permissions", async () => {
const res = await testApp.app.inject({
method: "PUT",
url: `/api/v1/roles/${customRoleId}`,
headers: { authorization: `Bearer ${adminToken}` },
payload: { permissions: ["files:all", "pipelines:all", "settings:read", "tools:use"] },
});
expect(res.statusCode).toBe(200);
});
it("cannot modify built-in roles", async () => {
const listRes = await testApp.app.inject({
method: "GET",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${adminToken}` },
});
const builtinRole = JSON.parse(listRes.body).roles.find((r: any) => r.name === "admin");
const res = await testApp.app.inject({
method: "PUT",
url: `/api/v1/roles/${builtinRole.id}`,
headers: { authorization: `Bearer ${adminToken}` },
payload: { permissions: ["tools:use"] },
});
expect(res.statusCode).toBe(400);
});
it("cannot delete built-in roles", async () => {
const listRes = await testApp.app.inject({
method: "GET",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${adminToken}` },
});
const builtinRole = JSON.parse(listRes.body).roles.find((r: any) => r.name === "admin");
const res = await testApp.app.inject({
method: "DELETE",
url: `/api/v1/roles/${builtinRole.id}`,
headers: { authorization: `Bearer ${adminToken}` },
});
expect(res.statusCode).toBe(400);
});
it("deleting custom role reassigns users to user", async () => {
const res = await testApp.app.inject({
method: "DELETE",
url: `/api/v1/roles/${customRoleId}`,
headers: { authorization: `Bearer ${adminToken}` },
});
expect(res.statusCode).toBe(200);
const loginRes = await testApp.app.inject({
method: "POST",
url: "/api/auth/login",
payload: { username: "customroleuser", password: "CustomRole1" },
});
const body = JSON.parse(loginRes.body);
expect(body.user.role).toBe("user");
});
it("requires users:manage to create roles", async () => {
const loginRes = await testApp.app.inject({
method: "POST",
url: "/api/auth/login",
payload: { username: "customroleuser", password: "CustomRole1" },
});
const userToken = JSON.parse(loginRes.body).token;
const res = await testApp.app.inject({
method: "POST",
url: "/api/v1/roles",
headers: { authorization: `Bearer ${userToken}` },
payload: { name: "hacker", permissions: ["users:manage"] },
});
expect(res.statusCode).toBe(403);
});
});