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 Whirlpool sensor tests #142437

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Refactor Whirlpool sensor tests #142437

wants to merge 1 commit into from

Conversation

abmantis
Copy link
Contributor

@abmantis abmantis commented Apr 6, 2025

Proposed change

This is a full rewrite of the sensor platform tests in an attempt to make them easier to maintain and support new sensors in the future.

  • fix methods in WASHER_DRYER_CYCLE_FUNC not being mocked (and remove workarounds using attr_value_to_bool in tests).
  • split the washer and dryer fixtures, since they have different sensors (and will be split in the library in the future).
  • rename mock_sensor* fixtures, to mock_washer and mock_dryer since in the future other types of appliances may have sensors too.
  • unify tests for common washer dryer sensors.
  • simplify main sensor state tests.
  • add snapshots for sensors (and enabling disabled-by-default entities for them).

These changes should also make it easier to add and test new sensors if they are simple, since only snapshots need to be updated.

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:

@home-assistant
Copy link

home-assistant bot commented Apr 6, 2025

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

Code owner commands

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

@abmantis abmantis requested a review from Copilot April 6, 2025 22:01
Copy link

@Copilot 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.

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Files not reviewed (2)
  • tests/components/whirlpool/snapshots/test_diagnostics.ambr: Language not supported
  • tests/components/whirlpool/snapshots/test_sensor.ambr: Language not supported

'unit_of_measurement': None,
})
# ---
# name: test_all_entities[sensor.dryer_none-state]
Copy link
Member

Choose a reason for hiding this comment

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

dryer_none?

Comment on lines +26 to +33
@pytest.fixture
def entity_registry_enabled_by_default() -> Generator[None]:
"""Test fixture that ensures entities are enabled in the registry."""
with mock.patch(
"homeassistant.components.whirlpool.sensor.WhirlpoolSensor.entity_registry_enabled_default",
return_value=True,
):
yield
Copy link
Member

Choose a reason for hiding this comment

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

this one already exists

@pytest.mark.usefixtures("entity_registry_enabled_by_default")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants