Skip to content

stale_response.test.py: address log wait flakiness #13323

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

Open
bneradt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

stale_response.test.py: address log wait flakiness #13323

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
33 changes: 14 additions & 19 deletions tests/gold_tests/pluginTest/stale_response/stale_response.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,28 +140,23 @@ def setupClient(self, tr: 'TestRun') -> None:

def verify_plugin_log(self) -> None:
"""Verify the contents of the stale_response plugin log."""
tr = Test.AddTestRun("Verify stale_response plugin log")
name = f'log_waiter_{TestStaleResponse._ts_counter}'
log_waiter = tr.Processes.Process(name)
log_waiter.Command = 'sleep 30'
swr_log_pattern = "stale-while-revalidate:.*stale.jpeg"
sie_log_pattern = "stale-if-error:.*error.jpeg"

def expect_log_entry(pattern: str, description: str, still_running_after: bool = False) -> None:
tr = Test.AddAwaitFileContainsTestRun(f"Await {description}", self._ts.Disk.stale_responses_log.AbsPath, pattern)
tr.StillRunningBefore = self._ts
if still_running_after:
tr.StillRunningAfter = self._ts
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(pattern, f"Verify {description}")
Comment on lines +146 to +151

@moonchen moonchen Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The old waiter run set StillRunningAfter = self._ts in every branch; with the flag, the FORCE_SWR/FORCE_SIE variants no longer check that ATS is still alive after the directive is flushed. Setting it unconditionally restores that and removes the asymmetry.

Suggested change
def expect_log_entry(pattern: str, description: str, still_running_after: bool = False) -> None:
tr = Test.AddAwaitFileContainsTestRun(f"Await {description}", self._ts.Disk.stale_responses_log.AbsPath, pattern)
tr.StillRunningBefore = self._ts
if still_running_after:
tr.StillRunningAfter = self._ts
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(pattern, f"Verify {description}")
def expect_log_entry(pattern: str, description: str) -> None:
tr = Test.AddAwaitFileContainsTestRun(f"Await {description}", self._ts.Disk.stale_responses_log.AbsPath, pattern)
tr.StillRunningBefore = self._ts
tr.StillRunningAfter = self._ts
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(pattern, f"Verify {description}")


if self._option_type == OptionType.FORCE_SWR:
log_waiter.Ready = When.FileContains(self._ts.Disk.stale_responses_log.Name, "stale-while-revalidate:")
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(
"stale-while-revalidate:.*stale.jpeg", "Verify stale-while-revalidate directive is logged")
expect_log_entry(swr_log_pattern, "stale-while-revalidate directive is logged")
elif self._option_type == OptionType.FORCE_SIE:
log_waiter.Ready = When.FileContains(self._ts.Disk.stale_responses_log.Name, "stale-if-error:")
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(
"stale-if-error:.*error.jpeg", "Verify stale-if-error directive is logged")
expect_log_entry(sie_log_pattern, "stale-if-error directive is logged")
else:
log_waiter.Ready = When.FileContains(self._ts.Disk.stale_responses_log.Name, "stale-if-error:")
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(
"stale-while-revalidate:.*stale.jpeg", "Verify stale-while-revalidate directive is logged")
self._ts.Disk.stale_responses_log.Content += Testers.ContainsExpression(
"stale-if-error:.*error.jpeg", "Verify stale-if-error directive is logged")
p = tr.Processes.Default
p.Command = 'echo "Waiting upon the stale response log."'
p.StartBefore(log_waiter)
p.StillRunningAfter = self._ts
expect_log_entry(swr_log_pattern, "stale-while-revalidate directive is logged", still_running_after=True)

@moonchen moonchen Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

(goes with the helper change above)

Suggested change
expect_log_entry(swr_log_pattern, "stale-while-revalidate directive is logged", still_running_after=True)
expect_log_entry(swr_log_pattern, "stale-while-revalidate directive is logged")

expect_log_entry(sie_log_pattern, "stale-if-error directive is logged")


TestStaleResponse(OptionType.NONE, is_global=True)
Expand Down