246 lines
8.3 KiB
TypeScript
246 lines
8.3 KiB
TypeScript
/**
|
||
* Copyright (c) Microsoft Corporation.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
import { codeFrameColumns } from '@babel/code-frame';
|
||
import colors from 'colors/safe';
|
||
import fs from 'fs';
|
||
// @ts-ignore
|
||
import milliseconds from 'ms';
|
||
import path from 'path';
|
||
import StackUtils from 'stack-utils';
|
||
import { FullConfig, TestStatus, Test, Suite, TestResult, TestError, Reporter, FullResult } from '../../../types/testReporter';
|
||
|
||
const stackUtils = new StackUtils();
|
||
|
||
export class BaseReporter implements Reporter {
|
||
duration = 0;
|
||
config!: FullConfig;
|
||
suite!: Suite;
|
||
result!: FullResult;
|
||
fileDurations = new Map<string, number>();
|
||
monotonicStartTime: number = 0;
|
||
|
||
onBegin(config: FullConfig, suite: Suite) {
|
||
this.monotonicStartTime = monotonicTime();
|
||
this.config = config;
|
||
this.suite = suite;
|
||
}
|
||
|
||
onStdOut(chunk: string | Buffer) {
|
||
if (!this.config.quiet)
|
||
process.stdout.write(chunk);
|
||
}
|
||
|
||
onStdErr(chunk: string | Buffer) {
|
||
if (!this.config.quiet)
|
||
process.stderr.write(chunk);
|
||
}
|
||
|
||
onTestEnd(test: Test, result: TestResult) {
|
||
const projectName = test.titlePath()[1];
|
||
const relativePath = relativeTestPath(this.config, test);
|
||
const fileAndProject = (projectName ? `[${projectName}] › ` : '') + relativePath;
|
||
const duration = this.fileDurations.get(fileAndProject) || 0;
|
||
this.fileDurations.set(fileAndProject, duration + result.duration);
|
||
}
|
||
|
||
onError(error: TestError) {
|
||
console.log(formatError(error));
|
||
}
|
||
|
||
async onEnd(result: FullResult) {
|
||
this.duration = monotonicTime() - this.monotonicStartTime;
|
||
this.result = result;
|
||
}
|
||
|
||
private _printSlowTests() {
|
||
if (!this.config.reportSlowTests)
|
||
return;
|
||
const fileDurations = [...this.fileDurations.entries()];
|
||
fileDurations.sort((a, b) => b[1] - a[1]);
|
||
const count = Math.min(fileDurations.length, this.config.reportSlowTests.max || Number.POSITIVE_INFINITY);
|
||
for (let i = 0; i < count; ++i) {
|
||
const duration = fileDurations[i][1];
|
||
if (duration <= this.config.reportSlowTests.threshold)
|
||
break;
|
||
console.log(colors.yellow(' Slow test: ') + fileDurations[i][0] + colors.yellow(` (${milliseconds(duration)})`));
|
||
}
|
||
}
|
||
|
||
epilogue(full: boolean) {
|
||
let skipped = 0;
|
||
let expected = 0;
|
||
const unexpected: Test[] = [];
|
||
const flaky: Test[] = [];
|
||
|
||
this.suite.allTests().forEach(test => {
|
||
switch (test.status()) {
|
||
case 'skipped': ++skipped; break;
|
||
case 'expected': ++expected; break;
|
||
case 'unexpected': unexpected.push(test); break;
|
||
case 'flaky': flaky.push(test); break;
|
||
}
|
||
});
|
||
|
||
if (full && unexpected.length) {
|
||
console.log('');
|
||
this._printFailures(unexpected);
|
||
}
|
||
|
||
this._printSlowTests();
|
||
|
||
console.log('');
|
||
if (unexpected.length) {
|
||
console.log(colors.red(` ${unexpected.length} failed`));
|
||
this._printTestHeaders(unexpected);
|
||
}
|
||
if (flaky.length) {
|
||
console.log(colors.red(` ${flaky.length} flaky`));
|
||
this._printTestHeaders(flaky);
|
||
}
|
||
if (skipped)
|
||
console.log(colors.yellow(` ${skipped} skipped`));
|
||
if (expected)
|
||
console.log(colors.green(` ${expected} passed`) + colors.dim(` (${milliseconds(this.duration)})`));
|
||
if (this.result.status === 'timedout')
|
||
console.log(colors.red(` Timed out waiting ${this.config.globalTimeout / 1000}s for the entire test run`));
|
||
}
|
||
|
||
private _printTestHeaders(tests: Test[]) {
|
||
tests.forEach(test => {
|
||
console.log(formatTestHeader(this.config, test, ' '));
|
||
});
|
||
}
|
||
|
||
private _printFailures(failures: Test[]) {
|
||
failures.forEach((test, index) => {
|
||
console.log(formatFailure(this.config, test, index + 1));
|
||
});
|
||
}
|
||
|
||
hasResultWithStatus(test: Test, status: TestStatus): boolean {
|
||
return !!test.results.find(r => r.status === status);
|
||
}
|
||
|
||
willRetry(test: Test, result: TestResult): boolean {
|
||
return result.status !== 'passed' && result.status !== test.expectedStatus && test.results.length <= test.retries;
|
||
}
|
||
}
|
||
|
||
export function formatFailure(config: FullConfig, test: Test, index?: number): string {
|
||
const tokens: string[] = [];
|
||
tokens.push(formatTestHeader(config, test, ' ', index));
|
||
for (const result of test.results) {
|
||
if (result.status === 'passed')
|
||
continue;
|
||
tokens.push(formatFailedResult(test, result));
|
||
}
|
||
tokens.push('');
|
||
return tokens.join('\n');
|
||
}
|
||
|
||
function relativeTestPath(config: FullConfig, test: Test): string {
|
||
return path.relative(config.rootDir, test.location.file) || path.basename(test.location.file);
|
||
}
|
||
|
||
export function formatTestTitle(config: FullConfig, test: Test): string {
|
||
// root, project, file, ...describes, test
|
||
const [, projectName, , ...titles] = test.titlePath();
|
||
const location = `${relativeTestPath(config, test)}:${test.location.line}:${test.location.column}`;
|
||
const projectTitle = projectName ? `[${projectName}] › ` : '';
|
||
return `${projectTitle}${location} › ${titles.join(' ')}`;
|
||
}
|
||
|
||
function formatTestHeader(config: FullConfig, test: Test, indent: string, index?: number): string {
|
||
const title = formatTestTitle(config, test);
|
||
const passedUnexpectedlySuffix = test.results[0].status === 'passed' ? ' -- passed unexpectedly' : '';
|
||
const header = `${indent}${index ? index + ') ' : ''}${title}${passedUnexpectedlySuffix}`;
|
||
return colors.red(pad(header, '='));
|
||
}
|
||
|
||
function formatFailedResult(test: Test, result: TestResult): string {
|
||
const tokens: string[] = [];
|
||
if (result.retry)
|
||
tokens.push(colors.gray(pad(`\n Retry #${result.retry}`, '-')));
|
||
if (result.status === 'timedOut') {
|
||
tokens.push('');
|
||
tokens.push(indent(colors.red(`Timeout of ${test.timeout}ms exceeded.`), ' '));
|
||
if (result.error !== undefined)
|
||
tokens.push(indent(formatError(result.error, test.location.file), ' '));
|
||
} else {
|
||
tokens.push(indent(formatError(result.error!, test.location.file), ' '));
|
||
}
|
||
return tokens.join('\n');
|
||
}
|
||
|
||
function formatError(error: TestError, file?: string) {
|
||
const stack = error.stack;
|
||
const tokens = [];
|
||
if (stack) {
|
||
tokens.push('');
|
||
const message = error.message || '';
|
||
const messageLocation = stack.indexOf(message);
|
||
const preamble = stack.substring(0, messageLocation + message.length);
|
||
tokens.push(preamble);
|
||
const position = file ? positionInFile(stack, file) : null;
|
||
if (position) {
|
||
const source = fs.readFileSync(file!, 'utf8');
|
||
tokens.push('');
|
||
tokens.push(codeFrameColumns(source, {
|
||
start: position,
|
||
},
|
||
{ highlightCode: colors.enabled }
|
||
));
|
||
}
|
||
tokens.push('');
|
||
tokens.push(colors.dim(preamble.length > 0 ? stack.substring(preamble.length + 1) : stack));
|
||
} else {
|
||
tokens.push('');
|
||
tokens.push(error.value);
|
||
}
|
||
return tokens.join('\n');
|
||
}
|
||
|
||
function pad(line: string, char: string): string {
|
||
return line + ' ' + colors.gray(char.repeat(Math.max(0, 100 - line.length - 1)));
|
||
}
|
||
|
||
function indent(lines: string, tab: string) {
|
||
return lines.replace(/^(?=.+$)/gm, tab);
|
||
}
|
||
|
||
function positionInFile(stack: string, file: string): { column: number; line: number; } | undefined {
|
||
// Stack will have /private/var/folders instead of /var/folders on Mac.
|
||
file = fs.realpathSync(file);
|
||
for (const line of stack.split('\n')) {
|
||
const parsed = stackUtils.parseLine(line);
|
||
if (!parsed || !parsed.file)
|
||
continue;
|
||
if (path.resolve(process.cwd(), parsed.file) === file)
|
||
return {column: parsed.column || 0, line: parsed.line || 0};
|
||
}
|
||
}
|
||
|
||
function monotonicTime(): number {
|
||
const [seconds, nanoseconds] = process.hrtime();
|
||
return seconds * 1000 + (nanoseconds / 1000000 | 0);
|
||
}
|
||
|
||
const asciiRegex = new RegExp('[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))', 'g');
|
||
export function stripAscii(str: string): string {
|
||
return str.replace(asciiRegex, '');
|
||
}
|