Add laundrify integration by xLarry · Pull Request #65090 · home-assistant/core

xLarry · 2022-01-27T21:58:51Z

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

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: Add documentation for the laundrify integration home-assistant.io#21360

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

I have reviewed two other open pull requests in this repository.

austinmroczek

This looks pretty good. A few minor changes requested.

I wish these were available with U.S. plugs.

homeassistant/components/laundrify/__init__.py

homeassistant/components/laundrify/binary_sensor.py

tests/components/laundrify/__init__.py

tests/components/laundrify/test_config_flow.py

austinmroczek · 2022-01-30T00:34:18Z

Also, please remove "breaking change" from the PR text at the top. Since this is a new integration it is not a breaking change.

xLarry · 2022-01-30T13:31:05Z

Thanks for your feedback @austinmroczek. I addressed your comments in my last commit and changed the description of the PR.

austinmroczek

Looks good. Thanks for the all of the work.

iMicknl

Had a quick look to get you started.

homeassistant/components/laundrify/__init__.py

homeassistant/components/laundrify/binary_sensor.py

homeassistant/components/laundrify/config_flow.py

homeassistant/components/laundrify/binary_sensor.py

homeassistant/components/laundrify/__init__.py

xLarry · 2022-03-02T15:33:03Z

Thanks for your input, @iMicknl. I went through your comments and referenced the corresponding commit in my answer.

iMicknl

Some more small remarks.

homeassistant/components/laundrify/__init__.py

homeassistant/components/laundrify/config_flow.py

homeassistant/components/laundrify/binary_sensor.py

homeassistant/components/laundrify/__init__.py

homeassistant/components/laundrify/binary_sensor.py

homeassistant/components/laundrify/__init__.py

xLarry · 2022-04-20T18:01:02Z

Sorry for the delay. @iMicknl: I addressed your feedback in the latest 2 commits. Let me know if anything is missing :)

raman325

Getting close!

homeassistant/components/laundrify/__init__.py

homeassistant/components/laundrify/binary_sensor.py

homeassistant/components/laundrify/coordinator.py

homeassistant/components/laundrify/strings.json

homeassistant/components/laundrify/translations/en.json

raman325

this looks good to me. Last thing to do is improve test coverage so coverage check will pass

xLarry · 2022-05-13T18:34:20Z

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 😀

raman325

Apologies, I didn't look at your tests. While not technically wrong, making these changes will make your tests much cleaner and will avoid some of the indenting

tests/components/laundrify/test_config_flow.py

tests/components/laundrify/__init__.py

xLarry · 2022-05-16T12:15:49Z

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 autouse=True and some others for whenever a side effect is required. Let me know if there's something else to improve :)

tests/components/laundrify/conftest.py

homeassistant/components/laundrify/binary_sensor.py

raman325

Great work on this, thanks for the contribution! Can be merged as soon as tests pass

xLarry · 2022-05-21T06:48:31Z

Nice 🤩 Thanks for your feedback!

Looks like the tests failed due to some dependency conflicts. Is it something I can resolve?

raman325 · 2022-05-21T19:17:19Z

nope not your problem!

MartinHjelmare

Please address the comments in a new PR. Thanks!

MartinHjelmare · 2022-05-29T13:18:00Z

homeassistant/components/laundrify/config_flow.py

+        """Handle a flow initialized by the user."""
+        return await self.async_step_init(user_input)
+
+    async def async_step_init(


We don't need to define this init step. Just merge this with the user step.

MartinHjelmare · 2022-05-29T13:20:54Z

homeassistant/components/laundrify/model.py

+from typing import TypedDict
+
+
+class LaundrifyDevice(TypedDict):


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.

MartinHjelmare · 2022-05-29T13:23:50Z

homeassistant/components/laundrify/strings.json

+      "unknown": "[%key:common::config_flow::error::unknown%]"
+    },
+    "abort": {
+      "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]"


single_instance_allowed abort reason is never used. We're missing a reason for already_configured though.

MartinHjelmare · 2022-05-29T13:25:47Z

tests/components/laundrify/test_config_flow.py

+    )
+    await hass.async_block_till_done()
+
+    assert result["type"] == RESULT_TYPE_FORM


Please continue the flow until the reauthentication is completed.

MartinHjelmare · 2022-05-29T13:26:23Z

tests/components/laundrify/test_config_flow.py

+
+async def test_step_reauth(hass: HomeAssistant) -> None:
+    """Test the reauth form is shown."""
+    result = await hass.config_entries.flow.async_init(


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.

MartinHjelmare · 2022-05-29T13:27:15Z

tests/components/laundrify/test_coordinator.py

+    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"]


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

MartinHjelmare · 2022-05-29T13:27:37Z

tests/components/laundrify/test_coordinator.py

+    await coordinator.async_refresh()
+    await hass.async_block_till_done()
+
+    assert coordinator.last_update_success


We can assert the state of an entity instead.

MartinHjelmare · 2022-05-29T13:28:47Z

tests/components/laundrify/test_coordinator.py

+    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()


We can move time forward to make the coordinator do a refresh.

core/tests/common.py

Lines 375 to 379 in d59ecc4

@ha.callback

def async_fire_time_changed(

hass: HomeAssistant, datetime_: datetime = None, fire_all: bool = False

) -> None:

"""Fire a time changed event."""

MartinHjelmare · 2022-05-29T13:31:44Z

tests/components/laundrify/test_coordinator.py

@@ -0,0 +1,50 @@
+"""Test the laundrify coordinator."""


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.

raman325 · 2022-06-01T06:24:01Z

@xLarry did you see these additional comments from Martin? these should get addressed soon, particularly the missing string

xLarry · 2022-06-01T14:53:29Z

Sure! I'll create a new PR asap.

raman325 · 2022-06-01T19:16:32Z

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

homeassistant added the cla-signed label Jan 27, 2022

probot-home-assistant bot added has-tests new-integration integration: laundrify labels Jan 27, 2022

xLarry mentioned this pull request Jan 27, 2022

Add documentation for the laundrify integration home-assistant/home-assistant.io#21360

Merged

8 tasks

xLarry changed the title ~~First version of laundrify integration~~ Add laundrify integration Jan 27, 2022

xLarry mentioned this pull request Jan 27, 2022

Add images for new core integration (laundrify) home-assistant/brands#3115

Merged

11 tasks

austinmroczek suggested changes Jan 29, 2022

View reviewed changes

austinmroczek approved these changes Jan 30, 2022

View reviewed changes

iMicknl reviewed Feb 24, 2022

View reviewed changes

homeassistant/components/laundrify/__init__.py Outdated Show resolved Hide resolved

This comment was marked as off-topic.

Sign in to view

iMicknl reviewed Apr 6, 2022

View reviewed changes

homeassistant/components/laundrify/__init__.py Outdated Show resolved Hide resolved

This comment was marked as off-topic.

Sign in to view

xLarry added 8 commits April 26, 2022 08:36

First version of laundrify integration

ad43394

Code cleanup

f05473d

Code cleanup after review home-assistant#2

64b2f6d

Move coordinator to its own file

51b7daa

Save devices as dict and implement available prop as fn

d410b77

Validate token on init, abort if already configured

e5c59ba

Some more cleanup after review

7ed2366

Add strict type hints

902fb85

xLarry force-pushed the laundrify branch from 1b179a0 to 902fb85 Compare April 26, 2022 08:52

Update internal device property after fetching data

6bb6e22

raman325 requested changes May 12, 2022

View reviewed changes

Call parental update handler and remove obsolete code

95018ce

raman325 requested changes May 13, 2022

View reviewed changes

Add coordinator tests and fix some config flow tests

8e681da

raman325 requested changes May 14, 2022

View reviewed changes

raman325 reviewed May 14, 2022

View reviewed changes

tests/components/laundrify/__init__.py Outdated Show resolved Hide resolved

Refactor tests

e54dbf5

raman325 reviewed May 17, 2022

View reviewed changes

tests/components/laundrify/conftest.py Outdated Show resolved Hide resolved

raman325 reviewed May 17, 2022

View reviewed changes

homeassistant/components/laundrify/binary_sensor.py Outdated Show resolved Hide resolved

xLarry added 2 commits May 17, 2022 11:02

Refactor fixtures

92283ac

Device unavailable if polling fails

7444241

xLarry requested a review from raman325 May 20, 2022 08:54

raman325 approved these changes May 21, 2022

View reviewed changes

raman325 merged commit abf9aab into home-assistant:dev May 21, 2022

github-actions bot locked and limited conversation to collaborators May 22, 2022

xLarry mentioned this pull request May 24, 2022

Remove options_flow from laundrify integration home-assistant/home-assistant.io#22875

Merged

9 tasks

xLarry deleted the laundrify branch May 27, 2022 14:23

xLarry mentioned this pull request May 27, 2022

Bump laundrify_aio to v1.1.2 #72605

Merged

22 tasks

MartinHjelmare reviewed May 29, 2022

View reviewed changes

home-assistant unlocked this conversation Jun 1, 2022

github-actions bot locked and limited conversation to collaborators Jun 2, 2022

		from typing import TypedDict


		class LaundrifyDevice(TypedDict):

	@ha.callback
	def async_fire_time_changed(
	hass: HomeAssistant, datetime_: datetime = None, fire_all: bool = False
	) -> None:
	"""Fire a time changed event."""

Uh oh!

Conversation

xLarry commented Jan 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

austinmroczek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

austinmroczek commented Jan 30, 2022

Uh oh!

xLarry commented Jan 30, 2022

Uh oh!

austinmroczek left a comment

Choose a reason for hiding this comment

Uh oh!

iMicknl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xLarry commented Mar 2, 2022

Uh oh!

This comment was marked as off-topic.

This comment was marked as off-topic.

iMicknl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xLarry commented Apr 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as off-topic.

This comment was marked as off-topic.

raman325 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

raman325 left a comment

Choose a reason for hiding this comment

Uh oh!

xLarry commented May 13, 2022

Uh oh!

raman325 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xLarry commented Jan 27, 2022 •

edited

Loading

xLarry commented Apr 20, 2022 •

edited

Loading

raman325 commented Jun 1, 2022 •

edited

Loading