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

Add constant for PlatformNotReady wait time to use in tests #37266

Merged
merged 1 commit into from
Jul 1, 2020

Conversation

mdegat01
Copy link
Contributor

Proposed change

When a platform returns a PlatformNotReady exception then entity_platform.py handles it by waiting for 30 seconds * number of setup attempts before trying again. When testing this behavior in tests the recommendation is to try and setup the platform while forcing a failure, fix the failure, advance time, and see that is has been setup.

Since "30 seconds" was simply hard-coded into the logic tests are currently forced to advance time an arbitrarily long amount of time to ensure it was enough to satisfy this wait time (I saw code adding a few minutes generally). Thought it would be preferable to refactor this into a constant so tests can advance time by exactly that.

Also adjusted the InfluxDB sensor tests to import this new constant instead of creating it itself now that it is available. Just since that was the test I was working on that made me want this :)

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

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

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@probot-home-assistant
Copy link

Hey there @fabaff, mind taking a look at this pull request as its been labeled with an integration (influxdb) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

@MartinHjelmare MartinHjelmare changed the title Added constant for PlatformNotReady wait time to use in tests Add constant for PlatformNotReady wait time to use in tests Jun 30, 2020
@MartinHjelmare MartinHjelmare requested a review from balloob June 30, 2020 23:40
@balloob balloob merged commit 52f3238 into home-assistant:dev Jul 1, 2020
@mdegat01 mdegat01 deleted the platform-not-ready-constant branch July 1, 2020 22:23
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.

4 participants