mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-10-09 07:56:40 +00:00
* feat: adapt configuration for multi optimization algorithms Decouple configuration from optimization algorithm parameters. Add to_[algorithm]_param() methods to the configuration that derive optimization algorithm specific parameters from the configuration. Add x-scope tags to the configuration options that describe for which specific algorithms the configuration option is for. The whole device settings are restructured. There are now general settings for the device classes with the afore mentioned to_[algorithm]_param() methods. The general device settings got their own directory `devices/settings`. By this the parameter class also does not have to be a pydantic model which can be used for future optimization/ simulations speed up. Also the parameter class for a device is now part of the device module. This better decouples and also is the natural place for parameters of a device. Besides this feature there are also fixes and improvements: * feat: extend home appliance time window settings and simulation Home appliance can now be configured for multiple runs with per-cycle allowed time windows. The number of remaining cycles to plan is determined at runtime by reading the ``cycles_completed_measurement_key`` from the measurement store. * feat: specialiced CycleTimeWindowSequence for time window sequences Sequence of time windows associated to cycles. This model specializes ``ValueTimeWindowSequence`` so that the ``value`` field of each ``ValueTimeWindow`` encodes the **cycle index** (0-based integer) the window belongs to. Typical use: an appliance that must run ``n`` times per day, each run constrained to a distinct time window. Assign ``value=0`` to windows for the first cycle, ``value=1`` for the second, and so on. Multiple windows may share the same cycle index (their allowed regions are unioned). Windows with ``value=None`` are silently ignored by all cycle-aware methods. * fix: Make test_configmigrate also regard the _ANY_SENTENIEL in key values * chore: Make devices configurations a map instead of a list This makes config paths stable regardless of declaration order and lets each device settings class build its own config path from ``self.device_id`` without needing an external index. Tests are adapted likewise. Devices configurations are automatically migrated from lists to maps. * chore: rename levelized_cost_of_storage_kwh to levelized_cost_of_storage_amt kwh This better fits in the naming scheme and also makes clear the costs are money. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * fix: runtime config update ignored by config file Runtime settings were handed back to pydantic-settings as init settings, which rank below the config file and the environment. Any key already present in EOS.config.json or in the environment silently discarded the update, so a bulk PUT /v1/config returned 200 without applying anything, while the granular PUT /v1/config/{path} endpoint kept working. Add a dedicated runtime settings source ranked directly below the command line arguments and record granular updates there as well, so both endpoints share one store that survives re-evaluation of the settings sources. Environment variables keep precedence over the config file for all keys that were not set at runtime. Also repairs revert_settings() and update(), which passed their data through the same init settings. Closes #1303 * fix: env vars ignored on first config build ConfigEOS.__init__ passed self as first positional argument to _setup, which forwards it to pydantic_settings.BaseSettings.__init__. Its first positional parameter is _case_sensitive, so the environment source matched the upper case variable names against the lower case field names and returned nothing. Environment settings only took effect after the next configuration setup. * docs: changelog for config priority fixes * fix(config): preserve device identities and storage costs during migration * fix(devices): preserve charge-rate typing and public import compatibility * ruff format fix * fix(config): satisfy typed device conversion and migration contracts * docs(config): refresh validated configuration prerequisite schemas --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: r0b2g1t <r0b2g1t@users.noreply.github.com>
757 lines
27 KiB
Python
757 lines
27 KiB
Python
import json
|
|
import tempfile
|
|
from pathlib import Path
|
|
from typing import Any, Optional, Union
|
|
from unittest.mock import patch
|
|
|
|
import numpy as np
|
|
import pytest
|
|
from loguru import logger
|
|
from pydantic import IPvAnyAddress, ValidationError
|
|
|
|
from akkudoktoreos.config.config import ConfigEOS, GeneralSettings
|
|
from akkudoktoreos.devices.settings.batterysettings import BATTERY_DEFAULT_CHARGE_RATES
|
|
|
|
|
|
def assert_values_equal(actual, expected):
|
|
"""Compare values, handling lists and numpy arrays."""
|
|
if isinstance(actual, (list, np.ndarray)) or isinstance(expected, (list, np.ndarray)):
|
|
# Convert both to numpy arrays for comparison
|
|
actual_arr = np.array(actual)
|
|
expected_arr = np.array(expected)
|
|
assert np.array_equal(actual_arr, expected_arr), f"Expected {expected_arr}, but got {actual_arr}"
|
|
else:
|
|
assert actual == expected, f"Expected {expected}, but got {actual}"
|
|
|
|
|
|
# overwrite config_mixin fixture from conftest
|
|
@pytest.fixture(autouse=True)
|
|
def config_mixin():
|
|
pass
|
|
|
|
|
|
def test_fixture_new_config_file(config_default_dirs):
|
|
"""Assure fixture stash_config_file is working."""
|
|
config_default_dir_user, config_default_dir_cwd, _, _ = config_default_dirs
|
|
|
|
config_file_user = config_default_dir_user.joinpath(ConfigEOS.CONFIG_FILE_NAME)
|
|
config_file_cwd = config_default_dir_cwd.joinpath(ConfigEOS.CONFIG_FILE_NAME)
|
|
|
|
assert not config_file_user.exists()
|
|
assert not config_file_cwd.exists()
|
|
|
|
|
|
def test_config_constants(config_eos):
|
|
"""Test config constants are the way expected by the tests."""
|
|
assert config_eos.APP_NAME == "net.akkudoktor.eos"
|
|
assert config_eos.APP_AUTHOR == "akkudoktor"
|
|
assert config_eos.EOS_DIR == "EOS_DIR"
|
|
assert config_eos.ENCODING == "UTF-8"
|
|
assert config_eos.CONFIG_FILE_NAME == "EOS.config.json"
|
|
|
|
|
|
def test_computed_paths(config_eos, monkeypatch):
|
|
"""Test computed paths for output and cache."""
|
|
|
|
# Ensure we do not have the environment patched by conftest.py
|
|
monkeypatch.delenv("EOS_GENERAL__DATA_FOLDER_PATH", raising=False)
|
|
monkeypatch.delenv("EOS_GENERAL__DATA_CACHE_SUBPATH", raising=False)
|
|
monkeypatch.delenv("EOS_GENERAL__DATA_OUTPUT_SUBPATH", raising=False)
|
|
|
|
# Don't actually try to create the data folder
|
|
with patch("pathlib.Path.mkdir"), \
|
|
patch("pathlib.Path.is_dir", return_value=True), \
|
|
patch("pathlib.Path.exists", return_value=True):
|
|
config_eos.merge_settings_from_dict(
|
|
{
|
|
"general": {
|
|
"data_folder_path": "/base/data",
|
|
"data_output_subpath": "extra/output",
|
|
},
|
|
"cache": {
|
|
"subpath": "somewhere/cache",
|
|
},
|
|
}
|
|
)
|
|
assert config_eos.general.data_folder_path == Path("/base/data")
|
|
assert config_eos.general.data_output_path == Path("/base/data/extra/output")
|
|
assert config_eos.cache.path() == Path("/base/data/somewhere/cache")
|
|
# Check non configurable pathes
|
|
assert config_eos.package_root_path == Path(__file__).parent.parent.resolve().joinpath(
|
|
"src/akkudoktoreos"
|
|
)
|
|
# reset settings so the config_eos fixture can verify the default paths
|
|
config_eos.reset_settings()
|
|
|
|
|
|
def test_config_from_env(monkeypatch, config_eos):
|
|
"""Test configuration from env."""
|
|
assert config_eos.server.port == 8503
|
|
assert config_eos.server.eosdash_port == 8504
|
|
|
|
monkeypatch.setenv("EOS_SERVER__PORT", "8553")
|
|
monkeypatch.setenv("EOS_SERVER__EOSDASH_PORT", "8555")
|
|
|
|
config_eos.reset_settings()
|
|
|
|
assert config_eos.server.port == 8553
|
|
assert config_eos.server.eosdash_port == 8555
|
|
|
|
|
|
def test_config_ipaddress(monkeypatch, config_eos):
|
|
"""Test configuration for IP adresses."""
|
|
assert config_eos.server.host == "127.0.0.1"
|
|
|
|
monkeypatch.setenv("EOS_SERVER__HOST", "0.0.0.0")
|
|
config_eos.reset_settings()
|
|
assert config_eos.server.host == "0.0.0.0"
|
|
|
|
monkeypatch.setenv("EOS_SERVER__HOST", "mail.akkudoktor.net")
|
|
config_eos.reset_settings()
|
|
assert config_eos.server.host == "mail.akkudoktor.net"
|
|
|
|
# keep last
|
|
monkeypatch.setenv("EOS_SERVER__HOST", "localhost")
|
|
config_eos.reset_settings()
|
|
assert config_eos.server.host == "localhost"
|
|
|
|
|
|
def test_singleton_behavior(config_eos, config_default_dirs, monkeypatch):
|
|
"""Test that ConfigEOS behaves as a singleton."""
|
|
config_eos.reset_instance()
|
|
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", str(config_default_dirs[0]))
|
|
|
|
instance1 = ConfigEOS()
|
|
instance2 = ConfigEOS()
|
|
|
|
assert instance1 is not config_eos
|
|
assert instance1 is instance2
|
|
assert instance1._config_file_path == instance2._config_file_path
|
|
|
|
|
|
def test_config_file_priority(config_default_dirs):
|
|
"""Test config file priority.
|
|
|
|
Priority is:
|
|
1. environment variable directory
|
|
2. user configuration directory
|
|
3. current working directory
|
|
"""
|
|
|
|
config_default_dir_user, config_default_dir_cwd, _, _ = config_default_dirs
|
|
config_file_cwd = Path(config_default_dir_cwd) / ConfigEOS.CONFIG_FILE_NAME
|
|
config_file_user = Path(config_default_dir_user) / ConfigEOS.CONFIG_FILE_NAME
|
|
|
|
assert not config_file_cwd.exists()
|
|
assert not config_file_user.exists()
|
|
|
|
# current working directory (prio 3)
|
|
config_file_cwd.write_text("{}")
|
|
|
|
config_eos = ConfigEOS()
|
|
config_eos.update()
|
|
assert config_eos.general.config_file_path == config_file_cwd
|
|
|
|
# user configuration directory (prio 2)
|
|
config_file_user.parent.mkdir()
|
|
config_file_user.write_text("{}")
|
|
|
|
config_eos.update()
|
|
assert config_eos.general.config_file_path == config_file_user
|
|
|
|
|
|
@patch("akkudoktoreos.config.config.user_config_dir")
|
|
def test_get_config_file_path(user_config_dir_patch, config_eos, config_default_dirs, monkeypatch):
|
|
"""Test that _get_config_file_path identifies the correct config file."""
|
|
config_default_dir_user, _, _, _ = config_default_dirs
|
|
user_config_dir_patch.return_value = str(config_default_dir_user)
|
|
|
|
def cfg_file(dir: Path) -> Path:
|
|
# Match production directory normalization, including macOS /var aliases.
|
|
return dir.resolve().joinpath(ConfigEOS.CONFIG_FILE_NAME)
|
|
|
|
# Config newly created from fixture with fresh user config directory
|
|
assert config_eos._get_config_file_path() == (cfg_file(config_default_dir_user), True)
|
|
cfg_file(config_default_dir_user).unlink()
|
|
|
|
with tempfile.TemporaryDirectory() as temp_dir:
|
|
temp_dir_path = Path(temp_dir)
|
|
monkeypatch.setenv("EOS_DIR", str(temp_dir_path))
|
|
monkeypatch.delenv("EOS_CONFIG_DIR", raising=False)
|
|
assert config_eos._get_config_file_path() == (cfg_file(temp_dir_path), False)
|
|
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", "config")
|
|
config_dir = temp_dir_path / "config"
|
|
config_dir.mkdir(exist_ok=True)
|
|
assert config_eos._get_config_file_path() == (
|
|
cfg_file(config_dir),
|
|
False,
|
|
)
|
|
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", str(temp_dir_path / "config2"))
|
|
config_dir = temp_dir_path / "config2"
|
|
config_dir.mkdir(exist_ok=True)
|
|
assert config_eos._get_config_file_path() == (
|
|
cfg_file(config_dir),
|
|
False,
|
|
)
|
|
|
|
monkeypatch.delenv("EOS_DIR")
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", "config3")
|
|
assert config_eos._get_config_file_path() == (cfg_file(config_default_dir_user), False)
|
|
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", str(temp_dir_path / "config3"))
|
|
config_dir = temp_dir_path / "config3"
|
|
config_dir.mkdir(exist_ok=True)
|
|
assert config_eos._get_config_file_path() == (
|
|
cfg_file(config_dir),
|
|
False,
|
|
)
|
|
|
|
|
|
def test_config_copy(config_eos, monkeypatch):
|
|
"""Test if the config is copied to the provided path."""
|
|
with tempfile.TemporaryDirectory() as temp_dir:
|
|
temp_folder_path = Path(temp_dir)
|
|
temp_config_file_path = temp_folder_path.joinpath(config_eos.CONFIG_FILE_NAME).resolve()
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", str(temp_folder_path))
|
|
assert not temp_config_file_path.exists()
|
|
with patch("akkudoktoreos.config.config.user_config_dir", return_value=temp_dir):
|
|
assert config_eos._get_config_file_path() == (temp_config_file_path, False)
|
|
config_eos.update()
|
|
assert temp_config_file_path.exists()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"latitude, longitude, expected_timezone",
|
|
[
|
|
(40.7128, -74.0060, "America/New_York"), # Valid latitude/longitude
|
|
(None, None, None), # No location
|
|
(51.5074, -0.1278, "Europe/London"), # Another valid location
|
|
],
|
|
)
|
|
def test_config_common_settings_valid(latitude, longitude, expected_timezone):
|
|
"""Test valid settings for GeneralSettings."""
|
|
general_settings = GeneralSettings(
|
|
latitude=latitude,
|
|
longitude=longitude,
|
|
)
|
|
assert general_settings.latitude == latitude
|
|
assert general_settings.longitude == longitude
|
|
assert general_settings.timezone == expected_timezone
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"field_name, invalid_value, expected_error",
|
|
[
|
|
("latitude", -91.0, "Input should be greater than or equal to -90"),
|
|
("latitude", 91.0, "Input should be less than or equal to 90"),
|
|
("longitude", -181.0, "Input should be greater than or equal to -180"),
|
|
("longitude", 181.0, "Input should be less than or equal to 180"),
|
|
],
|
|
)
|
|
def test_config_common_settings_invalid(field_name, invalid_value, expected_error):
|
|
"""Test invalid settings for PredictionCommonSettings."""
|
|
valid_data = {
|
|
"latitude": 40.7128,
|
|
"longitude": -74.0060,
|
|
}
|
|
assert GeneralSettings.model_validate(valid_data) is not None
|
|
valid_data[field_name] = invalid_value
|
|
|
|
with pytest.raises(ValidationError, match=expected_error):
|
|
GeneralSettings.model_validate(valid_data)
|
|
|
|
|
|
def test_config_common_settings_no_location():
|
|
"""Test that timezone is None when latitude and longitude are not provided."""
|
|
settings = GeneralSettings(latitude=None, longitude=None)
|
|
assert settings.timezone is None
|
|
|
|
|
|
def test_config_common_settings_with_location():
|
|
"""Test that timezone is correctly computed when latitude and longitude are provided."""
|
|
settings = GeneralSettings(latitude=34.0522, longitude=-118.2437)
|
|
assert settings.timezone == "America/Los_Angeles"
|
|
|
|
|
|
def test_config_common_settings_timezone_none_when_coordinates_missing():
|
|
"""Test that timezone is None when latitude or longitude is missing."""
|
|
config_no_latitude = GeneralSettings(latitude=None, longitude=-74.0060)
|
|
config_no_longitude = GeneralSettings(latitude=40.7128, longitude=None)
|
|
config_no_coords = GeneralSettings(latitude=None, longitude=None)
|
|
|
|
assert config_no_latitude.timezone is None
|
|
assert config_no_longitude.timezone is None
|
|
assert config_no_coords.timezone is None
|
|
|
|
|
|
# Test partial assignments and possible side effects
|
|
@pytest.mark.parametrize(
|
|
"path, value, expected, exception",
|
|
[
|
|
# Correct value assignment
|
|
(
|
|
"general/latitude",
|
|
42.0,
|
|
[("general.latitude", 42.0), ("general.longitude", 13.405)],
|
|
None,
|
|
),
|
|
# Correct value assignment (trailing /)
|
|
(
|
|
"general/latitude/",
|
|
41,
|
|
[("general.latitude", 41.0), ("general.longitude", 13.405)],
|
|
None,
|
|
),
|
|
# Correct value assignment (cast)
|
|
(
|
|
"general/latitude",
|
|
"43.0",
|
|
[("general.latitude", 43.0), ("general.longitude", 13.405)],
|
|
None,
|
|
),
|
|
# Invalid value assignment (constraint)
|
|
(
|
|
"general/latitude",
|
|
91.0,
|
|
[("general.latitude", 52.52), ("general.longitude", 13.405)],
|
|
ValueError,
|
|
),
|
|
# Invalid value assignment (type)
|
|
(
|
|
"general/latitude",
|
|
"test",
|
|
[("general.latitude", 52.52), ("general.longitude", 13.405)],
|
|
ValueError,
|
|
),
|
|
# Invalid path
|
|
(
|
|
"general/latitude/test",
|
|
"",
|
|
[("general.latitude", 52.52), ("general.longitude", 13.405)],
|
|
KeyError,
|
|
),
|
|
# Correct value nested assignment
|
|
(
|
|
"general",
|
|
{"latitude": 22},
|
|
[("general.latitude", 22.0), ("general.longitude", 13.405)],
|
|
None,
|
|
),
|
|
# Invalid value nested assignment
|
|
(
|
|
"general",
|
|
{"latitude": "test"},
|
|
[("general.latitude", 52.52), ("general.longitude", 13.405)],
|
|
ValueError,
|
|
),
|
|
# Correct value assignment - preparation for list
|
|
(
|
|
"devices/max_home_appliances",
|
|
1,
|
|
[("devices.max_home_appliances", 1), ],
|
|
None,
|
|
),
|
|
# Correct value to generate a windows list
|
|
(
|
|
"devices/home_appliances",
|
|
{
|
|
"dishwasher1": {
|
|
"device_id": "dishwasher1",
|
|
"consumption_wh": 2000,
|
|
"duration_h": 3,
|
|
"cycle_time_windows": {
|
|
"windows": [
|
|
{
|
|
"start_time": "08:00",
|
|
"duration": "5 hours",
|
|
"value": 0,
|
|
},
|
|
{
|
|
"start_time": "15:00",
|
|
"duration": "3 hours",
|
|
"value": 0,
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
[
|
|
("devices.home_appliances['dishwasher1'].device_id", "dishwasher1"),
|
|
("devices.home_appliances['dishwasher1'].consumption_wh", 2000),
|
|
("devices.home_appliances['dishwasher1'].duration_h", 3),
|
|
],
|
|
None,
|
|
),
|
|
# Invalid value for list
|
|
(
|
|
"devices/home_appliances/dishwasher1/cycle_time_windows/windows",
|
|
"invalid",
|
|
[
|
|
(
|
|
"devices.home_appliances['dishwasher1'].cycle_time_windows",
|
|
[
|
|
{
|
|
"start_time": "08:00",
|
|
"duration": "5 hours",
|
|
"value": 0,
|
|
},
|
|
{
|
|
"start_time": "15:00",
|
|
"duration": "3 hours",
|
|
"value": 0,
|
|
},
|
|
],
|
|
)
|
|
],
|
|
ValueError,
|
|
),
|
|
# Invalid index (out of bound)
|
|
(
|
|
"devices/home_appliances/dishwasher1/cycle_time_windows/windows/10",
|
|
{
|
|
"start_time": "17:00",
|
|
"duration": "1 hour",
|
|
"value": 0,
|
|
},
|
|
[
|
|
(
|
|
"devices.home_appliances['dishwasher1'].cycle_time_windows.windows[10]",
|
|
{
|
|
"start_time": "17:00",
|
|
"duration": "1 hour",
|
|
"value": 0,
|
|
},
|
|
)
|
|
],
|
|
TypeError,
|
|
),
|
|
# Invalid index (no number)
|
|
(
|
|
"devices/home_appliances/dishwasher1/cycle_time_windows/windows/test",
|
|
{
|
|
"start_time": "17:00",
|
|
"duration": "1 hour",
|
|
"value": 0,
|
|
},
|
|
[
|
|
(
|
|
"devices.home_appliances['dishwasher1'].cycle_time_windows.windows[0]",
|
|
{
|
|
"start_time": "08:00",
|
|
"duration": "5 hours",
|
|
"value": 0,
|
|
},
|
|
)
|
|
],
|
|
IndexError,
|
|
),
|
|
# Unset value (set None)
|
|
(
|
|
"devices/home_appliances/dishwasher1/cycle_time_windows/windows/0",
|
|
None,
|
|
[
|
|
(
|
|
"devices.home_appliances['dishwasher1'].cycle_time_windows.windows[0]",
|
|
{
|
|
"start_time": "08:00",
|
|
"duration": "5 hours",
|
|
"value": 0,
|
|
},
|
|
)
|
|
],
|
|
TypeError,
|
|
),
|
|
],
|
|
)
|
|
def test_set_nested_key(path, value, expected, exception, config_eos):
|
|
if not exception:
|
|
config_eos.set_nested_value(path, value)
|
|
for expected_path, expected_value in expected:
|
|
actual_value = eval(f"config_eos.{expected_path}")
|
|
assert_values_equal(actual_value, expected_value)
|
|
else:
|
|
try:
|
|
config_eos.set_nested_value(path, value)
|
|
for expected_path, expected_value in expected:
|
|
actual_value = eval(f"config_eos.{expected_path}")
|
|
assert_values_equal(actual_value, expected_value)
|
|
pytest.fail(
|
|
f"Expected exception {exception} but none was raised. Set '{expected_path}' to '{actual_value}'"
|
|
)
|
|
except Exception as e:
|
|
assert isinstance(e, exception), (
|
|
f"Expected exception {exception}, but got {type(e)}: {e}"
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"path, expected_value, exception",
|
|
[
|
|
("general/latitude", 52.52, None),
|
|
("general/latitude/", 52.52, None),
|
|
("general/latitude/test", None, KeyError),
|
|
],
|
|
)
|
|
def test_get_nested_key(path, expected_value, exception, config_eos):
|
|
if not exception:
|
|
assert config_eos.get_nested_value(path) == expected_value
|
|
else:
|
|
with pytest.raises(exception):
|
|
config_eos.get_nested_value(path)
|
|
|
|
|
|
def test_merge_settings_from_dict_invalid(config_eos):
|
|
"""Test merging invalid data."""
|
|
invalid_settings = {
|
|
"general": {
|
|
"latitude": "invalid_latitude" # Should be a float
|
|
},
|
|
}
|
|
|
|
with pytest.raises(Exception): # Pydantic ValidationError expected
|
|
config_eos.merge_settings_from_dict(invalid_settings)
|
|
|
|
|
|
def test_merge_settings_partial(config_eos):
|
|
"""Test merging only a subset of settings."""
|
|
|
|
partial_settings: dict[str, Any] = {
|
|
"general": {
|
|
"latitude": 51.1657 # Only latitude is updated
|
|
},
|
|
}
|
|
|
|
config_eos.merge_settings_from_dict(partial_settings)
|
|
assert config_eos.general.latitude == 51.1657
|
|
assert config_eos.general.longitude == 13.405 # Should remain unchanged
|
|
|
|
#-----------------
|
|
|
|
partial_settings = {
|
|
"weather": {
|
|
"provider": "BrightSky",
|
|
},
|
|
}
|
|
|
|
config_eos.merge_settings_from_dict(partial_settings)
|
|
assert config_eos.weather.provider == "BrightSky"
|
|
|
|
#-----------------
|
|
|
|
partial_settings = {
|
|
"general": {
|
|
"latitude": None,
|
|
},
|
|
"weather": {
|
|
"provider": "ClearOutside",
|
|
},
|
|
}
|
|
|
|
config_eos.merge_settings_from_dict(partial_settings)
|
|
assert config_eos.general.latitude is None
|
|
assert config_eos.weather.provider == "ClearOutside"
|
|
|
|
# Assure update keeps same values
|
|
config_eos.update()
|
|
assert config_eos.general.latitude is None
|
|
assert config_eos.weather.provider == "ClearOutside"
|
|
|
|
#-----------------
|
|
|
|
partial_settings = {
|
|
"devices": {
|
|
"max_electric_vehicles": 1,
|
|
"electric_vehicles": {
|
|
"ev1": {"charge_rates": [0.0, 0.375, 0.5, 0.625, 0.75, 0.875, 1.0],}
|
|
},
|
|
}
|
|
}
|
|
|
|
config_eos.merge_settings_from_dict(partial_settings)
|
|
assert config_eos.devices.max_electric_vehicles == 1
|
|
assert len(config_eos.devices.electric_vehicles) == 1
|
|
assert_values_equal(config_eos.devices.electric_vehicles["ev1"].charge_rates, [0.0, 0.375, 0.5, 0.625, 0.75, 0.875, 1.0])
|
|
|
|
# Assure re-apply generates the same config
|
|
config_eos.merge_settings_from_dict(partial_settings)
|
|
assert config_eos.devices.max_electric_vehicles == 1
|
|
assert len(config_eos.devices.electric_vehicles) == 1
|
|
assert_values_equal(config_eos.devices.electric_vehicles["ev1"].charge_rates, [0.0, 0.375, 0.5, 0.625, 0.75, 0.875, 1.0])
|
|
|
|
# Assure update keeps same values
|
|
config_eos.update()
|
|
assert config_eos.devices.max_electric_vehicles == 1
|
|
assert len(config_eos.devices.electric_vehicles) == 1
|
|
assert_values_equal(config_eos.devices.electric_vehicles["ev1"].charge_rates, [0.0, 0.375, 0.5, 0.625, 0.75, 0.875, 1.0])
|
|
|
|
|
|
def test_merge_settings_empty(config_eos):
|
|
"""Test merging an empty dictionary does not change settings."""
|
|
original_latitude = config_eos.general.latitude
|
|
|
|
config_eos.merge_settings_from_dict({}) # No changes
|
|
|
|
assert config_eos.general.latitude == original_latitude # Should remain unchanged
|
|
|
|
|
|
# ------------------------------------
|
|
# Runtime settings priority (issue #1303)
|
|
# ------------------------------------
|
|
|
|
|
|
@pytest.fixture
|
|
def config_eos_file(config_eos_factory) -> ConfigEOS:
|
|
"""ConfigEOS with the EOS configuration file as an active settings source."""
|
|
return config_eos_factory(
|
|
init={
|
|
"with_init_settings": True,
|
|
"with_env_settings": True,
|
|
"with_dotenv_settings": False,
|
|
"with_file_settings": True,
|
|
"with_file_secret_settings": False,
|
|
}
|
|
)
|
|
|
|
|
|
def write_config_file(config_eos: ConfigEOS, settings: dict[str, Any]) -> None:
|
|
"""Write settings to the EOS configuration file and load them."""
|
|
settings = {"general": {"version": config_eos.general.version}, **settings}
|
|
config_file_path = config_eos.general.config_file_path
|
|
assert config_file_path is not None
|
|
config_file_path.write_text(json.dumps(settings), encoding="utf-8")
|
|
config_eos.reset_settings()
|
|
|
|
|
|
def test_merge_settings_overrides_config_file(config_eos_file):
|
|
"""Runtime settings take precedence over the EOS configuration file."""
|
|
write_config_file(
|
|
config_eos_file,
|
|
{
|
|
"optimization": {"genetic": {"individuals": 200}},
|
|
"pvforecast": {
|
|
"planes": [
|
|
{"surface_tilt": 30.0, "surface_azimuth": azimuth, "peakpower": 5.0}
|
|
for azimuth in (0.0, 90.0, 180.0, 270.0)
|
|
]
|
|
},
|
|
},
|
|
)
|
|
assert config_eos_file.optimization.genetic.individuals == 200
|
|
assert len(config_eos_file.pvforecast.planes) == 4
|
|
|
|
config_eos_file.merge_settings_from_dict(
|
|
{
|
|
"optimization": {"genetic": {"individuals": 300}},
|
|
"pvforecast": {
|
|
"planes": [{"surface_tilt": 30.0, "surface_azimuth": 180.0, "peakpower": 5.0}]
|
|
},
|
|
}
|
|
)
|
|
|
|
assert config_eos_file.optimization.genetic.individuals == 300
|
|
assert len(config_eos_file.pvforecast.planes) == 1
|
|
|
|
|
|
def test_merge_settings_overrides_env(config_eos_file, monkeypatch):
|
|
"""Runtime settings take precedence over environment variables."""
|
|
monkeypatch.setenv("EOS_OPTIMIZATION__GENETIC__INDIVIDUALS", "150")
|
|
config_eos_file.reset_settings()
|
|
assert config_eos_file.optimization.genetic.individuals == 150
|
|
|
|
config_eos_file.merge_settings_from_dict({"optimization": {"genetic": {"individuals": 300}}})
|
|
|
|
assert config_eos_file.optimization.genetic.individuals == 300
|
|
|
|
|
|
def test_env_overrides_config_file_after_merge(config_eos_file, monkeypatch):
|
|
"""Environment variables keep precedence over the config file for untouched keys."""
|
|
write_config_file(config_eos_file, {"server": {"port": 9000}})
|
|
monkeypatch.setenv("EOS_SERVER__PORT", "9500")
|
|
config_eos_file.reset_settings()
|
|
assert config_eos_file.server.port == 9500
|
|
|
|
# A runtime update of an unrelated key must not freeze the env value
|
|
config_eos_file.merge_settings_from_dict({"general": {"latitude": 51.1657}})
|
|
assert config_eos_file.general.latitude == 51.1657
|
|
assert config_eos_file.server.port == 9500
|
|
|
|
monkeypatch.setenv("EOS_SERVER__PORT", "9600")
|
|
config_eos_file.reset_settings()
|
|
assert config_eos_file.server.port == 9600
|
|
|
|
|
|
def test_reset_settings_drops_runtime_settings(config_eos_file):
|
|
"""Reset drops runtime settings and falls back to the config file."""
|
|
write_config_file(config_eos_file, {"optimization": {"genetic": {"individuals": 200}}})
|
|
|
|
config_eos_file.merge_settings_from_dict({"optimization": {"genetic": {"individuals": 300}}})
|
|
assert config_eos_file.optimization.genetic.individuals == 300
|
|
|
|
config_eos_file.reset_settings()
|
|
assert config_eos_file.optimization.genetic.individuals == 200
|
|
|
|
|
|
def test_set_nested_value_survives_merge(config_eos_file):
|
|
"""Granular updates are not lost by a later bulk update."""
|
|
write_config_file(
|
|
config_eos_file,
|
|
{
|
|
"general": {"latitude": 48.0},
|
|
"optimization": {"genetic": {"individuals": 200}},
|
|
"pvforecast": {
|
|
"planes": [
|
|
{"surface_tilt": 30.0, "surface_azimuth": azimuth, "peakpower": 5.0}
|
|
for azimuth in (0.0, 90.0)
|
|
]
|
|
},
|
|
},
|
|
)
|
|
|
|
config_eos_file.set_nested_value("optimization/genetic/individuals", 400)
|
|
# A list index can not be expressed by the settings dictionary
|
|
config_eos_file.set_nested_value("pvforecast/planes/1/peakpower", 9.9)
|
|
# Clearing a value must not be reverted by the config file either
|
|
config_eos_file.set_nested_value("general/latitude", None)
|
|
|
|
config_eos_file.merge_settings_from_dict({"server": {"port": 8600}})
|
|
|
|
assert config_eos_file.server.port == 8600
|
|
assert config_eos_file.optimization.genetic.individuals == 400
|
|
assert config_eos_file.pvforecast.planes[1].peakpower == 9.9
|
|
assert config_eos_file.general.latitude is None
|
|
|
|
|
|
def test_revert_settings_restores_backup(config_eos_file):
|
|
"""Revert restores the backup values even if the config file differs."""
|
|
write_config_file(config_eos_file, {"optimization": {"genetic": {"individuals": 200}}})
|
|
|
|
config_file_path = config_eos_file.general.config_file_path
|
|
assert config_file_path is not None
|
|
backup_path = config_file_path.with_suffix(".backup")
|
|
backup_path.write_text(
|
|
json.dumps(
|
|
{
|
|
"general": {"version": config_eos_file.general.version},
|
|
"optimization": {"genetic": {"individuals": 500}},
|
|
}
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
config_eos_file.revert_settings("backup")
|
|
|
|
assert config_eos_file.optimization.genetic.individuals == 500
|
|
|
|
|
|
def test_config_from_env_on_first_init(config_eos, config_default_dirs, monkeypatch):
|
|
"""Environment variables are applied on the first configuration build."""
|
|
config_eos.reset_instance()
|
|
|
|
monkeypatch.setenv("EOS_CONFIG_DIR", str(config_default_dirs[0]))
|
|
monkeypatch.setenv("EOS_SERVER__PORT", "8553")
|
|
|
|
assert ConfigEOS().server.port == 8553
|