mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
772adc93b2
## Description Fixes a typo in the release metadata filename written by `scripts/version-sync.py`. The file was being created as `.releaseetadata` (double `e`) instead of `.releasemetadata`. Any downstream tooling or developer looking for the artifact by its correct name would not find it. Closes # ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `scripts/version-sync.py`: corrected the filename in `write_release_metadata()` — both the docstring and the `metadata_path` assignment. - `scripts/tests/test_version_sync.py`: updated 3 test assertions to reference `.releasemetadata`. ## Testing - [x] Unit tests pass (`pytest`) - [ ] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) - [ ] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text $ uv run python -m pytest scripts/tests/test_version_sync.py -q ============================= test session starts ============================== platform linux -- Python 3.14.0, pytest-9.1.1, pluggy-1.6.0 rootdir: /home/sepurisaikrishna/Documents/calude-here/headroom configfile: pyproject.toml collected 6 items scripts/tests/test_version_sync.py ...... [100%] =============================== warnings summary =============================== PytestConfigWarning: Unknown config option: asyncio_mode -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html ========================= 6 passed, 1 warning in 1.00s ========================= $ git diff --check origin/main..HEAD # no output; command exited 0 ``` ## Real Behavior Proof - Environment: Linux, Python 3.14.0, uv-managed .venv, branch based on current origin/main. - Exact command / steps: grep -r "releaseetadata" scripts/ before the fix returns hits; after the fix returns nothing. Confirmed .releasemetadata is written correctly by test_release_metadata_written. - Observed result: all 6 test_version_sync.py tests pass with the corrected filename. - Not tested: full repository pytest, ruff, and mypy — this is a one-line spelling fix with no logic changes. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A. ## Additional Notes - The typo was consistent across implementation and tests, so all tests passed before this fix with the wrong name. The fix corrects both the code and the test expectations together. - No production behaviour changes the file is written but not yet consumed by any workflow step.
291 lines
10 KiB
Python
291 lines
10 KiB
Python
"""Tests for version-sync.py."""
|
|
|
|
import json
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.fixture
|
|
def temp_project(tmp_path: Path) -> dict[str, Path]:
|
|
"""Create a temporary project with all versioned files."""
|
|
# Create directory structure
|
|
root = tmp_path / "project"
|
|
headroom = root / "headroom"
|
|
headroom.mkdir(parents=True)
|
|
repo_claude_plugin = root / ".claude-plugin"
|
|
repo_claude_plugin.mkdir(parents=True)
|
|
repo_github_plugin = root / ".github" / "plugin"
|
|
repo_github_plugin.mkdir(parents=True)
|
|
plugins = root / "plugins"
|
|
openclaw = plugins / "openclaw"
|
|
openclaw.mkdir(parents=True)
|
|
agent_hooks_claude = plugins / "headroom-agent-hooks" / ".claude-plugin"
|
|
agent_hooks_claude.mkdir(parents=True)
|
|
agent_hooks_github = plugins / "headroom-agent-hooks" / ".github" / "plugin"
|
|
agent_hooks_github.mkdir(parents=True)
|
|
sdk = root / "sdk"
|
|
typescript = sdk / "typescript"
|
|
typescript.mkdir(parents=True)
|
|
|
|
# pyproject.toml
|
|
pyproject = root / "pyproject.toml"
|
|
pyproject.write_text('[project]\nversion = "0.5.25"\n')
|
|
|
|
# headroom/_version.py is runtime-derived and must not be rewritten by version-sync.
|
|
version_py = headroom / "_version.py"
|
|
version_py.write_text('"""Package version metadata."""\n\n__version__ = "0.5.25"\n')
|
|
|
|
# plugins/openclaw/package.json
|
|
openclaw_pkg = openclaw / "package.json"
|
|
openclaw_pkg.write_text(json.dumps({"name": "test", "version": "0.5.25"}))
|
|
|
|
repo_claude_marketplace = repo_claude_plugin / "marketplace.json"
|
|
repo_claude_marketplace.write_text(
|
|
json.dumps(
|
|
{
|
|
"metadata": {"name": "claude-marketplace", "version": "0.1.0"},
|
|
"plugins": [{"name": "headroom-agent-hooks", "version": "0.1.0"}],
|
|
}
|
|
)
|
|
)
|
|
|
|
repo_github_marketplace = repo_github_plugin / "marketplace.json"
|
|
repo_github_marketplace.write_text(
|
|
json.dumps(
|
|
{
|
|
"metadata": {"name": "copilot-marketplace", "version": "0.1.0"},
|
|
"plugins": [{"name": "headroom-agent-hooks", "version": "0.1.0"}],
|
|
}
|
|
)
|
|
)
|
|
|
|
claude_plugin = agent_hooks_claude / "plugin.json"
|
|
claude_plugin.write_text(json.dumps({"name": "headroom-agent-hooks", "version": "0.1.0"}))
|
|
|
|
github_plugin = agent_hooks_github / "plugin.json"
|
|
github_plugin.write_text(json.dumps({"name": "headroom-agent-hooks", "version": "0.1.0"}))
|
|
|
|
# sdk/typescript/package.json
|
|
typescript_pkg = typescript / "package.json"
|
|
typescript_pkg.write_text(json.dumps({"name": "test", "version": "0.5.25"}))
|
|
|
|
return {
|
|
"root": root,
|
|
"pyproject": pyproject,
|
|
"version_py": version_py,
|
|
"openclaw_pkg": openclaw_pkg,
|
|
"repo_claude_marketplace": repo_claude_marketplace,
|
|
"repo_github_marketplace": repo_github_marketplace,
|
|
"claude_plugin": claude_plugin,
|
|
"github_plugin": github_plugin,
|
|
"typescript_pkg": typescript_pkg,
|
|
}
|
|
|
|
|
|
def test_version_sync_explicit_version(temp_project: dict[str, Path]) -> None:
|
|
"""Test --version flag updates all files."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--version", "0.7.0"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify pyproject.toml
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.7.0"' in pyproject_content
|
|
|
|
# Verify headroom/_version.py is not a synced manifest.
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
# Verify plugins/openclaw/package.json
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.7.0"
|
|
|
|
# Verify sdk/typescript/package.json
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.7.0"
|
|
|
|
repo_claude_marketplace = json.loads(temp_project["repo_claude_marketplace"].read_text())
|
|
assert repo_claude_marketplace["metadata"]["version"] == "0.7.0"
|
|
assert repo_claude_marketplace["plugins"][0]["version"] == "0.7.0"
|
|
|
|
repo_github_marketplace = json.loads(temp_project["repo_github_marketplace"].read_text())
|
|
assert repo_github_marketplace["metadata"]["version"] == "0.7.0"
|
|
assert repo_github_marketplace["plugins"][0]["version"] == "0.7.0"
|
|
|
|
claude_plugin = json.loads(temp_project["claude_plugin"].read_text())
|
|
assert claude_plugin["version"] == "0.7.0"
|
|
|
|
github_plugin = json.loads(temp_project["github_plugin"].read_text())
|
|
assert github_plugin["version"] == "0.7.0"
|
|
|
|
# Verify .releasemetadata was created
|
|
release_metadata = root / ".releasemetadata"
|
|
assert release_metadata.exists()
|
|
metadata = json.loads(release_metadata.read_text())
|
|
assert metadata["version"] == "0.7.0"
|
|
assert metadata["packages"]["pypi"] == "0.7.0"
|
|
assert metadata["packages"]["npm-sdk"] == "0.7.0"
|
|
assert metadata["packages"]["npm-openclaw"] == "0.7.0"
|
|
assert metadata["packages"]["agent-hooks-plugin"] == "0.7.0"
|
|
|
|
|
|
def test_bump_patch(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump patch bumps 0.5.25 to 0.5.26."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "patch"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 0.5.26
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.5.26"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.5.26"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.5.26"
|
|
|
|
claude_plugin = json.loads(temp_project["claude_plugin"].read_text())
|
|
assert claude_plugin["version"] == "0.5.26"
|
|
|
|
|
|
def test_bump_minor(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump minor bumps 0.5.25 to 0.6.0."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "minor"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 0.6.0
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.6.0"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.6.0"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.6.0"
|
|
|
|
github_plugin = json.loads(temp_project["github_plugin"].read_text())
|
|
assert github_plugin["version"] == "0.6.0"
|
|
|
|
|
|
def test_bump_major(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump major bumps 0.5.25 to 1.0.0."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "major"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 1.0.0
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "1.0.0"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "1.0.0"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "1.0.0"
|
|
|
|
repo_claude_marketplace = json.loads(temp_project["repo_claude_marketplace"].read_text())
|
|
assert repo_claude_marketplace["metadata"]["version"] == "1.0.0"
|
|
|
|
|
|
def test_release_metadata_written(temp_project: dict[str, Path]) -> None:
|
|
"""Test .releasemetadata is written correctly."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--version", "0.6.0"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
release_metadata = root / ".releasemetadata"
|
|
assert release_metadata.exists()
|
|
|
|
metadata = json.loads(release_metadata.read_text())
|
|
assert metadata == {
|
|
"version": "0.6.0",
|
|
"packages": {
|
|
"pypi": "0.6.0",
|
|
"npm-sdk": "0.6.0",
|
|
"npm-openclaw": "0.6.0",
|
|
"agent-hooks-plugin": "0.6.0",
|
|
},
|
|
}
|
|
|
|
|
|
def test_plugin_manifests_only_leaves_package_versions_unchanged(
|
|
temp_project: dict[str, Path],
|
|
) -> None:
|
|
"""Test plugin-only sync leaves canonical package versions alone."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[
|
|
sys.executable,
|
|
str(script),
|
|
"--root",
|
|
str(root),
|
|
"--version",
|
|
"0.8.0",
|
|
"--plugin-manifests-only",
|
|
],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
assert 'version = "0.5.25"' in temp_project["pyproject"].read_text()
|
|
assert '__version__ = "0.5.25"' in temp_project["version_py"].read_text()
|
|
assert json.loads(temp_project["openclaw_pkg"].read_text())["version"] == "0.5.25"
|
|
assert json.loads(temp_project["typescript_pkg"].read_text())["version"] == "0.5.25"
|
|
assert json.loads(temp_project["claude_plugin"].read_text())["version"] == "0.8.0"
|
|
assert (
|
|
json.loads(temp_project["repo_github_marketplace"].read_text())["metadata"]["version"]
|
|
== "0.8.0"
|
|
)
|
|
assert not (root / ".releasemetadata").exists()
|