agent/codex
1
0
Fork 0
mirror of https://github.com/pchuan98/codex.git synced 2026-07-01 00:31:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

[codex] Add comprehensive root formatting check (#25683)

Browse Source 
## Why

The root formatting entrypoints could drift: `just fmt` did not format
the Justfile itself, and the CI-facing check recipe only checked Python
scripts instead of matching everything formatted by `just fmt`.

## What changed

- Add a shared cross-platform Python formatter driver used by both `just
fmt` and `just fmt-check`.
- Run Justfile, Rust, Python SDK, and internal-script formatter groups
concurrently while buffering each formatter group's output until it
finishes.
- Log formatter starts immediately, then print each formatter group's
labeled output when it completes.
- Keep the SDK lint-fix and Ruff formatting passes ordered, with source
comments explaining their distinct roles and the check-mode equivalents.
- Run Ruff through shared `uv run --no-sync --with ruff` overlays so
formatting works on clean glibc Linux checkouts without installing the
platform-specific SDK runtime wheel.
- Show `fmt-check` help text in `just -l` and simplify CI to call the
shared driver through `just fmt-check`.
- Pin the general CI workflow to `just@1.51.0` so its formatter agrees
with the checked-in Justfile.
- Add regression coverage for the thin Just recipes and the driver's
formatter graph.

## Validation

- `just fmt`
- `just fmt-check`
- `python3 -m pytest
sdk/python/tests/test_artifact_workflow_and_binaries.py -k 'root_fmt or
root_format' -q`
- `pnpm run format`
- `git diff --check`
- `just -l | rg -n '^    fmt|fmt-check'`
- `uvx --from uv==0.7.22 uv run --frozen --project sdk/python --no-sync
--with ruff ruff check --diff sdk/python`
This commit is contained in:
Adam Perry @ OpenAI
2026-06-01 18:20:25 -07:00
committed by GitHub
Unverified
parent 0002316687
commit 747f1003dd
4 changed files with 312 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sdk/python/tests/test_artifact_workflow_and_binaries.py
+120 -17
View File
@@ -14,6 +14,18 @@ import tomllib
ROOT = Path(__file__).resolve().parents[1]
def _load_root_format_script_module():
"""Load the root formatter driver so tests exercise its real command graph."""
script_path = ROOT.parents[1] / "scripts" / "format.py"
spec = importlib.util.spec_from_file_location("format_repo", script_path)
if spec is None or spec.loader is None:
raise AssertionError(f"Failed to load script module: {script_path}")
module = importlib.util.module_from_spec(spec)
sys.modules[spec.name] = module
spec.loader.exec_module(module)
return module
def _load_update_script_module():
"""Load the maintenance script as a module so tests exercise real helpers."""
script_path = ROOT / "scripts" / "update_sdk_artifacts.py"
@@ -68,44 +80,135 @@ def test_generation_has_single_maintenance_entrypoint_script() -> None:
assert scripts == ["update_sdk_artifacts.py"]
def test_root_fmt_recipe_formats_rust_python_sdk_and_scripts() -> None:
"""The repo fmt command should format Rust, the Python SDK, and scripts."""
def test_root_fmt_recipes_use_shared_formatter_driver() -> None:
"""The root formatting recipes should use the shared cross-platform driver."""
justfile = ROOT.parents[1] / "justfile"
lines = justfile.read_text().splitlines()
fmt_index = lines.index("fmt:")
fmt_check_index = lines.index("fmt-check:")
next_recipe_index = next(
index
for index in range(fmt_index + 1, len(lines))
for index in range(fmt_check_index + 1, len(lines))
if lines[index] and not lines[index].startswith((" ", "\t", "#"))
)
fmt_recipe = lines[fmt_index:next_recipe_index]
actual = {
"working_directory": lines[0],
"previous_comment": next(
line for line in reversed(lines[:fmt_index]) if line.startswith("#")
"fmt_comment": next(line for line in reversed(lines[:fmt_index]) if line.startswith("#")),
"fmt_commands": [
line.strip()
for line in lines[fmt_index + 1 : fmt_check_index]
if line.strip() and not line.startswith("#")
],
"fmt_check_comment": next(
line for line in reversed(lines[:fmt_check_index]) if line.startswith("#")
),
"commands": [line.strip() for line in fmt_recipe[1:] if line.strip()],
"fmt_check_commands": [
line.strip() for line in lines[fmt_check_index + 1 : next_recipe_index] if line.strip()
],
}
expected = {
"working_directory": 'set working-directory := "codex-rs"',
"previous_comment": "# Format Rust, Python SDK code, and Python scripts.",
"commands": [
"cargo fmt -- --config imports_granularity=Item {stderr-null}",
"uv run --frozen --project ../sdk/python --extra dev ruff check --fix --fix-only ../sdk/python",
"uv run --frozen --project ../sdk/python --extra dev ruff format ../sdk/python",
"# Root scripts have their own locked Ruff environment.",
"uv run --frozen --project ../scripts ruff format ../scripts",
],
"fmt_comment": "# Format the justfile, Rust, Python SDK code, and Python scripts.",
"fmt_commands": ["{{ python }} ../scripts/format.py"],
"fmt_check_comment": "# Check formatting without modifying files.",
"fmt_check_commands": ["{{ python }} ../scripts/format.py --check"],
}
assert actual == expected, (
"The root `just fmt` recipe must run Rust fmt and Ruff for Python SDK code and scripts. "
"Fix the `fmt` recipe in `justfile`, then run `just fmt`.\n"
"The root formatting recipes must use the shared formatter driver. "
"Fix the recipes in `justfile`, then run `just fmt`.\n"
f"Expected: {json.dumps(expected, indent=2)}\n"
f"Actual: {json.dumps(actual, indent=2)}"
)
def test_root_format_driver_covers_all_formatter_groups() -> None:
"""The shared driver should retain every formatter in both modes."""
script = _load_root_format_script_module()
formatters = script.formatter_groups(check=False)
checks = script.formatter_groups(check=True)
assert [group.name for group in formatters] == [
"Just",
"Rust",
"Python SDK",
"Python scripts",
]
assert [group.name for group in checks] == [group.name for group in formatters]
assert [len(group.commands) for group in formatters] == [1, 1, 2, 1]
assert [len(group.commands) for group in checks] == [
len(group.commands) for group in formatters
]
sdk_uv_run_args = (
"uv",
"run",
"--frozen",
"--project",
"sdk/python",
"--no-sync",
"--with",
"ruff",
)
scripts_uv_run_args = (
"uv",
"run",
"--frozen",
"--project",
"scripts",
"--no-sync",
"--with",
"ruff",
)
assert all(
command.args[: len(sdk_uv_run_args)] == sdk_uv_run_args
for group in (formatters[2], checks[2])
for command in group.commands
)
assert all(
command.args[: len(scripts_uv_run_args)] == scripts_uv_run_args
for group in (formatters[3], checks[3])
for command in group.commands
)
assert formatters[2].commands[0].args[-5:] == (
"ruff",
"check",
"--fix",
"--fix-only",
"sdk/python",
)
assert checks[2].commands[0].args[-4:] == (
"ruff",
"check",
"--diff",
"sdk/python",
)
assert formatters[0].commands[-1].args == ("just", "--unstable", "--fmt")
assert checks[0].commands[-1].args == ("just", "--unstable", "--fmt", "--check")
assert formatters[1].commands[-1].args == (
"cargo",
"fmt",
"--",
"--config",
"imports_granularity=Item",
)
assert checks[1].commands[-1].args == (
"cargo",
"fmt",
"--",
"--config",
"imports_granularity=Item",
"--check",
)
assert [group.commands[-1].args[-3:] for group in formatters[2:]] == [
("ruff", "format", "sdk/python"),
("ruff", "format", "scripts"),
]
assert [group.commands[-1].args[-4:] for group in checks[2:]] == [
("ruff", "format", "--check", "sdk/python"),
("ruff", "format", "--check", "scripts"),
]
def test_generate_types_wires_all_generation_steps() -> None:
"""The type generation command should refresh every schema-derived artifact."""
source = (ROOT / "scripts" / "update_sdk_artifacts.py").read_text()