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

Refactor rainforest_raven coordinator tests #128591

Merged
merged 9 commits into from
Oct 18, 2024

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Oct 17, 2024

Proposed change

Follow-up to #128517

  • move the initialisation tests to test_init.py, and check config entry state rather than coordinator error
  • move coordinator refresh tests to test_sensor.py and use async_fire_time_changed

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

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

Code owner commands

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

@cottsay
Copy link
Contributor

cottsay commented Oct 17, 2024

Thanks for this. I don't see anything concerning about this change, however it would be nice if these changes didn't regress the test coverage statistics for the integration. Is there any chance you can bump that back up?

@epenet epenet marked this pull request as ready for review October 17, 2024 14:55
@epenet epenet marked this pull request as draft October 17, 2024 14:57
@epenet
Copy link
Contributor Author

epenet commented Oct 17, 2024

Thanks for this. I don't see anything concerning about this change, however it would be nice if these changes didn't regress the test coverage statistics for the integration. Is there any chance you can bump that back up?

The problem is that your tests do not reflect the reality...
Your tests are based on the assumption that self._device_info is read before the config entry is loaded.

Instead, the tests should be based on the the config entry being loaded, but the device returning empty information.

I have adjusted this accordingly.

@epenet epenet marked this pull request as ready for review October 17, 2024 15:12
@epenet epenet changed the title Refactor rainforest_raven tests Refactor rainforest_raven coordinator tests Oct 17, 2024
@cottsay
Copy link
Contributor

cottsay commented Oct 17, 2024

The problem is that your tests do not reflect the reality...
Your tests are based on the assumption that self._device_info is read before the config entry is loaded.

Instead, the tests should be based on the the config entry being loaded, but the device returning empty information.

Sure, I'm on board. No need to convince me.

Can it be done without regressing the integration's test coverage statistics?

EDIT: Ah, looks like b173f94 resolved this. Thanks!

Copy link
Contributor Author

@epenet epenet left a comment

Choose a reason for hiding this comment

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

I've increased the abstraction layer of the tests, so that e test via the device_registry instead of testing the properties of the coordinator.

There are three tests left that call async_refresh but I think these should be update in a later PR.

@epenet epenet marked this pull request as draft October 18, 2024 09:12
@epenet epenet marked this pull request as ready for review October 18, 2024 10:33
@epenet epenet marked this pull request as draft October 18, 2024 10:34
@epenet epenet marked this pull request as ready for review October 18, 2024 10:36
@epenet epenet marked this pull request as draft October 18, 2024 10:53
@epenet epenet marked this pull request as ready for review October 18, 2024 13:56
@epenet epenet merged commit 8c4b076 into home-assistant:dev Oct 18, 2024
32 checks passed
@epenet epenet deleted the 20241017-1632 branch October 18, 2024 14:00
@github-actions github-actions bot locked and limited conversation to collaborators Oct 19, 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