Provide user consumable errors when lock operations fail

[bdraco]

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 August Lock Unprocessable entity error #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:

• Documentation added/updated for www.home-assistant.io

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

[codecov]

Codecov Report

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

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

[MartinHjelmare]

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

[bdraco]

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

[MartinHjelmare]

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]

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

[bdraco]

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