Add laundrify integration #65090
Add laundrify integration #65090
Conversation
probot-home-assistant
bot
added
has-tests
new-integration
integration: laundrify
labels
xLarry
changed the title
|
Also, please remove "breaking change" from the PR text at the top. Since this is a new integration it is not a breaking change. |
|
Thanks for your feedback @austinmroczek. I addressed your comments in my last commit and changed the description of the PR. |
|
Thanks for your input, @iMicknl. I went through your comments and referenced the corresponding commit in my answer. |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
|
Sorry for the delay. @iMicknl: I addressed your feedback in the latest 2 commits. Let me know if anything is missing :) |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
|
Thanks for your time and valuable input, @raman325! I added some tests and increased the coverage to 100%. Looking forward to hopefully pass the CI run now 😀 |
|
Thanks for pointing out. I didn't know about fixtures (first python project), but it actually felt like I was missing something 😀 I created a fixture for the API responses that's using |
|
Nice 🤩 Thanks for your feedback! Looks like the tests failed due to some dependency conflicts. Is it something I can resolve? |
|
nope not your problem! |
| """Handle a flow initialized by the user.""" | ||
| return await self.async_step_init(user_input) | ||
|
|
||
| async def async_step_init( |
There was a problem hiding this comment.
We don't need to define this init step. Just merge this with the user step.
| from typing import TypedDict | ||
|
|
||
|
|
||
| class LaundrifyDevice(TypedDict): |
There was a problem hiding this comment.
The library should preferably define its model, eg with a dataclass, so we don't need to define the type here but can use the type from the library.
| "unknown": "[%key:common::config_flow::error::unknown%]" | ||
| }, | ||
| "abort": { | ||
| "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]" |
There was a problem hiding this comment.
single_instance_allowed abort reason is never used. We're missing a reason for already_configured though.
| ) | ||
| await hass.async_block_till_done() | ||
|
|
||
| assert result["type"] == RESULT_TYPE_FORM |
There was a problem hiding this comment.
Please continue the flow until the reauthentication is completed.
|
|
||
| async def test_step_reauth(hass: HomeAssistant) -> None: | ||
| """Test the reauth form is shown.""" | ||
| result = await hass.config_entries.flow.async_init( |
There was a problem hiding this comment.
We need to add a MockConfigEntry before starting the reauth flow. At the end of the test we should assert that the entry data has been updated.
| config_entry = create_entry(hass) | ||
| await hass.config_entries.async_setup(config_entry.entry_id) | ||
| await hass.async_block_till_done() | ||
| coordinator = hass.data[DOMAIN][config_entry.entry_id]["coordinator"] |
There was a problem hiding this comment.
Please don't access integration details like hass.data or the coordinator in the tests.
https://developers.home-assistant.io/docs/development_testing#writing-tests-for-integrations
| await coordinator.async_refresh() | ||
| await hass.async_block_till_done() | ||
|
|
||
| assert coordinator.last_update_success |
There was a problem hiding this comment.
We can assert the state of an entity instead.
| await hass.config_entries.async_setup(config_entry.entry_id) | ||
| await hass.async_block_till_done() | ||
| coordinator = hass.data[DOMAIN][config_entry.entry_id]["coordinator"] | ||
| await coordinator.async_refresh() |
There was a problem hiding this comment.
We can move time forward to make the coordinator do a refresh.
Lines 375 to 379 in d59ecc4
| @@ -0,0 +1,50 @@ | |||
| """Test the laundrify coordinator.""" | |||
There was a problem hiding this comment.
We shouldn't test the coordinator directly. Test the binary sensor platform instead by setting up the integration and asserting the state of the entity in the core state machine.
|
@xLarry did you see these additional comments from Martin? these should get addressed soon, particularly the missing string |
|
Sure! I'll create a new PR asap. |
I would submit the strings fix as a separate PR so that we can include it in a patch release |
Proposed change
This PR adds a new integration for the laundrify WiFi power plugs. The purpose of the power plugs is to monitor the status of washing machines and dryers.
This integration will add a Binary Sensor for each power plug that has been set up in the laundrify App. To configure the integration, the user needs to generate an Auth Code in the laundrify App.
Type of change
Additional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.The integration reached or maintains the following Integration Quality Scale:
To help with the load of incoming pull requests: