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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide user consumable errors when lock operations fail #31864

Conversation

@bdraco
Copy link
Contributor

bdraco commented Feb 15, 2020

This fixes #26672

Breaking change

Proposed change

Provide user consumable errors when lock operations fail

Example: "Failed to call service lock/lock. Door: The operation failed because the bridge (connect) is offline."

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 #26672
  • 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
@project-bot project-bot bot added this to Needs review in Dev Feb 15, 2020
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Feb 15, 2020
@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 15, 2020

Codecov Report

Merging #31864 into dev will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev   #31864      +/-   ##
==========================================
+ Coverage   94.68%   94.69%   +<.01%     
==========================================
  Files         763      763              
  Lines       55192    55192              
==========================================
+ Hits        52261    52264       +3     
+ Misses       2931     2928       -3
Impacted Files Coverage 螖
homeassistant/components/template/cover.py 97.71% <0%> (+1.36%) 猬嗭笍

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 2516b94...a816fc3. Read the comment docs.

Copy link
Member

MartinHjelmare left a comment

We should avoid mocking our own code, and just patch the device library instead.

tests/components/august/mocks.py Outdated Show resolved Hide resolved
tests/components/august/mocks.py Outdated Show resolved Hide resolved
@bdraco

This comment has been minimized.

Copy link
Contributor Author

bdraco commented Feb 16, 2020

Will adjust after #31848 merges as this is likely going to conflict

bdraco added 4 commits Feb 15, 2020
This resolves issue #26672
@bdraco bdraco force-pushed the bdraco:provide_user_consumable_errors_when_lock_operations_fail branch from 6de9066 to a816fc3 Feb 16, 2020
@MartinHjelmare

This comment has been minimized.

Copy link
Member

MartinHjelmare commented Feb 16, 2020

Here's an example of how we want platforms to be tested:
https://github.com/home-assistant/home-assistant/blob/2516b9474dc998c4d5ae324e63ba75fe00476556/tests/components/manual/test_alarm_control_panel.py#L85-L121

Set up the component and platform with async_setup_component. Let the platform add an entity. Then assert the entity state via the core state machine.

Please make a separate PR where the tests are cleaned up before doing the bigger refactor.

@MartinHjelmare

This comment has been minimized.

Copy link
Member

MartinHjelmare commented Feb 16, 2020

If you need more inspiration here's a PR where I've cleaned up existing non robust tests:
#31888

@bdraco

This comment has been minimized.

Copy link
Contributor Author

bdraco commented Feb 16, 2020

Here's an example of how we want platforms to be tested:
https://github.com/home-assistant/home-assistant/blob/2516b9474dc998c4d5ae324e63ba75fe00476556/tests/components/manual/test_alarm_control_panel.py#L85-L121

Thanks, that is helpful. I'll switch to cleaning up the tests after I finish fixing issue #29980

Dev automation moved this from By Code Owner to Reviewer approved Feb 17, 2020
@balloob balloob merged commit 00ac7a7 into home-assistant:dev Feb 17, 2020
10 checks passed
10 checks passed
CI Build #20200216.42 succeeded
Details
CI (FullCheck Mypy) FullCheck Mypy succeeded
Details
CI (FullCheck Pylint) FullCheck Pylint succeeded
Details
CI (Overview CheckFormat) Overview CheckFormat succeeded
Details
CI (Overview Lint) Overview Lint succeeded
Details
CI (Overview Validate) Overview Validate succeeded
Details
CI (Tests PyTest Python37) Tests PyTest Python37 succeeded
Details
cla-bot Everyone involved has signed the CLA
codecov/patch Coverage not affected when comparing 2516b94...a816fc3
Details
codecov/project 94.69% (+<.01%) compared to 2516b94
Details
Dev automation moved this from Reviewer approved to Done Feb 17, 2020
@bdraco bdraco mentioned this pull request Feb 18, 2020
7 of 20 tasks complete
@lock lock bot locked and limited conversation to collaborators Feb 18, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Linked issues

Successfully merging this pull request may close these issues.

4 participants
You can鈥檛 perform that action at this time.