Cleanup and migrate rest_command tests to be async (#107264)

Migrate rest_command tests to be async
This commit is contained in:
Jan-Philipp Benecke 2024-01-05 18:53:25 +01:00 committed by GitHub
parent 833cddc8f5
commit 9a15a5b6c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 379 additions and 417 deletions

View file

@ -0,0 +1,42 @@
"""Fixtures for the trend component tests."""
from collections.abc import Awaitable, Callable
from typing import Any
import pytest
from homeassistant.components.rest_command import DOMAIN
from homeassistant.core import HomeAssistant
from homeassistant.setup import async_setup_component
from tests.common import assert_setup_component
ComponentSetup = Callable[[dict[str, Any] | None], Awaitable[None]]
TEST_URL = "https://example.com/"
TEST_CONFIG = {
"get_test": {"url": TEST_URL, "method": "get"},
"patch_test": {"url": TEST_URL, "method": "patch"},
"post_test": {"url": TEST_URL, "method": "post", "payload": "test"},
"put_test": {"url": TEST_URL, "method": "put"},
"delete_test": {"url": TEST_URL, "method": "delete"},
"auth_test": {
"url": TEST_URL,
"method": "get",
"username": "test",
"password": "123456",
},
}
@pytest.fixture(name="setup_component")
async def mock_setup_component(
hass: HomeAssistant,
) -> ComponentSetup:
"""Set up the rest_command component."""
async def _setup_func(alternative_config: dict[str, Any] | None = None) -> None:
config = alternative_config or TEST_CONFIG
with assert_setup_component(len(config)):
await async_setup_component(hass, DOMAIN, {DOMAIN: config})
return _setup_func

View file

@ -7,61 +7,29 @@ from unittest.mock import patch
import aiohttp
import pytest
import homeassistant.components.rest_command as rc
from homeassistant.components.rest_command import DOMAIN
from homeassistant.const import (
CONTENT_TYPE_JSON,
CONTENT_TYPE_TEXT_PLAIN,
SERVICE_RELOAD,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.setup import setup_component
from tests.common import assert_setup_component, get_test_home_assistant
from .conftest import TEST_URL, ComponentSetup
from tests.test_util.aiohttp import AiohttpClientMocker
class TestRestCommandSetup:
"""Test the rest command component."""
def setup_method(self):
"""Set up things to be run when tests are started."""
self.hass = get_test_home_assistant()
self.config = {rc.DOMAIN: {"test_get": {"url": "http://example.com/"}}}
def teardown_method(self):
"""Stop everything that was started."""
self.hass.stop()
def test_setup_component(self):
"""Test setup component."""
with assert_setup_component(1):
setup_component(self.hass, rc.DOMAIN, self.config)
def test_setup_component_timeout(self):
"""Test setup component timeout."""
self.config[rc.DOMAIN]["test_get"]["timeout"] = 10
with assert_setup_component(1):
setup_component(self.hass, rc.DOMAIN, self.config)
def test_setup_component_test_service(self):
"""Test setup component and check if service exits."""
with assert_setup_component(1):
setup_component(self.hass, rc.DOMAIN, self.config)
assert self.hass.services.has_service(rc.DOMAIN, "test_get")
def test_reload(self):
async def test_reload(hass: HomeAssistant, setup_component: ComponentSetup) -> None:
"""Verify we can reload rest_command integration."""
await setup_component()
with assert_setup_component(1):
setup_component(self.hass, rc.DOMAIN, self.config)
assert self.hass.services.has_service(rc.DOMAIN, "test_get")
assert not self.hass.services.has_service(rc.DOMAIN, "new_test")
assert hass.services.has_service(DOMAIN, "get_test")
assert not hass.services.has_service(DOMAIN, "new_test")
new_config = {
rc.DOMAIN: {
DOMAIN: {
"new_test": {"url": "https://example.org", "method": "get"},
}
}
@ -70,193 +38,141 @@ class TestRestCommandSetup:
autospec=True,
return_value=new_config,
):
self.hass.services.call(rc.DOMAIN, SERVICE_RELOAD, blocking=True)
await hass.services.async_call(DOMAIN, SERVICE_RELOAD, blocking=True)
assert self.hass.services.has_service(rc.DOMAIN, "new_test")
assert not self.hass.services.has_service(rc.DOMAIN, "get_test")
assert hass.services.has_service(DOMAIN, "new_test")
assert not hass.services.has_service(DOMAIN, "get_test")
class TestRestCommandComponent:
"""Test the rest command component."""
def setup_method(self):
"""Set up things to be run when tests are started."""
self.url = "https://example.com/"
self.config = {
rc.DOMAIN: {
"get_test": {"url": self.url, "method": "get"},
"patch_test": {"url": self.url, "method": "patch"},
"post_test": {"url": self.url, "method": "post"},
"put_test": {"url": self.url, "method": "put"},
"delete_test": {"url": self.url, "method": "delete"},
}
}
self.hass = get_test_home_assistant()
def teardown_method(self):
"""Stop everything that was started."""
self.hass.stop()
def test_setup_tests(self):
async def test_setup_tests(
hass: HomeAssistant, setup_component: ComponentSetup
) -> None:
"""Set up test config and test it."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
assert self.hass.services.has_service(rc.DOMAIN, "get_test")
assert self.hass.services.has_service(rc.DOMAIN, "post_test")
assert self.hass.services.has_service(rc.DOMAIN, "put_test")
assert self.hass.services.has_service(rc.DOMAIN, "delete_test")
assert hass.services.has_service(DOMAIN, "get_test")
assert hass.services.has_service(DOMAIN, "post_test")
assert hass.services.has_service(DOMAIN, "put_test")
assert hass.services.has_service(DOMAIN, "delete_test")
def test_rest_command_timeout(self, aioclient_mock):
async def test_rest_command_timeout(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with timeout."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
aioclient_mock.get(self.url, exc=asyncio.TimeoutError())
aioclient_mock.get(TEST_URL, exc=asyncio.TimeoutError())
with pytest.raises(
HomeAssistantError,
match=r"^Timeout when calling resource 'https://example.com/'$",
):
self.hass.services.call(rc.DOMAIN, "get_test", {}, blocking=True)
await hass.services.async_call(DOMAIN, "get_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_aiohttp_error(self, aioclient_mock):
"""Call a rest command with aiohttp exception."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.get(self.url, exc=aiohttp.ClientError())
async def test_rest_command_aiohttp_error(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with aiohttp exception."""
await setup_component()
aioclient_mock.get(TEST_URL, exc=aiohttp.ClientError())
with pytest.raises(
HomeAssistantError,
match=r"^Client error occurred when calling resource 'https://example.com/'$",
):
self.hass.services.call(rc.DOMAIN, "get_test", {}, blocking=True)
await hass.services.async_call(DOMAIN, "get_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_http_error(self, aioclient_mock):
async def test_rest_command_http_error(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with status code 400."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
aioclient_mock.get(self.url, status=HTTPStatus.BAD_REQUEST)
aioclient_mock.get(TEST_URL, status=HTTPStatus.BAD_REQUEST)
self.hass.services.call(rc.DOMAIN, "get_test", {})
self.hass.block_till_done()
await hass.services.async_call(DOMAIN, "get_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_auth(self, aioclient_mock):
async def test_rest_command_auth(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with auth credential."""
data = {"username": "test", "password": "123456"}
self.config[rc.DOMAIN]["get_test"].update(data)
await setup_component()
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.get(TEST_URL, content=b"success")
aioclient_mock.get(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "get_test", {})
self.hass.block_till_done()
await hass.services.async_call(DOMAIN, "auth_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_form_data(self, aioclient_mock):
async def test_rest_command_form_data(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with post form data."""
data = {"payload": "test"}
self.config[rc.DOMAIN]["post_test"].update(data)
await setup_component()
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.post(TEST_URL, content=b"success")
aioclient_mock.post(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "post_test", {})
self.hass.block_till_done()
await hass.services.async_call(DOMAIN, "post_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
assert aioclient_mock.mock_calls[0][2] == b"test"
def test_rest_command_get(self, aioclient_mock):
"""Call a rest command with get."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.get(self.url, content=b"success")
@pytest.mark.parametrize(
"method",
[
"get",
"patch",
"post",
"put",
"delete",
],
)
async def test_rest_command_methods(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
method: str,
):
"""Test various http methods."""
await setup_component()
self.hass.services.call(rc.DOMAIN, "get_test", {})
self.hass.block_till_done()
aioclient_mock.request(method=method, url=TEST_URL, content=b"success")
await hass.services.async_call(DOMAIN, f"{method}_test", {}, blocking=True)
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_delete(self, aioclient_mock):
"""Call a rest command with delete."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.delete(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "delete_test", {})
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
def test_rest_command_patch(self, aioclient_mock):
"""Call a rest command with patch."""
data = {"payload": "data"}
self.config[rc.DOMAIN]["patch_test"].update(data)
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.patch(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "patch_test", {})
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
assert aioclient_mock.mock_calls[0][2] == b"data"
def test_rest_command_post(self, aioclient_mock):
"""Call a rest command with post."""
data = {"payload": "data"}
self.config[rc.DOMAIN]["post_test"].update(data)
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.post(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "post_test", {})
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
assert aioclient_mock.mock_calls[0][2] == b"data"
def test_rest_command_put(self, aioclient_mock):
"""Call a rest command with put."""
data = {"payload": "data"}
self.config[rc.DOMAIN]["put_test"].update(data)
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
aioclient_mock.put(self.url, content=b"success")
self.hass.services.call(rc.DOMAIN, "put_test", {})
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
assert aioclient_mock.mock_calls[0][2] == b"data"
def test_rest_command_headers(self, aioclient_mock):
async def test_rest_command_headers(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Call a rest command with custom headers and content types."""
header_config_variations = {
rc.DOMAIN: {
"no_headers_test": {},
"content_type_test": {"content_type": CONTENT_TYPE_TEXT_PLAIN},
"headers_test": {
@ -290,19 +206,15 @@ class TestRestCommandComponent:
"content_type": "text/json",
},
}
}
# add common parameters
for variation in header_config_variations[rc.DOMAIN].values():
variation.update(
{"url": self.url, "method": "post", "payload": "test data"}
)
for variation in header_config_variations.values():
variation.update({"url": TEST_URL, "method": "post", "payload": "test data"})
with assert_setup_component(7):
setup_component(self.hass, rc.DOMAIN, header_config_variations)
await setup_component(header_config_variations)
# provide post request data
aioclient_mock.post(self.url, content=b"success")
aioclient_mock.post(TEST_URL, content=b"success")
for test_service in [
"no_headers_test",
@ -313,9 +225,9 @@ class TestRestCommandComponent:
"headers_template_test",
"headers_and_content_type_override_template_test",
]:
self.hass.services.call(rc.DOMAIN, test_service, {})
await hass.services.async_call(DOMAIN, test_service, {}, blocking=True)
self.hass.block_till_done()
await hass.async_block_till_done()
assert len(aioclient_mock.mock_calls) == 7
# no_headers_test
@ -356,65 +268,71 @@ class TestRestCommandComponent:
# headers_and_content_type_override_template_test
assert len(aioclient_mock.mock_calls[6][3]) == 2
assert (
aioclient_mock.mock_calls[6][3].get(aiohttp.hdrs.CONTENT_TYPE)
== "text/json"
)
assert aioclient_mock.mock_calls[6][3].get(aiohttp.hdrs.CONTENT_TYPE) == "text/json"
assert aioclient_mock.mock_calls[6][3].get("Accept") == "application/2json"
def test_rest_command_get_response_plaintext(self, aioclient_mock):
async def test_rest_command_get_response_plaintext(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Get rest_command response, text."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
aioclient_mock.get(
self.url, content=b"success", headers={"content-type": "text/plain"}
TEST_URL, content=b"success", headers={"content-type": "text/plain"}
)
response = self.hass.services.call(
rc.DOMAIN, "get_test", {}, blocking=True, return_response=True
response = await hass.services.async_call(
DOMAIN, "get_test", {}, blocking=True, return_response=True
)
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
assert response["content"] == "success"
assert response["status"] == 200
def test_rest_command_get_response_json(self, aioclient_mock):
async def test_rest_command_get_response_json(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Get rest_command response, json."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
aioclient_mock.get(
self.url,
TEST_URL,
json={"status": "success", "number": 42},
headers={"content-type": "application/json"},
)
response = self.hass.services.call(
rc.DOMAIN, "get_test", {}, blocking=True, return_response=True
response = await hass.services.async_call(
DOMAIN, "get_test", {}, blocking=True, return_response=True
)
self.hass.block_till_done()
assert len(aioclient_mock.mock_calls) == 1
assert response["content"]["status"] == "success"
assert response["content"]["number"] == 42
assert response["status"] == 200
def test_rest_command_get_response_malformed_json(self, aioclient_mock):
async def test_rest_command_get_response_malformed_json(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Get rest_command response, malformed json."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
aioclient_mock.get(
self.url,
TEST_URL,
content='{"status": "failure", 42',
headers={"content-type": "application/json"},
)
# No problem without 'return_response'
response = self.hass.services.call(rc.DOMAIN, "get_test", {}, blocking=True)
self.hass.block_till_done()
response = await hass.services.async_call(DOMAIN, "get_test", {}, blocking=True)
assert not response
# Throws error when requesting response
@ -422,29 +340,32 @@ class TestRestCommandComponent:
HomeAssistantError,
match=r"^Response of 'https://example.com/' could not be decoded as JSON$",
):
response = self.hass.services.call(
rc.DOMAIN, "get_test", {}, blocking=True, return_response=True
await hass.services.async_call(
DOMAIN, "get_test", {}, blocking=True, return_response=True
)
self.hass.block_till_done()
def test_rest_command_get_response_none(self, aioclient_mock):
async def test_rest_command_get_response_none(
hass: HomeAssistant,
setup_component: ComponentSetup,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Get rest_command response, other."""
with assert_setup_component(5):
setup_component(self.hass, rc.DOMAIN, self.config)
await setup_component()
png = base64.decodebytes(
b"iVBORw0KGgoAAAANSUhEUgAAAAIAAAABCAIAAAB7QOjdAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAAAPSURBVBhXY/h/ku////8AECAE1JZPvDAAAAAASUVORK5CYII="
b"iVBORw0KGgoAAAANSUhEUgAAAAIAAAABCAIAAAB7QOjdAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQ"
b"UAAAAJcEhZcwAAFiUAABYlAUlSJPAAAAAPSURBVBhXY/h/ku////8AECAE1JZPvDAAAAAASUVORK5CYII="
)
aioclient_mock.get(
self.url,
TEST_URL,
content=png,
headers={"content-type": "text/plain"},
)
# No problem without 'return_response'
response = self.hass.services.call(rc.DOMAIN, "get_test", {}, blocking=True)
self.hass.block_till_done()
response = await hass.services.async_call(DOMAIN, "get_test", {}, blocking=True)
assert not response
# Throws Decode error when requesting response
@ -452,9 +373,8 @@ class TestRestCommandComponent:
HomeAssistantError,
match=r"^Response of 'https://example.com/' could not be decoded as text$",
):
response = self.hass.services.call(
rc.DOMAIN, "get_test", {}, blocking=True, return_response=True
response = await hass.services.async_call(
DOMAIN, "get_test", {}, blocking=True, return_response=True
)
self.hass.block_till_done()
assert not response