Skip to content

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Oct 15, 2025

This adds the ability to use multiple books for the GUI tests. This is helpful since some tests need special configuration, and sharing the same book can make it difficult or impossible to test different configurations. It also makes it difficult to make changes to the test_book since it can affect other tests.

This works by placing the books in the tests/gui/books directory. The test runner will automatically build all the books. The gui tests can then just access the DOC_PATH with the name of the book.

Books are now saved in a temp directory to make it easier to use the DOC_PATH variable, instead of being tests/gui/books/book_name/book which is a little awkward.

ehuss added 8 commits October 15, 2025 07:00
This adds the ability to use multiple books for the GUI tests. This is
helpful since some tests need special configuration, and sharing the
same book can make it difficult or impossible to test different
configurations. It also makes it difficult to make changes to the
test_book since it can affect other tests.

This works by placing the books in the tests/gui/books directory. The
test runner will automatically build all the books. The gui tests can
then just access the DOC_PATH with the name of the book.

Books are now saved in a temp directory to make it easier to use the
DOC_PATH variable, instead of being tests/gui/books/book_name/book which
is a little awkward.

Following commits will restructure the existing book. This is just a
mechanical move.
This is the default book with a single chapter.
This adds the all-summary GUI test book which can be used for general
purpose tests that need a few pages to exercise all the different kinds
of items.
This isolates the search test with its own test book.
This adds a test specific to highlight.js syntax highlighting.
This is no longer used, as individual books have been added to support
different GUI tests. If there is anything here that we later decide we
need to keep for whatever reason, the needed content can be brought back
as new GUI test books. Otherwise, the guide and other books should cover
most things here.
@rustbot rustbot added the S-waiting-on-review Status: waiting on a review label Oct 15, 2025
@ehuss ehuss enabled auto-merge October 15, 2025 14:01
@ehuss ehuss added this pull request to the merge queue Oct 15, 2025
Merged via the queue into rust-lang:master with commit 5e7b6d7 Oct 15, 2025
15 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: waiting on a review label Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants