"""The tests for the REST sensor platform.""" import asyncio from os import path import httpx import respx from homeassistant import config as hass_config import homeassistant.components.sensor as sensor from homeassistant.const import ( ATTR_UNIT_OF_MEASUREMENT, CONTENT_TYPE_JSON, DATA_MEGABYTES, SERVICE_RELOAD, STATE_UNKNOWN, ) from homeassistant.setup import async_setup_component from tests.async_mock import Mock, patch async def test_setup_missing_config(hass): """Test setup with configuration missing required entries.""" assert await async_setup_component( hass, sensor.DOMAIN, {"sensor": {"platform": "rest"}} ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 0 async def test_setup_missing_schema(hass): """Test setup with resource missing schema.""" assert await async_setup_component( hass, sensor.DOMAIN, {"sensor": {"platform": "rest", "resource": "localhost", "method": "GET"}}, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 0 @respx.mock async def test_setup_failed_connect(hass): """Test setup when connection error occurs.""" respx.get( "http://localhost", content=httpx.RequestError(message="any", request=Mock()) ) assert await async_setup_component( hass, sensor.DOMAIN, { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 0 @respx.mock async def test_setup_timeout(hass): """Test setup when connection timeout occurs.""" respx.get("http://localhost", content=asyncio.TimeoutError()) assert await async_setup_component( hass, sensor.DOMAIN, {"sensor": {"platform": "rest", "resource": "localhost", "method": "GET"}}, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 0 @respx.mock async def test_setup_minimum(hass): """Test setup with minimum configuration.""" respx.get("http://localhost", status_code=200) assert await async_setup_component( hass, sensor.DOMAIN, { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 @respx.mock async def test_setup_minimum_resource_template(hass): """Test setup with minimum configuration (resource_template).""" respx.get("http://localhost", status_code=200) assert await async_setup_component( hass, sensor.DOMAIN, { "sensor": { "platform": "rest", "resource_template": "http://localhost", } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 @respx.mock async def test_setup_duplicate_resource_template(hass): """Test setup with duplicate resources.""" respx.get("http://localhost", status_code=200) assert await async_setup_component( hass, sensor.DOMAIN, { "sensor": { "platform": "rest", "resource": "http://localhost", "resource_template": "http://localhost", } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 0 @respx.mock async def test_setup_get(hass): """Test setup with valid configuration.""" respx.get("http://localhost", status_code=200, content="{}") assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "authentication": "basic", "username": "my username", "password": "my password", "headers": {"Accept": CONTENT_TYPE_JSON}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 @respx.mock async def test_setup_get_digest_auth(hass): """Test setup with valid configuration.""" respx.get("http://localhost", status_code=200, content="{}") assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "authentication": "digest", "username": "my username", "password": "my password", "headers": {"Accept": CONTENT_TYPE_JSON}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 @respx.mock async def test_setup_post(hass): """Test setup with valid configuration.""" respx.post("http://localhost", status_code=200, content="{}") assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "POST", "value_template": "{{ value_json.key }}", "payload": '{ "device": "toaster"}', "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "authentication": "basic", "username": "my username", "password": "my password", "headers": {"Accept": CONTENT_TYPE_JSON}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 @respx.mock async def test_setup_get_xml(hass): """Test setup with valid xml configuration.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "text/xml"}, content="abc", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.dog }}", "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "abc" assert state.attributes[ATTR_UNIT_OF_MEASUREMENT] == DATA_MEGABYTES @respx.mock async def test_update_with_json_attrs(hass): """Test attributes get extracted from a JSON result.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content='{ "key": "some_json_value" }', ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "some_json_value" assert state.attributes["key"] == "some_json_value" @respx.mock async def test_update_with_no_template(hass): """Test update when there is no value template.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content='{ "key": "some_json_value" }', ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "headers": {"Accept": "text/xml"}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == '{ "key": "some_json_value" }' @respx.mock async def test_update_with_json_attrs_no_data(hass, caplog): """Test attributes when no JSON result fetched.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content="", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "headers": {"Accept": "text/xml"}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == STATE_UNKNOWN assert state.attributes == {"unit_of_measurement": "MB", "friendly_name": "foo"} assert "Empty reply" in caplog.text @respx.mock async def test_update_with_json_attrs_not_dict(hass, caplog): """Test attributes get extracted from a JSON result.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content='["list", "of", "things"]', ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "headers": {"Accept": "text/xml"}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "" assert state.attributes == {"unit_of_measurement": "MB", "friendly_name": "foo"} assert "not a dictionary or list" in caplog.text @respx.mock async def test_update_with_json_attrs_bad_JSON(hass, caplog): """Test attributes get extracted from a JSON result.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content="This is text rather than JSON data.", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.key }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "headers": {"Accept": "text/xml"}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == STATE_UNKNOWN assert state.attributes == {"unit_of_measurement": "MB", "friendly_name": "foo"} assert "Erroneous JSON" in caplog.text @respx.mock async def test_update_with_json_attrs_with_json_attrs_path(hass): """Test attributes get extracted from a JSON result with a template for the attributes.""" respx.get( "http://localhost", status_code=200, headers={"content-type": CONTENT_TYPE_JSON}, content='{ "toplevel": {"master_value": "master", "second_level": {"some_json_key": "some_json_value", "some_json_key2": "some_json_value2" } } }', ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.toplevel.master_value }}", "json_attributes_path": "$.toplevel.second_level", "json_attributes": ["some_json_key", "some_json_key2"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, "headers": {"Accept": "text/xml"}, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "master" assert state.attributes["some_json_key"] == "some_json_value" assert state.attributes["some_json_key2"] == "some_json_value2" @respx.mock async def test_update_with_xml_convert_json_attrs_with_json_attrs_path(hass): """Test attributes get extracted from a JSON result that was converted from XML with a template for the attributes.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "text/xml"}, content="mastersome_json_valuesome_json_value2", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.toplevel.master_value }}", "json_attributes_path": "$.toplevel.second_level", "json_attributes": ["some_json_key", "some_json_key2"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "master" assert state.attributes["some_json_key"] == "some_json_value" assert state.attributes["some_json_key2"] == "some_json_value2" @respx.mock async def test_update_with_xml_convert_json_attrs_with_jsonattr_template(hass): """Test attributes get extracted from a JSON result that was converted from XML.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "text/xml"}, content='01255648alexander000bogus000000000upupupup000x0XF0x0XF 0', ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.response.bss.wlan }}", "json_attributes_path": "$.response", "json_attributes": ["led0", "led1", "temp0", "time0", "ver"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "bogus" assert state.attributes["led0"] == "0" assert state.attributes["led1"] == "0" assert state.attributes["temp0"] == "0x0XF0x0XF" assert state.attributes["time0"] == "0" assert state.attributes["ver"] == "12556" @respx.mock async def test_update_with_application_xml_convert_json_attrs_with_jsonattr_template( hass, ): """Test attributes get extracted from a JSON result that was converted from XML with application/xml mime type.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "application/xml"}, content="
13
", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.main.dog }}", "json_attributes_path": "$.main", "json_attributes": ["dog", "cat"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == "1" assert state.attributes["dog"] == "1" assert state.attributes["cat"] == "3" @respx.mock async def test_update_with_xml_convert_bad_xml(hass, caplog): """Test attributes get extracted from a XML result with bad xml.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "text/xml"}, content="", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.toplevel.master_value }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == STATE_UNKNOWN assert "Erroneous XML" in caplog.text assert "Empty reply" in caplog.text @respx.mock async def test_update_with_failed_get(hass, caplog): """Test attributes get extracted from a XML result with bad xml.""" respx.get( "http://localhost", status_code=200, headers={"content-type": "text/xml"}, content="", ) assert await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "resource": "http://localhost", "method": "GET", "value_template": "{{ value_json.toplevel.master_value }}", "json_attributes": ["key"], "name": "foo", "unit_of_measurement": DATA_MEGABYTES, "verify_ssl": "true", "timeout": 30, } }, ) await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 state = hass.states.get("sensor.foo") assert state.state == STATE_UNKNOWN assert "Erroneous XML" in caplog.text assert "Empty reply" in caplog.text @respx.mock async def test_reload(hass): """Verify we can reload reset sensors.""" respx.get("http://localhost", status_code=200) await async_setup_component( hass, "sensor", { "sensor": { "platform": "rest", "method": "GET", "name": "mockrest", "resource": "http://localhost", } }, ) await hass.async_block_till_done() await hass.async_start() await hass.async_block_till_done() assert len(hass.states.async_all()) == 1 assert hass.states.get("sensor.mockrest") yaml_path = path.join( _get_fixtures_base_path(), "fixtures", "rest/configuration.yaml", ) with patch.object(hass_config, "YAML_CONFIG_FILE", yaml_path): await hass.services.async_call( "rest", SERVICE_RELOAD, {}, blocking=True, ) await hass.async_block_till_done() assert hass.states.get("sensor.mockreset") is None assert hass.states.get("sensor.rollout") def _get_fixtures_base_path(): return path.dirname(path.dirname(path.dirname(__file__)))