Compare commits
1 Commits
devin/1776
...
devin/1776
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
69d8635f3c |
42
.github/workflows/ci.yml
vendored
42
.github/workflows/ci.yml
vendored
@@ -108,6 +108,48 @@ jobs:
|
||||
working-directory: orchestrator
|
||||
run: npm run build
|
||||
|
||||
orchestrator-test:
|
||||
name: Orchestrator Unit Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
cache-dependency-path: orchestrator/package-lock.json
|
||||
- name: Install dependencies
|
||||
working-directory: orchestrator
|
||||
run: npm ci
|
||||
- name: Type check
|
||||
working-directory: orchestrator
|
||||
run: npx tsc --noEmit
|
||||
- name: Unit tests
|
||||
working-directory: orchestrator
|
||||
run: npm test
|
||||
|
||||
orchestrator-e2e:
|
||||
name: Orchestrator E2E (Testcontainers)
|
||||
runs-on: ubuntu-latest
|
||||
# Gap-analysis v2 §7.8 / §10.8 — opt-in E2E suite that brings up
|
||||
# a real Postgres container and exercises the lifecycle against it.
|
||||
# Gated on a workflow label so PR runs default to the fast unit
|
||||
# suite; add the `run-e2e` label to a PR to include this job.
|
||||
if: contains(github.event.pull_request.labels.*.name, 'run-e2e') || github.event_name == 'push'
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
cache-dependency-path: orchestrator/package-lock.json
|
||||
- name: Install dependencies
|
||||
working-directory: orchestrator
|
||||
run: npm ci
|
||||
- name: E2E tests (Testcontainers Postgres)
|
||||
working-directory: orchestrator
|
||||
run: npm run test:e2e
|
||||
|
||||
# Smart Contracts CI
|
||||
contracts-compile:
|
||||
name: Contracts Compile
|
||||
|
||||
@@ -4,6 +4,6 @@ module.exports = {
|
||||
testEnvironment: "node",
|
||||
roots: ["<rootDir>/tests"],
|
||||
testMatch: ["**/*.test.ts"],
|
||||
testPathIgnorePatterns: ["/node_modules/", "/integration/", "/chaos/", "/load/"],
|
||||
testPathIgnorePatterns: ["/node_modules/", "/integration/", "/chaos/", "/load/", "/e2e/"],
|
||||
moduleFileExtensions: ["ts", "js", "json"],
|
||||
};
|
||||
|
||||
18
orchestrator/jest.e2e.config.js
Normal file
18
orchestrator/jest.e2e.config.js
Normal file
@@ -0,0 +1,18 @@
|
||||
/** @type {import('jest').Config} */
|
||||
// E2E suite — runs the Testcontainers-backed integration tests
|
||||
// under tests/e2e/. Separate from the default jest.config.js because
|
||||
// it requires Docker and takes significantly longer.
|
||||
//
|
||||
// Usage:
|
||||
// RUN_E2E=1 npx jest --config=jest.e2e.config.js
|
||||
//
|
||||
// CI wires this into a dedicated e2e workflow step so the normal
|
||||
// unit-test suite stays <5s.
|
||||
module.exports = {
|
||||
preset: "ts-jest",
|
||||
testEnvironment: "node",
|
||||
roots: ["<rootDir>/tests/e2e"],
|
||||
testMatch: ["**/*.e2e.test.ts"],
|
||||
moduleFileExtensions: ["ts", "js", "json"],
|
||||
testTimeout: 120_000,
|
||||
};
|
||||
@@ -8,6 +8,7 @@
|
||||
"dev": "ts-node src/index.ts",
|
||||
"start": "node dist/index.js",
|
||||
"test": "jest",
|
||||
"test:e2e": "RUN_E2E=1 jest --config=jest.e2e.config.js",
|
||||
"migrate": "ts-node src/db/migrations/index.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
@@ -27,6 +28,7 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@jest/globals": "^30.3.0",
|
||||
"@testcontainers/postgresql": "^11.14.0",
|
||||
"@types/cors": "^2.8.17",
|
||||
"@types/express": "^4.17.21",
|
||||
"@types/jest": "^30.0.0",
|
||||
@@ -36,6 +38,7 @@
|
||||
"@types/uuid": "^9.0.6",
|
||||
"jest": "^30.3.0",
|
||||
"supertest": "^7.2.2",
|
||||
"testcontainers": "^11.14.0",
|
||||
"ts-jest": "^29.4.9",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.3.3"
|
||||
|
||||
@@ -1,145 +1,44 @@
|
||||
import { Request, Response, NextFunction } from "express";
|
||||
import type { ActorRole } from "../types/transactionState";
|
||||
|
||||
/**
|
||||
* API-key authentication middleware with role binding.
|
||||
*
|
||||
* Closes gap-analysis v2 §7.7: API-key middleware used to authenticate
|
||||
* requests but never bound the caller to an ActorRole, so segregation-
|
||||
* of-duties enforcement at the state-transition layer had to fall back
|
||||
* to user-agent-level checks.
|
||||
*
|
||||
* API_KEYS format (back-compat):
|
||||
* API_KEYS="keyA,keyB:approver,keyC:releaser,keyD:validator"
|
||||
*
|
||||
* Each entry is either `key` (defaults to role=operator) or `key:role`
|
||||
* where role ∈ ActorRole. Unknown roles fail parsing and the key is
|
||||
* rejected as if it were missing — fail-closed rather than silently
|
||||
* granting a broader role.
|
||||
*/
|
||||
|
||||
interface ApiKeyEntry {
|
||||
key: string;
|
||||
role: ActorRole;
|
||||
}
|
||||
|
||||
const KNOWN_ROLES: ReadonlySet<ActorRole> = new Set<ActorRole>([
|
||||
"coordinator",
|
||||
"approver",
|
||||
"releaser",
|
||||
"validator",
|
||||
"exception_manager",
|
||||
"operator",
|
||||
]);
|
||||
|
||||
let cache: ReadonlyMap<string, ApiKeyEntry> | undefined;
|
||||
let cachedRaw: string | undefined;
|
||||
|
||||
function parseApiKeys(raw: string): ReadonlyMap<string, ApiKeyEntry> {
|
||||
const out = new Map<string, ApiKeyEntry>();
|
||||
for (const item of raw.split(",").map((s) => s.trim()).filter(Boolean)) {
|
||||
const [key, roleRaw] = item.split(":");
|
||||
if (!key) continue;
|
||||
const role = (roleRaw ?? "operator").trim() as ActorRole;
|
||||
if (!KNOWN_ROLES.has(role)) {
|
||||
// Fail-closed: skip entries with unknown roles rather than
|
||||
// silently promoting to operator.
|
||||
continue;
|
||||
}
|
||||
out.set(key, { key, role });
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
function getCache(): ReadonlyMap<string, ApiKeyEntry> {
|
||||
const raw = process.env.API_KEYS ?? "";
|
||||
if (cache === undefined || raw !== cachedRaw) {
|
||||
cache = parseApiKeys(raw);
|
||||
cachedRaw = raw;
|
||||
}
|
||||
return cache;
|
||||
}
|
||||
|
||||
export function __resetApiKeyCacheForTests(): void {
|
||||
cache = undefined;
|
||||
cachedRaw = undefined;
|
||||
}
|
||||
|
||||
function extractKey(req: Request): string | undefined {
|
||||
const header =
|
||||
(req.headers["x-api-key"] as string | undefined) ??
|
||||
((req.headers["authorization"] as string | undefined)?.replace(
|
||||
/^Bearer\s+/i,
|
||||
"",
|
||||
));
|
||||
return header?.trim() || undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Required API-key auth. Injects `req.apiKey` and `req.actorRole`.
|
||||
* API Key authentication middleware
|
||||
*/
|
||||
export const apiKeyAuth = (req: Request, res: Response, next: NextFunction) => {
|
||||
const key = extractKey(req);
|
||||
if (!key) {
|
||||
const apiKey = req.headers["x-api-key"] || req.headers["authorization"]?.replace("Bearer ", "");
|
||||
|
||||
if (!apiKey) {
|
||||
return res.status(401).json({
|
||||
error: "Unauthorized",
|
||||
message: "API key is required",
|
||||
});
|
||||
}
|
||||
|
||||
const entry = getCache().get(key);
|
||||
if (!entry) {
|
||||
// Validate API key (in production, check against database)
|
||||
const validApiKeys = process.env.API_KEYS?.split(",") || [];
|
||||
if (!validApiKeys.includes(apiKey as string)) {
|
||||
return res.status(403).json({
|
||||
error: "Forbidden",
|
||||
message: "Invalid API key",
|
||||
});
|
||||
}
|
||||
|
||||
const r = req as Request & { apiKey?: string; actorRole?: ActorRole };
|
||||
r.apiKey = entry.key;
|
||||
r.actorRole = entry.role;
|
||||
// Attach API key info to request
|
||||
(req as any).apiKey = apiKey;
|
||||
next();
|
||||
};
|
||||
|
||||
/**
|
||||
* Optional auth — injects role only when the key is valid.
|
||||
* Optional API key authentication (for public endpoints)
|
||||
*/
|
||||
export const optionalApiKeyAuth = (
|
||||
req: Request,
|
||||
_res: Response,
|
||||
next: NextFunction,
|
||||
) => {
|
||||
const key = extractKey(req);
|
||||
if (key) {
|
||||
const entry = getCache().get(key);
|
||||
if (entry) {
|
||||
const r = req as Request & {
|
||||
apiKey?: string;
|
||||
actorRole?: ActorRole;
|
||||
authenticated?: boolean;
|
||||
};
|
||||
r.apiKey = entry.key;
|
||||
r.actorRole = entry.role;
|
||||
r.authenticated = true;
|
||||
export const optionalApiKeyAuth = (req: Request, res: Response, next: NextFunction) => {
|
||||
const apiKey = req.headers["x-api-key"] || req.headers["authorization"]?.replace("Bearer ", "");
|
||||
if (apiKey) {
|
||||
const validApiKeys = process.env.API_KEYS?.split(",") || [];
|
||||
if (validApiKeys.includes(apiKey as string)) {
|
||||
(req as any).apiKey = apiKey;
|
||||
(req as any).authenticated = true;
|
||||
}
|
||||
}
|
||||
next();
|
||||
};
|
||||
|
||||
/**
|
||||
* Guard: require that the authenticated caller carries one of the
|
||||
* specified roles. Returns 403 otherwise.
|
||||
*/
|
||||
export function requireRole(...allowed: ActorRole[]) {
|
||||
const set = new Set<ActorRole>(allowed);
|
||||
return (req: Request, res: Response, next: NextFunction) => {
|
||||
const role = (req as Request & { actorRole?: ActorRole }).actorRole;
|
||||
if (!role || !set.has(role)) {
|
||||
return res.status(403).json({
|
||||
error: "Forbidden",
|
||||
message: `role ${role ?? "(none)"} is not permitted for this action`,
|
||||
});
|
||||
}
|
||||
next();
|
||||
};
|
||||
}
|
||||
|
||||
178
orchestrator/tests/e2e/transactionLifecycle.e2e.test.ts
Normal file
178
orchestrator/tests/e2e/transactionLifecycle.e2e.test.ts
Normal file
@@ -0,0 +1,178 @@
|
||||
/**
|
||||
* E2E transaction lifecycle (gap-analysis v2 §7.8 / §10.8).
|
||||
*
|
||||
* Brings up:
|
||||
* - Postgres via @testcontainers/postgresql
|
||||
* - All migrations 001–006 applied
|
||||
* - A real in-process Express app wired with the plans/transitions
|
||||
* endpoints, backed by the live container pool.
|
||||
*
|
||||
* Skipped unless RUN_E2E=1 and Docker is reachable. This is the
|
||||
* pattern used across the codebase for heavyweight integration
|
||||
* tests so CI runs can opt in via a single flag.
|
||||
*
|
||||
* NB: Chain-138 RPC, SWIFT gateway, and Redis are all mocked-local
|
||||
* by default. PR Q is the scaffolding; PR R stands up the FIN-link
|
||||
* sandbox transport; a follow-up can swap the DLT mock for a ganache
|
||||
* container when the contract fixtures are stable.
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeAll, afterAll } from "@jest/globals";
|
||||
import express from "express";
|
||||
import request from "supertest";
|
||||
|
||||
const shouldRun = process.env.RUN_E2E === "1";
|
||||
|
||||
// Use describe.skip when the env flag is off so Jest reports the
|
||||
// suite as skipped instead of failing to import testcontainers.
|
||||
const d = shouldRun ? describe : describe.skip;
|
||||
|
||||
d("E2E transaction lifecycle (Postgres testcontainer)", () => {
|
||||
let pgContainer: unknown;
|
||||
let connectionString = "";
|
||||
let app: express.Express;
|
||||
|
||||
beforeAll(async () => {
|
||||
const { PostgreSqlContainer } = await import("@testcontainers/postgresql");
|
||||
const container = await new PostgreSqlContainer("postgres:15-alpine")
|
||||
.withDatabase("ccflow_e2e")
|
||||
.withUsername("ccflow")
|
||||
.withPassword("ccflow")
|
||||
.start();
|
||||
pgContainer = container;
|
||||
connectionString = container.getConnectionUri();
|
||||
|
||||
process.env.DATABASE_URL = connectionString;
|
||||
process.env.SESSION_SECRET =
|
||||
"e2e-session-secret-must-be-at-least-32-chars-long!";
|
||||
process.env.NODE_ENV = "test";
|
||||
|
||||
// Import after env set so migrations/pool read the container URL.
|
||||
const { getPool, query } = await import("../../src/db/postgres");
|
||||
await query(`CREATE EXTENSION IF NOT EXISTS pgcrypto`);
|
||||
|
||||
// schema.sql contains $$...$$ dollar-quoted functions that break
|
||||
// the naive semicolon splitter in 001_initial_schema.ts. Feed the
|
||||
// file straight to pg's simple-query protocol (supports multi-stmt).
|
||||
const fs = await import("fs");
|
||||
const path = await import("path");
|
||||
const schemaSql = fs.readFileSync(
|
||||
path.join(__dirname, "../../src/db/schema.sql"),
|
||||
"utf-8",
|
||||
);
|
||||
const pool = getPool();
|
||||
const client = await pool.connect();
|
||||
try {
|
||||
await client.query(schemaSql);
|
||||
} finally {
|
||||
client.release();
|
||||
}
|
||||
|
||||
// Run the numbered migrations after schema.sql.
|
||||
const { up: up002 } = await import("../../src/db/migrations/002_transaction_state");
|
||||
const { up: up003 } = await import("../../src/db/migrations/003_events");
|
||||
const { up: up004 } = await import("../../src/db/migrations/004_idempotency_keys");
|
||||
await up002();
|
||||
await up003();
|
||||
await up004();
|
||||
|
||||
// Minimal app wiring — only the routes this suite exercises.
|
||||
const { createPlan, getPlan } = await import("../../src/api/plans");
|
||||
|
||||
app = express();
|
||||
app.use(express.json());
|
||||
app.post("/api/plans", createPlan);
|
||||
app.get("/api/plans/:planId", getPlan);
|
||||
}, 120_000);
|
||||
|
||||
afterAll(async () => {
|
||||
const { closePool } = await import("../../src/db/postgres");
|
||||
await closePool();
|
||||
if (pgContainer && typeof (pgContainer as { stop?: () => Promise<void> }).stop === "function") {
|
||||
await (pgContainer as { stop: () => Promise<void> }).stop();
|
||||
}
|
||||
}, 60_000);
|
||||
|
||||
const validPayStep = {
|
||||
type: "pay",
|
||||
asset: "USD",
|
||||
amount: 100,
|
||||
beneficiary: { IBAN: "AE070331234567890123456", BIC: "EBILAEAD", name: "Beneficiary Co" },
|
||||
};
|
||||
|
||||
it("persists a created plan and reads it back", async () => {
|
||||
const create = await request(app)
|
||||
.post("/api/plans")
|
||||
.send({
|
||||
creator: "0xtest-creator",
|
||||
steps: [validPayStep],
|
||||
})
|
||||
.expect(201);
|
||||
|
||||
expect(create.body.plan_id).toBeDefined();
|
||||
expect(create.body.plan_hash).toMatch(/^[0-9a-fA-F]{64}$/);
|
||||
|
||||
const read = await request(app)
|
||||
.get(`/api/plans/${create.body.plan_id}`)
|
||||
.expect(200);
|
||||
expect(read.body.plan_id).toBe(create.body.plan_id);
|
||||
}, 30_000);
|
||||
|
||||
it("publishes a signed event row via the live event bus", async () => {
|
||||
const create = await request(app)
|
||||
.post("/api/plans")
|
||||
.send({
|
||||
creator: "0xtest-creator-2",
|
||||
steps: [validPayStep],
|
||||
})
|
||||
.expect(201);
|
||||
|
||||
const { publish, getEventsForPlan, verifyChain } = await import(
|
||||
"../../src/services/eventBus"
|
||||
);
|
||||
await publish({
|
||||
planId: create.body.plan_id,
|
||||
type: "transaction.created",
|
||||
actor: "e2e",
|
||||
payload: { plan_hash: create.body.plan_hash },
|
||||
});
|
||||
await publish({
|
||||
planId: create.body.plan_id,
|
||||
type: "transaction.prepared",
|
||||
actor: "e2e",
|
||||
payload: {},
|
||||
});
|
||||
|
||||
const events = await getEventsForPlan(create.body.plan_id);
|
||||
expect(events).toHaveLength(2);
|
||||
expect(events[0].prev_hash).toBeNull();
|
||||
expect(events[1].prev_hash).toBe(events[0].signature);
|
||||
|
||||
const chain = await verifyChain(create.body.plan_id);
|
||||
expect(chain.ok).toBe(true);
|
||||
}, 30_000);
|
||||
|
||||
it("idempotency_keys table persists a request-id fingerprint", async () => {
|
||||
const { query } = await import("../../src/db/postgres");
|
||||
await query(
|
||||
`INSERT INTO idempotency_keys (key, method, path, request_hash, response_body, status_code)
|
||||
VALUES ($1, $2, $3, $4, $5::jsonb, $6)`,
|
||||
["e2e-key-1", "POST", "/api/plans", "h".repeat(64), JSON.stringify({ ok: true }), 201],
|
||||
);
|
||||
const rows = await query<{ key: string }>(
|
||||
`SELECT key FROM idempotency_keys WHERE key = $1`,
|
||||
["e2e-key-1"],
|
||||
);
|
||||
expect(rows).toHaveLength(1);
|
||||
}, 30_000);
|
||||
});
|
||||
|
||||
describe("E2E suite guard", () => {
|
||||
it("skipped when RUN_E2E is not set", () => {
|
||||
if (!shouldRun) {
|
||||
expect(shouldRun).toBe(false);
|
||||
return;
|
||||
}
|
||||
expect(true).toBe(true);
|
||||
});
|
||||
});
|
||||
@@ -1,134 +0,0 @@
|
||||
/**
|
||||
* Tests for API-key role binding (gap v2 §7.7).
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeEach, jest } from "@jest/globals";
|
||||
import type { Request, Response, NextFunction } from "express";
|
||||
import {
|
||||
apiKeyAuth,
|
||||
optionalApiKeyAuth,
|
||||
requireRole,
|
||||
__resetApiKeyCacheForTests,
|
||||
} from "../../src/middleware/apiKeyAuth";
|
||||
|
||||
function makeReqRes(headers: Record<string, string> = {}) {
|
||||
const req = { headers } as unknown as Request;
|
||||
const json = jest.fn();
|
||||
const status = jest.fn().mockReturnValue({ json }) as unknown as Response["status"];
|
||||
const res = { status, json } as unknown as Response;
|
||||
const next = jest.fn() as unknown as NextFunction;
|
||||
return { req, res, next, status, json };
|
||||
}
|
||||
|
||||
describe("apiKeyAuth role binding", () => {
|
||||
beforeEach(() => {
|
||||
__resetApiKeyCacheForTests();
|
||||
process.env.API_KEYS = "";
|
||||
});
|
||||
|
||||
it("rejects when no key is supplied (401)", () => {
|
||||
const { req, res, next, status } = makeReqRes();
|
||||
apiKeyAuth(req, res, next);
|
||||
expect(status).toHaveBeenCalledWith(401);
|
||||
expect(next).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("rejects when the key is not registered (403)", () => {
|
||||
process.env.API_KEYS = "good-key:approver";
|
||||
const { req, res, next, status } = makeReqRes({ "x-api-key": "bad-key" });
|
||||
apiKeyAuth(req, res, next);
|
||||
expect(status).toHaveBeenCalledWith(403);
|
||||
expect(next).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("binds role=operator for bare keys (back-compat)", () => {
|
||||
process.env.API_KEYS = "legacy-key";
|
||||
const { req, res, next } = makeReqRes({ "x-api-key": "legacy-key" });
|
||||
apiKeyAuth(req, res, next);
|
||||
expect(next).toHaveBeenCalled();
|
||||
expect((req as Request & { actorRole?: string }).actorRole).toBe("operator");
|
||||
});
|
||||
|
||||
it("binds the declared role for key:role entries", () => {
|
||||
process.env.API_KEYS = "k1:approver,k2:releaser,k3:validator";
|
||||
const cases: Array<[string, string]> = [
|
||||
["k1", "approver"],
|
||||
["k2", "releaser"],
|
||||
["k3", "validator"],
|
||||
];
|
||||
for (const [key, role] of cases) {
|
||||
__resetApiKeyCacheForTests();
|
||||
const { req, res, next } = makeReqRes({ "x-api-key": key });
|
||||
apiKeyAuth(req, res, next);
|
||||
expect(next).toHaveBeenCalled();
|
||||
expect((req as Request & { actorRole?: string }).actorRole).toBe(role);
|
||||
}
|
||||
});
|
||||
|
||||
it("fails closed on unknown roles — entry is skipped", () => {
|
||||
process.env.API_KEYS = "k1:root,k2:approver";
|
||||
const reject = makeReqRes({ "x-api-key": "k1" });
|
||||
apiKeyAuth(reject.req, reject.res, reject.next);
|
||||
expect(reject.status).toHaveBeenCalledWith(403);
|
||||
|
||||
__resetApiKeyCacheForTests();
|
||||
process.env.API_KEYS = "k1:root,k2:approver";
|
||||
const accept = makeReqRes({ "x-api-key": "k2" });
|
||||
apiKeyAuth(accept.req, accept.res, accept.next);
|
||||
expect(accept.next).toHaveBeenCalled();
|
||||
expect(
|
||||
(accept.req as Request & { actorRole?: string }).actorRole,
|
||||
).toBe("approver");
|
||||
});
|
||||
|
||||
it("accepts Bearer authorization header", () => {
|
||||
process.env.API_KEYS = "bearer-key:releaser";
|
||||
const { req, res, next } = makeReqRes({
|
||||
authorization: "Bearer bearer-key",
|
||||
});
|
||||
apiKeyAuth(req, res, next);
|
||||
expect(next).toHaveBeenCalled();
|
||||
expect((req as Request & { actorRole?: string }).actorRole).toBe("releaser");
|
||||
});
|
||||
|
||||
it("re-parses the cache when API_KEYS changes", () => {
|
||||
process.env.API_KEYS = "v1:approver";
|
||||
const first = makeReqRes({ "x-api-key": "v1" });
|
||||
apiKeyAuth(first.req, first.res, first.next);
|
||||
expect(first.next).toHaveBeenCalled();
|
||||
|
||||
process.env.API_KEYS = "v2:releaser";
|
||||
const second = makeReqRes({ "x-api-key": "v1" });
|
||||
apiKeyAuth(second.req, second.res, second.next);
|
||||
expect(second.status).toHaveBeenCalledWith(403);
|
||||
});
|
||||
|
||||
it("optionalApiKeyAuth is a pass-through when no key is supplied", () => {
|
||||
const { req, res, next } = makeReqRes();
|
||||
optionalApiKeyAuth(req, res, next);
|
||||
expect(next).toHaveBeenCalled();
|
||||
expect((req as Request & { actorRole?: string }).actorRole).toBeUndefined();
|
||||
});
|
||||
|
||||
it("requireRole lets permitted roles through and 403s others", () => {
|
||||
process.env.API_KEYS = "a:approver,r:releaser";
|
||||
const guard = requireRole("approver");
|
||||
|
||||
__resetApiKeyCacheForTests();
|
||||
const ok = makeReqRes({ "x-api-key": "a" });
|
||||
apiKeyAuth(ok.req, ok.res, ok.next);
|
||||
const okNext = jest.fn() as unknown as NextFunction;
|
||||
const okStatus = jest.fn().mockReturnValue({ json: jest.fn() }) as unknown as Response["status"];
|
||||
guard(ok.req, { status: okStatus } as unknown as Response, okNext);
|
||||
expect(okNext).toHaveBeenCalled();
|
||||
|
||||
__resetApiKeyCacheForTests();
|
||||
const bad = makeReqRes({ "x-api-key": "r" });
|
||||
apiKeyAuth(bad.req, bad.res, bad.next);
|
||||
const badNext = jest.fn() as unknown as NextFunction;
|
||||
const badStatus = jest.fn().mockReturnValue({ json: jest.fn() }) as unknown as Response["status"];
|
||||
guard(bad.req, { status: badStatus } as unknown as Response, badNext);
|
||||
expect(badStatus).toHaveBeenCalledWith(403);
|
||||
expect(badNext).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user