test::Miri,
test::Clippy,
test::CompiletestTest,
- test::RustdocJS,
+ test::RustdocJSStd,
test::RustdocJSNotStd,
test::RustdocTheme,
// Run bootstrap close to the end as it's unlikely to fail
}
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
-pub struct RustdocJS {
+pub struct RustdocJSStd {
pub host: Interned<String>,
pub target: Interned<String>,
}
-impl Step for RustdocJS {
+impl Step for RustdocJSStd {
type Output = ();
const DEFAULT: bool = true;
const ONLY_HOSTS: bool = true;
fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
- run.path("src/test/rustdoc-js")
+ run.path("src/test/rustdoc-js-std")
}
fn make_run(run: RunConfig<'_>) {
- run.builder.ensure(RustdocJS {
+ run.builder.ensure(RustdocJSStd {
host: run.host,
target: run.target,
});
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/tester.js", &*self.host]);
+ command.args(&["src/tools/rustdoc-js-std/tester.js", &*self.host]);
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\" tests"
+ "No nodejs found, skipping \"src/test/rustdoc-js-std\" tests"
);
}
}
const ONLY_HOSTS: bool = true;
fn should_run(run: ShouldRun) -> ShouldRun {
- run.path("src/test/rustdoc-js-not-std")
+ run.path("src/test/rustdoc-js")
}
fn make_run(run: RunConfig) {
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",
+ command.args(&["src/tools/rustdoc-js/tester.js",
&*self.host,
builder.top_stage.to_string().as_str()]);
builder.ensure(crate::doc::Std {
builder.run(&mut command);
} else {
builder.info(
- "No nodejs found, skipping \"src/test/rustdoc-js-not-std\" tests"
+ "No nodejs found, skipping \"src/test/rustdoc-js\" tests"
);
}
}
+++ /dev/null
-const QUERY = 'Fo';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'basic', 'name': 'Foo' },
- ],
-};
+++ /dev/null
-pub struct Foo;
--- /dev/null
+const QUERY = '&';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'reference' },
+ ],
+};
--- /dev/null
+// ignore-order
+
+const QUERY = '+';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::ops', 'name': 'AddAssign' },
+ { 'path': 'std::ops', 'name': 'Add' },
+ ],
+};
--- /dev/null
+const QUERY = '!';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'never' },
+ ],
+};
--- /dev/null
+// ignore-order
+
+const QUERY = '[';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'slice' },
+ { 'path': 'std::ops', 'name': 'IndexMut' },
+ { 'path': 'std::ops', 'name': 'Index' },
+ ],
+};
--- /dev/null
+const QUERY = 'String';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::string', 'name': 'String' },
+ { 'path': 'std::ffi', 'name': 'CString' },
+ { 'path': 'std::ffi', 'name': 'OsString' },
+ ],
+ 'in_args': [
+ { 'path': 'std::str', 'name': 'eq' },
+ ],
+ 'returned': [
+ { 'path': 'std::string::String', 'name': 'add' },
+ ],
+};
--- /dev/null
+// ignore-order
+
+const QUERY = 'is_nan';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::f32', 'name': 'is_nan' },
+ { 'path': 'std::f64', 'name': 'is_nan' },
+ { 'path': 'std::option::Option', 'name': 'is_none' },
+ ],
+};
--- /dev/null
+const QUERY = 'enum:Option';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::option', 'name': 'Option' },
+ ],
+};
--- /dev/null
+// exact-check
+
+const QUERY = 'hashmap';
+const FILTER_CRATE = 'core';
+
+const EXPECTED = {
+ 'others': [
+ ],
+};
--- /dev/null
+const QUERY = 'fn:forget';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::mem', 'name': 'forget' },
+ { 'path': 'std::fmt', 'name': 'format' },
+ ],
+};
--- /dev/null
+const QUERY = 'from_u';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::char', 'name': 'from_u32' },
+ { 'path': 'std::str', 'name': 'from_utf8' },
+ { 'path': 'std::string::String', 'name': 'from_utf8' },
+ ],
+};
--- /dev/null
+// ignore-order
+
+const QUERY = 'fn';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'fn', ty: 15 }, // 15 is for primitive types
+ { 'path': 'std', 'name': 'fn', ty: 21 }, // 21 is for keywords
+ ],
+};
--- /dev/null
+// ignore-order
+
+const QUERY = 'panic';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'panic', ty: 14 }, // 15 is for macros
+ { 'path': 'std', 'name': 'panic', ty: 0 }, // 0 is for modules
+ ],
+};
--- /dev/null
+const QUERY = 'macro:print';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'print' },
+ { 'path': 'std', 'name': 'eprint' },
+ { 'path': 'std', 'name': 'println' },
+ { 'path': 'std', 'name': 'eprintln' },
+ ],
+};
--- /dev/null
+const QUERY = 'str,u8';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'str' },
+ { 'path': 'std', 'name': 'u8' },
+ { 'path': 'std::ffi', 'name': 'CStr' },
+ ],
+};
--- /dev/null
+const QUERY = '!';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'never' },
+ ],
+};
--- /dev/null
+const QUERY = '"error"';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'error' },
+ { 'path': 'std::fmt', 'name': 'Error' },
+ { 'path': 'std::io', 'name': 'Error' },
+ ],
+ 'in_args': [],
+ 'returned': [
+ { 'path': 'std::fmt::LowerExp', 'name': 'fmt' },
+ ],
+};
--- /dev/null
+// should-fail
+
+const QUERY = 'fn';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std', 'name': 'fn', ty: 14 },
+ ],
+};
--- /dev/null
+const QUERY = 'String::from_ut';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::string::String', 'name': 'from_utf8' },
+ { 'path': 'std::string::String', 'name': 'from_utf8' },
+ { 'path': 'std::string::String', 'name': 'from_utf8_lossy' },
+ { 'path': 'std::string::String', 'name': 'from_utf16_lossy' },
+ { 'path': 'std::string::String', 'name': 'from_utf8_unchecked' },
+ ],
+};
--- /dev/null
+const QUERY = 'struct:Vec';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::vec', 'name': 'Vec' },
+ { 'path': 'std::collections', 'name': 'VecDeque' },
+ ],
+};
--- /dev/null
+const QUERY = 'Vec::new';
+
+const EXPECTED = {
+ 'others': [
+ { 'path': 'std::vec::Vec', 'name': 'new' },
+ { 'path': 'std::vec::Vec', 'name': 'ne' },
+ ],
+};
+++ /dev/null
-const QUERY = '&';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'reference' },
- ],
-};
+++ /dev/null
-// ignore-order
-
-const QUERY = '+';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::ops', 'name': 'AddAssign' },
- { 'path': 'std::ops', 'name': 'Add' },
- ],
-};
+++ /dev/null
-const QUERY = '!';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'never' },
- ],
-};
+++ /dev/null
-// ignore-order
-
-const QUERY = '[';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'slice' },
- { 'path': 'std::ops', 'name': 'IndexMut' },
- { 'path': 'std::ops', 'name': 'Index' },
- ],
-};
-const QUERY = 'String';
+const QUERY = 'Fo';
const EXPECTED = {
'others': [
- { 'path': 'std::string', 'name': 'String' },
- { 'path': 'std::ffi', 'name': 'CString' },
- { 'path': 'std::ffi', 'name': 'OsString' },
- ],
- 'in_args': [
- { 'path': 'std::str', 'name': 'eq' },
- ],
- 'returned': [
- { 'path': 'std::string::String', 'name': 'add' },
+ { 'path': 'basic', 'name': 'Foo' },
],
};
--- /dev/null
+pub struct Foo;
+++ /dev/null
-// ignore-order
-
-const QUERY = 'is_nan';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::f32', 'name': 'is_nan' },
- { 'path': 'std::f64', 'name': 'is_nan' },
- { 'path': 'std::option::Option', 'name': 'is_none' },
- ],
-};
+++ /dev/null
-const QUERY = 'enum:Option';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::option', 'name': 'Option' },
- ],
-};
+++ /dev/null
-// exact-check
-
-const QUERY = 'hashmap';
-const FILTER_CRATE = 'core';
-
-const EXPECTED = {
- 'others': [
- ],
-};
+++ /dev/null
-const QUERY = 'fn:forget';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::mem', 'name': 'forget' },
- { 'path': 'std::fmt', 'name': 'format' },
- ],
-};
+++ /dev/null
-const QUERY = 'from_u';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::char', 'name': 'from_u32' },
- { 'path': 'std::str', 'name': 'from_utf8' },
- { 'path': 'std::string::String', 'name': 'from_utf8' },
- ],
-};
+++ /dev/null
-// ignore-order
-
-const QUERY = 'fn';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'fn', ty: 15 }, // 15 is for primitive types
- { 'path': 'std', 'name': 'fn', ty: 21 }, // 21 is for keywords
- ],
-};
+++ /dev/null
-// ignore-order
-
-const QUERY = 'panic';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'panic', ty: 14 }, // 15 is for macros
- { 'path': 'std', 'name': 'panic', ty: 0 }, // 0 is for modules
- ],
-};
+++ /dev/null
-const QUERY = 'macro:print';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'print' },
- { 'path': 'std', 'name': 'eprint' },
- { 'path': 'std', 'name': 'println' },
- { 'path': 'std', 'name': 'eprintln' },
- ],
-};
+++ /dev/null
-const QUERY = 'str,u8';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'str' },
- { 'path': 'std', 'name': 'u8' },
- { 'path': 'std::ffi', 'name': 'CStr' },
- ],
-};
+++ /dev/null
-const QUERY = '!';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'never' },
- ],
-};
+++ /dev/null
-const QUERY = '"error"';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'error' },
- { 'path': 'std::fmt', 'name': 'Error' },
- { 'path': 'std::io', 'name': 'Error' },
- ],
- 'in_args': [],
- 'returned': [
- { 'path': 'std::fmt::LowerExp', 'name': 'fmt' },
- ],
-};
+++ /dev/null
-// should-fail
-
-const QUERY = 'fn';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std', 'name': 'fn', ty: 14 },
- ],
-};
+++ /dev/null
-const QUERY = 'String::from_ut';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::string::String', 'name': 'from_utf8' },
- { 'path': 'std::string::String', 'name': 'from_utf8' },
- { 'path': 'std::string::String', 'name': 'from_utf8_lossy' },
- { 'path': 'std::string::String', 'name': 'from_utf16_lossy' },
- { 'path': 'std::string::String', 'name': 'from_utf8_unchecked' },
- ],
-};
+++ /dev/null
-const QUERY = 'struct:Vec';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::vec', 'name': 'Vec' },
- { 'path': 'std::collections', 'name': 'VecDeque' },
- ],
-};
+++ /dev/null
-const QUERY = 'Vec::new';
-
-const EXPECTED = {
- 'others': [
- { 'path': 'std::vec::Vec', 'name': 'new' },
- { 'path': 'std::vec::Vec', 'name': 'ne' },
- ],
-};
+++ /dev/null
-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));
--- /dev/null
+const fs = require('fs');
+
+const TEST_FOLDER = 'src/test/rustdoc-js-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 main(argv) {
+ if (argv.length !== 3) {
+ console.error("Expected toolchain to check as argument (for example \
+ 'x86_64-apple-darwin')");
+ return 1;
+ }
+ var toolchain = argv[2];
+
+ var mainJs = readFile("build/" + toolchain + "/doc/main.js");
+ var ALIASES = readFile("build/" + toolchain + "/doc/aliases.js");
+ var searchIndex = readFile("build/" + toolchain + "/doc/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": "std" };\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);
+ var index = loaded.buildIndex(searchIndex.searchIndex);
+
+ var errors = 0;
+
+ fs.readdirSync(TEST_FOLDER).forEach(function(file) {
+ 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);
+ process.stdout.write('Checking "' + file + '" ... ');
+ 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 {
+ console.log("OK");
+ }
+ });
+ return errors;
+}
+
+process.exit(main(process.argv));
const fs = require('fs');
+const { spawnSync } = require('child_process');
const TEST_FOLDER = 'src/test/rustdoc-js/';
return null;
}
-function main(argv) {
- if (argv.length !== 3) {
- console.error("Expected toolchain to check as argument (for example \
- 'x86_64-apple-darwin')");
- return 1;
+function build_docs(out_dir, rustdoc_path, file_to_document) {
+ 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;
}
- var toolchain = argv[2];
+ return s;
+}
- var mainJs = readFile("build/" + toolchain + "/doc/main.js");
- var ALIASES = readFile("build/" + toolchain + "/doc/aliases.js");
- var searchIndex = readFile("build/" + toolchain + "/doc/search-index.js").split("\n");
+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();
}
var functionsToLoad = ["buildHrefAndPath", "pathSplitter", "levenshtein", "validateResult",
"getQuery", "buildIndex", "execQuery", "execSearch"];
- finalJS += 'window = { "currentCrate": "std" };\n';
+ finalJS += 'window = { "currentCrate": "' + crate + '" };\n';
finalJS += 'var rootPath = "../";\n';
finalJS += ALIASES;
finalJS += loadThings(arraysToLoad, 'array', extractArrayVariable, mainJs);
finalJS += loadThings(functionsToLoad, 'function', extractFunction, mainJs);
var loaded = loadContent(finalJS);
- var index = loaded.buildIndex(searchIndex.searchIndex);
+ 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/" +
+ 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 exact_check = loadedFile.exact_check;
const should_fail = loadedFile.should_fail;
var results = loaded.execSearch(loaded.getQuery(query), index);
- process.stdout.write('Checking "' + file + '" ... ');
var error_text = [];
for (var key in expected) {
if (!expected.hasOwnProperty(key)) {
projects / rust.git / commitdiff