Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test_runner: parse yaml #45815

Merged
merged 12 commits into from Dec 13, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 2 additions & 12 deletions lib/internal/test_runner/runner.js
Expand Up @@ -4,7 +4,6 @@ const {
ArrayPrototypeFilter,
ArrayPrototypeForEach,
ArrayPrototypeIncludes,
ArrayPrototypeJoin,
ArrayPrototypePush,
ArrayPrototypeSlice,
ArrayPrototypeSort,
Expand Down Expand Up @@ -35,6 +34,7 @@ const { kEmptyObject } = require('internal/util');
const { createTestTree } = require('internal/test_runner/harness');
const { kDefaultIndent, kSubtestsFailed, Test } = require('internal/test_runner/test');
const { TapParser } = require('internal/test_runner/tap_parser');
const { YAMLToJs } = require('internal/test_runner/yaml_parser');
const { TokenKind } = require('internal/test_runner/tap_lexer');

const {
Expand Down Expand Up @@ -130,17 +130,7 @@ class FileTest extends Test {
#handleReportItem({ kind, node, nesting = 0 }) {
const indent = StringPrototypeRepeat(kDefaultIndent, nesting + 1);

const details = (diagnostic) => {
return (
diagnostic && {
__proto__: null,
yaml:
`${indent} ` +
ArrayPrototypeJoin(diagnostic, `\n${indent} `) +
'\n',
}
);
};
const details = (diagnostic) => diagnostic && YAMLToJs(diagnostic);
MoLow marked this conversation as resolved.
Show resolved Hide resolved

switch (kind) {
case TokenKind.TAP_VERSION:
Expand Down
5 changes: 2 additions & 3 deletions lib/internal/test_runner/tap_stream.js
Expand Up @@ -83,11 +83,10 @@ class TapStream extends Readable {
}

#details(indent, data = kEmptyObject) {
const { error, duration, yaml } = data;
const { error, duration_ms } = data;
let details = `${indent} ---\n`;

details += `${yaml ? yaml : ''}`;
details += jsToYaml(indent, 'duration_ms', duration);
details += jsToYaml(indent, 'duration_ms', duration_ms);
details += jsToYaml(indent, null, error);
details += `${indent} ...\n`;
this.#tryPush(details);
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/test_runner/test.js
Expand Up @@ -680,7 +680,7 @@ class Test extends AsyncResource {
this.reportSubtest();
}
let directive;
const details = { __proto__: null, duration: this.#duration() };
const details = { __proto__: null, duration_ms: this.#duration() };

if (this.skipped) {
directive = this.reporter.getSkip(this.message);
Expand Down
116 changes: 116 additions & 0 deletions lib/internal/test_runner/yaml_parser.js
@@ -0,0 +1,116 @@
'use strict';
const {
codes: {
ERR_TEST_FAILURE,
}
} = require('internal/errors');
const AssertionError = require('internal/assert/assertion_error');
const {
ArrayPrototypeJoin,
ArrayPrototypePush,
Error,
Number,
NumberIsNaN,
ObjectCreate,
RegExpPrototypeExec,
StringPrototypeEndsWith,
StringPrototypeRepeat,
StringPrototypeSlice,
StringPrototypeStartsWith,
StringPrototypeSubstring,
} = primordials;

const kYamlKeyRegex = /^(\s+)?(\w+):(\s)+([>|][-+])?(.*)$/;
const kStackDelimiter = ' at ';
MoLow marked this conversation as resolved.
Show resolved Hide resolved

function reConstructError(parsedYaml) {
if (!('error' in parsedYaml)) {
return parsedYaml;
}
const isAssertionError = parsedYaml.code === 'ERR_ASSERTION' ||
'actual' in parsedYaml || 'expected' in parsedYaml || 'operator' in parsedYaml;
const isTestFailure = parsedYaml.code === 'ERR_TEST_FAILURE' || 'failureType' in parsedYaml;
const stack = parsedYaml.stack ? kStackDelimiter + ArrayPrototypeJoin(parsedYaml.stack, `\n${kStackDelimiter}`) : '';
let error, cause;

if (isAssertionError) {
cause = new AssertionError({
message: parsedYaml.error,
actual: parsedYaml.actual,
expected: parsedYaml.expected,
operator: parsedYaml.operator
});
} else {
// eslint-disable-next-line no-restricted-syntax
cause = new Error(parsedYaml.error);
cause.code = parsedYaml.code;
}
cause.stack = stack;

if (isTestFailure) {
error = new ERR_TEST_FAILURE(cause, parsedYaml.failureType);
error.stack = stack;
}

parsedYaml.error = error ?? cause;
delete parsedYaml.stack;
delete parsedYaml.code;
delete parsedYaml.failureType;
delete parsedYaml.actual;
delete parsedYaml.expected;
delete parsedYaml.operator;

return parsedYaml;
}

function getYamlValue(value) {
if (StringPrototypeStartsWith(value, "'") && StringPrototypeEndsWith(value, "'")) {
return StringPrototypeSlice(value, 1, -1);
}
if (value === 'true') {
return true;
}
if (value === 'false') {
return false;
}
MoLow marked this conversation as resolved.
Show resolved Hide resolved
if (value !== '' && !NumberIsNaN(value)) {
return Number(value);
MoLow marked this conversation as resolved.
Show resolved Hide resolved
}
return value;
}

// This parses the yaml generated by the TAP reporter in tap_stream.js#jsToYaml
MoLow marked this conversation as resolved.
Show resolved Hide resolved
// the yaml is a subset of the full yaml spec, so we there might be some
MoLow marked this conversation as resolved.
Show resolved Hide resolved
// YAML features that won't be parsed here
MoLow marked this conversation as resolved.
Show resolved Hide resolved
function YAMLToJs(lines) {
const result = ObjectCreate(null);
MoLow marked this conversation as resolved.
Show resolved Hide resolved
let isInYamlBlock = false;
for (let i = 0; i < lines.length; i++) {
const line = lines[i];
if (isInYamlBlock && !StringPrototypeStartsWith(line, StringPrototypeRepeat(' ', isInYamlBlock.indent))) {
result[isInYamlBlock.key] = isInYamlBlock.key === 'stack' ?
result[isInYamlBlock.key] : ArrayPrototypeJoin(result[isInYamlBlock.key], '\n');
isInYamlBlock = false;
}
if (isInYamlBlock) {
const blockLine = StringPrototypeSubstring(line, isInYamlBlock.indent);
ArrayPrototypePush(result[isInYamlBlock.key], blockLine);
continue;
}
const match = RegExpPrototypeExec(kYamlKeyRegex, line);
if (match !== null) {
const { 1: leadingSpaces, 2: key, 4: block, 5: value } = match;
if (block) {
isInYamlBlock = { key, indent: (leadingSpaces?.length ?? 0) + 2 };
result[key] = [];
} else {
result[key] = getYamlValue(value);
}
}
}
return reConstructError(result);
}

module.exports = {
YAMLToJs,
};
6 changes: 6 additions & 0 deletions test/message/test_runner_output_cli.js
@@ -0,0 +1,6 @@
// Flags: --no-warnings
'use strict';
require('../common');
const spawn = require('node:child_process').spawn;
spawn(process.execPath,
['--no-warnings', '--test', 'test/message/test_runner_output.js'], { stdio: 'inherit' });