Add google_travel_time sensor tests (#66568)

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
pull/66823/head
Kevin Stillhammer 2022-02-18 19:21:28 +01:00 committed by GitHub
parent 011c645ee2
commit beb30a1ff1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 253 additions and 23 deletions

View File

@ -433,9 +433,6 @@ omit =
homeassistant/components/google_cloud/tts.py
homeassistant/components/google_maps/device_tracker.py
homeassistant/components/google_pubsub/__init__.py
homeassistant/components/google_travel_time/__init__.py
homeassistant/components/google_travel_time/helpers.py
homeassistant/components/google_travel_time/sensor.py
homeassistant/components/gpmdp/media_player.py
homeassistant/components/gpsd/sensor.py
homeassistant/components/greenwave/light.py

View File

@ -0,0 +1,14 @@
"""Constants for google_travel_time tests."""
from homeassistant.components.google_travel_time.const import (
CONF_DESTINATION,
CONF_ORIGIN,
)
from homeassistant.const import CONF_API_KEY
MOCK_CONFIG = {
CONF_API_KEY: "api_key",
CONF_ORIGIN: "location1",
CONF_DESTINATION: "location2",
}

View File

@ -26,6 +26,7 @@ from homeassistant.const import (
)
from tests.common import MockConfigEntry
from tests.components.google_travel_time.const import MOCK_CONFIG
async def test_minimum_fields(hass, validate_config_entry, bypass_setup):
@ -38,11 +39,7 @@ async def test_minimum_fields(hass, validate_config_entry, bypass_setup):
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{
CONF_API_KEY: "api_key",
CONF_ORIGIN: "location1",
CONF_DESTINATION: "location2",
},
MOCK_CONFIG,
)
assert result2["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
@ -64,11 +61,7 @@ async def test_invalid_config_entry(hass, invalidate_config_entry):
assert result["errors"] == {}
result2 = await hass.config_entries.flow.async_configure(
result["flow_id"],
{
CONF_API_KEY: "api_key",
CONF_ORIGIN: "location1",
CONF_DESTINATION: "location2",
},
MOCK_CONFIG,
)
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
@ -79,11 +72,7 @@ async def test_options_flow(hass, validate_config_entry, bypass_update):
"""Test options flow."""
entry = MockConfigEntry(
domain=DOMAIN,
data={
CONF_API_KEY: "api_key",
CONF_ORIGIN: "location1",
CONF_DESTINATION: "location2",
},
data=MOCK_CONFIG,
options={
CONF_MODE: "driving",
CONF_ARRIVAL_TIME: "test",
@ -142,11 +131,7 @@ async def test_options_flow_departure_time(hass, validate_config_entry, bypass_u
"""Test options flow wiith departure time."""
entry = MockConfigEntry(
domain=DOMAIN,
data={
CONF_API_KEY: "api_key",
CONF_ORIGIN: "location1",
CONF_DESTINATION: "location2",
},
data=MOCK_CONFIG,
)
entry.add_to_hass(hass)
await hass.config_entries.async_setup(entry.entry_id)

View File

@ -0,0 +1,234 @@
"""Test the Google Maps Travel Time sensors."""
from unittest.mock import patch
import pytest
from homeassistant.components.google_travel_time.const import (
CONF_ARRIVAL_TIME,
CONF_DEPARTURE_TIME,
CONF_TRAVEL_MODE,
DOMAIN,
)
from .const import MOCK_CONFIG
from tests.common import MockConfigEntry
@pytest.fixture(name="mock_config")
async def mock_config_fixture(hass, data, options):
"""Mock a Google Travel Time config entry."""
config_entry = MockConfigEntry(
domain=DOMAIN,
data=data,
options=options,
entry_id="test",
)
config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
@pytest.fixture(name="mock_update")
def mock_update_fixture():
"""Mock an update to the sensor."""
with patch("homeassistant.components.google_travel_time.sensor.Client"), patch(
"homeassistant.components.google_travel_time.sensor.distance_matrix"
) as distance_matrix_mock:
distance_matrix_mock.return_value = {
"rows": [
{
"elements": [
{
"duration_in_traffic": {
"value": 1620,
"text": "27 mins",
},
"duration": {
"value": 1560,
"text": "26 mins",
},
"distance": {"text": "21.3 km"},
}
]
}
]
}
yield distance_matrix_mock
@pytest.fixture(name="mock_update_duration")
def mock_update_duration_fixture(mock_update):
"""Mock an update to the sensor returning no duration_in_traffic."""
mock_update.return_value = {
"rows": [
{
"elements": [
{
"duration": {
"value": 1560,
"text": "26 mins",
},
"distance": {"text": "21.3 km"},
}
]
}
]
}
yield mock_update
@pytest.fixture(name="mock_update_empty")
def mock_update_empty_fixture(mock_update):
"""Mock an update to the sensor with an empty response."""
mock_update.return_value = None
yield mock_update
@pytest.mark.parametrize(
"data,options",
[(MOCK_CONFIG, {})],
)
@pytest.mark.usefixtures("mock_update", "mock_config")
async def test_sensor(hass):
"""Test that sensor works."""
assert hass.states.get("sensor.google_travel_time").state == "27"
assert (
hass.states.get("sensor.google_travel_time").attributes["attribution"]
== "Powered by Google"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["duration"] == "26 mins"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["duration_in_traffic"]
== "27 mins"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["distance"] == "21.3 km"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["origin"] == "location1"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["destination"]
== "location2"
)
assert (
hass.states.get("sensor.google_travel_time").attributes["unit_of_measurement"]
== "min"
)
@pytest.mark.parametrize(
"data,options",
[(MOCK_CONFIG, {})],
)
@pytest.mark.usefixtures("mock_update_duration", "mock_config")
async def test_sensor_duration(hass):
"""Test that sensor works with no duration_in_traffic in response."""
assert hass.states.get("sensor.google_travel_time").state == "26"
@pytest.mark.parametrize(
"data,options",
[(MOCK_CONFIG, {})],
)
@pytest.mark.usefixtures("mock_update_empty", "mock_config")
async def test_sensor_empty_response(hass):
"""Test that sensor works for an empty response."""
assert hass.states.get("sensor.google_travel_time").state == "unknown"
@pytest.mark.parametrize(
"data,options",
[
(
MOCK_CONFIG,
{
CONF_DEPARTURE_TIME: "10:00",
},
),
],
)
@pytest.mark.usefixtures("mock_update", "mock_config")
async def test_sensor_departure_time(hass):
"""Test that sensor works for departure time."""
assert hass.states.get("sensor.google_travel_time").state == "27"
@pytest.mark.parametrize(
"data,options",
[
(
MOCK_CONFIG,
{
CONF_DEPARTURE_TIME: "custom_timestamp",
},
),
],
)
@pytest.mark.usefixtures("mock_update", "mock_config")
async def test_sensor_departure_time_custom_timestamp(hass):
"""Test that sensor works for departure time with a custom timestamp."""
assert hass.states.get("sensor.google_travel_time").state == "27"
@pytest.mark.parametrize(
"data,options",
[
(
MOCK_CONFIG,
{
CONF_ARRIVAL_TIME: "10:00",
},
),
],
)
@pytest.mark.usefixtures("mock_update", "mock_config")
async def test_sensor_arrival_time(hass):
"""Test that sensor works for arrival time."""
assert hass.states.get("sensor.google_travel_time").state == "27"
@pytest.mark.parametrize(
"data,options",
[
(
MOCK_CONFIG,
{
CONF_ARRIVAL_TIME: "custom_timestamp",
},
),
],
)
@pytest.mark.usefixtures("mock_update", "mock_config")
async def test_sensor_arrival_time_custom_timestamp(hass):
"""Test that sensor works for arrival time with a custom timestamp."""
assert hass.states.get("sensor.google_travel_time").state == "27"
@pytest.mark.usefixtures("mock_update")
async def test_sensor_deprecation_warning(hass, caplog):
"""Test that sensor setup prints a deprecating warning for old configs.
The mock_config fixture does not work with caplog.
"""
data = MOCK_CONFIG.copy()
data[CONF_TRAVEL_MODE] = "driving"
config_entry = MockConfigEntry(
domain=DOMAIN,
data=data,
entry_id="test",
)
config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert hass.states.get("sensor.google_travel_time").state == "27"
wstr = (
"Google Travel Time: travel_mode is deprecated, please "
"add mode to the options dictionary instead!"
)
assert wstr in caplog.text