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 flaky lru_cache test #101252

Merged
merged 1 commit into from
Oct 2, 2023
Merged

Fix flaky lru_cache test #101252

merged 1 commit into from
Oct 2, 2023

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Oct 2, 2023

Proposed change

Sometimes test_override_single_value would fail during a CI run.

FAILED tests/helpers/test_entity_values.py::test_override_single_value - assert 3 == 1
 +  where 3 = CacheInfo(hits=0, misses=3, maxsize=16384, currsize=3).currsize
 +    where CacheInfo(hits=0, misses=3, maxsize=16384, currsize=3) = <built-in method cache_info of functools._lru_cache_wrapper object at 0x7f5e05ba78a0>()
 +      where <built-in method cache_info of functools._lru_cache_wrapper object at 0x7f5e05ba78a0> = <bound method EntityValues.get of <homeassistant.helpers.entity_values.EntityValues object at 0x7f5dc8f43da0>>.cache_info
 +        where <bound method EntityValues.get of <homeassistant.helpers.entity_values.EntityValues object at 0x7f5dc8f43da0>> = <homeassistant.helpers.entity_values.EntityValues object at 0x7f5dc8f43da0>.get

That is caused if test_override_by_domain and / or test_override_by_glob is run beforehand.
The reason is that the lru_cache is created for the class, not a specific entity. I.e.

store = EV(...)
store.get(val)

store2 = EV(...)
store2.get(val)

would create two cache entries even if val is the same.

--
To reproduce the error locally

pytest \
  tests/helpers/test_entity_values.py::test_override_by_domain \
  tests/helpers/test_entity_values.py::test_override_by_glob \
  tests/helpers/test_entity_values.py::test_override_single_value

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:

@cdce8p cdce8p added the smash Indicator this PR is close to finish for merging or closing label Oct 2, 2023
@cdce8p cdce8p mentioned this pull request Oct 2, 2023
32 tasks
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @cdce8p 👍

../Frenck

@frenck frenck merged commit 100b6fd into home-assistant:dev Oct 2, 2023
31 checks passed
@cdce8p cdce8p deleted the fix-flaky-test branch October 2, 2023 12:24
@github-actions github-actions bot locked and limited conversation to collaborators Oct 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed code-quality core Hacktoberfest small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants