rust/tests/rustdoc-gui
2024-02-22 16:04:04 +00:00
..
src [AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives 2024-02-22 16:04:04 +00:00
anchor-navigable.goml
anchors.goml rustdoc: fix rustdoc-gui tests for logo changes 2023-10-08 20:17:53 -07:00
basic-code.goml
check_info_sign_position.goml
check-code-blocks-margin.goml
check-stab-in-docblock.goml
code-blocks-overflow.goml
code-color.goml Migrate GUI colors test to original CSS color format 2023-09-03 12:49:22 +02:00
code-sidebar-toggle.goml rustdoc: clean up source sidebar hide button 2023-12-17 23:06:31 -07:00
code-tags.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
codeblock-sub.goml
codeblock-tooltip.goml
cursor.goml rustdoc: clean up source sidebar hide button 2023-12-17 23:06:31 -07:00
default-settings.goml Migrate GUI colors test to original CSS color format 2023-09-23 20:03:03 +02:00
docblock-big-code-mobile.goml
docblock-code-block-line-number.goml
docblock-details.goml Update rustdoc headings tests 2023-12-05 15:59:40 +01:00
docblock-table-overflow.goml
docblock-table.goml Migrate GUI colors test to original CSS color format 2023-08-20 14:44:36 +02:00
duplicate-macro-reexport.goml
enum-variants.goml
escape-key.goml
extend-css.goml
fields.goml
font-weight.goml rustdoc: remove small from small-section-header 2023-11-29 13:40:07 -07:00
globals.goml rustdoc: clean up source sidebar hide button 2023-12-17 23:06:31 -07:00
go-to-collapsed-elem.goml
hash-item-expansion.goml
headers-color.goml Add tests for headings anchor and links in headings 2023-12-05 15:59:40 +01:00
headings-anchor.goml Add tests for headings anchor and links in headings 2023-12-05 15:59:40 +01:00
headings.goml
help-page.goml Migrate GUI colors test to original CSS color format 2023-09-09 11:20:03 +02:00
hide-mobile-topbar.goml rustdoc: allow resizing the sidebar 2023-10-11 10:26:36 -07:00
highlight-colors.goml
huge-collection-of-constants.goml
huge-logo.goml Add back the column 2023-12-18 12:42:24 -07:00
impl_on_foreign_order.goml Add GUI test to ensure that implementations on foreign types are in the expected order 2023-11-02 18:02:14 +01:00
impl-default-expansion.goml
impl-doc.goml
implementors.goml
item-decl-colors.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
item-decl-comment-highlighting.goml Add GUI tests for comments highlighting in items declaration 2023-12-01 11:23:38 +01:00
item-info-alignment.goml
item-info-overflow.goml
item-info.goml Extend GUI tests for doc_cfg 2023-12-07 10:44:55 +01:00
item-summary-table.goml
javascript-disabled.goml
jump-to-def-background.goml
label-next-to-symbol.goml
links-color.goml rustdoc: allow resizing the sidebar 2023-10-11 10:26:36 -07:00
list_code_block.goml
method-margins.goml
mobile-crate-name.goml Add regression test for #120471 to ensure that long crate name are handled as expected on mobile 2024-01-31 16:40:23 +01:00
mobile.goml
module-items-font.goml
no-docblock.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
notable-trait.goml
overflow-tooltip-information.goml
pocket-menu.goml
README.md
run-on-hover.goml Migrate GUI colors test to original CSS color format 2023-08-04 19:45:32 +02:00
rust-logo.goml Add back the column 2023-12-18 12:42:24 -07:00
scrape-examples-button-focus.goml
scrape-examples-color.goml
scrape-examples-fonts.goml
scrape-examples-layout.goml
scrape-examples-toggle.goml Migrate GUI colors test to original CSS color format 2023-08-05 12:47:05 +02:00
search-corrections.goml rustdoc: update tests for generic parsing and correction 2023-09-03 13:06:08 -07:00
search-error.goml Migrate GUI colors test to original CSS color format 2023-08-06 12:46:35 +02:00
search-filter.goml
search-form-elements.goml rustdoc: treat query string + as space 2023-12-26 14:14:28 -07:00
search-input-mobile.goml
search-keyboard.goml
search-no-result.goml Migrate GUI colors test to original CSS color format 2023-09-10 14:10:10 +02:00
search-reexport.goml
search-result-color.goml Migrate GUI colors test to original CSS color format 2023-09-16 11:54:25 +02:00
search-result-description.goml
search-result-display.goml
search-result-go-to-first.goml
search-result-impl-disambiguation.goml Update search-result-impl-disambiguation.goml 2023-09-21 15:16:44 -07:00
search-result-keyword.goml
search-tab-change-title-fn-sig.goml
search-tab.goml rustdoc-search: add support for associated types 2023-11-19 18:54:36 -07:00
setting-auto-hide-content-large-items.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
setting-auto-hide-item-methods-docs.goml
setting-auto-hide-trait-implementations.goml
setting-go-to-only-result.goml
settings.goml
shortcuts.goml
sidebar-links-color.goml rustdoc: allow resizing the sidebar 2023-10-11 10:26:36 -07:00
sidebar-macro-reexport.goml
sidebar-mobile-scroll.goml
sidebar-mobile.goml rustdoc: clean up the In [name] up-pointer 2023-10-08 20:17:53 -07:00
sidebar-resize-close-popover.goml rustdoc: hide modals when resizing the sidebar 2024-01-08 09:54:05 -07:00
sidebar-resize-setting.goml Fix corner cases when dealing with mobile mode 2023-12-19 19:50:53 -07:00
sidebar-resize-window.goml rustdoc: fix resize trouble with mobile 2023-10-11 12:15:33 -07:00
sidebar-resize.goml rustdoc: allow resizing the sidebar 2023-10-11 10:26:36 -07:00
sidebar-source-code-display.goml Stop using the trigram of heaven as a hamburger button 2023-12-18 13:56:55 -07:00
sidebar-source-code.goml Add back the column 2023-12-18 12:42:24 -07:00
sidebar.goml rustdoc: allow resizing the sidebar 2023-10-11 10:26:36 -07:00
source-anchor-scroll.goml rustdoc: fix rustdoc-gui tests for logo changes 2023-10-08 20:17:53 -07:00
source-code-page-code-scroll.goml
source-code-page.goml Use folder icon instead of hamburger and sidebar 2023-12-18 18:22:35 -07:00
src-font-size.goml
stab-badge.goml
struct-fields.goml
target.goml
theme-change.goml rusdoc: add gui test for custom CSS themes 2023-09-14 13:24:23 -07:00
theme-defaults.goml
theme-in-history.goml
toggle-click-deadspace.goml
toggle-docs-mobile.goml
toggle-docs.goml
toggle-implementors.goml
toggled-open-implementations.goml
tooltip-over-sidebar.goml rustdoc ui: adjust tooltip z-index to be above sidebar 2023-12-31 20:31:56 +01:00
trait-sidebar-item-order.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
type-declation-overflow.goml Add regression test for #120471 to ensure that long crate name are handled as expected on mobile 2024-01-31 16:40:23 +01:00
type-impls.goml rustdoc: make JS trait impls act more like HTML 2023-10-22 16:51:32 -07:00
unsafe-fn.goml Migrate GUI colors test to original CSS color format 2023-08-15 14:46:54 +02:00
warning-block.goml Add GUI regression test for position of warning block 2023-12-24 19:24:04 +01:00
where-whitespace.goml rustdoc: div.where instead of fmt-newline class 2023-11-30 10:43:40 -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 tests/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 tests/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 tests/rustdoc-gui --stage 1 --test-args --no-sandbox