mirror of
https://github.com/openai/codex.git
synced 2026-09-11 20:36:49 +00:00
45134c0463
## Why Keep Python protocol models aligned with the checked-in app-server schemas and preserve reviewed generated artifacts when staging SDK releases. ## What changed - Generate SDK types from the schema directory configured in `pyproject.toml`, with a `--schema-dir` override, instead of invoking the pinned runtime binary. - Refresh Python artifacts through `just write-app-server-schema` for standard repository exports. Skip SDK updates for scratch and experimental exports. - Regenerate protocol models and notification dispatch, deriving the known payload union from the registry so `Notification.payload` covers every registered event. - Explicitly allowlist convenience API parameters so new protocol fields do not silently expand method signatures. Preserve existing approval path wrappers. - Stage SDK releases using checked-in generated files without regenerating them. ## Testing Add coverage for schema selection, refresh gating and failure handling, release artifact preservation, notification payload typing, and approval path compatibility. Update the generation drift test to use repository schemas. GitOrigin-RevId: fab350b07cf170258b91fbafa8da384aeb2e3bd7
97 lines
3.3 KiB
Python
97 lines
3.3 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import runpy
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
GENERATED_TARGETS = [
|
|
Path("src/openai_codex/generated/notification_registry.py"),
|
|
Path("src/openai_codex/generated/v2_all.py"),
|
|
Path("src/openai_codex/api.py"),
|
|
]
|
|
|
|
|
|
def _snapshot_target(root: Path, rel_path: Path) -> dict[str, bytes] | bytes | None:
|
|
"""Capture one generated artifact so regeneration drift is easy to compare."""
|
|
target = root / rel_path
|
|
if not target.exists():
|
|
return None
|
|
if target.is_file():
|
|
return target.read_bytes()
|
|
|
|
snapshot: dict[str, bytes] = {}
|
|
for path in sorted(target.rglob("*")):
|
|
if path.is_file() and "__pycache__" not in path.parts:
|
|
snapshot[str(path.relative_to(target))] = path.read_bytes()
|
|
return snapshot
|
|
|
|
|
|
def _snapshot_targets(root: Path) -> dict[str, dict[str, bytes] | bytes | None]:
|
|
"""Capture all checked-in generated artifacts before and after regeneration."""
|
|
return {str(rel_path): _snapshot_target(root, rel_path) for rel_path in GENERATED_TARGETS}
|
|
|
|
|
|
def test_generated_files_are_up_to_date():
|
|
"""Regenerating from repository schemas should leave reviewed artifacts unchanged."""
|
|
before = _snapshot_targets(ROOT)
|
|
|
|
env = os.environ.copy()
|
|
python_bin = str(Path(sys.executable).parent)
|
|
env["PATH"] = f"{python_bin}{os.pathsep}{env.get('PATH', '')}"
|
|
|
|
subprocess.run(
|
|
[sys.executable, "scripts/update_sdk_artifacts.py", "generate-types"],
|
|
cwd=ROOT,
|
|
check=True,
|
|
env=env,
|
|
)
|
|
|
|
after = _snapshot_targets(ROOT)
|
|
assert before == after, "Generated files drifted after regeneration"
|
|
|
|
|
|
@pytest.mark.parametrize("mode", ["repository", "scratch", "experimental"])
|
|
def test_schema_refresh_only_updates_python_for_repository_schemas(monkeypatch, tmp_path, mode):
|
|
script = ROOT.parents[1] / "codex-rs/app-server-protocol/scripts/write_schema_fixtures.py"
|
|
arguments = {
|
|
"repository": [],
|
|
"scratch": ["--schema-root", str(tmp_path / "schema")],
|
|
"experimental": ["--experimental"],
|
|
}[mode]
|
|
calls = []
|
|
monkeypatch.setattr(sys, "argv", [str(script), *arguments])
|
|
monkeypatch.setattr(subprocess, "run", lambda args, **kwargs: calls.append((args, kwargs)))
|
|
|
|
runpy.run_path(str(script), run_name="__main__")
|
|
|
|
assert [args[0] for args, _kwargs in calls] == (
|
|
["cargo", "uv"] if mode == "repository" else ["cargo"]
|
|
)
|
|
assert all(kwargs["check"] for _args, kwargs in calls)
|
|
if mode == "repository":
|
|
assert calls[1][0][-3:] == [
|
|
"generate-types",
|
|
"--schema-dir",
|
|
str(ROOT.parents[1] / "codex-rs/app-server-protocol/schema/json"),
|
|
]
|
|
|
|
|
|
def test_schema_generation_failure_does_not_update_python(monkeypatch):
|
|
script = ROOT.parents[1] / "codex-rs/app-server-protocol/scripts/write_schema_fixtures.py"
|
|
calls = []
|
|
|
|
def fail(args, **_kwargs):
|
|
calls.append(args[0])
|
|
raise subprocess.CalledProcessError(1, args)
|
|
|
|
monkeypatch.setattr(sys, "argv", [str(script)])
|
|
monkeypatch.setattr(subprocess, "run", fail)
|
|
with pytest.raises(subprocess.CalledProcessError):
|
|
runpy.run_path(str(script), run_name="__main__")
|
|
assert calls == ["cargo"]
|