Skip to content
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.

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

Fix flaky tests in advantage_air #129758

Merged
merged 2 commits into from
Nov 3, 2024
Merged

Fix flaky tests in advantage_air #129758

merged 2 commits into from
Nov 3, 2024

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Nov 3, 2024

Breaking change

Proposed change

#129735 reduced the occurrences, but it is still flaky

There must be a better way to resolve this - but I couldn't work one out...
I believe it is now resolved.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • 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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

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

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

  • The manifest file 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 link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Nov 3, 2024

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

Code owner commands

Code owners of advantage_air can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign advantage_air Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@Bre77
Copy link
Contributor

Bre77 commented Nov 3, 2024

I'll take a look for the root cause soon. There must be some sort of race condition.

@epenet
Copy link
Contributor Author

epenet commented Nov 3, 2024

I'll take a look for the root cause soon. There must be some sort of race condition.

Yes - I think I have resolved the issue now: patching the reload timeout means that it reloads more quickly, before the next update triggers.

I think this is the correct way of resolving the race condition.

await hass.async_block_till_done(wait_background_tasks=True)
assert len(mock_get.mock_calls) == 3

with patch("homeassistant.config_entries.RELOAD_AFTER_UPDATE_DELAY", 1):
Copy link
Member

Choose a reason for hiding this comment

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

Patching RELOAD_AFTER_UPDATE_DELAY isn't great, but its an existing issue

@Bre77 Bre77 mentioned this pull request Nov 3, 2024
19 tasks
@Bre77
Copy link
Contributor

Bre77 commented Nov 3, 2024

I am reworking the tests because this whole reload business is redundant given we can test with @pytest.mark.usefixtures("entity_registry_enabled_by_default"), however since you have fixed the tests we might as well get this merged to fix the issue immediately.

@bdraco bdraco merged commit f11aba9 into dev Nov 3, 2024
32 checks passed
@bdraco bdraco deleted the epenet-20241103-2318 branch November 3, 2024 23:25
@github-actions github-actions bot locked and limited conversation to collaborators Nov 5, 2024
@bdraco bdraco added this to the 2024.11.2 milestone Nov 13, 2024
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