Files
roboco/tests/unit/llm/providers/test_codex_cli_usage.py
T
c70ff3cf9a feat(providers): Codex CLI provider — OpenAI via ModelProvider.OPENAI (#659)
* feat(providers): Codex CLI provider — OpenAI via ModelProvider.OPENAI

Mirrors the grok blueprint end to end: CodexCliProvider (RO ~/.codex
mount, ANTHROPIC_* blanked), an orchestrator-side codex_auth.py
refresher (JWT-exp staleness, atomic rewrite, lock-serialized single-use
rotation, --check backstop; the CLI's own in-process refresh write
no-ops on the RO mount by design — margins keep the orchestrator ahead
of the CLI's 5-minute window), config.toml rendering with required=true
gateway MCP servers, execpolicy deny rules (forbidden-only), per-role
--sandbox (developer=workspace-write, review/doc roles read-only),
codex exec --json with pinned ROBOCO_CODEX_CLI_MODEL (gpt-5.3-codex),
usage summed from typed turn.completed events priced via the real
4-bucket split, dedicated image + entrypoint, registry/park/finalize/
compose/release wiring. V1 excludes interactive intake/secretary.

Per adversarial review: migration 083 seeds the openai provider row
enabled=True (without it every routing path 404'd — the whole feature
was operationally dead code; grok needed the same seed in 039), the
panel picker gained the OpenAI catalog group it silently lacked, and
exit classification is structural — only stderr and error.message
fields from error events are sniffed (word-boundaried patterns, exact
auth phrases, bare 'login' dropped), so the model echoing on-topic
words can never false-park the provider fleet-wide, proven by a
benign-transcript test. Known open risk flagged, not claimed: whether
codex's workspace-write OS sandbox excludes /app is unverified, and no
hook mechanism exists to port the bash-guard defense-in-depth.

* fix(providers): containment barrier on usage.json reads (code scanning)

CodeQL flagged the codex usage read as path injection — correctly:
os.path.basename does not neutralize '..', and the upstream segment
validator isn't in CodeQL's taint model. The grok/codex reads collapse
into one _read_usage_json_contained helper that resolves the built path
and refuses anything outside the resolved usage root — a hostile id can
never escape regardless of upstream drift. Traversal + containment
regression tests added; a stray noqa in the test file replaced with a
named constant per repo rule.

* fix(providers): use realpath+startswith containment CodeQL recognizes

The is_relative_to() guard was a real barrier but not in CodeQL's
py/path-injection sanitizer model, so the alert persisted. Switch to
the canonical os.path.realpath + startswith(root + os.sep) form, which
CodeQL recognizes as a path-traversal barrier; behavior is identical
(refuse any candidate resolving outside the usage root).

* fix(providers): regexp-allowlist the usage-id segment (CodeQL barrier)

Neither is_relative_to nor realpath+startswith was recognized by
CodeQL's py/path-injection sanitizer model across the str->Path->open
flow. Sanitize the tainted component at the source instead: the id must
fullmatch a strict slug token ([A-Za-z0-9][A-Za-z0-9._-]*, no
separators, no '..'), which CodeQL recognizes as a path-injection
barrier; the realpath+startswith containment stays as defense-in-depth.

* fix(providers): standalone regexp guard so CodeQL recognizes the barrier

The sanitizer was one disjunct of a compound 'or' condition, which
CodeQL's guard analysis does not trace as a barrier. Split the regexp
fullmatch into its own single-condition guard (the redundant '..' check
is dropped — the required alphanumeric first char already excludes it).

---------

Co-authored-by: Renn F <rennf93@users.noreply.github.com>
2026-07-23 03:20:29 +02:00

160 lines
5.5 KiB
Python

"""codex_cli_usage — sum real input/output/cache usage across ``turn.completed``
events in a captured ``codex exec --json`` JSONL log."""
from __future__ import annotations
import json
from typing import TYPE_CHECKING
from roboco.llm.providers import codex_cli_usage as cu
if TYPE_CHECKING:
from pathlib import Path
import pytest
def _turn_completed(
*,
input_tokens: int,
cached_input_tokens: int = 0,
cache_write_input_tokens: int = 0,
output_tokens: int,
reasoning_output_tokens: int = 0,
) -> str:
return json.dumps(
{
"type": "turn.completed",
"usage": {
"input_tokens": input_tokens,
"cached_input_tokens": cached_input_tokens,
"cache_write_input_tokens": cache_write_input_tokens,
"output_tokens": output_tokens,
"reasoning_output_tokens": reasoning_output_tokens,
},
}
)
def _write_jsonl(path: Path, lines: list[str]) -> None:
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text("\n".join(lines) + "\n", encoding="utf-8")
def test_aggregate_sums_across_multiple_turn_completed_events(tmp_path: Path) -> None:
log = tmp_path / "run.jsonl"
_write_jsonl(
log,
[
json.dumps({"type": "thread.started"}),
json.dumps({"type": "turn.started"}),
_turn_completed(
input_tokens=1000, cached_input_tokens=200, output_tokens=100
),
json.dumps({"type": "item.completed", "item": {"type": "command"}}),
_turn_completed(
input_tokens=500,
cached_input_tokens=100,
cache_write_input_tokens=50,
output_tokens=80,
reasoning_output_tokens=20,
),
],
)
agg = cu.aggregate_usage_from_jsonl(log)
assert agg["input_tokens"] == 1500 # noqa: PLR2004
assert agg["cached_input_tokens"] == 300 # noqa: PLR2004
assert agg["cache_write_input_tokens"] == 50 # noqa: PLR2004
assert agg["output_tokens"] == 180 # noqa: PLR2004
assert agg["reasoning_output_tokens"] == 20 # noqa: PLR2004
assert agg["turns"] == 2 # noqa: PLR2004
def test_aggregate_ignores_turn_failed_and_bad_lines(tmp_path: Path) -> None:
log = tmp_path / "run.jsonl"
_write_jsonl(
log,
[
"not json",
json.dumps({"type": "turn.failed", "error": {"message": "boom"}}),
_turn_completed(input_tokens=10, output_tokens=5),
],
)
agg = cu.aggregate_usage_from_jsonl(log)
assert agg["input_tokens"] == 10 # noqa: PLR2004
assert agg["turns"] == 1
def test_aggregate_zero_for_missing_or_empty_log(tmp_path: Path) -> None:
agg = cu.aggregate_usage_from_jsonl(tmp_path / "nope.jsonl")
assert agg["turns"] == 0
assert all(v == 0 for k, v in agg.items() if k != "turns")
def test_usage_and_cost_treats_cached_as_subset_of_input() -> None:
# cached_input_tokens is a SUBSET of input_tokens (not additional) — the
# "fresh" input priced at the full rate is the difference.
agg = {
"input_tokens": 1000,
"cached_input_tokens": 300,
"cache_write_input_tokens": 0,
"output_tokens": 200,
"reasoning_output_tokens": 50,
}
tin, tout, cr, cw, cost = cu.usage_and_cost("gpt-5.3-codex", agg)
assert tin == 700 # 1000 - 300 # noqa: PLR2004
assert tout == 250 # output + reasoning folded in # noqa: PLR2004
assert cr == 300 # noqa: PLR2004
assert cw == 0
assert cost > 0.0
def test_usage_and_cost_never_goes_negative_when_cached_exceeds_input() -> None:
agg = {
"input_tokens": 10,
"cached_input_tokens": 50, # malformed/inconsistent upstream data
"cache_write_input_tokens": 0,
"output_tokens": 0,
"reasoning_output_tokens": 0,
}
tin, *_rest = cu.usage_and_cost("gpt-5.3-codex", agg)
assert tin == 0
def test_capture_run_usage_writes_usage_json(tmp_path: Path) -> None:
log = tmp_path / "run.jsonl"
_write_jsonl(log, [_turn_completed(input_tokens=100, output_tokens=50)])
out = tmp_path / "usage.json"
tokens = cu.capture_run_usage(run_log=log, model="gpt-5.3-codex", out_path=out)
assert tokens == (100, 50, 0, 0)
data = json.loads(out.read_text())
assert data["model"] == "gpt-5.3-codex"
assert data["tokens_input"] == 100 # noqa: PLR2004
assert data["tokens_output"] == 50 # noqa: PLR2004
assert data["turns"] == 1
assert data["cost_usd"] > 0.0
def test_main_writes_usage_file(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
log = tmp_path / "run.jsonl"
_write_jsonl(log, [_turn_completed(input_tokens=200, output_tokens=100)])
out = tmp_path / "usage.json"
monkeypatch.setattr(cu, "USAGE_OUT_PATH", out)
monkeypatch.setenv("ROBOCO_CODEX_RUN_LOG", str(log))
monkeypatch.setenv("ROBOCO_AGENT_MODEL", "gpt-5.3-codex")
assert cu.main() == 0
data = json.loads(out.read_text())
assert data["tokens_input"] == 200 # noqa: PLR2004
assert data["tokens_output"] == 100 # noqa: PLR2004
def test_main_warns_when_run_log_env_missing(
monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture
) -> None:
monkeypatch.delenv("ROBOCO_CODEX_RUN_LOG", raising=False)
with caplog.at_level("WARNING", logger="roboco.llm.providers.codex_cli_usage"):
assert cu.main() == 0
assert any("ROBOCO_CODEX_RUN_LOG" in r.message for r in caplog.records)