-
-
Notifications
You must be signed in to change notification settings - Fork 268
/
base.ts
900 lines (829 loc) · 21.7 KB
/
base.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
/**
* The base class that is extended by all TAP-generating classes
*
* @module
*/
import { Domain } from 'async-hook-domain'
import { AsyncResource } from 'async_hooks'
import { Minipass } from 'minipass'
import { hrtime } from 'node:process'
import { format } from 'node:util'
import { FinalResults, Parser, Result, TapError } from 'tap-parser'
import { Deferred } from 'trivial-deferred'
import { Counts } from './counts.js'
import { diags } from './diags.js'
import { extraFromError } from './extra-from-error.js'
import type { Extra, TestBase } from './index.js'
import { Lists } from './lists.js'
import { messageFromError } from './message-from-error.js'
const unsetContext = Symbol('TAP.context unset')
/**
* Events emitted by the Base class
*/
export interface TapBaseEvents extends Minipass.Events<string> {
/**
* emitted when a timeout occurs
*/
timeout: [threw?: Extra]
/**
* emitted when the test bails out
*/
bailout: [reason?: string]
/**
* emitted when the test is complete
*/
complete: [results: FinalResults]
}
/**
* Wrapper for the async-hook-domain that catches errors thrown during
* test operation.
*
* @see {@link https://npmjs.com/async-hook-domain}
*/
export class TapWrap extends AsyncResource {
test: Base
onDestroy?: () => void
constructor(test: Base) {
super(`tap.${test.constructor.name}`)
this.test = test
}
emitDestroy() {
this.onDestroy?.()
super.emitDestroy()
return this
}
}
const debug =
(name: string) =>
(...args: any[]) => {
const prefix = `TAP ${process.pid} ${name}: `
const msg = format(...args).trim()
console.error(prefix + msg.split('\n').join(`\n${prefix}`))
}
/**
* A number indicating an amount of milliseconds
*/
export type MILLISECONDS = number
/**
* Options that may be passed to any TAP-generating class
*/
export interface BaseOpts extends Extra {
/**
* Bail out on the first failure
*/
bail?: boolean
/**
* Treat any unknown non-TAP data as an error
* May be set at run-time by the TAP stream using `pragma +strict`
*/
strict?: boolean
/**
* Do not emit the `TAP version 14` line.
*/
omitVersion?: boolean
/**
* Do not elide empty lines and other unnecessary whitespace
*/
preserveWhitespace?: boolean
/**
* Skip this test entirely, emitting a `# SKIP` directive
*/
skip?: boolean | string
/**
* Mark this test as to be done later, emitting a `# TODO` directive
*/
todo?: boolean | string
/**
* Amount of time in milliseconds before this test times out
*/
timeout?: MILLISECONDS
/**
* track passes in the results lists, default false
*/
passes?: boolean
/**
* treat todo tests as failures, default false
*/
failTodo?: boolean
/**
* treat skip tests as failures, default false
*/
failSkip?: boolean
/**
* The amount of time that this test took to complete.
*
* Typically, this is not set explicitly, but inferred from the actual
* time spent. However in some cases, it may be reported by the
* top-level `# time=...` comment in a TAP subprocess stream.
*/
time?: number
/**
* The TAP data from a buffered test.
*
* @internal
*
* @group Internal Machinery
*/
tapChildBuffer?: string
/**
* The stack where this test was initiated
*/
stack?: string
/**
* Parent test of this test
*/
parent?: Base | TestBase
/**
* The name of this test
*/
name?: string
/**
* Numeric identifier attached to child tests. Most of the time, this is
* set based on the `TAP_CHILD_ID` environment variable.
*/
childId?: number
/**
* Any arbitrary data that is provided to this test object. Often, this
* is set in a `t.before()` or `t.beforeEach()` method. Scalar values
* are inherited by child tests. Object values are extended in child
* tests using `Object.create()`.
*
* If not set in the options, this is initialized to a null-prototyped
* object, so that usage like `t.context.foo = 'bar'` will work as expected.
*
* This is initialized and set on the Test object in the `runMain` method,
* *not* at construction time. If set explicitly on the Test object in a
* `before` hook, then any context specified on options or inherited from
* the parent test will be ignored.
*/
context?: any
/**
* Number of spaces that this test is indented.
*
* @internal
*
* @group Internal Machinery
*/
indent?: string
/**
* True to output LOTS AND LOTS of noisy debugging information.
* Set at the top level by the `TAP_DEBUG` environment variable.
*/
debug?: boolean
/**
* Parser to use for this TAP stream.
*
* @internal
*
* @group Internal Machinery
*/
parser?: Parser
/**
* True if this test should be buffered, and only processed once
* complete.
*
* Defaults to true when `t.jobs` is set to a value greater than 1.
*
* If set false in that case, then the test will NOT be run in parallel,
* so this provides a way to control the parallelism within a test suite.
*/
buffered?: boolean
/**
* Setting silent:true in a subtest option makes it completely excluded
* from test output, UNLESS it fails.
*
* This was used historically for a few things which are now implemented
* with a more sophisticated promise management system, but can be handy in
* some rare situations.
*/
silent?: boolean
}
export class Base<
Events extends TapBaseEvents = TapBaseEvents
> extends Minipass<string, string, Events> {
/**
* Set upon test completion when a child test is ready to be processed by its
* parent.
*/
readyToProcess: boolean = false
/**
* Options provided to this test
*/
options: BaseOpts
/**
* number of spaces to indent the TAP stream
*/
indent: string
/**
* TapWrap AsyncResource that limits the async-hook-domain
*
* @group Internal Machinery
*/
hook: TapWrap
// this actually is deterministically set in the ctor, but
// in the hook, so tsc doesn't see it.
/**
* the async-hook-domain that catches throws and Promise rejections
*
* @group Internal Machinery
*/
hookDomain!: Domain
/**
* The timer that fires when the test times out
*
* @group Internal Machinery
*/
timer?: NodeJS.Timeout
/**
* Set to true when the test times out, so its failure status can be
* determined later.
*/
timedOut: boolean = false
/**
* The tap parser attached to this TAP stream
*
* @group Internal Machinery
*/
parser: Parser
/**
* Method that writes to stderr when `debug: true` is set in the options,
* or no-ops otherwise
*/
debug: (...args: any[]) => void
/**
* The count of all assertions that this stream emitted
*
* @group Test Reflection
*/
counts: Counts
/**
* Lists of todo, skip, and failure test points. If `passes: true` is
* set in the options, then passing test points will also be tracked.
*
* @group Test Reflection
*/
lists: Lists
/**
* the name of this test
*
* @group Test Reflection
*/
name: string
/**
* Set on completion. The results of the test run.
*
* @group Test Reflection
*/
results?: FinalResults
/**
* Parent test of this TAP stream
*
* @group Internal Machinery
*/
parent?: Base | TestBase
/**
* Nesting level, for serialization to node test runner
*
* Note that this is zero for parent-less tests, and *also* zero
* for the first level of children.
*/
nestingLevel: number = 0
/**
* Bail out on the first failed test point
*/
bail: boolean
/**
* Treat non-TAP data as an error.
* May be set with `pragma +strict` in the TAP stream, or unset with
* `pragma: -strict`.
*/
strict: boolean
/**
* Do not emit the `TAP version 14` line at the start
*/
omitVersion: boolean
/**
* Do not elide extraneous whitespace and empty lines.
*/
preserveWhitespace: boolean
/**
* Unrecoverable TAP protocol errors in the stream
*
* @group Test Reflection
*/
errors: TapError[]
/**
* Numeric identifier for this test
*/
childId: number
/**
* Any arbitrary data that is provided to this test object. Often, this
* is set in a `t.before()` or `t.beforeEach()` method. Scalar values
* are inherited by child tests. Object values are extended in child
* tests using `Object.create()`.
*/
#context: any = unsetContext
get context () {
if (this.#context === unsetContext) this.#context = Object.create(null)
return this.#context
}
set context (c: any) {
this.#context = c
}
/**
* the TAP stream data for buffered tests
*
* @internal
*
* @group Internal Machinery
*/
output: string
/**
* True if this test should be buffered and only processed on completion
*
* @internal
*
* @group Internal Machinery
*/
buffered: boolean
/**
* True if this test emitted a bailout
*
* @group Test Reflection
*/
bailedOut: string | boolean
/**
* high resolution bigint time when this test started
*
* @group Internal Machinery
*/
start: bigint
#started: boolean = false
/**
* Amount of time in milliseconds that this test took to complete.
*
* @group Test Reflection
*/
time: MILLISECONDS
/**
* High resolution time in ns that this test took to complete.
*
* @group Test Reflection
*/
hrtime: bigint
/**
* True if this test should be buffered and only emit data if it fails
*/
silent: boolean
/**
* A `Deferred` promise wrapper that is resolved when this test completes.
*
* @group Internal Machinery
*/
deferred?: Deferred<FinalResults>
#printedOutput: boolean = false
#writable: boolean = true
constructor(options: BaseOpts = {}) {
super({ encoding: 'utf8' })
// always use the constructor name as toStringTag, so we get
// [object Test] or [object TAP] and the appropriate typeName
// in stack traces.
Object.defineProperty(this, Symbol.toStringTag, {
value: this.constructor.name,
configurable: true,
})
// all tap streams are sync string minipasses
this.hook = new TapWrap(this)
this.options = options
this.counts = new Counts()
this.lists = new Lists()
this.silent = !!options.silent
this.bail = !!options.bail
this.strict = !!options.strict
this.omitVersion = !!options.omitVersion
this.preserveWhitespace = options.preserveWhitespace !== false
this.buffered = this.silent
? options.buffered === undefined
: !!options.buffered
this.bailedOut = false
this.errors = []
this.parent = options.parent
if (this.parent?.parent) {
this.nestingLevel = this.parent.nestingLevel + 1
}
this.time = 0
this.hrtime = 0n
this.start = 0n
this.childId = options.childId || 0
// do we need this? couldn't we just call the Minipass
this.output = ''
this.indent = options.indent || ''
this.name = options.name || '(unnamed test)'
this.hook.runInAsyncScope(() => {
this.hookDomain = new Domain((er, type) => {
/* c8 ignore start */
if (!er || typeof er !== 'object') {
er = { error: er }
}
/* c8 ignore stop */
;(er as { tapCaught?: string }).tapCaught = type
this.threw(er)
})
})
this.debug = !!options.debug ? debug(this.name) : () => {}
this.parser =
options.parser ||
new Parser({
bail: this.bail,
strict: this.strict,
omitVersion: this.omitVersion,
preserveWhitespace: this.preserveWhitespace,
passes: this.options.passes,
name: this.name,
})
this.#setupParser()
// ensure that a skip or todo on a child class reverts
// back to Base's no-op main.
if (options.skip || options.todo) {
this.main = Base.prototype.main
}
}
#isFilterSkip(res: Result) {
return (
typeof res.skip === 'string' &&
/^filter: (only|\/.*\/)$/.test(res.skip)
)
}
#onParserResult(res: Result) {
this.counts.total++
const type = res.todo
? 'todo'
: res.skip
? 'skip'
: !res.ok
? 'fail'
: 'pass'
this.counts[type]++
if (type === 'pass' && this.options.passes) {
this.lists.pass.push(res)
} else if (type === 'todo') {
this.lists.todo.push(res)
} else if (type === 'skip') {
if (!this.#isFilterSkip(res)) this.lists.skip.push(res)
} else if (type === 'fail') {
this.lists.fail.push(res)
}
}
#setupParser() {
this.parser.on('line', l => this.#online(l))
this.parser.once('bailout', reason => this.onbail(reason))
this.parser.on('complete', result => this.oncomplete(result))
this.parser.on('result', res => this.#onParserResult(res))
}
/**
* Set the amount of time in milliseconds before this test is considered
* a timeout. The time is counted from right now, so for example, repeatedly
* calling `t.setTimeout(100)` can keep it going indefinitely, as long as
* you call it more often than every 100ms.
*
* Calling `setTimeout(0)` will remove the timer and allow the test to run
* indefinitely.
*
* @group Test Lifecycle Management
*/
setTimeout(n: MILLISECONDS) {
if (this.timer) {
clearTimeout(this.timer)
}
if (n <= 0) {
this.timer = undefined
delete this.options.timeout
} else {
this.options.timeout = n
this.timer = setTimeout(() => this.timeout(), n)
/* c8 ignore start */
if (this.timer.unref) this.timer.unref()
/* c8 ignore stop */
}
}
/**
* Called when a timeout occurs. Only exposed because it has to be called
* and/or extended by other classes, which all have their own sorts of
* timeout behavior specific to the type of thing they represent.
*
* @internal
*
* @group Internal Machinery
*/
timeout(
options: { expired?: string; message?: string } = {
expired: this.name,
message: 'timeout!',
}
) {
this.timedOut = true
const { message = 'timeout!' } = options
this.setTimeout(0)
options.expired = options.expired || this.name
// timeouts don't generally have a useful callsite information,
// and no sense trying to capture it from @tapjs/stack
const extra: Extra = {
...options,
message,
stack: '',
at: {},
}
const threw = this.threw({ message }, extra)
delete extra.stack
delete extra.at
if (threw) {
this.emit('timeout', threw)
}
}
/**
* Run the `main` test function. Called by
* {@link @tapjs/core!test-base.TestBase} when starting a subtest.
* Initializes the TapWrap hook
*
* @internal
*
* @group Internal Machinery
*/
runMain(cb: () => void) {
this.debug('BASE runMain')
this.start = hrtime.bigint()
this.#started = true
// if it's null or an object, inherit from it. otherwise, copy it.
const ctx =
this.#context !== unsetContext ? this.#context :
('context' in this.options
? this.options.context
: this.parent?.context) ??
null
this.#context = typeof ctx === 'object' ? Object.create(ctx) : ctx
this.hook.runInAsyncScope(this.main, this, cb)
}
/**
* Returns true if this test has begun
*
* @group Test Reflection
*/
get started() {
return this.#started
}
/**
* True if the test has printed *some* output of any kind
*
* @group Test Reflection
*/
get printedOutput() {
return this.#printedOutput
}
/**
* Boolean indicating whether the underlying stream can be written to,
* or if it has been ended.
*/
get streamWritable() {
return this.#writable
}
/**
* The main test function. For this Base class, this is a no-op. Subclasses
* implement this in their specific ways.
*
* @internal
*
* @group Internal Machinery
*/
main(cb: () => void) {
cb()
}
/**
* Stream write method.
*
* For buffered tests, this collects the output in the
* {@link @tapjs/core!base.Base#output}
* field. Sets {@link @tapjs/core!base.Base#printedOutput} to `true` when
* called.
*
* Note: you *probably* never need to call this. Instead, use the various
* assertion methods and other parts of the API.
*
* @internal
*
* @group Internal Machinery
*/
write(c: string) {
this.#printedOutput = true
if (this.buffered || this.silent) {
// need the silent output if it fails
this.output += c
return true
}
if (!this.#writable) {
return false
}
return super.write(c)
}
/**
* Method called when the parser encounters a bail out
*
* Extended by {@link @tapjs/core!test-base.TestBase}
*/
onbail(reason?: string) {
this.bailedOut = reason || true
this.emit('bailout', reason)
}
/**
* Method called when parser emits a line of TAP data
*
* @internal
*
* @group Internal Machinery
*/
#online(line: string) {
this.debug('LINE %j', line, [this.name, this.indent])
return this.write(this.indent + line)
}
/**
* Method called when the parser completes and emits its final results
*
* Extended by {@link @tapjs/core!worker.Worker} and
* {@link @tapjs/core!tap.TAP} classes
*
* @internal
*
* @group Internal Machinery
*/
oncomplete(results: FinalResults) {
if (this.start) {
this.hrtime = hrtime.bigint() - this.start
this.time =
results.time || Math.floor(Number(this.hrtime) / 1000) / 1000
}
this.debug('ONCOMPLETE %j %j', this.name, results)
// should only ever happen once, but just in case
/* c8 ignore start */
if (this.results) {
Object.assign(results, this.results)
}
/* c8 ignore stop */
this.results = results
this.emit('complete', results)
const errors = results.failures
.filter(f => f.tapError)
.map(f => {
delete f.diag
delete f.ok
return f
})
if (errors.length) {
this.errors = errors
}
this.#writable = false
super.end()
}
/**
* extension point for plugins that want to be notified when the test
* is about to end, whether explicitly or implicitly.
*
* If the function returns a Promise, it will be awaited before ending
* the TAP stream.
*
* @internal
*
* @group Internal Machinery
*/
onbeforeend(): Promise<void> | void {}
/**
* extension point for plugins that want to be notified when the test
* is completely done, and terminating its parser.
*
* @internal
*
* @group Internal Machinery
*/
onEOF(): Promise<void> | void {}
/**
* extension point for TestBase to know when a child tests is done being
* processed and it's safe to move on to the next one.
*
* @internal
*
* @group Internal Machinery
*/
ondone() {}
/**
* EventEmitter emit method, but closes the
* {@link @tapjs/core!base.Base#hook} and
* {@link @tapjs/core!base.Base#hookDomain} when emitting `'end'`.
*
* @internal
*
* @group Internal Machinery
*/
emit<Event extends keyof Events>(
ev: Event,
...data: Events[Event]
) {
const ret = super.emit(ev, ...data)
if (ev === 'end') {
this.ondone()
this.hook.emitDestroy()
this.hookDomain.destroy()
}
return ret
}
/**
* Mark the test as ended. In this base class, this is a no-op, but
* in {@link @tapjs/core!test-base.TestBase}, it also triggers the other
* end-of-test operations.
*/
end() {
return this
}
/**
* Method called when an unrecoverable error is encountered in a test.
*
* Typically, in tests you would not call this, you'd just actually throw
* an error.
*
* @internal
*
* @group Internal Machinery
*/
threw(
er: any,
extra?: Extra,
proxy: boolean = false,
ended: boolean = false
): Extra | void | undefined {
this.debug('BASE.threw', er)
this.hook.emitDestroy()
this.hookDomain.destroy()
if (typeof er === 'string') {
er = { message: er }
} else if (!er || typeof er !== 'object') {
er = { error: er }
}
if (this.name && !proxy) {
er.test = this.name
}
const message = messageFromError(er)
if (!extra) {
extra = extraFromError(er, extra)
}
extra.message = message
this.parser.ok = false
// if possible to handle it here, then return the info so that this
// Base subclass can do its thing
if (
!ended &&
!this.results &&
/* c8 ignore start */
(this.parser.planEnd === -1 ||
this.parser.count < this.parser.planEnd)
/* c8 ignore stop */
) {
return extra
}
// if we ended, we have to report it SOMEWHERE, unless we're
// already in the process of bailing out, in which case it's
// a bit excessive. Do not print it here if it would trigger
// a plan exceeded error, or if we already have results.
this.debug(
'Base.threw, but finished',
this.name,
this.results,
extra.message
)
const alreadyBailing =
(this.results?.ok === false && this.bail) ||
this.parser.bailedOut ||
this.results?.bailout
if (this.results) this.results.ok = false
if (this.parent) {
this.parent.threw(er, extra, true)
} else if (!alreadyBailing) {
// not already bailing out, so print the error as best we can
if (!er.stack) {
console.error(er)
} else {
/* c8 ignore start */
const name = er.name || 'Error'
/* c8 ignore stop */
console.error('%s: %s', name, extra.message)
console.error(diags(extra))
}
}
// we are already bailing out, and this is the top level,
// just make our way hastily to the nearest exit.
}
/**
* returns true if the test has not as yet encountered any failures
*
* @group Test Reflection
*/
passing() {
return this.parser.ok && this.results?.ok !== false
}
}