user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/test/rustdoc-gui
History
Michael Howell 3cb03cb342 rustdoc: remove unused CSS class in-band 
Since a7c25b2957 removed `in-band` from code
headers, the only remaining uses of the `in-band` class are:

02cd79afb8/src/librustdoc/html/render/write_shared.rs (L520-L521)

02cd79afb8/src/librustdoc/html/templates/print_item.html (L2-L3)

02cd79afb8/src/librustdoc/html/render/context.rs (L637-L638)

02cd79afb8/src/librustdoc/html/render/mod.rs (L368-L369)

02cd79afb8/src/librustdoc/html/render/mod.rs (L401-L402)

02cd79afb8/src/librustdoc/html/static/js/main.js (L525)

Since all of these uses are nested below `h1.fqn`, we can get rid of it,
and the support code that was used for when `in-band` was part of item
rendering.
2022-10-05 16:56:07 -07:00
..
src rustdoc: add gui test for no-docblock margins 2022-09-30 10:47:18 -07:00
anchor-navigable.goml rustdoc: remove bad CSS font-weight on .impl, .method, etc 2022-09-28 16:18:12 -07:00
anchors.goml rustdoc: remove unused CSS class in-band 2022-10-05 16:56:07 -07: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 rustdoc: give .line-number / .line-numbers meaningful names 2022-09-26 11:48:03 -07: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 rustdoc: update test cases for changed item-decl HTML 2022-09-19 13:39:31 -07:00
check-stab-in-docblock.goml Improve GUI tests by using variables 2022-09-23 18:12:37 +02:00
check_info_sign_position.goml Update rustdoc GUI tests 2022-09-10 10:18:32 +02:00
code-blocks-overflow.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07: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 Clean up themes a bit more 2022-09-09 00:11:16 +02:00
codeblock-tooltip.goml Update rustdoc GUI tests 2022-09-10 10:18:32 +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 rustdoc: give .line-number / .line-numbers meaningful names 2022-09-26 11:48:03 -07:00
docblock-details.goml Remove useless color assertions on 0px borders 2022-09-19 20:14:09 -07:00
docblock-table-overflow.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07:00
docblock-table.goml rustdoc: remove incorrect CSS selector .impl-items table td 2022-08-26 08:48:50 -07: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 rustdoc: remove bad CSS font-weight on .impl, .method, etc 2022-09-28 16:18:12 -07: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: clean up .out-of-band/.in-band CSS 2022-09-25 13:48:17 -07:00
headings.goml Remove useless color assertions on 0px borders 2022-09-19 20:14:09 -07: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 Round offset to whole integer 2022-09-25 14:58:49 -07:00
item-info-alignment.goml rustdoc: put in rule to get alignment in desktop and mobile layouts 2022-09-02 13:13:22 -07:00
item-info-overflow.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07:00
item-info.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07:00
item-summary-table.goml rustdoc: omit start/end tags for empty item description blocks 2022-08-25 20:30:23 -07: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 rustdoc: clean up DOM by removing .dockblock-short p 2022-09-13 16:03:11 -07:00
links-color.goml Add GUI test for links colors 2022-09-16 18:26:48 +02: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
no-docblock.goml rustdoc: add gui test for no-docblock margins 2022-09-30 10:47:18 -07:00
notable-trait.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07:00
overflow-tooltip-information.goml Update rustdoc GUI tests 2022-09-10 10:18:32 +02:00
pocket-menu.goml Update existing rustdoc-gui tests and add a new one 2022-08-18 16:14:46 +02: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 Update existing rustdoc-gui tests and add a new one 2022-08-18 16:14:46 +02:00
search-form-elements.goml Update rustdoc-gui tests for search-input border color on dark theme 2022-09-03 00:16:10 +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-reexport.goml Fix flakyness of GUI tests 2022-07-16 13:53:43 +02:00
search-result-color.goml Extend GUI test to check hover and focus on search results 2022-10-03 23:15:38 +02:00
search-result-description.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-display.goml rustdoc: fix GUI tests to deal with slightly changed width 2022-09-23 09:18:07 -07:00
search-result-go-to-first.goml rustdoc: remove unused CSS class in-band 2022-10-05 16:56:07 -07: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-links-color.goml Add GUI test for sidebar links color 2022-09-30 13:29:40 +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: update test cases for <section> tags in traits 2022-09-30 11:58:58 -07:00
sidebar-mobile.goml Add regression test for hamberger button color in mobile sidebar 2022-10-05 11:20:14 +02:00
sidebar-source-code-display.goml rustdoc: update test case now that the UI animation is removed 2022-09-29 15:40:24 -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 rustdoc: add regression test for sidebar width jank 2022-09-23 08:35:14 -07:00
source-anchor-scroll.goml rustdoc: adjust test to cope with slightly different scrolling behaviour 2022-09-21 16:44:33 -07:00
source-code-page.goml rustdoc: give .line-number / .line-numbers meaningful names 2022-09-26 11:48:03 -07:00
src-font-size.goml rustdoc: remove bad CSS font-weight on .impl, .method, etc 2022-09-28 16:18:12 -07: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: remove unused CSS class in-band 2022-10-05 16:56:07 -07: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 Rollup merge of #102199 - GuillaumeGomez:improve-rustdoc-gui-tests, r=notriddle 2022-09-24 07:38:58 +02:00
where-whitespace.goml Add rustdoc GUI test 2022-08-31 18:13:59 +02: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