mirror of
https://github.com/openai/codex.git
synced 2026-11-06 20:20:34 +00:00
jif
b6f53857fc
## Why Prereleases are published before their assets are uploaded. A failed upload can leave an incomplete public release and prevent a rerun from recreating its `prereleased` event. ## What changed Track newly created prereleases and successful asset uploads in the release workflow. Remove a newly created prerelease if its upload fails, preserving the tag so a rerun can recreate the release. Keep existing releases and releases whose assets finished uploading, even if the metadata update fails. ## Testing Add a regression test that runs the workflow commands with a stubbed `gh`, covering upload failure cleanup, a successful rerun, preservation of existing prereleases, and metadata update failures after upload. GitOrigin-RevId: 29411d6d1e649f4e8c67e84a41d9de2c9d31558f
409 lines
17 KiB
Python
409 lines
17 KiB
Python
import io
|
|
import json
|
|
import os
|
|
from pathlib import Path
|
|
import re
|
|
import shutil
|
|
import subprocess
|
|
import tarfile
|
|
import tempfile
|
|
import textwrap
|
|
import unittest
|
|
from unittest.mock import patch
|
|
|
|
from npm_alpha_tag import npm_alpha_tag
|
|
import publish_r2_release as r2
|
|
from releases import is_valid_release_version, should_make_latest, should_update_version
|
|
|
|
|
|
class VersionComparisonTest(unittest.TestCase):
|
|
def test_validation_accepts_alpha_hotfix(self) -> None:
|
|
self.assertTrue(is_valid_release_version("0.123.0-alpha.5.2"))
|
|
|
|
def test_validation_rejects_extra_component(self) -> None:
|
|
self.assertFalse(is_valid_release_version("0.123.0-alpha.5.2.3"))
|
|
|
|
def test_next_alpha_after_public_release(self) -> None:
|
|
self.assertTrue(should_update_version("0.124.0-alpha.1", "0.123.0"))
|
|
|
|
def test_public_release_after_next_alpha(self) -> None:
|
|
self.assertFalse(should_update_version("0.123.0", "0.124.0-alpha.1"))
|
|
|
|
def test_hotfix_for_an_older_release_line(self) -> None:
|
|
self.assertFalse(should_update_version("0.100.0-alpha.1.2", "0.123.0-alpha.5"))
|
|
|
|
def test_hotfix_for_an_older_alpha(self) -> None:
|
|
self.assertFalse(should_update_version("0.123.0-alpha.2.3", "0.123.0-alpha.10"))
|
|
|
|
def test_hotfix_for_the_current_alpha(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0-alpha.5.2", "0.123.0-alpha.5"))
|
|
|
|
def test_hotfix_numbers_compare_numerically(self) -> None:
|
|
self.assertTrue(
|
|
should_update_version("0.123.0-alpha.5.10", "0.123.0-alpha.5.2")
|
|
)
|
|
|
|
def test_numbered_alpha_after_bare_alpha(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0-alpha.1", "0.123.0-alpha"))
|
|
|
|
def test_beta_after_alpha(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0-beta", "0.123.0-alpha.10"))
|
|
|
|
def test_public_release_after_beta(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0", "0.123.0-beta.2"))
|
|
|
|
def test_equal_version(self) -> None:
|
|
self.assertFalse(should_update_version("0.123.0-alpha.5", "0.123.0-alpha.5"))
|
|
|
|
def test_missing_current_version(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0-alpha.5", ""))
|
|
|
|
def test_invalid_current_version(self) -> None:
|
|
self.assertTrue(should_update_version("0.123.0-alpha.5", "0.123"))
|
|
|
|
def test_invalid_release_version(self) -> None:
|
|
self.assertRaises(ValueError, should_update_version, "0.123", "")
|
|
|
|
|
|
class NpmAlphaTagTest(unittest.TestCase):
|
|
def write_package(self, tarball: Path, package: str) -> None:
|
|
content = json.dumps({"name": package}).encode()
|
|
with tarfile.open(tarball, "w:gz") as archive:
|
|
info = tarfile.TarInfo("package/package.json")
|
|
info.size = len(content)
|
|
archive.addfile(info, io.BytesIO(content))
|
|
|
|
def test_published_tags_across_packages_and_platforms(self) -> None:
|
|
# Each package/tag reads its own registry value, even after a partially
|
|
# published release. Also exercise a missing pointer and dotted hotfix.
|
|
cases = [
|
|
(
|
|
"@openai/codex-sdk",
|
|
"latest",
|
|
"0.100.0",
|
|
"0.99.9",
|
|
"release-0.99.9-latest",
|
|
),
|
|
(
|
|
"@openai/codex",
|
|
"linux-x64",
|
|
"0.99.9-linux-x64",
|
|
"0.100.0",
|
|
"linux-x64",
|
|
),
|
|
("@openai/codex-responses-api-proxy", "latest", None, "0.100.0", "latest"),
|
|
(
|
|
"@openai/codex",
|
|
"alpha",
|
|
"0.158.0-alpha.10",
|
|
"0.157.0-alpha.11.1",
|
|
"release-0.157.0-alpha.11.1-alpha",
|
|
),
|
|
(
|
|
"@openai/codex",
|
|
"alpha-linux-x64",
|
|
"0.158.0-alpha.10-linux-x64",
|
|
"0.157.0-alpha.11.1",
|
|
"release-0.157.0-alpha.11.1-alpha-linux-x64",
|
|
),
|
|
(
|
|
"@openai/codex",
|
|
"alpha-win32-arm64",
|
|
"0.158.0-alpha.9-win32-arm64",
|
|
"0.158.0-alpha.10",
|
|
"alpha-win32-arm64",
|
|
),
|
|
(
|
|
"@openai/codex-sdk",
|
|
"alpha",
|
|
"0.158.0-alpha.10",
|
|
"0.158.0-alpha.10.1",
|
|
"alpha",
|
|
),
|
|
(
|
|
"@openai/codex-responses-api-proxy",
|
|
"alpha",
|
|
"0.159.0-alpha.1",
|
|
"0.158.0-alpha.10.1",
|
|
"release-0.158.0-alpha.10.1-alpha",
|
|
),
|
|
("@openai/codex-sdk", "alpha", None, "0.158.0-alpha.10", "alpha"),
|
|
(
|
|
"@openai/codex",
|
|
"alpha-linux-x64",
|
|
"broken-linux-x64",
|
|
"0.158.0-alpha.10",
|
|
"alpha-linux-x64",
|
|
),
|
|
]
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
tarball = Path(tmpdir) / "package.tgz"
|
|
for package, tag, current, version, expected in cases:
|
|
with self.subTest(package=package, tag=tag, version=version):
|
|
self.write_package(tarball, package)
|
|
tags = {tag: current} if current is not None else {}
|
|
result = subprocess.CompletedProcess([], 0, json.dumps(tags))
|
|
with patch(
|
|
"npm_alpha_tag.subprocess.run", return_value=result
|
|
) as run:
|
|
self.assertEqual(npm_alpha_tag(tarball, version, tag), expected)
|
|
run.assert_called_once_with(
|
|
[
|
|
"npm",
|
|
"view",
|
|
package,
|
|
"dist-tags",
|
|
"--json",
|
|
"--prefer-online",
|
|
],
|
|
check=True,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
def test_stable_tags_reject_malformed_and_prerelease_versions(self) -> None:
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
tarball = Path(tmpdir) / "package.tgz"
|
|
self.write_package(tarball, "@openai/codex")
|
|
for tag, current in (
|
|
("latest", "broken"),
|
|
("linux-x64", "0.100.0-alpha.1-linux-x64"),
|
|
):
|
|
with self.subTest(tag=tag, current=current):
|
|
result = subprocess.CompletedProcess(
|
|
[], 0, json.dumps({tag: current})
|
|
)
|
|
with patch("npm_alpha_tag.subprocess.run", return_value=result):
|
|
with self.assertRaises(ValueError):
|
|
npm_alpha_tag(tarball, "0.99.9", tag)
|
|
|
|
def test_registry_failure_prevents_publish(self) -> None:
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
tarball = Path(tmpdir) / "package.tgz"
|
|
self.write_package(tarball, "@openai/codex")
|
|
with patch(
|
|
"npm_alpha_tag.subprocess.run",
|
|
side_effect=subprocess.CalledProcessError(1, "npm"),
|
|
):
|
|
with self.assertRaises(subprocess.CalledProcessError):
|
|
npm_alpha_tag(tarball, "0.158.0-alpha.10", "alpha")
|
|
|
|
|
|
class DotSlashReleaseConfigTests(unittest.TestCase):
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
github_dir = Path(__file__).resolve().parent.parent
|
|
cls.configs = {
|
|
filename: json.loads((github_dir / filename).read_text())["outputs"]
|
|
for filename in (
|
|
"dotslash-config.json",
|
|
"dotslash-argument-comment-lint-config.json",
|
|
"dotslash-provisioned-config.json",
|
|
)
|
|
}
|
|
# Names from the published rust-v0.167.0-alpha.2 release, which has no
|
|
# Bazel assets: https://github.com/openai/codex/releases/tag/rust-v0.167.0-alpha.2
|
|
cls.assets = set(
|
|
(github_dir / "scripts/fixtures/codex-0.167.0-alpha.2-assets.txt")
|
|
.read_text()
|
|
.splitlines()
|
|
)
|
|
|
|
def missing_assets(self, assets):
|
|
return sorted(
|
|
(filename, output_name, platform)
|
|
for filename, outputs in self.configs.items()
|
|
for output_name, output in outputs.items()
|
|
for platform, config in output["platforms"].items()
|
|
if not any(re.match(config["regex"], asset) for asset in assets)
|
|
)
|
|
|
|
def test_cargo_release_covers_all_configured_outputs(self):
|
|
self.assertEqual(
|
|
{filename: set(outputs) for filename, outputs in self.configs.items()},
|
|
{
|
|
"dotslash-config.json": {
|
|
"codex",
|
|
"codex-app-server",
|
|
"codex-responses-api-proxy",
|
|
"bwrap",
|
|
"codex-command-runner",
|
|
"codex-windows-sandbox-setup",
|
|
"codex-windows-sandbox-service",
|
|
},
|
|
"dotslash-argument-comment-lint-config.json": {"argument-comment-lint"},
|
|
"dotslash-provisioned-config.json": {"codex-provisioned"},
|
|
},
|
|
)
|
|
self.assertFalse(any("-bazel" in asset for asset in self.assets))
|
|
self.assertEqual(self.missing_assets(self.assets), [])
|
|
|
|
def test_missing_cargo_asset_is_detected(self):
|
|
missing_asset = "codex-package-aarch64-apple-darwin.tar.zst"
|
|
self.assertIn(missing_asset, self.assets)
|
|
self.assertEqual(
|
|
self.missing_assets(self.assets - {missing_asset}),
|
|
[("dotslash-config.json", "codex", "macos-aarch64")],
|
|
)
|
|
|
|
def test_missing_provisioned_cargo_asset_is_detected(self):
|
|
for arch in ("aarch64", "x86_64"):
|
|
with self.subTest(arch=arch):
|
|
missing_asset = f"codex-provisioned-package-{arch}-apple-darwin.tar.gz"
|
|
self.assertIn(missing_asset, self.assets)
|
|
self.assertEqual(
|
|
self.missing_assets(self.assets - {missing_asset}),
|
|
[
|
|
(
|
|
"dotslash-provisioned-config.json",
|
|
"codex-provisioned",
|
|
f"macos-{arch}",
|
|
)
|
|
],
|
|
)
|
|
|
|
|
|
class StablePublicationTests(unittest.TestCase):
|
|
def test_failed_alpha_upload_cleanup_and_rerun(self):
|
|
bash = shutil.which("bash")
|
|
if bash is None:
|
|
self.skipTest("Release workflow requires Bash 4.4 or newer")
|
|
version = subprocess.check_output(
|
|
[bash, "-c", 'echo "${BASH_VERSINFO[0]} ${BASH_VERSINFO[1]}"'],
|
|
text=True,
|
|
)
|
|
if tuple(map(int, version.split())) < (4, 4):
|
|
self.skipTest("Release workflow requires Bash 4.4 or newer")
|
|
|
|
workflow = (
|
|
Path(__file__).resolve().parent.parent / "workflows/rust-release.yml"
|
|
).read_text()
|
|
create = workflow.split(" - name: Create GitHub Release\n", 1)[1]
|
|
create, cleanup = create.split(
|
|
" - name: Remove incomplete prerelease\n", 1
|
|
)
|
|
create = textwrap.dedent(create.split(" run: |\n", 1)[1])
|
|
cleanup = cleanup.split("\n publish-r2-assets:", 1)[0]
|
|
condition = cleanup.split("if: ${{ ", 1)[1].split(" }}", 1)[0]
|
|
# These output comparisons use the same operators in Bash. Run the
|
|
# actual cleanup command even when the preceding publication failed.
|
|
condition = re.sub(
|
|
r"steps\.github_release\.outputs\.(\w+)",
|
|
lambda match: '"${' + match[1] + ':-}"',
|
|
condition.replace("always()", "true"),
|
|
)
|
|
cleanup_command = cleanup.split(" run: ", 1)[1].strip()
|
|
cleanup = (
|
|
'set -euo pipefail\nsource "$GITHUB_OUTPUT"\n'
|
|
f"if [[ {condition} ]]; then\n{cleanup_command}\nfi\n"
|
|
)
|
|
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
directory = Path(tmpdir)
|
|
gh = directory / "gh"
|
|
gh.write_text(
|
|
textwrap.dedent("""\
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
case "$1 $2" in
|
|
'api graphql')
|
|
if [[ -f "$GITHUB_REF_NAME.release" ]]; then echo true; else echo false; fi ;;
|
|
'release create')
|
|
test -f "$GITHUB_REF_NAME.tag"
|
|
printf '%s\\n' "$@" > "$GITHUB_REF_NAME.release" ;;
|
|
'release upload')
|
|
[[ "$FAIL_AT" != upload ]] || exit 7
|
|
touch "$GITHUB_REF_NAME.uploaded" ;;
|
|
'release edit')
|
|
[[ "$FAIL_AT" != edit ]] || exit 8 ;;
|
|
'release delete')
|
|
rm -f "$GITHUB_REF_NAME.release" "$GITHUB_REF_NAME.uploaded"
|
|
if [[ " $* " == *' --cleanup-tag '* ]]; then rm "$GITHUB_REF_NAME.tag"; fi ;;
|
|
*) exit 99 ;;
|
|
esac
|
|
""")
|
|
)
|
|
gh.chmod(0o755)
|
|
(directory / "dist").mkdir()
|
|
(directory / "dist/package.tar.gz").write_bytes(b"package")
|
|
outputs = directory / "outputs"
|
|
tag = "rust-v0.100.0-alpha.1"
|
|
# Fail a new alpha, retry it, fail an existing alpha, then fail only
|
|
# the metadata edit of another new alpha whose assets are complete.
|
|
for release_tag, fail_at, expected_status, remains_public in (
|
|
(tag, "upload", 7, False),
|
|
(tag, "", 0, True),
|
|
(tag, "upload", 7, True),
|
|
("rust-v0.100.0-alpha.2", "edit", 8, True),
|
|
):
|
|
with self.subTest(tag=release_tag, fail_at=fail_at):
|
|
(directory / f"{release_tag}.tag").touch()
|
|
outputs.write_text("")
|
|
env = {
|
|
**os.environ,
|
|
"PATH": f"{directory}{os.pathsep}{os.environ['PATH']}",
|
|
"GITHUB_OUTPUT": str(outputs),
|
|
"GITHUB_REPOSITORY": "test/codex",
|
|
"GITHUB_REPOSITORY_OWNER": "test",
|
|
"GITHUB_REF_NAME": release_tag,
|
|
"RELEASE_NAME": release_tag.removeprefix("rust-v"),
|
|
"RELEASE_NOTES": "notes.md",
|
|
"MAKE_LATEST": "false",
|
|
"PRERELEASE": "true",
|
|
"FAIL_AT": fail_at,
|
|
}
|
|
result = subprocess.run(
|
|
[bash, "-c", create],
|
|
cwd=directory,
|
|
env=env,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
self.assertEqual(result.returncode, expected_status, result.stderr)
|
|
release = directory / f"{release_tag}.release"
|
|
self.assertIn("--draft=false", release.read_text().splitlines())
|
|
subprocess.run(
|
|
[bash, "-c", cleanup], cwd=directory, env=env, check=True
|
|
)
|
|
self.assertTrue((directory / f"{release_tag}.tag").exists())
|
|
self.assertEqual(release.exists(), remains_public)
|
|
self.assertEqual(
|
|
(directory / f"{release_tag}.uploaded").exists(), remains_public
|
|
)
|
|
|
|
def test_github_latest_orders_numerically_and_allows_equal_reruns(self):
|
|
latest = {"tag_name": "rust-v0.100.0", "draft": False, "prerelease": False}
|
|
self.assertFalse(should_make_latest("0.99.9", latest))
|
|
self.assertTrue(should_make_latest("0.100.0", latest))
|
|
self.assertTrue(should_make_latest("0.101.0", latest))
|
|
|
|
def test_github_latest_rejects_unpublished_or_unreadable_metadata(self):
|
|
for latest in (
|
|
{},
|
|
{"tag_name": "rust-vunknown", "draft": False, "prerelease": False},
|
|
{"tag_name": "rust-v0.100.0", "draft": True, "prerelease": False},
|
|
{"tag_name": "rust-v0.100.0", "draft": False, "prerelease": True},
|
|
):
|
|
with self.subTest(latest=latest):
|
|
with self.assertRaises(ValueError):
|
|
should_make_latest("0.99.9", latest)
|
|
|
|
def test_r2_checks_its_channel_and_only_repairs_unreadable_prereleases(self):
|
|
with patch.object(r2, "run_command") as command:
|
|
command.return_value = '{"tag_name":"rust-v0.100.0"}'
|
|
self.assertFalse(r2.should_update_channel("endpoint", "0.99.9", "latest"))
|
|
self.assertTrue(r2.should_update_channel("endpoint", "0.100.0", "latest"))
|
|
self.assertIn(
|
|
"s3://releases/codex/channels/latest", command.call_args.args[0]
|
|
)
|
|
command.return_value = "invalid"
|
|
with self.assertRaises(r2.PublishError):
|
|
r2.should_update_channel("endpoint", "0.99.9", "latest")
|
|
self.assertTrue(
|
|
r2.should_update_channel("endpoint", "0.99.9-alpha.1", "prerelease")
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|