jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-15 09:17:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rewrite shell_command unittest tests to pytest style test function (#41274)

Browse Source
This commit is contained in:
Ariana Hlavaty 2020-10-16 12:04:12 +01:00 committed by GitHub
parent 5e96d21414
commit 0a192947ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 124 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
tests/components/shell_command/test_init.py
View File

@ -1,15 +1,13 @@
"""The tests for the Shell command component.""" """The tests for the Shell command component."""
import asyncio
import os import os
import tempfile import tempfile
from typing import Tuple from typing import Tuple
import unittest
from homeassistant.components import shell_command from homeassistant.components import shell_command
from homeassistant.setup import async_setup_component, setup_component from homeassistant.setup import async_setup_component
from tests.async_mock import Mock, patch from tests.async_mock import MagicMock, patch
from tests.common import get_test_home_assistant
def mock_process_creator(error: bool = False): def mock_process_creator(error: bool = False):
@ -22,91 +20,79 @@ def mock_process_creator(error: bool = False):
""" """
return b"I am stdout", b"I am stderr" return b"I am stdout", b"I am stderr"
mock_process = Mock() mock_process = MagicMock()
mock_process.communicate = communicate mock_process.communicate = communicate
mock_process.returncode = int(error) mock_process.returncode = int(error)
return mock_process return mock_process
class TestShellCommand(unittest.TestCase): async def test_executing_service(hass):
"""Test the shell_command component."""
def setUp(self): # pylint: disable=invalid-name
"""Set up things to be run when tests are started.
Also seems to require a child watcher attached to the loop when run
from pytest.
"""
self.hass = get_test_home_assistant()
asyncio.get_child_watcher().attach_loop(self.hass.loop)
self.addCleanup(self.tear_down_cleanup)
def tear_down_cleanup(self):
"""Stop everything that was started."""
self.hass.stop()
def test_executing_service(self):
"""Test if able to call a configured service.""" """Test if able to call a configured service."""
with tempfile.TemporaryDirectory() as tempdirname: with tempfile.TemporaryDirectory() as tempdirname:
path = os.path.join(tempdirname, "called.txt") path = os.path.join(tempdirname, "called.txt")
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"test_service": f"date > {path}"}}, {shell_command.DOMAIN: {"test_service": f"date > {path}"}},
) )
await hass.async_block_till_done()
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
self.hass.block_till_done() await hass.async_block_till_done()
assert os.path.isfile(path) assert os.path.isfile(path)
def test_config_not_dict(self):
async def test_config_not_dict(hass):
"""Test that setup fails if config is not a dict.""" """Test that setup fails if config is not a dict."""
assert not setup_component( assert not await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: ["some", "weird", "list"]}, {shell_command.DOMAIN: ["some", "weird", "list"]},
) )
def test_config_not_valid_service_names(self):
async def test_config_not_valid_service_names(hass):
"""Test that setup fails if config contains invalid service names.""" """Test that setup fails if config contains invalid service names."""
assert not setup_component( assert not await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"this is invalid because space": "touch bla.txt"}}, {shell_command.DOMAIN: {"this is invalid because space": "touch bla.txt"}},
) )
@patch( @patch(
"homeassistant.components.shell_command.asyncio.subprocess" "homeassistant.components.shell_command.asyncio.subprocess"
".create_subprocess_shell" ".create_subprocess_shell"
) )
def test_template_render_no_template(self, mock_call): async def test_template_render_no_template(mock_call, hass):
"""Ensure shell_commands without templates get rendered properly.""" """Ensure shell_commands without templates get rendered properly."""
mock_call.return_value = mock_process_creator(error=False) mock_call.return_value = mock_process_creator(error=False)
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"test_service": "ls /bin"}}, {shell_command.DOMAIN: {"test_service": "ls /bin"}},
) )
await hass.async_block_till_done()
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
await hass.async_block_till_done()
self.hass.block_till_done()
cmd = mock_call.mock_calls[0][1][0] cmd = mock_call.mock_calls[0][1][0]
assert mock_call.call_count == 1 assert mock_call.call_count == 1
assert "ls /bin" == cmd assert "ls /bin" == cmd
@patch( @patch(
"homeassistant.components.shell_command.asyncio.subprocess" "homeassistant.components.shell_command.asyncio.subprocess"
".create_subprocess_exec" ".create_subprocess_exec"
) )
def test_template_render(self, mock_call): async def test_template_render(mock_call, hass):
"""Ensure shell_commands with templates get rendered properly.""" """Ensure shell_commands with templates get rendered properly."""
self.hass.states.set("sensor.test_state", "Works") hass.states.async_set("sensor.test_state", "Works")
mock_call.return_value = mock_process_creator(error=False) mock_call.return_value = mock_process_creator(error=False)
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{ {
shell_command.DOMAIN: { shell_command.DOMAIN: {
@ -115,66 +101,68 @@ class TestShellCommand(unittest.TestCase):
}, },
) )
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
self.hass.block_till_done() await hass.async_block_till_done()
cmd = mock_call.mock_calls[0][1] cmd = mock_call.mock_calls[0][1]
assert mock_call.call_count == 1 assert mock_call.call_count == 1
assert ("ls", "/bin", "Works") == cmd assert ("ls", "/bin", "Works") == cmd
@patch( @patch(
"homeassistant.components.shell_command.asyncio.subprocess" "homeassistant.components.shell_command.asyncio.subprocess"
".create_subprocess_shell" ".create_subprocess_shell"
) )
@patch("homeassistant.components.shell_command._LOGGER.error") @patch("homeassistant.components.shell_command._LOGGER.error")
def test_subprocess_error(self, mock_error, mock_call): async def test_subprocess_error(mock_error, mock_call, hass):
"""Test subprocess that returns an error.""" """Test subprocess that returns an error."""
mock_call.return_value = mock_process_creator(error=True) mock_call.return_value = mock_process_creator(error=True)
with tempfile.TemporaryDirectory() as tempdirname: with tempfile.TemporaryDirectory() as tempdirname:
path = os.path.join(tempdirname, "called.txt") path = os.path.join(tempdirname, "called.txt")
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"test_service": f"touch {path}"}}, {shell_command.DOMAIN: {"test_service": f"touch {path}"}},
) )
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
await hass.async_block_till_done()
self.hass.block_till_done()
assert mock_call.call_count == 1 assert mock_call.call_count == 1
assert mock_error.call_count == 1 assert mock_error.call_count == 1
assert not os.path.isfile(path) assert not os.path.isfile(path)
@patch("homeassistant.components.shell_command._LOGGER.debug") @patch("homeassistant.components.shell_command._LOGGER.debug")
def test_stdout_captured(self, mock_output): async def test_stdout_captured(mock_output, hass):
"""Test subprocess that has stdout.""" """Test subprocess that has stdout."""
test_phrase = "I have output" test_phrase = "I have output"
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"test_service": f"echo {test_phrase}"}}, {shell_command.DOMAIN: {"test_service": f"echo {test_phrase}"}},
) )
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
self.hass.block_till_done() await hass.async_block_till_done()
assert mock_output.call_count == 1 assert mock_output.call_count == 1
assert test_phrase.encode() + b"\n" == mock_output.call_args_list[0][0][-1] assert test_phrase.encode() + b"\n" == mock_output.call_args_list[0][0][-1]
@patch("homeassistant.components.shell_command._LOGGER.debug") @patch("homeassistant.components.shell_command._LOGGER.debug")
def test_stderr_captured(self, mock_output): async def test_stderr_captured(mock_output, hass):
"""Test subprocess that has stderr.""" """Test subprocess that has stderr."""
test_phrase = "I have error" test_phrase = "I have error"
assert setup_component( assert await async_setup_component(
self.hass, hass,
shell_command.DOMAIN, shell_command.DOMAIN,
{shell_command.DOMAIN: {"test_service": f">&2 echo {test_phrase}"}}, {shell_command.DOMAIN: {"test_service": f">&2 echo {test_phrase}"}},
) )
self.hass.services.call("shell_command", "test_service", blocking=True) await hass.services.async_call("shell_command", "test_service", blocking=True)
self.hass.block_till_done() await hass.async_block_till_done()
assert mock_output.call_count == 1 assert mock_output.call_count == 1
assert test_phrase.encode() + b"\n" == mock_output.call_args_list[0][0][-1] assert test_phrase.encode() + b"\n" == mock_output.call_args_list[0][0][-1]