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

tests/data_models/test_experiment_models.py

@@ -1,277 +0,0 @@
-from datetime import timedelta
-
-import pytest
-from pydantic import ValidationError
-
-from shepherd_core import local_now
-from shepherd_core.data_models import VirtualHarvesterConfig
-from shepherd_core.data_models import VirtualSourceConfig
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import GpioActuation
-from shepherd_core.data_models.experiment import GpioEvent
-from shepherd_core.data_models.experiment import GpioLevel
-from shepherd_core.data_models.experiment import GpioTracing
-from shepherd_core.data_models.experiment import PowerTracing
-from shepherd_core.data_models.experiment import SystemLogging
-from shepherd_core.data_models.experiment import TargetConfig
-from shepherd_core.data_models.testbed import GPIO
-from shepherd_core.data_models.testbed import Target
-
-from .conftest import load_yaml
-
-
-def test_experiment_model_exp_min() -> None:
-    Experiment(
-        name="mex per",
-        target_configs=[
-            TargetConfig(
-                target_IDs=[1],
-                energy_env=EnergyEnvironment(name="SolarSunny"),
-                firmware1=Firmware(name="nrf52_demo_rf"),
-            )
-        ],
-    )
-
-
-def test_experiment_model_exp_yaml_load() -> None:
-    exp1_data = load_yaml("example_config_experiment_alternative.yaml")
-    Experiment(**exp1_data)
-
-
-def test_experiment_model_exp_yaml_comparison() -> None:
-    exp1_data = load_yaml("example_config_experiment_alternative.yaml")
-    exp1 = Experiment(**exp1_data)
-
-    target_cfgs = TargetConfig(
-        target_IDs=list(range(1, 5)),
-        custom_IDs=list(range(4)),
-        energy_env={"name": "SolarSunny"},
-        virtual_source={"name": "diode+capacitor"},
-        firmware1={"name": "nrf52_demo_rf"},
-    )
-    exp2 = Experiment(
-        id=4567,
-        name="meaningful Test-Name",
-        created="2023-11-11 11:11:11",
-        time_start="2023-12-12 12:12:12",
-        target_configs=[target_cfgs],
-    )
-    assert exp1.get_hash() == exp2.get_hash()
-
-
-def test_experiment_model_exp_collision_target_id() -> None:
-    hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
-    target_cfgs = [
-        TargetConfig(
-            target_IDs=[1, 2, 3],  # <- collision
-            custom_IDs=[0, 1, 2, 3],
-            energy_env={"name": "SolarSunny"},
-            virtual_source={"name": "diode+capacitor"},
-            firmware1={"name": "nrf52_demo_rf"},
-        ),
-        TargetConfig(
-            target_IDs=list(range(1, 5)),  # <- collision
-            custom_IDs=list(range(7, 18)),  # note: longer list is OK
-            energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-            virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-            firmware2=Firmware(name="msp430_deep_sleep"),
-        ),
-    ]
-    with pytest.raises(ValueError):
-        _ = Experiment(
-            id="4567",
-            name="meaningful Test-Name",
-            time_start=local_now() + timedelta(minutes=30),
-            target_configs=target_cfgs,
-        )
-
-
-def test_experiment_model_exp_collision_custom_id() -> None:
-    hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
-    target_cfgs = [
-        TargetConfig(
-            target_IDs=[1, 2, 3],
-            custom_IDs=[0, 1, 7],  # <- collision
-            energy_env={"name": "SolarSunny"},
-            virtual_source={"name": "diode+capacitor"},
-            firmware1={"name": "nrf52_demo_rf"},
-        ),
-        TargetConfig(
-            target_IDs=list(range(1, 5)),
-            custom_IDs=list(range(7, 18)),  # <- collision
-            energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-            virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-            firmware2=Firmware(name="msp430_deep_sleep"),
-        ),
-    ]
-    with pytest.raises(ValueError):
-        _ = Experiment(
-            id="4567",
-            name="meaningful Test-Name",
-            time_start=local_now() + timedelta(minutes=30),
-            target_configs=target_cfgs,
-        )
-
-
-def test_experiment_model_exp_collision_observer() -> None:
-    hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
-    target_cfgs = [
-        TargetConfig(
-            target_IDs=[1, 1001],  # <- both on same observer
-            custom_IDs=list(range(7, 18)),
-            energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-            virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-            firmware2=Firmware(name="msp430_deep_sleep"),
-        ),
-    ]
-    with pytest.raises(ValueError):
-        _ = Experiment(
-            id="4567",
-            name="meaningful Test-Name",
-            time_start=local_now() + timedelta(minutes=30),
-            target_configs=target_cfgs,
-        )
-
-
-def test_experiment_model_exp_missing_target() -> None:
-    hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
-    with pytest.raises(ValidationError):
-        # should raise ValueError in Experiment
-        # buts gets already caught in target_config
-        _ = [
-            TargetConfig(
-                target_IDs=[1234567],  # <- not existent
-                custom_IDs=list(range(7, 18)),
-                energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-                virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-                firmware1=Firmware(name="nrf52_demo_rf"),
-                firmware2=Firmware(name="msp430_deep_sleep"),
-            ),
-        ]
-        # experiment (like above) removed
-
-
-def test_experiment_model_pwrtracing_min() -> None:
-    PowerTracing()
-
-
-def test_experiment_model_pwrtracing_fault_post() -> None:
-    with pytest.raises(ValueError):
-        PowerTracing(calculate_power=True)
-
-
-def test_experiment_model_pwrtracing_fault_discard_all() -> None:
-    with pytest.raises(ValueError):
-        PowerTracing(calculate_power=False, discard_current=True, discard_voltage=True)
-
-
-def test_experiment_model_gpiotracing_min() -> None:
-    GpioTracing()
-
-
-def test_experiment_model_gpiotracing_fault_mask() -> None:
-    with pytest.raises(ValueError):
-        GpioTracing(mask=0)
-
-
-def test_experiment_model_gpioevent_min() -> None:
-    gevt = GpioEvent(
-        delay=300,
-        gpio=GPIO(name="GPIO3"),
-        level=GpioLevel.high,
-    )
-    gevt.get_events()
-
-
-def test_experiment_model_gpioevent_fault_readonly() -> None:
-    with pytest.raises(ValueError):
-        GpioEvent(
-            delay=300,
-            gpio=GPIO(name="BAT_OK"),
-            level=GpioLevel.high,
-        )
-
-
-def test_experiment_model_gpioactuation_min() -> None:
-    gact = GpioActuation(
-        events=[
-            GpioEvent(
-                delay=300,
-                gpio=GPIO(name="GPIO2"),
-                level=GpioLevel.high,
-            )
-        ]
-    )
-    gact.get_gpios()
-
-
-def test_experiment_model_syslogging_min() -> None:
-    SystemLogging()
-
-
-def test_experiment_model_tgt_cfg_min1() -> None:
-    cfg = TargetConfig(
-        target_IDs=[1],
-        energy_env=EnergyEnvironment(name="SolarSunny"),
-        firmware1=Firmware(name="nrf52_demo_rf"),
-    )
-    for _id in cfg.target_IDs:
-        Target(id=_id)
-    assert cfg.get_custom_id(1) is None
-
-
-def test_experiment_model_tgt_cfg_min2() -> None:
-    cfg = TargetConfig(
-        target_IDs=[1, 2],
-        custom_IDs=[7, 9],
-        energy_env=EnergyEnvironment(name="SolarSunny"),
-        firmware1=Firmware(name="nrf52_demo_rf"),
-    )
-    for _id in cfg.target_IDs:
-        Target(id=_id)
-    assert cfg.get_custom_id(1) == 7
-    assert cfg.get_custom_id(2) == 9
-    assert cfg.get_custom_id(3) is None
-
-
-def test_experiment_model_tgt_cfg_fault_valid_ee() -> None:
-    with pytest.raises(ValueError):
-        _ = TargetConfig(
-            target_IDs=[1],
-            energy_env=EnergyEnvironment(name="nuclear"),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-        )
-
-
-def test_experiment_model_tgt_cfg_fault_firmware1() -> None:
-    with pytest.raises(ValueError):
-        _ = TargetConfig(
-            target_IDs=[1],  # is nRF
-            energy_env=EnergyEnvironment(name="SolarSunny"),
-            firmware1=Firmware(name="msp430_spi_fram"),
-        )
-
-
-def test_experiment_model_tgt_cfg_fault_firmware2() -> None:
-    with pytest.raises(ValueError):
-        _ = TargetConfig(
-            target_IDs=[1],  # is nRF
-            energy_env=EnergyEnvironment(name="SolarSunny"),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-            firmware2=Firmware(name="nrf52_demo_rf"),
-        )
-
-
-def test_experiment_model_tgt_cfg_fault_custom_ids() -> None:
-    with pytest.raises(ValueError):
-        _ = TargetConfig(
-            target_IDs=[1, 2, 3],
-            custom_IDs=[0, 1],  # not enough
-            energy_env=EnergyEnvironment(name="SolarSunny"),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-        )

tests/data_models/test_task_generation.py

@@ -1,52 +0,0 @@
-from datetime import timedelta
-from pathlib import Path
-
-from shepherd_core import local_now
-from shepherd_core.data_models import EnergyEnvironment
-from shepherd_core.data_models import Experiment
-from shepherd_core.data_models import Firmware
-from shepherd_core.data_models import TargetConfig
-from shepherd_core.data_models import VirtualHarvesterConfig
-from shepherd_core.data_models import VirtualSourceConfig
-from shepherd_core.data_models.task import TestbedTasks as TasteBadTasks
-
-
-def test_task_generation_file(tmp_path: Path) -> None:
-    path = Path(__file__).with_name("example_config_experiment.yaml")
-    xp1 = Experiment.from_file(path)
-    tb_tasks = TasteBadTasks.from_xp(xp1)
-    tb_tasks.to_file(tmp_path / "tbt1.yaml")
-
-
-def test_task_generation_script(tmp_path: Path) -> None:
-    hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
-
-    target_cfgs = [
-        # first init similar to yaml
-        TargetConfig(
-            target_IDs=list(range(1, 4)),
-            custom_IDs=list(range(3)),
-            energy_env={"name": "SolarSunny"},
-            virtual_source={"name": "diode+capacitor"},
-            firmware1={"name": "nrf52_demo_rf"},
-        ),
-        # second Instance fully object-oriented
-        TargetConfig(
-            target_IDs=list(range(6, 9)),
-            custom_IDs=list(range(7, 18)),
-            energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-            virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-            firmware1=Firmware(name="nrf52_demo_rf"),
-            firmware2=Firmware(name="msp430_deep_sleep"),
-        ),
-    ]
-
-    xperi = Experiment(
-        id="4567",
-        name="meaningful Test-Name",
-        time_start=local_now() + timedelta(minutes=30),
-        target_configs=target_cfgs,
-    )
-
-    tb_tasks = TasteBadTasks.from_xp(xperi)
-    tb_tasks.to_file(tmp_path / "tbt2.yaml")

tests/data_models/test_task_models.py

@@ -1,131 +0,0 @@
-from pathlib import Path
-from typing import Union
-
-import pytest
-
-from shepherd_core.data_models import Experiment
-from shepherd_core.data_models import FirmwareDType
-from shepherd_core.data_models import GpioActuation
-from shepherd_core.data_models import GpioEvent
-from shepherd_core.data_models.task import ObserverTasks
-from shepherd_core.data_models.task.emulation import EmulationTask
-from shepherd_core.data_models.task.firmware_mod import FirmwareModTask
-from shepherd_core.data_models.task.harvest import HarvestTask
-from shepherd_core.data_models.task.programming import ProgrammingTask
-from shepherd_core.data_models.testbed import GPIO
-from shepherd_core.data_models.testbed import ProgrammerProtocol
-from shepherd_core.data_models.testbed import Testbed as TasteBad
-
-
-def test_task_model_emu_min() -> None:
-    EmulationTask(
-        input_path="./here",
-    )
-
-
-def test_task_model_emu_fault_in_past() -> None:
-    with pytest.raises(ValueError):
-        EmulationTask(
-            input_path="./here",
-            time_start="1984-01-01 11:12:13",
-        )
-
-
-@pytest.mark.parametrize("value", [0, 1, 2, 3, 4, 4.5, "buffer", "main"])
-def test_task_model_emu_custom_aux(value: Union[float, str]) -> None:
-    EmulationTask(
-        input_path="./here",
-        voltage_aux=value,
-    )
-
-
-@pytest.mark.parametrize("value", [-1.0, 5, "max", "something"])
-def test_task_model_emu_fault_aux(value: Union[float, str]) -> None:
-    with pytest.raises(ValueError):
-        EmulationTask(
-            input_path="./here",
-            voltage_aux=value,
-        )
-
-
-def test_task_model_emu_fault_gpio_actuation() -> None:
-    with pytest.raises(ValueError):
-        EmulationTask(
-            input_path="./here",
-            gpio_actuation=GpioActuation(
-                events=[GpioEvent(delay=5, gpio=GPIO(name="GPIO5"))],
-            ),
-        )
-
-
-def test_task_model_fw_min() -> None:
-    FirmwareModTask(
-        data=Path("/"),
-        data_type=FirmwareDType.path_elf,
-        custom_id=42,
-        firmware_file=Path("fw_to_be.elf"),
-    )
-
-
-def test_task_model_fw_fault_hex() -> None:
-    # just a warning for now
-    FirmwareModTask(
-        data=Path("/"),
-        data_type=FirmwareDType.path_hex,
-        custom_id=42,
-        firmware_file=Path("fw_to_be.hex"),
-    )
-
-
-def test_task_model_hrv_min() -> None:
-    HarvestTask(
-        output_path="./here",
-    )
-
-
-def test_task_model_hrv_duration() -> None:
-    hrv = HarvestTask(
-        output_path="./here",
-        duration=42,
-    )
-    assert hrv.duration.total_seconds() == 42
-
-
-def test_task_model_hrv_too_late() -> None:
-    with pytest.raises(ValueError):
-        HarvestTask(
-            output_path="./here",
-            time_start="1984-01-01 11:12:13",
-        )
-
-
-def test_task_model_observer_min1() -> None:
-    ObserverTasks(
-        observer="peeping tom",
-        owner_id=666,
-        time_prep="2044-01-01 12:13:14",
-        root_path="/usr",
-        abort_on_error=False,
-    )
-
-
-def test_task_model_observer_min2() -> None:
-    path = Path(__file__).with_name("example_config_experiment.yaml")
-    xp = Experiment.from_file(path)
-    ObserverTasks.from_xp(xp=xp, tb=TasteBad(name="shepherd_tud_nes"), tgt_id=1)
-
-
-def test_task_model_prog_min() -> None:
-    ProgrammingTask(
-        firmware_file=Path("fw_to_load.hex"),
-        protocol=ProgrammerProtocol.SWD,
-        mcu_type="nrf52",
-    )
-
-
-def test_task_model_prog_fault_elf() -> None:
-    ProgrammingTask(
-        firmware_file=Path("fw_to_load.elf"),
-        protocol=ProgrammerProtocol.SWD,
-        mcu_type="nrf52",
-    )

tests/data_models/test_testbed_fixtures.py

@@ -1,47 +0,0 @@
-from shepherd_core.data_models.content.firmware import Firmware
-from shepherd_core.data_models.testbed.cape import Cape
-from shepherd_core.data_models.testbed.gpio import GPIO
-from shepherd_core.data_models.testbed.mcu import MCU
-from shepherd_core.data_models.testbed.observer import Observer
-from shepherd_core.data_models.testbed.target import Target
-from shepherd_core.data_models.testbed.testbed import Testbed as TasteBad
-from shepherd_core.testbed_client.fixtures import Fixtures
-
-# ⤷ TasteBad avoids pytest-warning
-
-
-def test_testbed_fixture_cape() -> None:
-    for fix in Fixtures()["Cape"]:
-        Cape(name=fix["name"])
-        Cape(id=fix["id"])
-
-
-def test_testbed_fixture_gpio() -> None:
-    for fix in Fixtures()["GPIO"]:
-        GPIO(name=fix["name"])
-        GPIO(id=fix["id"])
-
-
-def test_testbed_fixture_mcu() -> None:
-    for fix in Fixtures()["MCU"]:
-        MCU(name=fix["name"])
-        mcu = MCU(id=fix["id"])
-        Firmware(name=mcu.fw_name_default)
-
-
-def test_testbed_fixture_observer() -> None:
-    for fix in Fixtures()["Observer"]:
-        Observer(name=fix["name"])
-        Observer(id=fix["id"])
-
-
-def test_testbed_fixture_target() -> None:
-    for fix in Fixtures()["Target"]:
-        Target(name=fix["name"])
-        Target(id=fix["id"])
-
-
-def test_testbed_fixture_tb() -> None:
-    for fix in Fixtures()["Testbed"]:
-        TasteBad(name=fix["name"])
-        TasteBad(id=fix["id"])

tests/data_models/test_testbed_models.py

@@ -1,187 +0,0 @@
-import pytest
-
-from shepherd_core.data_models.testbed import GPIO
-from shepherd_core.data_models.testbed import MCU
-from shepherd_core.data_models.testbed import Cape
-from shepherd_core.data_models.testbed import Direction
-from shepherd_core.data_models.testbed import Observer
-from shepherd_core.data_models.testbed import ProgrammerProtocol
-from shepherd_core.data_models.testbed import Target
-from shepherd_core.data_models.testbed import Testbed as TasteBad
-
-# ⤷ TasteBad avoids pytest-warning
-
-
-def test_testbed_model_cape_min() -> None:
-    cape = Cape(
-        id=9999,
-        name="cappi",
-        version="1.0.0",
-        description="lorem",
-    )
-    print(cape)
-
-
-def test_testbed_model_gpio_min() -> None:
-    gpio = GPIO(
-        id=9999,
-        name="gippi",
-        reg_pru="ABCD",
-        pin_pru="EFGH",
-    )
-    print(gpio)
-
-
-def test_testbed_model_gpio_fault() -> None:
-    with pytest.raises(ValueError):
-        GPIO(
-            id=9999,
-            name="gippi",
-        )
-
-
-def test_testbed_model_gpio_var() -> None:
-    GPIO(
-        id=9999,
-        name="gippi",
-        direction=Direction.Bidirectional,
-        reg_pru="ABCD",
-        pin_pru="EFGH",
-    )
-
-
-def test_testbed_model_mcu_min() -> None:
-    mcu = MCU(
-        id=9922,
-        name="controller2",
-        description="lorem",
-        platform="arm32",
-        core="STM32F7",
-        prog_protocol=ProgrammerProtocol.SWD,
-        fw_name_default="nananana",
-    )
-    print(mcu)
-
-
-def test_testbed_model_observer_min() -> None:
-    obs = Observer(
-        id=9933,
-        name="sheep120",
-        description="not existing",
-        ip="127.0.0.1",
-        mac="FF:FF:FF:FF:FF:FF",
-        room="IIE72",
-        eth_port="375b2",
-        cape=Cape(name="cape53"),
-    )
-    print(obs)
-
-
-def test_testbed_model_observer_fault_cape_a() -> None:
-    with pytest.raises(ValueError):
-        Observer(
-            id=9933,
-            name="sheep120",
-            description="not existing",
-            ip="127.0.0.1",
-            mac="FF:FF:FF:FF:FF:FF",
-            room="IIE72",
-            eth_port="375b2",
-            target_a=Target(id=3),
-        )
-
-
-def test_testbed_model_observer_fault_cape_b() -> None:
-    with pytest.raises(ValueError):
-        Observer(
-            id=9933,
-            name="sheep120",
-            description="not existing",
-            ip="127.0.0.1",
-            mac="FF:FF:FF:FF:FF:FF",
-            room="IIE72",
-            eth_port="375b2",
-            target_b=Target(id=3),
-        )
-
-
-def test_testbed_model_observer_fault_target() -> None:
-    obs = Observer(
-        id=9933,
-        name="sheep120",
-        description="not existing",
-        ip="127.0.0.1",
-        mac="FF:FF:FF:FF:FF:FF",
-        room="IIE72",
-        eth_port="375b2",
-        cape=Cape(name="cape53"),
-        target_a=Target(id=3),
-        target_b=Target(id=2),
-    )
-    obs.get_target(2)
-    obs.get_target(3)
-    obs.get_target_port(2)
-    obs.get_target_port(3)
-    with pytest.raises(ValueError):
-        obs.get_target_port(123456)
-    with pytest.raises(ValueError):
-        obs.get_target(123456)
-
-
-def test_testbed_model_target_min1() -> None:
-    tgt = Target(
-        id=9944,
-        name="TerraTarget",
-        version="v1.00",
-        description="lorem",
-        mcu1=MCU(name="MSP430FR"),
-    )
-    print(tgt)
-
-
-def test_testbed_model_target_min2() -> None:
-    Target(
-        id=9944,
-        name="TerraTarget",
-        version="v1.00",
-        description="lorem",
-        mcu1="MSP430FR",
-        mcu2="MSP430FR",
-    )
-
-
-def test_testbed_model_tb_min() -> None:
-    tb = TasteBad(
-        name="shepherd",
-        id="9955",
-        description="lorem",
-        observers=[Observer(name="sheep02")],
-        data_on_server="/mnt/driveA",
-        data_on_observer="/mnt/driveB",
-    )
-    print(tb)
-
-
-def test_testbed_model_tb_fault_observer() -> None:
-    with pytest.raises(ValueError):
-        TasteBad(
-            name="shepherd",
-            id="9955",
-            description="lorem",
-            observers=[Observer(name="sheep02"), Observer(name="sheep02")],
-            data_on_server="/mnt/driveA",
-            data_on_observer="/mnt/driveB",
-        )
-
-
-def test_testbed_model_tb_fault_shared() -> None:
-    with pytest.raises(ValueError):
-        TasteBad(
-            name="shepherd",
-            id="9955",
-            description="lorem",
-            observers=[Observer(name="sheep02")],
-            data_on_server="/mnt/driveA",
-            data_on_observer="/mnt/driveB",
-            shared_storage=False,
-        )