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

Only load translations for an integration once per test session #117118

Merged
merged 5 commits into from
May 11, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 8, 2024

needs #117224

Proposed change

During a production run we cache the translations, but for tests we load english on every test (tests only have english). A new pytest fixture called translations_once with session scope allows translations to be shared between runs. It can be disabled for specific tests by using the disable_translations_once fixture. This sped up my local test runs by ~6%.

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:

During a production run we cache the translations, but for tests
we load them on every test. A new pytest fixture called
translations_once with session scope allows translations
to be shared between runs. It can be disabled for specific
tests by using the disable_translations_once fixture
@bdraco
Copy link
Member Author

bdraco commented May 9, 2024

That advantage air test is flakey. Probably going to need to fix that first since this change seems to make it worse as it likely takes more work out of the loop and now its more flakey

@bdraco bdraco marked this pull request as ready for review May 11, 2024 01:56
@bdraco bdraco requested a review from a team as a code owner May 11, 2024 01:56
@bdraco bdraco merged commit d7aa24f into dev May 11, 2024
34 checks passed
@bdraco bdraco deleted the share_translations_cache_between_runs branch May 11, 2024 03:00
@github-actions github-actions bot locked and limited conversation to collaborators May 12, 2024
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.

None yet

2 participants