@specbook/core 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/assert.ts +17 -6
- package/src/config.ts +15 -2
- package/src/controls.ts +34 -9
- package/src/diff.ts +131 -0
- package/src/environment.ts +175 -0
- package/src/index.ts +4 -1
- package/src/mock.ts +80 -70
- package/src/reporters/ci.ts +53 -0
- package/src/reporters/color.ts +34 -0
- package/src/reporters/envelope.ts +63 -0
- package/src/reporters/index.ts +139 -25
- package/src/reporters/list.ts +254 -0
- package/src/reporters/redact.ts +113 -0
- package/src/reporters/trace.ts +70 -0
- package/src/request.ts +20 -2
- package/src/runner/index.ts +1 -0
- package/src/runner/run.ts +111 -26
- package/src/runner/suite.ts +122 -0
- package/src/runner/transport.ts +29 -4
- package/src/secrets.ts +31 -2
- package/src/sequence.ts +4 -4
- package/src/spec-config.ts +77 -11
- package/src/types.ts +49 -32
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
// Where a run happens, from the environment a CI system sets, for the report's header and its links.
|
|
2
|
+
|
|
3
|
+
export interface CiInfo {
|
|
4
|
+
provider: string
|
|
5
|
+
runUrl?: string
|
|
6
|
+
sha?: string
|
|
7
|
+
branch?: string
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export function detectCi(env: Record<string, string | undefined>): CiInfo | undefined {
|
|
11
|
+
if (env.GITHUB_ACTIONS === 'true') {
|
|
12
|
+
const server = env.GITHUB_SERVER_URL ?? 'https://github.com'
|
|
13
|
+
return {
|
|
14
|
+
provider: 'github-actions',
|
|
15
|
+
runUrl:
|
|
16
|
+
env.GITHUB_REPOSITORY && env.GITHUB_RUN_ID
|
|
17
|
+
? `${server}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}`
|
|
18
|
+
: undefined,
|
|
19
|
+
sha: env.GITHUB_SHA,
|
|
20
|
+
branch: env.GITHUB_HEAD_REF || env.GITHUB_REF_NAME,
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
if (env.GITLAB_CI === 'true')
|
|
24
|
+
return {
|
|
25
|
+
provider: 'gitlab-ci',
|
|
26
|
+
runUrl: env.CI_PIPELINE_URL,
|
|
27
|
+
sha: env.CI_COMMIT_SHA,
|
|
28
|
+
branch: env.CI_COMMIT_REF_NAME,
|
|
29
|
+
}
|
|
30
|
+
if (env.CIRCLECI === 'true')
|
|
31
|
+
return {
|
|
32
|
+
provider: 'circleci',
|
|
33
|
+
runUrl: env.CIRCLE_BUILD_URL,
|
|
34
|
+
sha: env.CIRCLE_SHA1,
|
|
35
|
+
branch: env.CIRCLE_BRANCH,
|
|
36
|
+
}
|
|
37
|
+
if (env.BUILDKITE === 'true')
|
|
38
|
+
return {
|
|
39
|
+
provider: 'buildkite',
|
|
40
|
+
runUrl: env.BUILDKITE_BUILD_URL,
|
|
41
|
+
sha: env.BUILDKITE_COMMIT,
|
|
42
|
+
branch: env.BUILDKITE_BRANCH,
|
|
43
|
+
}
|
|
44
|
+
if (env.JENKINS_URL)
|
|
45
|
+
return {
|
|
46
|
+
provider: 'jenkins',
|
|
47
|
+
runUrl: env.BUILD_URL,
|
|
48
|
+
sha: env.GIT_COMMIT,
|
|
49
|
+
branch: env.GIT_BRANCH,
|
|
50
|
+
}
|
|
51
|
+
if (env.CI) return { provider: 'ci' }
|
|
52
|
+
return undefined
|
|
53
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
// Terminal colors, only when they will be seen: a TTY or a CI log that renders them, not NO_COLOR, or FORCE_COLOR.
|
|
2
|
+
|
|
3
|
+
export interface Colors {
|
|
4
|
+
red(s: string): string
|
|
5
|
+
green(s: string): string
|
|
6
|
+
yellow(s: string): string
|
|
7
|
+
cyan(s: string): string
|
|
8
|
+
dim(s: string): string
|
|
9
|
+
bold(s: string): string
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
/** CI systems whose logs render color though the stream is not a terminal. */
|
|
13
|
+
const COLOR_CI = ['GITHUB_ACTIONS', 'GITLAB_CI', 'CIRCLECI', 'BUILDKITE']
|
|
14
|
+
|
|
15
|
+
/** Whether to color output: FORCE_COLOR wins, then NO_COLOR, then an interactive terminal or a CI log that shows color. */
|
|
16
|
+
export function colorEnabled(env: Record<string, string | undefined>, isTTY: boolean): boolean {
|
|
17
|
+
if (env.FORCE_COLOR && env.FORCE_COLOR !== '0') return true
|
|
18
|
+
if (env.NO_COLOR !== undefined && env.NO_COLOR !== '') return false
|
|
19
|
+
if (COLOR_CI.some((k) => env[k] && env[k] !== 'false')) return true
|
|
20
|
+
return isTTY && env.TERM !== 'dumb'
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export function createColors(enabled: boolean): Colors {
|
|
24
|
+
const wrap = (open: number, close: number) => (s: string) =>
|
|
25
|
+
enabled ? `\u001b[${open}m${s}\u001b[${close}m` : s
|
|
26
|
+
return {
|
|
27
|
+
red: wrap(31, 39),
|
|
28
|
+
green: wrap(32, 39),
|
|
29
|
+
yellow: wrap(33, 39),
|
|
30
|
+
cyan: wrap(36, 39),
|
|
31
|
+
dim: wrap(2, 22),
|
|
32
|
+
bold: wrap(1, 22),
|
|
33
|
+
}
|
|
34
|
+
}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
// The JSON report: the results with what a monitoring system needs to know about the run around them.
|
|
2
|
+
|
|
3
|
+
import type { RunResult } from '../types'
|
|
4
|
+
import type { CiInfo } from './ci'
|
|
5
|
+
|
|
6
|
+
export interface ReportMeta {
|
|
7
|
+
env: string
|
|
8
|
+
/** version of the specbook that ran it */
|
|
9
|
+
specbook?: string
|
|
10
|
+
node?: string
|
|
11
|
+
os?: string
|
|
12
|
+
git?: { sha?: string; branch?: string }
|
|
13
|
+
ci?: CiInfo
|
|
14
|
+
/** `bundle.json` details when run from a bundle */
|
|
15
|
+
bundle?: { sha?: string; createdAt?: string }
|
|
16
|
+
/** service → origin of the address its calls went to */
|
|
17
|
+
services?: Record<string, string>
|
|
18
|
+
startedAt: string
|
|
19
|
+
finishedAt: string
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface ReportTotals {
|
|
23
|
+
flows: { passed: number; failed: number; errored: number; flaky: number }
|
|
24
|
+
steps: { passed: number; failed: number; skipped: number }
|
|
25
|
+
assertions: { passed: number; failed: number }
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface RunReport extends ReportMeta {
|
|
29
|
+
schemaVersion: 2
|
|
30
|
+
durationMs: number
|
|
31
|
+
totals: ReportTotals
|
|
32
|
+
results: RunResult[]
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export function reportTotals(results: RunResult[]): ReportTotals {
|
|
36
|
+
const t: ReportTotals = {
|
|
37
|
+
flows: { passed: 0, failed: 0, errored: 0, flaky: 0 },
|
|
38
|
+
steps: { passed: 0, failed: 0, skipped: 0 },
|
|
39
|
+
assertions: { passed: 0, failed: 0 },
|
|
40
|
+
}
|
|
41
|
+
for (const r of results) {
|
|
42
|
+
if (r.status === 'pass') t.flows.passed++
|
|
43
|
+
else if (r.status === 'error') t.flows.errored++
|
|
44
|
+
else t.flows.failed++
|
|
45
|
+
if (r.flaky) t.flows.flaky++
|
|
46
|
+
t.steps.passed += r.totals.passed
|
|
47
|
+
t.steps.failed += r.totals.failed
|
|
48
|
+
t.steps.skipped += r.totals.skipped
|
|
49
|
+
t.assertions.passed += r.totals.assertions.passed
|
|
50
|
+
t.assertions.failed += r.totals.assertions.failed
|
|
51
|
+
}
|
|
52
|
+
return t
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function buildReport(results: RunResult[], meta: ReportMeta): RunReport {
|
|
56
|
+
return {
|
|
57
|
+
schemaVersion: 2,
|
|
58
|
+
...meta,
|
|
59
|
+
durationMs: Math.max(0, Date.parse(meta.finishedAt) - Date.parse(meta.startedAt)),
|
|
60
|
+
totals: reportTotals(results),
|
|
61
|
+
results,
|
|
62
|
+
}
|
|
63
|
+
}
|
package/src/reporters/index.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { stripAnsi } from '../assert'
|
|
2
|
+
import { diffAssertion } from '../diff'
|
|
2
3
|
import type { RunResult, StepResult } from '../types'
|
|
4
|
+
import { reportTotals } from './envelope'
|
|
5
|
+
import { traceLines } from './trace'
|
|
3
6
|
|
|
4
7
|
export interface Reporter {
|
|
5
8
|
onEvent?(e: unknown): void
|
|
@@ -40,35 +43,74 @@ export function formatPretty(results: RunResult[]): string {
|
|
|
40
43
|
|
|
41
44
|
const esc = (s: unknown) =>
|
|
42
45
|
String(s).replace(
|
|
43
|
-
/
|
|
44
|
-
|
|
46
|
+
// biome-ignore lint/suspicious/noControlCharactersInRegex: characters XML 1.0 forbids
|
|
47
|
+
/[<>&"']|[\u0000-\u0008\u000b\u000c\u000e-\u001f]/g,
|
|
48
|
+
(c) => ({ '<': '<', '>': '>', '&': '&', '"': '"', "'": ''' })[c] ?? '',
|
|
45
49
|
)
|
|
46
50
|
|
|
47
|
-
export
|
|
51
|
+
export interface JUnitOptions {
|
|
52
|
+
/** ISO time the run began; shown on each suite */
|
|
53
|
+
timestamp?: string
|
|
54
|
+
hostname?: string
|
|
55
|
+
/** shown as `<properties>` on each suite (env, git sha, seed…) */
|
|
56
|
+
properties?: Record<string, string | undefined>
|
|
57
|
+
/** service → origin, for the trace in `<system-out>` */
|
|
58
|
+
origins?: Record<string, string>
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const leafSteps = (steps: StepResult[]): StepResult[] =>
|
|
62
|
+
steps.flatMap((s) => (s.children?.length ? leafSteps(s.children) : [s]))
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* JUnit XML: one suite per flow or request, one case per step (named `flow › step`, class = the project file), failures
|
|
66
|
+
* with the expected and received values, errors with their message, skipped steps, a flow that passed on a retry as a
|
|
67
|
+
* `<flakyFailure>`, and the redacted request/response trace in `<system-out>`.
|
|
68
|
+
*/
|
|
69
|
+
export function toJUnit(results: RunResult[], o: JUnitOptions = {}): string {
|
|
48
70
|
const suites = results.map((r) => {
|
|
49
|
-
const flat
|
|
50
|
-
const
|
|
51
|
-
|
|
52
|
-
const
|
|
71
|
+
const flat = leafSteps(r.steps)
|
|
72
|
+
const failures = flat.filter((s) => s.status === 'fail').length
|
|
73
|
+
const errors = flat.filter((s) => s.status === 'error').length
|
|
74
|
+
const skipped = flat.filter((s) => s.status === 'skipped').length
|
|
75
|
+
const props = Object.entries({ env: r.env, seed: r.seed, ...o.properties })
|
|
76
|
+
.filter(([, v]) => v !== undefined && v !== '')
|
|
77
|
+
.map(([k, v]) => ` <property name="${esc(k)}" value="${esc(v)}"/>`)
|
|
78
|
+
.join('\n')
|
|
53
79
|
const cases = flat
|
|
54
80
|
.map((s) => {
|
|
55
81
|
const time = (s.durationMs / 1000).toFixed(3)
|
|
56
82
|
const failed = s.assertions.filter((a) => !a.pass)
|
|
57
83
|
let inner = ''
|
|
58
84
|
if (s.status === 'skipped') inner = '<skipped/>'
|
|
59
|
-
else if (s.status === 'error')
|
|
85
|
+
else if (s.status === 'error')
|
|
86
|
+
inner = `<error message="${esc(s.error ?? 'error')}" type="Error">${esc(s.error ?? 'error')}</error>`
|
|
60
87
|
else if (failed.length) {
|
|
61
88
|
inner = failed
|
|
62
|
-
.map(
|
|
63
|
-
(a)
|
|
64
|
-
|
|
65
|
-
|
|
89
|
+
.map((a) => {
|
|
90
|
+
const lines = diffAssertion(a)
|
|
91
|
+
.filter((l) => l.kind !== 'skip')
|
|
92
|
+
.map(
|
|
93
|
+
(l) =>
|
|
94
|
+
`${l.kind === 'expected' ? '- ' : l.kind === 'received' ? '+ ' : ' '}${l.text}`,
|
|
95
|
+
)
|
|
96
|
+
const at = a.location
|
|
97
|
+
? `\nat ${a.location.file}:${a.location.line}:${a.location.column ?? 1}`
|
|
98
|
+
: ''
|
|
99
|
+
return `<failure message="${esc(a.label)}" type="${esc(a.operator)}">${esc(`${lines.join('\n')}${at}`)}</failure>`
|
|
100
|
+
})
|
|
66
101
|
.join('')
|
|
67
102
|
}
|
|
68
|
-
|
|
103
|
+
if (r.flaky && s.status === 'pass' && (r.attempts ?? 1) > 1)
|
|
104
|
+
inner += `<flakyFailure message="passed on attempt ${r.attempts}"/>`
|
|
105
|
+
const trace =
|
|
106
|
+
s.status === 'fail' || s.status === 'error'
|
|
107
|
+
? `<system-out>${esc(traceLines(s, { origins: o.origins }).join('\n'))}</system-out>`
|
|
108
|
+
: ''
|
|
109
|
+
return ` <testcase classname="${esc(r.file ?? r.id)}" name="${esc(`${r.title} › ${s.name}`)}" time="${time}">${inner}${trace}</testcase>`
|
|
69
110
|
})
|
|
70
111
|
.join('\n')
|
|
71
|
-
|
|
112
|
+
const stamp = r.startedAt || o.timestamp
|
|
113
|
+
return ` <testsuite name="${esc(r.title)}" tests="${flat.length}" failures="${failures}" errors="${errors}" skipped="${skipped}" time="${(r.durationMs / 1000).toFixed(3)}"${stamp ? ` timestamp="${esc(stamp)}"` : ''}${o.hostname ? ` hostname="${esc(o.hostname)}"` : ''}>\n <properties>\n${props}\n </properties>\n${cases}\n </testsuite>`
|
|
72
114
|
})
|
|
73
115
|
return `<?xml version="1.0" encoding="UTF-8"?>\n<testsuites>\n${suites.join('\n')}\n</testsuites>\n`
|
|
74
116
|
}
|
|
@@ -82,24 +124,96 @@ export function exitCode(results: RunResult[]): 0 | 1 | 2 {
|
|
|
82
124
|
return 0
|
|
83
125
|
}
|
|
84
126
|
|
|
85
|
-
/**
|
|
86
|
-
export function
|
|
87
|
-
|
|
127
|
+
/** For `specbook test`: 0 when every flow passed (a flaky one counts), 1 when any failed or errored. */
|
|
128
|
+
export function testExitCode(results: RunResult[]): 0 | 1 {
|
|
129
|
+
return results.some((r) => r.status !== 'pass') ? 1 : 0
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export interface GithubOptions {
|
|
133
|
+
/** folder the paths are made relative to (the project or repository root) */
|
|
134
|
+
cwd?: string
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** A workflow command property: `%`, newlines, `:` and `,` are escaped. */
|
|
138
|
+
const prop = (v: string) =>
|
|
139
|
+
v
|
|
140
|
+
.replace(/%/g, '%25')
|
|
141
|
+
.replace(/\r/g, '%0D')
|
|
142
|
+
.replace(/\n/g, '%0A')
|
|
143
|
+
.replace(/:/g, '%3A')
|
|
144
|
+
.replace(/,/g, '%2C')
|
|
145
|
+
const data = (v: string) => v.replace(/%/g, '%25').replace(/\r/g, '%0D').replace(/\n/g, '%0A')
|
|
146
|
+
|
|
147
|
+
/** GitHub Actions workflow commands: one annotation per failing assertion/step, a warning for a flaky flow. */
|
|
148
|
+
export function formatGithub(results: RunResult[], o: GithubOptions = {}): string {
|
|
149
|
+
const rel = (f: string) => (o.cwd && f.startsWith(`${o.cwd}/`) ? f.slice(o.cwd.length + 1) : f)
|
|
88
150
|
const lines: string[] = []
|
|
89
151
|
const visit = (r: RunResult, s: StepResult) => {
|
|
90
152
|
for (const c of s.children ?? []) visit(r, c)
|
|
91
|
-
if (s.
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
153
|
+
if (s.children?.length) return
|
|
154
|
+
const title = prop(`${r.title}: ${s.name}`)
|
|
155
|
+
const file = r.file ? `file=${prop(r.file)},` : ''
|
|
156
|
+
if (s.status === 'error')
|
|
157
|
+
lines.push(`::error ${file}title=${title}::${data(s.error ?? 'error')}`)
|
|
158
|
+
if (s.status === 'skipped' || s.status === 'error') return
|
|
96
159
|
for (const a of s.assertions.filter((x) => !x.pass)) {
|
|
97
|
-
const loc = a.location ? `file=${
|
|
98
|
-
lines.push(`::error ${loc}title=${
|
|
160
|
+
const loc = a.location ? `file=${prop(rel(a.location.file))},line=${a.location.line},` : file
|
|
161
|
+
lines.push(`::error ${loc}title=${title}::${data(a.label)}`)
|
|
99
162
|
}
|
|
100
163
|
}
|
|
101
|
-
for (const r of results)
|
|
164
|
+
for (const r of results) {
|
|
165
|
+
for (const s of r.steps) visit(r, s)
|
|
166
|
+
if (r.flaky)
|
|
167
|
+
lines.push(
|
|
168
|
+
`::warning ${r.file ? `file=${prop(r.file)},` : ''}title=${prop(`${r.title}: flaky`)}::${data(`passed on attempt ${r.attempts}`)}`,
|
|
169
|
+
)
|
|
170
|
+
}
|
|
102
171
|
const ok = results.filter((r) => r.status === 'pass').length
|
|
103
172
|
lines.push(`${ok}/${results.length} runs passed`)
|
|
104
173
|
return lines.join('\n')
|
|
105
174
|
}
|
|
175
|
+
|
|
176
|
+
/** Markdown for `$GITHUB_STEP_SUMMARY`: totals, a table of flows, and what failed. */
|
|
177
|
+
export function githubSummary(
|
|
178
|
+
results: RunResult[],
|
|
179
|
+
meta: { env: string; runUrl?: string } = { env: '' },
|
|
180
|
+
): string {
|
|
181
|
+
const t = reportTotals(results)
|
|
182
|
+
const mark = (r: RunResult) =>
|
|
183
|
+
r.status === 'pass' ? (r.flaky ? '⚠️ flaky' : '✅') : r.status === 'error' ? '❗ error' : '❌'
|
|
184
|
+
const cell = (s: string) => s.replace(/\|/g, '\\|')
|
|
185
|
+
const lines = [
|
|
186
|
+
`### specbook test${meta.env ? ` · ${meta.env}` : ''}`,
|
|
187
|
+
'',
|
|
188
|
+
`**${t.flows.passed}** passed · **${t.flows.failed + t.flows.errored}** failed · **${t.flows.flaky}** flaky · ${results.length} total`,
|
|
189
|
+
'',
|
|
190
|
+
'| | Flow | Steps | Assertions | Time |',
|
|
191
|
+
'| --- | --- | --- | --- | --- |',
|
|
192
|
+
...results.map(
|
|
193
|
+
(r) =>
|
|
194
|
+
`| ${mark(r)} | ${cell(r.title)} | ${r.totals.passed}/${r.totals.steps} | ${r.totals.assertions.passed}/${r.totals.assertions.passed + r.totals.assertions.failed} | ${(r.durationMs / 1000).toFixed(2)}s |`,
|
|
195
|
+
),
|
|
196
|
+
]
|
|
197
|
+
const bad = results.flatMap((r) =>
|
|
198
|
+
leafSteps(r.steps)
|
|
199
|
+
.filter((s) => s.status === 'fail' || s.status === 'error')
|
|
200
|
+
.map((s) => ({ r, s })),
|
|
201
|
+
)
|
|
202
|
+
if (bad.length) {
|
|
203
|
+
lines.push('', '#### Failures', '')
|
|
204
|
+
for (const { r, s } of bad) {
|
|
205
|
+
lines.push(`- **${cell(r.title)} › ${cell(s.name)}**`)
|
|
206
|
+
if (s.error) lines.push(` - ${s.error}`)
|
|
207
|
+
for (const a of s.assertions.filter((x) => !x.pass)) lines.push(` - ${a.label}`)
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
if (meta.runUrl) lines.push('', `[Run](${meta.runUrl})`)
|
|
211
|
+
return `${lines.join('\n')}\n`
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
export * from './ci'
|
|
215
|
+
export * from './color'
|
|
216
|
+
export * from './envelope'
|
|
217
|
+
export * from './list'
|
|
218
|
+
export * from './redact'
|
|
219
|
+
export * from './trace'
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
// The default report: steps as they finish, then what failed (with the assertion, a source frame and the trace) and a summary.
|
|
2
|
+
|
|
3
|
+
import { type DiffLine, diffAssertion } from '../diff'
|
|
4
|
+
import type { RunEvent } from '../runner/run'
|
|
5
|
+
import type { AssertionResult, RunResult, StepResult } from '../types'
|
|
6
|
+
import { type Colors, createColors } from './color'
|
|
7
|
+
import { reportTotals } from './envelope'
|
|
8
|
+
import { type TraceOptions, traceLines } from './trace'
|
|
9
|
+
|
|
10
|
+
export interface ListOptions {
|
|
11
|
+
colors?: Colors
|
|
12
|
+
/** only failures and the summary */
|
|
13
|
+
quiet?: boolean
|
|
14
|
+
/** show the request and response of a failed step (default), of every step, or not at all */
|
|
15
|
+
trace?: 'on-failure' | 'always' | 'off'
|
|
16
|
+
/** service → origin, to show full addresses in a trace */
|
|
17
|
+
origins?: Record<string, string>
|
|
18
|
+
/** paths are shown relative to this folder */
|
|
19
|
+
cwd?: string
|
|
20
|
+
/** the text of a project file, for the source frame of a failed assertion */
|
|
21
|
+
readSource?: (file: string) => string | undefined
|
|
22
|
+
/** the command that runs just this flow again */
|
|
23
|
+
rerun?: (r: RunResult) => string | undefined
|
|
24
|
+
/** how long the whole run took, for the summary */
|
|
25
|
+
durationMs?: number
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const MARKS = { pass: '✓', fail: '✗', error: '!', skipped: '–' } as const
|
|
29
|
+
|
|
30
|
+
export const formatDuration = (ms: number): string =>
|
|
31
|
+
ms < 1000
|
|
32
|
+
? `${Math.round(ms)}ms`
|
|
33
|
+
: ms < 60_000
|
|
34
|
+
? `${(ms / 1000).toFixed(2)}s`
|
|
35
|
+
: `${Math.floor(ms / 60_000)}m ${Math.round((ms % 60_000) / 1000)}s`
|
|
36
|
+
|
|
37
|
+
const leaves = (steps: StepResult[]): StepResult[] =>
|
|
38
|
+
steps.flatMap((s) => (s.children?.length ? leaves(s.children) : [s]))
|
|
39
|
+
|
|
40
|
+
function paint(status: StepResult['status'], c: Colors, text: string): string {
|
|
41
|
+
return status === 'pass'
|
|
42
|
+
? c.green(text)
|
|
43
|
+
: status === 'skipped'
|
|
44
|
+
? c.dim(text)
|
|
45
|
+
: status === 'error'
|
|
46
|
+
? c.yellow(text)
|
|
47
|
+
: c.red(text)
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
interface StepFacts {
|
|
51
|
+
status: StepResult['status']
|
|
52
|
+
flow: string
|
|
53
|
+
step: string
|
|
54
|
+
method?: string
|
|
55
|
+
url?: string
|
|
56
|
+
code?: number
|
|
57
|
+
ms?: number
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/** `✓ Checkout › Create order POST /orders 201 85ms` */
|
|
61
|
+
export function stepLine(f: StepFacts, c: Colors, indent = ' '): string {
|
|
62
|
+
const detail = [
|
|
63
|
+
f.method && f.url ? `${f.method} ${f.url}` : '',
|
|
64
|
+
f.code ? String(f.code) : '',
|
|
65
|
+
f.ms !== undefined ? formatDuration(f.ms) : '',
|
|
66
|
+
]
|
|
67
|
+
.filter(Boolean)
|
|
68
|
+
.join(' ')
|
|
69
|
+
// a request that is its own flow is named once
|
|
70
|
+
const name = f.flow === f.step ? f.step : `${f.flow} › ${f.step}`
|
|
71
|
+
return `${indent}${paint(f.status, c, MARKS[f.status])} ${name}${detail ? ` ${c.dim(detail)}` : ''}`
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function diffText(lines: DiffLine[], c: Colors, indent: string): string[] {
|
|
75
|
+
return lines.map((l) =>
|
|
76
|
+
l.kind === 'expected'
|
|
77
|
+
? `${indent}${c.green(`- ${l.text}`)}`
|
|
78
|
+
: l.kind === 'received'
|
|
79
|
+
? `${indent}${c.red(`+ ${l.text}`)}`
|
|
80
|
+
: l.kind === 'skip'
|
|
81
|
+
? `${indent}${c.dim(` ${l.text}`)}`
|
|
82
|
+
: `${indent}${c.dim(` ${l.text}`)}`,
|
|
83
|
+
)
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** The lines around `line` with a caret under `column`, from a file's text. */
|
|
87
|
+
export function codeFrame(
|
|
88
|
+
source: string,
|
|
89
|
+
line: number,
|
|
90
|
+
column = 1,
|
|
91
|
+
c: Colors = createColors(false),
|
|
92
|
+
around = 2,
|
|
93
|
+
): string[] {
|
|
94
|
+
const lines = source.split('\n')
|
|
95
|
+
const from = Math.max(1, line - around)
|
|
96
|
+
const to = Math.min(lines.length, line + around)
|
|
97
|
+
const width = String(to).length
|
|
98
|
+
const out: string[] = []
|
|
99
|
+
for (let n = from; n <= to; n++) {
|
|
100
|
+
const text = lines[n - 1] ?? ''
|
|
101
|
+
const mark = n === line ? c.red('>') : ' '
|
|
102
|
+
out.push(`${mark} ${c.dim(String(n).padStart(width))} ${c.dim('|')} ${text}`)
|
|
103
|
+
if (n === line)
|
|
104
|
+
out.push(
|
|
105
|
+
` ${' '.repeat(width)} ${c.dim('|')} ${' '.repeat(Math.max(0, column - 1))}${c.red('^')}`,
|
|
106
|
+
)
|
|
107
|
+
}
|
|
108
|
+
return out
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const rel = (file: string, cwd?: string) =>
|
|
112
|
+
cwd && file.startsWith(`${cwd}/`) ? file.slice(cwd.length + 1) : file
|
|
113
|
+
|
|
114
|
+
function assertionBlock(a: AssertionResult, o: ListOptions, c: Colors): string[] {
|
|
115
|
+
const out = [` ${c.red('✗')} ${a.label}`]
|
|
116
|
+
const diff = diffAssertion(a)
|
|
117
|
+
if (diff.length) {
|
|
118
|
+
out.push(` ${c.green('- Expected')} ${c.red('+ Received')}`)
|
|
119
|
+
out.push(...diffText(diff, c, ' '))
|
|
120
|
+
}
|
|
121
|
+
if (a.location) {
|
|
122
|
+
out.push(
|
|
123
|
+
` ${c.dim(`at ${rel(a.location.file, o.cwd)}:${a.location.line}:${a.location.column ?? 1}`)}`,
|
|
124
|
+
)
|
|
125
|
+
const text = o.readSource?.(a.location.file)
|
|
126
|
+
if (text !== undefined)
|
|
127
|
+
for (const l of codeFrame(text, a.location.line, a.location.column, c))
|
|
128
|
+
out.push(` ${l}`)
|
|
129
|
+
}
|
|
130
|
+
return out
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/** One block per failed or errored step: the assertions that failed, why a step errored, and its trace. */
|
|
134
|
+
export function formatFailures(results: RunResult[], o: ListOptions = {}): string {
|
|
135
|
+
const c = o.colors ?? createColors(false)
|
|
136
|
+
const out: string[] = []
|
|
137
|
+
for (const r of results) {
|
|
138
|
+
for (const s of leaves(r.steps)) {
|
|
139
|
+
if (s.status !== 'fail' && s.status !== 'error') continue
|
|
140
|
+
const where = r.file ? `${r.file} › ` : ''
|
|
141
|
+
out.push(
|
|
142
|
+
'',
|
|
143
|
+
`${c.bold(c.red(' FAIL '))} ${where}${r.title === s.name ? r.title : `${r.title} › ${s.name}`} ${c.dim(`[${r.env}] ${formatDuration(s.durationMs)}`)}`,
|
|
144
|
+
)
|
|
145
|
+
if (s.status === 'error') out.push(` ${c.yellow('!')} ${s.error ?? 'error'}`)
|
|
146
|
+
for (const a of s.assertions) if (!a.pass) out.push(...assertionBlock(a, o, c))
|
|
147
|
+
if ((o.trace ?? 'on-failure') !== 'off')
|
|
148
|
+
for (const l of traceLines(s, { origins: o.origins })) out.push(` ${c.dim(l)}`)
|
|
149
|
+
const rerun = o.rerun?.(r)
|
|
150
|
+
if (rerun) out.push(` ${c.dim(`Re-run: ${rerun}`)}`)
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
return out.join('\n')
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/** `Flows 8 passed | 1 failed | 1 flaky`, steps, assertions, time and the slowest steps. */
|
|
157
|
+
export function formatSummary(results: RunResult[], o: ListOptions = {}): string {
|
|
158
|
+
const c = o.colors ?? createColors(false)
|
|
159
|
+
const t = reportTotals(results)
|
|
160
|
+
const part = (n: number, word: string, paintFn: (s: string) => string) =>
|
|
161
|
+
n ? paintFn(`${n} ${word}`) : ''
|
|
162
|
+
const join = (...parts: string[]) => parts.filter(Boolean).join(c.dim(' | ')) || c.dim('none')
|
|
163
|
+
const lines = [
|
|
164
|
+
'',
|
|
165
|
+
`${c.bold(' Flows ')} ${join(
|
|
166
|
+
part(t.flows.failed, 'failed', c.red),
|
|
167
|
+
part(t.flows.errored, 'errored', c.yellow),
|
|
168
|
+
part(t.flows.flaky, 'flaky', c.yellow),
|
|
169
|
+
part(t.flows.passed, 'passed', c.green),
|
|
170
|
+
)} ${c.dim(`(${results.length})`)}`,
|
|
171
|
+
`${c.bold(' Steps ')} ${join(
|
|
172
|
+
part(t.steps.failed, 'failed', c.red),
|
|
173
|
+
part(t.steps.skipped, 'skipped', c.dim),
|
|
174
|
+
part(t.steps.passed, 'passed', c.green),
|
|
175
|
+
)}`,
|
|
176
|
+
`${c.bold(' Assertions ')} ${join(
|
|
177
|
+
part(t.assertions.failed, 'failed', c.red),
|
|
178
|
+
part(t.assertions.passed, 'passed', c.green),
|
|
179
|
+
)}`,
|
|
180
|
+
]
|
|
181
|
+
const total = o.durationMs ?? results.reduce((n, r) => n + r.durationMs, 0)
|
|
182
|
+
lines.push(`${c.bold(' Duration ')} ${formatDuration(total)}`)
|
|
183
|
+
const slow = results
|
|
184
|
+
.flatMap((r) =>
|
|
185
|
+
leaves(r.steps)
|
|
186
|
+
.filter((s) => s.status !== 'skipped')
|
|
187
|
+
// a request is a flow of one step: its name is said once
|
|
188
|
+
.map((s) => ({
|
|
189
|
+
name: r.title === s.name ? r.title : `${r.title} › ${s.name}`,
|
|
190
|
+
ms: s.durationMs,
|
|
191
|
+
})),
|
|
192
|
+
)
|
|
193
|
+
.sort((a, b) => b.ms - a.ms)
|
|
194
|
+
.slice(0, 5)
|
|
195
|
+
if (slow.length > 1) {
|
|
196
|
+
const times = slow.map((s) => formatDuration(s.ms))
|
|
197
|
+
const width = Math.max(...times.map((t) => t.length))
|
|
198
|
+
lines.push(c.bold(' Slowest'))
|
|
199
|
+
for (const [i, s] of slow.entries())
|
|
200
|
+
lines.push(` ${c.dim(`${(times[i] as string).padStart(width)} ${s.name}`)}`)
|
|
201
|
+
}
|
|
202
|
+
return lines.join('\n')
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
function stepFacts(r: RunResult, s: StepResult): StepFacts {
|
|
206
|
+
return {
|
|
207
|
+
status: s.status,
|
|
208
|
+
flow: r.title,
|
|
209
|
+
step: s.name,
|
|
210
|
+
method: s.request?.method,
|
|
211
|
+
url: s.request?.url,
|
|
212
|
+
code: s.response?.status,
|
|
213
|
+
ms: s.status === 'skipped' ? undefined : s.durationMs,
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/** The whole report at once, from finished results (what the streaming reporter prints, in one string). */
|
|
218
|
+
export function formatList(results: RunResult[], o: ListOptions = {}): string {
|
|
219
|
+
const c = o.colors ?? createColors(false)
|
|
220
|
+
const lines: string[] = []
|
|
221
|
+
if (!o.quiet)
|
|
222
|
+
for (const r of results)
|
|
223
|
+
for (const s of leaves(r.steps)) lines.push(stepLine(stepFacts(r, s), c))
|
|
224
|
+
const failures = formatFailures(results, o)
|
|
225
|
+
return [lines.join('\n'), failures, formatSummary(results, o)].filter((x) => x !== '').join('\n')
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/** Prints each step as it finishes, from the run's events; at the end prints the failures and the summary. */
|
|
229
|
+
export function createListReporter(o: ListOptions & { write(text: string): void }) {
|
|
230
|
+
const c = o.colors ?? createColors(false)
|
|
231
|
+
let flow = ''
|
|
232
|
+
const facts = new Map<string, Partial<StepFacts>>()
|
|
233
|
+
return {
|
|
234
|
+
onEvent(e: RunEvent) {
|
|
235
|
+
if (e.type === 'run:start') flow = e.title ?? e.id
|
|
236
|
+
else if (e.type === 'request')
|
|
237
|
+
facts.set(e.name, { ...facts.get(e.name), method: e.request.method, url: e.request.url })
|
|
238
|
+
else if (e.type === 'response')
|
|
239
|
+
facts.set(e.name, { ...facts.get(e.name), code: e.status, ms: e.durationMs })
|
|
240
|
+
else if (e.type === 'step:end') {
|
|
241
|
+
const f = facts.get(e.name)
|
|
242
|
+
facts.delete(e.name)
|
|
243
|
+
if (e.status === 'pass' && o.quiet) return
|
|
244
|
+
o.write(`${stepLine({ ...f, status: e.status, flow, step: e.name }, c)}\n`)
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
onEnd(results: RunResult[]) {
|
|
248
|
+
const rest = [formatFailures(results, o), formatSummary(results, o)].filter((x) => x !== '')
|
|
249
|
+
o.write(`${rest.join('\n')}\n`)
|
|
250
|
+
},
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
export type { TraceOptions }
|