mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
Eliminates the dual-package architecture that was the root cause of #355. `pip install headroom-ai` now produces ONE wheel containing both the Python source (headroom/*.py) and the compiled Rust extension (headroom/_core.so). No more separate `headroom-core-py` package, no more chicken-and-egg with PyPI publication, no more wheelhouse / PIP_FIND_LINKS / composite-action plumbing in CI. This is the canonical pattern used by cryptography, polars, ruff, pydantic-core, and other Rust-as-core Python packages. Honors the "Rust as core engine" direction. ## What changed - pyproject.toml: `[build-system]` swapped from hatchling to maturin. `[tool.hatch.*]` deleted; `[tool.maturin]` added pointing at `crates/headroom-py/Cargo.toml` for the cdylib. `python-source = "."` picks up the root `headroom/` package directly (dashboard HTML templates and other non-Python files included automatically). - crates/headroom-py/pyproject.toml: deleted. The crate is no longer a separate published package; its Cargo.toml stays as the cdylib build target invoked via `[tool.maturin] manifest-path`. - crates/headroom-py/python/: deleted (placeholder layout for the old separate package). ## CI updates - ci.yml: `test` / `test-extras` / `test-agno` jobs simplified — Rust toolchain set up before `pip install -e .` (which now invokes maturin via build-system). Removed the "build wheel + symlink .so" dance. `build` job swapped from `python -m build` (hatch) to `maturin build` + `maturin sdist`. - release.yml: collapsed dual-package matrix into one. New `build-wheels` matrix produces cross-platform wheels for cp310/11/12/13 × {linux x86_64, linux aarch64, macos x86_64, macos aarch64}. New `collect-dist` aggregator merges artifacts. publish-pypi consumes the merged dist. - init-native-e2e.yml: dropped windows-latest from the matrix — upstream `esaxx-rs` (/MT) and `ort-sys` (/MD) link with conflicting MSVC C runtime libraries, so the Rust extension cannot build for win_amd64 today. Tracked as a follow-up; not a blocker for Linux+macOS. - headroom-e2e-setup: composite action now sets up Rust toolchain + Swatinem/rust-cache before `pip install -e .[proxy]`. - eval.yml, publish.yml, rust.yml: same pattern — rust toolchain before install. rust.yml's wheels job builds from root pyproject.toml (no more `-m crates/headroom-py/Cargo.toml`). - e2e/init/Dockerfile, e2e/wrap/Dockerfile: install rust + maturin in the build stage; copy `crates/` + workspace `Cargo.toml/lock` so the install can build the extension. Dropped `HEADROOM_REQUIRE_RUST_CORE=false` from wrap-e2e — the image now ships the full Rust core. - Dockerfile (main): simplified — no more Layer 2/3 dance with `headroom-core-py` install + symlink. Single `uv pip install` builds + installs everything. - .devcontainer/Dockerfile: rust toolchain + libssl-dev + maturin added so `uv sync` builds the extension inside the devcontainer. ## Lockfile + script - uv.lock: regenerated. No `headroom-core-py` entries remain. - scripts/build_rust_extension.sh: simplified from a symlink-into-tree workaround to a thin wrapper around `pip install -e .`. The maturin build-backend handles placement automatically. ## Local validation (all green on macOS aarch64) 1. Clean venv `pip install -e .` → `from headroom._core import …` works. 2. `maturin build --release` → 13.8 MB wheel, 336 files including `headroom/_core.cpython-311-darwin.so` (32 MB cdylib) and `headroom/dashboard/templates/dashboard.html`. 3. `pip install <wheel>` in fresh venv → import works. 4. Wheel contents verified via `unzip -l`. 5. `pytest tests/test_transforms/test_diff_compressor.py` — 29 passed. 6. `pytest tests/test_relevance.py` — 30 passed. 7. `cargo build --workspace` + `cargo test --workspace` — all green. 8. `make ci-precheck` — 176 Python tests + Rust + commitlint green. ## Migration notes Users on `pip install headroom-ai` get the Rust core automatically (linux + macos wheels). sdist installs require rust toolchain available locally — pip will build via maturin. Closes #355 Supersedes #357 (workarounds-based fix abandoned in favor of architectural fix)
139 lines
5.3 KiB
YAML
139 lines
5.3 KiB
YAML
name: Init Native E2E
|
|
|
|
# Cross-platform (linux / macos / windows) smoke tests for the per-subcommand
|
|
# ``headroom init -g <target>`` flows. Each matrix cell drops a noop shim for
|
|
# the target agent onto PATH and asserts ``headroom init -g <target>``
|
|
# succeeds, writes the expected settings file, and (for claude/codex) places
|
|
# hooks in the right place.
|
|
#
|
|
# Deliberately scoped to pull_request + push-to-main + workflow_dispatch to
|
|
# avoid bloating CI minutes on every push to every feature branch. The Docker
|
|
# init-e2e.yml still runs on every PR and provides the deeper functional
|
|
# coverage; this workflow exists to catch platform-specific bugs (Windows
|
|
# path separators, macos keychain prompts, PowerShell-vs-bash hook matchers)
|
|
# that the single-platform Docker suite can miss.
|
|
#
|
|
# Extending to other commands (``headroom install``, ``headroom wrap``) is
|
|
# expected to be a near-copy of this file. The shared composite action at
|
|
# ``.github/actions/headroom-e2e-setup`` absorbs the Python + shim setup so
|
|
# each per-command workflow only supplies its matrix and assertion steps.
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
paths:
|
|
- "headroom/cli/init.py"
|
|
- "headroom/install/**"
|
|
- "e2e/_lib/**"
|
|
- "e2e/init/**"
|
|
- ".github/actions/headroom-e2e-setup/**"
|
|
- ".github/workflows/init-native-e2e.yml"
|
|
push:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
init-native:
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 25
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
# Windows is excluded today: upstream `esaxx-rs` (transitively from
|
|
# `tokenizers`) and `ort-sys` (onnxruntime via `fastembed`) link
|
|
# with conflicting MSVC C runtime libraries (/MT vs /MD), so the
|
|
# Rust extension cannot build for `win_amd64` until the upstream
|
|
# CRT conflict is resolved. Re-add `windows-latest` once the wheel
|
|
# builds cleanly there. Tracked in the project plan; not a blocker
|
|
# for headroom-ai installs on Linux + macOS.
|
|
os: [ubuntu-latest, macos-latest]
|
|
target: [claude, codex, copilot, openclaw]
|
|
exclude:
|
|
# openclaw delegates to ``headroom wrap openclaw`` which needs a
|
|
# running OpenClaw CLI; it can't be shimmed cheaply, so it's
|
|
# covered by the bundled Docker e2e instead.
|
|
- target: openclaw
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Setup (shim=${{ matrix.target }})
|
|
uses: ./.github/actions/headroom-e2e-setup
|
|
with:
|
|
python-version: "3.11"
|
|
shim-target: ${{ matrix.target }}
|
|
|
|
- name: Verify shim is on PATH (POSIX)
|
|
if: runner.os != 'Windows'
|
|
shell: bash
|
|
run: |
|
|
which "${{ matrix.target }}"
|
|
|
|
- name: Verify shim is on PATH (Windows)
|
|
if: runner.os == 'Windows'
|
|
shell: pwsh
|
|
run: |
|
|
# On Windows the shim is ``<target>.cmd``; Get-Command resolves via
|
|
# PATHEXT (same as Python's ``shutil.which`` used by headroom init).
|
|
# Git Bash's ``which`` cannot find ``.cmd`` shims, so we use pwsh.
|
|
$cmd = Get-Command "${{ matrix.target }}" -ErrorAction Stop
|
|
Write-Output $cmd.Source
|
|
|
|
- name: Run headroom init -g ${{ matrix.target }}
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
headroom init -g "${{ matrix.target }}"
|
|
|
|
- name: Assert settings file (POSIX)
|
|
if: runner.os != 'Windows'
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
case "${{ matrix.target }}" in
|
|
claude)
|
|
test -f "$HOME/.claude/settings.json"
|
|
grep -q "ANTHROPIC_BASE_URL" "$HOME/.claude/settings.json"
|
|
;;
|
|
codex)
|
|
test -f "$HOME/.codex/config.toml"
|
|
test -f "$HOME/.codex/hooks.json"
|
|
grep -q "headroom" "$HOME/.codex/config.toml"
|
|
;;
|
|
copilot)
|
|
test -f "$HOME/.copilot/config.json"
|
|
grep -q "SessionStart" "$HOME/.copilot/config.json"
|
|
;;
|
|
esac
|
|
|
|
- name: Assert settings file (Windows)
|
|
if: runner.os == 'Windows'
|
|
shell: pwsh
|
|
run: |
|
|
$ErrorActionPreference = "Stop"
|
|
$home_ = $env:USERPROFILE
|
|
switch ("${{ matrix.target }}") {
|
|
"claude" {
|
|
$p = Join-Path $home_ ".claude\settings.json"
|
|
if (-not (Test-Path $p)) { throw "Missing $p" }
|
|
if (-not ((Get-Content $p -Raw) -match "ANTHROPIC_BASE_URL")) {
|
|
throw "settings.json missing ANTHROPIC_BASE_URL"
|
|
}
|
|
}
|
|
"codex" {
|
|
$c = Join-Path $home_ ".codex\config.toml"
|
|
$h = Join-Path $home_ ".codex\hooks.json"
|
|
if (-not (Test-Path $c)) { throw "Missing $c" }
|
|
if (-not (Test-Path $h)) { throw "Missing $h" }
|
|
if (-not ((Get-Content $c -Raw) -match "headroom")) {
|
|
throw "config.toml missing headroom provider"
|
|
}
|
|
}
|
|
"copilot" {
|
|
$p = Join-Path $home_ ".copilot\config.json"
|
|
if (-not (Test-Path $p)) { throw "Missing $p" }
|
|
if (-not ((Get-Content $p -Raw) -match "SessionStart")) {
|
|
throw "copilot config missing SessionStart hooks"
|
|
}
|
|
}
|
|
}
|