user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/test/rustdoc-gui
History
Andy Russell 753d567989
clarify doc(cfg) wording 
The current "This is supported" wording implies that it's possible to
still use the item on other configurations, but in an unsupported way.
Changing this to "Available" removes this ambiguity.
2022-04-14 21:12:13 -04:00
..
src Add GUI test to ensure that the width of the item-info does not overflow its parent 2022-04-05 18:11:27 +02:00
anchor-navigable.goml Outdent method headings so they stand out 2021-10-23 11:50:11 -07:00
anchors.goml Update rustdoc tests for headings indent 2022-02-09 14:55:26 +01:00
auto-hide-trait-implementations.goml Add GUI test for auto-hide-trait-implementations setting 2021-07-16 15:15:23 +02:00
basic-code.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
basic.goml * Remove left margin on items declaration at the top of their documentation page 2021-10-18 15:06:38 +02:00
check-code-blocks-margin.goml Rename ID "main" into "main-content" 2021-12-02 14:17:20 +01:00
check_info_sign_position.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
code-blocks-overflow.goml Simplify and unify rustdoc sidebar styles 2022-01-18 10:43:14 -08:00
code-color.goml Add test for code blocks color 2021-08-28 11:44:02 +02:00
code-sidebar-toggle.goml Remove animation on source sidebar 2022-03-19 16:59:56 +01:00
code-tags.goml [rustdoc] Wrap code blocks in <code> tag 2021-08-19 10:30:08 +02:00
default-settings.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
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 Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
docblock-table-overflow.goml Update GUI tests for impl blocks path changes 2022-03-08 23:12:11 +01:00
duplicate-macro-reexport.goml Add test for duplicated macros in the sidebar 2022-02-14 21:43:48 +01:00
escape-key.goml Add URL GUI tests 2022-03-15 20:56:14 +01:00
font-weight.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
hash-item-expansion.goml Update GUI tests for impl blocks path changes 2022-03-08 23:12:11 +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 Update GUI tests for impl blocks path changes 2022-03-08 23:12:11 +01:00
implementors.goml rustdoc: fix spacing of non-toggled impl blocks 2022-02-09 23:34:10 -08:00
item-info-overflow.goml clarify doc(cfg) wording 2022-04-14 21:12:13 -04:00
item-info-width.goml clarify doc(cfg) wording 2022-04-14 21:12:13 -04:00
item-summary-table.goml Add test to ensure tables are not inside items summary 2021-07-21 20:06:06 +02:00
javascript-disabled.goml Hide search bar in noscript.css 2021-10-31 12:41:06 -07:00
jump-to-def-background.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
label-next-to-symbol.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
list_code_block.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
mobile.goml Fix spurious CI failures 2022-03-09 21:28:23 +01:00
module-items-font.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
overflow-tooltip-information.goml Fix scrollbars appearing on information tooltip on mac when they shouldn't 2021-10-25 11:40:13 +02:00
README.md Allow to pass arguments to rustdoc-gui tool 2021-06-16 11:54:19 +02:00
run-on-hover.goml Make Run button visible on hover 2022-01-05 10:07:22 -05:00
rust-logo.goml Add GUI test for rust logo style in the sidebars 2022-01-11 13:57:17 +01:00
search-filter.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
search-input-mobile.goml Move rustdoc-gui rust libraries into their own folder and prepare the field for more libraries 2021-05-11 20:56:16 +02:00
search-result-color.goml Merge both "search-result-color" GUI tests 2022-03-15 20:41:24 +01:00
search-result-description.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-display.goml Fix last rustdoc-gui spurious test 2022-03-30 14:30:46 +02:00
search-result-go-to-first.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
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 Update browser-ui-test version 2021-06-19 14:19:39 +02:00
sidebar-macro-reexport.goml Add test for duplicated sidebar entries for reexported macro 2021-10-20 15:44:16 +02:00
sidebar-mobile.goml Update rustdoc tests to adapt to changes to the sidebar 2022-02-16 20:43:31 +01:00
sidebar-source-code-display.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
sidebar-source-code.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01: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 GUI test to ensure that line numbers text is aligned to the right 2022-03-07 12:08:14 +01:00
src-font-size.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
theme-change.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
theme-in-history.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
toggle-click-deadspace.goml Fix clicking on anchors inside summary tags. 2021-11-24 10:46:55 -08:00
toggle-docs-mobile.goml Update GUI tests for impl blocks path changes 2022-03-08 23:12:11 +01:00
toggle-docs.goml Replace wait-for instructions for rustdoc GUI tests with wait-for-css 2022-03-25 21:32:16 +01:00
toggle-implementors.goml Remove implementors setting 2021-09-01 20:34:51 +02:00
toggled-open-implementations.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
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

README.md

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.