Skip to content

Fix shelly device_trigger tests#169305

Merged
thecode merged 3 commits into
devfrom
epenet/20260427-1751
Apr 28, 2026
Merged

Fix shelly device_trigger tests#169305
thecode merged 3 commits into
devfrom
epenet/20260427-1751

Conversation

@epenet
Copy link
Copy Markdown
Contributor

@epenet epenet commented Apr 27, 2026

Proposed change

Linked to https://github.com/home-assistant/core/actions/runs/24982630534/job/73149424430?pr=162263

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

  • 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
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings April 27, 2026 15:52
@home-assistant home-assistant Bot added bugfix cla-signed has-tests integration: shelly small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage Top 50 Integration is ranked within the top 50 by usage labels Apr 27, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

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

Code owner commands

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

Comment on lines -906 to -907
and hasattr(entry, "runtime_data")
and isinstance(entry.runtime_data, ShellyEntryData)
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I could not find ANY path in which the entry would be loaded without the runtime_data being present.

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

This PR removes defensive runtime_data checks in Shelly coordinator lookup helpers and drops tests that exercised missing runtime_data scenarios.

Changes:

  • Remove hasattr(entry, "runtime_data") / isinstance(..., ShellyEntryData) guards when resolving Shelly coordinators by device_id.
  • Remove tests that monkeypatched Shelly config entries to delete runtime_data.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
homeassistant/components/shelly/coordinator.py Simplifies coordinator lookup by directly accessing entry.runtime_data when entries are loaded.
tests/components/shelly/test_device_trigger.py Removes tests covering triggers when runtime_data is forcibly removed from the config entry.

Comment thread homeassistant/components/shelly/coordinator.py
Comment thread homeassistant/components/shelly/coordinator.py
@epenet epenet marked this pull request as draft April 27, 2026 15:58
Co-authored-by: Copilot <copilot@github.com>
Comment on lines -396 to -403
async def test_rpc_no_runtime_data(
hass: HomeAssistant,
device_registry: dr.DeviceRegistry,
service_calls: list[ServiceCall],
mock_rpc_device: Mock,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Test the device trigger for the RPC device when there is no runtime_data in the entry."""
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PR marked as draft to let code-owners describe why these tests were added...

@thecode
Copy link
Copy Markdown
Member

thecode commented Apr 27, 2026

I am worried that we recreate the bug it fixed if we remove it, see details at #118805

@epenet epenet changed the title Remove invalid shelly runtime_data checks Fix shelly device_trigger tests Apr 28, 2026
Copilot AI review requested due to automatic review settings April 28, 2026 04:57
@epenet epenet marked this pull request as ready for review April 28, 2026 04:57
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread tests/components/shelly/test_device_trigger.py
Comment thread tests/components/shelly/test_device_trigger.py
@epenet
Copy link
Copy Markdown
Contributor Author

epenet commented Apr 28, 2026

I am worried that we recreate the bug it fixed if we remove it, see details at #118805

I have read it now - but it doesn't explain how that is possible :( and I still don't understand how it can occur. I think it points to a bigger underlying issue.

Anyway, I have reverted the code changes and only updated the tests to clean up after themselves.

@epenet epenet mentioned this pull request Apr 28, 2026
21 tasks
@thecode
Copy link
Copy Markdown
Member

thecode commented Apr 28, 2026

I don't understand why yet, but the changes in this PR remove 2 lines from the coverage
Before:

homeassistant/components/shelly/coordinator.py            443      0   100%

After:

homeassistant/components/shelly/coordinator.py            443      2    99%   210-211

Missing:

LOGGER.debug("Stopping RPC device coordinator for %s", self.name)
await self.shutdown()

We didn't have any specific test to cover it, but I am just wondering why this change remove the coverage for these lines.

@epenet
Copy link
Copy Markdown
Contributor Author

epenet commented Apr 28, 2026

I don't understand why yet, but the changes in this PR remove 2 lines from the coverage Before:

homeassistant/components/shelly/coordinator.py            443      0   100%

After:

homeassistant/components/shelly/coordinator.py            443      2    99%   210-211

Missing:

LOGGER.debug("Stopping RPC device coordinator for %s", self.name)
await self.shutdown()

We didn't have any specific test to cover it, but I am just wondering why this change remove the coverage for these lines.

I wonder if maybe:

  • previously, the entry unloading failed silently => the device was unloaded via HA_STOP
  • now the entry unloading succeeds => the device doesn't need unloading via HA_STOP

@thecode
Copy link
Copy Markdown
Member

thecode commented Apr 28, 2026

  • previously, the entry unloading failed silently => the device was unloaded via HA_STOP
  • now the entry unloading succeeds => the device doesn't need unloading via HA_STOP

Since the changes in this PR make sense (and your explanation) lets proceed with it, I will look into adding another test to cover HA_STOP (so that is is not covered by mistake as it is now)

@thecode thecode merged commit 7e2a7b9 into dev Apr 28, 2026
37 checks passed
@thecode thecode deleted the epenet/20260427-1751 branch April 28, 2026 10:50
@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.

Labels

bugfix cla-signed code-owner-approved has-tests integration: shelly Quality Scale: platinum small-pr PRs with less than 30 lines. Top 50 Integration is ranked within the top 50 by usage Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants