Skip to content

Add GUI test for "go to first" feature #87102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2021
Merged

Add GUI test for "go to first" feature #87102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/test/rustdoc-gui/search-result-go-to-first.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// This test ensures that the "go_to_first" feature is working as expected.

// First, we check that the first page doesn't have the string we're looking for to ensure
// that the feature is changing page as expected.
goto: file://|DOC_PATH|/test_docs/index.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we also go to a search page without go_to_first?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is search-result-description.goml which does that already. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pop in a comment saying that and r=me

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually the test will be more complete if we add that as an intermediate check.

assert-text-false: (".fqn .in-band", "Struct test_docs::Foo")

// We now check that we land on the search result page if "go_to_first" isn't set.
goto: file://|DOC_PATH|/test_docs/index.html?search=struct%3AFoo
// Waiting for the search results to appear...
wait-for: "#titles"
assert-text-false: (".fqn .in-band", "Struct test_docs::Foo")
// Ensure that the search results are displayed, not the "normal" content.
assert-css: ("#main", {"display": "none"})

// Now we can check that the feature is working as expected!
goto: file://|DOC_PATH|/test_docs/index.html?search=struct%3AFoo&go_to_first=true
// Waiting for the page to load...
wait-for: 500
assert-text: (".fqn .in-band", "Struct test_docs::Foo")