EOS/tests/test_elecpriceimport.py

import json
from pathlib import Path

import pytest

from akkudoktoreos.core.ems import get_ems
from akkudoktoreos.prediction.elecpriceimport import ElecPriceImport
from akkudoktoreos.utils.datetimeutil import compare_datetimes, to_datetime

DIR_TESTDATA = Path(__file__).absolute().parent.joinpath("testdata")

FILE_TESTDATA_ELECPRICEIMPORT_1_JSON = DIR_TESTDATA.joinpath("import_input_1.json")


@pytest.fixture
def provider(sample_import_1_json, config_eos):
    """Fixture to create a ElecPriceProvider instance."""
    settings = {
        "elecprice": {
            "provider": "ElecPriceImport",
            "provider_settings": {
                "import_file_path": str(FILE_TESTDATA_ELECPRICEIMPORT_1_JSON),
                "import_json": json.dumps(sample_import_1_json),
            },
        }
    }
    config_eos.merge_settings_from_dict(settings)
    provider = ElecPriceImport()
    assert provider.enabled()
    return provider


@pytest.fixture
def sample_import_1_json():
    """Fixture that returns sample forecast data report."""
    with FILE_TESTDATA_ELECPRICEIMPORT_1_JSON.open("r", encoding="utf-8", newline=None) as f_res:
        input_data = json.load(f_res)
    return input_data


# ------------------------------------------------
# General forecast
# ------------------------------------------------


def test_singleton_instance(provider):
    """Test that ElecPriceForecast behaves as a singleton."""
    another_instance = ElecPriceImport()
    assert provider is another_instance


def test_invalid_provider(provider, config_eos):
    """Test requesting an unsupported provider."""
    settings = {
        "elecprice": {
            "provider": "<invalid>",
            "provider_settings": {
                "import_file_path": str(FILE_TESTDATA_ELECPRICEIMPORT_1_JSON),
            },
        }
    }
    with pytest.raises(ValueError, match="not a valid electricity price provider"):
        config_eos.merge_settings_from_dict(settings)


# ------------------------------------------------
# Import
# ------------------------------------------------


@pytest.mark.parametrize(
    "start_datetime, from_file",
    [
        ("2024-11-10 00:00:00", True),  # No DST in Germany
        ("2024-08-10 00:00:00", True),  # DST in Germany
        ("2024-03-31 00:00:00", True),  # DST change in Germany (23 hours/ day)
        ("2024-10-27 00:00:00", True),  # DST change in Germany (25 hours/ day)
        ("2024-11-10 00:00:00", False),  # No DST in Germany
        ("2024-08-10 00:00:00", False),  # DST in Germany
        ("2024-03-31 00:00:00", False),  # DST change in Germany (23 hours/ day)
        ("2024-10-27 00:00:00", False),  # DST change in Germany (25 hours/ day)
    ],
)
def test_import(provider, sample_import_1_json, start_datetime, from_file, config_eos):
    """Test fetching forecast from Import."""
    ems_eos = get_ems()
    ems_eos.set_start_datetime(to_datetime(start_datetime, in_timezone="Europe/Berlin"))
    if from_file:
        config_eos.elecprice.provider_settings.import_json = None
        assert config_eos.elecprice.provider_settings.import_json is None
    else:
        config_eos.elecprice.provider_settings.import_file_path = None
        assert config_eos.elecprice.provider_settings.import_file_path is None
    provider.clear()

    # Call the method
    provider.update_data()

    # Assert: Verify the result is as expected
    assert provider.start_datetime is not None
    assert provider.total_hours is not None
    assert compare_datetimes(provider.start_datetime, ems_eos.start_datetime).equal
    values = sample_import_1_json["elecprice_marketprice_wh"]
    value_datetime_mapping = provider.import_datetimes(ems_eos.start_datetime, len(values))
    for i, mapping in enumerate(value_datetime_mapping):
        assert i < len(provider.records)
        expected_datetime, expected_value_index = mapping
        expected_value = values[expected_value_index]
        result_datetime = provider.records[i].date_time
        result_value = provider.records[i]["elecprice_marketprice_wh"]

        # print(f"{i}: Expected: {expected_datetime}:{expected_value}")
        # print(f"{i}:   Result: {result_datetime}:{result_value}")
        assert compare_datetimes(result_datetime, expected_datetime).equal
        assert result_value == expected_value