user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/test/rustdoc-gui
History
Guillaume Gomez 8dba89823a
Rollup merge of #87288 - ijackson:rustdoc-theme, r=GuillaumeGomez 
rustdoc: Restore --default-theme, etc, by restoring varname escaping

In #86157

    cd0f93193c
    Use Tera templates for rustdoc.

dropped the following transformation from the keys of the default settings element's `data-` attribute names:

    .map(|(k, v)| format!(r#" data-{}="{}""#, k.replace('-', "_"), Escape(v)))

The `Escape` part is indeed no longer needed, because Tera does that for us.  But the massaging of `-` to `_` is needed, for the (bizarre) reasons explained in the new comments.

I have tested that the default theme function works again for me.  I have also verified that passing (in shell syntax)

    '--default-theme="zork&"'

escapes the value in the HTML.

Closes #87263
2021-07-22 13:39:22 +02:00
..
src Rollup merge of #87288 - ijackson:rustdoc-theme, r=GuillaumeGomez 2021-07-22 13:39:22 +02:00
auto-hide-trait-implementations.goml Add GUI test for auto-hide-trait-implementations setting 2021-07-16 15:15:23 +02:00
ayu-code-tag-colors.goml Add GUI test to check ayu <code> colors 2021-07-14 15:00:12 +02:00
basic-code.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
basic.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
check_info_sign_position.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
code-blocks-overflow.goml Add test for codeblocks overflow 2021-07-14 12:03:55 +02:00
code-sidebar-toggle.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
default-settings.goml Add tests for default-settings 2021-07-22 12:58:59 +02:00
docblock-table-overflow.goml Add GUI test for <table> overflow 2021-07-18 00:03:30 +02:00
escape-key.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
font-weight.goml Add tests to ensure the font-weight is the correct one 2021-06-26 21:38:24 +02:00
hash-item-expansion.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
impl-default-expansion.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
implementors.goml Add test for implementors 2021-07-12 19:03:59 +02:00
item-info-width.goml Add test to check width of item-info 2021-07-18 12:32:26 +02:00
item-summary-table.goml Add test to ensure tables are not inside items summary 2021-07-21 20:06:06 +02:00
label-next-to-symbol.goml Enable the tests developed with #86594 2021-07-01 10:13:28 +02:00
list_code_block.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
README.md Allow to pass arguments to rustdoc-gui tool 2021-06-16 11:54:19 +02:00
search-filter.goml Fix search filter update 2021-06-23 10:09:26 +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-result-color.goml Add test for keyword/primitive text color 2021-07-13 10:18:24 +02:00
search-result-colors.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-description.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-display.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-go-to-first.goml Add test for "go to first" feature 2021-07-13 19:41:58 +02:00
search-result-keyword.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-tab-selection-if-current-is-empty.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
shortcuts.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
sidebar-mobile.goml Fix sidebar-mobile test to focus on an actual focusable element 2021-07-17 11:53:59 -07:00
sidebar.goml Fixing the test rustdoc by ignoring *[@id="module-item"]//following-sibling::item-right relationship and rustdoc-gui 2021-06-24 16:46:15 +02:00
source-code-page.goml Add check to ensure that the line numbers are aligned with the source code 2021-06-22 11:17:53 +02:00
theme-change.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
toggle-docs-mobile.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
toggle-docs.goml Update browser-ui-test version 2021-06-22 11:11:45 +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 browser-ui-test version 2021-06-19 14:19:39 +02:00
type-declation-overflow.goml Add regression test for type declaration layout overflow 2021-07-15 18:19:25 +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 --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.