156 lines
4.4 KiB
Python
156 lines
4.4 KiB
Python
# SPDX-FileCopyrightText: 2025 Justin Myers
|
|
#
|
|
# SPDX-License-Identifier: MIT
|
|
import os
|
|
from unittest import mock
|
|
import pytest
|
|
from adafruit_blinka import load_settings_toml
|
|
|
|
try:
|
|
import tomllib
|
|
except ImportError:
|
|
import toml as tomllib
|
|
|
|
# pylint: disable=no-self-use,unused-argument
|
|
|
|
CONVERTED_TOML = {
|
|
"123": 123,
|
|
"test": "test",
|
|
"test-hyphen": "test-hyphen",
|
|
"test_bool": True,
|
|
"test_number": 123,
|
|
"test_space": "test space",
|
|
"test_underscore": "test_underscore",
|
|
"true": False,
|
|
}
|
|
|
|
|
|
INVALID_TOML = b"""
|
|
# strings
|
|
test=test
|
|
"""
|
|
|
|
|
|
VALID_TOML = b"""
|
|
# strings
|
|
test="test"
|
|
test_space="test space"
|
|
test_underscore="test_underscore"
|
|
test-hyphen="test-hyphen"
|
|
# number
|
|
test_number=123
|
|
# bool
|
|
test_bool=true
|
|
# other
|
|
123=123
|
|
true=false
|
|
"""
|
|
|
|
VALID_TOML_WITH_UNSUPPORTED_DATA_DICT = b"""
|
|
# dict
|
|
data = { key_1 = "value", key_2 = "value" }
|
|
"""
|
|
|
|
VALID_TOML_WITH_UNSUPPORTED_DATA_LIST = b"""
|
|
# list
|
|
numbers = [ 1, 2, 3 ]
|
|
"""
|
|
|
|
VALID_TOML_WITH_UNSUPPORTED_DATA_MANY = b"""
|
|
# dict
|
|
data = { key_1 = "value", key_2 = "value" }
|
|
|
|
# list
|
|
numbers = [ 1, 2, 3 ]
|
|
|
|
[nested]
|
|
test="test"
|
|
"""
|
|
|
|
VALID_TOML_WITH_UNSUPPORTED_DATA_NESTED = b"""
|
|
[nested]
|
|
test="test"
|
|
"""
|
|
|
|
|
|
class TestLoadSettingsToml:
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=False))
|
|
def test_raises_with_no_file(self):
|
|
with pytest.raises(
|
|
FileNotFoundError, match="settings.toml not cound in current directory."
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch("builtins.open", mock.mock_open(read_data=INVALID_TOML))
|
|
def test_raises_with_invalid_file(self):
|
|
with pytest.raises(
|
|
tomllib.TOMLDecodeError, match="Error with settings.toml file."
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch(
|
|
"builtins.open", mock.mock_open(read_data=VALID_TOML_WITH_UNSUPPORTED_DATA_DICT)
|
|
)
|
|
def test_raises_with_invalid_file_dict(self):
|
|
with pytest.raises(
|
|
ValueError, match="The types: 'dict' are not supported in settings.toml."
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch(
|
|
"builtins.open", mock.mock_open(read_data=VALID_TOML_WITH_UNSUPPORTED_DATA_LIST)
|
|
)
|
|
def test_raises_with_invalid_file_list(self):
|
|
with pytest.raises(
|
|
ValueError, match="The types: 'list' are not supported in settings.toml."
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch(
|
|
"builtins.open", mock.mock_open(read_data=VALID_TOML_WITH_UNSUPPORTED_DATA_MANY)
|
|
)
|
|
def test_raises_with_invalid_file_many(self):
|
|
with pytest.raises(
|
|
ValueError,
|
|
match="The types: 'dict, list' are not supported in settings.toml.",
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch(
|
|
"builtins.open",
|
|
mock.mock_open(read_data=VALID_TOML_WITH_UNSUPPORTED_DATA_NESTED),
|
|
)
|
|
def test_raises_with_invalid_file_nested(self):
|
|
with pytest.raises(
|
|
ValueError, match="The types: 'dict' are not supported in settings.toml."
|
|
):
|
|
load_settings_toml(return_toml=True)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch("builtins.open", mock.mock_open(read_data=VALID_TOML))
|
|
@mock.patch.dict(os.environ, {}, clear=True)
|
|
def test_returns_data(self):
|
|
for key in CONVERTED_TOML:
|
|
assert os.getenv(key) is None
|
|
|
|
assert load_settings_toml() is None
|
|
|
|
for key, value in CONVERTED_TOML.items():
|
|
assert os.getenv(key) == str(value)
|
|
|
|
@mock.patch("adafruit_blinka.os.path.isfile", mock.Mock(return_value=True))
|
|
@mock.patch("builtins.open", mock.mock_open(read_data=VALID_TOML))
|
|
@mock.patch.dict(os.environ, {}, clear=True)
|
|
def test_returns_data_when_asked(self):
|
|
for key in CONVERTED_TOML:
|
|
assert os.getenv(key) is None
|
|
|
|
assert load_settings_toml(return_toml=True) == CONVERTED_TOML
|
|
|
|
for key, value in CONVERTED_TOML.items():
|
|
assert os.getenv(key) == str(value)
|