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

Address Crownstone review comments #56485

Merged

Conversation

RicArch97
Copy link
Contributor

Breaking change

Proposed change

Address the extra review comments by @MartinHjelmare in #50677

I have not found a good way to deal with the use of persistent notification in entry_manager.py, line 143. After testing i'm sure that triggering a new flow is not a good idea here. Especially not without any context (notification) why it was triggered.

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

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.
  • 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.

The integration reached or maintains the following Integration Quality Scale:

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

To help with the load of incoming pull requests:

* Revert property addition, as we would otherwise have to add extra cast statements for every usage of the property. This way the type check knows exactly what type it is.
* These entries shall be added as binary sensors later.
* Use CrownstoneNotFoundError instead of generic KeyError
* Created base class for a Crownstone flow, which has methods used by both config and options flow

* Fix step id's

* Update tests to set up the integration before starting options flow; This includes a small change to write to hass.data in async_setup_entry, and not in entry_manager.async setup. This avoids having mock all the code in entry_manager.async_setup and we can just mock CrownstoneEntryManager entirely.
@probot-home-assistant
Copy link

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

@bdraco bdraco added the smash Indicator this PR is close to finish for merging or closing label Sep 21, 2021
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Nice!

* Use fixtures for other frequently used patches, and decorate with pytest.mark.usefixtures.
* Test if the integration setup was called in every config flow test.
* Use a type alias for fixtures to provide more clarity of what these parameters are.
@RicArch97
Copy link
Contributor Author

Thanks Martin, all fixtures yield their mock now and are tested on call count in the tests where they are used. I'm slowly getting more familiar with the pytest toolkit :)

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Great!

@MartinHjelmare MartinHjelmare merged commit 63610ea into home-assistant:dev Sep 23, 2021
@bdraco
Copy link
Member

bdraco commented Sep 23, 2021

Thank you!

@RicArch97 RicArch97 deleted the crownstone_review_comments branch September 23, 2021 13:08
@github-actions github-actions bot locked and limited conversation to collaborators Sep 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants