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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { newWriteableBufferStream, VSBuffer, VSBufferReadableStream, VSBufferWriteableStream } from 'vs/base/common/buffer';
import { Emitter } from 'vs/base/common/event';
import { Lazy } from 'vs/base/common/lazy';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { URI } from 'vs/base/common/uri';
import { Range } from 'vs/editor/common/core/range';
import { localize } from 'vs/nls';
import { IComputedStateAccessor, refreshComputedState } from 'vs/workbench/contrib/testing/common/getComputedState';
import { IObservableValue, MutableObservableValue, staticObservableValue } from 'vs/workbench/contrib/testing/common/observableValue';
import { IRichLocation, ISerializedTestResults, ITestItem, ITestMessage, ITestOutputMessage, ITestRunTask, ITestTaskState, ResolvedTestRunRequest, TestItemExpandState, TestMessageType, TestResultItem, TestResultState } from 'vs/workbench/contrib/testing/common/testTypes';
import { TestCoverage } from 'vs/workbench/contrib/testing/common/testCoverage';
import { maxPriority, statesInOrder, terminalStatePriorities } from 'vs/workbench/contrib/testing/common/testingStates';
export interface ITestRunTaskResults extends ITestRunTask {
/**
* Contains test coverage for the result, if it's available.
*/
readonly coverage: IObservableValue<TestCoverage | undefined>;
/**
* Messages from the task not associated with any specific test.
*/
readonly otherMessages: ITestOutputMessage[];
}
export interface ITestResult {
/**
* Count of the number of tests in each run state.
*/
readonly counts: Readonly<TestStateCount>;
/**
* Unique ID of this set of test results.
*/
readonly id: string;
/**
* If the test is completed, the unix milliseconds time at which it was
* completed. If undefined, the test is still running.
*/
readonly completedAt: number | undefined;
/**
* Whether this test result is triggered from an auto run.
*/
readonly request: ResolvedTestRunRequest;
/**
* Human-readable name of the test result.
*/
readonly name: string;
/**
* Gets all tests involved in the run.
*/
tests: IterableIterator<TestResultItem>;
/**
* List of this result's subtasks.
*/
tasks: ReadonlyArray<ITestRunTaskResults>;
/**
* Gets the state of the test by its extension-assigned ID.
*/
getStateById(testExtId: string): TestResultItem | undefined;
/**
* Loads the output of the result as a stream.
*/
getOutput(): Promise<VSBufferReadableStream>;
/**
* Serializes the test result. Used to save and restore results
* in the workspace.
*/
toJSON(): ISerializedTestResults | undefined;
}
export const resultItemParents = function* (results: ITestResult, item: TestResultItem) {
let i: TestResultItem | undefined = item;
while (i) {
yield i;
i = i.parent ? results.getStateById(i.parent) : undefined;
}
};
/**
* Count of the number of tests in each run state.
*/
export type TestStateCount = { [K in TestResultState]: number };
export const makeEmptyCounts = () => {
const o: Partial<TestStateCount> = {};
for (const state of statesInOrder) {
o[state] = 0;
}
return o as TestStateCount;
};
export const sumCounts = (counts: Iterable<TestStateCount>) => {
const total = makeEmptyCounts();
for (const count of counts) {
for (const state of statesInOrder) {
total[state] += count[state];
}
}
return total;
};
export const maxCountPriority = (counts: Readonly<TestStateCount>) => {
for (const state of statesInOrder) {
if (counts[state] > 0) {
return state;
}
}
return TestResultState.Unset;
};
/**
* Deals with output of a {@link LiveTestResult}. By default we pass-through
* data into the underlying write stream, but if a client requests to read it
* we splice in the written data and then continue streaming incoming data.
*/
export class LiveOutputController {
/** Set on close() to a promise that is resolved once closing is complete */
private closed?: Promise<void>;
/** Data written so far. This is available until the file closes. */
private previouslyWritten: VSBuffer[] | undefined = [];
private readonly dataEmitter = new Emitter<VSBuffer>();
private readonly endEmitter = new Emitter<void>();
private _offset = 0;
/**
* Gets the number of written bytes.
*/
public get offset() {
return this._offset;
}
constructor(
private readonly writer: Lazy<[VSBufferWriteableStream, Promise<void>]>,
private readonly reader: () => Promise<VSBufferReadableStream>,
) { }
/**
* Appends data to the output.
*/
public append(data: VSBuffer): Promise<void> | void {
if (this.closed) {
return this.closed;
}
this.previouslyWritten?.push(data);
this.dataEmitter.fire(data);
this._offset += data.byteLength;
return this.writer.getValue()[0].write(data);
}
/**
* Reads the value of the stream.
*/
public read() {
if (!this.previouslyWritten) {
return this.reader();
}
const stream = newWriteableBufferStream();
for (const chunk of this.previouslyWritten) {
stream.write(chunk);
}
const disposable = new DisposableStore();
disposable.add(this.dataEmitter.event(d => stream.write(d)));
disposable.add(this.endEmitter.event(() => stream.end()));
stream.on('end', () => disposable.dispose());
return Promise.resolve(stream);
}
/**
* Closes the output, signalling no more writes will be made.
* @returns a promise that resolves when the output is written
*/
public close(): Promise<void> {
if (this.closed) {
return this.closed;
}
if (!this.writer.hasValue()) {
this.closed = Promise.resolve();
} else {
const [stream, ended] = this.writer.getValue();
stream.end();
this.closed = ended;
}
this.endEmitter.fire();
this.closed.then(() => {
this.previouslyWritten = undefined;
this.dataEmitter.dispose();
this.endEmitter.dispose();
});
return this.closed;
}
}
interface TestResultItemWithChildren extends TestResultItem {
/** Children in the run */
children: TestResultItemWithChildren[];
}
const itemToNode = (controllerId: string, item: ITestItem, parent: string | null): TestResultItemWithChildren => ({
parent,
controllerId,
expand: TestItemExpandState.NotExpandable,
item: { ...item },
children: [],
tasks: [],
ownComputedState: TestResultState.Unset,
computedState: TestResultState.Unset,
});
export const enum TestResultItemChangeReason {
ComputedStateChange,
OwnStateChange,
}
export type TestResultItemChange = { item: TestResultItem; result: ITestResult } & (
| { reason: TestResultItemChangeReason.ComputedStateChange }
| { reason: TestResultItemChangeReason.OwnStateChange; previousState: TestResultState; previousOwnDuration: number | undefined }
);
/**
* Results of a test. These are created when the test initially started running
* and marked as "complete" when the run finishes.
*/
export class LiveTestResult implements ITestResult {
private readonly completeEmitter = new Emitter<void>();
private readonly changeEmitter = new Emitter<TestResultItemChange>();
private readonly testById = new Map<string, TestResultItemWithChildren>();
private _completedAt?: number;
public readonly onChange = this.changeEmitter.event;
public readonly onComplete = this.completeEmitter.event;
public readonly tasks: ITestRunTaskResults[] = [];
public readonly name = localize('runFinished', 'Test run at {0}', new Date().toLocaleString());
/**
* @inheritdoc
*/
public get completedAt() {
return this._completedAt;
}
/**
* @inheritdoc
*/
public readonly counts: { [K in TestResultState]: number } = makeEmptyCounts();
/**
* @inheritdoc
*/
public get tests() {
return this.testById.values();
}
private readonly computedStateAccessor: IComputedStateAccessor<TestResultItemWithChildren> = {
getOwnState: i => i.ownComputedState,
getCurrentComputedState: i => i.computedState,
setComputedState: (i, s) => i.computedState = s,
getChildren: i => i.children,
getParents: i => {
const { testById: testByExtId } = this;
return (function* () {
for (let parentId = i.parent; parentId;) {
const parent = testByExtId.get(parentId);
if (!parent) {
break;
}
yield parent;
parentId = parent.parent;
}
})();
},
};
constructor(
public readonly id: string,
public readonly output: LiveOutputController,
public readonly persist: boolean,
public readonly request: ResolvedTestRunRequest,
) {
}
/**
* @inheritdoc
*/
public getStateById(extTestId: string) {
return this.testById.get(extTestId);
}
/**
* Appends output that occurred during the test run.
*/
public appendOutput(output: VSBuffer, taskId: string, location?: IRichLocation, testId?: string): void {
this.output.append(output);
const message: ITestOutputMessage = {
location,
message: output.toString(),
offset: this.output.offset,
type: TestMessageType.Info,
};
const index = this.mustGetTaskIndex(taskId);
if (testId) {
this.testById.get(testId)?.tasks[index].messages.push(message);
} else {
this.tasks[index].otherMessages.push(message);
}
}
/**
* Adds a new run task to the results.
*/
public addTask(task: ITestRunTask) {
const index = this.tasks.length;
this.tasks.push({ ...task, coverage: new MutableObservableValue(undefined), otherMessages: [] });
for (const test of this.tests) {
test.tasks.push({ duration: undefined, messages: [], state: TestResultState.Unset });
this.fireUpdateAndRefresh(test, index, TestResultState.Queued);
}
}
/**
* Add the chain of tests to the run. The first test in the chain should
* be either a test root, or a previously-known test.
*/
public addTestChainToRun(controllerId: string, chain: ReadonlyArray<ITestItem>) {
let parent = this.testById.get(chain[0].extId);
if (!parent) { // must be a test root
parent = this.addTestToRun(controllerId, chain[0], null);
}
for (let i = 1; i < chain.length; i++) {
parent = this.addTestToRun(controllerId, chain[i], parent.item.extId);
}
for (let i = 0; i < this.tasks.length; i++) {
this.fireUpdateAndRefresh(parent, i, TestResultState.Queued);
}
return undefined;
}
/**
* Updates the state of the test by its internal ID.
*/
public updateState(testId: string, taskId: string, state: TestResultState, duration?: number) {
const entry = this.testById.get(testId);
if (!entry) {
return;
}
const index = this.mustGetTaskIndex(taskId);
const oldTerminalStatePrio = terminalStatePriorities[entry.tasks[index].state];
const newTerminalStatePrio = terminalStatePriorities[state];
// Ignore requests to set the state from one terminal state back to a
// "lower" one, e.g. from failed back to passed:
if (oldTerminalStatePrio !== undefined &&
(newTerminalStatePrio === undefined || newTerminalStatePrio < oldTerminalStatePrio)) {
return;
}
this.fireUpdateAndRefresh(entry, index, state, duration);
}
/**
* Appends a message for the test in the run.
*/
public appendMessage(testId: string, taskId: string, message: ITestMessage) {
const entry = this.testById.get(testId);
if (!entry) {
return;
}
entry.tasks[this.mustGetTaskIndex(taskId)].messages.push(message);
this.changeEmitter.fire({
item: entry,
result: this,
reason: TestResultItemChangeReason.OwnStateChange,
previousState: entry.ownComputedState,
previousOwnDuration: entry.ownDuration,
});
}
/**
* @inheritdoc
*/
public getOutput() {
return this.output.read();
}
/**
* Marks the task in the test run complete.
*/
public markTaskComplete(taskId: string) {
this.tasks[this.mustGetTaskIndex(taskId)].running = false;
this.setAllToState(
TestResultState.Unset,
taskId,
t => t.state === TestResultState.Queued || t.state === TestResultState.Running,
);
}
/**
* Notifies the service that all tests are complete.
*/
public markComplete() {
if (this._completedAt !== undefined) {
throw new Error('cannot complete a test result multiple times');
}
for (const task of this.tasks) {
if (task.running) {
this.markTaskComplete(task.id);
}
}
this._completedAt = Date.now();
this.completeEmitter.fire();
}
/**
* @inheritdoc
*/
public toJSON(): ISerializedTestResults | undefined {
return this.completedAt && this.persist ? this.doSerialize.getValue() : undefined;
}
/**
* Updates all tests in the collection to the given state.
*/
protected setAllToState(state: TestResultState, taskId: string, when: (task: ITestTaskState, item: TestResultItem) => boolean) {
const index = this.mustGetTaskIndex(taskId);
for (const test of this.testById.values()) {
if (when(test.tasks[index], test)) {
this.fireUpdateAndRefresh(test, index, state);
}
}
}
private fireUpdateAndRefresh(entry: TestResultItem, taskIndex: number, newState: TestResultState, newOwnDuration?: number) {
const previousOwnComputed = entry.ownComputedState;
const previousOwnDuration = entry.ownDuration;
const changeEvent: TestResultItemChange = {
item: entry,
result: this,
reason: TestResultItemChangeReason.OwnStateChange,
previousState: previousOwnComputed,
previousOwnDuration: previousOwnDuration,
};
entry.tasks[taskIndex].state = newState;
if (newOwnDuration !== undefined) {
entry.tasks[taskIndex].duration = newOwnDuration;
entry.ownDuration = Math.max(entry.ownDuration || 0, newOwnDuration);
}
const newOwnComputed = maxPriority(...entry.tasks.map(t => t.state));
if (newOwnComputed === previousOwnComputed) {
if (newOwnDuration !== previousOwnDuration) {
this.changeEmitter.fire(changeEvent); // fire manually since state change won't do it
}
return;
}
entry.ownComputedState = newOwnComputed;
this.counts[previousOwnComputed]--;
this.counts[newOwnComputed]++;
refreshComputedState(this.computedStateAccessor, entry).forEach(t =>
this.changeEmitter.fire(t === entry ? changeEvent : {
item: t,
result: this,
reason: TestResultItemChangeReason.ComputedStateChange,
}),
);
}
private addTestToRun(controllerId: string, item: ITestItem, parent: string | null) {
const node = itemToNode(controllerId, item, parent);
this.testById.set(item.extId, node);
this.counts[TestResultState.Unset]++;
if (parent) {
this.testById.get(parent)?.children.push(node);
}
if (this.tasks.length) {
for (let i = 0; i < this.tasks.length; i++) {
node.tasks.push({ duration: undefined, messages: [], state: TestResultState.Queued });
}
}
return node;
}
private mustGetTaskIndex(taskId: string) {
const index = this.tasks.findIndex(t => t.id === taskId);
if (index === -1) {
throw new Error(`Unknown task ${taskId} in updateState`);
}
return index;
}
private readonly doSerialize = new Lazy((): ISerializedTestResults => ({
id: this.id,
completedAt: this.completedAt!,
tasks: this.tasks.map(t => ({ id: t.id, name: t.name, messages: t.otherMessages })),
name: this.name,
request: this.request,
items: [...this.testById.values()].map(e => TestResultItem.serialize(e, [...e.children.map(c => c.item.extId)])),
}));
}
/**
* Test results hydrated from a previously-serialized test run.
*/
export class HydratedTestResult implements ITestResult {
/**
* @inheritdoc
*/
public readonly counts = makeEmptyCounts();
/**
* @inheritdoc
*/
public readonly id: string;
/**
* @inheritdoc
*/
public readonly completedAt: number;
/**
* @inheritdoc
*/
public readonly tasks: ITestRunTaskResults[];
/**
* @inheritdoc
*/
public get tests() {
return this.testById.values();
}
/**
* @inheritdoc
*/
public readonly name: string;
/**
* @inheritdoc
*/
public readonly request: ResolvedTestRunRequest;
private readonly testById = new Map<string, TestResultItem>();
constructor(
private readonly serialized: ISerializedTestResults,
private readonly outputLoader: () => Promise<VSBufferReadableStream>,
private readonly persist = true,
) {
this.id = serialized.id;
this.completedAt = serialized.completedAt;
this.tasks = serialized.tasks.map((task, i) => ({
id: task.id,
name: task.name,
running: false,
coverage: staticObservableValue(undefined),
otherMessages: task.messages.map(m => ({
message: m.message,
type: m.type,
offset: m.offset,
location: m.location && {
uri: URI.revive(m.location.uri),
range: Range.lift(m.location.range)
},
}))
}));
this.name = serialized.name;
this.request = serialized.request;
for (const item of serialized.items) {
const cast: TestResultItem = { ...item } as any;
cast.item.uri = URI.revive(cast.item.uri);
for (const task of cast.tasks) {
for (const message of task.messages) {
if (message.location) {
message.location.uri = URI.revive(message.location.uri);
message.location.range = Range.lift(message.location.range);
}
}
}
this.counts[item.ownComputedState]++;
this.testById.set(item.item.extId, cast);
}
}
/**
* @inheritdoc
*/
public getStateById(extTestId: string) {
return this.testById.get(extTestId);
}
/**
* @inheritdoc
*/
public getOutput() {
return this.outputLoader();
}
/**
* @inheritdoc
*/
public toJSON(): ISerializedTestResults | undefined {
return this.persist ? this.serialized : undefined;
}
}
|