shepherd-core 2023.12.1__py3-none-any.whl → 2024.4.1__py3-none-any.whl

tests/data_models/test_base_models.py

@@ -1,205 +0,0 @@
-import os
-from pathlib import Path
-
-import numpy as np
-import pytest
-from pydantic import ValidationError
-
-from shepherd_core.data_models.base.cal_measurement import CalMeasurementCape
-from shepherd_core.data_models.base.calibration import CalibrationCape
-from shepherd_core.data_models.base.calibration import CalibrationEmulator
-from shepherd_core.data_models.base.calibration import CalibrationHarvester
-from shepherd_core.data_models.base.calibration import CalibrationPair
-from shepherd_core.data_models.base.calibration import CalibrationSeries
-from shepherd_core.data_models.base.calibration import CapeData
-from shepherd_core.data_models.base.content import ContentModel
-
-
-def test_base_model_cape_data() -> None:
-    CapeData(serial_number="xyz1")
-
-
-def test_base_model_cape_data_fail() -> None:
-    with pytest.raises(ValueError):
-        CapeData()
-
-
-def test_base_model_cal_pair_conv() -> None:
-    cal = CalibrationPair(gain=4.9)
-    val_raw = 500
-    val_si = cal.raw_to_si(val_raw)
-    val_rbw = cal.si_to_raw(val_si)
-    assert val_raw == val_rbw
-
-
-def test_base_model_cal_pair_conv2() -> None:
-    cal = CalibrationPair(gain=44)
-    rng = np.random.default_rng()
-    val_raw = rng.integers(low=0, high=2000, size=20)
-    val_si = cal.raw_to_si(val_raw)
-    val_rbw = cal.si_to_raw(val_si)
-    assert val_raw.size == val_rbw.size
-
-
-def test_base_model_cal_series_min() -> None:
-    CalibrationSeries()
-
-
-def test_base_model_cal_series_all() -> None:
-    cal = CalibrationCape()
-    _ = CalibrationSeries.from_cal(cal.harvester)
-    _ = CalibrationSeries.from_cal(cal.emulator)
-    _ = CalibrationSeries.from_cal(cal.emulator, emu_port_a=True)
-    _ = CalibrationSeries.from_cal(cal.emulator, emu_port_a=False)
-
-
-def test_base_model_cal_hrv_min() -> None:
-    cal = CalibrationHarvester()
-    cs = cal.export_for_sysfs()
-    assert len(cs) == 6
-
-
-def test_base_model_cal_emu_min() -> None:
-    cal = CalibrationEmulator()
-    cs = cal.export_for_sysfs()
-    assert len(cs) == 6
-
-
-def test_base_model_cal_cape_bytestr() -> None:
-    cal1 = CalibrationCape()
-    cb = cal1.to_bytestr()
-    cal2 = CalibrationCape.from_bytestr(cb)
-    assert cal1.get_hash() == cal2.get_hash()
-
-
-def test_base_model_cal_cape_bytestr_with_cape_data() -> None:
-    cal1 = CalibrationCape(cape=CapeData(serial_number="123"))
-    cb = cal1.to_bytestr()
-    cal2 = CalibrationCape.from_bytestr(cb, cal1.cape)
-    assert cal1.get_hash() == cal2.get_hash()
-
-
-def test_base_model_cal_cape_example(tmp_path: Path) -> None:
-    cal0 = CalMeasurementCape()
-    path1 = Path(__file__).resolve().with_name("example_cal_data.yaml")
-    cal1 = CalibrationCape.from_file(path1)
-    path2 = tmp_path / "cal_data_new.yaml"
-    cal1.to_file(path2)
-    cal2 = CalibrationCape.from_file(path2)
-    assert cal0.get_hash() != cal1.get_hash()
-    assert cal1.get_hash() == cal2.get_hash()
-
-
-def test_base_model_cal_hrv_fault() -> None:
-    path = Path(__file__).resolve().with_name("example_cal_data_faulty.yaml")
-    cal = CalibrationCape.from_file(path)
-    with pytest.raises(ValueError):
-        _ = cal.harvester.export_for_sysfs()
-
-
-def test_base_model_cal_emu_fault() -> None:
-    path = Path(__file__).resolve().with_name("example_cal_data_faulty.yaml")
-    cal = CalibrationCape.from_file(path)
-    with pytest.raises(ValueError):
-        _ = cal.emulator.export_for_sysfs()
-
-
-def test_base_model_cal_meas_min() -> None:
-    cm1 = CalMeasurementCape()
-    cal1 = cm1.to_cal()
-    cal2 = CalibrationCape()
-    assert cal1.get_hash() == cal2.get_hash()
-
-
-def test_base_model_cal_meas_example() -> None:
-    path1 = Path(__file__).resolve().with_name("example_cal_meas.yaml")
-    cm1 = CalMeasurementCape.from_file(path1)
-    cal1 = cm1.to_cal()
-    cal2 = CalibrationCape()
-    assert cal1.get_hash() != cal2.get_hash()
-
-
-def test_base_model_cal_meas_fault_correlation() -> None:
-    path = Path(__file__).resolve().with_name("example_cal_meas_faulty1.yaml")
-    with pytest.raises(ValueError):
-        _ = CalMeasurementCape.from_file(path)
-
-
-def test_base_model_cal_meas_fault_no_pairs() -> None:
-    path = Path(__file__).resolve().with_name("example_cal_meas_faulty2.yaml")
-    with pytest.raises(ValidationError):
-        _ = CalMeasurementCape.from_file(path)
-
-
-def test_base_model_content_str_repr() -> None:
-    content = ContentModel(name="tricky", owner="peter", group="work")
-    print(content)
-    assert str(content) == "tricky"
-
-
-def test_base_model_content_public_group() -> None:
-    _ = ContentModel(
-        name="tricky",
-        description="fake",
-        owner="peter",
-        group="work",
-        visible2group=True,
-    )
-    with pytest.raises(ValueError):
-        _ = ContentModel(name="tricky", owner="peter", group="work", visible2group=True)
-
-
-def test_base_model_content_public_all() -> None:
-    _ = ContentModel(
-        name="tricky", description="fake", owner="peter", group="work", visible2all=True
-    )
-    with pytest.raises(ValueError):
-        _ = ContentModel(name="tricky", owner="peter", group="work", visible2all=True)
-
-
-# ContentModel below is used as inheritor of ShpModel
-
-
-def test_base_model_shepherd_scheme(tmp_path: Path) -> None:
-    os.chdir(tmp_path)
-    ContentModel.schema_to_file(tmp_path / "schema.yaml")
-
-
-def test_base_model_shepherd_min(tmp_path: Path) -> None:
-    content = ContentModel(name="tricky", owner="peter", group="work")
-    content.to_file(tmp_path / "content1.yaml", minimal=True)
-    content.to_file(tmp_path / "content2.yaml", minimal=False)
-    # minimal should produce min-set (input dict), but does not work currently
-
-
-def test_base_model_shepherd_fault_load_other(tmp_path: Path) -> None:
-    path = tmp_path / "content.yaml"
-    content = ContentModel(name="tricky", owner="peter", group="work")
-    content.to_file(path)
-    with pytest.raises(ValueError):
-        CalibrationCape.from_file(path)
-
-
-def test_base_model_shepherd_fault_mutation() -> None:
-    content = ContentModel(name="tricky", owner="peter", group="work")
-    with pytest.raises(ValidationError):
-        content.name = "whatever"
-
-
-def test_base_model_shepherd_fault_short_str() -> None:
-    with pytest.raises(ValidationError):
-        _ = ContentModel(name="", owner="peter", group="work")
-
-
-def test_base_model_shepherd_fault_long_str() -> None:
-    with pytest.raises(ValidationError):
-        _ = ContentModel(
-            name="very_long_123456789_123456789_1234567890", owner="peter", group="work"
-        )
-
-
-def test_base_model_shepherd_fault_unsafe_str() -> None:
-    with pytest.raises(ValidationError):
-        _ = ContentModel(name="fs_trouble<>", owner="peter", group="work")
-    with pytest.raises(ValidationError):
-        _ = ContentModel(name="unicode", owner="peter", group="work", description="🐍")

tests/data_models/test_content_fixtures.py

@@ -1,41 +0,0 @@
-from shepherd_core.data_models.content.energy_environment import EnergyEnvironment
-from shepherd_core.data_models.content.firmware import Firmware
-from shepherd_core.data_models.content.virtual_harvester import HarvesterPRUConfig
-from shepherd_core.data_models.content.virtual_harvester import VirtualHarvesterConfig
-from shepherd_core.data_models.content.virtual_source import ConverterPRUConfig
-from shepherd_core.data_models.content.virtual_source import VirtualSourceConfig
-from shepherd_core.testbed_client.fixtures import Fixtures
-
-
-def test_testbed_fixture_energy_environment() -> None:
-    for fix in Fixtures()["EnergyEnvironment"]:
-        EnergyEnvironment(name=fix["name"])
-        EnergyEnvironment(id=fix["id"])
-
-
-def test_testbed_fixture_firmware() -> None:
-    for fix in Fixtures()["Firmware"]:
-        _id = fix["id"]
-        if _id in {1001, 1002}:
-            continue
-        Firmware(name=fix["name"])
-        Firmware(id=fix["id"])
-
-
-def test_experiment_fixture_vsrc() -> None:
-    for fix in Fixtures()["VirtualSourceConfig"]:
-        vsrc = VirtualSourceConfig(name=fix["name"])
-        VirtualSourceConfig(id=fix["id"])
-        ConverterPRUConfig.from_vsrc(vsrc, log_intermediate_node=False)
-        ConverterPRUConfig.from_vsrc(vsrc, log_intermediate_node=True)
-
-
-def test_experiment_fixture_vhrv() -> None:
-    for fix in Fixtures()["VirtualHarvesterConfig"]:
-        if fix["name"] == "neutral":
-            continue
-        vhrv = VirtualHarvesterConfig(name=fix["name"])
-        VirtualHarvesterConfig(id=fix["id"])
-        HarvesterPRUConfig.from_vhrv(vhrv, for_emu=False)
-        if int(fix["id"]) >= 1030:
-            HarvesterPRUConfig.from_vhrv(vhrv, for_emu=True)

tests/data_models/test_content_models.py

@@ -1,282 +0,0 @@
-from pathlib import Path
-
-import pytest
-from pydantic import ValidationError
-
-from shepherd_core import fw_tools
-from shepherd_core.data_models.content import EnergyDType
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.content import FirmwareDType
-from shepherd_core.data_models.content import VirtualHarvesterConfig
-from shepherd_core.data_models.content import VirtualSourceConfig
-from shepherd_core.data_models.content.virtual_source import ConverterPRUConfig
-from shepherd_core.data_models.testbed import MCU
-
-from .conftest import files_elf
-
-
-def test_content_model_ee_min1() -> None:
-    EnergyEnvironment(
-        id=9999,
-        name="some",
-        data_path="./file",
-        data_type="isc_voc",
-        duration=1,
-        energy_Ws=0.1,
-        owner="jane",
-        group="wayne",
-    )
-
-
-def test_content_model_ee_min2() -> None:
-    EnergyEnvironment(
-        id="98765",
-        name="some",
-        data_path="./file",
-        data_type=EnergyDType.ivcurve,
-        duration=999,
-        energy_Ws=3.1,
-        owner="jane",
-        group="wayne",
-    )
-
-
-def test_content_model_fw_faulty() -> None:
-    with pytest.raises(ValueError):
-        Firmware(
-            id=9999,
-            name="dome",
-            mcu=MCU(name="nRF52"),
-            data="xyz",
-            data_type=FirmwareDType.base64_hex,
-            owner="Obelix",
-            group="Gaul",
-        )
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_min(path_elf: Path, tmp_path: Path) -> None:
-    path_hex = (tmp_path / (path_elf.stem + ".hex")).resolve()
-    path_hex = fw_tools.elf_to_hex(path_elf, path_hex)
-    Firmware(
-        id=9999,
-        name="dome",
-        mcu=MCU(name="nRF52"),
-        data=fw_tools.file_to_base64(path_hex),
-        data_type=FirmwareDType.base64_hex,
-        owner="Obelix",
-        group="Gaul",
-    )
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_from_elf(path_elf: Path) -> None:
-    Firmware.from_firmware(
-        file=path_elf,
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_from_hex(path_elf: Path, tmp_path: Path) -> None:
-    path_hex = (tmp_path / (path_elf.stem + ".hex")).resolve()
-    path_hex = fw_tools.elf_to_hex(path_elf, path_hex)
-    Firmware.from_firmware(
-        file=path_hex,
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-
-
-def test_content_model_fw_from_hex_failing(tmp_path: Path) -> None:
-    path_hex = tmp_path / "some.hex"
-    with path_hex.open("w") as fd:
-        fd.write("something")
-    with pytest.raises(ValueError):
-        Firmware.from_firmware(
-            file=path_hex,
-            name="dome",
-            owner="Obelix",
-            group="Gaul",
-        )
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_extract_elf_to_dir(path_elf: Path, tmp_path: Path) -> None:
-    fw = Firmware.from_firmware(
-        file=path_elf,
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-    file = fw.extract_firmware(tmp_path)
-    assert file.exists()
-    assert file.is_file()
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_extract_hex_to_dir(path_elf: Path, tmp_path: Path) -> None:
-    path_hex = (tmp_path / (path_elf.stem + ".hex")).resolve()
-    path_hex = fw_tools.elf_to_hex(path_elf, path_hex)
-    fw = Firmware.from_firmware(
-        file=path_hex,
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-    file = fw.extract_firmware(tmp_path)
-    assert file.exists()
-    assert file.is_file()
-
-
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_extract_path_elf_to_dir(path_elf: Path, tmp_path: Path) -> None:
-    assert path_elf.exists()
-    fw = Firmware(
-        data=path_elf,
-        data_type=FirmwareDType.path_elf,
-        mcu={"name": "MSP430FR"},
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-    file = fw.extract_firmware(tmp_path)
-    assert file.exists()
-    assert file.is_file()
-
-
-@pytest.mark.elf
-@pytest.mark.converter
-@pytest.mark.parametrize("path_elf", files_elf)
-def test_content_model_fw_extract_path_hex_to_dir(path_elf: Path, tmp_path: Path) -> None:
-    path_hex = (tmp_path / (path_elf.stem + ".hex")).resolve()
-    path_hex = fw_tools.elf_to_hex(path_elf, path_hex)
-    assert path_hex.exists()
-    fw = Firmware(
-        data=path_hex,
-        data_type=FirmwareDType.path_hex,
-        mcu={"name": "MSP430FR"},
-        name="dome",
-        owner="Obelix",
-        group="Gaul",
-    )
-    file = fw.extract_firmware(tmp_path)
-    assert file.exists()
-    assert file.is_file()
-
-
-def test_content_model_hrv_min() -> None:
-    hrv = VirtualHarvesterConfig(
-        id=9999,
-        name="whatever",
-        owner="jane",
-        group="wayne",
-        algorithm="mppt_opt",
-    )
-    assert hrv.get_datatype() == "ivsample"
-
-
-def test_content_model_hrv_neutral() -> None:
-    with pytest.raises(ValueError):
-        _ = VirtualHarvesterConfig(name="neutral")
-
-
-@pytest.mark.parametrize("name", ["iv110", "cv24", "mppt_voc", "mppt_po"])
-def test_content_model_hrv_by_name(name: str) -> None:
-    _ = VirtualHarvesterConfig(name=name)
-
-
-@pytest.mark.parametrize("uid", [1013, 1020, 1032, 1044, 1045, 1046])
-def test_content_model_hrv_by_id(uid: int) -> None:
-    _ = VirtualHarvesterConfig(id=uid)
-
-
-def test_content_model_hrv_steps() -> None:
-    hrv = VirtualHarvesterConfig(
-        name="ivcurves", voltage_min_mV=1000, voltage_max_mV=4000, samples_n=11
-    )
-    assert hrv.voltage_step_mV == 300
-
-
-def test_content_model_hrv_faulty_voltage0() -> None:
-    with pytest.raises(ValidationError):
-        _ = VirtualHarvesterConfig(name="iv110", voltage_max_mV=5001)
-    with pytest.raises(ValidationError):
-        _ = VirtualHarvesterConfig(name="iv110", voltage_min_mV=-1)
-
-
-def test_content_model_hrv_faulty_voltage1() -> None:
-    with pytest.raises(ValueError):
-        _ = VirtualHarvesterConfig(name="iv110", voltage_min_mV=4001, voltage_max_mV=4000)
-
-
-def test_content_model_hrv_faulty_voltage2() -> None:
-    with pytest.raises(ValueError):
-        _ = VirtualHarvesterConfig(name="iv110", voltage_mV=4001, voltage_max_mV=4000)
-
-
-def test_content_model_hrv_faulty_voltage3() -> None:
-    with pytest.raises(ValueError):
-        _ = VirtualHarvesterConfig(name="iv110", voltage_mV=4000, voltage_min_mV=4001)
-
-
-@pytest.mark.parametrize("name", ["ivcurves", "iv1000", "isc_voc"])
-def test_content_model_hrv_faulty_emu(name: str) -> None:
-    hrv = VirtualHarvesterConfig(name=name)
-    with pytest.raises(ValueError):
-        _ = VirtualSourceConfig(name="dio_cap", harvester=hrv)
-
-
-def test_content_model_src_min() -> None:
-    VirtualSourceConfig(
-        id=9999,
-        name="new_src",
-        owner="jane",
-        group="wayne",
-    )
-
-
-def test_content_model_src_force_warning() -> None:
-    src = VirtualSourceConfig(
-        name="BQ25570",
-        C_output_uF=200,
-        C_intermediate_uF=100,
-    )
-    ConverterPRUConfig.from_vsrc(src)
-    # -> triggers warning currently
-
-
-def test_content_model_src_force_other_hysteresis1() -> None:
-    src = VirtualSourceConfig(
-        name="BQ25570",
-        V_intermediate_enable_threshold_mV=4000,
-        V_intermediate_disable_threshold_mV=3999,
-        V_output_mV=2000,
-        V_buck_drop_mV=100,
-    )
-    ConverterPRUConfig.from_vsrc(src)
-
-
-def test_content_model_src_force_other_hysteresis2() -> None:
-    src = VirtualSourceConfig(
-        name="BQ25570",
-        V_intermediate_enable_threshold_mV=1000,
-        V_intermediate_disable_threshold_mV=999,
-        V_output_mV=2000,
-        V_buck_drop_mV=100,
-    )
-    ConverterPRUConfig.from_vsrc(src)

tests/data_models/test_examples.py

@@ -1,48 +0,0 @@
-from pathlib import Path
-
-from shepherd_core.data_models.content import VirtualSourceConfig
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.task import EmulationTask
-from shepherd_core.data_models.task import HarvestTask
-from shepherd_core.data_models.testbed.testbed import Testbed as TasteBad
-
-from .conftest import load_yaml
-
-# ⤷ TasteBad avoids pytest-warning
-
-
-def test_example_emu() -> None:
-    data_dict = load_yaml("example_config_emulator.yaml")
-    assert data_dict["mode"] == "emulator"
-    emu = EmulationTask(**data_dict["parameters"])
-    print(emu)
-
-
-def test_example_hrv() -> None:
-    data_dict = load_yaml("example_config_harvester.yaml")
-    assert data_dict["mode"] == "harvester"
-    emu = HarvestTask(**data_dict["parameters"])
-    print(emu)
-
-
-def test_example_exp_recommended() -> None:
-    # new way
-    path = Path(__file__).with_name("example_config_experiment.yaml")
-    Experiment.from_file(path)
-
-
-def test_example_exp() -> None:
-    # non-optimal / old way
-    data_dict = load_yaml("example_config_experiment_alternative.yaml")
-    Experiment(**data_dict)
-
-
-def test_example_tb() -> None:
-    data_dict = load_yaml("example_config_testbed.yaml")
-    print(data_dict)
-    TasteBad(**data_dict)
-
-
-def test_example_vsrc() -> None:
-    data_dict = load_yaml("example_config_virtsource.yaml")
-    VirtualSourceConfig(**data_dict["VirtualSource"])