Fix Sonos Tests failing intermittently on CI #114873
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Intermittently the pytests for Sonos would fail during CI. Over the last several weeks the problem has become much more consistent. Locally the tests would usually pass.
The root cause is the test was not properly waiting for tasks to complete and hence there was a race condition in the tests; that have likely become more acute due to the performance improvements in HA related to tasks and eager task execution.
I ran pytest test_alarms.py in a loop on my local machine, before the change it would fail within 15 iterations; after the change I let it run over night and it executed a thousand iterations with no issues.
Type of change
Additional information
Checklist
ruff format homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
..coveragerc
.To help with the load of incoming pull requests: