from pathlib import Path
from typing import Optional
import pytest
from yawning_titan.config.core import ConfigGroup, ConfigGroupValidation
from yawning_titan.config.item_types.bool_item import BoolItem
from yawning_titan.config.item_types.float_item import FloatItem
from yawning_titan.config.item_types.int_item import IntItem
from yawning_titan.config.item_types.str_item import StrItem
from yawning_titan.exceptions import ConfigGroupValidationError
[docs]class Group(ConfigGroup):
"""Basic implementation of a :class: `~yawning_titan.config.core.ConfigGroup`."""
[docs] def __init__(self, doc: Optional[str] = None):
self.a: BoolItem = BoolItem(value=False, alias="legacy_a")
self.b: FloatItem = FloatItem(value=1, alias="legacy_b")
self.c: StrItem = StrItem(value="test", alias="legacy_c")
super().__init__(doc)
[docs]class GroupTier1(ConfigGroup):
"""Basic implementation of a nested :class: `~yawning_titan.config.core.ConfigGroup`."""
[docs] def __init__(self, doc: Optional[str] = None):
self.bool: BoolItem = BoolItem(value=False)
self.float: FloatItem = FloatItem(value=1)
super().__init__(doc)
[docs] def validate(self) -> ConfigGroupValidation:
"""Extend the parent validation with additional rules specific to this :class: `~yawning_titan.config.core.ConfigGroup`."""
super().validate()
try:
if self.bool.value and self.float.value > 1:
msg = "test error tier 1"
raise ConfigGroupValidationError(msg)
except ConfigGroupValidationError as e:
self.validation.add_validation(msg, e)
try:
if self.bool.value and self.float.value < 0:
msg = "test error tier 1 b"
raise ConfigGroupValidationError(msg)
except ConfigGroupValidationError as e:
self.validation.add_validation(msg, e)
return self.validation
[docs]class GroupTier2(ConfigGroup):
"""Basic implementation of a nested :class: `~yawning_titan.config.core.ConfigGroup`."""
[docs] def __init__(self, doc: Optional[str] = None):
self.bool: BoolItem = BoolItem(value=False)
self.int: IntItem = IntItem(value=1)
self.tier_1: GroupTier1 = GroupTier1()
super().__init__(doc)
[docs] def validate(self) -> ConfigGroupValidation:
"""Extend the parent validation with additional rules specific to this :class: `~yawning_titan.config.core.ConfigGroup`."""
super().validate()
try:
if self.bool.value and self.int.value != 1:
msg = "test error tier 2"
raise ConfigGroupValidationError(msg)
except ConfigGroupValidationError as e:
self.validation.add_validation(msg, e)
return self.validation
[docs]@pytest.fixture
def test_group():
"""A test instance of :class: `~yawning_titan.config.core.ConfigGroup`."""
return Group()
[docs]@pytest.fixture
def multi_tier_test_group():
"""A nested test instance of :class: `~yawning_titan.config.core.ConfigGroup`."""
return GroupTier2()
[docs]@pytest.mark.unit_test
def test_to_dict(test_group: Group):
"""Test the to_dict method produces a dictionary with the values as set."""
d1 = test_group.to_dict(values_only=True)
d2 = test_group.to_dict()
assert d1 == {"a": False, "b": 1, "c": "test"}
assert d2 == {
"a": {"value": False, "properties": {}},
"b": {"value": 1, "properties": {}},
"c": {"value": "test", "properties": {}},
}
[docs]@pytest.mark.unit_test
def test_set_config_item_to_value(test_group: Group):
"""Test the to_dict method produces a dictionary with the values as set."""
test_group.a = "test"
assert test_group.a.value == "test"
[docs]@pytest.mark.unit_test
def test_create_from_legacy(test_group: Group):
"""Test the group can be created using legacy config names."""
d1 = {"legacy_a": True, "legacy_b": 2, "legacy_c": "set"}
test_group.set_from_dict(config_dict=d1, legacy=True)
d2 = test_group.to_dict(values_only=True)
assert d2 == {"a": True, "b": 2, "c": "set"}
[docs]@pytest.mark.unit_test
def test_stringify(test_group: Group):
"""
Test the group can represent itself as a string.
The string should contain the groups class name,
the validation failure reasons and exceptions together with the names and values of each of its elements.
This should all be wrapped in parentheses.
"""
s = test_group.stringify()
assert (
s
== "Group(a=False, b=1, c=test, doc=None, validation=ConfigGroupValidation(passed=True, fail_reasons=[], fail_exceptions=[]))"
)
[docs]@pytest.mark.unit_test
def test_repeat_item_validation(test_group: Group):
"""Test validating a group then modifying its items and re-validating."""
test_group.a.value = "test"
test_group.validate()
test_group.a.value = 1
test_group.validate()
assert test_group.a.validation.fail_reasons == [
"Value 1 is of type <class 'int'>, should be <class 'bool'>."
]
[docs]@pytest.mark.unit_test
def test_repeat_group_validation(multi_tier_test_group: GroupTier2):
"""Test validating a group then modifying its sub-groups and re-validating."""
multi_tier_test_group.tier_1.bool.value = True
multi_tier_test_group.tier_1.float.value = 2
multi_tier_test_group.validate()
multi_tier_test_group.tier_1.bool.value = True
multi_tier_test_group.tier_1.float.value = -1
multi_tier_test_group.validate()
assert multi_tier_test_group.tier_1.validation.fail_reasons == [
"test error tier 1 b"
]
[docs]@pytest.mark.unit_test
def test_multi_tier_group_validation_passed(multi_tier_test_group: GroupTier2):
"""Test the element and group validation works for groups with multiple nested tiers."""
multi_tier_test_group.validate()
assert multi_tier_test_group.validation.passed
[docs]@pytest.mark.unit_test
def test_multi_tier_group_tier_1_validation_group_failed(
multi_tier_test_group: GroupTier2,
):
"""Test the element and group validation works for groups with multiple nested tiers."""
multi_tier_test_group.tier_1.bool.value = True
multi_tier_test_group.tier_1.float.value = 2
multi_tier_test_group.validate()
assert not multi_tier_test_group.validation.passed
assert multi_tier_test_group.validation.group_passed
assert not multi_tier_test_group.validation.elements_passed
[docs]@pytest.mark.unit_test
def test_multi_tier_group_tier_2_validation_group_failed(
multi_tier_test_group: GroupTier2,
):
"""Test the element and group validation works for groups with multiple nested tiers."""
multi_tier_test_group.bool.value = True
multi_tier_test_group.int.value = 2
multi_tier_test_group.validate()
assert not multi_tier_test_group.validation.passed
assert not multi_tier_test_group.validation.group_passed
assert multi_tier_test_group.validation.elements_passed
[docs]@pytest.mark.unit_test
def test_multi_tier_group_tier_2_item_failed(multi_tier_test_group: GroupTier2):
"""Test the element and group validation works for groups with multiple nested tiers."""
multi_tier_test_group.bool.value = "test"
multi_tier_test_group.validate()
assert not multi_tier_test_group.validation.passed
assert multi_tier_test_group.validation.group_passed
assert not multi_tier_test_group.validation.elements_passed
[docs]@pytest.mark.unit_test
def test_multi_tier_group_tier_1_item_failed(multi_tier_test_group: GroupTier2):
"""Test the element and group validation works for groups with multiple nested tiers."""
multi_tier_test_group.tier_1.bool.value = "test"
multi_tier_test_group.validate()
assert not multi_tier_test_group.validation.passed
assert multi_tier_test_group.validation.group_passed
assert not multi_tier_test_group.validation.elements_passed
[docs]@pytest.mark.unit_test
def test_yaml_round_trip(test_group: Group, tmp_path: Path):
"""Test that the items can be stored in a yaml file and subsequently reloaded."""
d1 = test_group.to_dict()
test_group.to_yaml(tmp_path / "yaml_out.yaml")
test_group.set_from_yaml(tmp_path / "yaml_out.yaml")
d2 = test_group.to_dict()
assert d1 == d2