Files
hermes-agent/tests/run_agent/test_iteration_budget_race.py
Ricardo-M-L fbc477df71 fix(run_agent): acquire lock in IterationBudget.used property
The `used` property was reading `self._used` without holding the lock,
while `consume()`, `refund()`, and `remaining` all properly acquire
`self._lock` before accessing `_used`. This means a concurrent call to
`used` during `consume()` or `refund()` could observe a partially-
updated value, leading to incorrect iteration budget metrics reported
to the gateway, or in extreme cases a ValueError from CPython's list
implementation when the internal array resizes during iteration.

Fix: acquire the lock in `used` just like `remaining` does.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-04 12:37:28 -07:00

110 lines
3.3 KiB
Python

"""Tests for IterationBudget thread safety.
The `used` property must acquire the lock before reading `_used` to prevent
data races with concurrent `consume()` / `refund()` calls.
"""
import threading
import time
from concurrent.futures import ThreadPoolExecutor
import pytest
def test_iteration_budget_used_is_thread_safe():
"""Iterating `used` while other threads consume/refund must not crash.
Before the fix, `used` returned `_used` directly without holding the lock,
so a concurrent `consume()` could observe a partially-updated value or
cause the C-level `list.append` to raise a ValueError ("list size changed").
"""
from run_agent import IterationBudget
budget = IterationBudget(max_total=1000)
num_threads = 10
operations_per_thread = 200
errors = []
def worker(consume: bool):
try:
for _ in range(operations_per_thread):
if consume:
budget.consume()
else:
budget.refund()
# Also read `used` to exercise the property
_ = budget.used
except Exception as exc:
errors.append(exc)
with ThreadPoolExecutor(max_workers=num_threads * 2) as executor:
# Half the threads consume, half refund
futures = []
for i in range(num_threads):
consume = i < num_threads // 2
futures.append(executor.submit(worker, consume))
futures.append(executor.submit(worker, consume))
for f in futures:
f.result()
assert not errors, f"Thread safety violation: {errors}"
# Final value should be within expected bounds
assert 0 <= budget.used <= budget.max_total
def test_iteration_budget_consume_returns_false_when_exhausted():
"""consume() must return False once the budget is exhausted."""
from run_agent import IterationBudget
budget = IterationBudget(max_total=3)
assert budget.consume() is True
assert budget.consume() is True
assert budget.consume() is True
assert budget.consume() is False
def test_iteration_budget_refund_restores_consume():
"""refund() after consume() must allow one more consume()."""
from run_agent import IterationBudget
budget = IterationBudget(max_total=2)
assert budget.consume() is True
assert budget.consume() is True
assert budget.consume() is False # exhausted
budget.refund()
assert budget.consume() is True
def test_iteration_budget_used_reflects_consume_and_refund():
"""used property must accurately reflect consume() and refund() calls."""
from run_agent import IterationBudget
budget = IterationBudget(max_total=10)
assert budget.used == 0
budget.consume()
assert budget.used == 1
budget.consume()
assert budget.used == 2
budget.refund()
assert budget.used == 1
budget.refund()
assert budget.used == 0
def test_iteration_budget_remaining():
"""remaining property must equal max_total - used."""
from run_agent import IterationBudget
budget = IterationBudget(max_total=5)
assert budget.remaining == 5
budget.consume()
assert budget.remaining == 4
budget.consume()
budget.consume()
assert budget.remaining == 2
budget.refund()
assert budget.remaining == 3