hermes-agent/tests/hermes_cli/test_oneshot_usage_file.py
Teknium 7dfd5077ce
feat(oneshot): add --usage-file JSON usage report to hermes -z (#59615)
* feat(oneshot): add --usage-file JSON usage report to hermes -z

Pipelines driving hermes -z (batch reviewers, cron scripts, eval
harnesses) had no way to account for per-invocation spend: the agent
computes estimated_cost_usd and full token counts internally, but
oneshot mode discards everything except the final response text.

- hermes -z PROMPT --usage-file PATH writes a JSON report after the
  run: estimated_cost_usd, cost_status/source, input/output/cache/
  reasoning/total tokens, api_calls, model, provider, session_id,
  completed, failed.
- Written even when the run fails (with a failure field) so callers
  can always account for spend; the write itself is best-effort and
  never masks the run's own outcome.
- Flag registered in both the full parser and the Termux fast path;
  added to both value-flag scan sets so profile detection stays
  correct.

Validation: 6 unit tests + live E2E (real -z run produced a report
with real OpenRouter cost + token counts).

* test: include usage_file kwarg in oneshot dispatch assertions

The two dispatch tests assert the exact kwargs dict passed to
run_oneshot; the new usage_file kwarg must appear there.
2026-07-06 11:10:51 -07:00

69 lines
2.5 KiB
Python

"""Tests for hermes -z --usage-file (per-run JSON usage report)."""
import json
from hermes_cli.oneshot import _write_usage_file
def _result(**overrides):
base = {
"estimated_cost_usd": 0.1234,
"cost_status": "estimated",
"cost_source": "pricing-table",
"input_tokens": 1000,
"output_tokens": 200,
"cache_read_tokens": 800,
"cache_write_tokens": 0,
"reasoning_tokens": 50,
"total_tokens": 1250,
"api_calls": 3,
"model": "openai/gpt-5.5",
"provider": "openrouter",
"session_id": "abc123",
"completed": True,
"failed": False,
}
base.update(overrides)
return base
class TestWriteUsageFile:
def test_writes_report_with_cost_and_tokens(self, tmp_path):
path = tmp_path / "usage.json"
_write_usage_file(str(path), _result())
report = json.loads(path.read_text())
assert report["estimated_cost_usd"] == 0.1234
assert report["input_tokens"] == 1000
assert report["output_tokens"] == 200
assert report["model"] == "openai/gpt-5.5"
assert report["api_calls"] == 3
assert report["failed"] is False
assert "failure" not in report
def test_none_path_is_noop(self, tmp_path):
# Must not raise and must not create a report file.
_write_usage_file(None, _result())
assert not (tmp_path / "usage.json").exists()
def test_failure_marks_failed_and_records_message(self, tmp_path):
path = tmp_path / "usage.json"
_write_usage_file(str(path), {}, failure="boom")
report = json.loads(path.read_text())
assert report["failed"] is True
assert report["failure"] == "boom"
# Missing result fields serialize as null, not KeyError.
assert report["estimated_cost_usd"] is None
def test_creates_parent_directories(self, tmp_path):
path = tmp_path / "nested" / "dir" / "usage.json"
_write_usage_file(str(path), _result())
assert json.loads(path.read_text())["total_tokens"] == 1250
def test_unwritable_path_never_raises(self):
# Root-owned path — the write must be swallowed, not raised.
_write_usage_file("/proc/definitely/not/writable/usage.json", _result())
def test_result_failed_flag_carries_through(self, tmp_path):
path = tmp_path / "usage.json"
_write_usage_file(str(path), _result(failed=True))
assert json.loads(path.read_text())["failed"] is True