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.

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

Refactor tests for Brother integration #117377

Merged
merged 11 commits into from
May 19, 2024
Merged

Refactor tests for Brother integration #117377

merged 11 commits into from
May 19, 2024

Conversation

bieniu
Copy link
Member

@bieniu bieniu commented May 13, 2024

Breaking change

Proposed change

Refactors tests and increases coverage.

Name                                              Stmts   Miss  Cover   Missing
-------------------------------------------------------------------------------
homeassistant/components/brother/__init__.py         31      0   100%
homeassistant/components/brother/config_flow.py      61      0   100%
homeassistant/components/brother/const.py             7      0   100%
homeassistant/components/brother/coordinator.py      18      0   100%
homeassistant/components/brother/diagnostics.py       8      0   100%
homeassistant/components/brother/sensor.py           46      0   100%
homeassistant/components/brother/utils.py            20      0   100%
-------------------------------------------------------------------------------
TOTAL                                               191      0   100%

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

joostlek
joostlek reviewed May 13, 2024
View reviewed changes
tests/components/brother/test_config_flow.py Outdated
Comment on lines 86 to 89
with (
patch("brother.Brother.initialize"),
patch("brother.Brother._get_data", side_effect=UnsupportedModelError("error")),
patch("homeassistant.components.brother.Brother.initialize"),
patch(
"homeassistant.components.brother.Brother._get_data",
side_effect=UnsupportedModelError("error"),
),
):
Copy link
Member

Choose a reason for hiding this comment

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

2 things, why isn't this patched in the config flow, and can't we use the new mock for this?

Copy link
Member Author

@bieniu bieniu May 13, 2024 •
edited

Choose a reason for hiding this comment

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

This exception may occur in the Brother.create method, and this method is used to create an instance of the Brother class, I was unable to get AsyncMock to raise the exception as a side_effect. Something like this doesn't work

mock_brother_client.create.side_effect = UnsupportedModelError("error")

Maybe there is a better way to achieve this?

Copy link
Member

Choose a reason for hiding this comment

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

I'm just going to throw some ideas, I will have some time later to actually test some

mock_client.create.return_value.side_effect = UnsupportedModelError("error")
mock_client.create.return_value = UnsupportedModelError("error")

Copy link
Member Author

@bieniu bieniu May 13, 2024 •
edited

Choose a reason for hiding this comment

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

Unfortunately, these propositions also do not give the desired effect 😒

Copy link
Member

Choose a reason for hiding this comment

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

Have you tried something like

core/tests/components/shelly/test_config_flow.py

Lines 867 to 869 in f23419e

patch(
"aioshelly.block_device.BlockDevice.create",
new=AsyncMock(side_effect=InvalidAuthError),

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, this simplifies tests a bit, but I still can't force a fixture mock to raise an exception for the create() method.

joostlek
joostlek reviewed May 13, 2024
View reviewed changes
tests/components/brother/test_config_flow.py Outdated
with (
patch("brother.Brother.initialize"),
patch("brother.Brother._get_data") as mock_get_data,
patch("homeassistant.components.brother.Brother.initialize"),
patch("homeassistant.components.brother.Brother._get_data") as mock_get_data,
):
Copy link
Member

Choose a reason for hiding this comment

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

idem

joostlek
joostlek reviewed May 13, 2024
View reviewed changes
tests/components/brother/test_init.py Outdated
unique_id="0123456789",
data={CONF_HOST: "localhost", CONF_TYPE: "laser"},
)
with patch("homeassistant.components.brother.Brother.create", side_effect=exc):
Copy link
Member

Choose a reason for hiding this comment

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

We can use the asyncmock here as well I think

@bieniu bieniu merged commit 826f6c6 into home-assistant:dev May 19, 2024
24 checks passed
@bieniu bieniu deleted the brother-refactor-tests branch May 19, 2024 18:41
@github-actions github-actions bot locked and limited conversation to collaborators May 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@thecode thecode thecode approved these changes

@joostlek joostlek joostlek approved these changes

Assignees
No one assigned
Labels
by-code-owner cla-signed code-quality has-tests integration: brother Quality Scale: platinum small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@bieniu @thecode @joostlek