Skip to content

Use non-autospec mock for Reolink's button tests #146969

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

Merged
merged 2 commits into from
Jun 16, 2025
Merged

Conversation

abmantis
Copy link
Member

@abmantis abmantis commented Jun 16, 2025

Proposed change

This is an initial PR to completely drop autospec'ed mocks from Reolink.

The reason is that autospec made the tests too slow, so the fixture scope was changed to 'module' in #125215
Having the fixture scope as 'module' makes the test methods spill over each other, which makes them fragile and more complex since they have to clean up the mock's state.

I will update the remaining platform tests in followup PRs.

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:

This is an initial PR to completely drop autospec'ed mocks from Reolink.

The reason is that autospec made the tests too slow, so the fixture scope was changed to
'module' in #125215
Having the fixture scope as 'module' makes the test methods spill over each other, which
makes them fragile and more complex since they have to clean up the mock's state.

I will update the remaining platform tests in followup PRs.
@home-assistant
Copy link

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

Code owner commands

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

@@ -62,6 +62,100 @@ def mock_setup_entry() -> Generator[AsyncMock]:
yield mock_setup_entry


def _init_host_mock(host_mock: MagicMock) -> None:
Copy link
Member Author

Choose a reason for hiding this comment

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

in the final PR, after removing everything that depends on autospec, I'll remove reolink_connect_class() and just move what's on this method to reolink_host().

Copy link
Contributor

Choose a reason for hiding this comment

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

seems good

Copy link
Contributor

@starkillerOG starkillerOG left a comment

Choose a reason for hiding this comment

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

LGTM.

Did you check how long it took to run the test before and after this PR?

@abmantis
Copy link
Member Author

abmantis commented Jun 16, 2025

Did you check how long it took to run the test before and after this PR?

Running only the test_button.py tests, it goes down from ~0.55s on dev to ~0.35s on this branch.

@starkillerOG
Copy link
Contributor

Perfect, lets wait for the CLI and then we can merge

@starkillerOG starkillerOG merged commit 6f3ceb8 into dev Jun 16, 2025
34 checks passed
@starkillerOG starkillerOG deleted the reolink_test_nospec branch June 16, 2025 19:14
@github-actions github-actions bot locked and limited conversation to collaborators Jun 17, 2025
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.

2 participants