user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/test/rustdoc-gui
History
Matthias Krüger 02fc0faa9a
Rollup merge of #98775 - notriddle:notriddle/mobile-sidebar-scroll-lock, r=jsha 
rustdoc: improve scroll locking in the rustdoc mobile sidebars

This PR prevents the main content area from scrolling while the mobile sidebar is open on documentation pages (porting the scroll locking behavior from the source sidebar to the regular sidebar), and also fixes some bad behavior where opening a "mobile" sidebar, and growing the viewport so that the "desktop" mode without scroll locking is activated, could potentially leave the page stuck.

This does not affect the behavior on larger screens. Only small ones, where the sidebar covers up the main content.

Split out from #98772
2022-08-10 00:00:23 +02:00
..
src Rollup merge of #99779 - GuillaumeGomez:fix-item-info-pos-and-height, r=notriddle 2022-08-02 07:30:41 +02:00
anchor-navigable.goml Outdent method headings so they stand out 2021-10-23 11:50:11 -07:00
anchors.goml rustdoc: Add more semantic information to impl ids 2022-07-05 19:43:52 +02: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-details.goml Add GUI tests for headings border and text color 2022-07-27 17:08:51 +02: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 Improve loading of crates.js and sidebar-items.js 2022-06-20 11:12:55 -07:00
escape-key.goml Fix flakyness of GUI tests 2022-07-16 13:53:43 +02: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 rustdoc: Add more semantic information to impl ids 2022-07-05 19:43:52 +02:00
headings.goml Add GUI tests for headings border and text color 2022-07-27 17:08:51 +02: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 Update rustdoc tests 2022-07-05 21:33:39 +02:00
item-info-overflow.goml Update rustdoc tests 2022-07-05 21:33:39 +02:00
item-info.goml Add GUI test for item info position 2022-07-27 14:48:10 +02: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
pocket-menu.goml rustdoc: fix help menu popover toggling 2022-06-28 16:02:44 -07:00
README.md Update rustdoc-gui README 2022-06-07 11:49:35 +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 Fix flakyness of GUI tests 2022-07-16 13:53:43 +02: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-input.goml Add GUI tests for search input border color 2022-07-20 12:19:30 +02:00
search-reexport.goml Fix flakyness of GUI tests 2022-07-16 13:53:43 +02:00
search-result-color.goml Fix flakyness of GUI tests 2022-07-16 13:53:43 +02:00
search-result-description.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-display.goml Add GUI tests for search input border color 2022-07-20 12:19:30 +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 Fix flakyness of GUI tests 2022-07-16 13:53:43 +02:00
search-tab-change-title-fn-sig.goml Fix flakyness of GUI tests 2022-07-16 13:53:43 +02:00
settings.goml Add GUI test for settings in small device 2022-07-27 14:45:12 +02:00
shortcuts.goml Add/update GUI tests for help pocket menu 2022-06-23 00:22:25 +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-scroll.goml rustdoc: improve scroll locking in the rustdoc mobile sidebars 2022-07-05 11:12:18 -07:00
sidebar-mobile.goml Add GUI test to prevent sidebar background regression 2022-07-25 14:35:06 +02:00
sidebar-source-code-display.goml rustdoc: improve scroll locking in the rustdoc mobile sidebars 2022-07-05 11:12:18 -07:00
sidebar-source-code.goml Add GUI test for source code sidebar auto-expand 2022-07-17 17:04:43 +02:00
sidebar.goml Add GUI test for search reexports 2022-05-06 13:52:21 +02: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 rustdoc: add test case for source sidebar spacing 2022-07-02 09:42:49 -07:00
src-font-size.goml rustdoc: tweak line and ¶ spacing for a11y 2022-02-08 03:09:10 -08:00
theme-change.goml Update GUI tests 2022-05-14 17:21:52 +02:00
theme-in-history.goml Add GUI test for settings menu 2022-04-30 13:12:42 +02:00
toggle-click-deadspace.goml rustdoc: Add more semantic information to impl ids 2022-07-05 19:43:52 +02: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 --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