rust/src/test/rustdoc-gui
2022-03-05 16:02:28 +01:00
..
src Add GUI test for source code viewer scroll handling 2022-03-05 16:02:28 +01:00
anchor-navigable.goml
anchors.goml Update rustdoc tests for headings indent 2022-02-09 14:55:26 +01:00
auto-hide-trait-implementations.goml
basic-code.goml
basic.goml
check_info_sign_position.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
check-code-blocks-margin.goml
code-blocks-overflow.goml
code-color.goml
code-sidebar-toggle.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
code-tags.goml
default-settings.goml
docblock-big-code-mobile.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
docblock-code-block-line-number.goml
docblock-table-overflow.goml
duplicate-macro-reexport.goml Add test for duplicated macros in the sidebar 2022-02-14 21:43:48 +01:00
escape-key.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
font-weight.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
hash-item-expansion.goml Update rustdoc tests to adapt to changes to the sidebar 2022-02-16 20:43:31 +01:00
headers-color.goml Update rustdoc tests for headings indent 2022-02-09 14:55:26 +01:00
headings.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
huge-collection-of-constants.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
impl-default-expansion.goml
implementors.goml rustdoc: fix spacing of non-toggled impl blocks 2022-02-09 23:34:10 -08:00
item-info-width.goml Fix GUI test 2022-02-15 21:31:40 +01:00
item-summary-table.goml
javascript-disabled.goml
jump-to-def-background.goml
label-next-to-symbol.goml
list_code_block.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
mobile.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
module-items-font.goml
overflow-tooltip-information.goml
README.md
run-on-hover.goml
rust-logo.goml
search-filter.goml Add GUI test for crate filter URL parameter 2022-02-03 22:59:34 +01:00
search-input-mobile.goml
search-result-color.goml
search-result-colors.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-result-description.goml
search-result-display.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-result-go-to-first.goml
search-result-keyword.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-tab-selection-if-current-is-empty.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
shortcuts.goml
sidebar-macro-reexport.goml
sidebar-mobile.goml Update rustdoc tests to adapt to changes to the sidebar 2022-02-16 20:43:31 +01:00
sidebar-source-code.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
sidebar.goml Update rustdoc tests to adapt to changes to the sidebar 2022-02-16 20:43:31 +01:00
source-anchor-scroll.goml Add GUI test for source code viewer scroll handling 2022-03-05 16:02:28 +01:00
source-code-page.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
src-font-size.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
theme-change.goml Extend theme change GUI test 2022-01-29 10:44:27 +01:00
theme-in-history.goml Add test to ensure that theme is applied correctly when going back in history 2022-01-30 13:19:01 +01:00
toggle-click-deadspace.goml
toggle-docs-mobile.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
toggle-docs.goml Extend toggle GUI test a bit 2022-02-25 11:11:52 +01:00
toggle-implementors.goml
toggled-open-implementations.goml
trait-sidebar-item-order.goml Update rustdoc tests to adapt to changes to the sidebar 2022-02-16 20:43:31 +01:00
type-declation-overflow.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00

The tests present here are used to test the generated HTML from rustdoc. The goal is to prevent unsound/unexpected GUI changes.

This is using the browser-ui-test framework to do so. It works as follows:

It wraps puppeteer to send commands to a web browser in order to navigate and test what's being currently displayed in the web page.

You can find more information and its documentation in its repository.

If you need to have more information on the tests run, you can use --test-args:

$ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug

There are three options supported:

  • --debug: allows to see puppeteer commands.
  • --no-headless: disable headless mode so you can see what's going on.
  • --show-text: by default, text isn't rendered because of issues with fonts, it enables it back.