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

Fix EntityComponent lingering timer in helper tests #89801

Merged
merged 6 commits into from
Mar 17, 2023

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Mar 16, 2023

Proposed change

Linked to #89292

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 Black (black --fast 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:

@@ -46,6 +46,7 @@ async def test_polling_only_updates_entities_it_should_poll(
) -> None:
"""Test the polling of only updated entities."""
component = EntityComponent(_LOGGER, DOMAIN, hass, timedelta(seconds=20))
await component.async_setup({})
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the first type of change in the file.

Tests that create an instance of EntityComponent need to call async_setup so that it starts listening for STOP event from home assistant, which will trigger an automatic cleanup.

@@ -598,6 +615,8 @@ async def test_registry_respect_entity_namespace(
await platform.async_add_entities([entity])
assert entity.entity_id == "test_domain.ns_device_name"

await platform.async_shutdown()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the second type of change in the file.

Tests that create an instance of MockEntityPlatform need to shut it down at the end of the test to enforce a cleanup.

Copy link
Member

Choose a reason for hiding this comment

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

Can we have a MockEntityPlatform register itself to shut down itself at the end of a test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have removed these changes for now.
I'll have another look at this one later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I found a solution for this.
In order to avoid holding up this PR, I created a separate one in #89849

@epenet epenet changed the title Fix lingering timer in entity platform tests Fix lingering timer in entity helper tests Mar 16, 2023
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Looks good to me,
Thnx @epenet !

@epenet epenet changed the title Fix lingering timer in entity helper tests Fix EntityComponent lingering timer in helper tests Mar 17, 2023
@MartinHjelmare MartinHjelmare merged commit ab6e929 into home-assistant:dev Mar 17, 2023
@epenet epenet deleted the entity-platform branch March 17, 2023 09:30
@github-actions github-actions bot locked and limited conversation to collaborators Mar 18, 2023
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.

4 participants