Skip to content

Log an error if modbus Cover is not initialized correctly#48829

Merged
MartinHjelmare merged 3 commits intohome-assistant:devfrom
Lutemi:feature/cover-improve-error-handling
Apr 19, 2021
Merged

Log an error if modbus Cover is not initialized correctly#48829
MartinHjelmare merged 3 commits intohome-assistant:devfrom
Lutemi:feature/cover-improve-error-handling

Conversation

@vzahradnik
Copy link
Copy Markdown
Contributor

Proposed change

This PR adds an error message to the log, if user tries to initialize Cover
in an unsupported way, i.e., the discovery_info dictionary is None.

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

@probot-home-assistant
Copy link
Copy Markdown

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

@MartinHjelmare MartinHjelmare changed the title Log an error if Cover is not initialized correctly Log an error if modbus Cover is not initialized correctly Apr 8, 2021
Copy link
Copy Markdown
Member

@janiversen janiversen left a comment

Choose a reason for hiding this comment

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

looks good

Comment thread homeassistant/components/modbus/cover.py Outdated
Comment thread tests/components/modbus/test_modbus_cover.py Outdated
@janiversen janiversen mentioned this pull request Apr 17, 2021
21 tasks
@vzahradnik
Copy link
Copy Markdown
Contributor Author

@MartinHjelmare thanks for the review! I'll update the code here, as you suggested, and I'll do the same also in PR #42120 and #48558. This small PR was ported from my work there to maintain consistency with the components.

@janiversen
Copy link
Copy Markdown
Member

@vzahradnik if you want, you can look in #49053 test_modbus.py I already changed mock(_logger) -> caplog

@vzahradnik
Copy link
Copy Markdown
Contributor Author

@MartinHjelmare I updated the code as you requested. Please take a look at your convenience. Thanks!

Comment thread tests/components/modbus/test_modbus_cover.py Outdated
@janiversen
Copy link
Copy Markdown
Member

adding a flag expectFail is a good idea, please add it.

@vzahradnik
Copy link
Copy Markdown
Contributor Author

adding a flag expectFail is a good idea, please add it.

Already did as a POC as I waited for your response. Please check the code.

@janiversen
Copy link
Copy Markdown
Member

Looks good to me, thanks for not duplicating code.

@vzahradnik
Copy link
Copy Markdown
Contributor Author

OK, let's wait for the test results. If they'll pass, this PR should address all issues pointed by @MartinHjelmare

Copy link
Copy Markdown
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.

Looks good!

@MartinHjelmare MartinHjelmare merged commit 05755c2 into home-assistant:dev Apr 19, 2021
@vzahradnik vzahradnik deleted the feature/cover-improve-error-handling branch April 19, 2021 15:03
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 20, 2021
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.

4 participants