560 lines
20 KiB
Python
560 lines
20 KiB
Python
"""Test config utils."""
|
|
# pylint: disable=protected-access
|
|
import os
|
|
import unittest
|
|
import unittest.mock as mock
|
|
|
|
import pytest
|
|
from voluptuous import MultipleInvalid
|
|
|
|
from homeassistant.core import DOMAIN, HomeAssistantError, Config
|
|
import homeassistant.config as config_util
|
|
from homeassistant.const import (
|
|
CONF_LATITUDE, CONF_LONGITUDE, CONF_UNIT_SYSTEM, CONF_NAME,
|
|
CONF_TIME_ZONE, CONF_ELEVATION, CONF_CUSTOMIZE, __version__,
|
|
CONF_UNIT_SYSTEM_METRIC, CONF_UNIT_SYSTEM_IMPERIAL, CONF_TEMPERATURE_UNIT)
|
|
from homeassistant.util import location as location_util, dt as dt_util
|
|
from homeassistant.util.async import run_coroutine_threadsafe
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.components.config.group import (
|
|
CONFIG_PATH as GROUP_CONFIG_PATH)
|
|
|
|
from tests.common import (
|
|
get_test_config_dir, get_test_home_assistant, mock_coro)
|
|
|
|
CONFIG_DIR = get_test_config_dir()
|
|
YAML_PATH = os.path.join(CONFIG_DIR, config_util.YAML_CONFIG_FILE)
|
|
VERSION_PATH = os.path.join(CONFIG_DIR, config_util.VERSION_FILE)
|
|
GROUP_PATH = os.path.join(CONFIG_DIR, GROUP_CONFIG_PATH)
|
|
ORIG_TIMEZONE = dt_util.DEFAULT_TIME_ZONE
|
|
|
|
|
|
def create_file(path):
|
|
"""Create an empty file."""
|
|
with open(path, 'w'):
|
|
pass
|
|
|
|
|
|
class TestConfig(unittest.TestCase):
|
|
"""Test the configutils."""
|
|
|
|
# pylint: disable=invalid-name
|
|
def setUp(self):
|
|
"""Initialize a test Home Assistant instance."""
|
|
self.hass = get_test_home_assistant()
|
|
|
|
# pylint: disable=invalid-name
|
|
def tearDown(self):
|
|
"""Clean up."""
|
|
dt_util.DEFAULT_TIME_ZONE = ORIG_TIMEZONE
|
|
|
|
if os.path.isfile(YAML_PATH):
|
|
os.remove(YAML_PATH)
|
|
|
|
if os.path.isfile(VERSION_PATH):
|
|
os.remove(VERSION_PATH)
|
|
|
|
if os.path.isfile(GROUP_PATH):
|
|
os.remove(GROUP_PATH)
|
|
|
|
self.hass.stop()
|
|
|
|
def test_create_default_config(self):
|
|
"""Test creation of default config."""
|
|
config_util.create_default_config(CONFIG_DIR, False)
|
|
|
|
assert os.path.isfile(YAML_PATH)
|
|
assert os.path.isfile(VERSION_PATH)
|
|
assert os.path.isfile(GROUP_PATH)
|
|
|
|
def test_find_config_file_yaml(self):
|
|
"""Test if it finds a YAML config file."""
|
|
create_file(YAML_PATH)
|
|
|
|
self.assertEqual(YAML_PATH, config_util.find_config_file(CONFIG_DIR))
|
|
|
|
@mock.patch('builtins.print')
|
|
def test_ensure_config_exists_creates_config(self, mock_print):
|
|
"""Test that calling ensure_config_exists.
|
|
|
|
If not creates a new config file.
|
|
"""
|
|
config_util.ensure_config_exists(CONFIG_DIR, False)
|
|
|
|
self.assertTrue(os.path.isfile(YAML_PATH))
|
|
self.assertTrue(mock_print.called)
|
|
|
|
def test_ensure_config_exists_uses_existing_config(self):
|
|
"""Test that calling ensure_config_exists uses existing config."""
|
|
create_file(YAML_PATH)
|
|
config_util.ensure_config_exists(CONFIG_DIR, False)
|
|
|
|
with open(YAML_PATH) as f:
|
|
content = f.read()
|
|
|
|
# File created with create_file are empty
|
|
self.assertEqual('', content)
|
|
|
|
def test_load_yaml_config_converts_empty_files_to_dict(self):
|
|
"""Test that loading an empty file returns an empty dict."""
|
|
create_file(YAML_PATH)
|
|
|
|
self.assertIsInstance(
|
|
config_util.load_yaml_config_file(YAML_PATH), dict)
|
|
|
|
def test_load_yaml_config_raises_error_if_not_dict(self):
|
|
"""Test error raised when YAML file is not a dict."""
|
|
with open(YAML_PATH, 'w') as f:
|
|
f.write('5')
|
|
|
|
with self.assertRaises(HomeAssistantError):
|
|
config_util.load_yaml_config_file(YAML_PATH)
|
|
|
|
def test_load_yaml_config_raises_error_if_malformed_yaml(self):
|
|
"""Test error raised if invalid YAML."""
|
|
with open(YAML_PATH, 'w') as f:
|
|
f.write(':')
|
|
|
|
with self.assertRaises(HomeAssistantError):
|
|
config_util.load_yaml_config_file(YAML_PATH)
|
|
|
|
def test_load_yaml_config_raises_error_if_unsafe_yaml(self):
|
|
"""Test error raised if unsafe YAML."""
|
|
with open(YAML_PATH, 'w') as f:
|
|
f.write('hello: !!python/object/apply:os.system')
|
|
|
|
with self.assertRaises(HomeAssistantError):
|
|
config_util.load_yaml_config_file(YAML_PATH)
|
|
|
|
def test_load_yaml_config_preserves_key_order(self):
|
|
"""Test removal of library."""
|
|
with open(YAML_PATH, 'w') as f:
|
|
f.write('hello: 0\n')
|
|
f.write('world: 1\n')
|
|
|
|
self.assertEqual(
|
|
[('hello', 0), ('world', 1)],
|
|
list(config_util.load_yaml_config_file(YAML_PATH).items()))
|
|
|
|
@mock.patch('homeassistant.util.location.detect_location_info',
|
|
return_value=location_util.LocationInfo(
|
|
'0.0.0.0', 'US', 'United States', 'CA', 'California',
|
|
'San Diego', '92122', 'America/Los_Angeles', 32.8594,
|
|
-117.2073, True))
|
|
@mock.patch('homeassistant.util.location.elevation', return_value=101)
|
|
@mock.patch('builtins.print')
|
|
def test_create_default_config_detect_location(self, mock_detect,
|
|
mock_elev, mock_print):
|
|
"""Test that detect location sets the correct config keys."""
|
|
config_util.ensure_config_exists(CONFIG_DIR)
|
|
|
|
config = config_util.load_yaml_config_file(YAML_PATH)
|
|
|
|
self.assertIn(DOMAIN, config)
|
|
|
|
ha_conf = config[DOMAIN]
|
|
|
|
expected_values = {
|
|
CONF_LATITUDE: 32.8594,
|
|
CONF_LONGITUDE: -117.2073,
|
|
CONF_ELEVATION: 101,
|
|
CONF_UNIT_SYSTEM: CONF_UNIT_SYSTEM_METRIC,
|
|
CONF_NAME: 'Home',
|
|
CONF_TIME_ZONE: 'America/Los_Angeles'
|
|
}
|
|
|
|
assert expected_values == ha_conf
|
|
assert mock_print.called
|
|
|
|
@mock.patch('builtins.print')
|
|
def test_create_default_config_returns_none_if_write_error(self,
|
|
mock_print):
|
|
"""Test the writing of a default configuration.
|
|
|
|
Non existing folder returns None.
|
|
"""
|
|
self.assertIsNone(
|
|
config_util.create_default_config(
|
|
os.path.join(CONFIG_DIR, 'non_existing_dir/'), False))
|
|
self.assertTrue(mock_print.called)
|
|
|
|
# pylint: disable=no-self-use
|
|
def test_core_config_schema(self):
|
|
"""Test core config schema."""
|
|
for value in (
|
|
{CONF_UNIT_SYSTEM: 'K'},
|
|
{'time_zone': 'non-exist'},
|
|
{'latitude': '91'},
|
|
{'longitude': -181},
|
|
{'customize': 'bla'},
|
|
{'customize': {'light.sensor': 100}},
|
|
{'customize': {'entity_id': []}},
|
|
):
|
|
with pytest.raises(MultipleInvalid):
|
|
config_util.CORE_CONFIG_SCHEMA(value)
|
|
|
|
config_util.CORE_CONFIG_SCHEMA({
|
|
'name': 'Test name',
|
|
'latitude': '-23.45',
|
|
'longitude': '123.45',
|
|
CONF_UNIT_SYSTEM: CONF_UNIT_SYSTEM_METRIC,
|
|
'customize': {
|
|
'sensor.temperature': {
|
|
'hidden': True,
|
|
},
|
|
},
|
|
})
|
|
|
|
def _compute_state(self, config):
|
|
run_coroutine_threadsafe(
|
|
config_util.async_process_ha_core_config(self.hass, config),
|
|
self.hass.loop).result()
|
|
|
|
entity = Entity()
|
|
entity.entity_id = 'test.test'
|
|
entity.hass = self.hass
|
|
entity.schedule_update_ha_state()
|
|
|
|
self.hass.block_till_done()
|
|
|
|
return self.hass.states.get('test.test')
|
|
|
|
def test_entity_customization_false(self):
|
|
"""Test entity customization through configuration."""
|
|
config = {CONF_LATITUDE: 50,
|
|
CONF_LONGITUDE: 50,
|
|
CONF_NAME: 'Test',
|
|
CONF_CUSTOMIZE: {
|
|
'test.test': {'hidden': False}}}
|
|
|
|
state = self._compute_state(config)
|
|
|
|
assert 'hidden' not in state.attributes
|
|
|
|
def test_entity_customization(self):
|
|
"""Test entity customization through configuration."""
|
|
config = {CONF_LATITUDE: 50,
|
|
CONF_LONGITUDE: 50,
|
|
CONF_NAME: 'Test',
|
|
CONF_CUSTOMIZE: {'test.test': {'hidden': True}}}
|
|
|
|
state = self._compute_state(config)
|
|
|
|
assert state.attributes['hidden']
|
|
|
|
@mock.patch('homeassistant.config.shutil')
|
|
@mock.patch('homeassistant.config.os')
|
|
def test_remove_lib_on_upgrade(self, mock_os, mock_shutil):
|
|
"""Test removal of library on upgrade."""
|
|
ha_version = '0.7.0'
|
|
|
|
mock_os.path.isdir = mock.Mock(return_value=True)
|
|
|
|
mock_open = mock.mock_open()
|
|
with mock.patch('homeassistant.config.open', mock_open, create=True):
|
|
opened_file = mock_open.return_value
|
|
# pylint: disable=no-member
|
|
opened_file.readline.return_value = ha_version
|
|
|
|
self.hass.config.path = mock.Mock()
|
|
|
|
config_util.process_ha_config_upgrade(self.hass)
|
|
|
|
hass_path = self.hass.config.path.return_value
|
|
|
|
self.assertEqual(mock_os.path.isdir.call_count, 1)
|
|
self.assertEqual(
|
|
mock_os.path.isdir.call_args, mock.call(hass_path)
|
|
)
|
|
|
|
self.assertEqual(mock_shutil.rmtree.call_count, 1)
|
|
self.assertEqual(
|
|
mock_shutil.rmtree.call_args, mock.call(hass_path)
|
|
)
|
|
|
|
@mock.patch('homeassistant.config.shutil')
|
|
@mock.patch('homeassistant.config.os')
|
|
def test_not_remove_lib_if_not_upgrade(self, mock_os, mock_shutil):
|
|
"""Test removal of library with no upgrade."""
|
|
ha_version = __version__
|
|
|
|
mock_os.path.isdir = mock.Mock(return_value=True)
|
|
|
|
mock_open = mock.mock_open()
|
|
with mock.patch('homeassistant.config.open', mock_open, create=True):
|
|
opened_file = mock_open.return_value
|
|
# pylint: disable=no-member
|
|
opened_file.readline.return_value = ha_version
|
|
|
|
self.hass.config.path = mock.Mock()
|
|
|
|
config_util.process_ha_config_upgrade(self.hass)
|
|
|
|
assert mock_os.path.isdir.call_count == 0
|
|
assert mock_shutil.rmtree.call_count == 0
|
|
|
|
def test_loading_configuration(self):
|
|
"""Test loading core config onto hass object."""
|
|
self.hass.config = mock.Mock()
|
|
|
|
run_coroutine_threadsafe(
|
|
config_util.async_process_ha_core_config(self.hass, {
|
|
'latitude': 60,
|
|
'longitude': 50,
|
|
'elevation': 25,
|
|
'name': 'Huis',
|
|
CONF_UNIT_SYSTEM: CONF_UNIT_SYSTEM_IMPERIAL,
|
|
'time_zone': 'America/New_York',
|
|
}), self.hass.loop).result()
|
|
|
|
assert self.hass.config.latitude == 60
|
|
assert self.hass.config.longitude == 50
|
|
assert self.hass.config.elevation == 25
|
|
assert self.hass.config.location_name == 'Huis'
|
|
assert self.hass.config.units.name == CONF_UNIT_SYSTEM_IMPERIAL
|
|
assert self.hass.config.time_zone.zone == 'America/New_York'
|
|
|
|
def test_loading_configuration_temperature_unit(self):
|
|
"""Test backward compatibility when loading core config."""
|
|
self.hass.config = mock.Mock()
|
|
|
|
run_coroutine_threadsafe(
|
|
config_util.async_process_ha_core_config(self.hass, {
|
|
'latitude': 60,
|
|
'longitude': 50,
|
|
'elevation': 25,
|
|
'name': 'Huis',
|
|
CONF_TEMPERATURE_UNIT: 'C',
|
|
'time_zone': 'America/New_York',
|
|
}), self.hass.loop).result()
|
|
|
|
assert self.hass.config.latitude == 60
|
|
assert self.hass.config.longitude == 50
|
|
assert self.hass.config.elevation == 25
|
|
assert self.hass.config.location_name == 'Huis'
|
|
assert self.hass.config.units.name == CONF_UNIT_SYSTEM_METRIC
|
|
assert self.hass.config.time_zone.zone == 'America/New_York'
|
|
|
|
@mock.patch('homeassistant.util.location.detect_location_info',
|
|
autospec=True, return_value=location_util.LocationInfo(
|
|
'0.0.0.0', 'US', 'United States', 'CA', 'California',
|
|
'San Diego', '92122', 'America/Los_Angeles', 32.8594,
|
|
-117.2073, True))
|
|
@mock.patch('homeassistant.util.location.elevation',
|
|
autospec=True, return_value=101)
|
|
def test_discovering_configuration(self, mock_detect, mock_elevation):
|
|
"""Test auto discovery for missing core configs."""
|
|
self.hass.config.latitude = None
|
|
self.hass.config.longitude = None
|
|
self.hass.config.elevation = None
|
|
self.hass.config.location_name = None
|
|
self.hass.config.time_zone = None
|
|
|
|
run_coroutine_threadsafe(
|
|
config_util.async_process_ha_core_config(
|
|
self.hass, {}), self.hass.loop
|
|
).result()
|
|
|
|
assert self.hass.config.latitude == 32.8594
|
|
assert self.hass.config.longitude == -117.2073
|
|
assert self.hass.config.elevation == 101
|
|
assert self.hass.config.location_name == 'San Diego'
|
|
assert self.hass.config.units.name == CONF_UNIT_SYSTEM_METRIC
|
|
assert self.hass.config.units.is_metric
|
|
assert self.hass.config.time_zone.zone == 'America/Los_Angeles'
|
|
|
|
@mock.patch('homeassistant.util.location.detect_location_info',
|
|
autospec=True, return_value=None)
|
|
@mock.patch('homeassistant.util.location.elevation', return_value=0)
|
|
def test_discovering_configuration_auto_detect_fails(self, mock_detect,
|
|
mock_elevation):
|
|
"""Test config remains unchanged if discovery fails."""
|
|
self.hass.config = Config()
|
|
|
|
run_coroutine_threadsafe(
|
|
config_util.async_process_ha_core_config(
|
|
self.hass, {}), self.hass.loop
|
|
).result()
|
|
|
|
blankConfig = Config()
|
|
assert self.hass.config.latitude == blankConfig.latitude
|
|
assert self.hass.config.longitude == blankConfig.longitude
|
|
assert self.hass.config.elevation == blankConfig.elevation
|
|
assert self.hass.config.location_name == blankConfig.location_name
|
|
assert self.hass.config.units == blankConfig.units
|
|
assert self.hass.config.time_zone == blankConfig.time_zone
|
|
|
|
@mock.patch('asyncio.create_subprocess_exec')
|
|
def test_check_ha_config_file_correct(self, mock_create):
|
|
"""Check that restart propagates to stop."""
|
|
process_mock = mock.MagicMock()
|
|
attrs = {
|
|
'communicate.return_value': mock_coro(('output', 'error')),
|
|
'wait.return_value': mock_coro(0)}
|
|
process_mock.configure_mock(**attrs)
|
|
mock_create.return_value = mock_coro(process_mock)
|
|
|
|
assert run_coroutine_threadsafe(
|
|
config_util.async_check_ha_config_file(self.hass), self.hass.loop
|
|
).result() is None
|
|
|
|
@mock.patch('asyncio.create_subprocess_exec')
|
|
def test_check_ha_config_file_wrong(self, mock_create):
|
|
"""Check that restart with a bad config doesn't propagate to stop."""
|
|
process_mock = mock.MagicMock()
|
|
attrs = {
|
|
'communicate.return_value':
|
|
mock_coro(('\033[34mhello'.encode('utf-8'), 'error')),
|
|
'wait.return_value': mock_coro(1)}
|
|
process_mock.configure_mock(**attrs)
|
|
mock_create.return_value = mock_coro(process_mock)
|
|
|
|
assert run_coroutine_threadsafe(
|
|
config_util.async_check_ha_config_file(self.hass),
|
|
self.hass.loop
|
|
).result() == 'hello'
|
|
|
|
|
|
# pylint: disable=redefined-outer-name
|
|
@pytest.fixture
|
|
def merge_log_err(hass):
|
|
"""Patch _merge_log_error from packages."""
|
|
with mock.patch('homeassistant.config._LOGGER.error') \
|
|
as logerr:
|
|
yield logerr
|
|
|
|
|
|
def test_merge(merge_log_err):
|
|
"""Test if we can merge packages."""
|
|
packages = {
|
|
'pack_dict': {'input_boolean': {'ib1': None}},
|
|
'pack_11': {'input_select': {'is1': None}},
|
|
'pack_list': {'light': {'platform': 'test'}},
|
|
'pack_list2': {'light': [{'platform': 'test'}]},
|
|
}
|
|
config = {
|
|
config_util.CONF_CORE: {config_util.CONF_PACKAGES: packages},
|
|
'input_boolean': {'ib2': None},
|
|
'light': {'platform': 'test'}
|
|
}
|
|
config_util.merge_packages_config(config, packages)
|
|
|
|
assert merge_log_err.call_count == 0
|
|
assert len(config) == 4
|
|
assert len(config['input_boolean']) == 2
|
|
assert len(config['input_select']) == 1
|
|
assert len(config['light']) == 3
|
|
|
|
|
|
def test_merge_new(merge_log_err):
|
|
"""Test adding new components to outer scope."""
|
|
packages = {
|
|
'pack_1': {'light': [{'platform': 'one'}]},
|
|
'pack_11': {'input_select': {'ib1': None}},
|
|
'pack_2': {
|
|
'light': {'platform': 'one'},
|
|
'panel_custom': {'pan1': None},
|
|
'api': {}},
|
|
}
|
|
config = {
|
|
config_util.CONF_CORE: {config_util.CONF_PACKAGES: packages},
|
|
}
|
|
config_util.merge_packages_config(config, packages)
|
|
|
|
assert merge_log_err.call_count == 0
|
|
assert 'api' in config
|
|
assert len(config) == 5
|
|
assert len(config['light']) == 2
|
|
assert len(config['panel_custom']) == 1
|
|
|
|
|
|
def test_merge_type_mismatch(merge_log_err):
|
|
"""Test if we have a type mismatch for packages."""
|
|
packages = {
|
|
'pack_1': {'input_boolean': [{'ib1': None}]},
|
|
'pack_11': {'input_select': {'ib1': None}},
|
|
'pack_2': {'light': {'ib1': None}}, # light gets merged - ensure_list
|
|
}
|
|
config = {
|
|
config_util.CONF_CORE: {config_util.CONF_PACKAGES: packages},
|
|
'input_boolean': {'ib2': None},
|
|
'input_select': [{'ib2': None}],
|
|
'light': [{'platform': 'two'}]
|
|
}
|
|
config_util.merge_packages_config(config, packages)
|
|
|
|
assert merge_log_err.call_count == 2
|
|
assert len(config) == 4
|
|
assert len(config['input_boolean']) == 1
|
|
assert len(config['light']) == 2
|
|
|
|
|
|
def test_merge_once_only(merge_log_err):
|
|
"""Test if we have a merge for a comp that may occur only once."""
|
|
packages = {
|
|
'pack_2': {
|
|
'mqtt': {},
|
|
'api': {}, # No config schema
|
|
},
|
|
}
|
|
config = {
|
|
config_util.CONF_CORE: {config_util.CONF_PACKAGES: packages},
|
|
'mqtt': {}, 'api': {}
|
|
}
|
|
config_util.merge_packages_config(config, packages)
|
|
assert merge_log_err.call_count == 2
|
|
assert len(config) == 3
|
|
|
|
|
|
def test_merge_id_schema(hass):
|
|
"""Test if we identify the config schemas correctly."""
|
|
types = {
|
|
'panel_custom': 'list',
|
|
'group': 'dict',
|
|
'script': 'dict',
|
|
'input_boolean': 'dict',
|
|
'shell_command': 'dict',
|
|
'qwikswitch': '',
|
|
}
|
|
for name, expected_type in types.items():
|
|
module = config_util.get_component(name)
|
|
typ, _ = config_util._identify_config_schema(module)
|
|
assert typ == expected_type, "{} expected {}, got {}".format(
|
|
name, expected_type, typ)
|
|
|
|
|
|
def test_merge_duplicate_keys(merge_log_err):
|
|
"""Test if keys in dicts are duplicates."""
|
|
packages = {
|
|
'pack_1': {'input_select': {'ib1': None}},
|
|
}
|
|
config = {
|
|
config_util.CONF_CORE: {config_util.CONF_PACKAGES: packages},
|
|
'input_select': {'ib1': None},
|
|
}
|
|
config_util.merge_packages_config(config, packages)
|
|
|
|
assert merge_log_err.call_count == 1
|
|
assert len(config) == 2
|
|
assert len(config['input_select']) == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
def test_merge_customize(hass):
|
|
"""Test loading core config onto hass object."""
|
|
core_config = {
|
|
'latitude': 60,
|
|
'longitude': 50,
|
|
'elevation': 25,
|
|
'name': 'Huis',
|
|
CONF_UNIT_SYSTEM: CONF_UNIT_SYSTEM_IMPERIAL,
|
|
'time_zone': 'GMT',
|
|
'customize': {'a.a': {'friendly_name': 'A'}},
|
|
'packages': {'pkg1': {'homeassistant': {'customize': {
|
|
'b.b': {'friendly_name': 'BB'}}}}},
|
|
}
|
|
yield from config_util.async_process_ha_core_config(hass, core_config)
|
|
|
|
assert hass.data[config_util.DATA_CUSTOMIZE].get('b.b') == \
|
|
{'friendly_name': 'BB'}
|