Skip to content

Fix flaky velbus test #149743

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

Jump to bottom
Merged
merged 4 commits into from
Aug 1, 2025
Merged

Fix flaky velbus test #149743

merged 4 commits into from
Aug 1, 2025

Conversation

@emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Jul 31, 2025

Proposed change

SSIA

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:
  • Link to developer documentation pull request:
  • Link to frontend 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:

@emontnemery emontnemery added this to the 2025.8.0 milestone Jul 31, 2025
Copilot AI review requested due to automatic review settings July 31, 2025 12:00
@home-assistant
Copy link

home-assistant bot commented Jul 31, 2025

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

Code owner commands

Code owners of velbus 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 velbus 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.

Copilot AI reviewed Jul 31, 2025
View reviewed changes
Copy link
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

This PR fixes a flaky test in the Velbus integration by adding sorting to the device registry entries comparison to ensure deterministic test results.

  • Adds sorting to device entries comparison to prevent test flakiness due to random ordering

tests/components/velbus/test_init.py
Comment on lines 176 to 179
device_entries = dr.async_entries_for_config_entry(
device_registry, config_entry.entry_id
)
assert device_entries == snapshot
assert sorted(device_entries, key=lambda x: list(x.identifiers)[0][1]) == snapshot
Copy link

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

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

[nitpick] The sorting key lambda x: list(x.identifiers)[0][1] is complex and could be unclear to future maintainers. Consider extracting this into a named function or adding a comment explaining that it sorts by the second element of the first identifier tuple.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@emontnemery emontnemery Jul 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

adding a comment explaining that it sorts by the second element of the first identifier tuple

There's no need to explain that, because that's literally what the lambda does. We should explain why we need to sort though (the order of the list returned by async_entries_for_config_entry is not consistent)

@emontnemery
Copy link
Contributor Author

emontnemery commented Jul 31, 2025

The test is still flaky, just sorting the device list is apparently not enough

@emontnemery emontnemery marked this pull request as draft July 31, 2025 13:56
@emontnemery emontnemery marked this pull request as draft July 31, 2025 13:56
@emontnemery
Copy link
Contributor Author

emontnemery commented Jul 31, 2025

@cereal2nd @brefra The sorting in the initial commit seems safe, but I'm not sure about the changes in the last commit. Could you have a look please?

@emontnemery emontnemery marked this pull request as ready for review July 31, 2025 14:19
@emontnemery emontnemery requested a review from joostlek July 31, 2025 16:33
@emontnemery
Copy link
Contributor Author

emontnemery commented Aug 1, 2025

I'm merging this now. @cereal2nd @brefra if the solution in the PR is not good, please fix that in a follow-up 👍

@emontnemery emontnemery merged commit 4d59e8c into dev Aug 1, 2025
34 checks passed
@emontnemery emontnemery deleted the fix_velbus_test branch August 1, 2025 05:49
@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@thecode thecode thecode approved these changes

@joostlek joostlek Awaiting requested review from joostlek

Assignees

No one assigned

Labels

cherry-picked cla-signed code-quality has-tests integration: velbus Quality Scale: bronze small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

2025.8.0

Development

Successfully merging this pull request may close these issues.

5 participants

@emontnemery @thecode @joostlek @bramkragten