"""Test the python_script component.""" import asyncio import logging from unittest.mock import patch, mock_open from homeassistant.setup import async_setup_component from homeassistant.components.python_script import execute @asyncio.coroutine def test_setup(hass): """Test we can discover scripts.""" scripts = [ "/some/config/dir/python_scripts/hello.py", "/some/config/dir/python_scripts/world_beer.py", ] with patch( "homeassistant.components.python_script.os.path.isdir", return_value=True ), patch("homeassistant.components.python_script.glob.iglob", return_value=scripts): res = yield from async_setup_component(hass, "python_script", {}) assert res assert hass.services.has_service("python_script", "hello") assert hass.services.has_service("python_script", "world_beer") with patch( "homeassistant.components.python_script.open", mock_open(read_data="fake source"), create=True, ), patch("homeassistant.components.python_script.execute") as mock_ex: yield from hass.services.async_call( "python_script", "hello", {"some": "data"}, blocking=True ) assert len(mock_ex.mock_calls) == 1 hass, script, source, data = mock_ex.mock_calls[0][1] assert hass is hass assert script == "hello.py" assert source == "fake source" assert data == {"some": "data"} @asyncio.coroutine def test_setup_fails_on_no_dir(hass, caplog): """Test we fail setup when no dir found.""" with patch( "homeassistant.components.python_script.os.path.isdir", return_value=False ): res = yield from async_setup_component(hass, "python_script", {}) assert not res assert "Folder python_scripts not found in configuration folder" in caplog.text @asyncio.coroutine def test_execute_with_data(hass, caplog): """Test executing a script.""" caplog.set_level(logging.WARNING) source = """ hass.states.set('test.entity', data.get('name', 'not set')) """ hass.async_add_job(execute, hass, "test.py", source, {"name": "paulus"}) yield from hass.async_block_till_done() assert hass.states.is_state("test.entity", "paulus") # No errors logged = good assert caplog.text == "" @asyncio.coroutine def test_execute_warns_print(hass, caplog): """Test print triggers warning.""" caplog.set_level(logging.WARNING) source = """ print("This triggers warning.") """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Don't use print() inside scripts." in caplog.text @asyncio.coroutine def test_execute_logging(hass, caplog): """Test logging works.""" caplog.set_level(logging.INFO) source = """ logger.info('Logging from inside script') """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Logging from inside script" in caplog.text @asyncio.coroutine def test_execute_compile_error(hass, caplog): """Test compile error logs error.""" caplog.set_level(logging.ERROR) source = """ this is not valid Python """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Error loading script test.py" in caplog.text @asyncio.coroutine def test_execute_runtime_error(hass, caplog): """Test compile error logs error.""" caplog.set_level(logging.ERROR) source = """ raise Exception('boom') """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Error executing script: boom" in caplog.text @asyncio.coroutine def test_accessing_async_methods(hass, caplog): """Test compile error logs error.""" caplog.set_level(logging.ERROR) source = """ hass.async_stop() """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Not allowed to access async methods" in caplog.text @asyncio.coroutine def test_using_complex_structures(hass, caplog): """Test that dicts and lists work.""" caplog.set_level(logging.INFO) source = """ mydict = {"a": 1, "b": 2} mylist = [1, 2, 3, 4] logger.info('Logging from inside script: %s %s' % (mydict["a"], mylist[2])) """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Logging from inside script: 1 3" in caplog.text @asyncio.coroutine def test_accessing_forbidden_methods(hass, caplog): """Test compile error logs error.""" caplog.set_level(logging.ERROR) for source, name in { "hass.stop()": "HomeAssistant.stop", "dt_util.set_default_time_zone()": "module.set_default_time_zone", "datetime.non_existing": "module.non_existing", "time.tzset()": "TimeWrapper.tzset", }.items(): caplog.records.clear() hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert "Not allowed to access {}".format(name) in caplog.text @asyncio.coroutine def test_iterating(hass): """Test compile error logs error.""" source = """ for i in [1, 2]: hass.states.set('hello.{}'.format(i), 'world') """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert hass.states.is_state("hello.1", "world") assert hass.states.is_state("hello.2", "world") @asyncio.coroutine def test_unpacking_sequence(hass, caplog): """Test compile error logs error.""" caplog.set_level(logging.ERROR) source = """ a,b = (1,2) ab_list = [(a,b) for a,b in [(1, 2), (3, 4)]] hass.states.set('hello.a', a) hass.states.set('hello.b', b) hass.states.set('hello.ab_list', '{}'.format(ab_list)) """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert hass.states.is_state("hello.a", "1") assert hass.states.is_state("hello.b", "2") assert hass.states.is_state("hello.ab_list", "[(1, 2), (3, 4)]") # No errors logged = good assert caplog.text == "" @asyncio.coroutine def test_execute_sorted(hass, caplog): """Test sorted() function.""" caplog.set_level(logging.ERROR) source = """ a = sorted([3,1,2]) assert(a == [1,2,3]) hass.states.set('hello.a', a[0]) hass.states.set('hello.b', a[1]) hass.states.set('hello.c', a[2]) """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert hass.states.is_state("hello.a", "1") assert hass.states.is_state("hello.b", "2") assert hass.states.is_state("hello.c", "3") # No errors logged = good assert caplog.text == "" @asyncio.coroutine def test_exposed_modules(hass, caplog): """Test datetime and time modules exposed.""" caplog.set_level(logging.ERROR) source = """ hass.states.set('module.time', time.strftime('%Y', time.gmtime(521276400))) hass.states.set('module.time_strptime', time.strftime('%H:%M', time.strptime('12:34', '%H:%M'))) hass.states.set('module.datetime', datetime.timedelta(minutes=1).total_seconds()) """ hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert hass.states.is_state("module.time", "1986") assert hass.states.is_state("module.time_strptime", "12:34") assert hass.states.is_state("module.datetime", "60.0") # No errors logged = good assert caplog.text == "" @asyncio.coroutine def test_reload(hass): """Test we can re-discover scripts.""" scripts = [ "/some/config/dir/python_scripts/hello.py", "/some/config/dir/python_scripts/world_beer.py", ] with patch( "homeassistant.components.python_script.os.path.isdir", return_value=True ), patch("homeassistant.components.python_script.glob.iglob", return_value=scripts): res = yield from async_setup_component(hass, "python_script", {}) assert res assert hass.services.has_service("python_script", "hello") assert hass.services.has_service("python_script", "world_beer") assert hass.services.has_service("python_script", "reload") scripts = [ "/some/config/dir/python_scripts/hello2.py", "/some/config/dir/python_scripts/world_beer.py", ] with patch( "homeassistant.components.python_script.os.path.isdir", return_value=True ), patch("homeassistant.components.python_script.glob.iglob", return_value=scripts): yield from hass.services.async_call( "python_script", "reload", {}, blocking=True ) assert not hass.services.has_service("python_script", "hello") assert hass.services.has_service("python_script", "hello2") assert hass.services.has_service("python_script", "world_beer") assert hass.services.has_service("python_script", "reload") @asyncio.coroutine def test_sleep_warns_one(hass, caplog): """Test time.sleep warns once.""" caplog.set_level(logging.WARNING) source = """ time.sleep(2) time.sleep(5) """ with patch("homeassistant.components.python_script.time.sleep"): hass.async_add_job(execute, hass, "test.py", source, {}) yield from hass.async_block_till_done() assert caplog.text.count("time.sleep") == 1