feat(scenario): attach step output and assertion details to run log
- "Step N passed" log entry carries the step's return value as data
- context.assert accepts an optional details argument; on failure the
assertion:fail entry stores { details, error } as data
- assertion failures throw AssertionFailedError so "Step N failed" and
"Snippet X failed" entries name only the assertion, without repeating
the details; the step run description keeps the full message
- exported e2e runtime accepts and prints assert details
- log output shows elapsed time in whole seconds, matching the stored
timestamp resolution
- run artifact and scenario file names link to the inline file content
in a new tab
This commit is contained in:
9 files changed
+195
-17
No files matched your search
@@ -18,6 +18,31 @@ export interface ExecResult {
|
||||
result: unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Thrown by `context.assert`. Its `message` includes the failure reason;
|
||||
* `summary` doesn't, so failure reports that follow the `assertion:fail` log
|
||||
* entry (which already holds the details) can stay short.
|
||||
*/
|
||||
export class AssertionFailedError extends Error {
|
||||
constructor(
|
||||
message: string,
|
||||
readonly summary: string,
|
||||
) {
|
||||
super(message);
|
||||
this.name = "AssertionFailedError";
|
||||
}
|
||||
}
|
||||
|
||||
/** The `AssertionFailedError` behind `err` (directly or via `cause`), if any. */
|
||||
export function findAssertionFailure(
|
||||
err: unknown,
|
||||
): AssertionFailedError | null {
|
||||
for (let e = err; e instanceof Error; e = (e as { cause?: unknown }).cause) {
|
||||
if (e instanceof AssertionFailedError) return e;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
export type ScriptLogger = (
|
||||
level: "debug" | "log" | "warn" | "error",
|
||||
message: string,
|
||||
@@ -50,11 +75,13 @@ export interface ScriptContext {
|
||||
/**
|
||||
* Runs `fn` and requires it to return `true`. Logs the outcome under
|
||||
* `description`, then throws if `fn` returned anything other than `true`
|
||||
* or threw an exception.
|
||||
* or threw an exception. On failure, `details` (and the exception message,
|
||||
* if any) are stored as the log entry's data.
|
||||
*/
|
||||
assert: (
|
||||
fn: () => boolean | Promise<boolean>,
|
||||
description: string,
|
||||
details?: unknown,
|
||||
) => Promise<void>;
|
||||
/** Runs a named snippet with the same context, plus any extra positional args. */
|
||||
runSnippet: (alias: string, ...args: unknown[]) => Promise<unknown>;
|
||||
@@ -194,6 +221,7 @@ export class CodeExecutorService {
|
||||
assert: async (
|
||||
fn: () => boolean | Promise<boolean>,
|
||||
description: string,
|
||||
details?: unknown,
|
||||
): Promise<void> => {
|
||||
let passed: boolean;
|
||||
let failureReason: string | undefined;
|
||||
@@ -210,8 +238,18 @@ export class CodeExecutorService {
|
||||
const message = failureReason
|
||||
? `Assertion failed: ${description} (${failureReason})`
|
||||
: `Assertion failed: ${description}`;
|
||||
emit("error", message, "assertion:fail");
|
||||
throw new Error(message);
|
||||
const failureData =
|
||||
failureReason !== undefined || details !== undefined
|
||||
? {
|
||||
...(failureReason !== undefined && { error: failureReason }),
|
||||
...(details !== undefined && { details }),
|
||||
}
|
||||
: undefined;
|
||||
emit("error", message, "assertion:fail", failureData);
|
||||
throw new AssertionFailedError(
|
||||
message,
|
||||
`Assertion failed: ${description}`,
|
||||
);
|
||||
},
|
||||
getStepOutput: getStepOutput ?? (() => Promise.resolve(null)),
|
||||
getCredential: (alias: string): unknown => {
|
||||
@@ -262,7 +300,7 @@ export class CodeExecutorService {
|
||||
} catch (err) {
|
||||
emit(
|
||||
"error",
|
||||
`Snippet "${alias}" failed: ${(err as Error).message}`,
|
||||
`Snippet "${alias}" failed: ${findAssertionFailure(err)?.summary ?? (err as Error).message}`,
|
||||
snippetContext,
|
||||
);
|
||||
throw err;
|
||||
|
||||
Reference in new issue
Block a user