rust/src/test/rustdoc-gui
Matthias Krüger 8e059d5968
Rollup merge of #105143 - notriddle:notriddle/scraped-example-list-font, r=GuillaumeGomez
rustdoc: use simpler CSS for setting the font on scraped examples
2022-12-02 08:28:12 +01:00
..
src rustdoc: use simpler CSS for setting the font on scraped examples 2022-12-01 12:34:02 -07:00
anchor-navigable.goml
anchors.goml
auto-hide-trait-implementations.goml
basic-code.goml
basic.goml
check_info_sign_position.goml
check-code-blocks-margin.goml
check-stab-in-docblock.goml
code-blocks-overflow.goml
code-color.goml
code-sidebar-toggle.goml
code-tags.goml Update to new browser-ui-test version 2022-11-09 17:00:25 +01:00
codeblock-tooltip.goml rustdoc: revert tooltip background color on light theme to readable 2022-11-25 09:28:25 -07:00
cursor.goml rustdoc: add test case for pointer cursor 2022-11-21 09:16:54 -07:00
default-settings.goml
docblock-big-code-mobile.goml
docblock-code-block-line-number.goml rustdoc: use checkbox instead of switch for settings toggles 2022-11-10 17:22:37 -07:00
docblock-details.goml
docblock-table-overflow.goml
docblock-table.goml
duplicate-macro-reexport.goml
enum-variants.goml rustdoc: update tests for enum variant margin tweak 2022-11-17 15:37:34 -07:00
escape-key.goml
font-weight.goml
hash-item-expansion.goml
headers-color.goml
headings.goml
help-page.goml Extend GUI tests to check kbd colors 2022-11-20 14:32:49 +01:00
highlight-colors.goml rustdoc: rename syntax highlighting CSS class attribute to attr 2022-10-31 13:55:39 -07:00
huge-collection-of-constants.goml
huge-logo.goml rustdoc: add test case for huge logo 2022-11-05 14:26:13 -07:00
impl-default-expansion.goml
implementors.goml
item-decl-colors.goml rustdoc: remove fnname CSS class that's styled exactly like fn 2022-11-28 10:51:46 -07:00
item-info-alignment.goml
item-info-overflow.goml
item-info.goml
item-summary-table.goml
javascript-disabled.goml
jump-to-def-background.goml Use functions for jump-to-def-background rustodoc GUI test 2022-10-23 15:40:56 +02:00
label-next-to-symbol.goml
links-color.goml
list_code_block.goml
method-margins.goml rustdoc: add test case for associated type margins 2022-10-31 07:47:42 -07:00
mobile.goml
module-items-font.goml
no-docblock.goml Update to new browser-ui-test version 2022-11-09 17:00:25 +01:00
notable-trait.goml rustdoc: remove fnname CSS class that's styled exactly like fn 2022-11-28 10:51:46 -07:00
overflow-tooltip-information.goml
pocket-menu.goml rustdoc: improve popover focus handling JS 2022-11-26 10:19:22 -07:00
README.md
run-on-hover.goml Extend GUI test for run button 2022-11-05 17:22:38 +01:00
rust-logo.goml Extend rust-logo GUI test to check there is no filter for other logos 2022-11-06 20:20:43 +01:00
scrape-examples-button-focus.goml rustdoc: add test case for scraped example expand GUI 2022-11-19 17:42:07 -07:00
scrape-examples-fonts.goml rustdoc: use simpler CSS for setting the font on scraped examples 2022-12-01 12:34:02 -07:00
search-filter.goml rustdoc: add test case for huge logo 2022-11-05 14:26:13 -07:00
search-form-elements.goml
search-input-mobile.goml
search-keyboard.goml rustdoc: fix corner case in search keyboard commands 2022-11-14 13:21:08 -07:00
search-no-result.goml Use same color for links in no result search 2022-11-12 13:33:17 +01:00
search-reexport.goml
search-result-color.goml Extend GUI test for alias search result 2022-11-21 11:15:54 +01:00
search-result-description.goml
search-result-display.goml rustdoc: simplify .search-results-title CSS 2022-11-23 14:31:09 -07:00
search-result-go-to-first.goml
search-result-keyword.goml
search-tab-change-title-fn-sig.goml
settings.goml Update GUI test 2022-11-13 21:23:12 +01:00
shortcuts.goml
sidebar-links-color.goml Migrate sidebar-links-color GUI test to functions 2022-11-01 19:46:42 +01:00
sidebar-macro-reexport.goml
sidebar-mobile-scroll.goml
sidebar-mobile.goml Rollup merge of #104955 - GuillaumeGomez:migrate-to-func, r=notriddle 2022-11-27 22:14:08 +01:00
sidebar-source-code-display.goml Strenghten GUI test to include extra state in selector 2022-11-24 23:39:49 +01:00
sidebar-source-code.goml rustdoc: fix test case 2022-11-19 18:21:46 -07:00
sidebar.goml
source-anchor-scroll.goml
source-code-page.goml Rollup merge of #103650 - notriddle:notriddle/line-anchors, r=GuillaumeGomez 2022-11-13 16:41:44 +09:00
src-font-size.goml Add GUI test to ensure that source links can be clicked 2022-11-12 13:58:59 +01:00
struct-fields.goml rustdoc: make struct fields display: block 2022-11-22 15:10:33 -07:00
target.goml Add GUI test for :target 2022-11-10 18:53:31 +01:00
theme-change.goml Extend GUI test for theme settings 2022-11-13 21:37:42 +01:00
theme-in-history.goml Remove unneeded "rustdoc-preferred-dark-theme" setting 2022-11-01 19:47:12 +01:00
toggle-click-deadspace.goml
toggle-docs-mobile.goml
toggle-docs.goml Add GUI test for toggle filter and opacity 2022-12-01 15:58:16 +01:00
toggle-implementors.goml
toggled-open-implementations.goml
trait-sidebar-item-order.goml Update to new browser-ui-test version 2022-11-09 17:00:25 +01:00
type-declation-overflow.goml rustdoc: remove no-op CSS .main-header { justify-content } 2022-11-14 15:27:04 -07:00
unsafe-fn.goml
where-whitespace.goml rustdoc: remove fnname CSS class that's styled exactly like fn 2022-11-28 10:51:46 -07: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 --test-args --debug

If you don't want to run in headless mode (helpful to debug sometimes), you can use --no-headless:

$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-headless

To see the supported options, use --help.

Important to be noted: if the chromium instance crashes when you run it, you might need to use --no-sandbox to make it work:

$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-sandbox