1 // This package needs to be install:
4 // npm install browser-ui-test
7 const fs = require("fs");
8 const path = require("path");
9 const os = require('os');
10 const {Options, runTest} = require('browser-ui-test');
13 console.log("rustdoc-js options:");
14 console.log(" --doc-folder [PATH] : location of the generated doc folder");
15 console.log(" --file [PATH] : file to run (can be repeated)");
16 console.log(" --debug : show extra information about script run");
17 console.log(" --show-text : render font in pages");
18 console.log(" --no-headless : disable headless mode");
19 console.log(" --help : show this message then quit");
20 console.log(" --tests-folder [PATH] : location of the .GOML tests folder");
21 console.log(" --jobs [NUMBER] : number of threads to run tests on");
24 function isNumeric(s) {
25 return /^\d+$/.test(s);
28 function parseOptions(args) {
38 var correspondances = {
39 "--doc-folder": "doc_folder",
40 "--tests-folder": "tests_folder",
42 "--show-text": "show_text",
43 "--no-headless": "no_headless",
46 for (var i = 0; i < args.length; ++i) {
47 if (args[i] === "--doc-folder"
48 || args[i] === "--tests-folder"
49 || args[i] === "--file"
50 || args[i] === "--jobs") {
52 if (i >= args.length) {
53 console.log("Missing argument after `" + args[i - 1] + "` option.");
56 if (args[i - 1] === "--jobs") {
57 if (!isNumeric(args[i])) {
59 "`--jobs` option expects a positive number, found `" + args[i] + "`");
62 opts["jobs"] = parseInt(args[i]);
63 } else if (args[i - 1] !== "--file") {
64 opts[correspondances[args[i - 1]]] = args[i];
66 opts["files"].push(args[i]);
68 } else if (args[i] === "--help") {
71 } else if (correspondances[args[i]]) {
72 opts[correspondances[args[i]]] = true;
74 console.log("Unknown option `" + args[i] + "`.");
75 console.log("Use `--help` to see the list of options");
79 if (opts["tests_folder"].length < 1) {
80 console.log("Missing `--tests-folder` option.");
81 } else if (opts["doc_folder"].length < 1) {
82 console.log("Missing `--doc-folder` option.");
89 /// Print single char status information without \n
90 function char_printer(n_tests) {
91 const max_per_line = 10;
94 successful: function() {
96 if (current % max_per_line === 0) {
97 process.stdout.write(`. (${current}/${n_tests})${os.EOL}`);
99 process.stdout.write(".");
102 erroneous: function() {
104 if (current % max_per_line === 0) {
105 process.stderr.write(`F (${current}/${n_tests})${os.EOL}`);
107 process.stderr.write("F");
111 if (current % max_per_line === 0) {
112 // Don't output if we are already at a matching line end
115 const spaces = " ".repeat(max_per_line - (current % max_per_line));
116 process.stdout.write(`${spaces} (${current}/${n_tests})${os.EOL}${os.EOL}`);
122 /// Sort array by .file_name property
123 function by_filename(a, b) {
124 return a.file_name - b.file_name;
127 async function main(argv) {
128 let opts = parseOptions(argv.slice(2));
133 // Print successful tests too
135 // Run tests in sequentially
136 let no_headless = false;
137 const options = new Options();
139 // This is more convenient that setting fields one by one.
142 "--variable", "DOC_PATH", opts["doc_folder"],
146 args.push("--debug");
148 if (opts["show_text"]) {
149 args.push("--show-text");
151 if (opts["no_headless"]) {
152 args.push("--no-headless");
155 options.parseArguments(args);
157 console.error(`invalid argument: ${error}`);
163 if (opts["files"].length === 0) {
164 files = fs.readdirSync(opts["tests_folder"]);
166 files = opts["files"];
168 files = files.filter(file => path.extname(file) == ".goml");
169 if (files.length === 0) {
170 console.error("rustdoc-gui: No test selected");
177 console.log("`--no-headless` option is active, disabling concurrency for running tests.");
180 console.log(`Running ${files.length} rustdoc-gui (${opts["jobs"]} concurrently) ...`);
182 if (opts["jobs"] < 1) {
183 process.setMaxListeners(files.length + 1);
184 } else if (!no_headless) {
185 process.setMaxListeners(opts["jobs"] + 1);
188 const tests_queue = [];
194 const status_bar = char_printer(files.length);
195 for (let i = 0; i < files.length; ++i) {
196 const file_name = files[i];
197 const testPath = path.join(opts["tests_folder"], file_name);
198 const callback = runTest(testPath, options)
200 const [output, nb_failures] = out;
201 results[nb_failures === 0 ? "successful" : "failed"].push({
205 if (nb_failures > 0) {
206 status_bar.erroneous();
209 status_bar.successful();
213 results.errored.push({
214 file_name: testPath + file_name,
217 status_bar.erroneous();
221 // We now remove the promise from the tests_queue.
222 tests_queue.splice(tests_queue.indexOf(callback), 1);
224 tests_queue.push(callback);
225 if (opts["jobs"] > 0 && tests_queue.length >= opts["jobs"]) {
226 await Promise.race(tests_queue);
229 if (!no_headless && tests_queue.length > 0) {
230 await Promise.all(tests_queue);
235 results.successful.sort(by_filename);
236 results.successful.forEach(r => {
237 console.log(r.output);
241 if (results.failed.length > 0) {
243 results.failed.sort(by_filename);
244 results.failed.forEach(r => {
245 console.log(r.file_name, r.output);
248 if (results.errored.length > 0) {
250 // print run errors on the bottom so developers see them better
251 results.errored.sort(by_filename);
252 results.errored.forEach(r => {
253 console.error(r.file_name, r.output);