Skip to content

Fix flaky cloud TTS and picotts streaming tests#169376

Merged
justanotherariel merged 2 commits intodevfrom
fix/cloud-tts-flaky-test
Apr 28, 2026
Merged

Fix flaky cloud TTS and picotts streaming tests#169376
justanotherariel merged 2 commits intodevfrom
fix/cloud-tts-flaky-test

Conversation

@epenet
Copy link
Copy Markdown
Contributor

@epenet epenet commented Apr 28, 2026

Proposed change

Wait for background tasks to complete after triggering the streaming GET in two TTS tests, so the background task that loads the streamed audio (and the ffmpeg conversion subprocess) finishes before assertions run / the test ends:

  • tests/components/cloud/test_tts.py::test_get_tts_audio
  • tests/components/picotts/test_tts.py::test_tts_service

In both tests the TTS audio is loaded into the cache by a hass background task. The streaming GET (await client.get(...) directly, or via the shared retrieve_media helper) only awaits response headers — the streaming background task can still be in flight when the test body finishes. Plain async_block_till_done() does not wait for background tasks, so the task can outlive the test and surface as teardown errors.

The cloud failure was spotted in the failing CI job for #162263:
https://github.com/home-assistant/core/actions/runs/25057100718/job/73402201821?pr=162263

Adding await hass.async_block_till_done(wait_background_tasks=True) after the streaming GET matches the pattern already used in tests/components/tts/test_init.py.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the [development checklist][dev-checklist]
  • I have followed the [perfect PR recommendations][perfect-pr]
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

  • Documentation added/updated for [www.home-assistant.io][docs-repository]

If the code communicates with devices, web services, or third-party tools:

  • The [manifest file][manifest-docs] has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

Wait for background tasks to complete after triggering streaming so
the streaming background task that calls process_tts_stream finishes
before assertions run.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 28, 2026 14:19
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/cloud, mind taking a look at this pull request as it has been labeled with an integration (cloud) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of cloud can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign cloud Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Wait for background tasks to complete after retrieve_media so the
streaming background task finishes before the test ends.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@epenet epenet changed the title Fix flaky cloud TTS test_get_tts_audio Fix flaky cloud TTS and picotts streaming tests Apr 28, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Improves the reliability of the Home Assistant Cloud TTS URL test by ensuring Home Assistant background tasks complete before assertions run, preventing teardown-time failures from still-running streaming/conversion work.

Changes:

  • Add wait_background_tasks=True when blocking after triggering the TTS proxy GET in test_get_tts_audio.

Comment thread tests/components/cloud/test_tts.py
@epenet epenet marked this pull request as ready for review April 28, 2026 14:57
@justanotherariel justanotherariel merged commit 6636e67 into dev Apr 28, 2026
34 checks passed
@justanotherariel justanotherariel deleted the fix/cloud-tts-flaky-test branch April 28, 2026 16:38
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants