Unify the condensed test output of rustdoc-gui and other test suites

binarycat · April 25, 2025, 9:33pm

I noticed that the output formats are slightly different when run interactively (condensed output).

Both of them use rows of dots with a X/TOTAL at the end of the line, but they're subtly different, most test suites use long lines with colored dots and no parenthesis, while rustdoc-gui uses short lines with no color and the numeric progress is parenthisized.

This means that this functionality is likely implemented twice. I'm not sure how much code this constitutes, but it might be nice to make them use the same underlying code, either by moving that code to a shared library, simple refactoring, or changing IPC protocols so compiletest is always the one printing the dots.

bjorn3 · April 26, 2025, 3:08pm

I would guess rustdoc-gui uses libtest's implementation of this, while the other test suites ask libtest to emit json and then bootstrap does the formatting. This is done to also get the errors in json format for the CI test change reports. In any case compiletest is actually moving away from libtest to it's own test harness which only supports the json format. When rustdoc is responsible for printing the output, it would still use libtest.

binarycat · April 30, 2025, 4:52am

rustdoc-gui uses its own custom scripting language and stuff, so i'm not sure.

notriddle · May 2, 2025, 5:21am

rustdoc-gui uses an entirely separate test harness written in NodeJS.

github.com/rust-lang/rust

src/tools/rustdoc-gui/tester.js

master


      
                  console.log("Missing `--tests-folder` option.");
              } else if (opts["doc_folder"].length < 1) {
                  console.log("Missing `--doc-folder` option.");
              } else {
                  return opts;
              }
              return null;
          }
          
          /// Print single char status information without \n
          function char_printer(n_tests) {
              const max_per_line = 10;
              let current = 0;
              return {
                  successful: function() {
                      current += 1;
                      if (current % max_per_line === 0) {
                          process.stdout.write(`. (${current}/${n_tests})${os.EOL}`);
                      } else {
                          process.stdout.write(".");
                      }

Topic		Replies	Views
Alternate libtest output format	12	2083	March 25, 2019
Path for stabilizing libtest's json output? tools and infrastructure	8	733	April 19, 2024
Past, present, and future for Rust testing libs	104	16024	March 25, 2019
Pre-RFC: machine readable test output tools and infrastructure	14	3525	March 25, 2019
Design discussion: JSON output for rustdoc tools and infrastructure	8	2338	March 25, 2019

Unify the condensed test output of rustdoc-gui and other test suites

Related topics