Add rustdoc JS non-std tests
This commit is contained in:
Guillaume Gomez
parent
da573206f8
commit
834347ddaf
6 changed files with 420 additions and 1 deletions
|
|
@ -406,6 +406,7 @@ impl<'a> Builder<'a> {
|
|||
test::Clippy,
|
||||
test::CompiletestTest,
|
||||
test::RustdocJS,
|
||||
test::RustdocJSNotStd,
|
||||
test::RustdocTheme,
|
||||
// Run bootstrap close to the end as it's unlikely to fail
|
||||
test::Bootstrap,
|
||||
|
|
|
|||
|
|
@ -612,6 +612,50 @@ impl Step for RustdocJS {
|
|||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
|
||||
pub struct RustdocJSNotStd {
|
||||
pub host: Interned<String>,
|
||||
pub target: Interned<String>,
|
||||
pub compiler: Compiler,
|
||||
}
|
||||
|
||||
impl Step for RustdocJSNotStd {
|
||||
type Output = ();
|
||||
const DEFAULT: bool = true;
|
||||
const ONLY_HOSTS: bool = true;
|
||||
|
||||
fn should_run(run: ShouldRun) -> ShouldRun {
|
||||
run.path("src/test/rustdoc-js-not-std")
|
||||
}
|
||||
|
||||
fn make_run(run: RunConfig) {
|
||||
let compiler = run.builder.compiler(run.builder.top_stage, run.host);
|
||||
run.builder.ensure(RustdocJSNotStd {
|
||||
host: run.host,
|
||||
target: run.target,
|
||||
compiler,
|
||||
});
|
||||
}
|
||||
|
||||
fn run(self, builder: &Builder) {
|
||||
if let Some(ref nodejs) = builder.config.nodejs {
|
||||
let mut command = Command::new(nodejs);
|
||||
command.args(&["src/tools/rustdoc-js-not-std/tester.js",
|
||||
&*self.host,
|
||||
builder.top_stage.to_string().as_str()]);
|
||||
builder.ensure(crate::doc::Std {
|
||||
target: self.target,
|
||||
stage: builder.top_stage,
|
||||
});
|
||||
builder.run(&mut command);
|
||||
} else {
|
||||
builder.info(
|
||||
"No nodejs found, skipping \"src/test/rustdoc-js-not-std\" tests"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
|
||||
pub struct RustdocUi {
|
||||
pub host: Interned<String>,
|
||||
|
|
|
|||
7
src/test/rustdoc-js-not-std/basic.js
Normal file
7
src/test/rustdoc-js-not-std/basic.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
const QUERY = 'Fo';
|
||||
|
||||
const EXPECTED = {
|
||||
'others': [
|
||||
{ 'path': 'basic', 'name': 'Foo' },
|
||||
],
|
||||
};
|
||||
1
src/test/rustdoc-js-not-std/basic.rs
Normal file
1
src/test/rustdoc-js-not-std/basic.rs
Normal file
|
|
@ -0,0 +1 @@
|
|||
pub struct Foo;
|
||||
365
src/tools/rustdoc-js-not-std/tester.js
Normal file
365
src/tools/rustdoc-js-not-std/tester.js
Normal file
|
|
@ -0,0 +1,365 @@
|
|||
const fs = require('fs');
|
||||
const { spawnSync } = require('child_process');
|
||||
|
||||
const TEST_FOLDER = 'src/test/rustdoc-js-not-std/';
|
||||
|
||||
function getNextStep(content, pos, stop) {
|
||||
while (pos < content.length && content[pos] !== stop &&
|
||||
(content[pos] === ' ' || content[pos] === '\t' || content[pos] === '\n')) {
|
||||
pos += 1;
|
||||
}
|
||||
if (pos >= content.length) {
|
||||
return null;
|
||||
}
|
||||
if (content[pos] !== stop) {
|
||||
return pos * -1;
|
||||
}
|
||||
return pos;
|
||||
}
|
||||
|
||||
// Stupid function extractor based on indent. Doesn't support block
|
||||
// comments. If someone puts a ' or an " in a block comment this
|
||||
// will blow up. Template strings are not tested and might also be
|
||||
// broken.
|
||||
function extractFunction(content, functionName) {
|
||||
var indent = 0;
|
||||
var splitter = "function " + functionName + "(";
|
||||
|
||||
while (true) {
|
||||
var start = content.indexOf(splitter);
|
||||
if (start === -1) {
|
||||
break;
|
||||
}
|
||||
var pos = start;
|
||||
while (pos < content.length && content[pos] !== ')') {
|
||||
pos += 1;
|
||||
}
|
||||
if (pos >= content.length) {
|
||||
break;
|
||||
}
|
||||
pos = getNextStep(content, pos + 1, '{');
|
||||
if (pos === null) {
|
||||
break;
|
||||
} else if (pos < 0) {
|
||||
content = content.slice(-pos);
|
||||
continue;
|
||||
}
|
||||
while (pos < content.length) {
|
||||
// Eat single-line comments
|
||||
if (content[pos] === '/' && pos > 0 && content[pos-1] === '/') {
|
||||
do {
|
||||
pos += 1;
|
||||
} while (pos < content.length && content[pos] !== '\n');
|
||||
|
||||
// Eat quoted strings
|
||||
} else if (content[pos] === '"' || content[pos] === "'" || content[pos] === "`") {
|
||||
var stop = content[pos];
|
||||
var is_escaped = false;
|
||||
do {
|
||||
if (content[pos] === '\\') {
|
||||
pos += 2;
|
||||
} else {
|
||||
pos += 1;
|
||||
}
|
||||
} while (pos < content.length &&
|
||||
(content[pos] !== stop || content[pos - 1] === '\\'));
|
||||
|
||||
// Otherwise, check for indent
|
||||
} else if (content[pos] === '{') {
|
||||
indent += 1;
|
||||
} else if (content[pos] === '}') {
|
||||
indent -= 1;
|
||||
if (indent === 0) {
|
||||
return content.slice(start, pos + 1);
|
||||
}
|
||||
}
|
||||
pos += 1;
|
||||
}
|
||||
content = content.slice(start + 1);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Stupid function extractor for array.
|
||||
function extractArrayVariable(content, arrayName) {
|
||||
var splitter = "var " + arrayName;
|
||||
while (true) {
|
||||
var start = content.indexOf(splitter);
|
||||
if (start === -1) {
|
||||
break;
|
||||
}
|
||||
var pos = getNextStep(content, start, '=');
|
||||
if (pos === null) {
|
||||
break;
|
||||
} else if (pos < 0) {
|
||||
content = content.slice(-pos);
|
||||
continue;
|
||||
}
|
||||
pos = getNextStep(content, pos, '[');
|
||||
if (pos === null) {
|
||||
break;
|
||||
} else if (pos < 0) {
|
||||
content = content.slice(-pos);
|
||||
continue;
|
||||
}
|
||||
while (pos < content.length) {
|
||||
if (content[pos] === '"' || content[pos] === "'") {
|
||||
var stop = content[pos];
|
||||
do {
|
||||
if (content[pos] === '\\') {
|
||||
pos += 2;
|
||||
} else {
|
||||
pos += 1;
|
||||
}
|
||||
} while (pos < content.length &&
|
||||
(content[pos] !== stop || content[pos - 1] === '\\'));
|
||||
} else if (content[pos] === ']' &&
|
||||
pos + 1 < content.length &&
|
||||
content[pos + 1] === ';') {
|
||||
return content.slice(start, pos + 2);
|
||||
}
|
||||
pos += 1;
|
||||
}
|
||||
content = content.slice(start + 1);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Stupid function extractor for variable.
|
||||
function extractVariable(content, varName) {
|
||||
var splitter = "var " + varName;
|
||||
while (true) {
|
||||
var start = content.indexOf(splitter);
|
||||
if (start === -1) {
|
||||
break;
|
||||
}
|
||||
var pos = getNextStep(content, start, '=');
|
||||
if (pos === null) {
|
||||
break;
|
||||
} else if (pos < 0) {
|
||||
content = content.slice(-pos);
|
||||
continue;
|
||||
}
|
||||
while (pos < content.length) {
|
||||
if (content[pos] === '"' || content[pos] === "'") {
|
||||
var stop = content[pos];
|
||||
do {
|
||||
if (content[pos] === '\\') {
|
||||
pos += 2;
|
||||
} else {
|
||||
pos += 1;
|
||||
}
|
||||
} while (pos < content.length &&
|
||||
(content[pos] !== stop || content[pos - 1] === '\\'));
|
||||
} else if (content[pos] === ';') {
|
||||
return content.slice(start, pos + 1);
|
||||
}
|
||||
pos += 1;
|
||||
}
|
||||
content = content.slice(start + 1);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function loadContent(content) {
|
||||
var Module = module.constructor;
|
||||
var m = new Module();
|
||||
m._compile(content, "tmp.js");
|
||||
m.exports.ignore_order = content.indexOf("\n// ignore-order\n") !== -1 ||
|
||||
content.startsWith("// ignore-order\n");
|
||||
m.exports.exact_check = content.indexOf("\n// exact-check\n") !== -1 ||
|
||||
content.startsWith("// exact-check\n");
|
||||
m.exports.should_fail = content.indexOf("\n// should-fail\n") !== -1 ||
|
||||
content.startsWith("// should-fail\n");
|
||||
return m.exports;
|
||||
}
|
||||
|
||||
function readFile(filePath) {
|
||||
return fs.readFileSync(filePath, 'utf8');
|
||||
}
|
||||
|
||||
function loadThings(thingsToLoad, kindOfLoad, funcToCall, fileContent) {
|
||||
var content = '';
|
||||
for (var i = 0; i < thingsToLoad.length; ++i) {
|
||||
var tmp = funcToCall(fileContent, thingsToLoad[i]);
|
||||
if (tmp === null) {
|
||||
console.error('unable to find ' + kindOfLoad + ' "' + thingsToLoad[i] + '"');
|
||||
process.exit(1);
|
||||
}
|
||||
content += tmp;
|
||||
content += 'exports.' + thingsToLoad[i] + ' = ' + thingsToLoad[i] + ';';
|
||||
}
|
||||
return content;
|
||||
}
|
||||
|
||||
function lookForEntry(entry, data) {
|
||||
for (var i = 0; i < data.length; ++i) {
|
||||
var allGood = true;
|
||||
for (var key in entry) {
|
||||
if (!entry.hasOwnProperty(key)) {
|
||||
continue;
|
||||
}
|
||||
var value = data[i][key];
|
||||
// To make our life easier, if there is a "parent" type, we add it to the path.
|
||||
if (key === 'path' && data[i]['parent'] !== undefined) {
|
||||
if (value.length > 0) {
|
||||
value += '::' + data[i]['parent']['name'];
|
||||
} else {
|
||||
value = data[i]['parent']['name'];
|
||||
}
|
||||
}
|
||||
if (value !== entry[key]) {
|
||||
allGood = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (allGood === true) {
|
||||
return i;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function remove_docs(out_dir) {
|
||||
spawnSync('rm', ['-rf', out_dir]);
|
||||
}
|
||||
|
||||
function build_docs(out_dir, rustdoc_path, file_to_document) {
|
||||
remove_docs(out_dir);
|
||||
var c = spawnSync(rustdoc_path, [file_to_document, '-o', out_dir]);
|
||||
var s = '';
|
||||
if (c.error || c.stderr.length > 0) {
|
||||
if (c.stderr.length > 0) {
|
||||
s += '==> STDERR: ' + c.stderr + '\n';
|
||||
}
|
||||
s += '==> ERROR: ' + c.error;
|
||||
}
|
||||
return s;
|
||||
}
|
||||
|
||||
function load_files(out_folder, crate) {
|
||||
var mainJs = readFile(out_folder + "/main.js");
|
||||
var ALIASES = readFile(out_folder + "/aliases.js");
|
||||
var searchIndex = readFile(out_folder + "/search-index.js").split("\n");
|
||||
if (searchIndex[searchIndex.length - 1].length === 0) {
|
||||
searchIndex.pop();
|
||||
}
|
||||
searchIndex.pop();
|
||||
searchIndex = loadContent(searchIndex.join("\n") + '\nexports.searchIndex = searchIndex;');
|
||||
finalJS = "";
|
||||
|
||||
var arraysToLoad = ["itemTypes"];
|
||||
var variablesToLoad = ["MAX_LEV_DISTANCE", "MAX_RESULTS",
|
||||
"GENERICS_DATA", "NAME", "INPUTS_DATA", "OUTPUT_DATA",
|
||||
"TY_PRIMITIVE", "TY_KEYWORD",
|
||||
"levenshtein_row2"];
|
||||
// execQuery first parameter is built in getQuery (which takes in the search input).
|
||||
// execQuery last parameter is built in buildIndex.
|
||||
// buildIndex requires the hashmap from search-index.
|
||||
var functionsToLoad = ["buildHrefAndPath", "pathSplitter", "levenshtein", "validateResult",
|
||||
"getQuery", "buildIndex", "execQuery", "execSearch"];
|
||||
|
||||
finalJS += 'window = { "currentCrate": "' + crate + '" };\n';
|
||||
finalJS += 'var rootPath = "../";\n';
|
||||
finalJS += ALIASES;
|
||||
finalJS += loadThings(arraysToLoad, 'array', extractArrayVariable, mainJs);
|
||||
finalJS += loadThings(variablesToLoad, 'variable', extractVariable, mainJs);
|
||||
finalJS += loadThings(functionsToLoad, 'function', extractFunction, mainJs);
|
||||
|
||||
var loaded = loadContent(finalJS);
|
||||
return [loaded, loaded.buildIndex(searchIndex.searchIndex)];
|
||||
}
|
||||
|
||||
function main(argv) {
|
||||
if (argv.length !== 4) {
|
||||
console.error("USAGE: node tester.js [TOOLCHAIN] [STAGE]");
|
||||
return 1;
|
||||
}
|
||||
const toolchain = argv[2];
|
||||
const stage = argv[3];
|
||||
const rustdoc_path = './build/' + toolchain + '/stage' + stage + '/bin/rustdoc';
|
||||
|
||||
var errors = 0;
|
||||
|
||||
fs.readdirSync(TEST_FOLDER).forEach(function(file) {
|
||||
if (!file.endsWith('.js')) {
|
||||
return;
|
||||
}
|
||||
var test_name = file.substring(0, file.length - 3);
|
||||
process.stdout.write('Checking "' + test_name + '" ... ');
|
||||
var rust_file = TEST_FOLDER + test_name + '.rs';
|
||||
|
||||
if (!fs.existsSync(rust_file)) {
|
||||
console.error("FAILED");
|
||||
console.error("==> Missing '" + test_name + ".rs' file...");
|
||||
errors += 1;
|
||||
return;
|
||||
}
|
||||
|
||||
var out_folder = "build/" + toolchain + "/stage" + stage + "/tests/rustdoc-js-not-std/" +
|
||||
test_name;
|
||||
|
||||
var ret = build_docs(out_folder, rustdoc_path, rust_file);
|
||||
if (ret.length > 0) {
|
||||
console.error("FAILED");
|
||||
console.error(ret);
|
||||
errors += 1;
|
||||
return;
|
||||
}
|
||||
|
||||
var [loaded, index] = load_files(out_folder, test_name);
|
||||
var loadedFile = loadContent(readFile(TEST_FOLDER + file) +
|
||||
'exports.QUERY = QUERY;exports.EXPECTED = EXPECTED;');
|
||||
const expected = loadedFile.EXPECTED;
|
||||
const query = loadedFile.QUERY;
|
||||
const filter_crate = loadedFile.FILTER_CRATE;
|
||||
const ignore_order = loadedFile.ignore_order;
|
||||
const exact_check = loadedFile.exact_check;
|
||||
const should_fail = loadedFile.should_fail;
|
||||
var results = loaded.execSearch(loaded.getQuery(query), index);
|
||||
var error_text = [];
|
||||
for (var key in expected) {
|
||||
if (!expected.hasOwnProperty(key)) {
|
||||
continue;
|
||||
}
|
||||
if (!results.hasOwnProperty(key)) {
|
||||
error_text.push('==> Unknown key "' + key + '"');
|
||||
break;
|
||||
}
|
||||
var entry = expected[key];
|
||||
var prev_pos = -1;
|
||||
for (var i = 0; i < entry.length; ++i) {
|
||||
var entry_pos = lookForEntry(entry[i], results[key]);
|
||||
if (entry_pos === null) {
|
||||
error_text.push("==> Result not found in '" + key + "': '" +
|
||||
JSON.stringify(entry[i]) + "'");
|
||||
} else if (exact_check === true && prev_pos + 1 !== entry_pos) {
|
||||
error_text.push("==> Exact check failed at position " + (prev_pos + 1) + ": " +
|
||||
"expected '" + JSON.stringify(entry[i]) + "' but found '" +
|
||||
JSON.stringify(results[key][i]) + "'");
|
||||
} else if (ignore_order === false && entry_pos < prev_pos) {
|
||||
error_text.push("==> '" + JSON.stringify(entry[i]) + "' was supposed to be " +
|
||||
" before '" + JSON.stringify(results[key][entry_pos]) + "'");
|
||||
} else {
|
||||
prev_pos = entry_pos;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (error_text.length === 0 && should_fail === true) {
|
||||
errors += 1;
|
||||
console.error("FAILED");
|
||||
console.error("==> Test was supposed to fail but all items were found...");
|
||||
} else if (error_text.length !== 0 && should_fail === false) {
|
||||
errors += 1;
|
||||
console.error("FAILED");
|
||||
console.error(error_text.join("\n"));
|
||||
} else {
|
||||
// In this case, we remove the docs, no need to keep them around.
|
||||
remove_docs(out_folder);
|
||||
console.log("OK");
|
||||
}
|
||||
});
|
||||
return errors;
|
||||
}
|
||||
|
||||
process.exit(main(process.argv));
|
||||
|
|
@ -221,7 +221,8 @@ function lookForEntry(entry, data) {
|
|||
|
||||
function main(argv) {
|
||||
if (argv.length !== 3) {
|
||||
console.error("Expected toolchain to check as argument (for example 'x86_64-apple-darwin'");
|
||||
console.error("Expected toolchain to check as argument (for example \
|
||||
'x86_64-apple-darwin')");
|
||||
return 1;
|
||||
}
|
||||
var toolchain = argv[2];
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue