will/owlet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactoring, added tests

Browse Source 
###Fix
# In light of submitting this as a pull request to the core of HA there have been some refactoring changes to comply with HA's style requirements
#Sensor names now moved to strings file to allow for translations
#Coordinator now properly handles multiple devices
#Spelling of signal strength sensor corrected

###Feature
#Tests added
This commit is contained in:
RyanClark123
2023-05-30 13:30:59 +01:00
parent c6f37493ca
commit 26f81c14bf
21 changed files with 4202 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/__init__.py
+60
View File
@@ -0,0 +1,60 @@
"""Tests for the Owlet integration."""
from __future__ import annotations
import json
from unittest.mock import patch
from homeassistant.components.owlet.const import (
CONF_OWLET_EXPIRY,
CONF_OWLET_REFRESH,
DOMAIN,
POLLING_INTERVAL,
)
from homeassistant.const import (
CONF_API_TOKEN,
CONF_REGION,
CONF_SCAN_INTERVAL,
CONF_USERNAME,
)
from homeassistant.core import HomeAssistant
from tests.common import MockConfigEntry, load_fixture
async def async_init_integration(
hass: HomeAssistant,
skip_setup: bool = False,
properties_fixture: str = "update_properties_charging.json",
devices_fixture: str = "get_devices.json",
) -> MockConfigEntry:
"""Set up integration entry."""
entry = MockConfigEntry(
domain=DOMAIN,
title="sample@gmail.com",
unique_id="sample@gmail.com",
data={
CONF_REGION: "europe",
CONF_USERNAME: "sample@gmail.com",
CONF_API_TOKEN: "api_token",
CONF_OWLET_EXPIRY: 100,
CONF_OWLET_REFRESH: "refresh_token",
},
options={CONF_SCAN_INTERVAL: POLLING_INTERVAL},
)
entry.add_to_hass(hass)
if not skip_setup:
with patch(
"homeassistant.components.owlet.OwletAPI.get_properties",
return_value=json.loads(load_fixture(properties_fixture, "owlet")),
), patch(
"homeassistant.components.owlet.OwletAPI.authenticate", return_value=None
), patch(
"homeassistant.components.owlet.OwletAPI.get_devices",
return_value=json.loads(load_fixture(devices_fixture, "owlet")),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
return entry
tests/const.py
+14
View File
@@ -0,0 +1,14 @@
"""Constants used for Owlet tests."""
AUTH_RETURN = {
"api_token": "api_token",
"expiry": 100,
"refresh": "refresh_token",
}
CONF_INPUT = {
"region": "europe",
"username": "sample@gmail.com",
"password": "sample",
}
tests/fixtures/get_devices.json
Vendored
+32
View File
@@ -0,0 +1,32 @@
{
"response": [
{
"device": {
"product_name": "Owlet Baby Monitors",
"model": "AY001MTL1",
"dsn": "SERIAL_NUMBER",
"oem_model": "SS3-OBL-EU",
"sw_version": "bc 2.9.7-beta 05/01/19 16:15:18 ID beb2858",
"template_id": 48775,
"mac": "MAC",
"unique_hardware_id": "None",
"hwsig": "123-123-123",
"lan_ip": "192.0.0.1",
"connected_at": "2023-05-23T01:21:29Z",
"key": 123456,
"lan_enabled": false,
"connection_priority": [],
"has_properties": true,
"product_class": "None",
"connection_status": "Online",
"lat": "0.0",
"lng": "0.0",
"locality": "QW12",
"device_type": "Wifi",
"dealer": "None",
"manuf_model": "LBEE5PA1LD-222"
}
}
],
"tokens": ""
}
tests/fixtures/get_devices_with_tokens.json
Vendored
+36
View File
@@ -0,0 +1,36 @@
{
"response": [
{
"device": {
"product_name": "Owlet Baby Monitors",
"model": "AY001MTL1",
"dsn": "SERIAL_NUMBER",
"oem_model": "SS3-OBL-EU",
"sw_version": "bc 2.9.7-beta 05/01/19 16:15:18 ID beb2858",
"template_id": 48775,
"mac": "MAC",
"unique_hardware_id": "None",
"hwsig": "123-123-123",
"lan_ip": "192.0.0.1",
"connected_at": "2023-05-23T01:21:29Z",
"key": 123456,
"lan_enabled": false,
"connection_priority": [],
"has_properties": true,
"product_class": "None",
"connection_status": "Online",
"lat": "0.0",
"lng": "0.0",
"locality": "QW12",
"device_type": "Wifi",
"dealer": "None",
"manuf_model": "LBEE5PA1LD-222"
}
}
],
"tokens": {
"api_token": "new_api_token",
"expiry": 200,
"refresh": "new_refresh_token"
}
}
tests/fixtures/update_properties_asleep.json
Vendored
+1051
View File
File diff suppressed because it is too large Load Diff
tests/fixtures/update_properties_awake.json
Vendored
+1051
View File
File diff suppressed because it is too large Load Diff
tests/fixtures/update_properties_charging.json
Vendored
+1055
View File
File diff suppressed because it is too large Load Diff
tests/test_config_flow.py
+237
View File
@@ -0,0 +1,237 @@
"""Test Owlet config flow."""
from __future__ import annotations
from unittest.mock import patch
from pyowletapi.exceptions import (
OwletCredentialsError,
OwletDevicesError,
OwletEmailError,
OwletPasswordError,
)
from homeassistant import config_entries
from homeassistant.components.owlet.const import DOMAIN, POLLING_INTERVAL
from homeassistant.config_entries import SOURCE_REAUTH, SOURCE_USER
from homeassistant.const import CONF_PASSWORD, CONF_SCAN_INTERVAL
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResultType
from . import async_init_integration
from .const import AUTH_RETURN, CONF_INPUT
async def test_form(hass: HomeAssistant) -> None:
"""Test that the form is served with no input."""
# await async_init_integration(hass)
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_USER}
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "user"
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
return_value=AUTH_RETURN,
), patch(
"homeassistant.components.owlet.config_flow.OwletAPI.validate_authentication"
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
await hass.async_block_till_done()
assert result["type"] == FlowResultType.CREATE_ENTRY
assert result["title"] == "sample@gmail.com"
assert result["data"] == {
"region": "europe",
"username": "sample@gmail.com",
"api_token": "api_token",
"expiry": 100,
"refresh": "refresh_token",
}
assert result["options"] == {"scan_interval": POLLING_INTERVAL}
async def test_flow_wrong_password(hass: HomeAssistant) -> None:
"""Test incorrect login throwing error."""
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=OwletPasswordError(),
):
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": config_entries.SOURCE_USER},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "invalid_password"}
async def test_flow_wrong_email(hass: HomeAssistant) -> None:
"""Test incorrect login throwing error."""
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=OwletEmailError(),
):
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": config_entries.SOURCE_USER},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "invalid_email"}
async def test_flow_credentials_error(hass: HomeAssistant) -> None:
"""Test incorrect login throwing error."""
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=OwletCredentialsError(),
):
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": config_entries.SOURCE_USER},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "invalid_credentials"}
async def test_flow_unknown_error(hass: HomeAssistant) -> None:
"""Test unknown error throwing error."""
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=Exception(),
):
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": config_entries.SOURCE_USER},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "unknown"}
async def test_flow_no_devices(hass: HomeAssistant) -> None:
"""Test unknown error throwing error."""
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate"
), patch(
"homeassistant.components.owlet.config_flow.OwletAPI.validate_authentication",
side_effect=OwletDevicesError(),
):
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": config_entries.SOURCE_USER},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input=CONF_INPUT,
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "no_devices"}
async def test_reauth_success(hass: HomeAssistant) -> None:
"""Test reauth form."""
entry = await async_init_integration(hass, skip_setup=True)
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_REAUTH, "entry_id": entry.entry_id}
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "reauth_confirm"
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
return_value=AUTH_RETURN,
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
user_input={CONF_PASSWORD: "sample"},
)
await hass.async_block_till_done()
assert result["type"] == FlowResultType.ABORT
assert result["reason"] == "reauth_successful"
await hass.config_entries.async_unload(entry.entry_id)
async def test_reauth_invalid_password(hass: HomeAssistant) -> None:
"""Test reauth with invalid password errir."""
entry = await async_init_integration(hass, skip_setup=True)
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_REAUTH, "entry_id": entry.entry_id}
)
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=OwletPasswordError(),
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input={CONF_PASSWORD: "sample"}
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "reauth_confirm"
assert result["errors"] == {"base": "invalid_password"}
async def test_reauth_unknown_error(hass: HomeAssistant) -> None:
"""Test reauthing with an unknown error."""
entry = await async_init_integration(hass, skip_setup=True)
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_REAUTH, "entry_id": entry.entry_id}
)
with patch(
"homeassistant.components.owlet.config_flow.OwletAPI.authenticate",
side_effect=Exception(),
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input={CONF_PASSWORD: "sample"}
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "reauth_confirm"
async def test_options_flow(hass: HomeAssistant) -> None:
"""Test that the form is served with no input."""
entry = await async_init_integration(hass, skip_setup=True)
result = await hass.config_entries.options.async_init(entry.entry_id)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "init"
result = await hass.config_entries.options.async_configure(
result["flow_id"],
user_input={CONF_SCAN_INTERVAL: 10},
)
await hass.async_block_till_done()
assert result["type"] == FlowResultType.CREATE_ENTRY
assert result["title"] == ""
assert result["data"] == {CONF_SCAN_INTERVAL: 10}
tests/test_coordinator.py
+74
View File
@@ -0,0 +1,74 @@
"""Test owlet coordinator."""
from __future__ import annotations
import json
from unittest.mock import patch
from pyowletapi.exceptions import OwletAuthenticationError, OwletConnectionError
from homeassistant.config_entries import ConfigEntryState
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from . import async_init_integration
from tests.common import load_fixture
PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.SENSOR]
async def test_coordinator_auth_error(hass: HomeAssistant) -> None:
"""Test coordinator setup authentication error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.Sock.update_properties",
side_effect=OwletAuthenticationError(),
), patch(
"homeassistant.components.owlet.OwletAPI.authenticate", return_value=None
), patch(
"homeassistant.components.owlet.OwletAPI.get_devices",
return_value=json.loads(load_fixture("get_devices.json", "owlet")),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_RETRY
async def test_coordinator_connection_error(hass: HomeAssistant) -> None:
"""Test coordinator setup connection error error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.Sock.update_properties",
side_effect=OwletConnectionError(),
), patch(
"homeassistant.components.owlet.OwletAPI.authenticate", return_value=None
), patch(
"homeassistant.components.owlet.OwletAPI.get_devices",
return_value=json.loads(load_fixture("get_devices.json", "owlet")),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_RETRY
async def test_coordinator_error(hass: HomeAssistant) -> None:
"""Test coordinator setup generic error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.Sock.update_properties",
side_effect=Exception(),
), patch(
"homeassistant.components.owlet.OwletAPI.authenticate", return_value=None
), patch(
"homeassistant.components.owlet.OwletAPI.get_devices",
return_value=json.loads(load_fixture("get_devices.json", "owlet")),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_RETRY
tests/test_init.py
+136
View File
@@ -0,0 +1,136 @@
"""Test Owlet init."""
from __future__ import annotations
from unittest.mock import patch
from pyowletapi.exceptions import (
OwletAuthenticationError,
OwletConnectionError,
OwletDevicesError,
OwletError,
)
from homeassistant.components.owlet.const import (
CONF_OWLET_EXPIRY,
CONF_OWLET_REFRESH,
DOMAIN,
)
from homeassistant.config_entries import ConfigEntryState
from homeassistant.const import CONF_API_TOKEN, CONF_REGION, CONF_USERNAME, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr, entity_registry as er
from . import async_init_integration
PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.SENSOR]
async def test_async_setup_entry(hass: HomeAssistant) -> None:
"""Test setting up entry."""
entry = await async_init_integration(hass)
assert entry.state == ConfigEntryState.LOADED
device_registry = dr.async_get(hass)
device_entry = device_registry.async_get_or_create(
config_entry_id=entry.entry_id, identifiers={(DOMAIN, "SERIAL_NUMBER")}
)
assert device_entry.name == "Owlet Baby Care Sock"
entity_registry = er.async_get(hass)
entities = er.async_entries_for_device(entity_registry, device_entry.id)
assert len(entities) == 8
await entry.async_unload(hass)
assert entry.state == ConfigEntryState.NOT_LOADED
async def test_async_setup_entry_new_tokens(hass: HomeAssistant) -> None:
"""Test setting up entry and getting new tokens."""
entry = await async_init_integration(
hass, devices_fixture="get_devices_with_tokens.json"
)
assert entry.data == {
CONF_REGION: "europe",
CONF_USERNAME: "sample@gmail.com",
CONF_API_TOKEN: "new_api_token",
CONF_OWLET_EXPIRY: 200,
CONF_OWLET_REFRESH: "new_refresh_token",
}
assert entry.state == ConfigEntryState.LOADED
await entry.async_unload(hass)
assert entry.state == ConfigEntryState.NOT_LOADED
async def test_async_setup_entry_auth_error(hass: HomeAssistant) -> None:
"""Test setting up entry with auth error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.OwletAPI.authenticate",
side_effect=OwletAuthenticationError(),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_ERROR
await entry.async_unload(hass)
async def test_async_setup_entry_connection_error(hass: HomeAssistant) -> None:
"""Test setting up entry with connection error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.OwletAPI.authenticate",
side_effect=OwletConnectionError(),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_RETRY
await entry.async_unload(hass)
async def test_async_setup_entry_devices_error(hass: HomeAssistant) -> None:
"""Test setting up entry with device error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.OwletAPI.authenticate", return_value=None
), patch(
"homeassistant.components.owlet.OwletAPI.get_devices",
side_effect=OwletDevicesError(),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_ERROR
await entry.async_unload(hass)
async def test_async_setup_entry_error(hass: HomeAssistant) -> None:
"""Test setting up entry with unknown error."""
entry = await async_init_integration(hass, skip_setup=True)
with patch(
"homeassistant.components.owlet.OwletAPI.authenticate",
side_effect=OwletError(),
):
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()
assert entry.state == ConfigEntryState.SETUP_ERROR
await entry.async_unload(hass)
tests/test_sensor.py
+109
View File
@@ -0,0 +1,109 @@
"""Test Owlet Sensor."""
from __future__ import annotations
from homeassistant.core import HomeAssistant
from . import async_init_integration
async def test_sensors_asleep(hass: HomeAssistant) -> None:
"""Test sensor values."""
await async_init_integration(
hass, properties_fixture="update_properties_asleep.json"
)
assert len(hass.states.async_all("sensor")) == 8
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_percentage").state
== "50.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_remaining").state
== "400.0"
)
assert hass.states.get("sensor.owlet_baby_care_sock_heart_rate").state == "97.0"
assert hass.states.get("sensor.owlet_baby_care_sock_o2_saturation").state == "99.0"
assert (
hass.states.get(
"sensor.owlet_baby_care_sock_o2_saturation_10_minute_average"
).state
== "97.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_signal_strength").state == "30.0"
)
assert hass.states.get("sensor.owlet_baby_care_sock_skin_temperature").state == "34"
assert (
hass.states.get("sensor.owlet_baby_care_sock_sleep_state").state
== "light_sleep"
)
async def test_sensors_awake(hass: HomeAssistant) -> None:
"""Test sensor values."""
await async_init_integration(
hass, properties_fixture="update_properties_awake.json"
)
assert len(hass.states.async_all("sensor")) == 8
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_percentage").state
== "80.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_remaining").state
== "600.0"
)
assert hass.states.get("sensor.owlet_baby_care_sock_heart_rate").state == "110.0"
assert hass.states.get("sensor.owlet_baby_care_sock_o2_saturation").state == "98.0"
assert (
hass.states.get(
"sensor.owlet_baby_care_sock_o2_saturation_10_minute_average"
).state
== "98.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_signal_strength").state == "34.0"
)
assert hass.states.get("sensor.owlet_baby_care_sock_skin_temperature").state == "35"
assert hass.states.get("sensor.owlet_baby_care_sock_sleep_state").state == "awake"
async def test_sensors_charging(hass: HomeAssistant) -> None:
"""Test sensor values."""
await async_init_integration(
hass, properties_fixture="update_properties_charging.json"
)
assert len(hass.states.async_all("sensor")) == 8
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_percentage").state
== "100.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_battery_remaining").state
== "unknown"
)
assert hass.states.get("sensor.owlet_baby_care_sock_heart_rate").state == "unknown"
assert (
hass.states.get("sensor.owlet_baby_care_sock_o2_saturation").state == "unknown"
)
assert (
hass.states.get(
"sensor.owlet_baby_care_sock_o2_saturation_10_minute_average"
).state
== "unknown"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_signal_strength").state == "34.0"
)
assert (
hass.states.get("sensor.owlet_baby_care_sock_skin_temperature").state
== "unknown"
)
assert hass.states.get("sensor.owlet_baby_care_sock_sleep_state").state == "unknown"