Skip to content

Fix flaky gui tests #3074

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
ehuss merged 2 commits into from
Apr 21, 2026
+46 −44
Merged

Fix flaky gui tests #3074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4efaff
Try to make heading-nav-collapsed test more reliable
ehuss Apr 3, 2026
dc2fbde
Harden move-between-pages and sidebar-scroll tests
ehuss Apr 20, 2026
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
51 changes: 26 additions & 25 deletions tests/gui/heading-nav-collapsed.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,51 @@ assert-text: (".current-header", "Heading 1")
// Collapsed elements do not have "expanded" class.
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
assert-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "none"})

assert-property: ("div.on-this-page", {"innerHTML": '<ol class="section"><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-1" class="header-in-summary current-header">Heading 1</a></span><ol class="section"><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-11" class="header-in-summary">Heading 1.1</a></span></li><li class="header-item"><span class="chapter-link-wrapper"><a href="#heading-12" class="header-in-summary">Heading 1.2</a><a class="chapter-fold-toggle header-toggle"><div>❱</div></a></span><ol class="section"><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-121" class="header-in-summary">Heading 1.2.1</a></span></li><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-122" class="header-in-summary">Heading 1.2.2</a></span></li></ol></li><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-13" class="header-in-summary">Heading 1.3</a></span></li></ol></li><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-2" class="header-in-summary">Heading 2</a></span><ol class="section"><li class="header-item"><span class="chapter-link-wrapper"><a href="#heading-21" class="header-in-summary">Heading 2.1</a><a class="chapter-fold-toggle header-toggle"><div>❱</div></a></span><ol class="section"><li class="header-item"><span class="chapter-link-wrapper"><a href="#heading-211" class="header-in-summary">Heading 2.1.1</a><a class="chapter-fold-toggle header-toggle"><div>❱</div></a></span><ol class="section"><li class="header-item"><span class="chapter-link-wrapper"><a href="#heading-2111" class="header-in-summary">Heading 2.1.1.1</a><a class="chapter-fold-toggle header-toggle"><div>❱</div></a></span><ol class="section"><li class="header-item expanded"><span class="chapter-link-wrapper"><a href="#heading-21111" class="header-in-summary">Heading 2.1.1.1.1</a></span></li></ol></li></ol></li></ol></li></ol></li></ol>'})

// Click 1.2, expands it.
click: "a.header-in-summary[href='#heading-12']"
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item expanded"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "block"})
wait-for-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item expanded"})
wait-for-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
wait-for-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "block"})

// Click 1.1, should collapse it.
click: "a.header-in-summary[href='#heading-11']"
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
wait-for-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
wait-for-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
wait-for-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})

// Click the chevron, should expand it.
click: "a.header-in-summary[href='#heading-12'] ~ a.header-toggle"
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item expanded"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "block"})
wait-for-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item expanded"})
wait-for-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
wait-for-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "block"})

assert-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "none"})
// Click 1.3
click: "a.header-in-summary[href='#heading-13']"
// Everything should be collapsed
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
assert-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "none"})
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-211'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-2111'])", {"class": "header-item"})
wait-for-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
wait-for-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item"})
wait-for-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
wait-for-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "none"})
wait-for-attribute: ("li:has(> span > a[href='#heading-211'])", {"class": "header-item"})
wait-for-attribute: ("li:has(> span > a[href='#heading-2111'])", {"class": "header-item"})

// Scroll to bottom of page
press-key: 'PageDown'
press-key: 'PageDown'
press-key: 'PageDown'
press-key: 'PageDown'
// 2.1.1.1.1 should be visible, and all the chevrons should be open, and expanded should be on each one
assert-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
assert-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item expanded"})
assert-attribute: ("li:has(> span > a[href='#heading-211'])", {"class": "header-item expanded"})
assert-attribute: ("li:has(> span > a[href='#heading-2111'])", {"class": "header-item expanded"})
assert-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
assert-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "block"})
assert-css: ("//a[@href='#heading-211']/../following-sibling::ol", {"display": "block"})
assert-css: ("//a[@href='#heading-2111']/../following-sibling::ol", {"display": "block"})
wait-for-attribute: ("li:has(> span > a[href='#heading-12'])", {"class": "header-item"})
wait-for-attribute: ("li:has(> span > a[href='#heading-21'])", {"class": "header-item expanded"})
wait-for-attribute: ("li:has(> span > a[href='#heading-211'])", {"class": "header-item expanded"})
wait-for-attribute: ("li:has(> span > a[href='#heading-2111'])", {"class": "header-item expanded"})
wait-for-css: ("//a[@href='#heading-12']/../following-sibling::ol", {"display": "none"})
wait-for-css: ("//a[@href='#heading-21']/../following-sibling::ol", {"display": "block"})
wait-for-css: ("//a[@href='#heading-211']/../following-sibling::ol", {"display": "block"})
wait-for-css: ("//a[@href='#heading-2111']/../following-sibling::ol", {"display": "block"})
24 changes: 12 additions & 12 deletions tests/gui/move-between-pages.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,41 @@
go-to: |DOC_PATH| + "all-summary/index.html"

// default page is the first chapter
assert-text: ("title", "Prefix 1 - all-summary")
wait-for-text: ("title", "Prefix 1 - all-summary")

// Trying to move to the left beyond the prefix pages - nothing changes
press-key: 'ArrowLeft'
assert-text: ("title", "Prefix 1 - all-summary")
wait-for-text: ("title", "Prefix 1 - all-summary")

// Move left
go-to: |DOC_PATH| + "all-summary/intro.html"
assert-text: ("title", "Introduction - all-summary")
wait-for-text: ("title", "Introduction - all-summary")

press-key: 'ArrowLeft'
assert-text: ("title", "Prefix 2 - all-summary")
wait-for-text: ("title", "Prefix 2 - all-summary")

press-key: 'ArrowLeft'
assert-text: ("title", "Prefix 1 - all-summary")
wait-for-text: ("title", "Prefix 1 - all-summary")

// Move right
press-key: 'ArrowRight'
assert-text: ("title", "Prefix 2 - all-summary")
wait-for-text: ("title", "Prefix 2 - all-summary")

press-key: 'ArrowRight'
assert-text: ("title", "Introduction - all-summary")
wait-for-text: ("title", "Introduction - all-summary")

press-key: 'ArrowRight'
assert-text: ("title", "P1 C1 - all-summary")
wait-for-text: ("title", "P1 C1 - all-summary")

press-key: 'ArrowRight'
assert-text: ("title", "P2 C1 - all-summary")
wait-for-text: ("title", "P2 C1 - all-summary")

press-key: 'ArrowRight'
assert-text: ("title", "Suffix 1 - all-summary")
wait-for-text: ("title", "Suffix 1 - all-summary")

press-key: 'ArrowRight'
assert-text: ("title", "Suffix 2 - all-summary")
wait-for-text: ("title", "Suffix 2 - all-summary")

// Try to go beyond the last page
press-key: 'ArrowRight'
assert-text: ("title", "Suffix 2 - all-summary")
wait-for-text: ("title", "Suffix 2 - all-summary")
15 changes: 8 additions & 7 deletions tests/gui/sidebar-scroll.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assert-property: (".sidebar-scrollbox", {"scrollTop": 0})

click: ".chapter a[href='chapter_2.html']"
assert-text: ("title", "Chapter 2 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": 0})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": 0})

click: ".chapter a[href='chapter_10.html']"
assert-text: ("title", "Chapter 10 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": 0})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": 0})

// Check that heading nav of chapter 10 pushes 11 off the bottom.
store-position: (".chapter a[href='chapter_11.html']", {"y": chapter_y})
Expand All @@ -21,7 +21,7 @@ assert: |chapter_y| > |windowHeight|
// in position since there are only a few lines above.
click: ".chapter a[href='chapter_11.html']"
assert-text: ("title", "Chapter 11 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": 0})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": 0})

// Scroll down a little, and click on a chapter that can stay in place when
// clicked.
Expand All @@ -30,11 +30,12 @@ store-property: (".sidebar-scrollbox", {"scrollTop": sidebarScrollTop})
assert: |sidebarScrollTop| > 0
click: ".chapter a[href='chapter_35.html']"
assert-text: ("title", "Chapter 35 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})

// Go to the next chapter, and verify that it scrolls to the middle.
press-key: "ArrowRight"
assert-text: ("title", "Chapter 36 - sidebar-scroll")
wait-for: ".chapter a.active"
// The active link should be roughly in the middle of the screen.
store-position: (".chapter a.active", {"y": active_y})
// Approximate check just in case the browser has slight rendering differences.
Expand All @@ -45,7 +46,7 @@ assert: |active_y| < 450
store-property: (".sidebar-scrollbox", {"scrollTop": sidebarScrollTop})
click: ".chapter a[href='chapter_24.html']"
assert-text: ("title", "Chapter 24 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})

// Go to the last chapter, and verify it is scrolled to the bottom.
go-to: |DOC_PATH| + "sidebar-scroll/chapter_100.html"
Expand All @@ -57,9 +58,9 @@ assert: |scrollTop| >= |scrollHeight| - |clientHeight| - 1
store-property: (".sidebar-scrollbox", {"scrollTop": sidebarScrollTop})
click: ".chapter a[href='chapter_97.html']"
assert-text: ("title", "Chapter 97 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})

store-property: (".sidebar-scrollbox", {"scrollTop": sidebarScrollTop})
click: ".chapter a[href='chapter_76.html']"
assert-text: ("title", "Chapter 76 - sidebar-scroll")
assert-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})
wait-for-property: (".sidebar-scrollbox", {"scrollTop": |sidebarScrollTop|})