Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/agentex/lib/sdk/config/agent_manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from agentex.lib.utils.io import load_yaml_file
from agentex.lib.utils.logging import make_logger
from agentex.config.agent_manifest import AgentManifest # noqa: F401
from agentex.lib.utils.build_provenance import iter_context_files

logger = make_logger(__name__)

Expand Down Expand Up @@ -189,12 +190,11 @@ def zipped(root_path: Path | None = None) -> Iterator[IO[bytes]]:

tar_buffer = io.BytesIO()

# Sorted, relpath-stable enumeration (shared with the content hash) so the
# archive's member order is deterministic across machines.
with tarfile.open(fileobj=tar_buffer, mode="w:gz") as tar_file:
for path in Path(root_path).rglob(
"*"
): # Recursively add files to the tar.gz
if path.is_file(): # Ensure that we're only adding files
tar_file.add(path, arcname=path.relative_to(root_path))
for path in iter_context_files(Path(root_path)):
tar_file.add(path, arcname=path.relative_to(root_path))

tar_buffer.seek(0) # Reset the buffer position to the beginning
yield tar_buffer
Expand Down
234 changes: 234 additions & 0 deletions src/agentex/lib/utils/build_provenance.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
"""Client-attested build provenance capture (AGX1-418).

The single producer of source identity for agent builds: git coordinates plus a
deterministic content hash of the build context. Every build path (CLI, sgpctl,
CI) imports this so capture logic and the ``working_tree_hash`` definition live
in exactly one place. Capture is best-effort — a missing/odd git state degrades
to nulls and never raises into a build.
"""

from __future__ import annotations

import os
import stat
import hashlib
import subprocess
from typing import Optional
from pathlib import Path
from datetime import datetime, timezone
from dataclasses import dataclass

from agentex.lib.utils.logging import make_logger

logger = make_logger(__name__)

_GIT_TIMEOUT_S = 5
_HASH_CHUNK_BYTES = 1 << 20


@dataclass(frozen=True)
class BuildProvenance:
"""Source identity for one build; every field degrades to ``None``.

``working_tree_hash`` is the deterministic content hash of the build context
and is always computed — it identifies the exact bytes that shipped,
independent of git state. ``commit`` (+ ``ref`` / ``repo``) anchor those bytes
to source, and ``dirty`` records whether the work tree had uncommitted changes
at build time (``None`` outside a git work tree).
"""

repo: Optional[str] = None
commit: Optional[str] = None
ref: Optional[str] = None
subpath: Optional[str] = None
working_tree_hash: Optional[str] = None
dirty: Optional[bool] = None
author_name: Optional[str] = None
author_email: Optional[str] = None
build_timestamp: Optional[str] = None

def source_fields(self) -> dict[str, object]:
"""The ``source_*`` form fields for the cloud-build upload (None omitted)."""
fields = {
"source_repo": self.repo,
"source_commit": self.commit,
"source_ref": self.ref,
"source_subpath": self.subpath,
"working_tree_hash": self.working_tree_hash,
"source_dirty": self.dirty,
}
return {key: value for key, value in fields.items() if value is not None}

def build_info(self) -> dict[str, object]:
"""The ``build-info.json`` payload (runtime ``registration_metadata``).

Overlapping keys match the server's ``DeploymentHistory`` type
(``commit_hash`` / ``branch_name`` / ``author_*`` / ``build_timestamp``),
which is populated from ``registration_metadata``; the rest are the
provenance-specific coordinates.
"""
info = {
"repo": self.repo,
"commit_hash": self.commit,
"branch_name": self.ref,
"subpath": self.subpath,
"working_tree_hash": self.working_tree_hash,
"dirty": self.dirty,
"author_name": self.author_name,
"author_email": self.author_email,
"build_timestamp": self.build_timestamp,
}
return {key: value for key, value in info.items() if value is not None}


def _git(repo_root: Path, *args: str) -> Optional[str]:
"""Run a git command under ``repo_root``; return stripped stdout or None."""
try:
proc = subprocess.run(
("git", "-C", str(repo_root), *args),
capture_output=True,
text=True,
timeout=_GIT_TIMEOUT_S,
check=False,
)
except (OSError, subprocess.SubprocessError):
return None
if proc.returncode != 0:
return None
return proc.stdout.strip() or None


def normalize_remote(url: Optional[str]) -> Optional[str]:
"""Canonicalize a git remote to ``host/path`` — credentials and scheme stripped.

``git@github.com:org/repo.git`` and ``https://x:tok@github.com/org/repo.git``
both normalize to ``github.com/org/repo``. Host is lowercased; path casing is
preserved (repo paths can be case-significant).
"""
if not url:
return None
candidate = url.strip()
# scp-like syntax: git@host:org/repo(.git) — no scheme, host/path split on ':'
if "://" not in candidate and ":" in candidate and "/" not in candidate.split(":", 1)[0]:
candidate = candidate.split("@", 1)[-1].replace(":", "/", 1)
else:
if "://" in candidate:
candidate = candidate.split("://", 1)[1]
candidate = candidate.split("@", 1)[-1]
if candidate.endswith(".git"):
candidate = candidate[: -len(".git")]
candidate = candidate.strip("/")
if not candidate:
return None
host, slash, path = candidate.partition("/")
return f"{host.lower()}{slash}{path}"


def _sha256_file(path: Path) -> str:
digest = hashlib.sha256()
with open(path, "rb") as handle:
while chunk := handle.read(_HASH_CHUNK_BYTES):
digest.update(chunk)
return digest.hexdigest()


def iter_context_files(root: Path) -> list[Path]:
"""Files (and symlinks) under ``root``, sorted by POSIX relpath.

The canonical, order-stable enumeration shared by the content hash and the
archive packer so the two can never drift on which files they cover.
"""
return sorted(
(path for path in root.rglob("*") if path.is_symlink() or path.is_file()),
key=lambda path: path.relative_to(root).as_posix(),
)


def working_tree_hash(root: Path) -> str:
"""Deterministic content hash of the build context at ``root``.

sha256 over the sorted ``(relpath, normalized mode, content digest)`` of every
file — the build *inputs*, not the tarball (tar/gzip framing is
non-deterministic and would defeat dedupe). Mode is normalized to the
executable bit; symlinks hash their target string, not the resolved content.
"""
lines: list[str] = []
for path in iter_context_files(root):
relpath = path.relative_to(root).as_posix()
if path.is_symlink():
mode = "120000"
content_digest = hashlib.sha256(os.readlink(path).encode("utf-8")).hexdigest()
else:
executable = bool(path.stat().st_mode & stat.S_IXUSR)
mode = "100755" if executable else "100644"
content_digest = _sha256_file(path)
lines.append(f"{relpath}\x00{mode}\x00{content_digest}")
return hashlib.sha256("\n".join(lines).encode("utf-8")).hexdigest()


def _safe_working_tree_hash(root: Path) -> Optional[str]:
"""``working_tree_hash`` that degrades to None — capture must never fail a build.

A permission error or filesystem race during the walk/stat/read would otherwise
raise out of capture and abort the build before the archive is even created.
"""
try:
return working_tree_hash(root)
except Exception:
logger.warning("build-provenance: content hash failed; omitting", exc_info=True)
return None


def capture_build_provenance(
repo_path: Path, context_root: Path, content_root: Optional[Path] = None
) -> BuildProvenance:
"""Capture source identity for a build of ``context_root``.

``repo_path`` is where git is interrogated and ``subpath`` is ``context_root``
relative to the repo root (which agent, in a monorepo). ``content_root`` is
the directory hashed — the *staged*, post-``.dockerignore`` tree that actually
ships; it defaults to ``context_root`` when there is no separate staging dir.
``working_tree_hash`` is always computed; git coordinates anchor it to source
when available.
"""
timestamp = datetime.now(timezone.utc).isoformat()
hash_root = content_root if content_root is not None else context_root
tree_hash = _safe_working_tree_hash(hash_root)

repo_root = _git(repo_path, "rev-parse", "--show-toplevel")
if repo_root is None:
# No git — the content hash is the only identity available.
logger.info("build-provenance: %s is not a git work tree; content hash only", repo_path)
return BuildProvenance(working_tree_hash=tree_hash, build_timestamp=timestamp)

repo_root_path = Path(repo_root)
commit = _git(repo_root_path, "rev-parse", "HEAD")
# symbolic-ref fails on a detached HEAD (→ None); fall back to an exact tag.
ref = _git(repo_root_path, "symbolic-ref", "--short", "HEAD") or _git(
repo_root_path, "describe", "--tags", "--exact-match"
)
remote = normalize_remote(_git(repo_root_path, "remote", "get-url", "origin"))
author_name = _git(repo_root_path, "log", "-1", "--format=%an")
author_email = _git(repo_root_path, "log", "-1", "--format=%ae")

subpath: Optional[str] = None
try:
relative = context_root.resolve().relative_to(repo_root_path.resolve()).as_posix()
subpath = relative if relative != "." else None
except ValueError:
subpath = None

# `git status --porcelain` is empty (→ _git returns None) for a clean tree.
dirty = _git(repo_root_path, "status", "--porcelain") is not None

return BuildProvenance(
repo=remote,
commit=commit,
ref=ref,
subpath=subpath,
working_tree_hash=tree_hash,
dirty=dirty,
author_name=author_name,
author_email=author_email,
build_timestamp=timestamp,
)
Loading
Loading