File size: 14,290 Bytes
96bb363 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | """Tests for the Coordinator: multi-rate stepping order, dc_buffer accumulation."""
from __future__ import annotations
import warnings
from collections.abc import Callable
from fractions import Fraction
import numpy as np
from openg2g.clock import SimulationClock
from openg2g.common import ThreePhase
from openg2g.controller.base import Controller
from openg2g.coordinator import Coordinator, _gcd_fraction
from openg2g.datacenter.base import DatacenterBackend, DatacenterState
from openg2g.datacenter.command import DatacenterCommand, SetBatchSize
from openg2g.events import EventEmitter
from openg2g.grid.base import BusVoltages, GridBackend, GridState, PhaseVoltages
from openg2g.grid.command import GridCommand
from openg2g.grid.opendss import OpenDSSGrid
def test_gcd_fraction():
assert _gcd_fraction(Fraction(1, 10), Fraction(1)) == Fraction(1, 10)
assert _gcd_fraction(Fraction(1, 2), Fraction(3, 2)) == Fraction(1, 2)
assert _gcd_fraction(Fraction(60), Fraction(1)) == Fraction(1)
class _StubDC(DatacenterBackend[DatacenterState]):
"""Minimal datacenter for coordinator tests."""
def __init__(self, dt_s: Fraction = Fraction(1, 10)) -> None:
super().__init__()
self._dt_s = dt_s
self.step_count = 0
self.apply_control_calls: list[DatacenterCommand] = []
@property
def dt_s(self) -> Fraction:
return self._dt_s
def reset(self) -> None:
self.step_count = 0
self.apply_control_calls = []
def step(self, clock: SimulationClock, events: EventEmitter) -> DatacenterState:
self.step_count += 1
return DatacenterState(
time_s=clock.time_s,
power_w=ThreePhase(a=100.0, b=100.0, c=100.0),
)
def apply_control(self, command: DatacenterCommand, events: EventEmitter) -> None:
self.apply_control_calls.append(command)
class _StubGrid(GridBackend[GridState]):
"""Minimal grid for coordinator tests."""
def __init__(self, dt_s: Fraction = Fraction(1)) -> None:
super().__init__()
self._dt_s = dt_s
self.step_count = 0
self.step_calls: list[tuple[SimulationClock, list[ThreePhase]]] = []
@property
def dt_s(self) -> Fraction:
return self._dt_s
def reset(self) -> None:
self.step_count = 0
self.step_calls = []
def step(
self,
clock: SimulationClock,
power_samples_w: list[ThreePhase],
events: EventEmitter,
) -> GridState:
self.step_count += 1
self.step_calls.append((clock, list(power_samples_w)))
return GridState(
time_s=clock.time_s,
voltages=BusVoltages({"671": PhaseVoltages(a=1.0, b=1.0, c=1.0)}),
)
@property
def v_index(self) -> list[tuple[str, int]]:
return [("671", 0), ("671", 1), ("671", 2)]
def voltages_vector(self) -> np.ndarray:
return np.array([1.0, 1.0, 1.0])
def estimate_sensitivity(self, perturbation_kw: float = 100.0) -> tuple[np.ndarray, np.ndarray]:
return np.zeros((3, 3)), np.ones(3)
def apply_control(self, command: GridCommand, events: EventEmitter) -> None:
pass
class _StubController(Controller[DatacenterBackend, GridBackend]):
"""Test controller that delegates to a callback or returns a fixed action."""
def __init__(
self,
dt_s: Fraction = Fraction(1),
commands: list[DatacenterCommand | GridCommand] | None = None,
on_step: Callable[
[SimulationClock, DatacenterBackend, GridBackend, EventEmitter],
list[DatacenterCommand | GridCommand],
]
| None = None,
):
self._dt_s = dt_s
self._commands = commands if commands is not None else []
self._on_step = on_step
self.call_count = 0
def reset(self) -> None:
self.call_count = 0
@property
def dt_s(self) -> Fraction:
return self._dt_s
def step(
self,
clock: SimulationClock,
datacenter: DatacenterBackend,
grid: GridBackend,
events: EventEmitter,
) -> list[DatacenterCommand | GridCommand]:
self.call_count += 1
if self._on_step is not None:
return self._on_step(clock, datacenter, grid, events)
return self._commands
def test_coordinator_dc_fires_every_tick():
"""DC (dt=1/10) should fire 10x per grid step (dt=1)."""
dc = _StubDC(dt_s=Fraction(1, 10))
grid = _StubGrid(dt_s=Fraction(1))
ctrl = _StubController(dt_s=Fraction(1))
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
coord.run()
# DC fires 10 times in 1 second (steps 0-9)
assert dc.step_count == 10
# Grid fires once at step 0
assert grid.step_count == 1
def test_coordinator_dc_buffer_flush():
"""Grid receives full DC buffer at each grid step."""
dc = _StubDC(dt_s=Fraction(1, 10))
grid = _StubGrid(dt_s=Fraction(1, 2))
ctrl = _StubController(dt_s=Fraction(1, 2))
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
coord.run()
# Grid fires at step 0 and step 5 (twice in 1 second with dt=1/2)
assert grid.step_count == 2
# First grid call (step 0): 1 DC sample accumulated
# Second grid call (step 5): 5 DC samples (steps 1-5)
sizes = [len(call[1]) for call in grid.step_calls]
assert sizes == [1, 5]
def test_coordinator_controller_order():
"""Controllers execute in order, after DC and grid."""
call_order: list[str] = []
class _OrderDC(_StubDC):
def step(self, clock: SimulationClock, events: EventEmitter) -> DatacenterState:
call_order.append("dc")
return super().step(clock, events)
class _OrderGrid(_StubGrid):
def step(
self,
clock: SimulationClock,
power_samples_w: list[ThreePhase],
events: EventEmitter,
) -> GridState:
call_order.append("grid")
return super().step(clock, power_samples_w, events)
dc = _OrderDC(dt_s=Fraction(1))
grid = _OrderGrid(dt_s=Fraction(1))
ctrl1 = _StubController(
dt_s=Fraction(1),
on_step=lambda clock, dc, g, ev: (
call_order.append("ctrl1"),
[],
)[-1],
)
ctrl2 = _StubController(
dt_s=Fraction(1),
on_step=lambda clock, dc, g, ev: (
call_order.append("ctrl2"),
[],
)[-1],
)
coord = Coordinator(dc, grid, [ctrl1, ctrl2], total_duration_s=1, dc_bus="671")
coord.run()
# First tick order should be: dc, grid, ctrl1, ctrl2
assert call_order[0] == "dc"
assert call_order[1] == "grid"
assert call_order[2] == "ctrl1"
assert call_order[3] == "ctrl2"
def test_coordinator_batch_action_applied():
"""Batch size changes from controllers are applied to datacenter."""
dc = _StubDC(dt_s=Fraction(1))
grid = _StubGrid(dt_s=Fraction(1))
batch_cmd = SetBatchSize(batch_size_by_model={"model_a": 64})
ctrl = _StubController(dt_s=Fraction(1), commands=[batch_cmd])
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
coord.run()
assert dc.apply_control_calls == [batch_cmd]
def test_coordinator_exposes_clock_stamped_controller_events():
dc = _StubDC(dt_s=Fraction(1))
grid = _StubGrid(dt_s=Fraction(1))
def _on_step(
clock: SimulationClock,
datacenter: DatacenterBackend,
grid: GridBackend,
events: EventEmitter,
) -> list[DatacenterCommand | GridCommand]:
events.emit("controller.test", {"value": 1})
return []
ctrl = _StubController(dt_s=Fraction(1), on_step=_on_step)
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
log = coord.run()
assert len(log.events) == 1
ev = log.events[0]
assert ev.source == "controller"
assert ev.topic == "controller.test"
assert ev.tick == 0
assert abs(ev.t_s - 0.0) < 1e-12
def test_datacenter_events_are_recorded():
class _EventedDC(DatacenterBackend[DatacenterState]):
def __init__(self) -> None:
super().__init__()
self._dt_s = Fraction(1)
@property
def dt_s(self) -> Fraction:
return self._dt_s
def reset(self) -> None:
pass
def step(self, clock: SimulationClock, events: EventEmitter) -> DatacenterState:
return DatacenterState(time_s=clock.time_s, power_w=ThreePhase(a=1.0, b=1.0, c=1.0))
def apply_control(self, command: DatacenterCommand, events: EventEmitter) -> None:
events.emit(
"datacenter.batch_size.updated",
{"batch_size_by_model": {"model_a": 64}},
)
dc = _EventedDC()
grid = _StubGrid(dt_s=Fraction(1))
ctrl = _StubController(
dt_s=Fraction(1),
commands=[SetBatchSize(batch_size_by_model={"model_a": 64})],
)
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
log = coord.run()
batch_events = [e for e in log.events if e.topic == "datacenter.batch_size.updated"]
assert len(batch_events) == 1
assert batch_events[0].data["batch_size_by_model"]["model_a"] == 64
def test_controller_generic_types_auto_extracted():
class _TypedController(Controller[DatacenterBackend, OpenDSSGrid]):
@property
def dt_s(self) -> Fraction:
return Fraction(1)
def reset(self) -> None:
pass
def step(
self,
clock: SimulationClock,
datacenter: DatacenterBackend,
grid: OpenDSSGrid,
events: EventEmitter,
) -> list[DatacenterCommand | GridCommand]:
return []
assert _TypedController.compatible_datacenter_types() == (DatacenterBackend,)
assert _TypedController.compatible_grid_types() == (OpenDSSGrid,)
def test_controller_datacenter_mismatch_error_has_underlined_generic_snippet():
class _ExpectedDC(DatacenterBackend[DatacenterState]):
def __init__(self) -> None:
super().__init__()
@property
def dt_s(self) -> Fraction:
return Fraction(1)
def reset(self) -> None:
pass
def step(self, clock: SimulationClock, events: EventEmitter) -> DatacenterState:
return DatacenterState(time_s=clock.time_s, power_w=ThreePhase(a=1.0, b=1.0, c=1.0))
def apply_control(self, command: DatacenterCommand, events: EventEmitter) -> None:
pass
class _OtherDC(DatacenterBackend[DatacenterState]):
def __init__(self) -> None:
super().__init__()
@property
def dt_s(self) -> Fraction:
return Fraction(1)
def reset(self) -> None:
pass
def step(self, clock: SimulationClock, events: EventEmitter) -> DatacenterState:
return DatacenterState(time_s=clock.time_s, power_w=ThreePhase(a=1.0, b=1.0, c=1.0))
def apply_control(self, command: DatacenterCommand, events: EventEmitter) -> None:
pass
class _NeedsExpectedDC(Controller[_ExpectedDC, OpenDSSGrid]):
@property
def dt_s(self) -> Fraction:
return Fraction(1)
def reset(self) -> None:
pass
def step(
self,
clock: SimulationClock,
datacenter: _ExpectedDC,
grid: OpenDSSGrid,
events: EventEmitter,
) -> list[DatacenterCommand | GridCommand]:
return []
dc = _OtherDC()
grid = _StubGrid(dt_s=Fraction(1))
ctrl = _NeedsExpectedDC()
coord = Coordinator(dc, grid, [ctrl], total_duration_s=1, dc_bus="671")
try:
coord.run()
raise AssertionError("Expected TypeError for controller/datacenter incompatibility.")
except TypeError as exc:
msg = str(exc)
assert "_NeedsExpectedDC" in msg
assert "_ExpectedDC" in msg
assert "_OtherDC" in msg
def test_coordinator_grid_uses_stale_power_when_dc_buffer_empty():
"""When dt_grid < dt_dc, grid gets the most recent DC power as fallback."""
dc = _StubDC(dt_s=Fraction(1))
grid = _StubGrid(dt_s=Fraction(1, 2))
with warnings.catch_warnings():
warnings.simplefilter("ignore")
coord = Coordinator(dc, grid, [], total_duration_s=1, dc_bus="671")
log = coord.run()
# Grid fires at tick 0 (dc_buffer has 1 sample) and tick 5 (dc_buffer empty,
# grid reuses its internally cached previous power).
assert grid.step_count == 2
# Both grid steps should produce log entries
assert len(log.grid_states) == 2
def test_coordinator_warns_dt_grid_lt_dt_dc():
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
Coordinator(
_StubDC(dt_s=Fraction(1)),
_StubGrid(dt_s=Fraction(1, 2)),
[],
total_duration_s=1,
dc_bus="671",
)
msgs = [str(x.message) for x in w]
assert any("dt_grid" in m and "dt_dc" in m for m in msgs)
def test_coordinator_warns_ctrl_dt_lt_grid_dt():
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
Coordinator(
_StubDC(dt_s=Fraction(1)),
_StubGrid(dt_s=Fraction(1)),
[_StubController(dt_s=Fraction(1, 2))],
total_duration_s=1,
dc_bus="671",
)
msgs = [str(x.message) for x in w]
assert any("stale voltages" in m for m in msgs)
def test_coordinator_run_twice_identical():
"""Calling run() twice on the same coordinator produces identical results."""
dc = _StubDC(dt_s=Fraction(1, 10))
grid = _StubGrid(dt_s=Fraction(1))
ctrl = _StubController(dt_s=Fraction(1))
coord = Coordinator(dc, grid, [ctrl], total_duration_s=2, dc_bus="671")
log1 = coord.run()
log2 = coord.run()
assert len(log1.dc_states) == len(log2.dc_states)
assert len(log1.grid_states) == len(log2.grid_states)
assert [s.time_s for s in log1.grid_states] == [s.time_s for s in log2.grid_states]
assert dc.step_count == 20 # 20 per run, reset between
assert grid.step_count == 2 # 2 per run, reset between
|