Improve yaml fault tolerance and handle check_config border cases (#3159)
This commit is contained in:
1 parent
267cda447e
commit
e8ad76c816
5 files changed
+90
-59
No files matched your search
+61
-50
@@ -3,59 +3,68 @@ import io
|
||||
import unittest
|
||||
import os
|
||||
import tempfile
|
||||
from unittest.mock import patch
|
||||
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.util import yaml
|
||||
import homeassistant.config as config_util
|
||||
from tests.common import get_test_config_dir
|
||||
from homeassistant.config import YAML_CONFIG_FILE, load_yaml_config_file
|
||||
from tests.common import get_test_config_dir, patch_yaml_files
|
||||
|
||||
|
||||
class TestYaml(unittest.TestCase):
|
||||
"""Test util.yaml loader."""
|
||||
# pylint: disable=no-self-use,invalid-name
|
||||
|
||||
def test_simple_list(self):
|
||||
"""Test simple list."""
|
||||
conf = "config:\n - simple\n - list"
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc['config'] == ["simple", "list"]
|
||||
|
||||
def test_simple_dict(self):
|
||||
"""Test simple dict."""
|
||||
conf = "key: value"
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc['key'] == 'value'
|
||||
|
||||
def test_duplicate_key(self):
|
||||
"""Test simple dict."""
|
||||
conf = "key: thing1\nkey: thing2"
|
||||
try:
|
||||
with io.StringIO(conf) as f:
|
||||
yaml.yaml.safe_load(f)
|
||||
except Exception:
|
||||
pass
|
||||
else:
|
||||
assert 0
|
||||
"""Test duplicate dict keys."""
|
||||
files = {YAML_CONFIG_FILE: 'key: thing1\nkey: thing2'}
|
||||
with self.assertRaises(HomeAssistantError):
|
||||
with patch_yaml_files(files):
|
||||
load_yaml_config_file(YAML_CONFIG_FILE)
|
||||
|
||||
def test_unhashable_key(self):
|
||||
"""Test an unhasable key."""
|
||||
files = {YAML_CONFIG_FILE: 'message:\n {{ states.state }}'}
|
||||
with self.assertRaises(HomeAssistantError), \
|
||||
patch_yaml_files(files):
|
||||
load_yaml_config_file(YAML_CONFIG_FILE)
|
||||
|
||||
def test_no_key(self):
|
||||
"""Test item without an key."""
|
||||
files = {YAML_CONFIG_FILE: 'a: a\nnokeyhere'}
|
||||
with self.assertRaises(HomeAssistantError), \
|
||||
patch_yaml_files(files):
|
||||
yaml.load_yaml(YAML_CONFIG_FILE)
|
||||
|
||||
def test_enviroment_variable(self):
|
||||
"""Test config file with enviroment variable."""
|
||||
os.environ["PASSWORD"] = "secret_password"
|
||||
conf = "password: !env_var PASSWORD"
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc['password'] == "secret_password"
|
||||
del os.environ["PASSWORD"]
|
||||
|
||||
def test_invalid_enviroment_variable(self):
|
||||
"""Test config file with no enviroment variable sat."""
|
||||
conf = "password: !env_var PASSWORD"
|
||||
try:
|
||||
with io.StringIO(conf) as f:
|
||||
yaml.yaml.safe_load(f)
|
||||
except Exception:
|
||||
pass
|
||||
else:
|
||||
assert 0
|
||||
with self.assertRaises(HomeAssistantError):
|
||||
with io.StringIO(conf) as file:
|
||||
yaml.yaml.safe_load(file)
|
||||
|
||||
def test_include_yaml(self):
|
||||
"""Test include yaml."""
|
||||
@@ -63,8 +72,8 @@ class TestYaml(unittest.TestCase):
|
||||
include_file.write(b"value")
|
||||
include_file.seek(0)
|
||||
conf = "key: !include {}".format(include_file.name)
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc["key"] == "value"
|
||||
|
||||
def test_include_dir_list(self):
|
||||
@@ -79,8 +88,8 @@ class TestYaml(unittest.TestCase):
|
||||
file_2.write(b"two")
|
||||
file_2.close()
|
||||
conf = "key: !include_dir_list {}".format(include_dir)
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert sorted(doc["key"]) == sorted(["one", "two"])
|
||||
|
||||
def test_include_dir_named(self):
|
||||
@@ -98,8 +107,8 @@ class TestYaml(unittest.TestCase):
|
||||
correct = {}
|
||||
correct[os.path.splitext(os.path.basename(file_1.name))[0]] = "one"
|
||||
correct[os.path.splitext(os.path.basename(file_2.name))[0]] = "two"
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc["key"] == correct
|
||||
|
||||
def test_include_dir_merge_list(self):
|
||||
@@ -114,8 +123,8 @@ class TestYaml(unittest.TestCase):
|
||||
file_2.write(b"- two\n- three")
|
||||
file_2.close()
|
||||
conf = "key: !include_dir_merge_list {}".format(include_dir)
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert sorted(doc["key"]) == sorted(["one", "two", "three"])
|
||||
|
||||
def test_include_dir_merge_named(self):
|
||||
@@ -130,23 +139,25 @@ class TestYaml(unittest.TestCase):
|
||||
file_2.write(b"key2: two\nkey3: three")
|
||||
file_2.close()
|
||||
conf = "key: !include_dir_merge_named {}".format(include_dir)
|
||||
with io.StringIO(conf) as f:
|
||||
doc = yaml.yaml.safe_load(f)
|
||||
with io.StringIO(conf) as file:
|
||||
doc = yaml.yaml.safe_load(file)
|
||||
assert doc["key"] == {
|
||||
"key1": "one",
|
||||
"key2": "two",
|
||||
"key3": "three"
|
||||
}
|
||||
|
||||
FILES = {}
|
||||
|
||||
|
||||
def load_yaml(fname, string):
|
||||
"""Write a string to file and return the parsed yaml."""
|
||||
with open(fname, 'w') as file:
|
||||
file.write(string)
|
||||
return config_util.load_yaml_config_file(fname)
|
||||
FILES[fname] = string
|
||||
with patch_yaml_files(FILES):
|
||||
return load_yaml_config_file(fname)
|
||||
|
||||
|
||||
class FakeKeyring():
|
||||
class FakeKeyring(): # pylint: disable=too-few-public-methods
|
||||
"""Fake a keyring class."""
|
||||
|
||||
def __init__(self, secrets_dict):
|
||||
@@ -162,20 +173,16 @@ class FakeKeyring():
|
||||
|
||||
class TestSecrets(unittest.TestCase):
|
||||
"""Test the secrets parameter in the yaml utility."""
|
||||
# pylint: disable=protected-access,invalid-name
|
||||
|
||||
def setUp(self): # pylint: disable=invalid-name
|
||||
"""Create & load secrets file."""
|
||||
config_dir = get_test_config_dir()
|
||||
yaml.clear_secret_cache()
|
||||
self._yaml_path = os.path.join(config_dir,
|
||||
config_util.YAML_CONFIG_FILE)
|
||||
self._yaml_path = os.path.join(config_dir, YAML_CONFIG_FILE)
|
||||
self._secret_path = os.path.join(config_dir, yaml._SECRET_YAML)
|
||||
self._sub_folder_path = os.path.join(config_dir, 'subFolder')
|
||||
if not os.path.exists(self._sub_folder_path):
|
||||
os.makedirs(self._sub_folder_path)
|
||||
self._unrelated_path = os.path.join(config_dir, 'unrelated')
|
||||
if not os.path.exists(self._unrelated_path):
|
||||
os.makedirs(self._unrelated_path)
|
||||
|
||||
load_yaml(self._secret_path,
|
||||
'http_pw: pwhttp\n'
|
||||
@@ -194,12 +201,7 @@ class TestSecrets(unittest.TestCase):
|
||||
def tearDown(self): # pylint: disable=invalid-name
|
||||
"""Clean up secrets."""
|
||||
yaml.clear_secret_cache()
|
||||
for path in [self._yaml_path, self._secret_path,
|
||||
os.path.join(self._sub_folder_path, 'sub.yaml'),
|
||||
os.path.join(self._sub_folder_path, yaml._SECRET_YAML),
|
||||
os.path.join(self._unrelated_path, yaml._SECRET_YAML)]:
|
||||
if os.path.isfile(path):
|
||||
os.remove(path)
|
||||
FILES.clear()
|
||||
|
||||
def test_secrets_from_yaml(self):
|
||||
"""Did secrets load ok."""
|
||||
@@ -263,3 +265,12 @@ class TestSecrets(unittest.TestCase):
|
||||
"""Ensure logger: debug was removed."""
|
||||
with self.assertRaises(yaml.HomeAssistantError):
|
||||
load_yaml(self._yaml_path, 'api_password: !secret logger')
|
||||
|
||||
@patch('homeassistant.util.yaml._LOGGER.error')
|
||||
def test_bad_logger_value(self, mock_error):
|
||||
"""Ensure logger: debug was removed."""
|
||||
yaml.clear_secret_cache()
|
||||
load_yaml(self._secret_path, 'logger: info\npw: abc')
|
||||
load_yaml(self._yaml_path, 'api_password: !secret pw')
|
||||
assert mock_error.call_count == 1, \
|
||||
"Expected an error about logger: value"
|
||||
Reference in new issue
Block a user