Compare commits
75 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ef9f81ba83 | |||
| 913bcab6a0 | |||
| 0bf7f9ece6 | |||
| ebde817896 | |||
| 0b0729562b | |||
| 85e8e1bea2 | |||
| 30e39577c2 | |||
| 08e932805d | |||
| 2f8a7be1b1 | |||
| 1f64e4b6be | |||
| 90522d335a | |||
| adeb581cdf | |||
| 29c46356ef | |||
| 8fed02fd1e | |||
| a7b2befc06 | |||
| 6fdf090469 | |||
| d32e9cc3c3 | |||
| ef89ed084f | |||
| ccd987a501 | |||
| 2cd44cf79a | |||
| 8a1b833aaa | |||
| 3b5c55bc8e | |||
| 95220b4808 | |||
| b032562d74 | |||
| 1d925172ec | |||
| f6ae485b68 | |||
| e3258d0683 | |||
| 0ff11d8ed7 | |||
| a970f974a2 | |||
| c845d3fed4 | |||
| c6a9419b95 | |||
| 36fb019007 | |||
| adc033a902 | |||
| 21b253c7eb | |||
| d4e2bc5f93 | |||
| 4998a5ec6a | |||
| efd413c1ba | |||
| d3d468532f | |||
| ad2927b3b1 | |||
| 2582373490 | |||
| 17ac1be93b | |||
| c53254e9d5 | |||
| 58ecd8cb90 | |||
| 310b36196d | |||
| c473e5e5d8 | |||
| 137426d9ac | |||
| 2a3a7dfb5c | |||
| 16c12177d2 | |||
| 0f1734b823 | |||
| 2bf28e03f4 | |||
| d3428b8c14 | |||
| 4199de5e3e | |||
| 8348714e3e | |||
| 26002b75ca | |||
| 0c91c75a05 | |||
| 8ce8a8cc62 | |||
| 3fba385513 | |||
| b25cd72fc3 | |||
| 8e43c26ab4 | |||
| 14ff4fe186 | |||
| cae1215f63 | |||
| 28766d7733 | |||
| 819f967844 | |||
| 2f45f5afec | |||
| 31a5ec2fc8 | |||
| 1f192d785a | |||
| 853b6d1678 | |||
| cf9a53d582 | |||
| 0b36c3eb48 | |||
| 28fcc3f2d2 | |||
| 571030b8e8 | |||
| 288b205a44 | |||
| 0c1d27b605 | |||
| 69361114d1 | |||
| e4d53fd360 |
+63
-19
@@ -1,4 +1,5 @@
|
|||||||
# Run the project's test suite on every PR push and on push to main.
|
# Run the project's test suite when package or runtime inputs change on a PR
|
||||||
|
# or on push to main.
|
||||||
#
|
#
|
||||||
# The suite uses stdlib `unittest` discovery — no external Python
|
# The suite uses stdlib `unittest` discovery — no external Python
|
||||||
# dependencies are required to execute it. Tests are split by directory:
|
# dependencies are required to execute it. Tests are split by directory:
|
||||||
@@ -23,22 +24,34 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- '**.py'
|
- 'bot_bottle/**'
|
||||||
- '.gitea/workflows/**.yml'
|
- 'tests/**/*.py'
|
||||||
- 'scripts/**'
|
- 'cli.py'
|
||||||
- 'README.md'
|
- 'scripts/coverage.sh'
|
||||||
# Dockerfiles and pyproject.toml are baked into the infra rootfs; a
|
- 'scripts/critical-modules.txt'
|
||||||
# change here alters what the integration/coverage jobs build locally.
|
- 'scripts/diff_coverage.py'
|
||||||
|
- 'scripts/tracker_policy.py'
|
||||||
|
- 'scripts/firecracker-netpool.sh'
|
||||||
- 'Dockerfile*'
|
- 'Dockerfile*'
|
||||||
- 'pyproject.toml'
|
- 'pyproject.toml'
|
||||||
|
- 'requirements-dev.txt'
|
||||||
|
- '.coveragerc'
|
||||||
|
- '.dockerignore'
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- '**.py'
|
- 'bot_bottle/**'
|
||||||
- '.gitea/workflows/**.yml'
|
- 'tests/**/*.py'
|
||||||
- 'scripts/**'
|
- 'cli.py'
|
||||||
- 'README.md'
|
- 'scripts/coverage.sh'
|
||||||
|
- 'scripts/critical-modules.txt'
|
||||||
|
- 'scripts/diff_coverage.py'
|
||||||
|
- 'scripts/tracker_policy.py'
|
||||||
|
- 'scripts/firecracker-netpool.sh'
|
||||||
- 'Dockerfile*'
|
- 'Dockerfile*'
|
||||||
- 'pyproject.toml'
|
- 'pyproject.toml'
|
||||||
|
- 'requirements-dev.txt'
|
||||||
|
- '.coveragerc'
|
||||||
|
- '.dockerignore'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -57,16 +70,27 @@ jobs:
|
|||||||
run: python3 -m pip install --break-system-packages -r requirements-dev.txt
|
run: python3 -m pip install --break-system-packages -r requirements-dev.txt
|
||||||
|
|
||||||
- name: Run unit tests with coverage
|
- name: Run unit tests with coverage
|
||||||
run: python3 -m coverage run --data-file=.coverage.unit -m unittest discover -t . -s tests/unit -v
|
env:
|
||||||
|
COVERAGE_FILE: ${{ github.workspace }}/.coverage.unit
|
||||||
|
run: python3 -m coverage run -m unittest discover -t . -s tests/unit -v
|
||||||
|
|
||||||
- name: Report unit coverage
|
- name: Report unit coverage
|
||||||
run: python3 -m coverage report --data-file=.coverage.unit -m
|
env:
|
||||||
|
COVERAGE_FILE: ${{ github.workspace }}/.coverage.unit
|
||||||
|
run: python3 -m coverage report -m
|
||||||
|
|
||||||
|
# upload-artifact@v3's glob skips dotfiles, so a bare `.coverage.unit`
|
||||||
|
# silently uploads nothing ("No files were found"). Stage it under a
|
||||||
|
# non-dot name; the coverage job renames it back before `coverage
|
||||||
|
# combine`. `cp` also fails loudly if coverage never wrote the file.
|
||||||
|
- name: Stage unit coverage for upload
|
||||||
|
run: cp .coverage.unit coverage-unit.dat
|
||||||
|
|
||||||
- name: Upload unit coverage artifact
|
- name: Upload unit coverage artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: coverage-unit
|
name: coverage-unit
|
||||||
path: ${{ github.workspace }}/.coverage.unit
|
path: coverage-unit.dat
|
||||||
|
|
||||||
integration-docker:
|
integration-docker:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -91,13 +115,18 @@ jobs:
|
|||||||
- name: Run integration tests (docker) with coverage
|
- name: Run integration tests (docker) with coverage
|
||||||
env:
|
env:
|
||||||
BOT_BOTTLE_BACKEND: docker
|
BOT_BOTTLE_BACKEND: docker
|
||||||
run: python3 -m coverage run --data-file=.coverage.docker -m unittest discover -t . -s tests/integration -v
|
COVERAGE_FILE: ${{ github.workspace }}/.coverage.docker
|
||||||
|
run: python3 -m coverage run -m unittest discover -t . -s tests/integration -v
|
||||||
|
|
||||||
|
# Non-dot name so upload-artifact's dotfile-skipping glob picks it up.
|
||||||
|
- name: Stage docker coverage for upload
|
||||||
|
run: cp .coverage.docker coverage-docker.dat
|
||||||
|
|
||||||
- name: Upload docker coverage artifact
|
- name: Upload docker coverage artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: coverage-docker
|
name: coverage-docker
|
||||||
path: ${{ github.workspace }}/.coverage.docker
|
path: coverage-docker.dat
|
||||||
|
|
||||||
# Integration tests against the Firecracker backend. Runs on a self-hosted
|
# Integration tests against the Firecracker backend. Runs on a self-hosted
|
||||||
# KVM runner (label `kvm`) where /dev/kvm and the TAP/nft pool are available.
|
# KVM runner (label `kvm`) where /dev/kvm and the TAP/nft pool are available.
|
||||||
@@ -139,7 +168,7 @@ jobs:
|
|||||||
- name: Build infra candidate from this checkout
|
- name: Build infra candidate from this checkout
|
||||||
env:
|
env:
|
||||||
BOT_BOTTLE_FC_DROPBEAR: /var/cache/bot-bottle-fc/dropbear
|
BOT_BOTTLE_FC_DROPBEAR: /var/cache/bot-bottle-fc/dropbear
|
||||||
run: python3 -m bot_bottle.backend.firecracker.publish_infra --output infra-candidate
|
run: python3 -m bot_bottle.backend.firecracker.publish_infra --output infra-candidate --reuse-published
|
||||||
|
|
||||||
- name: Replace the persistent infra VM with the candidate
|
- name: Replace the persistent infra VM with the candidate
|
||||||
run: python3 -c 'from bot_bottle.backend.firecracker import infra_vm; infra_vm.stop()'
|
run: python3 -c 'from bot_bottle.backend.firecracker import infra_vm; infra_vm.stop()'
|
||||||
@@ -151,13 +180,18 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
BOT_BOTTLE_BACKEND: firecracker
|
BOT_BOTTLE_BACKEND: firecracker
|
||||||
BOT_BOTTLE_INFRA_ARTIFACT_DIR: ${{ github.workspace }}/infra-candidate
|
BOT_BOTTLE_INFRA_ARTIFACT_DIR: ${{ github.workspace }}/infra-candidate
|
||||||
run: python3 -m coverage run --data-file=.coverage.firecracker -m unittest discover -t . -s tests/integration -v
|
COVERAGE_FILE: ${{ github.workspace }}/.coverage.firecracker
|
||||||
|
run: python3 -m coverage run -m unittest discover -t . -s tests/integration -v
|
||||||
|
|
||||||
|
# Non-dot name so upload-artifact's dotfile-skipping glob picks it up.
|
||||||
|
- name: Stage firecracker coverage for upload
|
||||||
|
run: cp .coverage.firecracker coverage-firecracker.dat
|
||||||
|
|
||||||
- name: Upload firecracker coverage artifact
|
- name: Upload firecracker coverage artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: coverage-firecracker
|
name: coverage-firecracker
|
||||||
path: ${{ github.workspace }}/.coverage.firecracker
|
path: coverage-firecracker.dat
|
||||||
|
|
||||||
# Only upload the large rootfs artifact on main-branch pushes;
|
# Only upload the large rootfs artifact on main-branch pushes;
|
||||||
# PRs avoid the ~194 MB transfer. publish-infra only runs on main
|
# PRs avoid the ~194 MB transfer. publish-infra only runs on main
|
||||||
@@ -181,6 +215,8 @@ jobs:
|
|||||||
#
|
#
|
||||||
# Runs on ubuntu-latest — no KVM needed, no test reruns. Coverage files use
|
# Runs on ubuntu-latest — no KVM needed, no test reruns. Coverage files use
|
||||||
# relative_files = True (.coveragerc) so they combine cleanly across runners.
|
# relative_files = True (.coveragerc) so they combine cleanly across runners.
|
||||||
|
# Each test job sets COVERAGE_FILE to an absolute path so coverage.py writes
|
||||||
|
# to a known location that upload-artifact can find regardless of runner env.
|
||||||
#
|
#
|
||||||
# Restricted to the same events as integration-firecracker: it depends on
|
# Restricted to the same events as integration-firecracker: it depends on
|
||||||
# that job's coverage artifact and skips for fork PRs alongside it.
|
# that job's coverage artifact and skips for fork PRs alongside it.
|
||||||
@@ -220,6 +256,14 @@ jobs:
|
|||||||
name: coverage-firecracker
|
name: coverage-firecracker
|
||||||
path: ${{ github.workspace }}
|
path: ${{ github.workspace }}
|
||||||
|
|
||||||
|
# Rename the non-dot upload names back to the .coverage.* files that
|
||||||
|
# `coverage combine` discovers (see the staging steps in each test job).
|
||||||
|
- name: Reassemble coverage data files
|
||||||
|
run: |
|
||||||
|
mv coverage-unit.dat .coverage.unit
|
||||||
|
mv coverage-docker.dat .coverage.docker
|
||||||
|
mv coverage-firecracker.dat .coverage.firecracker
|
||||||
|
|
||||||
- name: Combined coverage (unit + integration, incl. firecracker)
|
- name: Combined coverage (unit + integration, incl. firecracker)
|
||||||
run: PYTHON=python3 bash scripts/coverage.sh aggregate critical
|
run: PYTHON=python3 bash scripts/coverage.sh aggregate critical
|
||||||
|
|
||||||
|
|||||||
@@ -14,11 +14,14 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
update-badges:
|
update-badges:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.BADGE_PUSH_TOKEN }}
|
||||||
|
|
||||||
# No actions/setup-python: the runner image ships Python 3.12 and older
|
# No actions/setup-python: the runner image ships Python 3.12 and older
|
||||||
# act_runner engines mishandle setup-python's PATH. Install into the
|
# act_runner engines mishandle setup-python's PATH. Install into the
|
||||||
|
|||||||
+13
-36
@@ -1,45 +1,22 @@
|
|||||||
# Firecracker single infra-VM image (PRD 0070 Stage B).
|
# Shared infra image: gateway data plane + orchestrator control plane.
|
||||||
#
|
#
|
||||||
# The per-host infra VM runs the orchestrator control plane, the gateway
|
# Used directly by the Docker backend (run as one `bot-bottle-infra`
|
||||||
# data plane, AND builds agent images (buildah) — all in one microVM (see
|
# container, replacing the prior two-container split). The Firecracker
|
||||||
# backend/firecracker/infra_vm.py). It composes:
|
# backend extends this via Dockerfile.infra.fc, adding buildah/crun/
|
||||||
# * FROM the gateway image (mitmproxy / git / gitleaks / supervise + the
|
# netavark for in-VM agent-image building.
|
||||||
# flat daemon modules) — now trixie-based, so buildah 1.39 is available;
|
#
|
||||||
# * `COPY --from` the orchestrator image's content (the single definition
|
# Dockerfile.orchestrator is the single definition of the orchestrator
|
||||||
# of the control-plane payload — see Dockerfile.orchestrator), so this
|
# content (the lean `bot_bottle` package on python:3.12-slim). Both this
|
||||||
# VM and the docker backend share one orchestrator definition; and
|
# image and Dockerfile.infra.fc pull it in via `COPY --from`.
|
||||||
# * buildah, installed HERE only (the docker orchestrator/gateway images
|
|
||||||
# never carry it).
|
|
||||||
#
|
#
|
||||||
# multi-`FROM` can't union two bases (that's multi-stage, not multiple
|
# multi-`FROM` can't union two bases (that's multi-stage, not multiple
|
||||||
# inheritance), so the orchestrator content is pulled in via `COPY --from`
|
# inheritance), so the orchestrator content is pulled in via `COPY --from`
|
||||||
# rather than a second base. Both images share the trixie `python:3.12-slim`
|
# rather than a second base. Both images share the trixie `python:3.12-slim`
|
||||||
# base, so the copy is clean (same python; future installed deps copy too).
|
# base, so the copy is clean (same python; future installed deps copy too).
|
||||||
#
|
|
||||||
# The docker backend keeps orchestrator + gateway as separate images; this
|
|
||||||
# combined image exists only for the Firecracker single-VM cut. Splitting a
|
|
||||||
# service back into its own VM later is a routing change, not a repackaging
|
|
||||||
# (PRD 0070's "secret concentration"; a disposable builder can boot from
|
|
||||||
# this same image on its own TAP).
|
|
||||||
FROM bot-bottle-gateway:latest
|
FROM bot-bottle-gateway:latest
|
||||||
|
|
||||||
# --- in-VM agent-image builder (PRD 0069 Stage 3) -------------------
|
# The orchestrator content, from its single definition. The gateway image
|
||||||
# The Firecracker backend builds users' agent Dockerfiles *inside this VM*
|
# already has the flat daemon modules under /app; this adds the full
|
||||||
# with buildah (rootless, daemonless) instead of on the host — no host
|
# `bot_bottle` package so `python3 -m bot_bottle.orchestrator` resolves —
|
||||||
# Docker daemon, no root-equivalent `docker` group. `crun` is the OCI
|
# used by gateway_init when BOT_BOTTLE_GATEWAY_DAEMONS includes `orchestrator`.
|
||||||
# runtime; `netavark` + `aardvark-dns` are the network backend for `FROM`
|
|
||||||
# pulls + `RUN` egress. Requires the trixie base (buildah 1.39: bookworm's
|
|
||||||
# 1.28 can't parse Dockerfile heredocs that agent images use).
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends \
|
|
||||||
buildah crun netavark aardvark-dns \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
# vfs + chroot: buildah works as root in the bare microVM (no
|
|
||||||
# fuse-overlayfs / overlay module / subuid maps). Matches image_builder.
|
|
||||||
ENV STORAGE_DRIVER=vfs \
|
|
||||||
BUILDAH_ISOLATION=chroot
|
|
||||||
|
|
||||||
# The orchestrator content, pulled from its single definition. The gateway
|
|
||||||
# image already has the flat daemon modules under /app; this adds the full
|
|
||||||
# `bot_bottle` package so `python3 -m bot_bottle.orchestrator` resolves.
|
|
||||||
COPY --from=bot-bottle-orchestrator:latest /app/bot_bottle /app/bot_bottle
|
COPY --from=bot-bottle-orchestrator:latest /app/bot_bottle /app/bot_bottle
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Firecracker infra VM image (PRD 0070 Stage B).
|
||||||
|
#
|
||||||
|
# Extends the shared infra base (Dockerfile.infra: gateway + orchestrator
|
||||||
|
# control plane) with the in-VM agent-image builder. The Firecracker backend
|
||||||
|
# builds users' agent Dockerfiles *inside this VM* with buildah (rootless,
|
||||||
|
# daemonless) instead of on the host — no host Docker daemon, no
|
||||||
|
# root-equivalent `docker` group.
|
||||||
|
#
|
||||||
|
# Requires the trixie base from bot-bottle-gateway (buildah 1.39: bookworm's
|
||||||
|
# 1.28 can't parse Dockerfile heredocs that agent images use).
|
||||||
|
#
|
||||||
|
# `crun` is the OCI runtime; `netavark` + `aardvark-dns` are the network
|
||||||
|
# backend for `FROM` pulls + `RUN` egress. `vfs` + `chroot`: buildah works
|
||||||
|
# as root in the bare microVM (no fuse-overlayfs / overlay module / subuid
|
||||||
|
# maps). Matches image_builder.
|
||||||
|
FROM bot-bottle-infra:latest
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends \
|
||||||
|
buildah crun netavark aardvark-dns \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
ENV STORAGE_DRIVER=vfs \
|
||||||
|
BUILDAH_ISOLATION=chroot
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
# bot-bottle
|
# bot-bottle
|
||||||
|
|
||||||
[](https://gitea.dideric.is/didericis/bot-bottle/actions?workflow=test.yml)
|
[](https://gitea.dideric.is/didericis/bot-bottle/actions?workflow=test.yml)
|
||||||
[](https://coverage.readthedocs.io/)
|
[](https://coverage.readthedocs.io/)
|
||||||
[](https://gitea.dideric.is/didericis/bot-bottle/src/branch/main/docs/decisions/0004-coverage-policy.md)
|
[](https://gitea.dideric.is/didericis/bot-bottle/src/branch/main/docs/decisions/0004-coverage-policy.md)
|
||||||
|
|
||||||
**Problem:** Developer wants to run a coding agent without supervision, but they don't want a prompt injected or misbehaving agent wrecking their environment or exfiltrating sensitive data.
|
**Problem:** Developer wants to run a coding agent without supervision, but they don't want a prompt injected or misbehaving agent wrecking their environment or exfiltrating sensitive data.
|
||||||
@@ -75,6 +75,88 @@ On compatible macOS hosts, the default backend requires Apple's `container` CLI
|
|||||||
|
|
||||||
Use `BOT_BOTTLE_BACKEND=docker ./cli.py start <agent>` on hosts where neither Apple Container nor KVM is available and Docker is the desired backend.
|
Use `BOT_BOTTLE_BACKEND=docker ./cli.py start <agent>` on hosts where neither Apple Container nor KVM is available and Docker is the desired backend.
|
||||||
|
|
||||||
|
### Containers inside a bottle
|
||||||
|
|
||||||
|
A bottle may set `nested_containers: true`. On the macOS backend this starts a
|
||||||
|
guest-local, rootless **podman** service after the bottle is registered and
|
||||||
|
exposes its Docker-compatible API socket, so the agent still runs `docker` and
|
||||||
|
`docker compose`. Nothing is mounted from the host: Docker Desktop's socket
|
||||||
|
stays out of the bottle and the guest gains no outer VM capabilities. Backends
|
||||||
|
that cannot do this (`docker`, `firecracker`) reject the flag rather than
|
||||||
|
silently ignore it.
|
||||||
|
|
||||||
|
Rootless Docker was tried first and does not work here at all: Apple
|
||||||
|
Container's capability bounding set omits `CAP_SYS_ADMIN`, which the kernel
|
||||||
|
requires to write a multi-range `uid_map`. See
|
||||||
|
[`docs/research/rootless-docker-in-apple-container-spike.md`](docs/research/rootless-docker-in-apple-container-spike.md).
|
||||||
|
|
||||||
|
The tradeoff to understand before enabling it: podman avoids that requirement
|
||||||
|
by falling back to a single-UID mapping, so nested containers provide **no
|
||||||
|
isolation from the agent itself** — `root` inside a nested container is the
|
||||||
|
agent user outside it. Nested containers are a build/test convenience, not a
|
||||||
|
security boundary. The bottle remains the boundary.
|
||||||
|
|
||||||
|
Pulling images goes through the bottle's egress proxy like every other
|
||||||
|
request, so each registry needs a route — **and so does the CDN it redirects
|
||||||
|
layer blobs to**, which is a different host. Without the CDN route the pull
|
||||||
|
authenticates, fetches the manifest, then 403s partway through.
|
||||||
|
|
||||||
|
Docker Hub and GHCR additionally need `preserve_auth: true`: their token dance
|
||||||
|
uses a client-fetched per-scope bearer token that the proxy would otherwise
|
||||||
|
strip. Turn DLP off on every registry and CDN route — the bodies are
|
||||||
|
compressed layer blobs that no detector can read, and buffering them is what
|
||||||
|
triggers the shared-proxy OOM in #455.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
nested_containers: true
|
||||||
|
egress:
|
||||||
|
routes:
|
||||||
|
# Docker Hub: registry, token endpoint, blob CDN.
|
||||||
|
- host: registry-1.docker.io
|
||||||
|
preserve_auth: true
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: auth.docker.io
|
||||||
|
preserve_auth: true
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: production.cloudfront.docker.com
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
# GHCR: registry + blob CDN.
|
||||||
|
- host: ghcr.io
|
||||||
|
preserve_auth: true
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: pkg-containers.githubusercontent.com
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
# quay.io: registry + blob CDNs. No preserve_auth needed for public pulls.
|
||||||
|
- host: quay.io
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: cdn01.quay.io
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: cdn02.quay.io
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
- host: cdn03.quay.io
|
||||||
|
dlp: { outbound_detectors: false, inbound_detectors: false }
|
||||||
|
```
|
||||||
|
|
||||||
|
`mcr.microsoft.com` and `registry.k8s.io` follow the same shape and also
|
||||||
|
redirect blobs elsewhere (`*.data.mcr.microsoft.com` and
|
||||||
|
`us-*-docker.pkg.dev` respectively); route whichever host the 403 names.
|
||||||
|
|
||||||
|
Inside a nested container the same allowlist applies: an allowlisted host
|
||||||
|
returns 200 and anything else gets a 403 straight from the proxy. The
|
||||||
|
gateway's CA bundle and proxy settings are wired in automatically, so
|
||||||
|
`docker run … curl https://…` works with no extra flags — no `--add-host`,
|
||||||
|
`-e`, or `-v`.
|
||||||
|
|
||||||
|
Two things worth knowing when testing that:
|
||||||
|
|
||||||
|
- Public DNS inside a nested container fails **by design**. Everything
|
||||||
|
egresses through the proxy, so `nslookup` failing is expected and is not
|
||||||
|
evidence of a problem.
|
||||||
|
- Alpine's BusyBox `wget` drops the connection after the proxy's TLS
|
||||||
|
interception and reports `error getting response`, even though the proxy
|
||||||
|
logs the decrypted request and returns a response. Use `curl` to test
|
||||||
|
egress; BusyBox `wget` will lie to you.
|
||||||
|
|
||||||
### Firecracker on Linux
|
### Firecracker on Linux
|
||||||
|
|
||||||
On Linux, a KVM-capable host defaults to the Firecracker backend. It needs:
|
On Linux, a KVM-capable host defaults to the Firecracker backend. It needs:
|
||||||
|
|||||||
@@ -45,6 +45,10 @@ PROVIDER_TEMPLATES = frozenset({PROVIDER_CLAUDE, PROVIDER_CODEX, PROVIDER_PI})
|
|||||||
# forward_host_credentials is enabled. Pipelock must pass these through
|
# forward_host_credentials is enabled. Pipelock must pass these through
|
||||||
# (no TLS MITM) or its header DLP blocks the injected JWT.
|
# (no TLS MITM) or its header DLP blocks the injected JWT.
|
||||||
CODEX_HOST_CREDENTIAL_HOSTS = ("api.openai.com", "chatgpt.com")
|
CODEX_HOST_CREDENTIAL_HOSTS = ("api.openai.com", "chatgpt.com")
|
||||||
|
|
||||||
|
# Host that egress injects the host Claude bearer on when Claude
|
||||||
|
# forward_host_credentials is enabled.
|
||||||
|
CLAUDE_HOST_CREDENTIAL_HOSTS = ("api.anthropic.com",)
|
||||||
PromptMode = Literal[
|
PromptMode = Literal[
|
||||||
"append_file",
|
"append_file",
|
||||||
"read_prompt_file",
|
"read_prompt_file",
|
||||||
@@ -257,7 +261,28 @@ class AgentProvider(ABC):
|
|||||||
Default: Debian/node — writes the git-gate insteadOf gitconfig
|
Default: Debian/node — writes the git-gate insteadOf gitconfig
|
||||||
and sets user.name/email as node. Workspace copy runs through
|
and sets user.name/email as node. Workspace copy runs through
|
||||||
BottleBackend.provision_workspace against the running bottle."""
|
BottleBackend.provision_workspace against the running bottle."""
|
||||||
from .log import info
|
from .log import die, info
|
||||||
|
|
||||||
|
# Firecracker exports image rootfs files through an unprivileged host
|
||||||
|
# tar extraction, so image-time ownership of XDG directories is not
|
||||||
|
# preserved. Git consults ~/.config/git even when the actual config
|
||||||
|
# is ~/.gitconfig; an unreadable directory there can prevent the
|
||||||
|
# git-gate insteadOf rules below from taking effect. Repair this at
|
||||||
|
# runtime, after every backend's copy/export path has completed.
|
||||||
|
git_xdg_dir = f"{plan.guest_home}/.config/git"
|
||||||
|
repair = bottle.exec(
|
||||||
|
f"chown node:node {shlex.quote(plan.guest_home)} && "
|
||||||
|
f"chmod 755 {shlex.quote(plan.guest_home)} && "
|
||||||
|
f"mkdir -p {shlex.quote(git_xdg_dir)} && "
|
||||||
|
f"chown -R node:node {shlex.quote(f'{plan.guest_home}/.config')} && "
|
||||||
|
f"chmod -R u+rwX,go+rX {shlex.quote(f'{plan.guest_home}/.config')}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
if repair.returncode != 0:
|
||||||
|
die(
|
||||||
|
"git provisioning: could not make the runtime Git config "
|
||||||
|
f"directory readable: {(repair.stderr or repair.stdout).strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
manifest_bottle = plan.manifest.bottle
|
manifest_bottle = plan.manifest.bottle
|
||||||
if manifest_bottle.git:
|
if manifest_bottle.git:
|
||||||
@@ -280,11 +305,27 @@ class AgentProvider(ABC):
|
|||||||
f"{len(manifest_bottle.git)} insteadOf rule(s)"
|
f"{len(manifest_bottle.git)} insteadOf rule(s)"
|
||||||
)
|
)
|
||||||
bottle.cp_in(str(config_file), guest_gitconfig)
|
bottle.cp_in(str(config_file), guest_gitconfig)
|
||||||
bottle.exec(
|
permissions = bottle.exec(
|
||||||
f"chown node:node {shlex.quote(guest_gitconfig)} && "
|
f"chown node:node {shlex.quote(guest_gitconfig)} && "
|
||||||
f"chmod 644 {shlex.quote(guest_gitconfig)}",
|
f"chmod 644 {shlex.quote(guest_gitconfig)}",
|
||||||
user="root",
|
user="root",
|
||||||
)
|
)
|
||||||
|
if permissions.returncode != 0:
|
||||||
|
die(
|
||||||
|
"git provisioning: could not set ownership on "
|
||||||
|
f"{guest_gitconfig}: "
|
||||||
|
f"{(permissions.stderr or permissions.stdout).strip()}"
|
||||||
|
)
|
||||||
|
configured = bottle.exec(
|
||||||
|
"git config --global --get-regexp '^url\\..*\\.insteadof$'",
|
||||||
|
user="node",
|
||||||
|
)
|
||||||
|
if configured.returncode != 0:
|
||||||
|
die(
|
||||||
|
"git provisioning: the runtime user cannot read the "
|
||||||
|
f"git-gate insteadOf rules from {guest_gitconfig}: "
|
||||||
|
f"{(configured.stderr or configured.stdout).strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
gu = manifest_bottle.git_user
|
gu = manifest_bottle.git_user
|
||||||
if not gu.is_empty():
|
if not gu.is_empty():
|
||||||
|
|||||||
@@ -37,10 +37,10 @@ import os
|
|||||||
import shlex
|
import shlex
|
||||||
import sys
|
import sys
|
||||||
from abc import ABC, abstractmethod
|
from abc import ABC, abstractmethod
|
||||||
from contextlib import AbstractContextManager
|
from contextlib import AbstractContextManager, contextmanager
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING, Any, Generic, Sequence, TypeVar
|
from typing import TYPE_CHECKING, Any, Generator, Generic, Sequence, TypeVar
|
||||||
|
|
||||||
from ..agent_provider import AgentProvisionPlan, get_provider, build_agent_provision_plan
|
from ..agent_provider import AgentProvisionPlan, get_provider, build_agent_provision_plan
|
||||||
from ..egress import EgressPlan
|
from ..egress import EgressPlan
|
||||||
@@ -83,6 +83,9 @@ class BottleSpec:
|
|||||||
# True when launched via --headless (no TTY, no interactive prompts).
|
# True when launched via --headless (no TTY, no interactive prompts).
|
||||||
# The git-gate host-key preflight uses this to error rather than prompt.
|
# The git-gate host-key preflight uses this to error rather than prompt.
|
||||||
headless: bool = False
|
headless: bool = False
|
||||||
|
# Image startup policy. "fresh" preserves the normal build path;
|
||||||
|
# "cached" reuses the current local image/artifact without rebuilding.
|
||||||
|
image_policy: str = "fresh"
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -278,6 +281,18 @@ PlanT = TypeVar("PlanT", bound=BottlePlan)
|
|||||||
CleanupT = TypeVar("CleanupT", bound=BottleCleanupPlan)
|
CleanupT = TypeVar("CleanupT", bound=BottleCleanupPlan)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BottleImages:
|
||||||
|
"""Resolved image references (or artifact paths) for a bottle launch.
|
||||||
|
|
||||||
|
For Docker/macOS-container backends, `agent` and `sidecar` are string
|
||||||
|
image refs. For the smolmachines backend they are Path objects pointing
|
||||||
|
to pre-built `.smolmachine` artifacts."""
|
||||||
|
|
||||||
|
agent: str | Path
|
||||||
|
sidecar: str | Path = ""
|
||||||
|
|
||||||
|
|
||||||
class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
||||||
"""Abstract base for selectable bottle backends. Concrete subclasses
|
"""Abstract base for selectable bottle backends. Concrete subclasses
|
||||||
(e.g. DockerBottleBackend) own their own prepare/launch impls.
|
(e.g. DockerBottleBackend) own their own prepare/launch impls.
|
||||||
@@ -287,6 +302,11 @@ class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
|||||||
|
|
||||||
name: str
|
name: str
|
||||||
|
|
||||||
|
# Whether this backend can run a container engine *inside* the bottle.
|
||||||
|
# Backends that cannot must reject `nested_containers: true` rather than
|
||||||
|
# reach for a host daemon socket (issue #392).
|
||||||
|
supports_nested_containers: bool = False
|
||||||
|
|
||||||
def prepare(self, spec: BottleSpec, stage_dir: Path) -> PlanT:
|
def prepare(self, spec: BottleSpec, stage_dir: Path) -> PlanT:
|
||||||
"""Template method: run cross-backend host-side validation, then
|
"""Template method: run cross-backend host-side validation, then
|
||||||
delegate to the subclass's `_resolve_plan` for the
|
delegate to the subclass's `_resolve_plan` for the
|
||||||
@@ -300,12 +320,16 @@ class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
|||||||
prepare_egress,
|
prepare_egress,
|
||||||
prepare_git_gate,
|
prepare_git_gate,
|
||||||
prepare_supervise,
|
prepare_supervise,
|
||||||
|
reject_nested_containers,
|
||||||
resolve_manifest_dockerfile,
|
resolve_manifest_dockerfile,
|
||||||
write_launch_metadata,
|
write_launch_metadata,
|
||||||
)
|
)
|
||||||
|
|
||||||
manifest = self._validate(spec)
|
manifest = self._validate(spec)
|
||||||
|
|
||||||
|
if not self.supports_nested_containers:
|
||||||
|
reject_nested_containers(self.name, manifest)
|
||||||
|
|
||||||
self._preflight()
|
self._preflight()
|
||||||
|
|
||||||
from ..git_gate_host_key import preflight_host_keys
|
from ..git_gate_host_key import preflight_host_keys
|
||||||
@@ -437,9 +461,27 @@ class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
|||||||
prompt file, Dockerfile path, and guest home all live on
|
prompt file, Dockerfile path, and guest home all live on
|
||||||
`agent_provision_plan` — the source of truth."""
|
`agent_provision_plan` — the source of truth."""
|
||||||
|
|
||||||
|
def prelaunch_checks(self, plan: PlanT) -> None:
|
||||||
|
"""Raise StaleImageError if any cached image used by this plan is stale.
|
||||||
|
No-op default; backends override to call the shared check_stale*
|
||||||
|
helpers on their image/artifact timestamps. Called by the CLI before
|
||||||
|
launch so the operator can be prompted outside the launch context."""
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(self, plan: PlanT) -> Generator[Bottle, None, None]:
|
||||||
|
"""Template: build or load images, then delegate to _launch_impl."""
|
||||||
|
images = self._build_or_load_images(plan)
|
||||||
|
with self._launch_impl(plan, images) as bottle:
|
||||||
|
yield bottle
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def launch(self, plan: PlanT) -> AbstractContextManager[Bottle]:
|
def _build_or_load_images(self, plan: PlanT) -> BottleImages:
|
||||||
"""Build/run the bottle and yield a handle; tear down on exit."""
|
"""Return the agent and sidecar image references (or artifact paths)
|
||||||
|
for this plan, building fresh images when the policy requires it."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def _launch_impl(self, plan: PlanT, images: BottleImages) -> AbstractContextManager[Bottle]:
|
||||||
|
"""Bring up the bottle using pre-resolved images; yield a handle; tear down on exit."""
|
||||||
|
|
||||||
def provision(self, plan: PlanT, bottle: "Bottle") -> str | None:
|
def provision(self, plan: PlanT, bottle: "Bottle") -> str | None:
|
||||||
"""Copy host-side files (CA cert, prompt, skills, .git) into
|
"""Copy host-side files (CA cert, prompt, skills, .git) into
|
||||||
|
|||||||
@@ -0,0 +1,60 @@
|
|||||||
|
"""Shared helpers for the consolidated launch sequence (PRD 0070).
|
||||||
|
|
||||||
|
Logic that was duplicated across the docker, macos_container, and
|
||||||
|
firecracker consolidated_launch modules — extracted so each backend
|
||||||
|
imports it rather than re-implementing it.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from ..egress import EgressPlan
|
||||||
|
from ..git_gate import GitGatePlan
|
||||||
|
from ..orchestrator.client import OrchestratorClient
|
||||||
|
from ..orchestrator.registration import registration_inputs
|
||||||
|
from .docker.gateway_provision import GatewayTransport, deprovision_git_gate, provision_git_gate
|
||||||
|
|
||||||
|
|
||||||
|
def provision_bottle(
|
||||||
|
client: OrchestratorClient,
|
||||||
|
source_ip: str,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
transport: GatewayTransport,
|
||||||
|
*,
|
||||||
|
image_ref: str = "",
|
||||||
|
tokens: dict[str, str] | None = None,
|
||||||
|
):
|
||||||
|
"""Register the bottle and provision its git-gate state. Rolls back the
|
||||||
|
registration if provisioning fails so no orphan is left. Returns the
|
||||||
|
`RegisteredBottle` from the orchestrator."""
|
||||||
|
inputs = registration_inputs(egress_plan)
|
||||||
|
reg = client.register_bottle(
|
||||||
|
source_ip, image_ref=image_ref, policy=inputs.policy,
|
||||||
|
metadata=inputs.metadata, tokens=tokens,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
provision_git_gate(transport, reg.bottle_id, git_gate_plan)
|
||||||
|
except Exception:
|
||||||
|
client.teardown_bottle(reg.bottle_id)
|
||||||
|
raise
|
||||||
|
return reg
|
||||||
|
|
||||||
|
|
||||||
|
def teardown_consolidated(
|
||||||
|
bottle_id: str,
|
||||||
|
transport: GatewayTransport,
|
||||||
|
*,
|
||||||
|
orchestrator_url: str,
|
||||||
|
timeout: float | None = None,
|
||||||
|
) -> None:
|
||||||
|
"""Deregister the bottle and remove its git-gate state. Both steps are
|
||||||
|
idempotent so this is safe from a cleanup trap."""
|
||||||
|
from ..orchestrator.config_store import DEFAULT_TEARDOWN_TIMEOUT_SECONDS
|
||||||
|
OrchestratorClient(
|
||||||
|
orchestrator_url,
|
||||||
|
timeout=timeout if timeout is not None else DEFAULT_TEARDOWN_TIMEOUT_SECONDS,
|
||||||
|
).teardown_bottle(bottle_id)
|
||||||
|
deprovision_git_gate(transport, bottle_id)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["provision_bottle", "teardown_consolidated"]
|
||||||
@@ -31,7 +31,7 @@ from ...env import ResolvedEnv
|
|||||||
from ...git_gate import GitGatePlan
|
from ...git_gate import GitGatePlan
|
||||||
from ...supervise import SupervisePlan
|
from ...supervise import SupervisePlan
|
||||||
from ...manifest import Manifest
|
from ...manifest import Manifest
|
||||||
from .. import ActiveAgent, BottleBackend, BottleSpec
|
from .. import ActiveAgent, BottleBackend, BottleImages, BottleSpec
|
||||||
from . import cleanup as _cleanup
|
from . import cleanup as _cleanup
|
||||||
from . import enumerate as _enumerate
|
from . import enumerate as _enumerate
|
||||||
from . import launch as _launch
|
from . import launch as _launch
|
||||||
@@ -100,9 +100,15 @@ class DockerBottleBackend(BottleBackend["DockerBottlePlan", "DockerBottleCleanup
|
|||||||
stage_dir=stage_dir,
|
stage_dir=stage_dir,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def prelaunch_checks(self, plan: DockerBottlePlan) -> None:
|
||||||
|
_launch.stale_checks(plan)
|
||||||
|
|
||||||
|
def _build_or_load_images(self, plan: DockerBottlePlan) -> BottleImages:
|
||||||
|
return _launch.build_or_load_images(plan)
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(self, plan: DockerBottlePlan) -> Generator[DockerBottle, None, None]:
|
def _launch_impl(self, plan: DockerBottlePlan, images: BottleImages) -> Generator[DockerBottle, None, None]:
|
||||||
with _launch.launch(plan, provision=self.provision) as bottle:
|
with _launch.launch(plan, images, provision=self.provision) as bottle:
|
||||||
yield bottle
|
yield bottle
|
||||||
|
|
||||||
def ensure_orchestrator(self) -> str:
|
def ensure_orchestrator(self) -> str:
|
||||||
|
|||||||
@@ -1,19 +1,13 @@
|
|||||||
"""Consolidated bottle launch sequence for the docker backend (PRD 0070).
|
"""Consolidated bottle launch sequence for the docker backend (PRD 0070).
|
||||||
|
|
||||||
Composes the orchestrator primitives into the register/teardown sequence that
|
Composes the orchestrator primitives into the register/teardown sequence:
|
||||||
replaces the per-bottle gateway:
|
|
||||||
|
|
||||||
1. ensure the orchestrator control plane + shared gateway are up;
|
1. ensure the single infra container (control plane + gateway) is up;
|
||||||
2. allocate the bottle a pinned source IP on the gateway network (the
|
2. allocate the bottle a pinned source IP on the gateway network;
|
||||||
attribution key), skipping the gateway's own address + live bottles;
|
3. register it and provision its git-gate repos/creds into the gateway.
|
||||||
3. register it (egress policy blob + slug metadata) → bottle id + identity
|
|
||||||
token;
|
|
||||||
4. provision its git-gate repos/creds into the running gateway.
|
|
||||||
|
|
||||||
It returns a `LaunchContext` with everything the agent container needs to
|
Returns a `LaunchContext` with everything the agent container needs to
|
||||||
attach — network, pinned IP, the gateway's address (its proxy target), the
|
attach. The agent `docker run` itself is the backend's job; this owns the
|
||||||
orchestrator URL, and the identity token. The agent `docker run` itself is
|
|
||||||
the backend's job (it owns provider provisioning); this owns the
|
|
||||||
orchestrator-facing wiring so that sequence stays testable in isolation.
|
orchestrator-facing wiring so that sequence stays testable in isolation.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -25,15 +19,12 @@ from ...docker_cmd import run_docker
|
|||||||
from ...egress import EgressPlan
|
from ...egress import EgressPlan
|
||||||
from ...git_gate import GitGatePlan
|
from ...git_gate import GitGatePlan
|
||||||
from ...orchestrator.client import OrchestratorClient
|
from ...orchestrator.client import OrchestratorClient
|
||||||
from ...orchestrator.gateway import GATEWAY_NAME, GATEWAY_NETWORK
|
from ...orchestrator.gateway import GATEWAY_NETWORK
|
||||||
from ...orchestrator.lifecycle import OrchestratorService
|
from ...orchestrator.lifecycle import INFRA_NAME, OrchestratorService
|
||||||
from ...orchestrator.registration import registration_inputs
|
from ..consolidated_util import provision_bottle
|
||||||
|
from ..consolidated_util import teardown_consolidated as _teardown_util
|
||||||
|
from .gateway_provision import DockerGatewayTransport
|
||||||
from .gateway_net import next_free_ip
|
from .gateway_net import next_free_ip
|
||||||
from .gateway_provision import (
|
|
||||||
DockerGatewayTransport,
|
|
||||||
deprovision_git_gate,
|
|
||||||
provision_git_gate,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ConsolidatedLaunchError(RuntimeError):
|
class ConsolidatedLaunchError(RuntimeError):
|
||||||
@@ -75,24 +66,21 @@ def _container_ip(name: str, network: str) -> str:
|
|||||||
ip = proc.stdout.strip()
|
ip = proc.stdout.strip()
|
||||||
if proc.returncode != 0 or not ip:
|
if proc.returncode != 0 or not ip:
|
||||||
raise ConsolidatedLaunchError(
|
raise ConsolidatedLaunchError(
|
||||||
f"gateway {name} has no address on {network}: {proc.stderr.strip()}"
|
f"container {name} has no address on {network}: {proc.stderr.strip()}"
|
||||||
)
|
)
|
||||||
return ip
|
return ip
|
||||||
|
|
||||||
|
|
||||||
def _network_container_ips(network: str) -> list[str]:
|
def _network_container_ips(network: str) -> list[str]:
|
||||||
"""Every address currently assigned on the gateway network — the ground
|
"""Every address currently assigned on the gateway network — the ground
|
||||||
truth for "in use": the gateway + orchestrator infrastructure containers
|
truth for "in use": the infra container and every live agent. Read from
|
||||||
and every live agent. Read from the network so a new bottle can't collide
|
the network so a new bottle can't collide with anything actually attached."""
|
||||||
with anything actually attached (a registry-only view would miss the
|
|
||||||
orchestrator/gateway containers)."""
|
|
||||||
proc = run_docker([
|
proc = run_docker([
|
||||||
"docker", "network", "inspect", "--format",
|
"docker", "network", "inspect", "--format",
|
||||||
"{{range .Containers}}{{.IPv4Address}} {{end}}", network,
|
"{{range .Containers}}{{.IPv4Address}} {{end}}", network,
|
||||||
])
|
])
|
||||||
ips: list[str] = []
|
ips: list[str] = []
|
||||||
for entry in proc.stdout.split():
|
for entry in proc.stdout.split():
|
||||||
# entries look like "172.20.0.2/16" — keep the address.
|
|
||||||
ips.append(entry.split("/", 1)[0])
|
ips.append(entry.split("/", 1)[0])
|
||||||
return ips
|
return ips
|
||||||
|
|
||||||
@@ -104,33 +92,24 @@ def launch_consolidated(
|
|||||||
image_ref: str = "",
|
image_ref: str = "",
|
||||||
tokens: dict[str, str] | None = None,
|
tokens: dict[str, str] | None = None,
|
||||||
service: OrchestratorService | None = None,
|
service: OrchestratorService | None = None,
|
||||||
gateway_name: str = GATEWAY_NAME,
|
infra_name: str = INFRA_NAME,
|
||||||
network: str = GATEWAY_NETWORK,
|
network: str = GATEWAY_NETWORK,
|
||||||
) -> LaunchContext:
|
) -> LaunchContext:
|
||||||
"""Ensure the orchestrator + gateway are up, allocate + register the
|
"""Ensure the infra container is up, allocate + register the bottle, and
|
||||||
bottle, and provision its git-gate state. Returns the agent's attach
|
provision its git-gate state. Returns the agent's attach context."""
|
||||||
context. Raises `ConsolidatedLaunchError` (or the primitives' own errors)
|
|
||||||
if any step fails — the caller tears down on failure."""
|
|
||||||
service = service or OrchestratorService()
|
service = service or OrchestratorService()
|
||||||
url = service.ensure_running()
|
url = service.ensure_running()
|
||||||
client = OrchestratorClient(url)
|
client = OrchestratorClient(url)
|
||||||
|
|
||||||
cidr = _network_cidr(network)
|
cidr = _network_cidr(network)
|
||||||
gateway_ip = _container_ip(gateway_name, network)
|
gateway_ip = _container_ip(infra_name, network)
|
||||||
source_ip = next_free_ip(cidr, _network_container_ips(network))
|
source_ip = next_free_ip(cidr, _network_container_ips(network))
|
||||||
|
|
||||||
inputs = registration_inputs(egress_plan)
|
transport = DockerGatewayTransport(infra_name)
|
||||||
reg = client.register_bottle(
|
reg = provision_bottle(
|
||||||
source_ip, image_ref=image_ref, policy=inputs.policy,
|
client, source_ip, egress_plan, git_gate_plan, transport,
|
||||||
metadata=inputs.metadata, tokens=tokens,
|
image_ref=image_ref, tokens=tokens,
|
||||||
)
|
)
|
||||||
try:
|
|
||||||
provision_git_gate(
|
|
||||||
DockerGatewayTransport(gateway_name), reg.bottle_id, git_gate_plan)
|
|
||||||
except Exception:
|
|
||||||
# Roll the registration back so a provisioning failure leaves no orphan.
|
|
||||||
client.teardown_bottle(reg.bottle_id)
|
|
||||||
raise
|
|
||||||
return LaunchContext(
|
return LaunchContext(
|
||||||
bottle_id=reg.bottle_id,
|
bottle_id=reg.bottle_id,
|
||||||
identity_token=reg.identity_token,
|
identity_token=reg.identity_token,
|
||||||
@@ -142,12 +121,12 @@ def launch_consolidated(
|
|||||||
|
|
||||||
|
|
||||||
def teardown_consolidated(
|
def teardown_consolidated(
|
||||||
bottle_id: str, *, orchestrator_url: str, gateway_name: str = GATEWAY_NAME,
|
bottle_id: str, *, orchestrator_url: str, infra_name: str = INFRA_NAME,
|
||||||
|
timeout: float | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Deregister the bottle and remove its git-gate state from the gateway.
|
"""Deregister the bottle and remove its git-gate state. Idempotent."""
|
||||||
Both steps are idempotent so this is safe from a cleanup trap."""
|
_teardown_util(bottle_id, DockerGatewayTransport(infra_name),
|
||||||
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
orchestrator_url=orchestrator_url, timeout=timeout)
|
||||||
deprovision_git_gate(DockerGatewayTransport(gateway_name), bottle_id)
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
|||||||
@@ -42,7 +42,9 @@ from ...git_gate import (
|
|||||||
provision_git_gate_dynamic_keys,
|
provision_git_gate_dynamic_keys,
|
||||||
revoke_git_gate_provisioned_keys,
|
revoke_git_gate_provisioned_keys,
|
||||||
)
|
)
|
||||||
from ...log import info, warn
|
from ...image_cache import check_stale
|
||||||
|
from ...log import die, info, warn
|
||||||
|
from .. import BottleImages
|
||||||
from . import util as docker_mod
|
from . import util as docker_mod
|
||||||
from .bottle import DockerBottle
|
from .bottle import DockerBottle
|
||||||
from .bottle_plan import DockerBottlePlan
|
from .bottle_plan import DockerBottlePlan
|
||||||
@@ -62,6 +64,7 @@ from .compose import (
|
|||||||
write_compose_file,
|
write_compose_file,
|
||||||
)
|
)
|
||||||
from .consolidated_compose import consolidated_agent_compose
|
from .consolidated_compose import consolidated_agent_compose
|
||||||
|
from ...orchestrator.config_store import resolve_teardown_timeout
|
||||||
from .consolidated_launch import launch_consolidated, teardown_consolidated
|
from .consolidated_launch import launch_consolidated, teardown_consolidated
|
||||||
from ...orchestrator.gateway import DockerGateway
|
from ...orchestrator.gateway import DockerGateway
|
||||||
|
|
||||||
@@ -70,16 +73,47 @@ from ...orchestrator.gateway import DockerGateway
|
|||||||
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
||||||
|
|
||||||
|
|
||||||
|
def build_or_load_images(plan: DockerBottlePlan) -> BottleImages:
|
||||||
|
"""Resolve the agent image ref for this plan.
|
||||||
|
|
||||||
|
Returns the committed snapshot if one exists, the cached image when the
|
||||||
|
policy is 'cached', or builds a fresh image and returns that."""
|
||||||
|
committed = read_committed_image(plan.slug)
|
||||||
|
if committed and docker_mod.image_exists(committed):
|
||||||
|
info(f"using committed image {committed!r}")
|
||||||
|
return BottleImages(agent=committed)
|
||||||
|
if plan.spec.image_policy == "cached":
|
||||||
|
if not docker_mod.image_exists(plan.image):
|
||||||
|
die(
|
||||||
|
f"cached agent image {plan.image!r} not found; "
|
||||||
|
"run without --cached-images to build it"
|
||||||
|
)
|
||||||
|
info(f"using cached agent image {plan.image!r}")
|
||||||
|
return BottleImages(agent=plan.image)
|
||||||
|
docker_mod.build_image(plan.image, _REPO_DIR, dockerfile=plan.dockerfile_path)
|
||||||
|
docker_mod.verify_agent_image(
|
||||||
|
plan.image, runtime_for(plan.agent_provider_template).smoke_test,
|
||||||
|
)
|
||||||
|
return BottleImages(agent=plan.image)
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(
|
def launch(
|
||||||
plan: DockerBottlePlan,
|
plan: DockerBottlePlan,
|
||||||
|
images: BottleImages,
|
||||||
*,
|
*,
|
||||||
provision: Callable[[DockerBottlePlan, "DockerBottle"], str | None],
|
provision: Callable[[DockerBottlePlan, "DockerBottle"], str | None],
|
||||||
) -> Generator[DockerBottle, None, None]:
|
) -> Generator[DockerBottle, None, None]:
|
||||||
"""Build, launch, and provision a Docker bottle via compose.
|
"""Launch and provision a Docker bottle via compose. Teardown on exit."""
|
||||||
Teardown on exit."""
|
|
||||||
stack = ExitStack()
|
stack = ExitStack()
|
||||||
|
|
||||||
|
# Stamp the resolved agent image ref into the plan so compose rendering
|
||||||
|
# picks up the right image (may be a committed snapshot or cached ref).
|
||||||
|
plan = dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
agent_provision=dataclasses.replace(plan.agent_provision, image=str(images.agent)),
|
||||||
|
)
|
||||||
|
|
||||||
_bottle_for_revoke = plan.manifest.bottle
|
_bottle_for_revoke = plan.manifest.bottle
|
||||||
_git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
_git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
||||||
|
|
||||||
@@ -96,25 +130,6 @@ def launch(
|
|||||||
)
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Step 1: agent image. Use a committed snapshot when one exists
|
|
||||||
# and is present in the local daemon; otherwise build from the
|
|
||||||
# Dockerfile. (The gateway image is built by the orchestrator.)
|
|
||||||
committed = read_committed_image(plan.slug)
|
|
||||||
if committed and docker_mod.image_exists(committed):
|
|
||||||
info(f"using committed image {committed!r}")
|
|
||||||
plan = dataclasses.replace(
|
|
||||||
plan,
|
|
||||||
agent_provision=dataclasses.replace(plan.agent_provision, image=committed),
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
docker_mod.build_image(
|
|
||||||
plan.image, _REPO_DIR,
|
|
||||||
dockerfile=plan.dockerfile_path,
|
|
||||||
)
|
|
||||||
docker_mod.verify_agent_image(
|
|
||||||
plan.image, runtime_for(plan.agent_provider_template).smoke_test,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Step 2: mint the git-gate dynamic (gitea) deploy keys, if any, before
|
# Step 2: mint the git-gate dynamic (gitea) deploy keys, if any, before
|
||||||
# provisioning the bottle's repos into the shared gateway.
|
# provisioning the bottle's repos into the shared gateway.
|
||||||
git_gate_plan = plan.git_gate_plan
|
git_gate_plan = plan.git_gate_plan
|
||||||
@@ -133,11 +148,14 @@ def launch(
|
|||||||
token_values = egress_resolve_token_values(
|
token_values = egress_resolve_token_values(
|
||||||
plan.egress_plan.token_env_map, effective_env,
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
)
|
)
|
||||||
|
teardown_timeout = resolve_teardown_timeout()
|
||||||
ctx = launch_consolidated(
|
ctx = launch_consolidated(
|
||||||
plan.egress_plan, git_gate_plan, image_ref=plan.image, tokens=token_values,
|
plan.egress_plan, git_gate_plan, image_ref=plan.image, tokens=token_values,
|
||||||
)
|
)
|
||||||
stack.callback(
|
stack.callback(
|
||||||
teardown_consolidated, ctx.bottle_id, orchestrator_url=ctx.orchestrator_url,
|
teardown_consolidated, ctx.bottle_id,
|
||||||
|
orchestrator_url=ctx.orchestrator_url,
|
||||||
|
timeout=teardown_timeout,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Step 4: install the SHARED gateway CA into the agent (replaces the
|
# Step 4: install the SHARED gateway CA into the agent (replaces the
|
||||||
@@ -207,3 +225,21 @@ def launch(
|
|||||||
yield bottle
|
yield bottle
|
||||||
finally:
|
finally:
|
||||||
teardown()
|
teardown()
|
||||||
|
|
||||||
|
|
||||||
|
def stale_checks(plan: DockerBottlePlan) -> None:
|
||||||
|
"""Raise StaleImageError if a cached image is older than the configured
|
||||||
|
threshold. Only runs when image_policy is 'cached'. Called by the backend
|
||||||
|
class's _image_stale_checks before _launch_impl starts any resources."""
|
||||||
|
if plan.spec.image_policy != "cached":
|
||||||
|
return
|
||||||
|
committed = read_committed_image(plan.slug)
|
||||||
|
if committed and docker_mod.image_exists(committed):
|
||||||
|
ts = docker_mod.image_created_at(committed)
|
||||||
|
if ts is not None:
|
||||||
|
check_stale(f"agent image {committed!r}", ts)
|
||||||
|
return
|
||||||
|
if docker_mod.image_exists(plan.image):
|
||||||
|
ts = docker_mod.image_created_at(plan.image)
|
||||||
|
if ts is not None:
|
||||||
|
check_stale(f"agent image {plan.image!r}", ts)
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ existence, and building images."""
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
from datetime import datetime, timezone
|
||||||
import re
|
import re
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
@@ -197,3 +198,46 @@ def commit_container(container_name: str, image_tag: str) -> None:
|
|||||||
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
)
|
)
|
||||||
info(f"committed {container_name!r} → {image_tag!r}")
|
info(f"committed {container_name!r} → {image_tag!r}")
|
||||||
|
|
||||||
|
|
||||||
|
def image_created_at(ref: str) -> datetime | None:
|
||||||
|
"""Return Docker's image Created timestamp as an aware UTC datetime, or
|
||||||
|
None when the field is absent or unparseable. Callers should skip the
|
||||||
|
stale check when None is returned."""
|
||||||
|
r = subprocess.run(
|
||||||
|
["docker", "image", "inspect", "--format", "{{.Created}}", ref],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"docker image inspect for {ref!r} failed: "
|
||||||
|
f"{(r.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
raw = r.stdout.strip()
|
||||||
|
if not raw:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
return _parse_docker_timestamp(raw)
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_docker_timestamp(raw: str) -> datetime:
|
||||||
|
text = raw.strip()
|
||||||
|
if text.endswith("Z"):
|
||||||
|
text = text[:-1] + "+00:00"
|
||||||
|
dot = text.find(".")
|
||||||
|
if dot != -1:
|
||||||
|
tz_plus = text.find("+", dot)
|
||||||
|
tz_minus = text.find("-", dot)
|
||||||
|
tz_candidates = [pos for pos in (tz_plus, tz_minus) if pos != -1]
|
||||||
|
if tz_candidates:
|
||||||
|
tz_pos = min(tz_candidates)
|
||||||
|
frac = text[dot + 1:tz_pos]
|
||||||
|
text = text[:dot + 1] + frac[:6].ljust(6, "0") + text[tz_pos:]
|
||||||
|
dt = datetime.fromisoformat(text)
|
||||||
|
if dt.tzinfo is None:
|
||||||
|
dt = dt.replace(tzinfo=timezone.utc)
|
||||||
|
return dt.astimezone(timezone.utc)
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ from ...env import ResolvedEnv
|
|||||||
from ...git_gate import GitGatePlan
|
from ...git_gate import GitGatePlan
|
||||||
from ...manifest import Manifest
|
from ...manifest import Manifest
|
||||||
from ...supervise import SupervisePlan
|
from ...supervise import SupervisePlan
|
||||||
from .. import ActiveAgent, BottleBackend, BottleSpec
|
from .. import ActiveAgent, BottleBackend, BottleImages, BottleSpec
|
||||||
from . import cleanup as _cleanup
|
from . import cleanup as _cleanup
|
||||||
from . import enumerate as _enumerate
|
from . import enumerate as _enumerate
|
||||||
from . import launch as _launch
|
from . import launch as _launch
|
||||||
@@ -92,11 +92,18 @@ class FirecrackerBottleBackend(
|
|||||||
stage_dir=stage_dir,
|
stage_dir=stage_dir,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def _build_or_load_images(self, plan: FirecrackerBottlePlan) -> BottleImages:
|
||||||
|
return BottleImages(agent=_launch.build_or_load_agent_base(plan))
|
||||||
|
|
||||||
|
def prelaunch_checks(self, plan: FirecrackerBottlePlan) -> None:
|
||||||
|
_launch.stale_checks(plan)
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(
|
def _launch_impl(
|
||||||
self, plan: FirecrackerBottlePlan
|
self, plan: FirecrackerBottlePlan, images: BottleImages,
|
||||||
) -> Generator[FirecrackerBottle, None, None]:
|
) -> Generator[FirecrackerBottle, None, None]:
|
||||||
with _launch.launch(plan, provision=self.provision) as bottle:
|
assert isinstance(images.agent, Path)
|
||||||
|
with _launch.launch(plan, images.agent, provision=self.provision) as bottle:
|
||||||
yield bottle
|
yield bottle
|
||||||
|
|
||||||
def prepare_cleanup(self) -> FirecrackerBottleCleanupPlan:
|
def prepare_cleanup(self) -> FirecrackerBottleCleanupPlan:
|
||||||
|
|||||||
@@ -33,8 +33,7 @@ from ...orchestrator.client import OrchestratorClient
|
|||||||
from ...orchestrator.lifecycle import (
|
from ...orchestrator.lifecycle import (
|
||||||
OrchestratorStartError, # re-exported so callers can catch it
|
OrchestratorStartError, # re-exported so callers can catch it
|
||||||
)
|
)
|
||||||
from ...orchestrator.registration import registration_inputs
|
from ..consolidated_util import provision_bottle, teardown_consolidated as _teardown_util
|
||||||
from ..docker.gateway_provision import deprovision_git_gate, provision_git_gate
|
|
||||||
from . import infra_vm
|
from . import infra_vm
|
||||||
|
|
||||||
|
|
||||||
@@ -68,18 +67,11 @@ def launch_consolidated(
|
|||||||
url = infra.control_plane_url
|
url = infra.control_plane_url
|
||||||
client = OrchestratorClient(url)
|
client = OrchestratorClient(url)
|
||||||
|
|
||||||
inputs = registration_inputs(egress_plan)
|
transport = infra_vm.gateway_transport()
|
||||||
reg = client.register_bottle(
|
reg = provision_bottle(
|
||||||
guest_ip, image_ref=image_ref, policy=inputs.policy,
|
client, guest_ip, egress_plan, git_gate_plan, transport,
|
||||||
metadata=inputs.metadata, tokens=tokens,
|
image_ref=image_ref, tokens=tokens,
|
||||||
)
|
)
|
||||||
try:
|
|
||||||
provision_git_gate(
|
|
||||||
infra_vm.gateway_transport(), reg.bottle_id, git_gate_plan)
|
|
||||||
except Exception:
|
|
||||||
client.teardown_bottle(reg.bottle_id)
|
|
||||||
raise
|
|
||||||
|
|
||||||
# The shared gateway CA every agent on this host trusts for TLS
|
# The shared gateway CA every agent on this host trusts for TLS
|
||||||
# interception — fetched from the infra VM over SSH.
|
# interception — fetched from the infra VM over SSH.
|
||||||
return LaunchContext(
|
return LaunchContext(
|
||||||
@@ -91,13 +83,15 @@ def launch_consolidated(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def teardown_consolidated(bottle_id: str, *, orchestrator_url: str) -> None:
|
def teardown_consolidated(
|
||||||
|
bottle_id: str, *, orchestrator_url: str, timeout: float | None = None,
|
||||||
|
) -> None:
|
||||||
"""Deregister the bottle and remove its git-gate state from the gateway
|
"""Deregister the bottle and remove its git-gate state from the gateway
|
||||||
VM. Both steps are idempotent so this is safe from a cleanup trap. Does
|
VM. Both steps are idempotent so this is safe from a cleanup trap. Does
|
||||||
NOT stop the infra VM — it's a persistent per-host singleton shared by
|
NOT stop the infra VM — it's a persistent per-host singleton shared by
|
||||||
every bottle."""
|
every bottle."""
|
||||||
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
_teardown_util(bottle_id, infra_vm.gateway_transport(),
|
||||||
deprovision_git_gate(infra_vm.gateway_transport(), bottle_id)
|
orchestrator_url=orchestrator_url, timeout=timeout)
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ backend — we stream the guest root filesystem out over the control
|
|||||||
channel (SSH here). Unlike the other backends this needs no Docker: the
|
channel (SSH here). Unlike the other backends this needs no Docker: the
|
||||||
tar *is* the resumable artifact. `resume` extracts it and rebuilds a
|
tar *is* the resumable artifact. `resume` extracts it and rebuilds a
|
||||||
fresh per-bottle ext4 with `mke2fs -d` (see `util.build_committed_rootfs_dir`
|
fresh per-bottle ext4 with `mke2fs -d` (see `util.build_committed_rootfs_dir`
|
||||||
and `launch._build_agent_base`). The bottle keeps running after the
|
and `launch.build_or_load_agent_base`). The bottle keeps running after the
|
||||||
snapshot.
|
snapshot.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|||||||
@@ -58,6 +58,12 @@ def _rootfs_digest(dockerfile: Path) -> str:
|
|||||||
return h.hexdigest()[:16]
|
return h.hexdigest()[:16]
|
||||||
|
|
||||||
|
|
||||||
|
def cached_agent_rootfs_dir(dockerfile: Path) -> Path | None:
|
||||||
|
"""Return the ready cached rootfs for ``dockerfile``, if one exists."""
|
||||||
|
base = util.cache_dir() / "rootfs" / f"agent-{_rootfs_digest(dockerfile)}"
|
||||||
|
return base if (base / ".bb-ready").is_file() else None
|
||||||
|
|
||||||
|
|
||||||
def build_agent_rootfs_dir(
|
def build_agent_rootfs_dir(
|
||||||
dockerfile: Path, *, image_tag: str, smoke_test: tuple[str, ...] = (),
|
dockerfile: Path, *, image_tag: str, smoke_test: tuple[str, ...] = (),
|
||||||
) -> Path:
|
) -> Path:
|
||||||
@@ -72,7 +78,7 @@ def build_agent_rootfs_dir(
|
|||||||
silent-failure image at build time rather than at first agent use."""
|
silent-failure image at build time rather than at first agent use."""
|
||||||
digest = _rootfs_digest(dockerfile)
|
digest = _rootfs_digest(dockerfile)
|
||||||
base = util.cache_dir() / "rootfs" / f"agent-{digest}"
|
base = util.cache_dir() / "rootfs" / f"agent-{digest}"
|
||||||
if (base / ".bb-ready").is_file():
|
if cached_agent_rootfs_dir(dockerfile) is not None:
|
||||||
info(f"using cached agent rootfs {base.name}")
|
info(f"using cached agent rootfs {base.name}")
|
||||||
return base
|
return base
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ from . import util
|
|||||||
_ARTIFACT_FORMAT = "1"
|
_ARTIFACT_FORMAT = "1"
|
||||||
|
|
||||||
_REPO_ROOT = Path(__file__).resolve().parents[3]
|
_REPO_ROOT = Path(__file__).resolve().parents[3]
|
||||||
_DOCKERFILES = ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra")
|
_DOCKERFILES = ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra", "Dockerfile.infra.fc")
|
||||||
|
|
||||||
_DEFAULT_BASE = "https://gitea.dideric.is"
|
_DEFAULT_BASE = "https://gitea.dideric.is"
|
||||||
_DEFAULT_OWNER = "didericis"
|
_DEFAULT_OWNER = "didericis"
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ from pathlib import Path
|
|||||||
from typing import Generator
|
from typing import Generator
|
||||||
|
|
||||||
from ...log import die, info
|
from ...log import die, info
|
||||||
|
from .. import util as backend_util
|
||||||
from ..docker import util as docker_mod
|
from ..docker import util as docker_mod
|
||||||
from ..docker.gateway_provision import GatewayProvisionError
|
from ..docker.gateway_provision import GatewayProvisionError
|
||||||
from . import firecracker_vm, infra_artifact, netpool, util
|
from . import firecracker_vm, infra_artifact, netpool, util
|
||||||
@@ -93,19 +94,18 @@ class InfraVm:
|
|||||||
"""The gateway's mitmproxy CA (PEM) that agents install to trust its
|
"""The gateway's mitmproxy CA (PEM) that agents install to trust its
|
||||||
TLS interception. Generated a moment after boot, so this polls over
|
TLS interception. Generated a moment after boot, so this polls over
|
||||||
SSH until it appears (mirrors DockerGateway.ca_cert_pem)."""
|
SSH until it appears (mirrors DockerGateway.ca_cert_pem)."""
|
||||||
deadline = time.monotonic() + timeout
|
def _fetch() -> str | None:
|
||||||
while True:
|
|
||||||
proc = subprocess.run(
|
proc = subprocess.run(
|
||||||
util.ssh_base_argv(self.private_key, self.guest_ip)
|
util.ssh_base_argv(self.private_key, self.guest_ip)
|
||||||
+ [f"cat {_GATEWAY_CA_PATH}"],
|
+ [f"cat {_GATEWAY_CA_PATH}"],
|
||||||
capture_output=True, text=True, timeout=15, check=False,
|
capture_output=True, text=True, timeout=15, check=False,
|
||||||
)
|
)
|
||||||
if proc.returncode == 0 and "BEGIN CERTIFICATE" in proc.stdout:
|
ok = proc.returncode == 0 and "BEGIN CERTIFICATE" in proc.stdout
|
||||||
return proc.stdout
|
return proc.stdout if ok else None
|
||||||
if time.monotonic() >= deadline:
|
try:
|
||||||
die(f"gateway CA not available after {timeout:g}s: "
|
return backend_util.poll_ca_cert(_fetch, timeout=timeout)
|
||||||
f"{proc.stderr.strip() or 'empty'}")
|
except TimeoutError as exc:
|
||||||
time.sleep(_HEALTH_POLL_SECONDS)
|
die(str(exc))
|
||||||
|
|
||||||
|
|
||||||
def ensure_built() -> None:
|
def ensure_built() -> None:
|
||||||
@@ -125,16 +125,19 @@ def ensure_built() -> None:
|
|||||||
|
|
||||||
|
|
||||||
def build_infra_images_with_docker() -> None:
|
def build_infra_images_with_docker() -> None:
|
||||||
"""Build the three fixed images from source with host Docker: orchestrator,
|
"""Build the four fixed images from source with host Docker: orchestrator,
|
||||||
gateway, then the combined infra image (`COPY --from` orchestrator, `FROM`
|
gateway, the shared infra base (Dockerfile.infra), then the Firecracker
|
||||||
gateway). The launch host uses this only in `BOT_BOTTLE_INFRA_BUILD=local`
|
infra image (Dockerfile.infra.fc: FROM infra + buildah). The launch host
|
||||||
mode; `publish_infra` uses it off-host to produce the published artifact."""
|
uses this only in `BOT_BOTTLE_INFRA_BUILD=local` mode; `publish_infra`
|
||||||
|
uses it off-host to produce the published artifact."""
|
||||||
docker_mod.build_image(
|
docker_mod.build_image(
|
||||||
_ORCHESTRATOR_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.orchestrator")
|
_ORCHESTRATOR_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.orchestrator")
|
||||||
docker_mod.build_image(
|
docker_mod.build_image(
|
||||||
_GATEWAY_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.gateway")
|
_GATEWAY_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.gateway")
|
||||||
docker_mod.build_image(
|
docker_mod.build_image(
|
||||||
_INFRA_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.infra")
|
"bot-bottle-infra:latest", str(_REPO_ROOT), dockerfile="Dockerfile.infra")
|
||||||
|
docker_mod.build_image(
|
||||||
|
_INFRA_IMAGE, str(_REPO_ROOT), dockerfile="Dockerfile.infra.fc")
|
||||||
|
|
||||||
|
|
||||||
def build_infra_rootfs_dir() -> Path:
|
def build_infra_rootfs_dir() -> Path:
|
||||||
|
|||||||
@@ -45,13 +45,15 @@ from ...git_gate import (
|
|||||||
provision_git_gate_dynamic_keys,
|
provision_git_gate_dynamic_keys,
|
||||||
revoke_git_gate_provisioned_keys,
|
revoke_git_gate_provisioned_keys,
|
||||||
)
|
)
|
||||||
from ...log import info, warn
|
from ...image_cache import check_stale_path
|
||||||
|
from ...log import die, info, warn
|
||||||
from ...supervise import SUPERVISE_PORT
|
from ...supervise import SUPERVISE_PORT
|
||||||
from ..docker.egress import EGRESS_PORT
|
from ..docker.egress import EGRESS_PORT
|
||||||
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
||||||
from . import firecracker_vm, image_builder, isolation_probe, netpool, util
|
from . import firecracker_vm, image_builder, isolation_probe, netpool, util
|
||||||
from .bottle import FirecrackerBottle
|
from .bottle import FirecrackerBottle
|
||||||
from .bottle_plan import FirecrackerBottlePlan
|
from .bottle_plan import FirecrackerBottlePlan
|
||||||
|
from ...orchestrator.config_store import resolve_teardown_timeout
|
||||||
from .consolidated_launch import (
|
from .consolidated_launch import (
|
||||||
launch_consolidated,
|
launch_consolidated,
|
||||||
teardown_consolidated,
|
teardown_consolidated,
|
||||||
@@ -64,6 +66,7 @@ _GIT_HTTP_PORT = 9420
|
|||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(
|
def launch(
|
||||||
plan: FirecrackerBottlePlan,
|
plan: FirecrackerBottlePlan,
|
||||||
|
agent_base: Path,
|
||||||
*,
|
*,
|
||||||
provision: Callable[[FirecrackerBottlePlan, "FirecrackerBottle"], str | None],
|
provision: Callable[[FirecrackerBottlePlan, "FirecrackerBottle"], str | None],
|
||||||
) -> Generator[FirecrackerBottle, None, None]:
|
) -> Generator[FirecrackerBottle, None, None]:
|
||||||
@@ -85,11 +88,9 @@ def launch(
|
|||||||
raise teardown_exc
|
raise teardown_exc
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Step 1: agent rootfs. Built from the Dockerfile inside a Firecracker
|
# Step 1 (rootfs resolution/build) runs in BottleBackend.launch before
|
||||||
# builder VM (buildah, no host docker); a committed snapshot is reused
|
# this context starts resources. ``agent_base`` is the selected cache,
|
||||||
# when present. Returns the base dir the per-bottle ext4 is made from.
|
# fresh build, or committed snapshot.
|
||||||
plan, agent_base = _build_agent_base(plan)
|
|
||||||
|
|
||||||
# Step 2: mint the git-gate dynamic (gitea) deploy keys, if any.
|
# Step 2: mint the git-gate dynamic (gitea) deploy keys, if any.
|
||||||
git_gate_plan = plan.git_gate_plan
|
git_gate_plan = plan.git_gate_plan
|
||||||
if git_gate_plan.upstreams:
|
if git_gate_plan.upstreams:
|
||||||
@@ -112,6 +113,7 @@ def launch(
|
|||||||
token_values = egress_resolve_token_values(
|
token_values = egress_resolve_token_values(
|
||||||
plan.egress_plan.token_env_map, effective_env,
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
)
|
)
|
||||||
|
teardown_timeout = resolve_teardown_timeout()
|
||||||
ctx = launch_consolidated(
|
ctx = launch_consolidated(
|
||||||
plan.egress_plan, git_gate_plan,
|
plan.egress_plan, git_gate_plan,
|
||||||
guest_ip=slot.guest_ip,
|
guest_ip=slot.guest_ip,
|
||||||
@@ -121,6 +123,7 @@ def launch(
|
|||||||
stack.callback(
|
stack.callback(
|
||||||
teardown_consolidated, ctx.bottle_id,
|
teardown_consolidated, ctx.bottle_id,
|
||||||
orchestrator_url=ctx.orchestrator_url,
|
orchestrator_url=ctx.orchestrator_url,
|
||||||
|
timeout=teardown_timeout,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Step 5: install the SHARED gateway CA (replaces the per-bottle CA).
|
# Step 5: install the SHARED gateway CA (replaces the per-bottle CA).
|
||||||
@@ -206,9 +209,7 @@ def launch(
|
|||||||
teardown()
|
teardown()
|
||||||
|
|
||||||
|
|
||||||
def _build_agent_base(
|
def build_or_load_agent_base(plan: FirecrackerBottlePlan) -> Path:
|
||||||
plan: FirecrackerBottlePlan,
|
|
||||||
) -> tuple[FirecrackerBottlePlan, Path]:
|
|
||||||
"""Produce the agent's base rootfs dir. Primary path: build the Dockerfile
|
"""Produce the agent's base rootfs dir. Primary path: build the Dockerfile
|
||||||
inside a Firecracker builder VM (buildah, no host docker), smoke-testing
|
inside a Firecracker builder VM (buildah, no host docker), smoke-testing
|
||||||
the image before export. A committed snapshot (freeze/migrate) is resumed
|
the image before export. A committed snapshot (freeze/migrate) is resumed
|
||||||
@@ -217,13 +218,36 @@ def _build_agent_base(
|
|||||||
committed_tar = committed_rootfs_path(plan.slug)
|
committed_tar = committed_rootfs_path(plan.slug)
|
||||||
if committed and committed_tar.is_file():
|
if committed and committed_tar.is_file():
|
||||||
info(f"resuming from committed rootfs {committed_tar}")
|
info(f"resuming from committed rootfs {committed_tar}")
|
||||||
return plan, util.build_committed_rootfs_dir(committed_tar)
|
return util.build_committed_rootfs_dir(committed_tar)
|
||||||
base = image_builder.build_agent_rootfs_dir(
|
dockerfile = Path(plan.dockerfile_path)
|
||||||
Path(plan.dockerfile_path),
|
if plan.spec.image_policy == "cached":
|
||||||
|
cached = image_builder.cached_agent_rootfs_dir(dockerfile)
|
||||||
|
if cached is None:
|
||||||
|
die(
|
||||||
|
f"cached agent rootfs for {plan.image!r} not found; "
|
||||||
|
"run without --cached-images to build it"
|
||||||
|
)
|
||||||
|
info(f"using cached agent rootfs {cached.name}")
|
||||||
|
return cached
|
||||||
|
return image_builder.build_agent_rootfs_dir(
|
||||||
|
dockerfile,
|
||||||
image_tag=plan.image,
|
image_tag=plan.image,
|
||||||
smoke_test=runtime_for(plan.agent_provider_template).smoke_test,
|
smoke_test=runtime_for(plan.agent_provider_template).smoke_test,
|
||||||
)
|
)
|
||||||
return plan, base
|
|
||||||
|
|
||||||
|
def stale_checks(plan: FirecrackerBottlePlan) -> None:
|
||||||
|
"""Raise when the cached rootfs selected by this plan is stale."""
|
||||||
|
if plan.spec.image_policy != "cached":
|
||||||
|
return
|
||||||
|
committed = read_committed_image(plan.slug)
|
||||||
|
committed_tar = committed_rootfs_path(plan.slug)
|
||||||
|
if committed and committed_tar.is_file():
|
||||||
|
check_stale_path(f"agent rootfs {committed_tar}", committed_tar)
|
||||||
|
return
|
||||||
|
cached = image_builder.cached_agent_rootfs_dir(Path(plan.dockerfile_path))
|
||||||
|
if cached is not None:
|
||||||
|
check_stale_path(f"agent rootfs {cached}", cached / ".bb-ready")
|
||||||
|
|
||||||
|
|
||||||
# --- agent guest env -------------------------------------------------
|
# --- agent guest env -------------------------------------------------
|
||||||
@@ -239,6 +263,11 @@ def _agent_guest_env(plan: FirecrackerBottlePlan, host_ip: str) -> dict[str, str
|
|||||||
"HTTPS_PROXY": proxy_url, "HTTP_PROXY": proxy_url,
|
"HTTPS_PROXY": proxy_url, "HTTP_PROXY": proxy_url,
|
||||||
"https_proxy": proxy_url, "http_proxy": proxy_url,
|
"https_proxy": proxy_url, "http_proxy": proxy_url,
|
||||||
"NO_PROXY": no_proxy, "no_proxy": no_proxy,
|
"NO_PROXY": no_proxy, "no_proxy": no_proxy,
|
||||||
|
# Rootfs export can leave Git's implicit XDG paths unreadable even
|
||||||
|
# after the runtime repair. Bypass that discovery and name the
|
||||||
|
# provisioned global config explicitly so insteadOf can never fall
|
||||||
|
# through to the credential-bearing upstream URL.
|
||||||
|
"GIT_CONFIG_GLOBAL": f"{plan.guest_home}/.gitconfig",
|
||||||
"NODE_EXTRA_CA_CERTS": AGENT_CA_PATH,
|
"NODE_EXTRA_CA_CERTS": AGENT_CA_PATH,
|
||||||
"SSL_CERT_FILE": AGENT_CA_BUNDLE,
|
"SSL_CERT_FILE": AGENT_CA_BUNDLE,
|
||||||
"REQUESTS_CA_BUNDLE": AGENT_CA_BUNDLE,
|
"REQUESTS_CA_BUNDLE": AGENT_CA_BUNDLE,
|
||||||
|
|||||||
@@ -131,6 +131,29 @@ def build_artifact(out_dir: Path) -> tuple[str, Path, Path]:
|
|||||||
return version, gz, sha
|
return version, gz, sha
|
||||||
|
|
||||||
|
|
||||||
|
def _try_download_published(out_dir: Path) -> tuple[str, Path, Path] | None:
|
||||||
|
"""If this version's artifact is already in the registry, download the gz
|
||||||
|
and sha to out_dir and return (version, gz_path, sha_path). Returns None
|
||||||
|
when not yet published."""
|
||||||
|
version = infra_artifact.infra_artifact_version(infra_vm._infra_init())
|
||||||
|
sha_url = infra_artifact.artifact_url(version, "rootfs.ext4.gz.sha256")
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(infra_artifact._open(sha_url)):
|
||||||
|
pass
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
if e.code == 404:
|
||||||
|
return None
|
||||||
|
raise SystemExit(f"registry check failed (HTTP {e.code}): {sha_url}")
|
||||||
|
except urllib.error.URLError as e:
|
||||||
|
raise SystemExit(f"registry unreachable: {sha_url} ({e.reason})")
|
||||||
|
print(f"infra rootfs {version} already published — downloading instead of building")
|
||||||
|
gz = out_dir / "rootfs.ext4.gz"
|
||||||
|
sha = out_dir / "rootfs.ext4.gz.sha256"
|
||||||
|
infra_artifact._download(infra_artifact.artifact_url(version, "rootfs.ext4.gz"), gz)
|
||||||
|
infra_artifact._download(infra_artifact.artifact_url(version, "rootfs.ext4.gz.sha256"), sha)
|
||||||
|
return version, gz, sha
|
||||||
|
|
||||||
|
|
||||||
def _publish_bundle(root: Path, token: str) -> str:
|
def _publish_bundle(root: Path, token: str) -> str:
|
||||||
version_file = root / "version.txt"
|
version_file = root / "version.txt"
|
||||||
# Guard the read so a missing version.txt is a clean error, not a raw
|
# Guard the read so a missing version.txt is a clean error, not a raw
|
||||||
@@ -187,6 +210,8 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
help="build a candidate bundle in DIR without publishing")
|
help="build a candidate bundle in DIR without publishing")
|
||||||
mode.add_argument("--publish-dir", type=Path,
|
mode.add_argument("--publish-dir", type=Path,
|
||||||
help="publish an already-built and tested candidate bundle")
|
help="publish an already-built and tested candidate bundle")
|
||||||
|
parser.add_argument("--reuse-published", action="store_true",
|
||||||
|
help="with --output: download from registry if already published instead of building")
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
_, _, token = infra_artifact._config()
|
_, _, token = infra_artifact._config()
|
||||||
@@ -197,6 +222,14 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
|
|
||||||
if args.output is not None:
|
if args.output is not None:
|
||||||
args.output.mkdir(parents=True, exist_ok=True)
|
args.output.mkdir(parents=True, exist_ok=True)
|
||||||
|
reused = None
|
||||||
|
if args.reuse_published:
|
||||||
|
reused = _try_download_published(args.output)
|
||||||
|
if reused is not None:
|
||||||
|
version, _, _ = reused
|
||||||
|
(args.output / "version.txt").write_text(version + "\n", encoding="utf-8")
|
||||||
|
print(f"reused published infra rootfs candidate {version}")
|
||||||
|
return 0
|
||||||
version, _gz, _sha = build_artifact(args.output)
|
version, _gz, _sha = build_artifact(args.output)
|
||||||
(args.output / "version.txt").write_text(version + "\n", encoding="utf-8")
|
(args.output / "version.txt").write_text(version + "\n", encoding="utf-8")
|
||||||
print(f"built infra rootfs candidate {version}")
|
print(f"built infra rootfs candidate {version}")
|
||||||
|
|||||||
@@ -373,6 +373,12 @@ mount -o remount,rw / 2>/dev/null
|
|||||||
# scratch dirs there — git worktrees, build temp, `git init /tmp/...`, etc.
|
# scratch dirs there — git worktrees, build temp, `git init /tmp/...`, etc.
|
||||||
mkdir -p /tmp && chmod 1777 /tmp
|
mkdir -p /tmp && chmod 1777 /tmp
|
||||||
|
|
||||||
|
# Rootfs export also maps the image's original owners to the unprivileged
|
||||||
|
# host build uid. That uid is not guaranteed to be node's uid in the guest;
|
||||||
|
# restore the home-directory boundary before any SSH provisioning runs.
|
||||||
|
chown node:node /home/node 2>/dev/null || true
|
||||||
|
chmod 755 /home/node 2>/dev/null || true
|
||||||
|
|
||||||
# Install the per-bottle SSH pubkey from the kernel cmdline.
|
# Install the per-bottle SSH pubkey from the kernel cmdline.
|
||||||
KEY=$(sed -n 's/.*bb_pubkey=\([^ ]*\).*/\1/p' /proc/cmdline | base64 -d 2>/dev/null)
|
KEY=$(sed -n 's/.*bb_pubkey=\([^ ]*\).*/\1/p' /proc/cmdline | base64 -d 2>/dev/null)
|
||||||
if [ -n "$KEY" ]; then
|
if [ -n "$KEY" ]; then
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ from ...env import ResolvedEnv
|
|||||||
from ...git_gate import GitGatePlan
|
from ...git_gate import GitGatePlan
|
||||||
from ...supervise import SupervisePlan
|
from ...supervise import SupervisePlan
|
||||||
from ...manifest import Manifest
|
from ...manifest import Manifest
|
||||||
from .. import ActiveAgent, BottleBackend, BottleSpec
|
from .. import ActiveAgent, BottleBackend, BottleImages, BottleSpec
|
||||||
from . import cleanup as _cleanup
|
from . import cleanup as _cleanup
|
||||||
from . import enumerate as _enumerate
|
from . import enumerate as _enumerate
|
||||||
from . import launch as _launch
|
from . import launch as _launch
|
||||||
@@ -31,6 +31,7 @@ class MacosContainerBottleBackend(
|
|||||||
`--backend=macos-container`."""
|
`--backend=macos-container`."""
|
||||||
|
|
||||||
name = "macos-container"
|
name = "macos-container"
|
||||||
|
supports_nested_containers = True
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def is_available(cls) -> bool:
|
def is_available(cls) -> bool:
|
||||||
@@ -82,11 +83,17 @@ class MacosContainerBottleBackend(
|
|||||||
stage_dir=stage_dir,
|
stage_dir=stage_dir,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def prelaunch_checks(self, plan: MacosContainerBottlePlan) -> None:
|
||||||
|
_launch.stale_checks(plan)
|
||||||
|
|
||||||
|
def _build_or_load_images(self, plan: MacosContainerBottlePlan) -> BottleImages:
|
||||||
|
return _launch.build_or_load_images(plan)
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(
|
def _launch_impl(
|
||||||
self, plan: MacosContainerBottlePlan
|
self, plan: MacosContainerBottlePlan, images: BottleImages
|
||||||
) -> Generator[MacosContainerBottle, None, None]:
|
) -> Generator[MacosContainerBottle, None, None]:
|
||||||
with _launch.launch(plan, provision=self.provision) as bottle:
|
with _launch.launch(plan, images, provision=self.provision) as bottle:
|
||||||
yield bottle
|
yield bottle
|
||||||
|
|
||||||
def ensure_orchestrator(self) -> str:
|
def ensure_orchestrator(self) -> str:
|
||||||
|
|||||||
@@ -20,6 +20,9 @@ class MacosContainerBottlePlan(BottlePlan):
|
|||||||
# bottle is registered. See launch.py's stamp for why it lives here and not
|
# bottle is registered. See launch.py's stamp for why it lives here and not
|
||||||
# only in the exec-time proxy env.
|
# only in the exec-time proxy env.
|
||||||
identity_token: str = ""
|
identity_token: str = ""
|
||||||
|
# Guest-local container engine (issue #392). Gates the derived image, the
|
||||||
|
# device-mode relaxation, and the resident podman service.
|
||||||
|
nested_containers: bool = False
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def container_name(self) -> str:
|
def container_name(self) -> str:
|
||||||
|
|||||||
@@ -36,9 +36,11 @@ from dataclasses import dataclass
|
|||||||
|
|
||||||
from ...egress import EgressPlan
|
from ...egress import EgressPlan
|
||||||
from ...git_gate import GitGatePlan
|
from ...git_gate import GitGatePlan
|
||||||
from ...orchestrator.client import OrchestratorClient
|
from ...log import info
|
||||||
from ...orchestrator.registration import registration_inputs
|
from ...orchestrator.client import OrchestratorClient, OrchestratorClientError
|
||||||
from ..docker.gateway_provision import deprovision_git_gate, provision_git_gate
|
from ..consolidated_util import provision_bottle, teardown_consolidated as _teardown_util
|
||||||
|
from . import util as container_mod
|
||||||
|
from .enumerate import CONTAINER_NAME_PREFIX, EnumerationError, enumerate_active
|
||||||
from .gateway import GATEWAY_NETWORK
|
from .gateway import GATEWAY_NETWORK
|
||||||
from .gateway_provision import AppleGatewayTransport
|
from .gateway_provision import AppleGatewayTransport
|
||||||
from .infra import MacosInfraService, OrchestratorStartError
|
from .infra import MacosInfraService, OrchestratorStartError
|
||||||
@@ -89,6 +91,32 @@ def ensure_gateway(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def live_source_ips(network: str) -> list[str]:
|
||||||
|
"""Every running agent container's address on `network`.
|
||||||
|
|
||||||
|
The reconciliation input: the orchestrator lives inside the infra
|
||||||
|
container and cannot enumerate the host's containers, so the host has to
|
||||||
|
tell it which bottles are actually up. Containers that have not been
|
||||||
|
assigned an address yet contribute nothing — the reap's grace window, not
|
||||||
|
this list, is what protects an in-flight launch.
|
||||||
|
|
||||||
|
Raises `EnumerationError` when the live set cannot be determined
|
||||||
|
authoritatively: either the container listing fails or any individual
|
||||||
|
inspect fails. Callers must skip reconciliation in that case to avoid
|
||||||
|
unregistering healthy bottles."""
|
||||||
|
ips: list[str] = []
|
||||||
|
for agent in enumerate_active():
|
||||||
|
name = f"{CONTAINER_NAME_PREFIX}{agent.slug}"
|
||||||
|
ip = container_mod.inspect_container_network_ip(name, network)
|
||||||
|
if ip is None:
|
||||||
|
raise EnumerationError(
|
||||||
|
f"container inspect {name!r} failed; live set is not authoritative"
|
||||||
|
)
|
||||||
|
if ip:
|
||||||
|
ips.append(ip)
|
||||||
|
return ips
|
||||||
|
|
||||||
|
|
||||||
def register_agent(
|
def register_agent(
|
||||||
egress_plan: EgressPlan,
|
egress_plan: EgressPlan,
|
||||||
git_gate_plan: GitGatePlan,
|
git_gate_plan: GitGatePlan,
|
||||||
@@ -103,17 +131,20 @@ def register_agent(
|
|||||||
container — it is the attribution key the gateway resolves policy by.
|
container — it is the attribution key the gateway resolves policy by.
|
||||||
Raises on failure; the caller tears down."""
|
Raises on failure; the caller tears down."""
|
||||||
client = OrchestratorClient(endpoint.orchestrator_url)
|
client = OrchestratorClient(endpoint.orchestrator_url)
|
||||||
inputs = registration_inputs(egress_plan)
|
# Self-heal before registering: a launcher that died hard (SIGKILL, closed
|
||||||
reg = client.register_bottle(
|
# terminal, host sleep) never ran its teardown callback, leaving an active
|
||||||
source_ip, image_ref=image_ref, policy=inputs.policy,
|
# row with no container. vmnet recycles addresses, so such a row can
|
||||||
metadata=inputs.metadata, tokens=tokens,
|
# collide with this bottle's — and `by_source_ip` fail-closes on ambiguity,
|
||||||
)
|
# which would resolve no policy at all and deny every host. Best-effort: a
|
||||||
|
# reconciliation failure must not block an otherwise-fine launch.
|
||||||
try:
|
try:
|
||||||
provision_git_gate(AppleGatewayTransport(), reg.bottle_id, git_gate_plan)
|
client.reconcile(live_source_ips(endpoint.network))
|
||||||
except Exception:
|
except (OrchestratorClientError, EnumerationError) as e:
|
||||||
# Roll the registration back so a provisioning failure leaves no orphan.
|
info(f"registry reconciliation skipped: {e}")
|
||||||
client.teardown_bottle(reg.bottle_id)
|
reg = provision_bottle(
|
||||||
raise
|
client, source_ip, egress_plan, git_gate_plan, AppleGatewayTransport(),
|
||||||
|
image_ref=image_ref, tokens=tokens,
|
||||||
|
)
|
||||||
return LaunchContext(
|
return LaunchContext(
|
||||||
bottle_id=reg.bottle_id,
|
bottle_id=reg.bottle_id,
|
||||||
identity_token=reg.identity_token,
|
identity_token=reg.identity_token,
|
||||||
@@ -124,18 +155,21 @@ def register_agent(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def teardown_consolidated(bottle_id: str, *, orchestrator_url: str) -> None:
|
def teardown_consolidated(
|
||||||
|
bottle_id: str, *, orchestrator_url: str, timeout: float | None = None,
|
||||||
|
) -> None:
|
||||||
"""Deregister the bottle and remove its git-gate state from the gateway.
|
"""Deregister the bottle and remove its git-gate state from the gateway.
|
||||||
Both steps are idempotent so this is safe from a cleanup trap. Does NOT
|
Both steps are idempotent so this is safe from a cleanup trap. Does NOT
|
||||||
stop the gateway — it's a persistent per-host singleton."""
|
stop the gateway — it's a persistent per-host singleton."""
|
||||||
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
_teardown_util(bottle_id, AppleGatewayTransport(),
|
||||||
deprovision_git_gate(AppleGatewayTransport(), bottle_id)
|
orchestrator_url=orchestrator_url, timeout=timeout)
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"GatewayEndpoint",
|
"GatewayEndpoint",
|
||||||
"LaunchContext",
|
"LaunchContext",
|
||||||
"ensure_gateway",
|
"ensure_gateway",
|
||||||
|
"live_source_ips",
|
||||||
"register_agent",
|
"register_agent",
|
||||||
"teardown_consolidated",
|
"teardown_consolidated",
|
||||||
"ConsolidatedLaunchError",
|
"ConsolidatedLaunchError",
|
||||||
|
|||||||
@@ -19,6 +19,10 @@ CONTAINER_NAME_PREFIX = "bot-bottle-"
|
|||||||
_INFRA_NAMES = frozenset({INFRA_NAME})
|
_INFRA_NAMES = frozenset({INFRA_NAME})
|
||||||
|
|
||||||
|
|
||||||
|
class EnumerationError(RuntimeError):
|
||||||
|
"""container list failed; the resulting live set is not authoritative."""
|
||||||
|
|
||||||
|
|
||||||
def enumerate_active() -> list[ActiveAgent]:
|
def enumerate_active() -> list[ActiveAgent]:
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["container", "list", "--quiet"],
|
["container", "list", "--quiet"],
|
||||||
@@ -27,7 +31,10 @@ def enumerate_active() -> list[ActiveAgent]:
|
|||||||
check=False,
|
check=False,
|
||||||
)
|
)
|
||||||
if result.returncode != 0:
|
if result.returncode != 0:
|
||||||
return []
|
raise EnumerationError(
|
||||||
|
f"container list failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
out: list[ActiveAgent] = []
|
out: list[ActiveAgent] = []
|
||||||
for name in sorted(line.strip() for line in result.stdout.splitlines()):
|
for name in sorted(line.strip() for line in result.stdout.splitlines()):
|
||||||
if not name.startswith(CONTAINER_NAME_PREFIX) or name in _INFRA_NAMES:
|
if not name.startswith(CONTAINER_NAME_PREFIX) or name in _INFRA_NAMES:
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ from dataclasses import dataclass
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from ... import log
|
from ... import log
|
||||||
from ...orchestrator.gateway import GATEWAY_CA_CERT
|
from ...orchestrator.gateway import GATEWAY_CA_CERT, MITMPROXY_HOME
|
||||||
from ...orchestrator.lifecycle import (
|
from ...orchestrator.lifecycle import (
|
||||||
DEFAULT_PORT,
|
DEFAULT_PORT,
|
||||||
DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
||||||
@@ -52,7 +52,9 @@ from ...paths import (
|
|||||||
CONTROL_PLANE_TOKEN_ENV,
|
CONTROL_PLANE_TOKEN_ENV,
|
||||||
HOST_DB_FILENAME,
|
HOST_DB_FILENAME,
|
||||||
host_control_plane_token,
|
host_control_plane_token,
|
||||||
|
host_gateway_ca_dir,
|
||||||
)
|
)
|
||||||
|
from .. import util as backend_util
|
||||||
from . import util as container_mod
|
from . import util as container_mod
|
||||||
from .gateway import (
|
from .gateway import (
|
||||||
DEFAULT_CA_TIMEOUT_SECONDS,
|
DEFAULT_CA_TIMEOUT_SECONDS,
|
||||||
@@ -217,6 +219,14 @@ class MacosInfraService:
|
|||||||
# Container-only DB volume: one kernel writes bot-bottle.db, never
|
# Container-only DB volume: one kernel writes bot-bottle.db, never
|
||||||
# shared with the host or another guest.
|
# shared with the host or another guest.
|
||||||
"--volume", f"{self._db_volume}:{_DB_ROOT_IN_CONTAINER}",
|
"--volume", f"{self._db_volume}:{_DB_ROOT_IN_CONTAINER}",
|
||||||
|
# The DB needs a container-only ext4 volume for coherent SQLite
|
||||||
|
# locking, but the CA has no such constraint. Keep it in the host
|
||||||
|
# app-data root so infra-container recreation and Apple Container
|
||||||
|
# volume pruning cannot silently rotate every bottle's trust
|
||||||
|
# anchor (issue #450).
|
||||||
|
"--mount",
|
||||||
|
container_mod.bind_mount_spec(
|
||||||
|
str(host_gateway_ca_dir()), MITMPROXY_HOME),
|
||||||
# Bind-mount the control-plane source (read-only); a code change
|
# Bind-mount the control-plane source (read-only); a code change
|
||||||
# takes effect on relaunch with no image rebuild.
|
# takes effect on relaunch with no image rebuild.
|
||||||
"--mount",
|
"--mount",
|
||||||
@@ -260,21 +270,19 @@ class MacosInfraService:
|
|||||||
|
|
||||||
def ca_cert_pem(self, *, timeout: float = DEFAULT_CA_TIMEOUT_SECONDS) -> str:
|
def ca_cert_pem(self, *, timeout: float = DEFAULT_CA_TIMEOUT_SECONDS) -> str:
|
||||||
"""The gateway's mitmproxy CA (PEM) agents install to trust its TLS
|
"""The gateway's mitmproxy CA (PEM) agents install to trust its TLS
|
||||||
interception. Read out of the container (the CA lives on a
|
interception. Read through the container path backed by the persistent
|
||||||
container-internal path, not a host mount); polls because mitmproxy
|
host CA directory; polls because mitmproxy writes it a beat after
|
||||||
writes it a beat after start."""
|
start."""
|
||||||
deadline = time.monotonic() + timeout
|
def _fetch() -> str | None:
|
||||||
while True:
|
|
||||||
result = container_mod.run_container_argv(
|
result = container_mod.run_container_argv(
|
||||||
["container", "exec", self._name, "cat", GATEWAY_CA_CERT])
|
["container", "exec", self._name, "cat", GATEWAY_CA_CERT])
|
||||||
if result.returncode == 0 and result.stdout.strip():
|
return result.stdout if result.returncode == 0 and result.stdout.strip() else None
|
||||||
return result.stdout
|
try:
|
||||||
if time.monotonic() >= deadline:
|
return backend_util.poll_ca_cert(_fetch, timeout=timeout)
|
||||||
raise GatewayError(
|
except TimeoutError as exc:
|
||||||
f"gateway CA not available in {self._name} after {timeout:g}s: "
|
raise GatewayError(
|
||||||
f"{(result.stderr or '').strip() or 'empty'}"
|
f"gateway CA not available in {self._name} after {timeout:g}s"
|
||||||
)
|
) from exc
|
||||||
time.sleep(_CA_POLL_SECONDS)
|
|
||||||
|
|
||||||
def stop(self) -> None:
|
def stop(self) -> None:
|
||||||
"""Remove the infra container (idempotent). The DB volume persists."""
|
"""Remove the infra container (idempotent). The DB volume persists."""
|
||||||
|
|||||||
@@ -53,7 +53,9 @@ from ...git_gate import (
|
|||||||
revoke_git_gate_provisioned_keys,
|
revoke_git_gate_provisioned_keys,
|
||||||
)
|
)
|
||||||
from ...git_http_backend import DEFAULT_PORT as _GIT_HTTP_PORT
|
from ...git_http_backend import DEFAULT_PORT as _GIT_HTTP_PORT
|
||||||
|
from ...image_cache import check_stale
|
||||||
from ...log import die, info, warn
|
from ...log import die, info, warn
|
||||||
|
from .. import BottleImages
|
||||||
from ...supervise import SUPERVISE_PORT
|
from ...supervise import SUPERVISE_PORT
|
||||||
from ..docker.egress import EGRESS_PORT
|
from ..docker.egress import EGRESS_PORT
|
||||||
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
||||||
@@ -64,7 +66,9 @@ from .gateway_hosts import (
|
|||||||
refresh_gateway_host,
|
refresh_gateway_host,
|
||||||
set_gateway_host,
|
set_gateway_host,
|
||||||
)
|
)
|
||||||
|
from . import nested_containers as nested_containers_mod
|
||||||
from .bottle_plan import MacosContainerBottlePlan
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
|
from ...orchestrator.config_store import resolve_teardown_timeout
|
||||||
from .consolidated_launch import (
|
from .consolidated_launch import (
|
||||||
GatewayEndpoint,
|
GatewayEndpoint,
|
||||||
ensure_gateway,
|
ensure_gateway,
|
||||||
@@ -76,18 +80,69 @@ _REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
|||||||
_AGENT_SLEEP_SECONDS = "2147483647"
|
_AGENT_SLEEP_SECONDS = "2147483647"
|
||||||
|
|
||||||
|
|
||||||
|
def build_or_load_images(plan: MacosContainerBottlePlan) -> BottleImages:
|
||||||
|
"""Resolve the agent image ref for this plan. The gateway's own image is
|
||||||
|
built by `ensure_gateway` — it belongs to the shared singleton."""
|
||||||
|
return BottleImages(agent=_layer_nested_containers(plan, _agent_image(plan)))
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_image(plan: MacosContainerBottlePlan) -> str:
|
||||||
|
committed = read_committed_image(plan.slug)
|
||||||
|
if committed and container_mod.image_exists(committed):
|
||||||
|
info(f"using committed image {committed!r}")
|
||||||
|
return committed
|
||||||
|
if plan.spec.image_policy == "cached":
|
||||||
|
if not container_mod.image_exists(plan.image):
|
||||||
|
die(
|
||||||
|
f"cached agent image {plan.image!r} not found; "
|
||||||
|
"run without --cached-images to build it"
|
||||||
|
)
|
||||||
|
info(f"using cached agent image {plan.image!r}")
|
||||||
|
return plan.image
|
||||||
|
container_mod.build_image(plan.image, _REPO_DIR, dockerfile=plan.dockerfile_path)
|
||||||
|
return plan.image
|
||||||
|
|
||||||
|
|
||||||
|
def _layer_nested_containers(
|
||||||
|
plan: MacosContainerBottlePlan, agent_image: str,
|
||||||
|
) -> str:
|
||||||
|
"""Add the guest-local container tooling on top of the agent image.
|
||||||
|
|
||||||
|
A separate derived tag, not the provider Dockerfile, so bottles that never
|
||||||
|
ask for nested containers carry none of its weight.
|
||||||
|
"""
|
||||||
|
if not plan.nested_containers:
|
||||||
|
return agent_image
|
||||||
|
derived = f"{agent_image}{nested_containers_mod.IMAGE_SUFFIX}"
|
||||||
|
if plan.spec.image_policy == "cached":
|
||||||
|
if not container_mod.image_exists(derived):
|
||||||
|
die(
|
||||||
|
f"cached nested-container image {derived!r} not found; "
|
||||||
|
"run without --cached-images to build it"
|
||||||
|
)
|
||||||
|
info(f"using cached nested-container image {derived!r}")
|
||||||
|
return derived
|
||||||
|
return nested_containers_mod.build_image(agent_image, container_mod.build_image)
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def launch(
|
def launch(
|
||||||
plan: MacosContainerBottlePlan,
|
plan: MacosContainerBottlePlan,
|
||||||
|
images: BottleImages,
|
||||||
*,
|
*,
|
||||||
provision: Callable[[MacosContainerBottlePlan, "MacosContainerBottle"], str | None],
|
provision: Callable[[MacosContainerBottlePlan, "MacosContainerBottle"], str | None],
|
||||||
) -> Generator[MacosContainerBottle, None, None]:
|
) -> Generator[MacosContainerBottle, None, None]:
|
||||||
"""Build, run, register, provision, and yield an Apple Container bottle on
|
"""Run, register, provision, and yield an Apple Container bottle on the
|
||||||
the shared per-host gateway."""
|
shared per-host gateway."""
|
||||||
stack = ExitStack()
|
stack = ExitStack()
|
||||||
bottle_for_revoke = plan.manifest.bottle
|
bottle_for_revoke = plan.manifest.bottle
|
||||||
git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
||||||
|
|
||||||
|
plan = dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
agent_provision=dataclasses.replace(plan.agent_provision, image=str(images.agent)),
|
||||||
|
)
|
||||||
|
|
||||||
def teardown() -> None:
|
def teardown() -> None:
|
||||||
teardown_exc: BaseException | None = None
|
teardown_exc: BaseException | None = None
|
||||||
try:
|
try:
|
||||||
@@ -100,8 +155,6 @@ def launch(
|
|||||||
raise teardown_exc
|
raise teardown_exc
|
||||||
|
|
||||||
try:
|
try:
|
||||||
plan = _build_images(plan)
|
|
||||||
|
|
||||||
# Step 1: the per-host singletons. Must precede the agent run — its
|
# Step 1: the per-host singletons. Must precede the agent run — its
|
||||||
# proxy env needs the gateway's address at `container run` time.
|
# proxy env needs the gateway's address at `container run` time.
|
||||||
endpoint = ensure_gateway()
|
endpoint = ensure_gateway()
|
||||||
@@ -142,6 +195,7 @@ def launch(
|
|||||||
token_values = egress_resolve_token_values(
|
token_values = egress_resolve_token_values(
|
||||||
plan.egress_plan.token_env_map, effective_env,
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
)
|
)
|
||||||
|
teardown_timeout = resolve_teardown_timeout()
|
||||||
ctx = register_agent(
|
ctx = register_agent(
|
||||||
plan.egress_plan,
|
plan.egress_plan,
|
||||||
plan.git_gate_plan,
|
plan.git_gate_plan,
|
||||||
@@ -153,6 +207,7 @@ def launch(
|
|||||||
stack.callback(
|
stack.callback(
|
||||||
teardown_consolidated, ctx.bottle_id,
|
teardown_consolidated, ctx.bottle_id,
|
||||||
orchestrator_url=ctx.orchestrator_url,
|
orchestrator_url=ctx.orchestrator_url,
|
||||||
|
timeout=teardown_timeout,
|
||||||
)
|
)
|
||||||
info(
|
info(
|
||||||
f"agent {plan.container_name} registered "
|
f"agent {plan.container_name} registered "
|
||||||
@@ -168,6 +223,10 @@ def launch(
|
|||||||
# token above, so — unlike the run-time env — the plan CAN carry it.
|
# token above, so — unlike the run-time env — the plan CAN carry it.
|
||||||
plan = dataclasses.replace(plan, identity_token=ctx.identity_token)
|
plan = dataclasses.replace(plan, identity_token=ctx.identity_token)
|
||||||
|
|
||||||
|
exec_env = {
|
||||||
|
**_identity_proxy_env(endpoint, ctx.identity_token),
|
||||||
|
**nested_containers_mod.guest_env(plan.nested_containers),
|
||||||
|
}
|
||||||
bottle = MacosContainerBottle(
|
bottle = MacosContainerBottle(
|
||||||
plan.container_name,
|
plan.container_name,
|
||||||
teardown,
|
teardown,
|
||||||
@@ -181,31 +240,38 @@ def launch(
|
|||||||
),
|
),
|
||||||
terminal_color=plan.spec.color,
|
terminal_color=plan.spec.color,
|
||||||
agent_workdir=plan.workspace_plan.workdir,
|
agent_workdir=plan.workspace_plan.workdir,
|
||||||
exec_env=_identity_proxy_env(endpoint, ctx.identity_token),
|
exec_env=exec_env,
|
||||||
)
|
)
|
||||||
bottle.prompt_path = provision(plan, bottle)
|
bottle.prompt_path = provision(plan, bottle)
|
||||||
|
|
||||||
|
if plan.nested_containers:
|
||||||
|
nested_containers_mod.prepare_guest_devices(
|
||||||
|
plan.container_name, container_mod.exec_container_as_root,
|
||||||
|
)
|
||||||
|
nested_containers_mod.start(bottle)
|
||||||
|
|
||||||
yield bottle
|
yield bottle
|
||||||
finally:
|
finally:
|
||||||
teardown()
|
teardown()
|
||||||
|
|
||||||
|
|
||||||
def _build_images(plan: MacosContainerBottlePlan) -> MacosContainerBottlePlan:
|
|
||||||
"""Build the agent image. The gateway's own image is built by
|
def stale_checks(plan: MacosContainerBottlePlan) -> None:
|
||||||
`ensure_gateway` — it belongs to the shared singleton, not to a bottle."""
|
"""Raise StaleImageError if a cached image is older than the configured
|
||||||
|
threshold. Only runs when image_policy is 'cached'. Called by the backend
|
||||||
|
class's _image_stale_checks before _launch_impl starts any resources."""
|
||||||
|
if plan.spec.image_policy != "cached":
|
||||||
|
return
|
||||||
committed = read_committed_image(plan.slug)
|
committed = read_committed_image(plan.slug)
|
||||||
if committed and container_mod.image_exists(committed):
|
if committed and container_mod.image_exists(committed):
|
||||||
info(f"using committed image {committed!r}")
|
ts = container_mod.image_created_at(committed)
|
||||||
return dataclasses.replace(
|
if ts is not None:
|
||||||
plan,
|
check_stale(f"agent image {committed!r}", ts)
|
||||||
agent_provision=dataclasses.replace(
|
return
|
||||||
plan.agent_provision, image=committed,
|
if container_mod.image_exists(plan.image):
|
||||||
),
|
ts = container_mod.image_created_at(plan.image)
|
||||||
)
|
if ts is not None:
|
||||||
container_mod.build_image(
|
check_stale(f"agent image {plan.image!r}", ts)
|
||||||
plan.image, _REPO_DIR, dockerfile=plan.dockerfile_path,
|
|
||||||
)
|
|
||||||
return plan
|
|
||||||
|
|
||||||
|
|
||||||
def _provision_git_gate_keys(
|
def _provision_git_gate_keys(
|
||||||
|
|||||||
@@ -0,0 +1,210 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
uid="$(id -u)"
|
||||||
|
if [ "$uid" -eq 0 ]; then
|
||||||
|
echo "refusing to run the guest container engine as root" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Every piece of podman 5's networking stack is checked here, because each
|
||||||
|
# one fails at a different and misleading layer if it is absent: no pasta and
|
||||||
|
# nothing starts at all; no nft and netavark cannot build the bridge every
|
||||||
|
# compose file expects; no aardvark-dns and DNS inside nested containers fails
|
||||||
|
# while everything else looks healthy.
|
||||||
|
for command in podman docker fuse-overlayfs pasta nft slirp4netns; do
|
||||||
|
command -v "$command" >/dev/null 2>&1 || {
|
||||||
|
echo "missing nested-container prerequisite: $command" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
done
|
||||||
|
|
||||||
|
# The inverse of the rootless-Docker check, and the whole point of the podman
|
||||||
|
# variant: a subordinate range would push podman onto newuidmap, which cannot
|
||||||
|
# write a multi-range uid_map without CAP_SYS_ADMIN in this guest. An empty
|
||||||
|
# range keeps it on the single-UID self-mapping an unprivileged process may
|
||||||
|
# write itself.
|
||||||
|
if grep -q "^$(id -un):" /etc/subuid 2>/dev/null; then
|
||||||
|
echo "unexpected subordinate UID range for $(id -un): podman would" >&2
|
||||||
|
echo "require CAP_SYS_ADMIN via newuidmap in this guest" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
for device in /dev/fuse /dev/net/tun; do
|
||||||
|
[ -r "$device" ] && [ -w "$device" ] || {
|
||||||
|
echo "device $device is not readable/writable by $(id -un)" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
done
|
||||||
|
|
||||||
|
# Short by necessity, not by accident: conmon's attach socket lives under
|
||||||
|
# this directory and must fit in a 108-byte sun_path. See nested_containers.py.
|
||||||
|
# Must stay in step with AGENT_CA_BUNDLE in bot_bottle/backend/util.py; a unit
|
||||||
|
# test pins the two together.
|
||||||
|
CA_BUNDLE="/etc/ssl/certs/ca-certificates.crt"
|
||||||
|
[ -r "$CA_BUNDLE" ] || {
|
||||||
|
echo "gateway CA bundle $CA_BUNDLE is missing or unreadable" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# The proxy URL the agent inherits names `bot-bottle-gateway`, which resolves
|
||||||
|
# only through this bottle's /etc/hosts. A nested container gets its own hosts
|
||||||
|
# file, so it cannot resolve the name and dies at "Could not resolve proxy".
|
||||||
|
#
|
||||||
|
# podman's containers.conf `hosts_file` would fix that, except the
|
||||||
|
# Docker-compatible API ignores it — it only takes effect for native
|
||||||
|
# `podman run`, and the agent types `docker`. So the name is resolved *here*
|
||||||
|
# and the address, not the name, goes into the proxy URL the nested container
|
||||||
|
# receives. Verified on macOS 26 / podman 5.4.2: with the address in place,
|
||||||
|
# https://quay.io returns 200 and a non-allowlisted host still gets 403, so
|
||||||
|
# the egress boundary applies inside nested containers too.
|
||||||
|
GATEWAY_NAME="bot-bottle-gateway"
|
||||||
|
gateway_ip="$(
|
||||||
|
awk -v name="$GATEWAY_NAME" '$2 == name { print $1; exit }' /etc/hosts
|
||||||
|
)"
|
||||||
|
[ -n "$gateway_ip" ] || {
|
||||||
|
echo "no /etc/hosts entry for $GATEWAY_NAME; the gateway address is" >&2
|
||||||
|
echo "needed so nested containers can reach the egress proxy" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export XDG_RUNTIME_DIR="${XDG_RUNTIME_DIR:-/tmp/bbp}"
|
||||||
|
config="$HOME/.config/containers"
|
||||||
|
mkdir -p "$XDG_RUNTIME_DIR" "$config"
|
||||||
|
chmod 700 "$XDG_RUNTIME_DIR"
|
||||||
|
|
||||||
|
# ignore_chown_errors is required, not incidental: with a single-UID mapping
|
||||||
|
# there is no second UID for image layers to be chowned to, so layers that
|
||||||
|
# record other owners would otherwise fail to extract.
|
||||||
|
cat > "$config/storage.conf" <<'CONF'
|
||||||
|
[storage]
|
||||||
|
driver="overlay"
|
||||||
|
[storage.options.overlay]
|
||||||
|
mount_program="/usr/bin/fuse-overlayfs"
|
||||||
|
ignore_chown_errors="true"
|
||||||
|
CONF
|
||||||
|
|
||||||
|
# No cgroup delegation reaches this guest, so asking podman to manage cgroups
|
||||||
|
# fails; events_logger=file avoids the journald socket that is equally absent.
|
||||||
|
#
|
||||||
|
# The rest of this config is what lets a nested container reach the network:
|
||||||
|
#
|
||||||
|
# hosts_file only takes effect for native `podman run` — the
|
||||||
|
# Docker-compatible API ignores it, and the agent types
|
||||||
|
# `docker`. Kept anyway because it costs nothing and makes
|
||||||
|
# podman-native use behave; the compat path is covered by the
|
||||||
|
# address-bearing proxy URL below.
|
||||||
|
# volumes/env the gateway TLS-intercepts, so a container that does not
|
||||||
|
# trust the bottle's CA bundle gets "unable to get local issuer
|
||||||
|
# certificate". Mounting the bundle read-only and pointing the
|
||||||
|
# usual env vars at it covers curl, wget, python, and node
|
||||||
|
# without distro-specific trust commands.
|
||||||
|
#
|
||||||
|
# The proxy URL carries the bottle's identity token. podman already forwards
|
||||||
|
# that same URL into every nested container from the agent's own environment,
|
||||||
|
# so writing it to a 0600 file inside this disposable VM hands it to nobody
|
||||||
|
# new. It is never echoed.
|
||||||
|
CA_BUNDLE="$CA_BUNDLE" GATEWAY_NAME="$GATEWAY_NAME" GATEWAY_IP="$gateway_ip" \
|
||||||
|
CONTAINERS_CONF="$config/containers.conf" python3 - <<'PY'
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
ca = os.environ["CA_BUNDLE"]
|
||||||
|
name = os.environ["GATEWAY_NAME"]
|
||||||
|
ip = os.environ["GATEWAY_IP"]
|
||||||
|
|
||||||
|
entries = [
|
||||||
|
f"SSL_CERT_FILE={ca}",
|
||||||
|
f"CURL_CA_BUNDLE={ca}",
|
||||||
|
f"REQUESTS_CA_BUNDLE={ca}",
|
||||||
|
f"NODE_EXTRA_CA_CERTS={ca}",
|
||||||
|
]
|
||||||
|
# The gateway name resolves only through the bottle's /etc/hosts, which a
|
||||||
|
# nested container does not inherit, so hand it the address instead.
|
||||||
|
for var in ("HTTP_PROXY", "HTTPS_PROXY", "http_proxy", "https_proxy"):
|
||||||
|
value = os.environ.get(var)
|
||||||
|
if value:
|
||||||
|
entries.append(f"{var}={value.replace(name, ip)}")
|
||||||
|
# NO_PROXY keeps the name: it is matched against what a client asks for, and
|
||||||
|
# code inside a nested container still says "bot-bottle-gateway".
|
||||||
|
for var in ("NO_PROXY", "no_proxy"):
|
||||||
|
value = os.environ.get(var)
|
||||||
|
if value:
|
||||||
|
entries.append(f"{var}={value}")
|
||||||
|
|
||||||
|
path = Path(os.environ["CONTAINERS_CONF"])
|
||||||
|
path.write_text("\n".join([
|
||||||
|
"[containers]",
|
||||||
|
'cgroups="disabled"',
|
||||||
|
# podman copies the host's proxy vars into every container by default,
|
||||||
|
# and that copy *wins* over the env below — putting the unresolvable
|
||||||
|
# gateway name back. Turn it off so the address-bearing URLs stand.
|
||||||
|
"http_proxy=false",
|
||||||
|
'hosts_file="/etc/hosts"',
|
||||||
|
f'volumes=["{ca}:{ca}:ro"]',
|
||||||
|
"env=[",
|
||||||
|
*[f' "{entry}",' for entry in entries],
|
||||||
|
"]",
|
||||||
|
"[engine]",
|
||||||
|
'cgroup_manager="cgroupfs"',
|
||||||
|
'events_logger="file"',
|
||||||
|
"",
|
||||||
|
]), encoding="utf-8")
|
||||||
|
path.chmod(0o600)
|
||||||
|
PY
|
||||||
|
|
||||||
|
# Registry pulls egress through the bottle's proxy like everything else. The
|
||||||
|
# token-bearing proxy URL is already in the agent's environment; persisting it
|
||||||
|
# inside this disposable VM does not broaden its authority.
|
||||||
|
#
|
||||||
|
# This file is also what the Docker CLI copies into every container it starts,
|
||||||
|
# and being client-side it beats anything the podman service does — it is why
|
||||||
|
# containers.conf `env`, `http_proxy=false`, and the service's own environment
|
||||||
|
# all failed to change what a nested container saw. The address goes in here
|
||||||
|
# for the same reason it goes everywhere else: `bot-bottle-gateway` resolves
|
||||||
|
# in the bottle, never inside a nested container.
|
||||||
|
GATEWAY_NAME="$GATEWAY_NAME" GATEWAY_IP="$gateway_ip" python3 - <<'PY'
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
name = os.environ["GATEWAY_NAME"]
|
||||||
|
ip = os.environ["GATEWAY_IP"]
|
||||||
|
|
||||||
|
proxy = os.environ.get("HTTPS_PROXY") or os.environ.get("https_proxy", "")
|
||||||
|
# NO_PROXY keeps the name: it is matched against what a client asks for, and
|
||||||
|
# code inside a nested container still says "bot-bottle-gateway".
|
||||||
|
no_proxy = os.environ.get("NO_PROXY") or os.environ.get("no_proxy", "")
|
||||||
|
config = {"proxies": {"default": {
|
||||||
|
"httpProxy": proxy.replace(name, ip),
|
||||||
|
"httpsProxy": proxy.replace(name, ip),
|
||||||
|
"noProxy": no_proxy,
|
||||||
|
}}}
|
||||||
|
path = Path.home() / ".docker" / "config.json"
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
path.write_text(json.dumps(config), encoding="utf-8")
|
||||||
|
path.chmod(0o600)
|
||||||
|
PY
|
||||||
|
|
||||||
|
if docker info >/dev/null 2>&1; then
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Belt to the ~/.docker/config.json braces above, which is what actually
|
||||||
|
# decides this for `docker run`. The service environment is what podman falls
|
||||||
|
# back to for anything the CLI does not stamp — its own registry pulls, and
|
||||||
|
# containers created through the API by something other than the Docker CLI.
|
||||||
|
# Cheap, and it keeps the address consistent across both paths.
|
||||||
|
#
|
||||||
|
# Assigned via parameter expansion, never echoed: these carry the bottle's
|
||||||
|
# identity token.
|
||||||
|
for var in HTTP_PROXY HTTPS_PROXY http_proxy https_proxy; do
|
||||||
|
eval "value=\${$var:-}"
|
||||||
|
[ -n "$value" ] || continue
|
||||||
|
eval "export $var=\"\${value%%$GATEWAY_NAME*}$gateway_ip\${value#*$GATEWAY_NAME}\""
|
||||||
|
done
|
||||||
|
|
||||||
|
log=/tmp/bot-bottle-nested-containers.log
|
||||||
|
nohup podman system service --time=0 \
|
||||||
|
"unix://$XDG_RUNTIME_DIR/podman.sock" \
|
||||||
|
>"$log" 2>&1 </dev/null &
|
||||||
@@ -0,0 +1,162 @@
|
|||||||
|
"""Guest-local container engine for Apple-container bottles (issue #392).
|
||||||
|
|
||||||
|
The service and every nested container remain inside the existing per-bottle
|
||||||
|
VM. This module refuses to compensate for missing prerequisites with outer
|
||||||
|
capabilities, a privileged container, or a host Docker socket.
|
||||||
|
|
||||||
|
Podman is used rather than rootless Docker for one specific reason: Apple
|
||||||
|
Container's capability bounding set omits `CAP_SYS_ADMIN`, which the kernel
|
||||||
|
requires to write a multi-range `uid_map` via `newuidmap`. Rootless Docker
|
||||||
|
has no path that avoids that write. Podman does — with no subordinate UID
|
||||||
|
range configured it falls back to a single-UID self-mapping, which an
|
||||||
|
unprivileged process may write itself. See
|
||||||
|
`docs/research/rootless-docker-in-apple-container-spike.md`.
|
||||||
|
|
||||||
|
That fallback is why `build_image` *removes* the agent user's `/etc/subuid`
|
||||||
|
and `/etc/subgid` entries instead of adding them: their presence is precisely
|
||||||
|
what would send podman down the `newuidmap` path that cannot work here.
|
||||||
|
|
||||||
|
The agent still talks to `docker` and `docker compose`; those speak to
|
||||||
|
podman's Docker-compatible API socket, so nothing in the agent's habits
|
||||||
|
changes.
|
||||||
|
|
||||||
|
Nested containers run *within* the bottle boundary, not inside a new one: the
|
||||||
|
single-UID mapping means `root` in a nested container is the agent user
|
||||||
|
outside it. This is for build and test workloads, not for sandboxing
|
||||||
|
untrusted code.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import shlex
|
||||||
|
import shutil
|
||||||
|
import tempfile
|
||||||
|
import time
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
from ...log import die, info
|
||||||
|
|
||||||
|
_INIT = "/usr/local/libexec/bot-bottle/nested-containers-init"
|
||||||
|
# Deliberately cryptic and short. podman derives conmon's attach socket as
|
||||||
|
# `$XDG_RUNTIME_DIR/libpod/tmp/socket/<64-hex-id>/attach`, and a Unix socket
|
||||||
|
# path may not exceed 108 bytes (`sun_path`). The descriptive
|
||||||
|
# `/tmp/bot-bottle-podman-run` produced a 116-byte path — over the limit, so
|
||||||
|
# attach would have broken as soon as anything got far enough to attach. Do
|
||||||
|
# not lengthen this for readability; it buys 8 bytes of headroom.
|
||||||
|
_RUNTIME_DIR = "/tmp/bbp"
|
||||||
|
_SOCKET = f"{_RUNTIME_DIR}/podman.sock"
|
||||||
|
_LOG = "/tmp/bot-bottle-nested-containers.log"
|
||||||
|
IMAGE_SUFFIX = "-nested-containers"
|
||||||
|
READY_RETRIES = 30
|
||||||
|
|
||||||
|
# Apple Container creates both device nodes 0600 root:root, so the agent user
|
||||||
|
# cannot open them: /dev/fuse blocks the fuse-overlayfs storage driver and
|
||||||
|
# /dev/net/tun blocks slirp4netns, which rootless podman uses for the default
|
||||||
|
# bridge network that stock compose files expect. Relaxing the modes needs no
|
||||||
|
# capability the bottle does not already hold — unlike CAP_SYS_ADMIN, which is
|
||||||
|
# what killed the rootless-Docker approach.
|
||||||
|
_GUEST_DEVICES = ("/dev/fuse", "/dev/net/tun")
|
||||||
|
|
||||||
|
|
||||||
|
def build_image(
|
||||||
|
base_image: str,
|
||||||
|
build: Callable[..., None],
|
||||||
|
) -> str:
|
||||||
|
"""Layer the nested-container tooling onto an already-built agent image.
|
||||||
|
|
||||||
|
Only what the flag is meant to gate lands here. Podman itself is already
|
||||||
|
in every built-in agent image (issue #451); the storage/network helpers,
|
||||||
|
the Docker CLI, and the compose plugin are the ~100MB this flag buys.
|
||||||
|
"""
|
||||||
|
image = f"{base_image}{IMAGE_SUFFIX}"
|
||||||
|
init_script = Path(__file__).with_name("nested-containers-init.sh")
|
||||||
|
with tempfile.TemporaryDirectory(prefix="bot-bottle-nested-containers.") as tmp:
|
||||||
|
context = Path(tmp)
|
||||||
|
shutil.copy2(init_script, context / "nested-containers-init.sh")
|
||||||
|
(context / "Dockerfile").write_text(
|
||||||
|
"FROM docker:28-cli AS docker_cli\n"
|
||||||
|
f"FROM {base_image}\n"
|
||||||
|
"USER root\n"
|
||||||
|
"COPY --from=docker_cli /usr/local/bin/docker /usr/local/bin/docker\n"
|
||||||
|
"COPY --from=docker_cli /usr/local/libexec/docker/cli-plugins/"
|
||||||
|
"docker-compose /usr/local/libexec/docker/cli-plugins/docker-compose\n"
|
||||||
|
"RUN apt-get update \\\n"
|
||||||
|
# podman 5's networking stack, installed explicitly because the
|
||||||
|
# base image's `--no-install-recommends` podman does not pull it
|
||||||
|
# in and each piece fails at a different, misleading layer:
|
||||||
|
# passt -> `pasta`, the default rootless netns helper
|
||||||
|
# (podman 4 used slirp4netns); without it
|
||||||
|
# nothing starts: "could not find pasta"
|
||||||
|
# nftables -> `nft`, which netavark shells out to for the
|
||||||
|
# bridge network every compose file expects
|
||||||
|
# aardvark-dns -> name resolution *inside* nested containers;
|
||||||
|
# without it DNS fails while everything else
|
||||||
|
# looks healthy
|
||||||
|
# slirp4netns stays as the documented fallback for pasta.
|
||||||
|
" && apt-get install -y --no-install-recommends "
|
||||||
|
"aardvark-dns fuse-overlayfs netavark nftables passt "
|
||||||
|
"slirp4netns uidmap \\\n"
|
||||||
|
" && rm -rf /var/lib/apt/lists/* \\\n"
|
||||||
|
# Deliberate: an empty subordinate range keeps podman on the
|
||||||
|
# single-UID mapping that needs no CAP_SYS_ADMIN. Adding ranges
|
||||||
|
# here would reintroduce the newuidmap failure this design exists
|
||||||
|
# to route around.
|
||||||
|
" && sed -i '/^node:/d' /etc/subuid /etc/subgid\n"
|
||||||
|
"COPY nested-containers-init.sh "
|
||||||
|
"/usr/local/libexec/bot-bottle/nested-containers-init\n"
|
||||||
|
"RUN chmod 0755 /usr/local/libexec/bot-bottle/nested-containers-init\n"
|
||||||
|
"USER node\n",
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
build(image, str(context), dockerfile=str(context / "Dockerfile"))
|
||||||
|
return image
|
||||||
|
|
||||||
|
|
||||||
|
def guest_env(enabled: bool) -> dict[str, str]:
|
||||||
|
"""Environment consumed by the Docker CLI inside an enabled bottle."""
|
||||||
|
if not enabled:
|
||||||
|
return {}
|
||||||
|
return {
|
||||||
|
"DOCKER_HOST": f"unix://{_SOCKET}",
|
||||||
|
"XDG_RUNTIME_DIR": _RUNTIME_DIR,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_guest_devices(container_name: str, exec_as_root: Callable[..., None]) -> None:
|
||||||
|
"""Make /dev/fuse and /dev/net/tun openable by the agent user.
|
||||||
|
|
||||||
|
Runs as root inside the bottle because the agent must not be able to
|
||||||
|
re-mode device nodes itself. No outer capability is involved.
|
||||||
|
"""
|
||||||
|
exec_as_root(
|
||||||
|
container_name,
|
||||||
|
["sh", "-c", f"chmod 0666 {' '.join(_GUEST_DEVICES)}"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def start(bottle: object) -> None:
|
||||||
|
"""Start and verify the unprivileged service through the bottle exec API."""
|
||||||
|
info("starting guest-local container engine")
|
||||||
|
result = bottle.exec(shlex.quote(_INIT)) # type: ignore[attr-defined]
|
||||||
|
if result.returncode != 0:
|
||||||
|
detail = (result.stderr or result.stdout or "").strip()
|
||||||
|
die(f"nested-container bootstrap failed: {detail or '<no output>'}")
|
||||||
|
|
||||||
|
for _ in range(READY_RETRIES):
|
||||||
|
result = bottle.exec("docker info >/dev/null 2>&1") # type: ignore[attr-defined]
|
||||||
|
if result.returncode == 0:
|
||||||
|
info("guest-local container engine is ready")
|
||||||
|
return
|
||||||
|
time.sleep(0.2)
|
||||||
|
|
||||||
|
logs = bottle.exec( # type: ignore[attr-defined]
|
||||||
|
f"tail -n 80 {_LOG} 2>/dev/null || true"
|
||||||
|
)
|
||||||
|
die(
|
||||||
|
"guest-local container engine did not become ready without additional "
|
||||||
|
f"outer privileges:\n{(logs.stdout or logs.stderr or '<no log>').strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["build_image", "guest_env", "prepare_guest_devices", "start"]
|
||||||
@@ -44,4 +44,5 @@ def resolve_plan(
|
|||||||
egress_plan=egress_plan,
|
egress_plan=egress_plan,
|
||||||
supervise_plan=supervise_plan,
|
supervise_plan=supervise_plan,
|
||||||
agent_provision=agent_provision_plan,
|
agent_provision=agent_provision_plan,
|
||||||
|
nested_containers=manifest.bottle.nested_containers,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import shutil
|
|||||||
import subprocess
|
import subprocess
|
||||||
import tempfile
|
import tempfile
|
||||||
import time
|
import time
|
||||||
|
from datetime import datetime, timezone
|
||||||
from typing import Iterable
|
from typing import Iterable
|
||||||
|
|
||||||
from ...log import die, info
|
from ...log import die, info
|
||||||
@@ -572,6 +573,41 @@ def try_container_ipv4_on_network(name: str, network: str) -> str:
|
|||||||
return ""
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def inspect_container_network_ip(name: str, network: str) -> str | None:
|
||||||
|
"""IP of `name` on `network`, distinguishing inspect failure from "not yet".
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- the IP string when the container has one on `network`
|
||||||
|
- "" when inspect succeeds but no address is assigned yet (in-flight DHCP)
|
||||||
|
- None when the inspect command itself fails (authoritative list impossible)
|
||||||
|
"""
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "inspect", name],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "[]")
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return None
|
||||||
|
if isinstance(data, list):
|
||||||
|
data = data[0] if data else {}
|
||||||
|
if not isinstance(data, dict):
|
||||||
|
return None
|
||||||
|
status = data.get("status")
|
||||||
|
networks = status.get("networks") if isinstance(status, dict) else None
|
||||||
|
if not isinstance(networks, list):
|
||||||
|
return ""
|
||||||
|
for entry in networks:
|
||||||
|
if not isinstance(entry, dict) or entry.get("network") != network:
|
||||||
|
continue
|
||||||
|
raw = entry.get("ipv4Address")
|
||||||
|
if isinstance(raw, str) and raw:
|
||||||
|
return raw.split("/", 1)[0]
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
def wait_container_ipv4_on_network(
|
def wait_container_ipv4_on_network(
|
||||||
name: str, network: str, *, timeout: float = 15.0, poll: float = 0.25,
|
name: str, network: str, *, timeout: float = 15.0, poll: float = 0.25,
|
||||||
) -> str:
|
) -> str:
|
||||||
@@ -626,6 +662,39 @@ def image_id(ref: str) -> str:
|
|||||||
raise AssertionError("unreachable")
|
raise AssertionError("unreachable")
|
||||||
|
|
||||||
|
|
||||||
|
def image_created_at(ref: str) -> datetime | None:
|
||||||
|
"""Return the image creation timestamp as an aware UTC datetime, or None
|
||||||
|
when the field is absent or unparseable (e.g. FROM-scratch images, images
|
||||||
|
pulled from registries that omit the field). Callers should skip the stale
|
||||||
|
check when None is returned rather than treating it as an error."""
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "image", "inspect", ref],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container image inspect for {ref!r} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "{}")
|
||||||
|
except json.JSONDecodeError as exc:
|
||||||
|
die(f"container image inspect for {ref!r} returned malformed JSON: {exc}")
|
||||||
|
if isinstance(data, list) and data:
|
||||||
|
data = data[0]
|
||||||
|
if isinstance(data, dict):
|
||||||
|
value = data.get("created") or data.get("Created")
|
||||||
|
if isinstance(value, str) and value:
|
||||||
|
try:
|
||||||
|
ts = value.rstrip("Z")
|
||||||
|
return datetime.fromisoformat(ts).replace(tzinfo=timezone.utc)
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
def save(ref: str, output: str) -> None:
|
def save(ref: str, output: str) -> None:
|
||||||
subprocess.run([_CONTAINER, "image", "save", ref, "-o", output], check=True)
|
subprocess.run([_CONTAINER, "image", "save", ref, "-o", output], check=True)
|
||||||
|
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ from ..bottle_state import (
|
|||||||
)
|
)
|
||||||
from ..egress import Egress, EgressPlan
|
from ..egress import Egress, EgressPlan
|
||||||
from ..git_gate import GitGate, GitGatePlan
|
from ..git_gate import GitGate, GitGatePlan
|
||||||
|
from ..log import die
|
||||||
from ..manifest import Manifest, ManifestBottle
|
from ..manifest import Manifest, ManifestBottle
|
||||||
from ..supervise import Supervise, SupervisePlan
|
from ..supervise import Supervise, SupervisePlan
|
||||||
from . import BottleSpec
|
from . import BottleSpec
|
||||||
@@ -112,6 +113,22 @@ def merge_provision_env_vars(provision: AgentProvisionPlan) -> AgentProvisionPla
|
|||||||
return replace(provision, guest_env=merged)
|
return replace(provision, guest_env=merged)
|
||||||
|
|
||||||
|
|
||||||
|
def reject_nested_containers(backend: str, manifest: Manifest) -> None:
|
||||||
|
"""Fail loudly when a backend cannot honor `nested_containers: true`.
|
||||||
|
|
||||||
|
Silently ignoring it would hand the agent a bottle where `docker` is not
|
||||||
|
there — and the only sound alternatives on these backends (a host daemon
|
||||||
|
socket, a privileged container) are exactly what issue #392 rules out.
|
||||||
|
"""
|
||||||
|
if not manifest.bottle.nested_containers:
|
||||||
|
return
|
||||||
|
die(
|
||||||
|
f"nested_containers is not supported on the {backend} backend. "
|
||||||
|
"Only macos-container runs a guest-local container engine today; "
|
||||||
|
"mounting the host Docker socket is not an option bot-bottle offers."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def resolve_manifest_dockerfile(path_value: str, spec: BottleSpec) -> str:
|
def resolve_manifest_dockerfile(path_value: str, spec: BottleSpec) -> str:
|
||||||
"""Resolve a manifest-supplied dockerfile path relative to user_cwd."""
|
"""Resolve a manifest-supplied dockerfile path relative to user_cwd."""
|
||||||
path = Path(os.path.expanduser(path_value))
|
path = Path(os.path.expanduser(path_value))
|
||||||
@@ -122,6 +139,7 @@ def resolve_manifest_dockerfile(path_value: str, spec: BottleSpec) -> str:
|
|||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"merge_provision_env_vars",
|
"merge_provision_env_vars",
|
||||||
|
"reject_nested_containers",
|
||||||
"mint_slug",
|
"mint_slug",
|
||||||
"prepare_agent_state_dir",
|
"prepare_agent_state_dir",
|
||||||
"prepare_egress",
|
"prepare_egress",
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ from __future__ import annotations
|
|||||||
import hashlib
|
import hashlib
|
||||||
import os
|
import os
|
||||||
import ssl
|
import ssl
|
||||||
|
import time
|
||||||
|
from collections.abc import Callable
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
@@ -15,6 +17,24 @@ from ..log import die, info
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ..egress import EgressPlan
|
from ..egress import EgressPlan
|
||||||
|
|
||||||
|
_CA_POLL_INTERVAL = 0.5
|
||||||
|
|
||||||
|
|
||||||
|
def poll_ca_cert(fetch: Callable[[], str | None], *, timeout: float) -> str:
|
||||||
|
"""Poll `fetch` until it returns a non-empty PEM string or `timeout` expires.
|
||||||
|
|
||||||
|
`fetch` should return the PEM on success and `None` (or empty string) when
|
||||||
|
the cert is not yet available. Raises `TimeoutError` if the cert never
|
||||||
|
appears within `timeout` seconds."""
|
||||||
|
deadline = time.monotonic() + timeout
|
||||||
|
while True:
|
||||||
|
result = fetch()
|
||||||
|
if result:
|
||||||
|
return result
|
||||||
|
if time.monotonic() >= deadline:
|
||||||
|
raise TimeoutError(f"CA cert not available after {timeout:g}s")
|
||||||
|
time.sleep(_CA_POLL_INTERVAL)
|
||||||
|
|
||||||
|
|
||||||
# Debian-family CA layout, shared by every backend (all guest images
|
# Debian-family CA layout, shared by every backend (all guest images
|
||||||
# are Debian-family). AGENT_CA_PATH is the source path that
|
# are Debian-family). AGENT_CA_PATH is the source path that
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ from .commit import cmd_commit
|
|||||||
from .edit import cmd_edit
|
from .edit import cmd_edit
|
||||||
from .info import cmd_info
|
from .info import cmd_info
|
||||||
from .init import cmd_init
|
from .init import cmd_init
|
||||||
|
from .login import cmd_login
|
||||||
from .resume import cmd_resume
|
from .resume import cmd_resume
|
||||||
from .start import cmd_start
|
from .start import cmd_start
|
||||||
from .supervise import cmd_supervise
|
from .supervise import cmd_supervise
|
||||||
@@ -33,6 +34,7 @@ COMMANDS = {
|
|||||||
"info": cmd_info,
|
"info": cmd_info,
|
||||||
"init": cmd_init,
|
"init": cmd_init,
|
||||||
"list": cmd_list,
|
"list": cmd_list,
|
||||||
|
"login": cmd_login,
|
||||||
"resume": cmd_resume,
|
"resume": cmd_resume,
|
||||||
"start": cmd_start,
|
"start": cmd_start,
|
||||||
"supervise": cmd_supervise,
|
"supervise": cmd_supervise,
|
||||||
@@ -43,7 +45,7 @@ COMMANDS = {
|
|||||||
# the host (TAP pool, /dev/kvm, firecracker) and never opens the store, so
|
# the host (TAP pool, /dev/kvm, firecracker) and never opens the store, so
|
||||||
# gating it on the schema breaks preflight on a fresh CI runner where stdin
|
# gating it on the schema breaks preflight on a fresh CI runner where stdin
|
||||||
# isn't a TTY and the migration prompt can't be answered.
|
# isn't a TTY and the migration prompt can't be answered.
|
||||||
NO_MIGRATION_COMMANDS = frozenset({"backend"})
|
NO_MIGRATION_COMMANDS = frozenset({"backend", "login"})
|
||||||
|
|
||||||
|
|
||||||
def usage() -> None:
|
def usage() -> None:
|
||||||
@@ -56,6 +58,7 @@ def usage() -> None:
|
|||||||
sys.stderr.write(" info print env, skills, and prompt details for a named agent\n")
|
sys.stderr.write(" info print env, skills, and prompt details for a named agent\n")
|
||||||
sys.stderr.write(" init interactively create a new agent and add it to bot-bottle.json\n")
|
sys.stderr.write(" init interactively create a new agent and add it to bot-bottle.json\n")
|
||||||
sys.stderr.write(" list list available agents or active containers\n")
|
sys.stderr.write(" list list available agents or active containers\n")
|
||||||
|
sys.stderr.write(" login register this host with a bot-bottle console\n")
|
||||||
sys.stderr.write(
|
sys.stderr.write(
|
||||||
" resume re-launch a bottle by its identity "
|
" resume re-launch a bottle by its identity "
|
||||||
"(continues state from PRD 0016)\n"
|
"(continues state from PRD 0016)\n"
|
||||||
@@ -111,7 +114,3 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
return e.code if isinstance(e.code, int) else 1
|
return e.code if isinstance(e.code, int) else 1
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
return 130
|
return 130
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
"""Entry point for `python -m bot_bottle.cli`.
|
||||||
|
|
||||||
|
`cli.py` at the repo root is the usual way in; this makes the package
|
||||||
|
runnable too, so the CLI works from an installed copy where there is no
|
||||||
|
`cli.py` on disk to point at.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from . import main
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
sys.exit(main())
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
"""bb login — register this host with a bot-bottle console.
|
||||||
|
|
||||||
|
Opens a device-authorization flow against the target console, waits for the
|
||||||
|
operator to approve, then writes access and refresh tokens to
|
||||||
|
~/.bot-bottle/console.json (or $BOT_BOTTLE_ROOT/console.json).
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
bb login [--console-url URL] [--label LABEL]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
--console-url URL Target console URL (overrides BB_CONSOLE_URL env var)
|
||||||
|
--label LABEL Host label shown in the console (default: hostname)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import time
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from ..paths import bot_bottle_root
|
||||||
|
|
||||||
|
_CONSOLE_URL_ENV = "BB_CONSOLE_URL"
|
||||||
|
_POLL_SLEEP = 2 # seconds between polls; matches console's poll_interval default
|
||||||
|
|
||||||
|
|
||||||
|
def _usage() -> None:
|
||||||
|
sys.stderr.write(
|
||||||
|
"usage: bb login [--console-url URL] [--label LABEL]\n"
|
||||||
|
"\n"
|
||||||
|
"Options:\n"
|
||||||
|
" --console-url URL Console base URL (or BB_CONSOLE_URL env var)\n"
|
||||||
|
" --label LABEL Host label shown in the console (default: hostname)\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _flag(argv: list[str], name: str) -> str | None:
|
||||||
|
for i, arg in enumerate(argv):
|
||||||
|
if arg == name and i + 1 < len(argv):
|
||||||
|
return argv[i + 1]
|
||||||
|
if arg.startswith(f"{name}="):
|
||||||
|
return arg[len(name) + 1:]
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _post(url: str, payload: dict[str, Any]) -> dict[str, Any]:
|
||||||
|
data = json.dumps(payload).encode()
|
||||||
|
req = urllib.request.Request(
|
||||||
|
url, data=data, headers={"Content-Type": "application/json"}
|
||||||
|
)
|
||||||
|
with urllib.request.urlopen(req, timeout=10) as resp:
|
||||||
|
return json.loads(resp.read())
|
||||||
|
|
||||||
|
|
||||||
|
def _get(url: str) -> tuple[int, dict[str, Any]]:
|
||||||
|
req = urllib.request.Request(url)
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req, timeout=10) as resp:
|
||||||
|
return resp.status, json.loads(resp.read())
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
return e.code, {}
|
||||||
|
|
||||||
|
|
||||||
|
def _save_credentials(
|
||||||
|
console_url: str, host_id: str, access_token: str, refresh_token: str
|
||||||
|
) -> Path:
|
||||||
|
path = bot_bottle_root() / "console.json"
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
content = (
|
||||||
|
json.dumps(
|
||||||
|
{
|
||||||
|
"url": console_url,
|
||||||
|
"host_id": host_id,
|
||||||
|
"access_token": access_token,
|
||||||
|
"refresh_token": refresh_token,
|
||||||
|
},
|
||||||
|
indent=2,
|
||||||
|
)
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
fd, tmp_path_str = tempfile.mkstemp(dir=path.parent, prefix=".console-")
|
||||||
|
tmp = Path(tmp_path_str)
|
||||||
|
try:
|
||||||
|
tmp.chmod(0o600)
|
||||||
|
with os.fdopen(fd, "w") as f:
|
||||||
|
f.write(content)
|
||||||
|
os.replace(tmp, path)
|
||||||
|
except OSError:
|
||||||
|
try:
|
||||||
|
tmp.unlink()
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
raise
|
||||||
|
return path
|
||||||
|
|
||||||
|
|
||||||
|
def cmd_login(argv: list[str]) -> int:
|
||||||
|
if "--help" in argv or "-h" in argv:
|
||||||
|
_usage()
|
||||||
|
return 0
|
||||||
|
|
||||||
|
console_url = _flag(argv, "--console-url") or os.environ.get(_CONSOLE_URL_ENV)
|
||||||
|
if not console_url:
|
||||||
|
sys.stderr.write(
|
||||||
|
"bb login: --console-url or BB_CONSOLE_URL is required\n"
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
console_url = console_url.rstrip("/")
|
||||||
|
|
||||||
|
label = _flag(argv, "--label") or socket.gethostname()
|
||||||
|
|
||||||
|
try:
|
||||||
|
resp = _post(f"{console_url}/api/v1/hosts/authorize", {"label": label})
|
||||||
|
except (OSError, ValueError) as exc:
|
||||||
|
sys.stderr.write(f"bb login: failed to start authorization: {exc}\n")
|
||||||
|
return 1
|
||||||
|
|
||||||
|
device_code = resp["device_code"]
|
||||||
|
user_code = resp["user_code"]
|
||||||
|
expires_in = resp.get("expires_in", 300)
|
||||||
|
poll_sleep = max(1, min(int(resp.get("poll_interval", _POLL_SLEEP)), 60))
|
||||||
|
|
||||||
|
sys.stderr.write(
|
||||||
|
f"\nOpen this URL in your browser to authorize this host:\n\n"
|
||||||
|
f" {console_url}/hosts/authorize?code={user_code}\n\n"
|
||||||
|
f"Waiting for approval"
|
||||||
|
)
|
||||||
|
|
||||||
|
deadline = time.monotonic() + expires_in
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
sys.stderr.write(".")
|
||||||
|
sys.stderr.flush()
|
||||||
|
time.sleep(poll_sleep)
|
||||||
|
|
||||||
|
try:
|
||||||
|
code, result = _get(
|
||||||
|
f"{console_url}/api/v1/hosts/authorize/{device_code}"
|
||||||
|
)
|
||||||
|
except (OSError, ValueError):
|
||||||
|
continue
|
||||||
|
|
||||||
|
if code == 410:
|
||||||
|
break
|
||||||
|
|
||||||
|
st = result.get("status")
|
||||||
|
if st == "approved":
|
||||||
|
sys.stderr.write("\n\nApproved.\n")
|
||||||
|
path = _save_credentials(
|
||||||
|
console_url,
|
||||||
|
result["host_id"],
|
||||||
|
result["access_token"],
|
||||||
|
result["refresh_token"],
|
||||||
|
)
|
||||||
|
sys.stderr.write(f"Credentials saved to {path}\n")
|
||||||
|
return 0
|
||||||
|
if st == "denied":
|
||||||
|
sys.stderr.write("\n\nDenied by operator.\n")
|
||||||
|
return 1
|
||||||
|
|
||||||
|
sys.stderr.write("\n\nAuthorization timed out.\n")
|
||||||
|
return 1
|
||||||
+35
-4
@@ -35,6 +35,7 @@ from ..bottle_state import (
|
|||||||
is_preserved,
|
is_preserved,
|
||||||
mark_preserved,
|
mark_preserved,
|
||||||
)
|
)
|
||||||
|
from ..image_cache import StaleImageError
|
||||||
from ..log import info, die
|
from ..log import info, die
|
||||||
from ..manifest import Manifest, ManifestIndex
|
from ..manifest import Manifest, ManifestIndex
|
||||||
from ._common import PROG, USER_CWD, read_tty_line
|
from ._common import PROG, USER_CWD, read_tty_line
|
||||||
@@ -64,6 +65,14 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
"skip all prompts. For orchestrators, CI, and webhooks."
|
"skip all prompts. For orchestrators, CI, and webhooks."
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--cached-images",
|
||||||
|
action="store_true",
|
||||||
|
help=(
|
||||||
|
"quickstart with existing local agent and sidecar images; "
|
||||||
|
"only valid with --headless"
|
||||||
|
),
|
||||||
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--bottle",
|
"--bottle",
|
||||||
action="append",
|
action="append",
|
||||||
@@ -96,6 +105,8 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
help="agent name defined in bot-bottle.json (omit to pick interactively)",
|
help="agent name defined in bot-bottle.json (omit to pick interactively)",
|
||||||
)
|
)
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
if args.cached_images and not args.headless:
|
||||||
|
die("--cached-images is only supported with --headless")
|
||||||
|
|
||||||
dry_run = args.dry_run or os.environ.get("BOT_BOTTLE_DRY_RUN") == "1"
|
dry_run = args.dry_run or os.environ.get("BOT_BOTTLE_DRY_RUN") == "1"
|
||||||
if args.no_cache or os.environ.get("BOT_BOTTLE_NO_CACHE") == "1":
|
if args.no_cache or os.environ.get("BOT_BOTTLE_NO_CACHE") == "1":
|
||||||
@@ -147,6 +158,10 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
label, color = tui.name_color_modal(default_label=agent_name)
|
label, color = tui.name_color_modal(default_label=agent_name)
|
||||||
label, color = _resolve_unique_label(label, color)
|
label, color = _resolve_unique_label(label, color)
|
||||||
|
|
||||||
|
image_policy = _select_image_policy()
|
||||||
|
if image_policy is None:
|
||||||
|
return 0
|
||||||
|
|
||||||
spec = BottleSpec(
|
spec = BottleSpec(
|
||||||
manifest=manifest,
|
manifest=manifest,
|
||||||
agent_name=agent_name,
|
agent_name=agent_name,
|
||||||
@@ -155,6 +170,7 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
label=label,
|
label=label,
|
||||||
color=color,
|
color=color,
|
||||||
bottle_names=bottle_names,
|
bottle_names=bottle_names,
|
||||||
|
image_policy=image_policy,
|
||||||
)
|
)
|
||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
@@ -213,6 +229,7 @@ def _start_headless(
|
|||||||
color=args.color or "",
|
color=args.color or "",
|
||||||
bottle_names=bottle_names,
|
bottle_names=bottle_names,
|
||||||
headless=True,
|
headless=True,
|
||||||
|
image_policy="cached" if args.cached_images else "fresh",
|
||||||
)
|
)
|
||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
@@ -395,6 +412,13 @@ def _text_prompt_yes() -> bool:
|
|||||||
return reply in ("y", "Y", "yes", "YES")
|
return reply in ("y", "Y", "yes", "YES")
|
||||||
|
|
||||||
|
|
||||||
|
def _select_image_policy() -> str | None:
|
||||||
|
return tui.filter_select(
|
||||||
|
["fresh", "cached"],
|
||||||
|
title="Select image startup mode",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _text_render_preflight():
|
def _text_render_preflight():
|
||||||
def _render(plan: DockerBottlePlan, backend_name: str) -> None:
|
def _render(plan: DockerBottlePlan, backend_name: str) -> None:
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
@@ -500,6 +524,8 @@ def _manifest_to_yaml(manifest: Manifest) -> str:
|
|||||||
lines.append(f" scheme: {r.AuthScheme}")
|
lines.append(f" scheme: {r.AuthScheme}")
|
||||||
|
|
||||||
lines.append(f" supervise: {'true' if bottle.supervise else 'false'}")
|
lines.append(f" supervise: {'true' if bottle.supervise else 'false'}")
|
||||||
|
if bottle.nested_containers:
|
||||||
|
lines.append(" nested_containers: true")
|
||||||
|
|
||||||
return "\n".join(lines)
|
return "\n".join(lines)
|
||||||
|
|
||||||
@@ -537,6 +563,15 @@ def _launch_bottle(
|
|||||||
return 0
|
return 0
|
||||||
|
|
||||||
backend = get_bottle_backend(backend_name)
|
backend = get_bottle_backend(backend_name)
|
||||||
|
try:
|
||||||
|
backend.prelaunch_checks(plan)
|
||||||
|
except StaleImageError as exc:
|
||||||
|
if assume_yes:
|
||||||
|
die(str(exc))
|
||||||
|
sys.stderr.write(f"bot-bottle: {exc}\nLaunch anyway? [y/N] ")
|
||||||
|
sys.stderr.flush()
|
||||||
|
if read_tty_line() not in ("y", "Y", "yes", "YES"):
|
||||||
|
return 0
|
||||||
with backend.launch(plan) as bottle:
|
with backend.launch(plan) as bottle:
|
||||||
agent_provider_template = getattr(plan, "agent_provider_template", "claude")
|
agent_provider_template = getattr(plan, "agent_provider_template", "claude")
|
||||||
extra_args: tuple[str, ...] = ()
|
extra_args: tuple[str, ...] = ()
|
||||||
@@ -555,10 +590,6 @@ def _launch_bottle(
|
|||||||
f"session ended (exit {exit_code}); "
|
f"session ended (exit {exit_code}); "
|
||||||
f"container {bottle.name} will be removed"
|
f"container {bottle.name} will be removed"
|
||||||
)
|
)
|
||||||
# While the container is still alive: always snapshot the
|
|
||||||
# transcript and — if the agent exited non-zero — mark
|
|
||||||
# the state for preservation. This picks up crashes /
|
|
||||||
# Ctrl-Cs / OOM kills before cleanup removes the state dir.
|
|
||||||
if agent_provider_template == "claude":
|
if agent_provider_template == "claude":
|
||||||
capture_claude_session_state(identity, exit_code)
|
capture_claude_session_state(identity, exit_code)
|
||||||
return 0
|
return 0
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
"""SQLite-backed bot-bottle configuration store."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
try:
|
||||||
|
from .db_store import DbStore
|
||||||
|
from .migrations import TableMigrations
|
||||||
|
from .paths import host_db_path
|
||||||
|
except ImportError:
|
||||||
|
from db_store import DbStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
from migrations import TableMigrations # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
from paths import host_db_path # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS = 1
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigStore(DbStore):
|
||||||
|
"""SQLite configuration for host-side bot-bottle settings."""
|
||||||
|
|
||||||
|
def __init__(self, db_path: Path | None = None) -> None:
|
||||||
|
migrations = TableMigrations("config_store", [
|
||||||
|
# v1 — host-side bot-bottle settings
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS bot_bottle_config (
|
||||||
|
id INTEGER PRIMARY KEY CHECK (id = 1),
|
||||||
|
cached_image_stale_warning_days INTEGER NOT NULL DEFAULT 1
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
])
|
||||||
|
super().__init__(db_path or host_db_path(), migrations)
|
||||||
|
|
||||||
|
def cached_image_stale_warning_days(self) -> int:
|
||||||
|
if not self.db_path.is_file():
|
||||||
|
return DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS
|
||||||
|
with self._connect() as conn:
|
||||||
|
row = conn.execute(
|
||||||
|
"""
|
||||||
|
SELECT cached_image_stale_warning_days
|
||||||
|
FROM bot_bottle_config
|
||||||
|
WHERE id = 1
|
||||||
|
""",
|
||||||
|
).fetchone()
|
||||||
|
if row is None:
|
||||||
|
return DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS
|
||||||
|
try:
|
||||||
|
return int(row["cached_image_stale_warning_days"])
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
return DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS
|
||||||
|
|
||||||
|
def set_cached_image_stale_warning_days(self, days: int) -> Path:
|
||||||
|
with self._connect() as conn:
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO bot_bottle_config (id, cached_image_stale_warning_days)
|
||||||
|
VALUES (1, ?)
|
||||||
|
ON CONFLICT(id) DO UPDATE SET
|
||||||
|
cached_image_stale_warning_days = excluded.cached_image_stale_warning_days
|
||||||
|
""",
|
||||||
|
(days,),
|
||||||
|
)
|
||||||
|
self._chmod()
|
||||||
|
return self.db_path
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS",
|
||||||
|
"ConfigStore",
|
||||||
|
]
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
# Current Node LTS; slim variant keeps the image small while still
|
# Current Node LTS; slim variant keeps the image small while still
|
||||||
# providing apt-get for any future additions.
|
# providing apt-get for any future additions.
|
||||||
FROM node:22-slim
|
FROM node:22-trixie-slim
|
||||||
|
|
||||||
# Install runtime system deps. claude-code shells out to git for several
|
# Install runtime system deps. claude-code shells out to git for several
|
||||||
# features (status checks, commits, PR creation) — without git in the
|
# features (status checks, commits, PR creation) — without git in the
|
||||||
@@ -21,7 +21,15 @@ FROM node:22-slim
|
|||||||
# to it) works against egress's bumped TLS without the agent needing
|
# to it) works against egress's bumped TLS without the agent needing
|
||||||
# local DNS.
|
# local DNS.
|
||||||
RUN apt-get update \
|
RUN apt-get update \
|
||||||
&& apt-get install -y --no-install-recommends git ca-certificates curl ripgrep iproute2 dnsutils \
|
&& apt-get install -y --no-install-recommends \
|
||||||
|
git \
|
||||||
|
ca-certificates \
|
||||||
|
curl \
|
||||||
|
openssh-client \
|
||||||
|
podman \
|
||||||
|
ripgrep \
|
||||||
|
iproute2 \
|
||||||
|
dnsutils \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
# App-specific deps. Python isn't required by claude-code itself
|
# App-specific deps. Python isn't required by claude-code itself
|
||||||
@@ -39,6 +47,11 @@ RUN apt-get update \
|
|||||||
RUN npm install -g --no-fund --no-audit @anthropic-ai/claude-code@2.1.172 \
|
RUN npm install -g --no-fund --no-audit @anthropic-ai/claude-code@2.1.172 \
|
||||||
&& npm cache clean --force
|
&& npm cache clean --force
|
||||||
|
|
||||||
|
# Git reads both ~/.gitconfig and ~/.config/git/config. Keep its XDG config
|
||||||
|
# path traversable by the non-root runtime user so permission errors do not
|
||||||
|
# suppress bot-bottle's git-gate insteadOf rules.
|
||||||
|
RUN install -d -o node -g node -m 755 /home/node/.config /home/node/.config/git
|
||||||
|
|
||||||
# Run as a non-root user. The node image already provides a `node` user
|
# Run as a non-root user. The node image already provides a `node` user
|
||||||
# (uid 1000) with a home directory, which is where claude-code will write
|
# (uid 1000) with a home directory, which is where claude-code will write
|
||||||
# its session state.
|
# its session state.
|
||||||
|
|||||||
@@ -23,8 +23,9 @@ from ...agent_provider import (
|
|||||||
provider_startup_args,
|
provider_startup_args,
|
||||||
)
|
)
|
||||||
from ...backend.docker import util as docker_mod
|
from ...backend.docker import util as docker_mod
|
||||||
from ...egress import EgressRoute
|
from ...egress import CLAUDE_HOST_CREDENTIAL_TOKEN_REF, EgressRoute
|
||||||
from ...log import die, info, warn
|
from ...log import die, info, warn
|
||||||
|
from .claude_auth import claude_host_access_token
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
@@ -118,7 +119,6 @@ class ClaudeAgentProvider(AgentProvider):
|
|||||||
color: str = "",
|
color: str = "",
|
||||||
provider_settings: dict[str, object] | None = None,
|
provider_settings: dict[str, object] | None = None,
|
||||||
) -> AgentProvisionPlan:
|
) -> AgentProvisionPlan:
|
||||||
del forward_host_credentials, host_env
|
|
||||||
resolved_guest_env = dict(guest_env or {})
|
resolved_guest_env = dict(guest_env or {})
|
||||||
startup_args = provider_startup_args(provider_settings)
|
startup_args = provider_startup_args(provider_settings)
|
||||||
guest_home = self.guest_home
|
guest_home = self.guest_home
|
||||||
@@ -180,13 +180,24 @@ class ClaudeAgentProvider(AgentProvider):
|
|||||||
claude_settings,
|
claude_settings,
|
||||||
f"{guest_home}/.claude/settings.json",
|
f"{guest_home}/.claude/settings.json",
|
||||||
))
|
))
|
||||||
|
provisioned_env: dict[str, str] = {}
|
||||||
|
if forward_host_credentials:
|
||||||
|
_host_env = host_env or dict(os.environ)
|
||||||
|
provisioned_env[CLAUDE_HOST_CREDENTIAL_TOKEN_REF] = (
|
||||||
|
claude_host_access_token(_host_env)
|
||||||
|
)
|
||||||
|
|
||||||
|
cred_token_ref = (
|
||||||
|
CLAUDE_HOST_CREDENTIAL_TOKEN_REF if forward_host_credentials
|
||||||
|
else auth_token
|
||||||
|
)
|
||||||
egress_routes = (EgressRoute(
|
egress_routes = (EgressRoute(
|
||||||
host="api.anthropic.com",
|
host="api.anthropic.com",
|
||||||
auth_scheme="Bearer" if auth_token else "",
|
auth_scheme="Bearer" if (auth_token or forward_host_credentials) else "",
|
||||||
token_ref=auth_token,
|
token_ref=cred_token_ref,
|
||||||
),)
|
),)
|
||||||
hidden_env_names: frozenset[str] = frozenset()
|
hidden_env_names: frozenset[str] = frozenset()
|
||||||
if auth_token:
|
if auth_token or forward_host_credentials:
|
||||||
env_vars["CLAUDE_CODE_OAUTH_TOKEN"] = "egress-placeholder"
|
env_vars["CLAUDE_CODE_OAUTH_TOKEN"] = "egress-placeholder"
|
||||||
hidden_env_names = frozenset({"CLAUDE_CODE_OAUTH_TOKEN"})
|
hidden_env_names = frozenset({"CLAUDE_CODE_OAUTH_TOKEN"})
|
||||||
|
|
||||||
@@ -208,6 +219,7 @@ class ClaudeAgentProvider(AgentProvider):
|
|||||||
files=tuple(files),
|
files=tuple(files),
|
||||||
egress_routes=egress_routes,
|
egress_routes=egress_routes,
|
||||||
hidden_env_names=hidden_env_names,
|
hidden_env_names=hidden_env_names,
|
||||||
|
provisioned_env=provisioned_env,
|
||||||
)
|
)
|
||||||
|
|
||||||
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
|||||||
@@ -0,0 +1,114 @@
|
|||||||
|
"""Host Claude auth helpers.
|
||||||
|
|
||||||
|
Reads the host's Claude Code credentials and returns only the access
|
||||||
|
token needed by egress. Does not expose refresh tokens or raw payloads.
|
||||||
|
|
||||||
|
Credential storage by platform:
|
||||||
|
Linux — ~/.claude/.credentials.json
|
||||||
|
macOS — macOS Keychain, service "Claude Code-credentials"
|
||||||
|
(file path is tried first; Keychain is the fallback)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...log import die
|
||||||
|
|
||||||
|
|
||||||
|
_KEYCHAIN_SERVICE = "Claude Code-credentials"
|
||||||
|
|
||||||
|
|
||||||
|
def claude_auth_path(host_env: dict[str, str] | None = None) -> Path:
|
||||||
|
env = os.environ if host_env is None else host_env
|
||||||
|
home = env.get("HOME")
|
||||||
|
if home:
|
||||||
|
return Path(home) / ".claude" / ".credentials.json"
|
||||||
|
return Path.home() / ".claude" / ".credentials.json"
|
||||||
|
|
||||||
|
|
||||||
|
def _read_keychain() -> dict[str, object] | None:
|
||||||
|
"""Try the macOS Keychain. Returns parsed JSON dict or None."""
|
||||||
|
if sys.platform != "darwin":
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
result = subprocess.run(
|
||||||
|
["security", "find-generic-password", "-s", _KEYCHAIN_SERVICE, "-w"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=10,
|
||||||
|
)
|
||||||
|
except (FileNotFoundError, subprocess.TimeoutExpired):
|
||||||
|
return None
|
||||||
|
if result.returncode != 0 or not result.stdout.strip():
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
raw = json.loads(result.stdout.strip())
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return None
|
||||||
|
return raw if isinstance(raw, dict) else None
|
||||||
|
|
||||||
|
|
||||||
|
def claude_host_access_token(
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
*,
|
||||||
|
now: datetime | None = None,
|
||||||
|
) -> str:
|
||||||
|
path = claude_auth_path(host_env)
|
||||||
|
raw: dict[str, object] | None = None
|
||||||
|
|
||||||
|
if path.is_file():
|
||||||
|
try:
|
||||||
|
raw = json.loads(path.read_text())
|
||||||
|
except (OSError, json.JSONDecodeError) as e:
|
||||||
|
die(f"claude host credentials: could not read valid JSON at {path}: {e}")
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
die(f"claude host credentials: {path} must contain a JSON object")
|
||||||
|
else:
|
||||||
|
raw = _read_keychain()
|
||||||
|
if raw is None:
|
||||||
|
die(
|
||||||
|
f"claude host credentials: auth file missing at {path} and "
|
||||||
|
f"macOS Keychain lookup for '{_KEYCHAIN_SERVICE}' failed. "
|
||||||
|
"Run `claude login` on the host or disable "
|
||||||
|
"agent_provider.forward_host_credentials."
|
||||||
|
)
|
||||||
|
|
||||||
|
oauth = raw.get("claudeAiOauth")
|
||||||
|
if not isinstance(oauth, dict):
|
||||||
|
die(
|
||||||
|
"claude host credentials: claudeAiOauth is missing from credentials. "
|
||||||
|
"Run `claude login` on the host or disable "
|
||||||
|
"agent_provider.forward_host_credentials."
|
||||||
|
)
|
||||||
|
|
||||||
|
access_token = oauth.get("accessToken")
|
||||||
|
if not isinstance(access_token, str) or not access_token:
|
||||||
|
die(
|
||||||
|
"claude host credentials: claudeAiOauth.accessToken is missing or empty. "
|
||||||
|
"Run `claude login` on the host and restart the bottle."
|
||||||
|
)
|
||||||
|
|
||||||
|
# expiresAt is in milliseconds
|
||||||
|
expires_at = oauth.get("expiresAt")
|
||||||
|
if isinstance(expires_at, (int, float)):
|
||||||
|
check_now = now or datetime.now(timezone.utc)
|
||||||
|
exp_dt = datetime.fromtimestamp(float(expires_at) / 1000.0, timezone.utc)
|
||||||
|
if exp_dt <= check_now:
|
||||||
|
die(
|
||||||
|
"claude host credentials: host Claude access token is expired. "
|
||||||
|
"Run `claude login` on the host and restart the bottle."
|
||||||
|
)
|
||||||
|
|
||||||
|
return access_token
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"claude_auth_path",
|
||||||
|
"claude_host_access_token",
|
||||||
|
]
|
||||||
@@ -3,10 +3,17 @@
|
|||||||
# Mirrors the default Claude image shape: Node LTS, git/network tooling,
|
# Mirrors the default Claude image shape: Node LTS, git/network tooling,
|
||||||
# non-root node user, and the provider CLI installed for that user.
|
# non-root node user, and the provider CLI installed for that user.
|
||||||
|
|
||||||
FROM node:22-slim
|
FROM node:22-trixie-slim
|
||||||
|
|
||||||
RUN apt-get update \
|
RUN apt-get update \
|
||||||
&& apt-get install -y --no-install-recommends git ca-certificates curl procps ripgrep \
|
&& apt-get install -y --no-install-recommends \
|
||||||
|
git \
|
||||||
|
ca-certificates \
|
||||||
|
curl \
|
||||||
|
openssh-client \
|
||||||
|
podman \
|
||||||
|
procps \
|
||||||
|
ripgrep \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
# App-specific deps. Python isn't required by codex itself
|
# App-specific deps. Python isn't required by codex itself
|
||||||
@@ -17,6 +24,8 @@ RUN apt-get update \
|
|||||||
&& apt-get install -y --no-install-recommends python3 python3-pip python3-venv \
|
&& apt-get install -y --no-install-recommends python3 python3-pip python3-venv \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
RUN install -d -o node -g node -m 755 /home/node/.config /home/node/.config/git
|
||||||
|
|
||||||
USER node
|
USER node
|
||||||
WORKDIR /home/node
|
WORKDIR /home/node
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
#
|
#
|
||||||
# Node LTS, git/network tooling, and the Pi coding-agent CLI installed globally.
|
# Node LTS, git/network tooling, and the Pi coding-agent CLI installed globally.
|
||||||
|
|
||||||
FROM node:22-slim
|
FROM node:22-trixie-slim
|
||||||
|
|
||||||
RUN apt-get update \
|
RUN apt-get update \
|
||||||
&& apt-get install -y --no-install-recommends \
|
&& apt-get install -y --no-install-recommends \
|
||||||
@@ -10,6 +10,8 @@ RUN apt-get update \
|
|||||||
ca-certificates \
|
ca-certificates \
|
||||||
curl \
|
curl \
|
||||||
fd-find \
|
fd-find \
|
||||||
|
openssh-client \
|
||||||
|
podman \
|
||||||
ripgrep \
|
ripgrep \
|
||||||
&& ln -s /usr/bin/fdfind /usr/local/bin/fd \
|
&& ln -s /usr/bin/fdfind /usr/local/bin/fd \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
@@ -21,7 +23,8 @@ RUN apt-get update \
|
|||||||
RUN npm install -g --ignore-scripts --no-fund --no-audit @earendil-works/pi-coding-agent \
|
RUN npm install -g --ignore-scripts --no-fund --no-audit @earendil-works/pi-coding-agent \
|
||||||
&& npm cache clean --force
|
&& npm cache clean --force
|
||||||
|
|
||||||
RUN mkdir -p /home/node/.pi/agent \
|
RUN install -d -o node -g node -m 755 /home/node/.config /home/node/.config/git \
|
||||||
|
&& mkdir -p /home/node/.pi/agent \
|
||||||
/home/node/.pi/context-mode/sessions \
|
/home/node/.pi/context-mode/sessions \
|
||||||
/tmp/pi-subagents-uid-1000 \
|
/tmp/pi-subagents-uid-1000 \
|
||||||
&& chown -R node:node /home/node/.pi /tmp \
|
&& chown -R node:node /home/node/.pi /tmp \
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ if TYPE_CHECKING:
|
|||||||
from .manifest import ManifestBottle
|
from .manifest import ManifestBottle
|
||||||
|
|
||||||
CODEX_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CODEX_HOST_ACCESS_TOKEN"
|
CODEX_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CODEX_HOST_ACCESS_TOKEN"
|
||||||
|
CLAUDE_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CLAUDE_HOST_ACCESS_TOKEN"
|
||||||
|
|
||||||
EGRESS_HOSTNAME = "egress"
|
EGRESS_HOSTNAME = "egress"
|
||||||
|
|
||||||
@@ -145,6 +146,7 @@ def egress_manifest_routes(
|
|||||||
outbound_detectors=r.OutboundDetectors,
|
outbound_detectors=r.OutboundDetectors,
|
||||||
inbound_detectors=r.InboundDetectors,
|
inbound_detectors=r.InboundDetectors,
|
||||||
outbound_on_match=r.OutboundOnMatch,
|
outbound_on_match=r.OutboundOnMatch,
|
||||||
|
preserve_auth=r.PreserveAuth,
|
||||||
))
|
))
|
||||||
return tuple(out)
|
return tuple(out)
|
||||||
|
|
||||||
@@ -253,6 +255,8 @@ def _route_to_yaml_fields(r: Route) -> dict[str, object]:
|
|||||||
fields["matches"] = matches_data
|
fields["matches"] = matches_data
|
||||||
if r.git_fetch:
|
if r.git_fetch:
|
||||||
fields["git"] = {"fetch": True}
|
fields["git"] = {"fetch": True}
|
||||||
|
if r.preserve_auth:
|
||||||
|
fields["preserve_auth"] = True
|
||||||
if (
|
if (
|
||||||
r.outbound_detectors is not None
|
r.outbound_detectors is not None
|
||||||
or r.inbound_detectors is not None
|
or r.inbound_detectors is not None
|
||||||
@@ -333,6 +337,8 @@ def egress_render_routes(
|
|||||||
lines.append(" git:")
|
lines.append(" git:")
|
||||||
if git_dict.get("fetch") is True:
|
if git_dict.get("fetch") is True:
|
||||||
lines.append(" fetch: true")
|
lines.append(" fetch: true")
|
||||||
|
if f.get("preserve_auth") is True:
|
||||||
|
lines.append(" preserve_auth: true")
|
||||||
if "dlp" in f:
|
if "dlp" in f:
|
||||||
dlp_dict: dict[str, object] = f["dlp"] # type: ignore
|
dlp_dict: dict[str, object] = f["dlp"] # type: ignore
|
||||||
lines.append(" dlp:")
|
lines.append(" dlp:")
|
||||||
@@ -400,6 +406,7 @@ class Egress(ABC):
|
|||||||
)
|
)
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
"CLAUDE_HOST_CREDENTIAL_TOKEN_REF",
|
||||||
"CODEX_HOST_CREDENTIAL_TOKEN_REF",
|
"CODEX_HOST_CREDENTIAL_TOKEN_REF",
|
||||||
"EGRESS_HOSTNAME",
|
"EGRESS_HOSTNAME",
|
||||||
"EGRESS_ROUTES_FILENAME",
|
"EGRESS_ROUTES_FILENAME",
|
||||||
|
|||||||
@@ -367,7 +367,10 @@ class EgressAddon:
|
|||||||
|
|
||||||
# Strip agent-set Authorization after DLP scan so smuggled tokens
|
# Strip agent-set Authorization after DLP scan so smuggled tokens
|
||||||
# are caught above; the route may inject gateway-owned auth below.
|
# are caught above; the route may inject gateway-owned auth below.
|
||||||
flow.request.headers.pop("authorization", None)
|
# Routes with preserve_auth=True pass the header through as-is so the
|
||||||
|
# agent's own credentials (e.g. registry bearer tokens) reach the upstream.
|
||||||
|
if route is None or not route.preserve_auth:
|
||||||
|
flow.request.headers.pop("authorization", None)
|
||||||
|
|
||||||
# Build headers mapping for match evaluation
|
# Build headers mapping for match evaluation
|
||||||
req_headers = {k.lower(): v for k, v in flow.request.headers.items()}
|
req_headers = {k.lower(): v for k, v in flow.request.headers.items()}
|
||||||
@@ -379,6 +382,7 @@ class EgressAddon:
|
|||||||
env,
|
env,
|
||||||
request_method=flow.request.method,
|
request_method=flow.request.method,
|
||||||
request_headers=req_headers,
|
request_headers=req_headers,
|
||||||
|
deny_reason=config.deny_reason,
|
||||||
)
|
)
|
||||||
|
|
||||||
if decision.action == "block":
|
if decision.action == "block":
|
||||||
|
|||||||
@@ -78,6 +78,7 @@ class Route:
|
|||||||
inbound_detectors: tuple[str, ...] | None = None
|
inbound_detectors: tuple[str, ...] | None = None
|
||||||
# "" means unset → DEFAULT_OUTBOUND_ON_MATCH. See OUTBOUND_ON_MATCH_VALUES.
|
# "" means unset → DEFAULT_OUTBOUND_ON_MATCH. See OUTBOUND_ON_MATCH_VALUES.
|
||||||
outbound_on_match: str = ""
|
outbound_on_match: str = ""
|
||||||
|
preserve_auth: bool = False
|
||||||
|
|
||||||
|
|
||||||
LOG_OFF = 0 # no logging
|
LOG_OFF = 0 # no logging
|
||||||
@@ -89,6 +90,14 @@ LOG_FULL = 2 # log block/warn events + full request and response bodies
|
|||||||
class Config:
|
class Config:
|
||||||
routes: tuple[Route, ...]
|
routes: tuple[Route, ...]
|
||||||
log: int = LOG_OFF
|
log: int = LOG_OFF
|
||||||
|
# Why this Config is a deny-all, when it is one for a reason *other* than
|
||||||
|
# the bottle's own policy genuinely not listing the host. A deny-all is
|
||||||
|
# indistinguishable from "policy loaded, host not allowed" at the decision
|
||||||
|
# point — both are simply "no matching route" — so without this the
|
||||||
|
# operator sees `host X is not in the allowlist` and goes hunting for a
|
||||||
|
# missing route that was never the problem. Empty for a normally-parsed
|
||||||
|
# policy; `decide` prefers it over the allowlist wording when set.
|
||||||
|
deny_reason: str = ""
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -300,11 +309,18 @@ def _parse_one(idx: int, raw: object) -> Route:
|
|||||||
idx, host, raw_dict,
|
idx, host, raw_dict,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
preserve_auth_raw = raw_dict.get("preserve_auth", False)
|
||||||
|
if preserve_auth_raw is not True and preserve_auth_raw is not False:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label} ({host}): 'preserve_auth' must be a boolean"
|
||||||
|
)
|
||||||
|
preserve_auth: bool = preserve_auth_raw
|
||||||
|
|
||||||
for k in raw_dict:
|
for k in raw_dict:
|
||||||
if k not in ("host", "matches", "auth_scheme", "token_env", "dlp", "git"):
|
if k not in ("host", "matches", "auth_scheme", "token_env", "dlp", "git", "preserve_auth"):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"{label} ({host}): unknown key {k!r}; accepted keys "
|
f"{label} ({host}): unknown key {k!r}; accepted keys "
|
||||||
f"are 'host', 'matches', 'auth_scheme', 'token_env', 'dlp', 'git'"
|
f"are 'host', 'matches', 'auth_scheme', 'token_env', 'dlp', 'git', 'preserve_auth'"
|
||||||
)
|
)
|
||||||
|
|
||||||
return Route(
|
return Route(
|
||||||
@@ -316,6 +332,7 @@ def _parse_one(idx: int, raw: object) -> Route:
|
|||||||
outbound_detectors=outbound_detectors,
|
outbound_detectors=outbound_detectors,
|
||||||
inbound_detectors=inbound_detectors,
|
inbound_detectors=inbound_detectors,
|
||||||
outbound_on_match=outbound_on_match,
|
outbound_on_match=outbound_on_match,
|
||||||
|
preserve_auth=preserve_auth,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -368,6 +385,8 @@ def route_to_yaml_dict(r: Route) -> dict[str, object]:
|
|||||||
dlp["outbound_on_match"] = r.outbound_on_match
|
dlp["outbound_on_match"] = r.outbound_on_match
|
||||||
if dlp:
|
if dlp:
|
||||||
d["dlp"] = dlp
|
d["dlp"] = dlp
|
||||||
|
if r.preserve_auth:
|
||||||
|
d["preserve_auth"] = True
|
||||||
return d
|
return d
|
||||||
|
|
||||||
|
|
||||||
@@ -405,16 +424,40 @@ class PolicyResolverLike(typing.Protocol):
|
|||||||
...
|
...
|
||||||
|
|
||||||
|
|
||||||
|
# Deny-all explanations. Each names the *actual* failure so an operator isn't
|
||||||
|
# sent looking for a missing egress route when the bottle never had a policy
|
||||||
|
# to begin with — the failure mode that made a bricked registration read like
|
||||||
|
# a misconfigured allowlist.
|
||||||
|
DENY_UNATTRIBUTED = (
|
||||||
|
"egress: this request was not attributed to any bottle, so no egress "
|
||||||
|
"policy applies and every host is denied. Either the bottle's registry "
|
||||||
|
"row is missing/ambiguous (torn down, or another bottle claimed its "
|
||||||
|
"source IP), or the request carried no matching identity token — check "
|
||||||
|
"that the caller's proxy URL includes it. This is not an allowlist problem."
|
||||||
|
)
|
||||||
|
DENY_UNPARSEABLE = (
|
||||||
|
"egress: this bottle's egress policy could not be parsed, so it is being "
|
||||||
|
"treated as deny-all. Fix the bottle's egress.routes; every host is denied "
|
||||||
|
"until it loads."
|
||||||
|
)
|
||||||
|
DENY_RESOLVER_ERROR = (
|
||||||
|
"egress: the orchestrator could not be reached to resolve this bottle's "
|
||||||
|
"egress policy, so every host is denied (fail-closed). Check that the "
|
||||||
|
"control plane is up; this is not an allowlist problem."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _config_from_policy(policy: "str | None") -> "Config":
|
def _config_from_policy(policy: "str | None") -> "Config":
|
||||||
"""Parse a resolved policy blob into a Config, fail-closed: None / empty /
|
"""Parse a resolved policy blob into a Config, fail-closed: None / empty /
|
||||||
unparseable all become a deny-all Config (no routes → every request
|
unparseable all become a deny-all Config (no routes → every request
|
||||||
blocked)."""
|
blocked). Each deny-all carries the reason it is one, so the block message
|
||||||
|
names the real fault instead of blaming the allowlist."""
|
||||||
if not policy:
|
if not policy:
|
||||||
return Config(routes=()) # unattributed or empty → deny-all
|
return Config(routes=(), deny_reason=DENY_UNATTRIBUTED)
|
||||||
try:
|
try:
|
||||||
return load_config(policy)
|
return load_config(policy)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
return Config(routes=()) # unparseable policy → deny
|
return Config(routes=(), deny_reason=DENY_UNPARSEABLE)
|
||||||
|
|
||||||
|
|
||||||
def resolve_client_config(
|
def resolve_client_config(
|
||||||
@@ -428,7 +471,7 @@ def resolve_client_config(
|
|||||||
try:
|
try:
|
||||||
policy = resolver.resolve(client_ip, identity_token)
|
policy = resolver.resolve(client_ip, identity_token)
|
||||||
except Exception: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
except Exception: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
||||||
return Config(routes=()) # orchestrator unreachable/errored → deny
|
return Config(routes=(), deny_reason=DENY_RESOLVER_ERROR)
|
||||||
return _config_from_policy(policy)
|
return _config_from_policy(policy)
|
||||||
|
|
||||||
|
|
||||||
@@ -457,7 +500,7 @@ def resolve_client_context(
|
|||||||
client_ip, identity_token,
|
client_ip, identity_token,
|
||||||
)
|
)
|
||||||
except Exception: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
except Exception: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
||||||
return Config(routes=()), "", {} # orchestrator unreachable/errored → deny
|
return Config(routes=(), deny_reason=DENY_RESOLVER_ERROR), "", {}
|
||||||
return _config_from_policy(policy), (bottle_id or ""), tokens
|
return _config_from_policy(policy), (bottle_id or ""), tokens
|
||||||
|
|
||||||
|
|
||||||
@@ -572,12 +615,16 @@ def decide(
|
|||||||
*,
|
*,
|
||||||
request_method: str = "GET",
|
request_method: str = "GET",
|
||||||
request_headers: typing.Mapping[str, str] | None = None,
|
request_headers: typing.Mapping[str, str] | None = None,
|
||||||
|
deny_reason: str = "",
|
||||||
) -> Decision:
|
) -> Decision:
|
||||||
|
"""`deny_reason` is `Config.deny_reason`: when the deny-all came from a
|
||||||
|
missing/unparseable policy rather than the bottle's own allowlist, report
|
||||||
|
that instead of implying a route is merely absent."""
|
||||||
route = match_route(routes, request_host)
|
route = match_route(routes, request_host)
|
||||||
if route is None:
|
if route is None:
|
||||||
return Decision(
|
return Decision(
|
||||||
action="block",
|
action="block",
|
||||||
reason=(
|
reason=deny_reason or (
|
||||||
f"egress: host {request_host!r} is not in the "
|
f"egress: host {request_host!r} is not in the "
|
||||||
f"bottle's egress.routes allowlist. Declare a "
|
f"bottle's egress.routes allowlist. Declare a "
|
||||||
f"route for it or remove the request."
|
f"route for it or remove the request."
|
||||||
@@ -852,6 +899,9 @@ __all__ = [
|
|||||||
"is_git_push_request",
|
"is_git_push_request",
|
||||||
"is_git_fetch_request",
|
"is_git_fetch_request",
|
||||||
"load_config",
|
"load_config",
|
||||||
|
"DENY_UNATTRIBUTED",
|
||||||
|
"DENY_UNPARSEABLE",
|
||||||
|
"DENY_RESOLVER_ERROR",
|
||||||
"resolve_client_config",
|
"resolve_client_config",
|
||||||
"resolve_client_context",
|
"resolve_client_context",
|
||||||
"PolicyResolverLike",
|
"PolicyResolverLike",
|
||||||
|
|||||||
+35
-15
@@ -61,6 +61,11 @@ class _DaemonSpec:
|
|||||||
_EGRESS_ONLY_ENV_PREFIXES: tuple[str, ...] = ("EGRESS_TOKEN_",)
|
_EGRESS_ONLY_ENV_PREFIXES: tuple[str, ...] = ("EGRESS_TOKEN_",)
|
||||||
_READY_GATED_DAEMONS: tuple[str, ...] = ("git-gate", "git-http")
|
_READY_GATED_DAEMONS: tuple[str, ...] = ("git-gate", "git-http")
|
||||||
|
|
||||||
|
# Daemons that must be requested explicitly via BOT_BOTTLE_GATEWAY_DAEMONS
|
||||||
|
# and are NOT started in the default (env-var-unset) case. The orchestrator
|
||||||
|
# only runs in the combined infra container, never in a standalone gateway.
|
||||||
|
_OPT_IN_DAEMONS: frozenset[str] = frozenset({"orchestrator"})
|
||||||
|
|
||||||
|
|
||||||
def _env_for_daemon(name: str, base_env: dict[str, str]) -> dict[str, str]:
|
def _env_for_daemon(name: str, base_env: dict[str, str]) -> dict[str, str]:
|
||||||
"""Egress sees the full bundle env. Everyone else gets a copy
|
"""Egress sees the full bundle env. Everyone else gets a copy
|
||||||
@@ -75,7 +80,14 @@ def _env_for_daemon(name: str, base_env: dict[str, str]) -> dict[str, str]:
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# The orchestrator is listed first so it starts before the gateway daemons,
|
||||||
|
# giving the control plane a head start to accept /resolve calls. The gateway
|
||||||
|
# daemons tolerate early /resolve failures and retry per-request.
|
||||||
_DAEMONS: tuple[_DaemonSpec, ...] = (
|
_DAEMONS: tuple[_DaemonSpec, ...] = (
|
||||||
|
_DaemonSpec("orchestrator", (
|
||||||
|
"python3", "-m", "bot_bottle.orchestrator",
|
||||||
|
"--host", "0.0.0.0", "--port", "8099", "--broker", "stub",
|
||||||
|
)),
|
||||||
_DaemonSpec("egress", ("/bin/sh", "/app/egress-entrypoint.sh")),
|
_DaemonSpec("egress", ("/bin/sh", "/app/egress-entrypoint.sh")),
|
||||||
_DaemonSpec("git-gate", ("/bin/sh", "/git-gate-entrypoint.sh")),
|
_DaemonSpec("git-gate", ("/bin/sh", "/git-gate-entrypoint.sh")),
|
||||||
_DaemonSpec("git-http", ("python3", "-m", "bot_bottle.git_http_backend")),
|
_DaemonSpec("git-http", ("python3", "-m", "bot_bottle.git_http_backend")),
|
||||||
@@ -103,18 +115,20 @@ def _selected_daemons(
|
|||||||
env: dict[str, str],
|
env: dict[str, str],
|
||||||
all_daemons: Sequence[_DaemonSpec] | None = None,
|
all_daemons: Sequence[_DaemonSpec] | None = None,
|
||||||
) -> tuple[_DaemonSpec, ...]:
|
) -> tuple[_DaemonSpec, ...]:
|
||||||
"""Filter the daemon set by the BOT_BOTTLE_GATEWAY_DAEMONS env
|
"""Filter the daemon set by the BOT_BOTTLE_GATEWAY_DAEMONS env var.
|
||||||
var. Unknown names in the list are ignored — the caller is the
|
|
||||||
source of truth for which daemons are wired.
|
|
||||||
|
|
||||||
`all_daemons` defaults to `_DAEMONS` resolved at call time (not
|
When the var is unset/empty, return all non-opt-in daemons (the
|
||||||
at definition time), so tests can monkey-patch the module-level
|
standard gateway subset). Opt-in daemons (e.g. `orchestrator`) only
|
||||||
`_DAEMONS` and have the new value take effect."""
|
run when explicitly named — they never start in a plain gateway
|
||||||
|
container that doesn't set the env var. Unknown names are ignored.
|
||||||
|
|
||||||
|
`all_daemons` defaults to `_DAEMONS` resolved at call time (not at
|
||||||
|
definition time), so tests can pass a custom list."""
|
||||||
if all_daemons is None:
|
if all_daemons is None:
|
||||||
all_daemons = _DAEMONS
|
all_daemons = _DAEMONS
|
||||||
raw = env.get("BOT_BOTTLE_GATEWAY_DAEMONS", "").strip()
|
raw = env.get("BOT_BOTTLE_GATEWAY_DAEMONS", "").strip()
|
||||||
if not raw:
|
if not raw:
|
||||||
return tuple(all_daemons)
|
return tuple(d for d in all_daemons if d.name not in _OPT_IN_DAEMONS)
|
||||||
wanted = {n.strip() for n in raw.split(",") if n.strip()}
|
wanted = {n.strip() for n in raw.split(",") if n.strip()}
|
||||||
return tuple(d for d in all_daemons if d.name in wanted)
|
return tuple(d for d in all_daemons if d.name in wanted)
|
||||||
|
|
||||||
@@ -136,7 +150,7 @@ def _pump(name: str, stream: IO[bytes]) -> None:
|
|||||||
|
|
||||||
def _spawn(spec: _DaemonSpec) -> subprocess.Popen[bytes]:
|
def _spawn(spec: _DaemonSpec) -> subprocess.Popen[bytes]:
|
||||||
env = _env_for_daemon(spec.name, dict(os.environ))
|
env = _env_for_daemon(spec.name, dict(os.environ))
|
||||||
proc = subprocess.Popen(
|
proc = subprocess.Popen( # pylint: disable=consider-using-with
|
||||||
_argv_for_daemon(spec.name, spec.argv, env),
|
_argv_for_daemon(spec.name, spec.argv, env),
|
||||||
stdout=subprocess.PIPE,
|
stdout=subprocess.PIPE,
|
||||||
stderr=subprocess.STDOUT,
|
stderr=subprocess.STDOUT,
|
||||||
@@ -183,6 +197,14 @@ class _Supervisor:
|
|||||||
except ProcessLookupError:
|
except ProcessLookupError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
def _sigkill_all(self) -> None:
|
||||||
|
for _, p in self.procs:
|
||||||
|
if p.poll() is None:
|
||||||
|
try:
|
||||||
|
p.kill()
|
||||||
|
except ProcessLookupError:
|
||||||
|
pass
|
||||||
|
|
||||||
def request_restart(self, daemon_name: str) -> bool:
|
def request_restart(self, daemon_name: str) -> bool:
|
||||||
"""Queue a daemon restart for the main loop to process.
|
"""Queue a daemon restart for the main loop to process.
|
||||||
|
|
||||||
@@ -235,12 +257,7 @@ class _Supervisor:
|
|||||||
f"grace ({_GRACE_SECONDS:.0f}s) elapsed; SIGKILL on "
|
f"grace ({_GRACE_SECONDS:.0f}s) elapsed; SIGKILL on "
|
||||||
f"{', '.join(still_running)}"
|
f"{', '.join(still_running)}"
|
||||||
)
|
)
|
||||||
for _, p in self.procs:
|
self._sigkill_all()
|
||||||
if p.poll() is None:
|
|
||||||
try:
|
|
||||||
p.kill()
|
|
||||||
except ProcessLookupError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
done = all(p.poll() is not None for _, p in self.procs)
|
done = all(p.poll() is not None for _, p in self.procs)
|
||||||
if done:
|
if done:
|
||||||
@@ -361,7 +378,10 @@ def main(argv: Sequence[str] | None = None) -> int:
|
|||||||
# --signal HUP <bundle>` after writing routes.yaml. The kernel
|
# --signal HUP <bundle>` after writing routes.yaml. The kernel
|
||||||
# delivers SIGHUP to PID 1 (this supervisor); forward it to
|
# delivers SIGHUP to PID 1 (this supervisor); forward it to
|
||||||
# mitmdump so it reloads its addon.
|
# mitmdump so it reloads its addon.
|
||||||
signal.signal(signal.SIGHUP, lambda *_: sup.forward_signal(signal.SIGHUP, "egress")) # type: ignore
|
signal.signal(
|
||||||
|
signal.SIGHUP,
|
||||||
|
lambda *_: sup.forward_signal(signal.SIGHUP, "egress"), # type: ignore[misc]
|
||||||
|
)
|
||||||
|
|
||||||
while not sup.tick():
|
while not sup.tick():
|
||||||
time.sleep(_POLL_INTERVAL)
|
time.sleep(_POLL_INTERVAL)
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
"""Shared helpers for cached-image quickstart stale checks."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
try:
|
||||||
|
from .config_store import ConfigStore
|
||||||
|
except ImportError:
|
||||||
|
from config_store import ConfigStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
|
||||||
|
|
||||||
|
class StaleImageError(Exception):
|
||||||
|
"""Raised when a cached image or artifact exceeds the configured staleness
|
||||||
|
threshold. Callers can catch this to prompt interactively; headless paths
|
||||||
|
let it propagate as a fatal error."""
|
||||||
|
|
||||||
|
|
||||||
|
def check_stale(label: str, created_at: datetime) -> None:
|
||||||
|
"""Raise StaleImageError if `created_at` is older than the configured
|
||||||
|
stale-warning threshold. Negative threshold disables the check."""
|
||||||
|
threshold_days = ConfigStore().cached_image_stale_warning_days()
|
||||||
|
if threshold_days < 0:
|
||||||
|
return
|
||||||
|
now = datetime.now(timezone.utc)
|
||||||
|
created = created_at.astimezone(timezone.utc)
|
||||||
|
age = now - created
|
||||||
|
if age.total_seconds() <= threshold_days * 86400:
|
||||||
|
return
|
||||||
|
raise StaleImageError(
|
||||||
|
f"cached {label} is {age.days} day(s) old; "
|
||||||
|
"quickstart does not verify it matches the current Dockerfile/context"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def check_stale_path(label: str, path: Path) -> None:
|
||||||
|
"""Raise StaleImageError if `path`'s mtime exceeds the staleness threshold."""
|
||||||
|
check_stale(label, datetime.fromtimestamp(path.stat().st_mtime, tz=timezone.utc))
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["StaleImageError", "check_stale", "check_stale_path"]
|
||||||
@@ -20,6 +20,7 @@ Bottle schema (frontmatter):
|
|||||||
egress: { routes: [ <egress-route>, ... ] }
|
egress: { routes: [ <egress-route>, ... ] }
|
||||||
# route keys: host, matches, auth, role, dlp
|
# route keys: host, matches, auth, role, dlp
|
||||||
supervise: <bool> # optional (default true)
|
supervise: <bool> # optional (default true)
|
||||||
|
nested_containers: <bool> # optional (default false)
|
||||||
|
|
||||||
Agent schema (frontmatter):
|
Agent schema (frontmatter):
|
||||||
bottle: <bottle-name> # required
|
bottle: <bottle-name> # required
|
||||||
|
|||||||
@@ -25,8 +25,9 @@ class ManifestAgentProvider:
|
|||||||
header, and sets a placeholder CLAUDE_CODE_OAUTH_TOKEN in the agent
|
header, and sets a placeholder CLAUDE_CODE_OAUTH_TOKEN in the agent
|
||||||
so the Claude Code CLI starts.
|
so the Claude Code CLI starts.
|
||||||
|
|
||||||
`forward_host_credentials` forwards the host Codex auth token into
|
`forward_host_credentials` forwards the host provider auth token into
|
||||||
the egress daemon (Codex only).
|
the egress sidecar (Codex and Claude). For Codex this reads
|
||||||
|
`~/.codex/auth.json`; for Claude it reads `~/.claude/.credentials.json`.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
template: str = "claude"
|
template: str = "claude"
|
||||||
@@ -92,10 +93,15 @@ class ManifestAgentProvider:
|
|||||||
f"is only supported for built-in templates "
|
f"is only supported for built-in templates "
|
||||||
f"({', '.join(sorted(PROVIDER_TEMPLATES))})"
|
f"({', '.join(sorted(PROVIDER_TEMPLATES))})"
|
||||||
)
|
)
|
||||||
if forward_host_credentials and template != "codex":
|
if forward_host_credentials and template not in {"codex", "claude"}:
|
||||||
raise ManifestError(
|
raise ManifestError(
|
||||||
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
||||||
"is currently only supported for template 'codex'"
|
"is only supported for templates 'codex' and 'claude'"
|
||||||
|
)
|
||||||
|
if forward_host_credentials and auth_token:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
||||||
|
"and auth_token both set; use one or the other"
|
||||||
)
|
)
|
||||||
settings = _parse_provider_settings(bottle_name, template, d.get("settings"))
|
settings = _parse_provider_settings(bottle_name, template, d.get("settings"))
|
||||||
return cls(
|
return cls(
|
||||||
|
|||||||
@@ -44,6 +44,11 @@ class ManifestBottle:
|
|||||||
# daemon that exposes egress MCP tools to the agent. Set
|
# daemon that exposes egress MCP tools to the agent. Set
|
||||||
# `supervise: false` to skip the gateway.
|
# `supervise: false` to skip the gateway.
|
||||||
supervise: bool = True
|
supervise: bool = True
|
||||||
|
# Guest-local container engine (issue #392). Not a host-daemon grant:
|
||||||
|
# backends implement it inside the bottle or reject it. Gated because it
|
||||||
|
# costs image weight, a resident service, and relaxed guest device modes
|
||||||
|
# that the majority of bottles never need.
|
||||||
|
nested_containers: bool = False
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def from_dict(cls, name: str, raw: object) -> "ManifestBottle":
|
def from_dict(cls, name: str, raw: object) -> "ManifestBottle":
|
||||||
@@ -123,7 +128,15 @@ class ManifestBottle:
|
|||||||
f"(was {type(supervise_raw).__name__})"
|
f"(was {type(supervise_raw).__name__})"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
nested_raw = d.get("nested_containers", False)
|
||||||
|
if not isinstance(nested_raw, bool):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' nested_containers must be a boolean "
|
||||||
|
f"(was {type(nested_raw).__name__})"
|
||||||
|
)
|
||||||
|
|
||||||
return cls(
|
return cls(
|
||||||
env=env, agent_provider=agent_provider, git=git,
|
env=env, agent_provider=agent_provider, git=git,
|
||||||
git_user=git_user, egress=egress, supervise=supervise_raw,
|
git_user=git_user, egress=egress, supervise=supervise_raw,
|
||||||
|
nested_containers=nested_raw,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -71,6 +71,7 @@ class ManifestEgressRoute:
|
|||||||
OutboundDetectors: tuple[str, ...] | None = None
|
OutboundDetectors: tuple[str, ...] | None = None
|
||||||
InboundDetectors: tuple[str, ...] | None = None
|
InboundDetectors: tuple[str, ...] | None = None
|
||||||
OutboundOnMatch: str = ""
|
OutboundOnMatch: str = ""
|
||||||
|
PreserveAuth: bool = False
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def from_dict(cls, bottle_name: str, idx: int, raw: object) -> "ManifestEgressRoute":
|
def from_dict(cls, bottle_name: str, idx: int, raw: object) -> "ManifestEgressRoute":
|
||||||
@@ -190,11 +191,22 @@ class ManifestEgressRoute:
|
|||||||
f"only 'fetch' is accepted"
|
f"only 'fetch' is accepted"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# --- preserve_auth ---
|
||||||
|
preserve_auth = False
|
||||||
|
if "preserve_auth" in d:
|
||||||
|
raw_preserve_auth = d.get("preserve_auth")
|
||||||
|
if not isinstance(raw_preserve_auth, bool):
|
||||||
|
raise ManifestError(
|
||||||
|
f"{label} preserve_auth must be a boolean "
|
||||||
|
f"(was {type(raw_preserve_auth).__name__})"
|
||||||
|
)
|
||||||
|
preserve_auth = raw_preserve_auth
|
||||||
|
|
||||||
for k in d:
|
for k in d:
|
||||||
if k not in ("host", "matches", "auth", "role", "dlp", "git"):
|
if k not in ("host", "matches", "auth", "role", "dlp", "git", "preserve_auth"):
|
||||||
raise ManifestError(
|
raise ManifestError(
|
||||||
f"{label} has unknown key {k!r}; accepted keys are "
|
f"{label} has unknown key {k!r}; accepted keys are "
|
||||||
f"'host', 'matches', 'auth', 'role', 'dlp', 'git'"
|
f"'host', 'matches', 'auth', 'role', 'dlp', 'git', 'preserve_auth'"
|
||||||
)
|
)
|
||||||
|
|
||||||
return cls(
|
return cls(
|
||||||
@@ -207,6 +219,7 @@ class ManifestEgressRoute:
|
|||||||
OutboundDetectors=outbound_detectors,
|
OutboundDetectors=outbound_detectors,
|
||||||
InboundDetectors=inbound_detectors,
|
InboundDetectors=inbound_detectors,
|
||||||
OutboundOnMatch=outbound_on_match,
|
OutboundOnMatch=outbound_on_match,
|
||||||
|
PreserveAuth=preserve_auth,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,16 @@ def merge_bottles_runtime(bottles: "list[ManifestBottle]") -> "ManifestBottle":
|
|||||||
the same field-merge rules as the file-based extends machinery:
|
the same field-merge rules as the file-based extends machinery:
|
||||||
env: dict merge, later wins; git_user: per-field overlay, later
|
env: dict merge, later wins; git_user: per-field overlay, later
|
||||||
wins on non-empty; git (repos): union by name, later wins; egress
|
wins on non-empty; git (repos): union by name, later wins; egress
|
||||||
routes: concatenate; agent_provider, supervise: later replaces.
|
routes: concatenate; agent_provider, supervise: later
|
||||||
|
replaces; nested_containers: OR (see below).
|
||||||
|
|
||||||
|
nested_containers is OR'd rather than replaced because these objects
|
||||||
|
are already resolved: a bottle that never mentions the key is
|
||||||
|
indistinguishable from one that sets it false, so "later replaces"
|
||||||
|
would let any bottle composed after a container-enabled one silently
|
||||||
|
drop the capability. The file-based `extends:` path still sees the
|
||||||
|
raw keys, so there an explicit `nested_containers: false` in a child
|
||||||
|
turns it back off.
|
||||||
"""
|
"""
|
||||||
if not bottles:
|
if not bottles:
|
||||||
raise ValueError("merge_bottles_runtime requires at least one bottle")
|
raise ValueError("merge_bottles_runtime requires at least one bottle")
|
||||||
@@ -54,6 +63,7 @@ def _merge_two_bottles_runtime(base: "ManifestBottle", override: "ManifestBottle
|
|||||||
git_user=merged_git_user,
|
git_user=merged_git_user,
|
||||||
egress=merged_egress,
|
egress=merged_egress,
|
||||||
supervise=override.supervise,
|
supervise=override.supervise,
|
||||||
|
nested_containers=base.nested_containers or override.nested_containers,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -206,6 +216,7 @@ def _fold_two_bottles(
|
|||||||
git_user=merged_git_user,
|
git_user=merged_git_user,
|
||||||
egress=merged_egress,
|
egress=merged_egress,
|
||||||
supervise=later.supervise,
|
supervise=later.supervise,
|
||||||
|
nested_containers=earlier.nested_containers or later.nested_containers,
|
||||||
), merged_repos_raw
|
), merged_repos_raw
|
||||||
|
|
||||||
|
|
||||||
@@ -266,6 +277,11 @@ def _merge_bottles(
|
|||||||
merged_supervise = (
|
merged_supervise = (
|
||||||
child.supervise if "supervise" in child_raw else parent.supervise
|
child.supervise if "supervise" in child_raw else parent.supervise
|
||||||
)
|
)
|
||||||
|
merged_nested_containers = (
|
||||||
|
child.nested_containers
|
||||||
|
if "nested_containers" in child_raw
|
||||||
|
else parent.nested_containers
|
||||||
|
)
|
||||||
validate_egress_routes(name, merged_egress.routes)
|
validate_egress_routes(name, merged_egress.routes)
|
||||||
|
|
||||||
return ManifestBottle(
|
return ManifestBottle(
|
||||||
@@ -275,6 +291,7 @@ def _merge_bottles(
|
|||||||
git_user=merged_git_user,
|
git_user=merged_git_user,
|
||||||
egress=merged_egress,
|
egress=merged_egress,
|
||||||
supervise=merged_supervise,
|
supervise=merged_supervise,
|
||||||
|
nested_containers=merged_nested_containers,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,10 @@ _FILENAME_RX = re.compile(r"^[a-z][a-z0-9-]*$")
|
|||||||
# sets dies with a "did you mean" pointer: typos should not silently
|
# sets dies with a "did you mean" pointer: typos should not silently
|
||||||
# ghost into an empty config.
|
# ghost into an empty config.
|
||||||
BOTTLE_KEYS = frozenset(
|
BOTTLE_KEYS = frozenset(
|
||||||
{"env", "extends", "agent_provider", "git-gate", "egress", "supervise"}
|
{
|
||||||
|
"env", "extends", "agent_provider", "git-gate", "egress",
|
||||||
|
"supervise", "nested_containers",
|
||||||
|
}
|
||||||
)
|
)
|
||||||
AGENT_KEYS_REQUIRED: frozenset[str] = frozenset()
|
AGENT_KEYS_REQUIRED: frozenset[str] = frozenset()
|
||||||
AGENT_KEYS_OPTIONAL = frozenset({"bottle", "skills", "git-gate"})
|
AGENT_KEYS_OPTIONAL = frozenset({"bottle", "skills", "git-gate"})
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ from __future__ import annotations
|
|||||||
import json
|
import json
|
||||||
import urllib.error
|
import urllib.error
|
||||||
import urllib.request
|
import urllib.request
|
||||||
|
from collections.abc import Iterable
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
|
||||||
from ..paths import host_control_plane_token
|
from ..paths import host_control_plane_token
|
||||||
@@ -147,6 +148,20 @@ class OrchestratorClient:
|
|||||||
raise OrchestratorClientError(f"teardown {bottle_id}: HTTP {status}")
|
raise OrchestratorClientError(f"teardown {bottle_id}: HTTP {status}")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
def reconcile(
|
||||||
|
self, live_source_ips: Iterable[str], *, grace_seconds: float | None = None,
|
||||||
|
) -> list[str]:
|
||||||
|
"""Drop registry rows for bottles that are no longer running
|
||||||
|
(`POST /reconcile`), returning the reaped bottle ids. `live_source_ips`
|
||||||
|
is the caller's enumeration of its live bottles — the orchestrator
|
||||||
|
can't see the backend from inside the infra container."""
|
||||||
|
body: dict[str, object] = {"live_source_ips": list(live_source_ips)}
|
||||||
|
if grace_seconds is not None:
|
||||||
|
body["grace_seconds"] = grace_seconds
|
||||||
|
payload = self._ok("POST", "/reconcile", body)
|
||||||
|
reaped = payload.get("reaped")
|
||||||
|
return [r for r in reaped if isinstance(r, str)] if isinstance(reaped, list) else []
|
||||||
|
|
||||||
def set_policy(self, bottle_id: str, policy: str) -> bool:
|
def set_policy(self, bottle_id: str, policy: str) -> bool:
|
||||||
"""Live-reload a bottle's policy (`PUT /bottles/<id>/policy`). False on
|
"""Live-reload a bottle's policy (`PUT /bottles/<id>/policy`). False on
|
||||||
404 (unknown bottle)."""
|
404 (unknown bottle)."""
|
||||||
|
|||||||
@@ -0,0 +1,107 @@
|
|||||||
|
"""Per-host orchestrator configuration store (settings in bot-bottle.db).
|
||||||
|
|
||||||
|
Co-tenants the shared `bot-bottle.db` via the `DbStore` framework. Settings
|
||||||
|
are readable by the host launch path directly (no HTTP round-trip to the
|
||||||
|
orchestrator), so they take effect even before the orchestrator is reachable.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sqlite3
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ..db_store import DbStore
|
||||||
|
from ..migrations import TableMigrations
|
||||||
|
from ..paths import host_db_path
|
||||||
|
|
||||||
|
TEARDOWN_TIMEOUT_ENV = "BOT_BOTTLE_ORCHESTRATOR_TEARDOWN_TIMEOUT_SECONDS"
|
||||||
|
DEFAULT_TEARDOWN_TIMEOUT_SECONDS = 30.0
|
||||||
|
|
||||||
|
_MIGRATIONS = TableMigrations(
|
||||||
|
"orchestrator_config",
|
||||||
|
[
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS orchestrator_config (
|
||||||
|
id INTEGER PRIMARY KEY CHECK (id = 1),
|
||||||
|
teardown_timeout_seconds REAL
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class OrchestratorConfigStore(DbStore):
|
||||||
|
"""Orchestrator settings in the shared host DB."""
|
||||||
|
|
||||||
|
def __init__(self, db_path: Path | None = None) -> None:
|
||||||
|
super().__init__(db_path or host_db_path(), _MIGRATIONS)
|
||||||
|
|
||||||
|
def _connect(self) -> sqlite3.Connection:
|
||||||
|
conn = super()._connect()
|
||||||
|
conn.execute("PRAGMA busy_timeout=5000")
|
||||||
|
return conn
|
||||||
|
|
||||||
|
def get_teardown_timeout_seconds(self) -> float | None:
|
||||||
|
"""Return the configured teardown timeout, or None if not set."""
|
||||||
|
try:
|
||||||
|
with self._connection() as conn:
|
||||||
|
row = conn.execute(
|
||||||
|
"SELECT teardown_timeout_seconds FROM orchestrator_config WHERE id = 1"
|
||||||
|
).fetchone()
|
||||||
|
except sqlite3.OperationalError:
|
||||||
|
return None
|
||||||
|
return row["teardown_timeout_seconds"] if row else None
|
||||||
|
|
||||||
|
def set_teardown_timeout_seconds(self, value: float) -> None:
|
||||||
|
"""Persist the teardown timeout."""
|
||||||
|
with self._connection() as conn:
|
||||||
|
conn.execute(
|
||||||
|
"INSERT OR REPLACE INTO orchestrator_config"
|
||||||
|
" (id, teardown_timeout_seconds) VALUES (1, ?)",
|
||||||
|
(value,),
|
||||||
|
)
|
||||||
|
self._chmod()
|
||||||
|
|
||||||
|
def delete_teardown_timeout_seconds(self) -> bool:
|
||||||
|
"""Clear the stored teardown timeout. Returns True if a value existed."""
|
||||||
|
with self._connection() as conn:
|
||||||
|
cur = conn.execute(
|
||||||
|
"UPDATE orchestrator_config SET teardown_timeout_seconds = NULL"
|
||||||
|
" WHERE id = 1 AND teardown_timeout_seconds IS NOT NULL"
|
||||||
|
)
|
||||||
|
return cur.rowcount > 0
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_teardown_timeout(db_path: Path | None = None) -> float:
|
||||||
|
"""Return the teardown timeout to use, in priority order:
|
||||||
|
|
||||||
|
1. ``BOT_BOTTLE_ORCHESTRATOR_TEARDOWN_TIMEOUT_SECONDS`` env var
|
||||||
|
2. ``teardown_timeout_seconds`` in the orchestrator config DB
|
||||||
|
3. ``DEFAULT_TEARDOWN_TIMEOUT_SECONDS`` (30 s)
|
||||||
|
"""
|
||||||
|
raw = os.environ.get(TEARDOWN_TIMEOUT_ENV, "").strip()
|
||||||
|
if raw:
|
||||||
|
try:
|
||||||
|
value = float(raw)
|
||||||
|
if value > 0:
|
||||||
|
return value
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
store = OrchestratorConfigStore(db_path)
|
||||||
|
if not store.is_migrated():
|
||||||
|
store.migrate()
|
||||||
|
db_value = store.get_teardown_timeout_seconds()
|
||||||
|
if db_value is not None and db_value > 0:
|
||||||
|
return db_value
|
||||||
|
|
||||||
|
return DEFAULT_TEARDOWN_TIMEOUT_SECONDS
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"OrchestratorConfigStore",
|
||||||
|
"resolve_teardown_timeout",
|
||||||
|
"TEARDOWN_TIMEOUT_ENV",
|
||||||
|
"DEFAULT_TEARDOWN_TIMEOUT_SECONDS",
|
||||||
|
]
|
||||||
@@ -13,6 +13,9 @@ vsock / unix-socket portability caveats):
|
|||||||
PUT /bottles/<bottle_id>/policy -> 200 {"updated": true} | 404 (live reload)
|
PUT /bottles/<bottle_id>/policy -> 200 {"updated": true} | 404 (live reload)
|
||||||
body: {"policy"}
|
body: {"policy"}
|
||||||
DELETE /bottles/<bottle_id> -> 200 {"torn_down": true} | 404 (teardown)
|
DELETE /bottles/<bottle_id> -> 200 {"torn_down": true} | 404 (teardown)
|
||||||
|
POST /reconcile -> 200 {"reaped": [bottle_id, ...]}
|
||||||
|
body: {"live_source_ips": [...],
|
||||||
|
["grace_seconds"]}
|
||||||
POST /attribute -> 200 {"bottle_id"} | 403
|
POST /attribute -> 200 {"bottle_id"} | 403
|
||||||
POST /resolve -> 200 {"bottle_id","policy"} | 403
|
POST /resolve -> 200 {"bottle_id","policy"} | 403
|
||||||
body: {"source_ip","identity_token"}
|
body: {"source_ip","identity_token"}
|
||||||
@@ -141,6 +144,27 @@ def dispatch( # pylint: disable=too-many-return-statements,too-many-branches
|
|||||||
return 200, {"torn_down": True}
|
return 200, {"torn_down": True}
|
||||||
return 404, {"error": "no such bottle"}
|
return 404, {"error": "no such bottle"}
|
||||||
|
|
||||||
|
if method == "POST" and route == "/reconcile":
|
||||||
|
# Host-driven self-heal: the caller enumerates its live bottles (only
|
||||||
|
# the host can see the backend) and the orchestrator drops rows for
|
||||||
|
# every other active bottle. Trusted-caller only — an agent that could
|
||||||
|
# reach this would be able to unregister its neighbours.
|
||||||
|
try:
|
||||||
|
data = _parse_json_object(body)
|
||||||
|
except ValueError as e:
|
||||||
|
return 400, {"error": f"invalid JSON: {e}"}
|
||||||
|
raw_ips = data.get("live_source_ips")
|
||||||
|
if not isinstance(raw_ips, list):
|
||||||
|
return 400, {"error": "live_source_ips (list of strings) is required"}
|
||||||
|
live = [ip for ip in raw_ips if isinstance(ip, str) and ip]
|
||||||
|
grace = data.get("grace_seconds")
|
||||||
|
kwargs = (
|
||||||
|
{"grace_seconds": float(grace)}
|
||||||
|
if isinstance(grace, (int, float)) and not isinstance(grace, bool)
|
||||||
|
else {}
|
||||||
|
)
|
||||||
|
return 200, {"reaped": orch.reconcile(live, **kwargs)}
|
||||||
|
|
||||||
if method == "POST" and route == "/attribute":
|
if method == "POST" and route == "/attribute":
|
||||||
try:
|
try:
|
||||||
data = _parse_json_object(body)
|
data = _parse_json_object(body)
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ from ..paths import (
|
|||||||
CONTROL_PLANE_TOKEN_ENV,
|
CONTROL_PLANE_TOKEN_ENV,
|
||||||
host_control_plane_token,
|
host_control_plane_token,
|
||||||
host_db_path,
|
host_db_path,
|
||||||
|
host_gateway_ca_dir,
|
||||||
)
|
)
|
||||||
from ..supervise import DB_PATH_IN_CONTAINER
|
from ..supervise import DB_PATH_IN_CONTAINER
|
||||||
|
|
||||||
@@ -48,14 +49,23 @@ GATEWAY_LABEL = "bot-bottle-orch-gateway=1"
|
|||||||
# the source IP the gateway attributes by is the address on this network.
|
# the source IP the gateway attributes by is the address on this network.
|
||||||
GATEWAY_NETWORK = "bot-bottle-gateway"
|
GATEWAY_NETWORK = "bot-bottle-gateway"
|
||||||
|
|
||||||
# mitmproxy's CA dir in the bundle. A persistent named volume here keeps the
|
# mitmproxy's CA dir in the bundle. The host's gateway-CA dir (see
|
||||||
# gateway's self-generated CA STABLE across container recreation — every agent
|
# `host_gateway_ca_dir`) is bind-mounted here so the gateway's self-generated
|
||||||
# installs this one CA to trust the shared gateway's TLS interception, so it
|
# CA stays STABLE across container recreation — every agent installs this one
|
||||||
# must not rotate when the gateway restarts.
|
# CA to trust the shared gateway's TLS interception, so it must not rotate when
|
||||||
|
# the gateway restarts. A host bind-mount rather than a named volume: a named
|
||||||
|
# volume is silently wiped by `docker volume prune`, minting a fresh CA that
|
||||||
|
# breaks every running bottle (issue #450).
|
||||||
MITMPROXY_HOME = "/home/mitmproxy/.mitmproxy"
|
MITMPROXY_HOME = "/home/mitmproxy/.mitmproxy"
|
||||||
GATEWAY_CA_VOLUME = "bot-bottle-gateway-mitmproxy"
|
|
||||||
GATEWAY_CA_CERT = f"{MITMPROXY_HOME}/mitmproxy-ca-cert.pem"
|
GATEWAY_CA_CERT = f"{MITMPROXY_HOME}/mitmproxy-ca-cert.pem"
|
||||||
|
|
||||||
|
# The CA material mitmproxy writes into its confdir. mitmproxy reuses these on
|
||||||
|
# startup when present and generates them only on first run, so persisting them
|
||||||
|
# is what makes the CA stable; deleting them (see `rotate_gateway_ca`) forces a
|
||||||
|
# fresh CA on the next start. `mitmproxy-ca.pem` (cert + private key) is the
|
||||||
|
# signing identity; the rest are derived encodings agents/clients consume.
|
||||||
|
GATEWAY_CA_GLOB = "mitmproxy-ca*"
|
||||||
|
|
||||||
# The gateway data-plane image + its Dockerfile. Kept as a local constant
|
# The gateway data-plane image + its Dockerfile. Kept as a local constant
|
||||||
# rather than imported from the backend layer, which would drag
|
# rather than imported from the backend layer, which would drag
|
||||||
# the whole backend layer into the lean orchestrator (see #359); unify when
|
# the whole backend layer into the lean orchestrator (see #359); unify when
|
||||||
@@ -73,6 +83,26 @@ def _host_db_dir() -> str:
|
|||||||
return str(db_dir)
|
return str(db_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def rotate_gateway_ca(ca_dir: Path | None = None) -> list[Path]:
|
||||||
|
"""Delete the persisted mitmproxy CA so the next gateway start mints a
|
||||||
|
fresh one — the explicit, deliberate CA-rollover path (issue #450).
|
||||||
|
|
||||||
|
Persistence keeps the CA stable across restarts precisely because mitmproxy
|
||||||
|
reuses the on-disk CA; rotation is therefore just removing that material.
|
||||||
|
Returns the files removed (empty when there was no CA yet); idempotent.
|
||||||
|
|
||||||
|
This only clears the on-disk CA. It does NOT stop the running gateway (whose
|
||||||
|
mitmproxy still holds the old CA in memory) or re-provision agents — the
|
||||||
|
caller recreates the gateway to mint the new CA and re-attaches bottles.
|
||||||
|
`rotate-ca` on the orchestrator CLI wires those steps together."""
|
||||||
|
ca_dir = ca_dir if ca_dir is not None else host_gateway_ca_dir()
|
||||||
|
removed: list[Path] = []
|
||||||
|
for path in sorted(ca_dir.glob(GATEWAY_CA_GLOB)):
|
||||||
|
path.unlink()
|
||||||
|
removed.append(path)
|
||||||
|
return removed
|
||||||
|
|
||||||
|
|
||||||
class GatewayError(Exception):
|
class GatewayError(Exception):
|
||||||
"""The shared gateway failed to build/start/stop (non-zero `docker` exit)."""
|
"""The shared gateway failed to build/start/stop (non-zero `docker` exit)."""
|
||||||
|
|
||||||
@@ -221,9 +251,10 @@ class DockerGateway(Gateway):
|
|||||||
"--name", self.name,
|
"--name", self.name,
|
||||||
"--label", GATEWAY_LABEL,
|
"--label", GATEWAY_LABEL,
|
||||||
"--network", self.network,
|
"--network", self.network,
|
||||||
# Persist the self-generated CA so it survives restarts (agents
|
# Persist the self-generated CA on the host so it survives both
|
||||||
# trust it) — see GATEWAY_CA_VOLUME.
|
# container recreation AND docker volume pruning (agents trust it)
|
||||||
"--volume", f"{GATEWAY_CA_VOLUME}:{MITMPROXY_HOME}",
|
# — see host_gateway_ca_dir / issue #450.
|
||||||
|
"--volume", f"{host_gateway_ca_dir()}:{MITMPROXY_HOME}",
|
||||||
# Share the one host DB: the supervise daemon queues proposals
|
# Share the one host DB: the supervise daemon queues proposals
|
||||||
# into the same file the orchestrator (and the operator, over
|
# into the same file the orchestrator (and the operator, over
|
||||||
# HTTP) reads — no second, disconnected DB in the container.
|
# HTTP) reads — no second, disconnected DB in the container.
|
||||||
@@ -272,7 +303,7 @@ class DockerGateway(Gateway):
|
|||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"Gateway", "DockerGateway", "GatewayError",
|
"Gateway", "DockerGateway", "GatewayError", "rotate_gateway_ca",
|
||||||
"GATEWAY_NAME", "GATEWAY_LABEL", "GATEWAY_IMAGE", "GATEWAY_NETWORK",
|
"GATEWAY_NAME", "GATEWAY_LABEL", "GATEWAY_IMAGE", "GATEWAY_NETWORK",
|
||||||
"GATEWAY_CA_VOLUME", "GATEWAY_CA_CERT",
|
"GATEWAY_CA_CERT", "GATEWAY_CA_GLOB",
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,17 +1,15 @@
|
|||||||
"""Orchestrator + gateway lifecycle (PRD 0070, docker slice).
|
"""Orchestrator + gateway lifecycle (PRD 0070, docker slice).
|
||||||
|
|
||||||
Runs the orchestrator control plane **as a container** on the shared gateway
|
Runs both the orchestrator control plane and the gateway data plane inside
|
||||||
network, alongside the gateway container. This is the PRD's "virtualize the
|
a single `bot-bottle-infra` container on the shared gateway network —
|
||||||
orchestrator": container↔container between the gateway and the orchestrator
|
matching the structure already used by the macOS and Firecracker backends.
|
||||||
avoids the host firewall (which drops container→host traffic), and the gateway
|
`gateway_init` is PID 1 and supervises both; the infra container is an
|
||||||
reaches the control plane by container name over docker DNS. The host CLI
|
idempotent per-host singleton.
|
||||||
reaches it via a published loopback port.
|
|
||||||
|
|
||||||
The orchestrator runs with the **register-only broker** — the *backend*
|
The combined container replaces the prior two-container split
|
||||||
launches agent containers (compose), so the orchestrator needs no docker
|
(bot-bottle-orchestrator + bot-bottle-orch-gateway). The host CLI reaches
|
||||||
socket. That keeps this control-plane container unprivileged; the host manages
|
the control plane via a published loopback port; gateway daemons reach it
|
||||||
both containers. `ensure_running` is an idempotent singleton (fixed container
|
over 127.0.0.1 (same container).
|
||||||
names + the published port).
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -25,50 +23,75 @@ from pathlib import Path
|
|||||||
|
|
||||||
from .. import log
|
from .. import log
|
||||||
from ..docker_cmd import run_docker
|
from ..docker_cmd import run_docker
|
||||||
from ..paths import CONTROL_PLANE_TOKEN_ENV, bot_bottle_root, host_control_plane_token
|
from ..paths import (
|
||||||
from .gateway import GATEWAY_IMAGE, GATEWAY_NAME, GATEWAY_NETWORK, DockerGateway, GatewayError
|
CONTROL_PLANE_TOKEN_ENV,
|
||||||
|
bot_bottle_root,
|
||||||
|
host_control_plane_token,
|
||||||
|
host_gateway_ca_dir,
|
||||||
|
)
|
||||||
|
from ..supervise import DB_PATH_IN_CONTAINER
|
||||||
|
from .gateway import (
|
||||||
|
GATEWAY_DOCKERFILE,
|
||||||
|
GATEWAY_IMAGE,
|
||||||
|
GATEWAY_NETWORK,
|
||||||
|
GatewayError,
|
||||||
|
MITMPROXY_HOME,
|
||||||
|
_host_db_dir,
|
||||||
|
)
|
||||||
|
|
||||||
DEFAULT_PORT = 8099
|
DEFAULT_PORT = 8099
|
||||||
ORCHESTRATOR_NAME = "bot-bottle-orchestrator"
|
DEFAULT_STARTUP_TIMEOUT_SECONDS = 45.0
|
||||||
ORCHESTRATOR_LABEL = "bot-bottle-orchestrator=1"
|
|
||||||
# The control-plane's own runtime image — lean (python + the stdlib-only
|
INFRA_NAME = "bot-bottle-infra"
|
||||||
# `bot_bottle` package, bind-mounted at run time), distinct from the heavy
|
INFRA_LABEL = "bot-bottle-infra=1"
|
||||||
# gateway data-plane image it used to borrow (#384). Env override for
|
# The combined infra image: gateway data plane + orchestrator content.
|
||||||
# operators pinning a published build.
|
# Built from Dockerfile.infra (FROM gateway + COPY --from orchestrator).
|
||||||
|
INFRA_IMAGE = os.environ.get("BOT_BOTTLE_INFRA_IMAGE", "bot-bottle-infra:latest")
|
||||||
|
INFRA_DOCKERFILE = "Dockerfile.infra"
|
||||||
|
# Baked as a container label so `ensure_running` can detect whether the
|
||||||
|
# running container is executing the current bind-mounted source.
|
||||||
|
INFRA_SOURCE_HASH_LABEL = "bot-bottle-infra-source-hash"
|
||||||
|
|
||||||
|
# Orchestrator image: the single canonical definition of the control-plane
|
||||||
|
# content (lean: python:3.12-slim + bot_bottle package, no mitmproxy/git).
|
||||||
|
# Used as a build intermediate: `Dockerfile.infra` COPY --from this image.
|
||||||
ORCHESTRATOR_IMAGE = os.environ.get(
|
ORCHESTRATOR_IMAGE = os.environ.get(
|
||||||
"BOT_BOTTLE_ORCHESTRATOR_IMAGE", "bot-bottle-orchestrator:latest"
|
"BOT_BOTTLE_ORCHESTRATOR_IMAGE", "bot-bottle-orchestrator:latest"
|
||||||
)
|
)
|
||||||
ORCHESTRATOR_DOCKERFILE = "Dockerfile.orchestrator"
|
ORCHESTRATOR_DOCKERFILE = "Dockerfile.orchestrator"
|
||||||
# Baked onto the container as a label so `ensure_running` can tell whether the
|
|
||||||
# running process is executing the *current* bind-mounted source — see
|
|
||||||
# `source_hash`.
|
|
||||||
ORCHESTRATOR_SOURCE_HASH_LABEL = "bot-bottle-orchestrator-source-hash"
|
|
||||||
|
|
||||||
# The repo root is bind-mounted into the control-plane container so
|
# The gateway daemons + orchestrator the infra container runs.
|
||||||
# `python -m bot_bottle.orchestrator` resolves the package (the orchestrator
|
# BOT_BOTTLE_GATEWAY_DAEMONS listing `orchestrator` opts it in to
|
||||||
# is stdlib-only, so the lean orchestrator image's python is enough).
|
# gateway_init's supervise tree (see gateway_init._OPT_IN_DAEMONS).
|
||||||
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
_INFRA_DAEMONS = "egress,git-http,supervise,orchestrator"
|
||||||
_APP_DIR = "/app"
|
|
||||||
|
# The bind-mount path for the live control-plane source inside the
|
||||||
|
# container. Separate from /app so the gateway's baked scripts
|
||||||
|
# (egress_addon.py, egress-entrypoint.sh) are not overlaid.
|
||||||
|
_SRC_IN_CONTAINER = "/bot-bottle-src"
|
||||||
|
# Bot-bottle host-root bind-mount inside the container (DB + state).
|
||||||
_ROOT_IN_CONTAINER = "/bot-bottle-root"
|
_ROOT_IN_CONTAINER = "/bot-bottle-root"
|
||||||
|
|
||||||
|
# The supervise daemon writes proposals into the host DB directory.
|
||||||
|
_SUPERVISE_DB_DIR_IN_CONTAINER = os.path.dirname(DB_PATH_IN_CONTAINER)
|
||||||
|
|
||||||
_HEALTH_POLL_SECONDS = 0.25
|
_HEALTH_POLL_SECONDS = 0.25
|
||||||
DEFAULT_STARTUP_TIMEOUT_SECONDS = 45.0
|
|
||||||
_HEALTH_REQUEST_TIMEOUT_SECONDS = 1.0
|
_HEALTH_REQUEST_TIMEOUT_SECONDS = 1.0
|
||||||
|
|
||||||
|
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
|
||||||
|
|
||||||
class OrchestratorStartError(RuntimeError):
|
class OrchestratorStartError(RuntimeError):
|
||||||
"""The orchestrator container did not become healthy within the timeout."""
|
"""The infra container did not become healthy within the timeout."""
|
||||||
|
|
||||||
|
|
||||||
def source_hash(repo_root: Path) -> str:
|
def source_hash(repo_root: Path) -> str:
|
||||||
"""Content hash of the orchestrator's bind-mounted Python source (the
|
"""Content hash of the orchestrator's bind-mounted Python source (the
|
||||||
`bot_bottle` package the control-plane process imports). This only
|
`bot_bottle` package the control-plane process imports). Changes only
|
||||||
changes when the code that would actually run inside the container
|
when the code that would actually run changes — `ensure_running`
|
||||||
changes — `ensure_running` recreates the container on a mismatch and
|
recreates the container on a mismatch so a code change takes effect,
|
||||||
otherwise leaves a healthy one alone, so a bottle launch that isn't
|
but leaves a healthy up-to-date container alone to preserve in-memory
|
||||||
accompanied by a code change doesn't restart the process and drop every
|
egress tokens."""
|
||||||
*other* active bottle's in-memory egress tokens (`Orchestrator._tokens`
|
|
||||||
in `service.py`, never persisted to disk by design)."""
|
|
||||||
h = hashlib.sha256()
|
h = hashlib.sha256()
|
||||||
for path in sorted((repo_root / "bot_bottle").rglob("*.py")):
|
for path in sorted((repo_root / "bot_bottle").rglob("*.py")):
|
||||||
h.update(str(path.relative_to(repo_root)).encode())
|
h.update(str(path.relative_to(repo_root)).encode())
|
||||||
@@ -77,57 +100,37 @@ def source_hash(repo_root: Path) -> str:
|
|||||||
|
|
||||||
|
|
||||||
class OrchestratorService:
|
class OrchestratorService:
|
||||||
"""Manages the orchestrator control-plane container + the shared gateway.
|
"""Manages the single per-host infra container (control plane + gateway).
|
||||||
Callers only need `ensure_running()` + `url`.
|
Callers only need `ensure_running()` + `url`.
|
||||||
|
|
||||||
`orchestrator_name` / `orchestrator_label` let backends run independent
|
`infra_name` / `infra_label` let backends run independent infra containers
|
||||||
orchestrators on the same host without name collisions (e.g. the
|
on the same host without name collisions (e.g. isolated integration tests
|
||||||
Firecracker backend uses `bot-bottle-fc-orchestrator` alongside the Docker
|
that can't share the production INFRA_NAME singleton)."""
|
||||||
backend's `bot-bottle-orchestrator`); `gateway_name` gives the paired
|
|
||||||
gateway container the same treatment (e.g. isolated integration tests
|
|
||||||
that can't share the production `GATEWAY_NAME` singleton). Subclass and
|
|
||||||
override `_gateway()` for anything `_gateway_image`/`gateway_name` can't
|
|
||||||
express (a genuinely backend-specific gateway variant)."""
|
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
*,
|
*,
|
||||||
port: int = DEFAULT_PORT,
|
port: int = DEFAULT_PORT,
|
||||||
network: str = GATEWAY_NETWORK,
|
network: str = GATEWAY_NETWORK,
|
||||||
image: str = ORCHESTRATOR_IMAGE,
|
image: str = INFRA_IMAGE,
|
||||||
gateway_image: str = GATEWAY_IMAGE,
|
|
||||||
gateway_name: str = GATEWAY_NAME,
|
|
||||||
repo_root: Path = _REPO_ROOT,
|
repo_root: Path = _REPO_ROOT,
|
||||||
host_root: Path | None = None,
|
host_root: Path | None = None,
|
||||||
orchestrator_name: str = ORCHESTRATOR_NAME,
|
infra_name: str = INFRA_NAME,
|
||||||
orchestrator_label: str = ORCHESTRATOR_LABEL,
|
infra_label: str = INFRA_LABEL,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.port = port
|
self.port = port
|
||||||
self.network = network
|
self.network = network
|
||||||
# Two distinct images (#384): `image` is the lean control-plane
|
|
||||||
# runtime this container runs; `_gateway_image` is the heavy egress /
|
|
||||||
# git-gate / supervise data plane the gateway container runs. They
|
|
||||||
# were one conflated image before the split.
|
|
||||||
self.image = image
|
self.image = image
|
||||||
self._gateway_image = gateway_image
|
|
||||||
self._gateway_name = gateway_name
|
|
||||||
self._repo_root = repo_root
|
self._repo_root = repo_root
|
||||||
self._host_root = host_root or bot_bottle_root()
|
self._host_root = host_root or bot_bottle_root()
|
||||||
self._orchestrator_name = orchestrator_name
|
self._infra_name = infra_name
|
||||||
self._orchestrator_label = orchestrator_label
|
self._infra_label = infra_label
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def url(self) -> str:
|
def url(self) -> str:
|
||||||
"""Host-side control-plane URL (published loopback port)."""
|
"""Host-side control-plane URL (published loopback port)."""
|
||||||
return f"http://127.0.0.1:{self.port}"
|
return f"http://127.0.0.1:{self.port}"
|
||||||
|
|
||||||
@property
|
|
||||||
def internal_url(self) -> str:
|
|
||||||
"""Control-plane URL as the gateway container reaches it — by name over
|
|
||||||
docker DNS on the shared network. This is the gateway's
|
|
||||||
BOT_BOTTLE_ORCHESTRATOR_URL."""
|
|
||||||
return f"http://{self._orchestrator_name}:{self.port}"
|
|
||||||
|
|
||||||
def is_healthy(self, *, timeout: float = _HEALTH_REQUEST_TIMEOUT_SECONDS) -> bool:
|
def is_healthy(self, *, timeout: float = _HEALTH_REQUEST_TIMEOUT_SECONDS) -> bool:
|
||||||
try:
|
try:
|
||||||
with urllib.request.urlopen(f"{self.url}/health", timeout=timeout) as resp:
|
with urllib.request.urlopen(f"{self.url}/health", timeout=timeout) as resp:
|
||||||
@@ -139,139 +142,131 @@ class OrchestratorService:
|
|||||||
proc = run_docker(["docker", "ps", "--filter", f"name=^/{name}$", "--format", "{{.Names}}"])
|
proc = run_docker(["docker", "ps", "--filter", f"name=^/{name}$", "--format", "{{.Names}}"])
|
||||||
return name in proc.stdout.split()
|
return name in proc.stdout.split()
|
||||||
|
|
||||||
def _run_orchestrator_container(self, current_hash: str) -> None:
|
def _infra_source_current(self, current_hash: str) -> bool:
|
||||||
"""Start the control-plane container (idempotent: clears a stale
|
"""True iff the running infra container was started from the current
|
||||||
fixed-name container first). Register-only broker → no docker socket.
|
bind-mounted source. Mirrors the macOS backend's `_source_current`."""
|
||||||
Labels the container with `current_hash` so a later `ensure_running`
|
if not self._container_running(self._infra_name):
|
||||||
can detect a real code change (see `source_hash`)."""
|
|
||||||
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
|
||||||
proc = run_docker([
|
|
||||||
"docker", "run", "--detach",
|
|
||||||
"--name", self._orchestrator_name,
|
|
||||||
"--label", self._orchestrator_label,
|
|
||||||
"--label", f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={current_hash}",
|
|
||||||
"--network", self.network,
|
|
||||||
# Host CLI reaches the control plane here; bound to loopback so it
|
|
||||||
# is not exposed on the host's external interfaces. NOTE: the
|
|
||||||
# container is still on `self.network` (the shared gateway network),
|
|
||||||
# so agents can reach it by container IP — which is exactly why the
|
|
||||||
# control plane requires the secret below rather than trusting the
|
|
||||||
# network boundary.
|
|
||||||
"--publish", f"127.0.0.1:{self.port}:{self.port}",
|
|
||||||
"--volume", f"{self._repo_root}:{_APP_DIR}:ro",
|
|
||||||
"--workdir", _APP_DIR,
|
|
||||||
# Persist the registry DB on the host (sole-owner: only the
|
|
||||||
# orchestrator opens bot-bottle.db).
|
|
||||||
"--volume", f"{self._host_root}:{_ROOT_IN_CONTAINER}",
|
|
||||||
"--env", f"BOT_BOTTLE_ROOT={_ROOT_IN_CONTAINER}",
|
|
||||||
# The control-plane secret it requires on every route but /health.
|
|
||||||
# Bare `--env NAME` → docker inherits the value from the run env
|
|
||||||
# below, so the secret never lands on argv / `docker inspect`.
|
|
||||||
"--env", CONTROL_PLANE_TOKEN_ENV,
|
|
||||||
"--entrypoint", "python3",
|
|
||||||
self.image,
|
|
||||||
"-m", "bot_bottle.orchestrator",
|
|
||||||
"--host", "0.0.0.0", "--port", str(self.port), "--broker", "stub",
|
|
||||||
], env={**os.environ, CONTROL_PLANE_TOKEN_ENV: host_control_plane_token()})
|
|
||||||
if proc.returncode != 0:
|
|
||||||
raise OrchestratorStartError(
|
|
||||||
f"orchestrator container failed to start: {proc.stderr.strip()}"
|
|
||||||
)
|
|
||||||
|
|
||||||
def _gateway(self) -> DockerGateway:
|
|
||||||
return DockerGateway(
|
|
||||||
self._gateway_image,
|
|
||||||
name=self._gateway_name,
|
|
||||||
network=self.network,
|
|
||||||
orchestrator_url=self.internal_url,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _ensure_orchestrator_image(self) -> None:
|
|
||||||
"""Build the lean control-plane image from `Dockerfile.orchestrator`
|
|
||||||
when it's missing (#384). Cheap — a `FROM python:*-slim` base with no
|
|
||||||
deps to install, so the layer cache makes rebuilds a no-op. Unlike the
|
|
||||||
gateway image this is build-if-missing, not build-every-time: the
|
|
||||||
control plane bind-mounts its source, so a code change is caught by the
|
|
||||||
source-hash recreate (below), not by an image rebuild."""
|
|
||||||
if run_docker(["docker", "image", "inspect", self.image]).returncode == 0:
|
|
||||||
return
|
|
||||||
argv = ["docker", "build", "-t", self.image,
|
|
||||||
"-f", str(self._repo_root / ORCHESTRATOR_DOCKERFILE),
|
|
||||||
str(self._repo_root)]
|
|
||||||
if os.environ.get("BOT_BOTTLE_NO_CACHE"):
|
|
||||||
argv.insert(2, "--no-cache")
|
|
||||||
proc = run_docker(argv)
|
|
||||||
if proc.returncode != 0:
|
|
||||||
raise GatewayError(
|
|
||||||
f"orchestrator image build failed: {proc.stderr.strip()}"
|
|
||||||
)
|
|
||||||
|
|
||||||
def _orchestrator_source_current(self, current_hash: str) -> bool:
|
|
||||||
"""True iff the running orchestrator container was created from the
|
|
||||||
*current* bind-mounted source. Mirrors `DockerGateway`'s
|
|
||||||
image-staleness check, but by content hash rather than image id since
|
|
||||||
the orchestrator runs bind-mounted source, not a built image."""
|
|
||||||
if not self._container_running(self._orchestrator_name):
|
|
||||||
return False
|
return False
|
||||||
proc = run_docker([
|
proc = run_docker([
|
||||||
"docker", "inspect", "--format",
|
"docker", "inspect", "--format",
|
||||||
"{{ index .Config.Labels \"" + ORCHESTRATOR_SOURCE_HASH_LABEL + "\" }}",
|
"{{ index .Config.Labels \"" + INFRA_SOURCE_HASH_LABEL + "\" }}",
|
||||||
self._orchestrator_name,
|
self._infra_name,
|
||||||
])
|
])
|
||||||
if proc.returncode != 0:
|
if proc.returncode != 0:
|
||||||
return True # can't compare -> don't churn a working container
|
return True # can't compare → don't churn a working container
|
||||||
return proc.stdout.strip() == current_hash
|
return proc.stdout.strip() == current_hash
|
||||||
|
|
||||||
|
def _ensure_network(self) -> None:
|
||||||
|
if run_docker(["docker", "network", "inspect", self.network]).returncode == 0:
|
||||||
|
return
|
||||||
|
proc = run_docker(["docker", "network", "create", self.network])
|
||||||
|
if proc.returncode != 0 and "already exists" not in proc.stderr:
|
||||||
|
raise GatewayError(
|
||||||
|
f"gateway network {self.network} failed to create: {proc.stderr.strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _build_images(self) -> None:
|
||||||
|
"""Build the gateway base, the orchestrator intermediate, then the
|
||||||
|
infra image. All are cache-aware: a no-op when nothing changed."""
|
||||||
|
for tag, dockerfile in (
|
||||||
|
(GATEWAY_IMAGE, GATEWAY_DOCKERFILE),
|
||||||
|
(ORCHESTRATOR_IMAGE, ORCHESTRATOR_DOCKERFILE),
|
||||||
|
(self.image, INFRA_DOCKERFILE),
|
||||||
|
):
|
||||||
|
argv = ["docker", "build", "-t", tag,
|
||||||
|
"-f", str(self._repo_root / dockerfile),
|
||||||
|
str(self._repo_root)]
|
||||||
|
if os.environ.get("BOT_BOTTLE_NO_CACHE"):
|
||||||
|
argv.insert(2, "--no-cache")
|
||||||
|
proc = run_docker(argv)
|
||||||
|
if proc.returncode != 0:
|
||||||
|
raise GatewayError(f"{dockerfile} build failed: {proc.stderr.strip()}")
|
||||||
|
|
||||||
|
def _run_infra_container(self, current_hash: str) -> None:
|
||||||
|
"""Start the combined infra container (idempotent: clears a stale
|
||||||
|
fixed-name container first). Labels the container with `current_hash`
|
||||||
|
so a later `ensure_running` can detect a real code change."""
|
||||||
|
self._ensure_network()
|
||||||
|
run_docker(["docker", "rm", "--force", self._infra_name])
|
||||||
|
proc = run_docker([
|
||||||
|
"docker", "run", "--detach",
|
||||||
|
"--name", self._infra_name,
|
||||||
|
"--label", self._infra_label,
|
||||||
|
"--label", f"{INFRA_SOURCE_HASH_LABEL}={current_hash}",
|
||||||
|
"--network", self.network,
|
||||||
|
# Host CLI reaches the control plane here (loopback only).
|
||||||
|
# gateway_init always starts the orchestrator on DEFAULT_PORT (8099)
|
||||||
|
# inside the container; self.port is the host-side published port.
|
||||||
|
"--publish", f"127.0.0.1:{self.port}:{DEFAULT_PORT}",
|
||||||
|
# Persist the mitmproxy CA on the host so it survives container
|
||||||
|
# recreation AND docker volume pruning (issue #450): every agent
|
||||||
|
# trusts this one CA, so a fresh one would break all running bottles.
|
||||||
|
"--volume", f"{host_gateway_ca_dir()}:{MITMPROXY_HOME}",
|
||||||
|
# Shared supervise DB (same file the operator reads over HTTP).
|
||||||
|
"--volume", f"{_host_db_dir()}:{_SUPERVISE_DB_DIR_IN_CONTAINER}",
|
||||||
|
"--env", f"SUPERVISE_DB_PATH={DB_PATH_IN_CONTAINER}",
|
||||||
|
# Live control-plane source, mounted to a path that does not
|
||||||
|
# overlay the gateway's baked /app scripts.
|
||||||
|
"--volume", f"{self._repo_root}:{_SRC_IN_CONTAINER}:ro",
|
||||||
|
# PYTHONPATH lets the orchestrator (and other Python daemons)
|
||||||
|
# import the live source ahead of the installed package.
|
||||||
|
"--env", f"PYTHONPATH={_SRC_IN_CONTAINER}",
|
||||||
|
# Orchestrator registry DB on the host (sole writer: control plane).
|
||||||
|
"--volume", f"{self._host_root}:{_ROOT_IN_CONTAINER}",
|
||||||
|
"--env", f"BOT_BOTTLE_ROOT={_ROOT_IN_CONTAINER}",
|
||||||
|
# Control-plane secret: required by the orchestrator (to enforce)
|
||||||
|
# and by the gateway daemons (to present on /resolve calls).
|
||||||
|
"--env", CONTROL_PLANE_TOKEN_ENV,
|
||||||
|
# Gateway daemons reach the orchestrator over loopback at its
|
||||||
|
# fixed internal port (DEFAULT_PORT), independent of self.port.
|
||||||
|
"--env", f"BOT_BOTTLE_ORCHESTRATOR_URL=http://127.0.0.1:{DEFAULT_PORT}",
|
||||||
|
# Opt the orchestrator into gateway_init's supervise tree.
|
||||||
|
"--env", f"BOT_BOTTLE_GATEWAY_DAEMONS={_INFRA_DAEMONS}",
|
||||||
|
self.image,
|
||||||
|
], env={**os.environ, CONTROL_PLANE_TOKEN_ENV: host_control_plane_token()})
|
||||||
|
if proc.returncode != 0:
|
||||||
|
raise OrchestratorStartError(
|
||||||
|
f"infra container failed to start: {proc.stderr.strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
def ensure_running(
|
def ensure_running(
|
||||||
self, *, startup_timeout: float = DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
self, *, startup_timeout: float = DEFAULT_STARTUP_TIMEOUT_SECONDS,
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Ensure the control plane + shared gateway are up; return the host
|
"""Ensure the infra container (control plane + gateway) is up; return
|
||||||
control-plane URL. Idempotent — a healthy control plane running
|
the host control-plane URL. Idempotent — a healthy container on current
|
||||||
current code and a running gateway are left untouched. Raises
|
source is left untouched. Raises `OrchestratorStartError` on timeout."""
|
||||||
`OrchestratorStartError` on timeout."""
|
self._build_images()
|
||||||
gateway = self._gateway()
|
|
||||||
gateway.ensure_built() # rebuild the bundle image on a source change
|
|
||||||
gateway.ensure_running() # creates the shared network + (re)starts gateway
|
|
||||||
|
|
||||||
# Recreate the orchestrator container only when its bind-mounted
|
|
||||||
# source has actually changed since it started — its Python process
|
|
||||||
# loaded that code at startup and won't reload, so a stale container
|
|
||||||
# would keep running OLD control-plane code. Recreating on *every*
|
|
||||||
# launch (the prior behaviour) would drop every other active
|
|
||||||
# bottle's in-memory egress tokens each time a new bottle starts,
|
|
||||||
# since the orchestrator process holds them only in memory (#381).
|
|
||||||
current_hash = source_hash(self._repo_root)
|
current_hash = source_hash(self._repo_root)
|
||||||
if self.is_healthy() and self._orchestrator_source_current(current_hash):
|
if self.is_healthy() and self._infra_source_current(current_hash):
|
||||||
return self.url
|
return self.url
|
||||||
|
|
||||||
self._ensure_orchestrator_image()
|
log.info("starting infra container", context={"name": self._infra_name})
|
||||||
log.info(
|
self._run_infra_container(current_hash)
|
||||||
"starting orchestrator container",
|
|
||||||
context={"name": self._orchestrator_name},
|
|
||||||
)
|
|
||||||
self._run_orchestrator_container(current_hash)
|
|
||||||
|
|
||||||
deadline = time.monotonic() + startup_timeout
|
deadline = time.monotonic() + startup_timeout
|
||||||
while time.monotonic() < deadline:
|
while time.monotonic() < deadline:
|
||||||
if self.is_healthy():
|
if self.is_healthy():
|
||||||
log.info("orchestrator healthy", context={"url": self.url})
|
log.info("infra container healthy", context={"url": self.url})
|
||||||
return self.url
|
return self.url
|
||||||
time.sleep(_HEALTH_POLL_SECONDS)
|
time.sleep(_HEALTH_POLL_SECONDS)
|
||||||
raise OrchestratorStartError(
|
raise OrchestratorStartError(
|
||||||
f"orchestrator at {self.url} did not become healthy within {startup_timeout:g}s"
|
f"infra container at {self.url} did not become healthy within {startup_timeout:g}s"
|
||||||
)
|
)
|
||||||
|
|
||||||
def stop(self) -> None:
|
def stop(self) -> None:
|
||||||
"""Remove the orchestrator + gateway containers (idempotent)."""
|
"""Remove the infra container (idempotent)."""
|
||||||
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
run_docker(["docker", "rm", "--force", self._infra_name])
|
||||||
self._gateway().stop()
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"OrchestratorService",
|
"OrchestratorService",
|
||||||
"OrchestratorStartError",
|
"OrchestratorStartError",
|
||||||
"ORCHESTRATOR_NAME",
|
"INFRA_NAME",
|
||||||
|
"INFRA_IMAGE",
|
||||||
|
"INFRA_SOURCE_HASH_LABEL",
|
||||||
"ORCHESTRATOR_IMAGE",
|
"ORCHESTRATOR_IMAGE",
|
||||||
"DEFAULT_PORT",
|
"DEFAULT_PORT",
|
||||||
"DEFAULT_STARTUP_TIMEOUT_SECONDS",
|
"DEFAULT_STARTUP_TIMEOUT_SECONDS",
|
||||||
|
"source_hash",
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -32,6 +32,7 @@ import hmac
|
|||||||
import secrets
|
import secrets
|
||||||
import sqlite3
|
import sqlite3
|
||||||
import time
|
import time
|
||||||
|
from collections.abc import Iterable
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
@@ -42,6 +43,12 @@ from ..paths import host_db_path
|
|||||||
# 256 bits of urandom, URL-safe — unguessable per-bottle identity token.
|
# 256 bits of urandom, URL-safe — unguessable per-bottle identity token.
|
||||||
IDENTITY_TOKEN_BYTES = 32
|
IDENTITY_TOKEN_BYTES = 32
|
||||||
|
|
||||||
|
# How recently a row must have been registered to be exempt from
|
||||||
|
# `reap_absent`. Covers the window between `container run` and the address
|
||||||
|
# becoming visible to another launch's enumeration, so reconciliation never
|
||||||
|
# reaps a bottle that is still coming up.
|
||||||
|
DEFAULT_REAP_GRACE_SECONDS = 120.0
|
||||||
|
|
||||||
|
|
||||||
def new_identity_token() -> str:
|
def new_identity_token() -> str:
|
||||||
"""A fresh per-bottle identity token (PRD 0070 attribution defence)."""
|
"""A fresh per-bottle identity token (PRD 0070 attribution defence)."""
|
||||||
@@ -225,6 +232,70 @@ class RegistryStore(DbStore):
|
|||||||
).fetchall()
|
).fetchall()
|
||||||
return [_row_to_record(r) for r in rows]
|
return [_row_to_record(r) for r in rows]
|
||||||
|
|
||||||
|
def reap_absent(
|
||||||
|
self,
|
||||||
|
live_source_ips: Iterable[str],
|
||||||
|
*,
|
||||||
|
grace_seconds: float = DEFAULT_REAP_GRACE_SECONDS,
|
||||||
|
now: float | None = None,
|
||||||
|
) -> list[BottleRecord]:
|
||||||
|
"""Delete active rows whose source IP is not held by a live bottle.
|
||||||
|
|
||||||
|
A row only ever leaves the registry two ways: an explicit
|
||||||
|
`teardown_bottle` (the launcher's cleanup callback) or the supersede
|
||||||
|
sweep in `register`. Neither runs when the launching CLI dies hard —
|
||||||
|
SIGKILL, a closed terminal, a host sleep/crash — so the row outlives
|
||||||
|
its container. That orphan is not inert: source IPs are recycled by
|
||||||
|
the backend's DHCP, and `by_source_ip` fail-closes on ambiguity, so a
|
||||||
|
leftover row at a reused address can brick the *next* bottle that
|
||||||
|
lands on it (no policy resolved -> every host denied, reported to the
|
||||||
|
agent as "not in the allowlist"). Reconciling against the live set at
|
||||||
|
launch keeps the registry from accumulating those landmines.
|
||||||
|
|
||||||
|
Restores the invariant the data plane needs: **at most one active row
|
||||||
|
per live address, and none at all for a dead one.** Two cases, because
|
||||||
|
a dead bottle's address may already have been handed to a live one:
|
||||||
|
|
||||||
|
* no live bottle holds the address — every row there is an orphan;
|
||||||
|
* a live bottle holds it but several rows claim it — the newest
|
||||||
|
registration is authoritative and the rest are orphans, the same
|
||||||
|
rule `register`'s same-IP supersede sweep applies. Without this
|
||||||
|
second case a recycled address stays ambiguous, which is exactly
|
||||||
|
the state that resolves no policy.
|
||||||
|
|
||||||
|
`grace_seconds` protects an in-flight launch: registration happens
|
||||||
|
moments after `container run`, and a concurrent launch's address may
|
||||||
|
not be visible to the caller's enumeration yet. Rows younger than the
|
||||||
|
grace window are never reaped, so reconciliation can't race a bottle
|
||||||
|
that is still coming up. Returns the deleted records."""
|
||||||
|
live = {ip for ip in live_source_ips if ip}
|
||||||
|
cutoff = (time.time() if now is None else now) - grace_seconds
|
||||||
|
with self._connection() as conn:
|
||||||
|
rows = conn.execute(
|
||||||
|
"SELECT * FROM orchestrator_bottles WHERE state = 'active'",
|
||||||
|
).fetchall()
|
||||||
|
by_ip: dict[str, list[BottleRecord]] = {}
|
||||||
|
for row in rows:
|
||||||
|
rec = _row_to_record(row)
|
||||||
|
by_ip.setdefault(rec.source_ip, []).append(rec)
|
||||||
|
candidates: list[BottleRecord] = []
|
||||||
|
for ip, recs in by_ip.items():
|
||||||
|
if ip not in live:
|
||||||
|
candidates.extend(recs)
|
||||||
|
continue
|
||||||
|
# Keep the newest claim on a live address; supersede the rest.
|
||||||
|
recs.sort(key=lambda r: r.created_at)
|
||||||
|
candidates.extend(recs[:-1])
|
||||||
|
doomed = [r for r in candidates if r.created_at <= cutoff]
|
||||||
|
for rec in doomed:
|
||||||
|
conn.execute(
|
||||||
|
"DELETE FROM orchestrator_bottles WHERE bottle_id = ?",
|
||||||
|
(rec.bottle_id,),
|
||||||
|
)
|
||||||
|
if doomed:
|
||||||
|
self._chmod()
|
||||||
|
return doomed
|
||||||
|
|
||||||
def by_source_ip(self, source_ip: str) -> BottleRecord | None:
|
def by_source_ip(self, source_ip: str) -> BottleRecord | None:
|
||||||
"""Network-layer attribution: the single active bottle at this source
|
"""Network-layer attribution: the single active bottle at this source
|
||||||
IP, or None if unknown or ambiguous (more than one — a
|
IP, or None if unknown or ambiguous (more than one — a
|
||||||
@@ -262,4 +333,5 @@ __all__ = [
|
|||||||
"new_identity_token",
|
"new_identity_token",
|
||||||
"default_db_path",
|
"default_db_path",
|
||||||
"IDENTITY_TOKEN_BYTES",
|
"IDENTITY_TOKEN_BYTES",
|
||||||
|
"DEFAULT_REAP_GRACE_SECONDS",
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
"""Rotate the shared gateway's mitmproxy CA (issue #450).
|
||||||
|
|
||||||
|
python -m bot_bottle.orchestrator.rotate_ca
|
||||||
|
|
||||||
|
A deliberate CA rollover has two halves: drop the *persisted* CA so a fresh one
|
||||||
|
is minted, and drop the *running* gateway so its mitmproxy (which holds the old
|
||||||
|
CA in memory) is replaced. This one-shot command does both:
|
||||||
|
|
||||||
|
1. Delete the persisted CA under the host gateway-CA dir — the next gateway
|
||||||
|
start generates a new one (mitmproxy reuses an existing CA, generates only
|
||||||
|
when absent).
|
||||||
|
2. Force-remove the infra / standalone-gateway containers so the stale
|
||||||
|
in-memory CA is gone; the next bottle launch's idempotent `ensure_running`
|
||||||
|
brings the gateway back up and mints the fresh CA.
|
||||||
|
|
||||||
|
It does NOT re-provision the new CA into already-running bottles — those must be
|
||||||
|
re-attached so they install the new trust anchor. Rotation is thus an explicit,
|
||||||
|
operator-driven action with a brief egress interruption, not an automatic one.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ..docker_cmd import run_docker
|
||||||
|
from ..paths import host_gateway_ca_dir
|
||||||
|
from .gateway import GATEWAY_NAME, rotate_gateway_ca
|
||||||
|
from .lifecycle import INFRA_NAME
|
||||||
|
|
||||||
|
# The containers whose mitmproxy would still be serving the old CA from memory:
|
||||||
|
# the consolidated infra container and the standalone per-host gateway.
|
||||||
|
_GATEWAY_CONTAINERS = (INFRA_NAME, GATEWAY_NAME)
|
||||||
|
|
||||||
|
|
||||||
|
def _out(msg: str) -> None:
|
||||||
|
sys.stdout.write(f"rotate-ca: {msg}\n")
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str] | None = None) -> int:
|
||||||
|
del argv # no flags — a single deliberate action
|
||||||
|
ca_dir: Path = host_gateway_ca_dir()
|
||||||
|
removed = rotate_gateway_ca(ca_dir)
|
||||||
|
if removed:
|
||||||
|
_out(f"removed {len(removed)} CA file(s) from {ca_dir}")
|
||||||
|
else:
|
||||||
|
_out(f"no persisted CA under {ca_dir}; a fresh one is minted on next start")
|
||||||
|
|
||||||
|
# Drop any running gateway so its in-memory (now-stale) CA is replaced on
|
||||||
|
# the next launch. `rm --force` on an absent name is a tolerated no-op.
|
||||||
|
for name in _GATEWAY_CONTAINERS:
|
||||||
|
proc = run_docker(["docker", "rm", "--force", name])
|
||||||
|
if proc.returncode == 0 and proc.stdout.strip():
|
||||||
|
_out(f"removed running container {name}")
|
||||||
|
|
||||||
|
_out("done — the next bottle launch remints the CA; re-attach bottles to "
|
||||||
|
"install the new trust anchor")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
@@ -13,15 +13,20 @@ Launch lifecycle:
|
|||||||
and returns the record. If the broker rejects/fails, the registry entry
|
and returns the record. If the broker rejects/fails, the registry entry
|
||||||
is rolled back so a failed launch leaves no orphan.
|
is rolled back so a failed launch leaves no orphan.
|
||||||
* `teardown_bottle` sends a signed teardown request, then deregisters.
|
* `teardown_bottle` sends a signed teardown request, then deregisters.
|
||||||
|
* `reconcile` sweeps rows whose bottle is no longer running — the
|
||||||
|
self-heal for the teardown paths that never got to run (a hard-killed
|
||||||
|
launcher), since an orphan row at a recycled source IP bricks the next
|
||||||
|
bottle that lands on it.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
from collections.abc import Iterable
|
||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
|
|
||||||
from .broker import LaunchBroker, LaunchRequest, sign_request
|
from .broker import LaunchBroker, LaunchRequest, sign_request
|
||||||
from .registry import BottleRecord, RegistryStore
|
from .registry import DEFAULT_REAP_GRACE_SECONDS, BottleRecord, RegistryStore
|
||||||
from .gateway import Gateway
|
from .gateway import Gateway
|
||||||
from ..supervise import (
|
from ..supervise import (
|
||||||
AuditEntry,
|
AuditEntry,
|
||||||
@@ -117,6 +122,30 @@ class Orchestrator:
|
|||||||
self._tokens.pop(bottle_id, None)
|
self._tokens.pop(bottle_id, None)
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
def reconcile(
|
||||||
|
self,
|
||||||
|
live_source_ips: Iterable[str],
|
||||||
|
*,
|
||||||
|
grace_seconds: float = DEFAULT_REAP_GRACE_SECONDS,
|
||||||
|
) -> list[str]:
|
||||||
|
"""Drop registry rows for bottles that are no longer running, and
|
||||||
|
forget their in-memory egress tokens. Returns the reaped bottle ids.
|
||||||
|
|
||||||
|
The caller supplies the live set because only the host can enumerate
|
||||||
|
its own containers — the orchestrator runs *inside* the infra
|
||||||
|
container and has no view of the backend. Deliberately does not
|
||||||
|
broker a teardown: the container is already gone, so there is nothing
|
||||||
|
to stop, and a broker error must not stop the sweep from clearing
|
||||||
|
the row that would otherwise brick the next bottle at that address.
|
||||||
|
|
||||||
|
See `RegistryStore.reap_absent` for why orphans accumulate and why
|
||||||
|
they are harmful rather than merely untidy."""
|
||||||
|
reaped = self.registry.reap_absent(
|
||||||
|
live_source_ips, grace_seconds=grace_seconds)
|
||||||
|
for rec in reaped:
|
||||||
|
self._tokens.pop(rec.bottle_id, None)
|
||||||
|
return [rec.bottle_id for rec in reaped]
|
||||||
|
|
||||||
def tokens_for(self, bottle_id: str) -> dict[str, str]:
|
def tokens_for(self, bottle_id: str) -> dict[str, str]:
|
||||||
"""The bottle's in-memory egress auth tokens (env_name -> value), or
|
"""The bottle's in-memory egress auth tokens (env_name -> value), or
|
||||||
empty. The gateway injects these per request; they are never
|
empty. The gateway injects these per request; they are never
|
||||||
|
|||||||
@@ -33,6 +33,13 @@ HOST_DB_FILENAME = "bot-bottle.db"
|
|||||||
CONTROL_PLANE_TOKEN_FILENAME = "control-plane-token"
|
CONTROL_PLANE_TOKEN_FILENAME = "control-plane-token"
|
||||||
CONTROL_PLANE_TOKEN_ENV = "BOT_BOTTLE_CONTROL_PLANE_TOKEN"
|
CONTROL_PLANE_TOKEN_ENV = "BOT_BOTTLE_CONTROL_PLANE_TOKEN"
|
||||||
|
|
||||||
|
# The host directory holding the gateway's persistent mitmproxy CA. Bind-mounted
|
||||||
|
# into the infra/gateway container at mitmproxy's confdir so the self-generated
|
||||||
|
# CA survives container recreation — every agent installs this one CA to trust
|
||||||
|
# the shared gateway's TLS interception, so it must not rotate on restart. See
|
||||||
|
# host_gateway_ca_dir() for why this is a host bind-mount, not a named volume.
|
||||||
|
GATEWAY_CA_DIRNAME = "gateway-ca"
|
||||||
|
|
||||||
|
|
||||||
def bot_bottle_root() -> Path:
|
def bot_bottle_root() -> Path:
|
||||||
"""The app data root — `$BOT_BOTTLE_ROOT` if set, else `~/.bot-bottle`."""
|
"""The app data root — `$BOT_BOTTLE_ROOT` if set, else `~/.bot-bottle`."""
|
||||||
@@ -59,6 +66,23 @@ def host_db_dir() -> Path:
|
|||||||
return db_dir
|
return db_dir
|
||||||
|
|
||||||
|
|
||||||
|
def host_gateway_ca_dir() -> Path:
|
||||||
|
"""The directory holding the gateway's persistent mitmproxy CA, created if
|
||||||
|
missing. Backends bind-mount this into the infra/gateway container at
|
||||||
|
mitmproxy's confdir so the CA persists across container recreation.
|
||||||
|
|
||||||
|
A host bind-mount under the app-data root — deliberately NOT a Docker
|
||||||
|
named volume. A named volume survives `docker rm` but is silently wiped by
|
||||||
|
`docker volume prune` / `docker system prune --volumes` during routine host
|
||||||
|
maintenance; the gateway then mints a fresh CA that every already-running
|
||||||
|
bottle distrusts, failing the TLS handshake even after it reconnects to the
|
||||||
|
moved gateway (issue #450). A path under the root docker never prunes it,
|
||||||
|
and it stays directly inspectable + rotatable from the host."""
|
||||||
|
ca_dir = bot_bottle_root() / GATEWAY_CA_DIRNAME
|
||||||
|
ca_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
return ca_dir
|
||||||
|
|
||||||
|
|
||||||
def host_control_plane_token() -> str:
|
def host_control_plane_token() -> str:
|
||||||
"""The per-host control-plane secret, minted (256-bit, url-safe) and
|
"""The per-host control-plane secret, minted (256-bit, url-safe) and
|
||||||
persisted 0600 on first use, then reused.
|
persisted 0600 on first use, then reused.
|
||||||
@@ -94,8 +118,10 @@ __all__ = [
|
|||||||
"HOST_DB_FILENAME",
|
"HOST_DB_FILENAME",
|
||||||
"CONTROL_PLANE_TOKEN_FILENAME",
|
"CONTROL_PLANE_TOKEN_FILENAME",
|
||||||
"CONTROL_PLANE_TOKEN_ENV",
|
"CONTROL_PLANE_TOKEN_ENV",
|
||||||
|
"GATEWAY_CA_DIRNAME",
|
||||||
"bot_bottle_root",
|
"bot_bottle_root",
|
||||||
"host_db_path",
|
"host_db_path",
|
||||||
"host_db_dir",
|
"host_db_dir",
|
||||||
|
"host_gateway_ca_dir",
|
||||||
"host_control_plane_token",
|
"host_control_plane_token",
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -6,9 +6,11 @@ from pathlib import Path
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
from .audit_store import AuditStore
|
from .audit_store import AuditStore
|
||||||
|
from .config_store import ConfigStore
|
||||||
from .queue_store import QueueStore
|
from .queue_store import QueueStore
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from audit_store import AuditStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
from audit_store import AuditStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
from config_store import ConfigStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
from queue_store import QueueStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
from queue_store import QueueStore # type: ignore[import-not-found] # pylint: disable=import-error,no-name-in-module
|
||||||
|
|
||||||
_instance: StoreManager | None = None
|
_instance: StoreManager | None = None
|
||||||
@@ -47,11 +49,13 @@ class StoreManager:
|
|||||||
return (
|
return (
|
||||||
QueueStore("", self.db_path).is_migrated()
|
QueueStore("", self.db_path).is_migrated()
|
||||||
and AuditStore(self.db_path).is_migrated()
|
and AuditStore(self.db_path).is_migrated()
|
||||||
|
and ConfigStore(self.db_path).is_migrated()
|
||||||
)
|
)
|
||||||
|
|
||||||
def migrate(self) -> None:
|
def migrate(self) -> None:
|
||||||
QueueStore("", self.db_path).migrate()
|
QueueStore("", self.db_path).migrate()
|
||||||
AuditStore(self.db_path).migrate()
|
AuditStore(self.db_path).migrate()
|
||||||
|
ConfigStore(self.db_path).migrate()
|
||||||
|
|
||||||
|
|
||||||
__all__ = ["StoreManager"]
|
__all__ = ["StoreManager"]
|
||||||
|
|||||||
@@ -312,6 +312,44 @@ reaches over the RPC rather than a shared mount into the VM. WAL on the
|
|||||||
shared DB is therefore a deliberate, tested future change — not enabled ad
|
shared DB is therefore a deliberate, tested future change — not enabled ad
|
||||||
hoc. `sqlite3` itself is stdlib, so "the host needs SQLite" is a non-cost.
|
hoc. `sqlite3` itself is stdlib, so "the host needs SQLite" is a non-cost.
|
||||||
|
|
||||||
|
### Gateway CA: host-resident, like the DB
|
||||||
|
|
||||||
|
The shared gateway bumps TLS with a self-generated mitmproxy CA, and **every
|
||||||
|
bottle installs that CA** into its trust store to accept the bumped leaves. So
|
||||||
|
the CA is durable per-host state with the same rule as the DB: it must outlive
|
||||||
|
any single gateway container, or a restart mints a fresh CA that every
|
||||||
|
already-running bottle distrusts — the TLS handshake then fails even after the
|
||||||
|
bottle re-resolves and reconnects to the moved gateway (issue #450, a
|
||||||
|
re-attachment blocker distinct from #443/#445).
|
||||||
|
|
||||||
|
The CA lives on the **host filesystem** at `bot_bottle_root()/gateway-ca`
|
||||||
|
(`host_gateway_ca_dir()`), bind-mounted into the container at mitmproxy's
|
||||||
|
confdir. This is deliberately a host bind-mount, **not a container-runtime
|
||||||
|
named volume**: a named volume survives ordinary container removal but can be
|
||||||
|
silently wiped by Docker's or Apple Container's volume-prune commands during
|
||||||
|
routine host maintenance, which is exactly how the ephemeral-CA symptom shows
|
||||||
|
up in practice. A path under the app-data root is not managed or pruned by the
|
||||||
|
container runtime, and stays directly inspectable and rotatable from the host.
|
||||||
|
mitmproxy reuses an existing CA and generates one only on first run, so the
|
||||||
|
bind-mount alone gives
|
||||||
|
"adopt-existing, generate-on-first-run" for free.
|
||||||
|
|
||||||
|
The macOS backend uses the same host-resident CA directory and bind-mounts it
|
||||||
|
into the consolidated Apple infra container. Its `bot-bottle-mac-db` named
|
||||||
|
volume remains container-only because that prevents incoherent cross-kernel
|
||||||
|
SQLite locking, but the CA is deliberately not stored there: Apple Container
|
||||||
|
also has a `container volume prune` operation, and the named volume is
|
||||||
|
temporarily unreferenced while the infra container is recreated. Keeping the
|
||||||
|
CA on the host makes both ordinary recreation and volume pruning safe.
|
||||||
|
|
||||||
|
**Deliberate rollover** is the explicit inverse: `rotate_gateway_ca()` removes
|
||||||
|
the persisted CA material so the next start remints it, and the
|
||||||
|
`python -m bot_bottle.orchestrator.rotate_ca` one-shot wires that together with
|
||||||
|
dropping the running gateway container (whose mitmproxy still holds the old CA
|
||||||
|
in memory). Rotation does not auto-re-provision the new CA into running bottles
|
||||||
|
— those re-attach to install the new anchor — so it is an operator action with
|
||||||
|
a brief egress interruption, never an implicit one.
|
||||||
|
|
||||||
## Sequencing
|
## Sequencing
|
||||||
|
|
||||||
Jump straight to the **virtualized** end state (not a host-daemon stepping
|
Jump straight to the **virtualized** end state (not a host-daemon stepping
|
||||||
|
|||||||
@@ -0,0 +1,146 @@
|
|||||||
|
# PRD prd-new: Claude forward_host_credentials
|
||||||
|
|
||||||
|
- **Status:** Draft
|
||||||
|
- **Author:** claude
|
||||||
|
- **Created:** 2026-07-01
|
||||||
|
- **Issue:** #325
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Add `agent_provider.forward_host_credentials: true` support for the
|
||||||
|
`claude` template, mirroring the existing Codex flow. When enabled,
|
||||||
|
bot-bottle reads the host's Claude OAuth session key from
|
||||||
|
`~/.claude/.credentials.json` at launch, forwards it only to the egress sidecar,
|
||||||
|
and injects a placeholder `CLAUDE_CODE_OAUTH_TOKEN` into the agent so
|
||||||
|
Claude Code starts without ever seeing the real credential.
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
Running a Claude agent in a container today requires the operator to
|
||||||
|
manually extract a long-lived OAuth token (`claude setup-token`), export
|
||||||
|
it as `BOT_BOTTLE_CLAUDE_OAUTH_TOKEN`, and reference it explicitly in
|
||||||
|
the manifest with `agent_provider.auth_token:
|
||||||
|
"BOT_BOTTLE_CLAUDE_OAUTH_TOKEN"`. This is a two-step manual ceremony
|
||||||
|
that is easy to skip or do incorrectly.
|
||||||
|
|
||||||
|
The host already stores a valid Claude session in `~/.claude/.credentials.json`
|
||||||
|
after `claude login`. Codex already automates an
|
||||||
|
equivalent extraction from `~/.codex/auth.json`. There is no reason
|
||||||
|
Claude bottles cannot do the same.
|
||||||
|
|
||||||
|
## Goals / Success Criteria
|
||||||
|
|
||||||
|
- A Claude bottle with `forward_host_credentials: true` in the manifest
|
||||||
|
uses the host's `~/.claude/.credentials.json` session key at launch with no
|
||||||
|
additional operator steps.
|
||||||
|
- The agent container receives only `CLAUDE_CODE_OAUTH_TOKEN=egress-placeholder`
|
||||||
|
— never the real token.
|
||||||
|
- The real session key lives only in the egress sidecar's environment.
|
||||||
|
- Missing, malformed, or expired host Claude auth fails launch with a
|
||||||
|
clear operator-facing message.
|
||||||
|
- Existing `auth_token` behavior is unchanged.
|
||||||
|
- `forward_host_credentials: true` is rejected in the manifest when both
|
||||||
|
`auth_token` and `forward_host_credentials` are set, since they serve
|
||||||
|
the same purpose.
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Refreshing Claude OAuth tokens in the sidecar.
|
||||||
|
- Writing a dummy `~/.claude.json` auth state to the agent (unlike the
|
||||||
|
Codex flow, Claude Code reads its credential from `CLAUDE_CODE_OAUTH_TOKEN`
|
||||||
|
in env, not from an auth file — no guest-side auth marker is needed).
|
||||||
|
- Supporting `forward_host_credentials` for providers other than `codex`
|
||||||
|
and `claude`.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
### Manifest schema
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
agent_provider:
|
||||||
|
template: claude
|
||||||
|
forward_host_credentials: true
|
||||||
|
```
|
||||||
|
|
||||||
|
Rejects in manifest validation when:
|
||||||
|
- Template is not `codex` or `claude`.
|
||||||
|
- Both `auth_token` and `forward_host_credentials` are set.
|
||||||
|
|
||||||
|
### Host auth extraction (`contrib/claude/claude_auth.py`)
|
||||||
|
|
||||||
|
Claude Code credential storage varies by platform:
|
||||||
|
|
||||||
|
- **Linux**: `~/.claude/.credentials.json`
|
||||||
|
- **macOS**: macOS Keychain, service `"Claude Code-credentials"`
|
||||||
|
(the file path is tried first; Keychain is the fallback when the file
|
||||||
|
is absent)
|
||||||
|
|
||||||
|
`~/.claude.json` contains only UI state and profile metadata — no token.
|
||||||
|
|
||||||
|
The credentials JSON schema (same whether from file or Keychain):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"claudeAiOauth": {
|
||||||
|
"accessToken": "<access-token>",
|
||||||
|
"refreshToken": "<refresh-token>",
|
||||||
|
"expiresAt": 1748276587173,
|
||||||
|
"scopes": ["user:inference", "user:profile"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`expiresAt` is in **milliseconds** (not seconds).
|
||||||
|
|
||||||
|
At prepare/launch time, when `forward_host_credentials: true`:
|
||||||
|
|
||||||
|
1. Try `~/.claude/.credentials.json`; on macOS, if absent, run
|
||||||
|
`security find-generic-password -s "Claude Code-credentials" -w`
|
||||||
|
and parse its stdout as JSON.
|
||||||
|
2. Require a `claudeAiOauth` dict.
|
||||||
|
3. Require a non-empty `claudeAiOauth.accessToken` string.
|
||||||
|
4. If `claudeAiOauth.expiresAt` is present, divide by 1000 and require
|
||||||
|
the result to be in the future.
|
||||||
|
5. Return only the access token to the launch path.
|
||||||
|
|
||||||
|
Errors name the missing or invalid condition and point the operator at
|
||||||
|
`claude login`, without printing token values.
|
||||||
|
|
||||||
|
### Egress route
|
||||||
|
|
||||||
|
When `forward_host_credentials: true`:
|
||||||
|
|
||||||
|
- Provision the session key in `provisioned_env` under
|
||||||
|
`BOT_BOTTLE_CLAUDE_HOST_ACCESS_TOKEN` (new constant in `egress.py`).
|
||||||
|
- Set up the `api.anthropic.com` egress route with `auth_scheme: Bearer`
|
||||||
|
and `token_ref: BOT_BOTTLE_CLAUDE_HOST_ACCESS_TOKEN`.
|
||||||
|
- Set `CLAUDE_CODE_OAUTH_TOKEN=egress-placeholder` in the agent env and
|
||||||
|
add it to `hidden_env_names`.
|
||||||
|
|
||||||
|
No dummy auth file and no `verify` step are needed — Claude Code reads
|
||||||
|
the credential from the env var, not from a file.
|
||||||
|
|
||||||
|
### Constants
|
||||||
|
|
||||||
|
- `CLAUDE_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CLAUDE_HOST_ACCESS_TOKEN"`
|
||||||
|
in `egress.py` (alongside the existing `CODEX_HOST_CREDENTIAL_TOKEN_REF`).
|
||||||
|
- `CLAUDE_HOST_CREDENTIAL_HOSTS = ("api.anthropic.com",)` in
|
||||||
|
`agent_provider.py` (alongside the existing `CODEX_HOST_CREDENTIAL_HOSTS`).
|
||||||
|
|
||||||
|
### Data flow
|
||||||
|
|
||||||
|
```
|
||||||
|
Host ~/.claude/.credentials.json → bot-bottle launch
|
||||||
|
│
|
||||||
|
├──► egress sidecar env (real token only)
|
||||||
|
│
|
||||||
|
└──► agent env: CLAUDE_CODE_OAUTH_TOKEN=egress-placeholder
|
||||||
|
|
||||||
|
Agent → HTTPS to api.anthropic.com (via egress)
|
||||||
|
Egress → injects Authorization: Bearer <real token>
|
||||||
|
Egress → forwards to api.anthropic.com
|
||||||
|
```
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
None — the Codex precedent makes the design clear.
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
# PRD prd-new: Consolidate infra backend for Docker
|
||||||
|
|
||||||
|
- **Status:** Active
|
||||||
|
- **Author:** Claude
|
||||||
|
- **Created:** 2026-07-20
|
||||||
|
- **Issue:** #431
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
The Docker backend runs two containers — `bot-bottle-orch-gateway` (gateway
|
||||||
|
data plane) and `bot-bottle-orchestrator` (control plane) — where the
|
||||||
|
macOS and Firecracker backends already run a single combined infra
|
||||||
|
unit. This PRD collapses Docker to the same model: one `bot-bottle-infra`
|
||||||
|
container running both processes under the `gateway_init` supervise tree, a
|
||||||
|
restructured `Dockerfile.infra` as the shared gateway+orchestrator base,
|
||||||
|
and a handful of extracted shared utilities (CA cert polling, teardown
|
||||||
|
sequence, launch skeleton) that are currently duplicated across all three
|
||||||
|
`consolidated_launch.py` files.
|
||||||
|
|
||||||
|
## Goals / success criteria
|
||||||
|
|
||||||
|
- Docker backend starts exactly one infra container instead of two.
|
||||||
|
- `Dockerfile.infra` is the shared base image (gateway + orchestrator, no
|
||||||
|
buildah); the Firecracker image layers buildah on top of it.
|
||||||
|
- The orchestrator process runs under the `gateway_init` supervise tree
|
||||||
|
inside the combined container (one PID-1, one restart/health surface).
|
||||||
|
- CA cert polling, the teardown sequence, and the shared launch skeleton
|
||||||
|
(ensure-infra → register → provision → return context) live in a single
|
||||||
|
shared module; all three backends import from it.
|
||||||
|
- No functional change to macOS or Firecracker launch paths.
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Changing per-bottle isolation — agents stay one-VM/container-each.
|
||||||
|
- Consolidating transport implementations (`DockerGatewayTransport`,
|
||||||
|
`AppleGatewayTransport`, `SshGatewayTransport`) — these are already the
|
||||||
|
right abstraction boundary.
|
||||||
|
- macOS DHCP-inversion of registration order — irreducible backend
|
||||||
|
difference, stays as-is.
|
||||||
|
- Any changes to the orchestrator RPC protocol or the attribution model.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
### Dockerfile restructuring
|
||||||
|
|
||||||
|
**Current shape:**
|
||||||
|
|
||||||
|
- `Dockerfile.gateway` — data plane (mitmproxy, gitleaks, git, openssh,
|
||||||
|
supervise daemons)
|
||||||
|
- `Dockerfile.orchestrator` — control plane (python:3.12-slim + bot_bottle
|
||||||
|
package; stdlib-only, no third-party deps)
|
||||||
|
- `Dockerfile.infra` — Firecracker only: `FROM bot-bottle-gateway` +
|
||||||
|
buildah + `COPY --from bot-bottle-orchestrator`
|
||||||
|
|
||||||
|
**New shape:**
|
||||||
|
|
||||||
|
- `Dockerfile.gateway` — unchanged
|
||||||
|
- `Dockerfile.orchestrator` — unchanged (single definition of orchestrator
|
||||||
|
content; both Docker infra and Firecracker infra `COPY --from` it)
|
||||||
|
- `Dockerfile.infra` — **shared base**: `FROM bot-bottle-gateway` + `COPY
|
||||||
|
--from bot-bottle-orchestrator` (no buildah — Docker infra image)
|
||||||
|
- `Dockerfile.infra.fc` — Firecracker only: `FROM bot-bottle-infra` +
|
||||||
|
buildah/crun/netavark/aardvark-dns (layered on the shared base, same net
|
||||||
|
result as today)
|
||||||
|
|
||||||
|
The comment in `Dockerfile.infra` that says "the docker backend keeps
|
||||||
|
orchestrator + gateway as separate images; this combined image exists only
|
||||||
|
for the Firecracker single-VM cut" is removed.
|
||||||
|
|
||||||
|
### Orchestrator in the supervise tree
|
||||||
|
|
||||||
|
`gateway_init` already supervises the data-plane daemons (egress, git-http,
|
||||||
|
supervise-MCP). The orchestrator control plane is added as another supervised
|
||||||
|
process: `python3 -m bot_bottle.orchestrator --host 0.0.0.0 --port <port>
|
||||||
|
--broker stub`.
|
||||||
|
|
||||||
|
The orchestrator source is bind-mounted (`/app` → repo root, as today) so
|
||||||
|
dev live-reload still works. `source_hash`-based container recreation in
|
||||||
|
`OrchestratorService.ensure_running` continues to apply — a code change
|
||||||
|
recreates the combined infra container, which bounces both gateway and
|
||||||
|
orchestrator. This is acceptable: the docker backend is a dev/legacy target
|
||||||
|
where in-flight egress connections across a code deploy are not a hard
|
||||||
|
requirement.
|
||||||
|
|
||||||
|
### `OrchestratorService` changes
|
||||||
|
|
||||||
|
`OrchestratorService` currently starts two containers in sequence: gateway
|
||||||
|
first (`DockerGateway.ensure_running`), then orchestrator. After this PRD:
|
||||||
|
|
||||||
|
- Single `docker run` of `bot-bottle-infra:latest`
|
||||||
|
- Container name: `bot-bottle-infra` (replaces `bot-bottle-orch-gateway` +
|
||||||
|
`bot-bottle-orchestrator`)
|
||||||
|
- Published ports: `127.0.0.1:{host_port}:8099` for the control plane
|
||||||
|
(`gateway_init` listens on a fixed internal port 8099; the caller-chosen
|
||||||
|
host port maps to it)
|
||||||
|
- Bind mounts: repo root + host root (same as today)
|
||||||
|
- `DockerGateway` becomes an implementation detail of `OrchestratorService`
|
||||||
|
rather than a separately started container; the gateway image name
|
||||||
|
(`GATEWAY_IMAGE`) is no longer referenced at runtime, only at build time
|
||||||
|
for the `Dockerfile.infra` base
|
||||||
|
|
||||||
|
The `_gateway()` / `ensure_running` two-step in `OrchestratorService` is
|
||||||
|
replaced by a single `_run_infra_container()`.
|
||||||
|
|
||||||
|
### Shared backend utilities
|
||||||
|
|
||||||
|
Three items are duplicated across
|
||||||
|
`backend/docker/consolidated_launch.py`,
|
||||||
|
`backend/macos_container/consolidated_launch.py`, and
|
||||||
|
`backend/firecracker/consolidated_launch.py`:
|
||||||
|
|
||||||
|
1. **CA cert polling loop** — `deadline = time.monotonic() + timeout; while
|
||||||
|
...: try fetch CA; sleep` — extracted to
|
||||||
|
`backend/consolidated_util.py:poll_ca_cert(transport, *, timeout)`.
|
||||||
|
|
||||||
|
2. **Teardown sequence** — `OrchestratorClient(url).teardown_bottle(id)` +
|
||||||
|
`deprovision_git_gate(transport, id)` — extracted to
|
||||||
|
`backend/consolidated_util.py:teardown_consolidated(url, transport,
|
||||||
|
bottle_id)`.
|
||||||
|
|
||||||
|
3. **Launch skeleton** — all three follow: ensure-infra → allocate/register
|
||||||
|
→ provision git-gate → fetch CA cert → return launch context. The macOS
|
||||||
|
inversion (agent starts before registration, source IP from DHCP) is the
|
||||||
|
only deviation. Extract a shared `_provision_bottle(transport, bottle_id,
|
||||||
|
plan, orchestrator_url)` helper covering the register → provision →
|
||||||
|
return-token steps; the backends keep their own `launch_consolidated`
|
||||||
|
wrappers for the before/after (infra-ensure + agent-start + IP
|
||||||
|
allocation), calling the shared helper.
|
||||||
|
|
||||||
|
The new `backend/consolidated_util.py` module holds only backend-neutral,
|
||||||
|
transport-agnostic logic. All three backends import from it.
|
||||||
|
|
||||||
|
## Implementation chunks
|
||||||
|
|
||||||
|
1. **(this PR)** Dockerfile restructuring: rename current `Dockerfile.infra`
|
||||||
|
content to `Dockerfile.infra.fc`; write new `Dockerfile.infra` as
|
||||||
|
gateway+orchestrator base. Update Firecracker image-build references from
|
||||||
|
`Dockerfile.infra` → `Dockerfile.infra.fc`.
|
||||||
|
|
||||||
|
2. Add orchestrator process to `gateway_init` supervise tree.
|
||||||
|
|
||||||
|
3. Collapse `OrchestratorService` to a single-container start; rename
|
||||||
|
container from `bot-bottle-orch-gateway`/`bot-bottle-orchestrator` →
|
||||||
|
`bot-bottle-infra`; update image name constant.
|
||||||
|
|
||||||
|
4. Extract `backend/consolidated_util.py` with `poll_ca_cert`,
|
||||||
|
`teardown_consolidated`, and `_provision_bottle`; update all three
|
||||||
|
`consolidated_launch.py` files to import from it.
|
||||||
|
|
||||||
|
5. Update tests that reference the old container names or two-container
|
||||||
|
startup sequence.
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
None — the supervise-tree approach and shared Dockerfile layering were
|
||||||
|
confirmed in issue #431.
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
# PRD prd-new: Modernize built-in agent images
|
||||||
|
|
||||||
|
- **Status:** Draft
|
||||||
|
- **Author:** Codex
|
||||||
|
- **Created:** 2026-07-21
|
||||||
|
- **Issue:** #451
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Keep every built-in agent provider on Debian's current stable release and make
|
||||||
|
Podman available inside each image. This gives agents a consistent, modern
|
||||||
|
userspace and an OCI container tool without requiring per-project setup.
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
The Claude, Codex, and Pi images inherit the generic `node:22-slim` tag. That
|
||||||
|
tag does not state which Debian release the project supports and currently
|
||||||
|
leaves the images on the older Bookworm release. None of the built-in images
|
||||||
|
installs Podman, so tasks that need to inspect or build OCI images must first
|
||||||
|
modify the bottle or cannot run at all.
|
||||||
|
|
||||||
|
## Goals / success criteria
|
||||||
|
|
||||||
|
- Every Dockerfile under `bot_bottle/contrib/*/Dockerfile` explicitly inherits
|
||||||
|
`node:22-trixie-slim`, based on Debian 13 (the current stable release).
|
||||||
|
- Every built-in agent image installs Podman from Debian stable.
|
||||||
|
- Every built-in agent image retains an SSH client for Git-over-SSH workflows.
|
||||||
|
- The non-root agent user owns a traversable XDG Git configuration directory,
|
||||||
|
so Git can load bot-bottle's global git-gate rewrites without permission
|
||||||
|
errors.
|
||||||
|
- A shared test enforces both requirements for current and future built-in
|
||||||
|
providers.
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Configuring privileged or nested-container execution for bottles.
|
||||||
|
- Pinning Podman outside Debian's stable package repository.
|
||||||
|
- Changing the Node.js or agent CLI release policy.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
Use the explicit `node:22-trixie-slim` base rather than the floating `slim`
|
||||||
|
variant. Install the `podman` package with each image's existing `apt-get`
|
||||||
|
dependency layer, so package metadata and caches are still removed in the same
|
||||||
|
layer. Treat Debian stable as the Podman stability and update channel; this
|
||||||
|
keeps the images stdlib/distribution-first and avoids adding a third-party
|
||||||
|
package repository.
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
# PRD prd-new: Containers inside a bottle
|
||||||
|
|
||||||
|
- **Status:** Draft
|
||||||
|
- **Author:** Claude
|
||||||
|
- **Created:** 2026-07-21
|
||||||
|
- **Issue:** #392
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Let an agent run `docker` and `docker compose` *inside* its bottle by starting
|
||||||
|
a guest-local rootless podman service that exposes a Docker-compatible API
|
||||||
|
socket. Gated per bottle by `nested_containers: true`. No host daemon socket is
|
||||||
|
mounted and no capability is added to the guest, on any backend.
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
Agent tasks routinely involve containers: `docker compose up` to verify a
|
||||||
|
scaffolded stack, a throwaway database for a test run, building an image to
|
||||||
|
check a Dockerfile works. Bottles have no way to do any of that, so those tasks
|
||||||
|
either fail or get done outside the bottle — which defeats the point of the
|
||||||
|
bottle.
|
||||||
|
|
||||||
|
## Goals / success criteria
|
||||||
|
|
||||||
|
- A bottle with `nested_containers: true` on the `macos-container` backend can
|
||||||
|
run `docker compose up -d --wait` against a stock compose file, pulling from
|
||||||
|
a routed registry and serving from the workspace.
|
||||||
|
- The agent's habits do not change: `docker` and `docker compose`, not
|
||||||
|
`podman`.
|
||||||
|
- No host Docker socket is mounted, on any backend.
|
||||||
|
- No capability is added to the Apple Container guest.
|
||||||
|
- Backends without a guest-local engine reject the flag with a clear error
|
||||||
|
rather than ignoring it.
|
||||||
|
- Bottles that do not set the flag carry none of its cost.
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Nested containers as an isolation layer. The single-UID mapping means `root`
|
||||||
|
inside a nested container is the agent user outside it. This is for build and
|
||||||
|
test workloads; the bottle stays the security boundary.
|
||||||
|
- The `docker` and `firecracker` backends. Both reject the flag for now.
|
||||||
|
- Reaching registries that are not routed through the bottle's egress proxy.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
### Why podman, not rootless Docker
|
||||||
|
|
||||||
|
Apple Container's capability bounding set omits `CAP_SYS_ADMIN`, which the
|
||||||
|
kernel requires in order to write a multi-range `uid_map` via `newuidmap`.
|
||||||
|
Rootless Docker has no path that avoids that write, so it cannot run in a
|
||||||
|
bottle without granting `CAP_SYS_ADMIN` — which is close to root in practical
|
||||||
|
terms and gives up most of what the bottle is for.
|
||||||
|
|
||||||
|
Podman does have a path: with **no** subordinate UID range configured it falls
|
||||||
|
back to a single-UID self-mapping, which an unprivileged process may write
|
||||||
|
itself. The image build therefore *removes* the agent user's `/etc/subuid` and
|
||||||
|
`/etc/subgid` entries rather than adding them — their presence is exactly what
|
||||||
|
would send podman down the `newuidmap` path. Full negative result in
|
||||||
|
[`docs/research/rootless-docker-in-apple-container-spike.md`](../research/rootless-docker-in-apple-container-spike.md).
|
||||||
|
|
||||||
|
### The flag, and its name
|
||||||
|
|
||||||
|
The flag is kept because it gates real costs, not because podman needs a
|
||||||
|
privilege grant: ~100MB of derived image, a resident service per bottle, and
|
||||||
|
relaxed modes on `/dev/fuse` and `/dev/net/tun` that the majority of bottles
|
||||||
|
should not get.
|
||||||
|
|
||||||
|
It is named `nested_containers`, not `docker_access`. It implies no Docker and
|
||||||
|
grants access to nothing on the host — naming it after Docker access would
|
||||||
|
describe the one thing the design refuses to do.
|
||||||
|
|
||||||
|
### Shape
|
||||||
|
|
||||||
|
- `bot_bottle/backend/macos_container/nested_containers.py` — derived-image
|
||||||
|
build, guest env, device preparation, service start/readiness.
|
||||||
|
- `bot_bottle/backend/macos_container/nested-containers-init.sh` — the
|
||||||
|
unprivileged bootstrap that runs inside the bottle. Fails closed on every
|
||||||
|
prerequisite it needs (podman, the storage/network helpers, writable device
|
||||||
|
nodes, an *empty* subordinate range) rather than degrading.
|
||||||
|
- The derived image `…-nested-containers` layers the Docker CLI, the compose
|
||||||
|
plugin, and podman 5's networking stack — `passt` (pasta), `netavark`,
|
||||||
|
`nftables`, `aardvark-dns` — plus `fuse-overlayfs`, `slirp4netns`, and
|
||||||
|
`uidmap` onto the agent image. Podman itself already ships in every built-in
|
||||||
|
image (#451), but with `--no-install-recommends`, so none of the networking
|
||||||
|
pieces arrive with it. Each absence fails at a different and misleading
|
||||||
|
layer: no pasta and nothing starts; no `nft` and containers are created but
|
||||||
|
never start; no aardvark-dns and DNS inside a container fails while
|
||||||
|
everything else looks healthy. Image pulls keep working throughout, which is
|
||||||
|
what makes these read as compat-API bugs.
|
||||||
|
- `BottleBackend.supports_nested_containers` — false by default, so a backend
|
||||||
|
that cannot honor the flag fails in the shared `prepare` template.
|
||||||
|
|
||||||
|
Guest configuration the single-UID mapping forces:
|
||||||
|
`ignore_chown_errors` (no second UID for layers to be chowned to),
|
||||||
|
`cgroups="disabled"` and `cgroup_manager="cgroupfs"` (no cgroup delegation
|
||||||
|
reaches the guest), `events_logger="file"` (no journald socket).
|
||||||
|
|
||||||
|
### Registry reach
|
||||||
|
|
||||||
|
Image pulls egress through the bottle's proxy like everything else, so each
|
||||||
|
registry needs a route — **and so does the CDN it redirects blobs to**, which
|
||||||
|
is a separate host: `production.cloudfront.docker.com` for Docker Hub,
|
||||||
|
`pkg-containers.githubusercontent.com` for GHCR, `cdn0*.quay.io` for quay.
|
||||||
|
Without those the pull authenticates, fetches the manifest, and then 403s
|
||||||
|
partway through. Docker Hub and GHCR need `preserve_auth: true` — their
|
||||||
|
token dance uses a client-fetched per-scope bearer token that the proxy would
|
||||||
|
otherwise strip. Layer pulls should also set `dlp.outbound_detectors: false`
|
||||||
|
and `dlp.inbound_detectors: false`: body scanning on a multi-hundred-MB layer
|
||||||
|
is what triggers #455, and a registry route's scanned bodies are compressed
|
||||||
|
layer blobs rather than anything a detector can read.
|
||||||
|
|
||||||
|
### Reaching the network from a nested container
|
||||||
|
|
||||||
|
Public DNS inside a nested container fails by design: everything egresses
|
||||||
|
through the proxy. What was actually broken was reaching the proxy at all, and
|
||||||
|
it took four attempts to fix because podman applies proxy settings at several
|
||||||
|
layers and the last writer wins:
|
||||||
|
|
||||||
|
| Layer | Applies to |
|
||||||
|
|---|---|
|
||||||
|
| `~/.docker/config.json` proxies block | **every container the Docker CLI starts** — client-side, beats everything below |
|
||||||
|
| service environment | podman's own pulls, non-CLI API clients |
|
||||||
|
| `containers.conf` `env` | native `podman run` |
|
||||||
|
| `containers.conf` `hosts_file`, `http_proxy` | native `podman run` only — the compat API ignores both |
|
||||||
|
|
||||||
|
The gateway is named `bot-bottle-gateway`, which resolves only through the
|
||||||
|
bottle's `/etc/hosts`; a nested container gets its own. Since no config key
|
||||||
|
reaches the compat path, the name is resolved in the bottle and the *address*
|
||||||
|
is substituted into the proxy URL at each layer above. `NO_PROXY` keeps the
|
||||||
|
name, which is matched against what a client asks for.
|
||||||
|
|
||||||
|
The gateway TLS-intercepts, so the CA bundle is mounted read-only and
|
||||||
|
`SSL_CERT_FILE`, `CURL_CA_BUNDLE`, `REQUESTS_CA_BUNDLE`, and
|
||||||
|
`NODE_EXTRA_CA_CERTS` point at it — no distro-specific trust commands.
|
||||||
|
|
||||||
|
## Verified on macOS 26 / Apple Container 1.0.0 / podman 5.4.2
|
||||||
|
|
||||||
|
With plain `docker`, no extra flags: image pulls from Docker Hub, GHCR, and
|
||||||
|
quay; `docker run` with correct exit-code propagation; `docker compose` up,
|
||||||
|
logs, down, and a published port curl'd from the bottle; `curl https://quay.io`
|
||||||
|
and `https://pypi.org/simple/` returning 200 from inside a nested container;
|
||||||
|
and `https://example.com` returning **403** — the egress allowlist applies to
|
||||||
|
nested containers, not just the bottle.
|
||||||
|
|
||||||
|
Alpine's BusyBox `wget` drops the connection after TLS interception and
|
||||||
|
reports "error getting response". The proxy logs the decrypted request, and
|
||||||
|
`curl` on the same host succeeds, so this is a BusyBox client limitation
|
||||||
|
rather than anything in the egress path.
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
- Whether the `docker` and `firecracker` backends want an equivalent, or
|
||||||
|
whether guest-local containers stay macOS-only.
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
# Egress proxy OOMs on large downloads
|
||||||
|
|
||||||
|
Found on 2026-07-21 while running the rootless-podman spike
|
||||||
|
(`docs/research/rootless-docker-in-apple-container-spike.md`). Recorded
|
||||||
|
rather than fixed — the fix is a security-relevant decision, not a
|
||||||
|
mechanical patch.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
A single large HTTPS download through the gateway kills the egress
|
||||||
|
proxy. `mitmdump` buffers whole response bodies so the DLP detectors can
|
||||||
|
scan them, grows past the gateway container's memory limit, and is
|
||||||
|
OOM-killed by the cgroup. Nothing restarts it.
|
||||||
|
|
||||||
|
Two properties make this worse than a failed download:
|
||||||
|
|
||||||
|
- **The gateway is a per-host singleton.** Every bottle shares it, so
|
||||||
|
one bottle's download takes egress away from all of them.
|
||||||
|
- **There is no restart on death.** The gateway supervisor is
|
||||||
|
`while : ; do wait ; done`; a killed daemon stays dead until the infra
|
||||||
|
container is recreated.
|
||||||
|
|
||||||
|
So ordinary agent activity — pulling a container image, downloading a
|
||||||
|
model or dataset, fetching a large tarball — is a denial of service
|
||||||
|
against every other bottle on the host. No malice required, though it is
|
||||||
|
trivially reachable on purpose.
|
||||||
|
|
||||||
|
## Evidence
|
||||||
|
|
||||||
|
Triggered by `docker compose up` pulling `quay.io/fedora/python-312`
|
||||||
|
(two layers, ~82MB and ~83MB) inside a bottle. The pull itself
|
||||||
|
succeeded; the *next* request failed:
|
||||||
|
|
||||||
|
```
|
||||||
|
initializing source docker://quay.io/fedora/python-312:latest:
|
||||||
|
pinging container registry quay.io: Get "https://quay.io/v2/":
|
||||||
|
proxyconnect tcp: dial tcp 192.168.128.39:9099: connect: connection refused
|
||||||
|
```
|
||||||
|
|
||||||
|
From the gateway's `dmesg`:
|
||||||
|
|
||||||
|
```
|
||||||
|
python3 invoked oom-killer: gfp_mask=0x100cca(GFP_HIGHUSER_MOVABLE), order=0
|
||||||
|
oom-kill:constraint=CONSTRAINT_MEMCG,
|
||||||
|
oom_memcg=/container/bot-bottle-mac-infra,
|
||||||
|
task_memcg=/container/bot-bottle-mac-infra,task=mitmdump,pid=118
|
||||||
|
Memory cgroup out of memory: Killed process 118 (mitmdump)
|
||||||
|
total-vm:1391936kB, anon-rss:997768kB
|
||||||
|
```
|
||||||
|
|
||||||
|
~1GB RSS against a 1024MB container. Note the amplification: ~165MB of
|
||||||
|
layers produced ~1GB of resident memory, so the buffering is several
|
||||||
|
copies deep (encoded body, decoded body, and the text conversion the
|
||||||
|
regex detectors scan).
|
||||||
|
|
||||||
|
Afterwards the gateway container was still running and healthy-looking —
|
||||||
|
orchestrator, supervise, and git-http all alive — with no `mitmdump`
|
||||||
|
process at all, and it stayed that way until the container was
|
||||||
|
recreated. A liveness check on the container would not have caught this.
|
||||||
|
|
||||||
|
## Reproduction
|
||||||
|
|
||||||
|
1. Launch any bottle with an egress route to a host serving a large file.
|
||||||
|
2. Download >~150MB over HTTPS through the proxy.
|
||||||
|
3. `dmesg | grep -i oom` inside `bot-bottle-mac-infra`, and note that no
|
||||||
|
`mitmdump` process remains.
|
||||||
|
|
||||||
|
Beware a false negative when checking: truncating the process listing
|
||||||
|
(`cut -c1-45`) cuts before the binary name, because `mitmdump` runs as
|
||||||
|
`/usr/local/bin/python3.12 /usr/local/bin/mitmdump …`.
|
||||||
|
|
||||||
|
## Fix options, not yet chosen
|
||||||
|
|
||||||
|
1. **Restart dead daemons.** Smallest change and strictly an
|
||||||
|
improvement: an OOM then degrades one download instead of removing
|
||||||
|
egress for every bottle. Does not stop the OOM.
|
||||||
|
2. **Cap the scanned body size.** Above a threshold, stop buffering —
|
||||||
|
either skip the scan or stream it. This is the root-cause fix and a
|
||||||
|
security decision: a size threshold is exactly the hole an exfiltrator
|
||||||
|
would aim for, so "skip above N" trades a DoS for a covert channel.
|
||||||
|
Streaming with a bounded window keeps coverage, at more complexity.
|
||||||
|
3. **Raise the gateway's memory limit.** Moves the threshold; does not
|
||||||
|
remove it.
|
||||||
|
|
||||||
|
Worth noting that (1) and (2) are complementary — the restart gap is
|
||||||
|
worth closing regardless of how the memory behaviour is resolved.
|
||||||
@@ -0,0 +1,359 @@
|
|||||||
|
# Rootless Docker inside Apple Container bottles
|
||||||
|
|
||||||
|
Spike branch: `spike/rootless-docker-macos` (`a4d8461`)
|
||||||
|
|
||||||
|
**Outcome:** the podman recommendation below shipped as the
|
||||||
|
`nested_containers` bottle flag — see
|
||||||
|
[`docs/prds/prd-new-nested-containers.md`](../prds/prd-new-nested-containers.md).
|
||||||
|
The `docker_access` name used throughout the spike text was renamed on the
|
||||||
|
way in; it granted no access to anything on the host.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
**Negative result.** Rootless Docker cannot run inside an Apple
|
||||||
|
Container bottle without granting the bottle `CAP_SYS_ADMIN`. This is a
|
||||||
|
kernel constraint on writing multi-range `uid_map`, not a packaging gap
|
||||||
|
we can close with a better init script, a different base image, or more
|
||||||
|
careful `/etc/subuid` handling.
|
||||||
|
|
||||||
|
The spike was built on the premise — stated in
|
||||||
|
`bot_bottle/backend/macos_container/rootless_docker.py` — that it would
|
||||||
|
*"deliberately refuse to compensate for missing prerequisites with outer
|
||||||
|
capabilities, a privileged container, or a host Docker socket."* That
|
||||||
|
premise is exactly what the experiment falsified. The two ways forward
|
||||||
|
are to abandon the premise (add `CAP_SYS_ADMIN` to the bottle, and with
|
||||||
|
it most of the isolation the bottle exists to provide) or to abandon
|
||||||
|
rootless Docker.
|
||||||
|
|
||||||
|
Recommendation: abandon rootless Docker. Podman does not have this
|
||||||
|
problem — see [Podman is not blocked by
|
||||||
|
this](#podman-is-not-blocked-by-this) below.
|
||||||
|
|
||||||
|
## Local environment
|
||||||
|
|
||||||
|
Tested on 2026-07-21:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ sw_vers
|
||||||
|
ProductName: macOS
|
||||||
|
ProductVersion: 26.5.1
|
||||||
|
BuildVersion: 25F80
|
||||||
|
|
||||||
|
$ container --version
|
||||||
|
container CLI version 1.0.0 (build: release, commit: ee848e3)
|
||||||
|
|
||||||
|
$ uname -a # inside the bottle
|
||||||
|
Linux ... 6.18.15 #1 SMP Tue Mar 17 01:36:53 UTC 2026 aarch64 GNU/Linux
|
||||||
|
```
|
||||||
|
|
||||||
|
## The failure
|
||||||
|
|
||||||
|
`tests/integration/test_macos_rootless_docker_spike.py` builds the
|
||||||
|
image, launches the bottle, and dies in `rootless_docker.start`:
|
||||||
|
|
||||||
|
```
|
||||||
|
+ exec rootlesskit --net=slirp4netns --mtu=65520 ... dockerd-rootless.sh
|
||||||
|
[rootlesskit:parent] error: failed to setup UID/GID map:
|
||||||
|
newuidmap 1100 [0 1000 1 1 100000 65536] failed:
|
||||||
|
newuidmap: write to uid_map failed: Operation not permitted
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why it fails
|
||||||
|
|
||||||
|
Every prerequisite you would normally suspect is present and correct in
|
||||||
|
the guest:
|
||||||
|
|
||||||
|
| Check | Result |
|
||||||
|
| --- | --- |
|
||||||
|
| `/usr/bin/newuidmap` | `-rwsr-xr-x root root` — setuid bit intact, survived the OCI export |
|
||||||
|
| `/` mount options | `rw,relatime` — **not** `nosuid` |
|
||||||
|
| `NoNewPrivs` | `0` |
|
||||||
|
| `Seccomp` | `0`, no filters |
|
||||||
|
| `/etc/subuid`, `/etc/subgid` | `node:100000:65536` in both |
|
||||||
|
| user namespace | `user:[4026531837]`, identical to pid 1 — the *initial* userns |
|
||||||
|
| `unshare -U -r true` | succeeds |
|
||||||
|
| `/proc/sys/user/max_user_namespaces` | `4505` |
|
||||||
|
|
||||||
|
The one thing that is missing is in the capability bounding set that
|
||||||
|
Apple Container gives the container:
|
||||||
|
|
||||||
|
```
|
||||||
|
CapBnd: 00000000a80425fb
|
||||||
|
= chown, dac_override, fowner, fsetid, kill, setgid, setuid, setpcap,
|
||||||
|
net_bind_service, net_raw, sys_chroot, mknod, audit_write, setfcap
|
||||||
|
```
|
||||||
|
|
||||||
|
No `CAP_SYS_ADMIN`. That is the whole story, and the chain is:
|
||||||
|
|
||||||
|
1. The kernel's `map_write()` gates writing a `uid_map` on
|
||||||
|
`file_ns_capable(file, ns, CAP_SYS_ADMIN)` — capability over the
|
||||||
|
**new** user namespace, evaluated against the credentials that opened
|
||||||
|
`/proc/<pid>/uid_map`.
|
||||||
|
2. `newuidmap` is setuid-root, so it runs with euid 0 — but its
|
||||||
|
capability sets are clamped by the bounding set, which has no
|
||||||
|
`CAP_SYS_ADMIN`.
|
||||||
|
3. `cap_capable()` has a shortcut that grants *all* capabilities when
|
||||||
|
the caller's userns is the new namespace's parent **and**
|
||||||
|
`ns->owner == cred->euid`. It does not apply: the namespace was
|
||||||
|
created by `node` (uid 1000) while `newuidmap` runs as euid 0.
|
||||||
|
4. So the check falls through to the effective-set test in the initial
|
||||||
|
userns, which fails. `EPERM`.
|
||||||
|
|
||||||
|
Note that the single-line unprivileged path (`unshare -U -r`) works
|
||||||
|
precisely because it does not go through `newuidmap` and does not need
|
||||||
|
`CAP_SYS_ADMIN`. Only the multi-range subuid mapping that rootless
|
||||||
|
Docker requires does.
|
||||||
|
|
||||||
|
This is the same constraint that makes upstream's `dind-rootless` image
|
||||||
|
require `--privileged`. It is not specific to Apple Container, except
|
||||||
|
that Apple Container gives us no bounding set that includes
|
||||||
|
`CAP_SYS_ADMIN` by default.
|
||||||
|
|
||||||
|
## It does work with the capability — which is the point
|
||||||
|
|
||||||
|
Adding the capability clears the failure immediately, and exposes one
|
||||||
|
further, much smaller blocker: `/dev/net/tun` exists (the kernel has
|
||||||
|
tun; `/proc/misc` lists `200 tun`) but Apple Container creates it
|
||||||
|
`crw------- root root`, so uid 1000 cannot open it and `slirp4netns`
|
||||||
|
fails with `open: Permission denied`. A `chmod 0666 /dev/net/tun` as
|
||||||
|
root inside the bottle fixes that, and needs no capability beyond what
|
||||||
|
the bottle already has.
|
||||||
|
|
||||||
|
With both applied by hand, the daemon comes up completely:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ container run --rm -u root --cap-add CAP_SYS_ADMIN \
|
||||||
|
bot-bottle-claude:latest-rootless-docker sh -c '...'
|
||||||
|
Server Version: 20.10.24+dfsg1
|
||||||
|
Storage Driver: fuse-overlayfs
|
||||||
|
Cgroup Driver: none
|
||||||
|
Cgroup Version: 2
|
||||||
|
API listen on /tmp/rt/docker.sock
|
||||||
|
```
|
||||||
|
|
||||||
|
So `rootless-docker-init.sh` and `rootless_docker.py` are *correct*.
|
||||||
|
The spike did not fail on a bug. It failed on its own premise.
|
||||||
|
|
||||||
|
Two secondary findings from that run, relevant if anyone revisits this:
|
||||||
|
|
||||||
|
- Debian's `docker.io` package pins Docker **20.10** (EOL), not the 28.x
|
||||||
|
implied by the `docker:28-cli` compose plugin the image copies in.
|
||||||
|
- `Cgroup Driver: none` — no resource limits on nested containers.
|
||||||
|
|
||||||
|
## Why we should not just add the capability
|
||||||
|
|
||||||
|
`CAP_SYS_ADMIN` is close to a superset of "root" in practical terms —
|
||||||
|
mount, `pivot_root`, namespace manipulation, and a long tail of
|
||||||
|
subsystem-specific powers. Granting it to the agent bottle would
|
||||||
|
undercut the containment argument the rest of the backend is built
|
||||||
|
around, including the deliberately narrow choices immediately adjacent
|
||||||
|
to it in `launch.py` (`--cap-drop CAP_NET_RAW`, no `NET_ADMIN`, a
|
||||||
|
host-only agent network). Trading all of that for nested `docker
|
||||||
|
compose` is a bad exchange.
|
||||||
|
|
||||||
|
## Podman is not blocked by this
|
||||||
|
|
||||||
|
Sanity-checked on the same host, same kernel, same runtime, so the
|
||||||
|
comparison is apples to apples:
|
||||||
|
|
||||||
|
| Scenario | Result |
|
||||||
|
| --- | --- |
|
||||||
|
| Podman rootless, `/etc/subuid` populated | **Fails identically** — `newuidmap: write to uid_map failed: Operation not permitted` |
|
||||||
|
| Podman rootless, no subuid ranges, `--network=host` | **Works**, no added capabilities |
|
||||||
|
| Podman rootless, no subuid ranges, default netns, `/dev/net/tun` at `0600` | Fails — `slirp4netns: open("/dev/net/tun"): Permission denied` |
|
||||||
|
| Podman rootless, no subuid ranges, default netns, `/dev/net/tun` at `0666` | **Works**, no added capabilities |
|
||||||
|
|
||||||
|
The difference is that podman degrades gracefully when no subuid range
|
||||||
|
is available: it falls back to a single-UID self-mapping, which an
|
||||||
|
unprivileged process may write itself, so `newuidmap` is never invoked
|
||||||
|
and `CAP_SYS_ADMIN` is never needed. Docker's rootless mode has no
|
||||||
|
equivalent fallback.
|
||||||
|
|
||||||
|
The cost of that fallback is real and should be weighed before building
|
||||||
|
on it: with a single-UID mapping, every UID inside a nested container
|
||||||
|
collapses onto the bottle's own uid 1000. There is no UID separation
|
||||||
|
between the agent and anything it runs — `root` in a nested container is
|
||||||
|
the agent user outside it. It also requires `ignore_chown_errors` on the
|
||||||
|
storage driver. Whether that is acceptable depends on whether the bottle
|
||||||
|
boundary (which is unchanged) or the nested-container boundary (which is
|
||||||
|
effectively nil) is the one we are relying on.
|
||||||
|
|
||||||
|
## What the podman spike then needed
|
||||||
|
|
||||||
|
The podman implementation that replaced the Docker one on this branch
|
||||||
|
turned up two more device-node blockers of the same shape as
|
||||||
|
`/dev/net/tun` — Apple Container creates the node, but 0600 root:root:
|
||||||
|
|
||||||
|
- **`/dev/fuse`** — blocks the `fuse-overlayfs` storage driver
|
||||||
|
(`fuse: failed to open /dev/fuse: Permission denied`). Without it the
|
||||||
|
only working driver is `vfs`, which copies whole layers per container.
|
||||||
|
- **`/dev/net/tun`** — blocks `slirp4netns`, which rootless podman uses
|
||||||
|
for the default bridge network.
|
||||||
|
|
||||||
|
Both are fixed by `chmod 0666` as root inside the bottle, which needs no
|
||||||
|
capability the bottle does not already hold. This is categorically
|
||||||
|
different from the `CAP_SYS_ADMIN` requirement: it is a permission on a
|
||||||
|
node that already exists, not an outer privilege grant.
|
||||||
|
|
||||||
|
One design note worth recording: the agent-facing surface stays `docker`
|
||||||
|
and `docker compose`, pointed at podman's Docker-compatible API socket
|
||||||
|
via `DOCKER_HOST`. Setting `netns="host"` in `containers.conf` does *not*
|
||||||
|
propagate through that compat API — stock `docker run` and compose files
|
||||||
|
request bridge networking explicitly — so slirp4netns (and therefore the
|
||||||
|
`/dev/net/tun` chmod) is required for ordinary compose files to work at
|
||||||
|
all. Host networking remains available per-workload via
|
||||||
|
`--network=host`.
|
||||||
|
|
||||||
|
Verified working in a bottle with zero added capabilities: fuse-overlayfs
|
||||||
|
storage, the compat API socket, `docker run` on both bridge and host
|
||||||
|
networking, and published ports.
|
||||||
|
|
||||||
|
### Nested pulls collide with our own egress DLP
|
||||||
|
|
||||||
|
The first live run got podman up and `docker compose` running, then
|
||||||
|
failed on the image pull:
|
||||||
|
|
||||||
|
```
|
||||||
|
web Pulling
|
||||||
|
initializing source docker://python:3.12-alpine: reading manifest ...
|
||||||
|
StatusCode: 403, egress DLP: Generic Bearer JWT found in body
|
||||||
|
```
|
||||||
|
|
||||||
|
This is bot-bottle's own egress scanner, not a podman problem. The
|
||||||
|
Docker registry auth flow carries a bearer JWT *by protocol*, and the
|
||||||
|
`token_patterns` detector's `Generic Bearer JWT` rule
|
||||||
|
(`Bearer\s+[A-Za-z0-9._\-]{50,}`) matches it on every pull. Any bottle
|
||||||
|
that pulls images will hit this.
|
||||||
|
|
||||||
|
The fix is per-route detector scoping, which the egress config already
|
||||||
|
supports — drop `token_patterns` on the registry hosts and keep
|
||||||
|
`known_secrets`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"host": "registry-1.docker.io",
|
||||||
|
"dlp": {"outbound_detectors": ["known_secrets"]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
That is the right trade rather than a grudging one: `known_secrets`
|
||||||
|
matches the bottle's *actual* credential values, so real exfil through a
|
||||||
|
registry host is still caught. `token_patterns` on a registry route only
|
||||||
|
ever produces protocol noise.
|
||||||
|
|
||||||
|
Worth generalising later: any manifest enabling `nested_containers` needs
|
||||||
|
this on its registry routes, so it probably belongs in a shared
|
||||||
|
registry-route snippet rather than being copy-pasted per bottle.
|
||||||
|
|
||||||
|
### And then registry auth collides with the Authorization strip
|
||||||
|
|
||||||
|
With DLP scoped, the pull failed differently: `unauthorized:
|
||||||
|
authentication required`. This one is architectural.
|
||||||
|
|
||||||
|
`egress_addon.py` strips agent-set `Authorization` unconditionally
|
||||||
|
before forwarding — deliberately, so an agent cannot smuggle a
|
||||||
|
credential out in a header the DLP detectors don't recognise. A route
|
||||||
|
may carry gateway-injected auth instead, but only from a *static* token
|
||||||
|
in an env var (`auth_scheme` + `token_env`).
|
||||||
|
|
||||||
|
Docker registry auth doesn't fit that shape. The client fetches a
|
||||||
|
short-lived, per-repository-scope bearer token from `auth.docker.io` and
|
||||||
|
presents it to `registry-1.docker.io`. There is no static token to
|
||||||
|
inject, and the token the client legitimately obtained is stripped.
|
||||||
|
|
||||||
|
Measured inside a bottle, by hand:
|
||||||
|
|
||||||
|
| Step | Result |
|
||||||
|
| --- | --- |
|
||||||
|
| Fetch token from `auth.docker.io` | 200, 5409-byte token body |
|
||||||
|
| Manifest request **with** that valid token | 401 |
|
||||||
|
| Manifest request with **no** Authorization | 401 — identical |
|
||||||
|
|
||||||
|
A valid token behaves exactly like sending none, which is direct
|
||||||
|
evidence the header never arrives. Any nested-container workflow that
|
||||||
|
pulls from a registry is blocked on this, so it is not a detail that can
|
||||||
|
be deferred: pulling base images is most of what nested containers are
|
||||||
|
for.
|
||||||
|
|
||||||
|
### Registries that skip the token dance work today
|
||||||
|
|
||||||
|
Not every registry needs the stripped header. Measured directly:
|
||||||
|
|
||||||
|
| Registry | Manifest request with no `Authorization` |
|
||||||
|
| --- | --- |
|
||||||
|
| `quay.io` | 200 |
|
||||||
|
| `mcr.microsoft.com` | 200 |
|
||||||
|
| `registry.k8s.io` | 307 (redirect, no auth) |
|
||||||
|
| `ghcr.io` | 401 |
|
||||||
|
| `registry-1.docker.io` | 401 |
|
||||||
|
|
||||||
|
So "just add the registry to the bottle config" genuinely works — for
|
||||||
|
quay, MCR, registry.k8s.io, or any unauthenticated internal registry.
|
||||||
|
Docker Hub and GHCR are the ones that need the strip resolved. The
|
||||||
|
acceptance test uses quay for exactly this reason.
|
||||||
|
|
||||||
|
Resolving it for Docker Hub means picking one of:
|
||||||
|
|
||||||
|
1. **Per-route opt-in to preserve client Authorization.** Smallest
|
||||||
|
change. Note the compounding effect on exactly these routes: the DLP
|
||||||
|
scoping above already removed `token_patterns` there, so a
|
||||||
|
preserved-auth registry route is one where the agent may send bearer
|
||||||
|
tokens that neither the strip nor the pattern detector inspects.
|
||||||
|
`known_secrets` still applies, so the bottle's real credentials are
|
||||||
|
still caught.
|
||||||
|
2. **A registry-aware gateway** that performs the token dance itself and
|
||||||
|
injects the result. Preserves the invariant fully; materially more
|
||||||
|
work, and it makes the gateway speak a specific registry protocol.
|
||||||
|
3. **Pre-seed images at provision time** (host-side `container image
|
||||||
|
save` into podman storage), so bottles never pull at runtime.
|
||||||
|
Preserves the invariant, and limits nested containers to
|
||||||
|
pre-approved images — which fits the custody positioning, at the cost
|
||||||
|
of no ad-hoc `docker pull`.
|
||||||
|
4. **Stop.** Nested containers are not supported on this backend.
|
||||||
|
|
||||||
|
### Podman 4.3.1 silently swallows container exit codes
|
||||||
|
|
||||||
|
Debian bookworm — which the current agent base image is built on —
|
||||||
|
ships podman 4.3.1. Through its Docker-compatible API, `docker run`
|
||||||
|
returns 0 no matter what the container did:
|
||||||
|
|
||||||
|
| Command | podman 4.3.1 | podman 5.4.2 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `docker run … sh -c 'exit 7'` (compat API) | **0** | 7 |
|
||||||
|
| `docker run … sh -c 'exit 0'` (compat API) | 0 | 0 |
|
||||||
|
| `podman run … sh -c 'exit 7'` (native) | 7 | 7 |
|
||||||
|
|
||||||
|
This is worse than a broken feature: every failing command an agent runs
|
||||||
|
via `docker run` reports success. A test suite, a build step, or a CI
|
||||||
|
script inside a bottle would pass while failing. It also silently
|
||||||
|
defeated the acceptance test's egress-containment assertion, which is
|
||||||
|
why that assertion now checks an in-band marker rather than an exit
|
||||||
|
code.
|
||||||
|
|
||||||
|
Podman 5.4.2 (Debian trixie) fixes it, but needs two packages that
|
||||||
|
bookworm's podman does not: `passt` (podman 5's default network tool)
|
||||||
|
and `nftables` (netavark shells out to `nft`; without it every run fails
|
||||||
|
with `unable to upgrade to tcp, received 500`). With both installed,
|
||||||
|
exit codes propagate correctly and the compat API behaves.
|
||||||
|
|
||||||
|
The open question this leaves is where podman 5 comes from, since the
|
||||||
|
agent base is bookworm-based:
|
||||||
|
|
||||||
|
1. **Move the agent images to Debian trixie.** Trixie is current stable.
|
||||||
|
Correct, and the blast radius is every bottle, not just this feature.
|
||||||
|
2. **Drop the compat socket and use podman natively** (`podman-docker`
|
||||||
|
provides a `docker` shim; compose comes from `podman-compose`).
|
||||||
|
Native podman propagates exit codes correctly even on 4.3.1. Contained
|
||||||
|
to this feature, at the cost of `docker compose` becoming
|
||||||
|
`docker-compose`/`podman-compose`.
|
||||||
|
3. **Ship bookworm's podman 4.3.1 with the compat socket** — not viable.
|
||||||
|
Silent false success is a correctness bug agents cannot see.
|
||||||
|
|
||||||
|
## Recommendation
|
||||||
|
|
||||||
|
1. Do not revive rootless Docker on this backend. This document is the
|
||||||
|
record of why.
|
||||||
|
2. Nested containers, if wanted, come from podman under the
|
||||||
|
single-mapping constraint — with the explicit understanding that the
|
||||||
|
nested-container boundary carries no security weight. `root` in a
|
||||||
|
nested container is the agent user outside it.
|
||||||
|
3. Nested containers are therefore a build/test convenience. The bottle
|
||||||
|
remains the security boundary, exactly as it was.
|
||||||
@@ -34,6 +34,7 @@ from tests._docker import skip_unless_docker
|
|||||||
# image instead of leaking a new dangling tag on every invocation.
|
# image instead of leaking a new dangling tag on every invocation.
|
||||||
_TEST_ORCHESTRATOR_IMAGE = "bot-bottle-orchestrator:itest"
|
_TEST_ORCHESTRATOR_IMAGE = "bot-bottle-orchestrator:itest"
|
||||||
_TEST_GATEWAY_IMAGE = "bot-bottle-gateway:itest"
|
_TEST_GATEWAY_IMAGE = "bot-bottle-gateway:itest"
|
||||||
|
_TEST_INFRA_IMAGE = "bot-bottle-infra:itest"
|
||||||
|
|
||||||
|
|
||||||
@skip_unless_docker()
|
@skip_unless_docker()
|
||||||
@@ -69,20 +70,17 @@ class TestDockerControlPlaneAuthIntegration(unittest.TestCase):
|
|||||||
os.environ["BOT_BOTTLE_ROOT"] = cls._tmp.name
|
os.environ["BOT_BOTTLE_ROOT"] = cls._tmp.name
|
||||||
cls.addClassCleanup(_restore_root)
|
cls.addClassCleanup(_restore_root)
|
||||||
|
|
||||||
orchestrator_name = f"bot-bottle-orch-itest-{suffix}"
|
infra_name = f"bot-bottle-infra-itest-{suffix}"
|
||||||
gateway_name = f"bot-bottle-gw-itest-{suffix}"
|
|
||||||
network = f"bot-bottle-net-itest-{suffix}"
|
network = f"bot-bottle-net-itest-{suffix}"
|
||||||
host_root = Path(cls._tmp.name)
|
host_root = Path(cls._tmp.name)
|
||||||
cls.addClassCleanup(
|
cls.addClassCleanup(
|
||||||
cls._teardown_docker, orchestrator_name, gateway_name, network, host_root
|
cls._teardown_docker, infra_name, network, host_root
|
||||||
)
|
)
|
||||||
|
|
||||||
cls.svc = OrchestratorService(
|
cls.svc = OrchestratorService(
|
||||||
orchestrator_name=orchestrator_name,
|
infra_name=infra_name,
|
||||||
gateway_name=gateway_name,
|
|
||||||
network=network,
|
network=network,
|
||||||
image=_TEST_ORCHESTRATOR_IMAGE,
|
image=_TEST_INFRA_IMAGE,
|
||||||
gateway_image=_TEST_GATEWAY_IMAGE,
|
|
||||||
port=20000 + secrets.randbelow(10000),
|
port=20000 + secrets.randbelow(10000),
|
||||||
host_root=host_root,
|
host_root=host_root,
|
||||||
)
|
)
|
||||||
@@ -91,23 +89,23 @@ class TestDockerControlPlaneAuthIntegration(unittest.TestCase):
|
|||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _teardown_docker(
|
def _teardown_docker(
|
||||||
orchestrator_name: str, gateway_name: str, network: str, host_root: Path
|
infra_name: str, network: str, host_root: Path
|
||||||
) -> None:
|
) -> None:
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["docker", "rm", "--force", orchestrator_name, gateway_name],
|
["docker", "rm", "--force", infra_name],
|
||||||
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
||||||
)
|
)
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["docker", "network", "rm", network],
|
["docker", "network", "rm", network],
|
||||||
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
||||||
)
|
)
|
||||||
# The orchestrator container (no USER directive) wrote the registry
|
# The infra container (no USER directive) wrote the registry
|
||||||
# DB as root into the throwaway host_root; chown it back so the
|
# DB as root into the throwaway host_root; chown it back so the
|
||||||
# (non-root) tempdir cleanup can remove it. Same workaround
|
# (non-root) tempdir cleanup can remove it. Same workaround
|
||||||
# test_multitenant_isolation.py uses for the identical bind mount.
|
# test_multitenant_isolation.py uses for the identical bind mount.
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["docker", "run", "--rm", "-v", f"{host_root}:/r",
|
["docker", "run", "--rm", "-v", f"{host_root}:/r",
|
||||||
"--entrypoint", "chown", _TEST_GATEWAY_IMAGE, "-R",
|
"--entrypoint", "chown", _TEST_INFRA_IMAGE, "-R",
|
||||||
f"{os.getuid()}:{os.getgid()}", "/r"],
|
f"{os.getuid()}:{os.getgid()}", "/r"],
|
||||||
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -172,7 +172,7 @@ class TestSandboxEscape(unittest.TestCase):
|
|||||||
# base image without producing five confusing
|
# base image without producing five confusing
|
||||||
# command-not-found failures down the suite.
|
# command-not-found failures down the suite.
|
||||||
missing: list[str] = []
|
missing: list[str] = []
|
||||||
for tool in ("curl", "git", "dig"):
|
for tool in ("curl", "git", "dig", "ssh"):
|
||||||
r = cls._bottle.exec(f"command -v {tool} >/dev/null 2>&1")
|
r = cls._bottle.exec(f"command -v {tool} >/dev/null 2>&1")
|
||||||
if r.returncode != 0:
|
if r.returncode != 0:
|
||||||
missing.append(tool)
|
missing.append(tool)
|
||||||
|
|||||||
@@ -9,11 +9,15 @@ import unittest
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from bot_bottle.agent_provider import (
|
from bot_bottle.agent_provider import (
|
||||||
|
CLAUDE_HOST_CREDENTIAL_HOSTS,
|
||||||
CODEX_HOST_CREDENTIAL_HOSTS,
|
CODEX_HOST_CREDENTIAL_HOSTS,
|
||||||
build_agent_provision_plan,
|
build_agent_provision_plan,
|
||||||
prompt_args,
|
prompt_args,
|
||||||
)
|
)
|
||||||
from bot_bottle.egress import CODEX_HOST_CREDENTIAL_TOKEN_REF
|
from bot_bottle.egress import (
|
||||||
|
CLAUDE_HOST_CREDENTIAL_TOKEN_REF,
|
||||||
|
CODEX_HOST_CREDENTIAL_TOKEN_REF,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _jwt(exp: int) -> str:
|
def _jwt(exp: int) -> str:
|
||||||
@@ -292,6 +296,67 @@ class TestAgentProviderRuntime(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual({}, plan.provisioned_env)
|
self.assertEqual({}, plan.provisioned_env)
|
||||||
|
|
||||||
|
def test_claude_forward_host_credentials_populates_egress_route(self):
|
||||||
|
access_token = "sk-ant-oat01-test-key" # gitleaks:allow
|
||||||
|
with tempfile.TemporaryDirectory(prefix="bb-provider.") as tmp:
|
||||||
|
home = Path(tmp) / "host-claude"
|
||||||
|
cred_dir = home / ".claude"
|
||||||
|
cred_dir.mkdir(parents=True)
|
||||||
|
(cred_dir / ".credentials.json").write_text(json.dumps({
|
||||||
|
"claudeAiOauth": {"accessToken": access_token},
|
||||||
|
}))
|
||||||
|
plan = build_agent_provision_plan(
|
||||||
|
template="claude",
|
||||||
|
dockerfile="",
|
||||||
|
state_dir=Path(tmp),
|
||||||
|
instance_name="bot-bottle-test",
|
||||||
|
prompt_file=Path(tmp) / "prompt.txt",
|
||||||
|
forward_host_credentials=True,
|
||||||
|
host_env={"HOME": str(home)},
|
||||||
|
)
|
||||||
|
self.assertEqual(1, len(plan.egress_routes))
|
||||||
|
route = plan.egress_routes[0]
|
||||||
|
self.assertIn(route.host, CLAUDE_HOST_CREDENTIAL_HOSTS)
|
||||||
|
self.assertEqual("Bearer", route.auth_scheme)
|
||||||
|
self.assertEqual(CLAUDE_HOST_CREDENTIAL_TOKEN_REF, route.token_ref)
|
||||||
|
self.assertEqual("egress-placeholder", plan.env_vars["CLAUDE_CODE_OAUTH_TOKEN"])
|
||||||
|
self.assertEqual(frozenset({"CLAUDE_CODE_OAUTH_TOKEN"}), plan.hidden_env_names)
|
||||||
|
|
||||||
|
def test_claude_forward_host_credentials_populates_provisioned_env(self):
|
||||||
|
access_token = "sk-ant-oat01-test-key" # gitleaks:allow
|
||||||
|
with tempfile.TemporaryDirectory(prefix="bb-provider.") as tmp:
|
||||||
|
home = Path(tmp) / "host-claude"
|
||||||
|
cred_dir = home / ".claude"
|
||||||
|
cred_dir.mkdir(parents=True)
|
||||||
|
(cred_dir / ".credentials.json").write_text(json.dumps({
|
||||||
|
"claudeAiOauth": {"accessToken": access_token},
|
||||||
|
}))
|
||||||
|
plan = build_agent_provision_plan(
|
||||||
|
template="claude",
|
||||||
|
dockerfile="",
|
||||||
|
state_dir=Path(tmp),
|
||||||
|
instance_name="bot-bottle-test",
|
||||||
|
prompt_file=Path(tmp) / "prompt.txt",
|
||||||
|
forward_host_credentials=True,
|
||||||
|
host_env={"HOME": str(home)},
|
||||||
|
)
|
||||||
|
self.assertEqual(
|
||||||
|
{CLAUDE_HOST_CREDENTIAL_TOKEN_REF: access_token},
|
||||||
|
plan.provisioned_env,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_claude_without_forward_host_credentials_has_empty_provisioned_env(self):
|
||||||
|
with tempfile.TemporaryDirectory(prefix="bb-provider.") as tmp:
|
||||||
|
plan = build_agent_provision_plan(
|
||||||
|
template="claude",
|
||||||
|
dockerfile="",
|
||||||
|
state_dir=Path(tmp),
|
||||||
|
instance_name="bot-bottle-test",
|
||||||
|
prompt_file=Path(tmp) / "prompt.txt",
|
||||||
|
forward_host_credentials=False,
|
||||||
|
)
|
||||||
|
self.assertEqual({}, plan.provisioned_env)
|
||||||
|
|
||||||
def test_pi_plan_writes_default_ollama_models(self):
|
def test_pi_plan_writes_default_ollama_models(self):
|
||||||
with tempfile.TemporaryDirectory(prefix="bb-provider.") as tmp:
|
with tempfile.TemporaryDirectory(prefix="bb-provider.") as tmp:
|
||||||
plan = build_agent_provision_plan(
|
plan = build_agent_provision_plan(
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ from bot_bottle.backend.firecracker import FirecrackerBottleBackend
|
|||||||
from bot_bottle.manifest import ManifestIndex
|
from bot_bottle.manifest import ManifestIndex
|
||||||
|
|
||||||
|
|
||||||
def _manifest() -> ManifestIndex:
|
def _manifest(*, nested_containers: bool = False) -> ManifestIndex:
|
||||||
return ManifestIndex.from_json_obj({
|
return ManifestIndex.from_json_obj({
|
||||||
"bottles": {
|
"bottles": {
|
||||||
"dev": {
|
"dev": {
|
||||||
@@ -29,6 +29,7 @@ def _manifest() -> ManifestIndex:
|
|||||||
"LITERAL_ENV": "literal-value",
|
"LITERAL_ENV": "literal-value",
|
||||||
"FORWARDED_ENV": "${HOST_SECRET_ENV}",
|
"FORWARDED_ENV": "${HOST_SECRET_ENV}",
|
||||||
},
|
},
|
||||||
|
"nested_containers": nested_containers,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
"agents": {
|
"agents": {
|
||||||
@@ -41,9 +42,11 @@ def _manifest() -> ManifestIndex:
|
|||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
def _spec(tmp: Path, *, identity: str) -> BottleSpec:
|
def _spec(
|
||||||
|
tmp: Path, *, identity: str, nested_containers: bool = False,
|
||||||
|
) -> BottleSpec:
|
||||||
return BottleSpec(
|
return BottleSpec(
|
||||||
manifest=_manifest(),
|
manifest=_manifest(nested_containers=nested_containers),
|
||||||
agent_name="demo",
|
agent_name="demo",
|
||||||
copy_cwd=False,
|
copy_cwd=False,
|
||||||
user_cwd=str(tmp),
|
user_cwd=str(tmp),
|
||||||
@@ -113,6 +116,42 @@ class TestFirecrackerPrepare(_FakeStateMixin, unittest.TestCase):
|
|||||||
self.assertEqual({"FORWARDED_ENV": "secret-value"}, plan.forwarded_env)
|
self.assertEqual({"FORWARDED_ENV": "secret-value"}, plan.forwarded_env)
|
||||||
|
|
||||||
|
|
||||||
|
class TestNestedContainersRejection(_FakeStateMixin, unittest.TestCase):
|
||||||
|
"""A backend with no guest-local engine must refuse the flag outright.
|
||||||
|
|
||||||
|
Ignoring it would leave the agent without `docker`, and the only ways to
|
||||||
|
fake it here (a host daemon socket, a privileged container) are what
|
||||||
|
issue #392 rules out.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_docker_backend_refuses_the_flag(self) -> None:
|
||||||
|
backend = DockerBottleBackend()
|
||||||
|
spec = _spec(
|
||||||
|
Path(self.tmp.name), identity="demo-docker", nested_containers=True,
|
||||||
|
)
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.resolve_common.die", side_effect=RuntimeError,
|
||||||
|
) as die,
|
||||||
|
self.assertRaises(RuntimeError),
|
||||||
|
):
|
||||||
|
backend.prepare(spec, Path(self.tmp.name) / "stage")
|
||||||
|
self.assertIn("nested_containers", die.call_args.args[0])
|
||||||
|
self.assertIn("docker", die.call_args.args[0])
|
||||||
|
|
||||||
|
def test_firecracker_backend_refuses_the_flag(self) -> None:
|
||||||
|
backend = FirecrackerBottleBackend()
|
||||||
|
spec = _spec(Path(self.tmp.name), identity="demo-fc", nested_containers=True)
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.resolve_common.die", side_effect=RuntimeError,
|
||||||
|
) as die,
|
||||||
|
self.assertRaises(RuntimeError),
|
||||||
|
):
|
||||||
|
backend.prepare(spec, Path(self.tmp.name) / "stage")
|
||||||
|
self.assertIn("firecracker", die.call_args.args[0])
|
||||||
|
|
||||||
|
|
||||||
class TestMintSlug(unittest.TestCase):
|
class TestMintSlug(unittest.TestCase):
|
||||||
def _spec(self, *, label: str = "", identity: str = "") -> BottleSpec:
|
def _spec(self, *, label: str = "", identity: str = "") -> BottleSpec:
|
||||||
manifest = _manifest()
|
manifest = _manifest()
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
"""Unit: shared cross-backend helpers in backend/util.py."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from bot_bottle.backend import util as backend_util
|
||||||
|
|
||||||
|
|
||||||
|
class TestPollCaCert(unittest.TestCase):
|
||||||
|
def test_returns_pem_on_first_success(self) -> None:
|
||||||
|
result = backend_util.poll_ca_cert(lambda: "PEM", timeout=1.0)
|
||||||
|
self.assertEqual("PEM", result)
|
||||||
|
|
||||||
|
def test_raises_timeout_error_when_cert_never_appears(self) -> None:
|
||||||
|
with self.assertRaises(TimeoutError):
|
||||||
|
backend_util.poll_ca_cert(lambda: None, timeout=0.0)
|
||||||
|
|
||||||
|
def test_polls_until_cert_appears(self) -> None:
|
||||||
|
responses = iter([None, None, "-----BEGIN CERTIFICATE-----\n"])
|
||||||
|
with patch("bot_bottle.backend.util.time.sleep") as mock_sleep:
|
||||||
|
result = backend_util.poll_ca_cert(lambda: next(responses), timeout=5.0)
|
||||||
|
self.assertTrue(result.startswith("-----BEGIN CERTIFICATE-----"))
|
||||||
|
self.assertEqual(2, mock_sleep.call_count)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
"""Unit contracts shared by all built-in agent images."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import re
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
_CONTRIB_DIR = Path(__file__).resolve().parents[2] / "bot_bottle/contrib"
|
||||||
|
_AGENT_DOCKERFILES = tuple(sorted(_CONTRIB_DIR.glob("*/Dockerfile")))
|
||||||
|
|
||||||
|
|
||||||
|
class TestBuiltinAgentImages(unittest.TestCase):
|
||||||
|
def test_all_use_debian_trixie_stable(self):
|
||||||
|
self.assertTrue(_AGENT_DOCKERFILES)
|
||||||
|
for dockerfile in _AGENT_DOCKERFILES:
|
||||||
|
with self.subTest(provider=dockerfile.parent.name):
|
||||||
|
self.assertRegex(
|
||||||
|
dockerfile.read_text(),
|
||||||
|
r"(?m)^FROM node:22-trixie-slim\s*$",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_all_install_podman(self):
|
||||||
|
for dockerfile in _AGENT_DOCKERFILES:
|
||||||
|
with self.subTest(provider=dockerfile.parent.name):
|
||||||
|
self.assertRegex(
|
||||||
|
dockerfile.read_text(),
|
||||||
|
re.compile(r"(?m)^\s*podman(?:\s|\\|$)"),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_all_install_ssh_client(self):
|
||||||
|
for dockerfile in _AGENT_DOCKERFILES:
|
||||||
|
with self.subTest(provider=dockerfile.parent.name):
|
||||||
|
self.assertRegex(
|
||||||
|
dockerfile.read_text(),
|
||||||
|
re.compile(r"(?m)^\s*openssh-client(?:\s|\\|$)"),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_all_prepare_node_git_config_directory(self):
|
||||||
|
for dockerfile in _AGENT_DOCKERFILES:
|
||||||
|
with self.subTest(provider=dockerfile.parent.name):
|
||||||
|
dockerfile_text = dockerfile.read_text()
|
||||||
|
self.assertIn("install -d -o node -g node", dockerfile_text)
|
||||||
|
self.assertIn("/home/node/.config/git", dockerfile_text)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -0,0 +1,268 @@
|
|||||||
|
"""Unit tests for bb login command."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
import urllib.error
|
||||||
|
from email.message import Message
|
||||||
|
from typing import Any
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
|
||||||
|
class TestFlagParsing(unittest.TestCase):
|
||||||
|
def test_console_url_flag(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _flag
|
||||||
|
self.assertEqual(_flag(["--console-url", "http://x"], "--console-url"), "http://x")
|
||||||
|
|
||||||
|
def test_console_url_equals_form(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _flag
|
||||||
|
self.assertEqual(
|
||||||
|
_flag(["--console-url=http://x"], "--console-url"), "http://x"
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_label_flag(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _flag
|
||||||
|
self.assertEqual(_flag(["--label", "my-mac"], "--label"), "my-mac")
|
||||||
|
|
||||||
|
def test_missing_flag_returns_none(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _flag
|
||||||
|
self.assertIsNone(_flag([], "--console-url"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestHttpHelpers(unittest.TestCase):
|
||||||
|
def test_post_sends_json_and_decodes_response(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _post
|
||||||
|
|
||||||
|
response = MagicMock()
|
||||||
|
response.__enter__.return_value.read.return_value = b'{"ok": true}'
|
||||||
|
with patch("urllib.request.urlopen", return_value=response) as urlopen:
|
||||||
|
self.assertEqual(
|
||||||
|
_post("http://console/start", {"label": "host"}), {"ok": True}
|
||||||
|
)
|
||||||
|
|
||||||
|
request = urlopen.call_args.args[0]
|
||||||
|
self.assertEqual(request.data, b'{"label": "host"}')
|
||||||
|
self.assertEqual(request.get_header("Content-type"), "application/json")
|
||||||
|
|
||||||
|
def test_get_decodes_success_response(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _get
|
||||||
|
|
||||||
|
response = MagicMock()
|
||||||
|
response.__enter__.return_value.status = 200
|
||||||
|
response.__enter__.return_value.read.return_value = b'{"status": "pending"}'
|
||||||
|
with patch("urllib.request.urlopen", return_value=response):
|
||||||
|
self.assertEqual(
|
||||||
|
_get("http://console/status"), (200, {"status": "pending"})
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_get_returns_http_error_status(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _get
|
||||||
|
|
||||||
|
error = urllib.error.HTTPError(
|
||||||
|
"http://console/status", 410, "gone", Message(), None
|
||||||
|
)
|
||||||
|
with patch("urllib.request.urlopen", side_effect=error):
|
||||||
|
self.assertEqual(_get("http://console/status"), (410, {}))
|
||||||
|
|
||||||
|
|
||||||
|
class TestSaveCredentials(unittest.TestCase):
|
||||||
|
def test_writes_json_and_sets_perms(self) -> None:
|
||||||
|
from bot_bottle.cli.login import _save_credentials
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
path = _save_credentials("http://c", "hid", "at", "rt")
|
||||||
|
self.assertTrue(path.exists())
|
||||||
|
data = json.loads(path.read_text())
|
||||||
|
self.assertEqual(data["url"], "http://c")
|
||||||
|
self.assertEqual(data["host_id"], "hid")
|
||||||
|
self.assertEqual(data["access_token"], "at")
|
||||||
|
self.assertEqual(data["refresh_token"], "rt")
|
||||||
|
self.assertEqual(oct(path.stat().st_mode & 0o777), oct(0o600))
|
||||||
|
|
||||||
|
def test_temp_file_is_private_before_replace(self) -> None:
|
||||||
|
"""Temp file must be 0600 at the moment os.replace is called."""
|
||||||
|
from bot_bottle.cli.login import _save_credentials
|
||||||
|
from pathlib import Path as _Path
|
||||||
|
|
||||||
|
tmp_perms_at_replace: list[int] = []
|
||||||
|
real_replace = os.replace
|
||||||
|
|
||||||
|
def _spy_replace(
|
||||||
|
src: str | os.PathLike[str], dst: str | os.PathLike[str]
|
||||||
|
) -> None:
|
||||||
|
tmp_perms_at_replace.append(_Path(src).stat().st_mode & 0o777)
|
||||||
|
real_replace(src, dst)
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
with patch("os.replace", side_effect=_spy_replace):
|
||||||
|
path = _save_credentials("http://c", "hid", "at", "rt")
|
||||||
|
self.assertEqual(len(tmp_perms_at_replace), 1)
|
||||||
|
self.assertEqual(oct(tmp_perms_at_replace[0]), oct(0o600))
|
||||||
|
self.assertEqual(oct(path.stat().st_mode & 0o777), oct(0o600))
|
||||||
|
|
||||||
|
def test_cleanup_on_write_failure(self) -> None:
|
||||||
|
"""Temp file is removed and no credentials remain if replace fails."""
|
||||||
|
from bot_bottle.cli.login import _save_credentials
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
with patch("os.replace", side_effect=OSError("disk full")):
|
||||||
|
with self.assertRaises(OSError):
|
||||||
|
_save_credentials("http://c", "hid", "at", "rt")
|
||||||
|
leftovers = [f for f in os.listdir(tmp) if f.startswith(".console-")]
|
||||||
|
self.assertEqual(leftovers, [])
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdLoginMissingUrl(unittest.TestCase):
|
||||||
|
def test_help_returns_0(self) -> None:
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
|
||||||
|
self.assertEqual(cmd_login(["--help"]), 0)
|
||||||
|
|
||||||
|
def test_returns_1_without_url(self) -> None:
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
with patch.dict(os.environ, {}, clear=True):
|
||||||
|
os.environ.pop("BB_CONSOLE_URL", None)
|
||||||
|
result = cmd_login([])
|
||||||
|
self.assertEqual(result, 1)
|
||||||
|
|
||||||
|
def test_reads_env_var(self) -> None:
|
||||||
|
"""Exits 1 (network error) not because of missing URL when env var is set."""
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
|
||||||
|
def _fail_post(_url: str, _payload: dict[str, Any]) -> dict[str, Any]:
|
||||||
|
raise OSError("connection refused")
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(
|
||||||
|
os.environ,
|
||||||
|
{
|
||||||
|
"BB_CONSOLE_URL": "http://localhost:9999",
|
||||||
|
"BOT_BOTTLE_ROOT": tmp,
|
||||||
|
},
|
||||||
|
):
|
||||||
|
with patch("bot_bottle.cli.login._post", side_effect=_fail_post):
|
||||||
|
result = cmd_login([])
|
||||||
|
self.assertEqual(result, 1)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdLoginFlow(unittest.TestCase):
|
||||||
|
def _run_with_mocks(
|
||||||
|
self, poll_responses: list[dict[str, Any]], tmp: str
|
||||||
|
) -> int:
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
|
||||||
|
start_resp = {
|
||||||
|
"device_code": "dc123",
|
||||||
|
"user_code": "ABC-DEF",
|
||||||
|
"expires_in": 300,
|
||||||
|
"poll_interval": 0,
|
||||||
|
}
|
||||||
|
|
||||||
|
poll_iter = iter(poll_responses)
|
||||||
|
|
||||||
|
def _fake_post(
|
||||||
|
_url: str, _payload: dict[str, Any]
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
return start_resp
|
||||||
|
|
||||||
|
def _fake_get(_url: str) -> tuple[int, dict[str, Any]]:
|
||||||
|
return 200, next(poll_iter, {"status": "pending"})
|
||||||
|
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
with patch("bot_bottle.cli.login._post", side_effect=_fake_post):
|
||||||
|
with patch("bot_bottle.cli.login._get", side_effect=_fake_get):
|
||||||
|
with patch("time.sleep"):
|
||||||
|
return cmd_login(["--console-url", "http://console"])
|
||||||
|
|
||||||
|
def test_approved_flow_returns_0(self) -> None:
|
||||||
|
approved = {
|
||||||
|
"status": "approved",
|
||||||
|
"host_id": "hid",
|
||||||
|
"access_token": "at",
|
||||||
|
"refresh_token": "rt",
|
||||||
|
}
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
result = self._run_with_mocks(
|
||||||
|
[{"status": "pending"}, approved], tmp
|
||||||
|
)
|
||||||
|
self.assertEqual(result, 0)
|
||||||
|
with open(os.path.join(tmp, "console.json"), encoding="utf-8") as f:
|
||||||
|
creds = json.loads(f.read())
|
||||||
|
self.assertEqual(creds["host_id"], "hid")
|
||||||
|
|
||||||
|
def test_denied_flow_returns_1(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
result = self._run_with_mocks([{"status": "denied"}], tmp)
|
||||||
|
self.assertEqual(result, 1)
|
||||||
|
|
||||||
|
def test_timeout_returns_1(self) -> None:
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
|
||||||
|
start_resp = {
|
||||||
|
"device_code": "dc",
|
||||||
|
"user_code": "ZZZ-ZZZ",
|
||||||
|
"expires_in": 0, # already expired; loop never runs
|
||||||
|
"poll_interval": 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
with patch("bot_bottle.cli.login._post", return_value=start_resp):
|
||||||
|
result = cmd_login(["--console-url", "http://console"])
|
||||||
|
self.assertEqual(result, 1)
|
||||||
|
|
||||||
|
def test_poll_interval_from_server_is_used(self) -> None:
|
||||||
|
"""time.sleep must be called with the server-provided poll_interval."""
|
||||||
|
from bot_bottle.cli.login import cmd_login
|
||||||
|
|
||||||
|
server_interval = 7
|
||||||
|
start_resp = {
|
||||||
|
"device_code": "dc",
|
||||||
|
"user_code": "ABC-DEF",
|
||||||
|
"expires_in": 300,
|
||||||
|
"poll_interval": server_interval,
|
||||||
|
}
|
||||||
|
approved = {
|
||||||
|
"status": "approved",
|
||||||
|
"host_id": "hid",
|
||||||
|
"access_token": "at",
|
||||||
|
"refresh_token": "rt",
|
||||||
|
}
|
||||||
|
poll_iter = iter([{"status": "pending"}, approved])
|
||||||
|
|
||||||
|
def _fake_get(_url: str) -> tuple[int, dict[str, str]]:
|
||||||
|
return 200, next(poll_iter)
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_ROOT": tmp}):
|
||||||
|
with patch("bot_bottle.cli.login._post", return_value=start_resp):
|
||||||
|
with patch(
|
||||||
|
"bot_bottle.cli.login._get", side_effect=_fake_get
|
||||||
|
):
|
||||||
|
with patch("time.sleep") as mock_sleep:
|
||||||
|
result = cmd_login(["--console-url", "http://console"])
|
||||||
|
|
||||||
|
self.assertEqual(result, 0)
|
||||||
|
self.assertTrue(mock_sleep.called)
|
||||||
|
for call in mock_sleep.call_args_list:
|
||||||
|
self.assertEqual(call.args[0], server_interval)
|
||||||
|
|
||||||
|
|
||||||
|
class TestDispatcherRegistration(unittest.TestCase):
|
||||||
|
def test_login_in_commands(self) -> None:
|
||||||
|
from bot_bottle.cli import COMMANDS
|
||||||
|
self.assertIn("login", COMMANDS)
|
||||||
|
|
||||||
|
def test_login_in_no_migration(self) -> None:
|
||||||
|
from bot_bottle.cli import NO_MIGRATION_COMMANDS
|
||||||
|
self.assertIn("login", NO_MIGRATION_COMMANDS)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
"""The CLI package is runnable as `python -m bot_bottle.cli`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
|
||||||
|
|
||||||
|
def _run(*args: str) -> subprocess.CompletedProcess[str]:
|
||||||
|
return subprocess.run(
|
||||||
|
[sys.executable, "-m", "bot_bottle.cli", *args],
|
||||||
|
cwd=_REPO_ROOT,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestModuleEntry(unittest.TestCase):
|
||||||
|
def test_help_exits_zero(self) -> None:
|
||||||
|
result = _run("--help")
|
||||||
|
self.assertEqual(result.returncode, 0, result.stderr)
|
||||||
|
self.assertIn("login", result.stderr)
|
||||||
|
|
||||||
|
def test_no_args_prints_usage(self) -> None:
|
||||||
|
# main() returns 2 with no command, matching the cli.py entry point.
|
||||||
|
self.assertEqual(_run().returncode, 2)
|
||||||
|
|
||||||
|
def test_subcommand_help_reaches_handler(self) -> None:
|
||||||
|
result = _run("login", "--help")
|
||||||
|
self.assertEqual(result.returncode, 0, result.stderr)
|
||||||
|
self.assertIn("--console-url", result.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -176,6 +176,18 @@ class TestCmdStartHeadless(unittest.TestCase):
|
|||||||
self.assertEqual("researcher-2", self._spec().label)
|
self.assertEqual("researcher-2", self._spec().label)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cached_images_sets_cached_policy(self):
|
||||||
|
start_mod.cmd_start(
|
||||||
|
["--headless", "--cached-images", "researcher", "--bottle", "claude",
|
||||||
|
"--prompt", "Do it"]
|
||||||
|
)
|
||||||
|
self.assertEqual("cached", self._spec().image_policy)
|
||||||
|
|
||||||
|
def test_cached_images_requires_headless(self):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
start_mod.cmd_start(["--cached-images", "researcher"])
|
||||||
|
self._launch_mock.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
class TestPrepareWithPreflight(unittest.TestCase):
|
class TestPrepareWithPreflight(unittest.TestCase):
|
||||||
"""prepare_with_preflight calls render_preflight with the plan and backend name."""
|
"""prepare_with_preflight calls render_preflight with the plan and backend name."""
|
||||||
|
|||||||
@@ -65,6 +65,12 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
self._modal_patch.start()
|
self._modal_patch.start()
|
||||||
|
|
||||||
|
self._image_policy_patch = patch(
|
||||||
|
"bot_bottle.cli.start._select_image_policy",
|
||||||
|
return_value="fresh",
|
||||||
|
)
|
||||||
|
self._image_policy_patch.start()
|
||||||
|
|
||||||
self._env_patch = patch.dict(os.environ, {}, clear=False)
|
self._env_patch = patch.dict(os.environ, {}, clear=False)
|
||||||
self._env_patch.start()
|
self._env_patch.start()
|
||||||
os.environ.pop("BOT_BOTTLE_BACKEND", None)
|
os.environ.pop("BOT_BOTTLE_BACKEND", None)
|
||||||
@@ -75,6 +81,7 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
self._agent_picker_patch.stop()
|
self._agent_picker_patch.stop()
|
||||||
self._bottle_picker_patch.stop()
|
self._bottle_picker_patch.stop()
|
||||||
self._modal_patch.stop()
|
self._modal_patch.stop()
|
||||||
|
self._image_policy_patch.stop()
|
||||||
self._env_patch.stop()
|
self._env_patch.stop()
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
@@ -133,6 +140,19 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
spec = self._launch_mock.call_args[0][0]
|
spec = self._launch_mock.call_args[0][0]
|
||||||
self.assertEqual(("claude", "dev"), spec.bottle_names)
|
self.assertEqual(("claude", "dev"), spec.bottle_names)
|
||||||
|
|
||||||
|
def test_image_policy_forwarded_to_spec(self):
|
||||||
|
with patch("bot_bottle.cli.start._select_image_policy", return_value="cached"):
|
||||||
|
start_mod.cmd_start(["researcher"])
|
||||||
|
self._launch_mock.assert_called_once()
|
||||||
|
spec = self._launch_mock.call_args[0][0]
|
||||||
|
self.assertEqual("cached", spec.image_policy)
|
||||||
|
|
||||||
|
def test_image_policy_cancel_returns_0(self):
|
||||||
|
with patch("bot_bottle.cli.start._select_image_policy", return_value=None):
|
||||||
|
rc = start_mod.cmd_start(["researcher"])
|
||||||
|
self.assertEqual(0, rc)
|
||||||
|
self._launch_mock.assert_not_called()
|
||||||
|
|
||||||
def test_empty_bottle_selection_forwarded(self):
|
def test_empty_bottle_selection_forwarded(self):
|
||||||
self._bottle_picker_mock.return_value = []
|
self._bottle_picker_mock.return_value = []
|
||||||
start_mod.cmd_start(["researcher"])
|
start_mod.cmd_start(["researcher"])
|
||||||
@@ -214,6 +234,7 @@ class TestCmdStartLabelCollision(unittest.TestCase):
|
|||||||
).start()
|
).start()
|
||||||
# Stub the bottle picker to always return a selection.
|
# Stub the bottle picker to always return a selection.
|
||||||
patch.object(tui_mod, "filter_multiselect", return_value=["claude"]).start()
|
patch.object(tui_mod, "filter_multiselect", return_value=["claude"]).start()
|
||||||
|
patch("bot_bottle.cli.start._select_image_policy", return_value="fresh").start()
|
||||||
self.addCleanup(patch.stopall)
|
self.addCleanup(patch.stopall)
|
||||||
|
|
||||||
def test_no_collision_proceeds_without_reprompt(self):
|
def test_no_collision_proceeds_without_reprompt(self):
|
||||||
|
|||||||
@@ -0,0 +1,146 @@
|
|||||||
|
"""Unit: _launch_bottle StaleImageError handling.
|
||||||
|
|
||||||
|
Exercises prelaunch_checks / backend.launch flow:
|
||||||
|
- headless mode → die on stale
|
||||||
|
- interactive mode, user declines → stop without launching
|
||||||
|
- interactive mode, user confirms → skip stale check and launch once
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import io
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from typing import Any, cast
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from bot_bottle.image_cache import StaleImageError
|
||||||
|
from bot_bottle.log import Die
|
||||||
|
|
||||||
|
|
||||||
|
def _fake_plan() -> Any:
|
||||||
|
provision = SimpleNamespace(startup_args=())
|
||||||
|
return cast(Any, SimpleNamespace(
|
||||||
|
agent_provision=provision,
|
||||||
|
agent_provider_template="claude",
|
||||||
|
slug="dev-abc",
|
||||||
|
))
|
||||||
|
|
||||||
|
|
||||||
|
def _ok_cm(bottle: Any) -> MagicMock:
|
||||||
|
"""Return a context-manager mock that yields `bottle`."""
|
||||||
|
cm = MagicMock()
|
||||||
|
cm.__enter__ = MagicMock(return_value=bottle)
|
||||||
|
cm.__exit__ = MagicMock(return_value=False)
|
||||||
|
return cm
|
||||||
|
|
||||||
|
|
||||||
|
class TestLaunchBottleStaleHandling(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self._tmp = tempfile.mkdtemp(prefix="cli-stale-test.")
|
||||||
|
|
||||||
|
def _spec(self) -> Any:
|
||||||
|
from bot_bottle.backend import BottleSpec
|
||||||
|
from bot_bottle.manifest import ManifestIndex
|
||||||
|
idx = ManifestIndex.from_json_obj({
|
||||||
|
"bottles": {"dev": {}},
|
||||||
|
"agents": {"demo": {"skills": [], "prompt": "", "bottle": "dev"}},
|
||||||
|
})
|
||||||
|
return BottleSpec(
|
||||||
|
manifest=idx,
|
||||||
|
agent_name="demo",
|
||||||
|
copy_cwd=False,
|
||||||
|
user_cwd=self._tmp,
|
||||||
|
identity="dev-abc",
|
||||||
|
)
|
||||||
|
|
||||||
|
def _run_launch(self, **patch_kwargs: Any) -> int:
|
||||||
|
import bot_bottle.cli.start as start_mod
|
||||||
|
spec = self._spec()
|
||||||
|
with patch.object(start_mod, "prepare_with_preflight",
|
||||||
|
return_value=(_fake_plan(), "dev-abc")), \
|
||||||
|
patch.object(start_mod, "settle_state"), \
|
||||||
|
patch.object(start_mod, "info"):
|
||||||
|
return start_mod._launch_bottle(
|
||||||
|
spec,
|
||||||
|
dry_run=False,
|
||||||
|
backend_name="docker",
|
||||||
|
**patch_kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_headless_stale_calls_die(self) -> None:
|
||||||
|
"""In headless mode (assume_yes=True), a StaleImageError from prelaunch_checks must call die()."""
|
||||||
|
import bot_bottle.cli.start as start_mod
|
||||||
|
|
||||||
|
backend_mock = MagicMock()
|
||||||
|
backend_mock.prelaunch_checks.side_effect = StaleImageError("image is 5 day(s) old")
|
||||||
|
|
||||||
|
with patch.object(start_mod, "get_bottle_backend", return_value=backend_mock), \
|
||||||
|
patch.object(start_mod, "die", side_effect=Die()):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
self._run_launch(assume_yes=True)
|
||||||
|
|
||||||
|
backend_mock.launch.assert_not_called()
|
||||||
|
|
||||||
|
def test_interactive_user_declines_stops_before_launch(self) -> None:
|
||||||
|
"""Interactive user answering 'n' → launch is never called."""
|
||||||
|
import bot_bottle.cli.start as start_mod
|
||||||
|
|
||||||
|
backend_mock = MagicMock()
|
||||||
|
backend_mock.prelaunch_checks.side_effect = StaleImageError("image is 5 day(s) old")
|
||||||
|
|
||||||
|
with patch.object(start_mod, "get_bottle_backend", return_value=backend_mock), \
|
||||||
|
patch.object(start_mod, "read_tty_line", return_value="n"), \
|
||||||
|
patch("sys.stderr", new_callable=io.StringIO):
|
||||||
|
rc = self._run_launch(assume_yes=False)
|
||||||
|
|
||||||
|
self.assertEqual(0, rc)
|
||||||
|
backend_mock.launch.assert_not_called()
|
||||||
|
|
||||||
|
def test_interactive_user_confirms_launches_once(self) -> None:
|
||||||
|
"""Interactive user answering 'y' → prelaunch stale error is bypassed; launch called once."""
|
||||||
|
import bot_bottle.cli.start as start_mod
|
||||||
|
|
||||||
|
bottle_mock = MagicMock()
|
||||||
|
bottle_mock.name = "dev-abc"
|
||||||
|
|
||||||
|
backend_mock = MagicMock()
|
||||||
|
backend_mock.prelaunch_checks.side_effect = StaleImageError("image is 5 day(s) old")
|
||||||
|
backend_mock.launch.return_value = _ok_cm(bottle_mock)
|
||||||
|
|
||||||
|
with patch.object(start_mod, "get_bottle_backend", return_value=backend_mock), \
|
||||||
|
patch.object(start_mod, "read_tty_line", return_value="y"), \
|
||||||
|
patch.object(start_mod, "attach_agent", return_value=0), \
|
||||||
|
patch.object(start_mod, "capture_claude_session_state"), \
|
||||||
|
patch("sys.stderr", new_callable=io.StringIO):
|
||||||
|
rc = self._run_launch(assume_yes=False)
|
||||||
|
|
||||||
|
self.assertEqual(0, rc)
|
||||||
|
backend_mock.prelaunch_checks.assert_called_once()
|
||||||
|
backend_mock.launch.assert_called_once()
|
||||||
|
|
||||||
|
def test_interactive_yes_uppercase_also_accepted(self) -> None:
|
||||||
|
"""'Y' or 'YES' should also be accepted as confirmation."""
|
||||||
|
import bot_bottle.cli.start as start_mod
|
||||||
|
|
||||||
|
bottle_mock = MagicMock()
|
||||||
|
bottle_mock.name = "dev-abc"
|
||||||
|
|
||||||
|
backend_mock = MagicMock()
|
||||||
|
backend_mock.prelaunch_checks.side_effect = StaleImageError("image is 5 day(s) old")
|
||||||
|
backend_mock.launch.return_value = _ok_cm(bottle_mock)
|
||||||
|
|
||||||
|
with patch.object(start_mod, "get_bottle_backend", return_value=backend_mock), \
|
||||||
|
patch.object(start_mod, "read_tty_line", return_value="YES"), \
|
||||||
|
patch.object(start_mod, "attach_agent", return_value=0), \
|
||||||
|
patch.object(start_mod, "capture_claude_session_state"), \
|
||||||
|
patch("sys.stderr", new_callable=io.StringIO):
|
||||||
|
rc = self._run_launch(assume_yes=False)
|
||||||
|
|
||||||
|
self.assertEqual(0, rc)
|
||||||
|
backend_mock.launch.assert_called_once()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
"""Unit tests for the host-side configuration store."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from bot_bottle.config_store import (
|
||||||
|
DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS,
|
||||||
|
ConfigStore,
|
||||||
|
)
|
||||||
|
from bot_bottle.store_manager import StoreManager
|
||||||
|
|
||||||
|
|
||||||
|
class TestConfigStore(unittest.TestCase):
|
||||||
|
def test_cached_image_warning_days_defaults_to_one(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
store = ConfigStore(Path(tmp) / "bot-bottle.db")
|
||||||
|
store.migrate()
|
||||||
|
self.assertEqual(
|
||||||
|
DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS,
|
||||||
|
store.cached_image_stale_warning_days(),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_cached_image_warning_days_reads_value(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
store = ConfigStore(Path(tmp) / "bot-bottle.db")
|
||||||
|
store.migrate()
|
||||||
|
store.set_cached_image_stale_warning_days(7)
|
||||||
|
self.assertEqual(7, store.cached_image_stale_warning_days())
|
||||||
|
|
||||||
|
def test_config_schema_uses_explicit_settings_columns(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
store = ConfigStore(Path(tmp) / "bot-bottle.db")
|
||||||
|
store.migrate()
|
||||||
|
with sqlite3.connect(store.db_path) as conn:
|
||||||
|
conn.row_factory = sqlite3.Row
|
||||||
|
columns = [
|
||||||
|
row["name"]
|
||||||
|
for row in conn.execute("PRAGMA table_info(bot_bottle_config)")
|
||||||
|
]
|
||||||
|
self.assertEqual([
|
||||||
|
"id",
|
||||||
|
"cached_image_stale_warning_days",
|
||||||
|
], columns)
|
||||||
|
|
||||||
|
def test_store_manager_includes_config_store(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
db = Path(tmp) / "bot-bottle.db"
|
||||||
|
manager = StoreManager(db)
|
||||||
|
self.assertFalse(manager.is_migrated())
|
||||||
|
manager.migrate()
|
||||||
|
self.assertTrue(manager.is_migrated())
|
||||||
|
|
||||||
|
def test_cached_image_warning_days_returns_default_when_db_missing(self) -> None:
|
||||||
|
# When the db file doesn't exist yet (parent exists, file doesn't),
|
||||||
|
# the store returns the default without touching the file.
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
store = ConfigStore(Path(tmp) / "missing.db")
|
||||||
|
self.assertEqual(
|
||||||
|
DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS,
|
||||||
|
store.cached_image_stale_warning_days(),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_cached_image_warning_days_returns_default_on_null_value(self) -> None:
|
||||||
|
# If the row exists but the value is NULL (or not castable to int),
|
||||||
|
# the store falls back to the default.
|
||||||
|
with tempfile.TemporaryDirectory(prefix="config-store.") as tmp:
|
||||||
|
db_path = Path(tmp) / "bot-bottle.db"
|
||||||
|
store = ConfigStore(db_path)
|
||||||
|
store.migrate()
|
||||||
|
# Write a NULL value directly.
|
||||||
|
with sqlite3.connect(db_path) as conn:
|
||||||
|
conn.execute(
|
||||||
|
"UPDATE bot_bottle_config SET cached_image_stale_warning_days = NULL WHERE id = 1"
|
||||||
|
)
|
||||||
|
self.assertEqual(
|
||||||
|
DEFAULT_CACHED_IMAGE_STALE_WARNING_DAYS,
|
||||||
|
store.cached_image_stale_warning_days(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -15,6 +15,7 @@ from bot_bottle.git_gate import GitGatePlan
|
|||||||
from bot_bottle.orchestrator.client import RegisteredBottle
|
from bot_bottle.orchestrator.client import RegisteredBottle
|
||||||
|
|
||||||
_MOD = "bot_bottle.backend.docker.consolidated_launch"
|
_MOD = "bot_bottle.backend.docker.consolidated_launch"
|
||||||
|
_UTIL = "bot_bottle.backend.consolidated_util"
|
||||||
|
|
||||||
|
|
||||||
def _egress_plan() -> EgressPlan:
|
def _egress_plan() -> EgressPlan:
|
||||||
@@ -49,7 +50,7 @@ class TestLaunchConsolidated(unittest.TestCase):
|
|||||||
patch(f"{_MOD}._container_ip", return_value="172.18.0.2"), \
|
patch(f"{_MOD}._container_ip", return_value="172.18.0.2"), \
|
||||||
patch(f"{_MOD}._network_container_ips", return_value=list(on_network)), \
|
patch(f"{_MOD}._network_container_ips", return_value=list(on_network)), \
|
||||||
patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_MOD}.provision_git_gate", provision or Mock()):
|
patch(f"{_UTIL}.provision_git_gate", provision or Mock()):
|
||||||
return launch_consolidated(_egress_plan(), _git_plan(), service=service)
|
return launch_consolidated(_egress_plan(), _git_plan(), service=service)
|
||||||
|
|
||||||
def test_allocates_ip_registers_and_provisions(self) -> None:
|
def test_allocates_ip_registers_and_provisions(self) -> None:
|
||||||
@@ -84,8 +85,8 @@ class TestLaunchConsolidated(unittest.TestCase):
|
|||||||
class TestTeardownConsolidated(unittest.TestCase):
|
class TestTeardownConsolidated(unittest.TestCase):
|
||||||
def test_deregisters_and_deprovisions(self) -> None:
|
def test_deregisters_and_deprovisions(self) -> None:
|
||||||
client = Mock()
|
client = Mock()
|
||||||
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
with patch(f"{_UTIL}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_MOD}.deprovision_git_gate") as deprov:
|
patch(f"{_UTIL}.deprovision_git_gate") as deprov:
|
||||||
teardown_consolidated("b1", orchestrator_url="http://orch:8080")
|
teardown_consolidated("b1", orchestrator_url="http://orch:8080")
|
||||||
client.teardown_bottle.assert_called_once_with("b1")
|
client.teardown_bottle.assert_called_once_with("b1")
|
||||||
deprov.assert_called_once()
|
deprov.assert_called_once()
|
||||||
|
|||||||
@@ -0,0 +1,186 @@
|
|||||||
|
"""Unit: host Claude auth extraction."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from bot_bottle.contrib.claude.claude_auth import (
|
||||||
|
claude_auth_path,
|
||||||
|
claude_host_access_token,
|
||||||
|
)
|
||||||
|
from bot_bottle.log import Die
|
||||||
|
|
||||||
|
|
||||||
|
def _cred_json(access_token: str, **extra: object) -> str:
|
||||||
|
payload: dict[str, object] = {"claudeAiOauth": {"accessToken": access_token, **extra}}
|
||||||
|
return json.dumps(payload)
|
||||||
|
|
||||||
|
|
||||||
|
class TestClaudeHostAccessToken(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
self.tmp = tempfile.TemporaryDirectory(prefix="bb-claude-auth.")
|
||||||
|
self.home = Path(self.tmp.name)
|
||||||
|
self.cred_dir = self.home / ".claude"
|
||||||
|
self.cred_dir.mkdir()
|
||||||
|
self.auth_path = self.cred_dir / ".credentials.json"
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.tmp.cleanup()
|
||||||
|
|
||||||
|
def _write(self, payload: dict) -> None: # type: ignore[no-untyped-def]
|
||||||
|
self.auth_path.write_text(json.dumps(payload))
|
||||||
|
|
||||||
|
def test_auth_path_uses_home_env(self):
|
||||||
|
self.assertEqual(
|
||||||
|
self.auth_path,
|
||||||
|
claude_auth_path({"HOME": str(self.home)}),
|
||||||
|
)
|
||||||
|
|
||||||
|
# --- file-based (Linux) ---
|
||||||
|
|
||||||
|
def test_file_returns_access_token(self):
|
||||||
|
key = "sk-ant-oat01-real-key" # gitleaks:allow
|
||||||
|
self._write({"claudeAiOauth": {"accessToken": key}})
|
||||||
|
out = claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
self.assertEqual(key, out)
|
||||||
|
|
||||||
|
def test_file_missing_claude_ai_oauth_dies(self):
|
||||||
|
self._write({"hasCompletedOnboarding": True})
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
|
||||||
|
def test_file_missing_access_token_dies(self):
|
||||||
|
self._write({"claudeAiOauth": {"expiresAt": 2000000000000}})
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
|
||||||
|
def test_file_empty_access_token_dies(self):
|
||||||
|
self._write({"claudeAiOauth": {"accessToken": ""}})
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
|
||||||
|
def test_file_expired_token_dies(self):
|
||||||
|
# expiresAt is milliseconds; 1_000_000 ms is year 1970
|
||||||
|
self._write({
|
||||||
|
"claudeAiOauth": {"accessToken": "sk-ant-oat01-x", "expiresAt": 1_000_000}, # gitleaks:allow
|
||||||
|
})
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token(
|
||||||
|
{"HOME": str(self.home)},
|
||||||
|
now=datetime(2026, 1, 1, tzinfo=timezone.utc),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_file_future_expiry_is_accepted(self):
|
||||||
|
key = "sk-ant-oat01-y" # gitleaks:allow
|
||||||
|
# 2_000_000_000_000 ms ≈ year 2033
|
||||||
|
self._write({
|
||||||
|
"claudeAiOauth": {"accessToken": key, "expiresAt": 2_000_000_000_000},
|
||||||
|
})
|
||||||
|
out = claude_host_access_token(
|
||||||
|
{"HOME": str(self.home)},
|
||||||
|
now=datetime(2026, 1, 1, tzinfo=timezone.utc),
|
||||||
|
)
|
||||||
|
self.assertEqual(key, out)
|
||||||
|
|
||||||
|
def test_file_absent_expiry_is_accepted(self):
|
||||||
|
key = "sk-ant-oat01-z" # gitleaks:allow
|
||||||
|
self._write({"claudeAiOauth": {"accessToken": key}})
|
||||||
|
out = claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
self.assertEqual(key, out)
|
||||||
|
|
||||||
|
def test_file_non_json_dies(self):
|
||||||
|
self.auth_path.write_text("not json {{{")
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
|
||||||
|
def test_file_json_array_root_dies(self):
|
||||||
|
self.auth_path.write_text("[]")
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
|
||||||
|
def test_file_extra_fields_are_ignored(self):
|
||||||
|
key = "sk-ant-oat01-real" # gitleaks:allow
|
||||||
|
self._write({
|
||||||
|
"claudeAiOauth": {
|
||||||
|
"accessToken": key,
|
||||||
|
"refreshToken": "sk-ant-ort01-secret", # gitleaks:allow
|
||||||
|
"scopes": ["user:inference"],
|
||||||
|
"expiresAt": 2_000_000_000_000,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
out = claude_host_access_token({"HOME": str(self.home)})
|
||||||
|
self.assertEqual(key, out)
|
||||||
|
|
||||||
|
# --- macOS Keychain fallback ---
|
||||||
|
|
||||||
|
def _home_without_creds(self) -> Path:
|
||||||
|
"""A home dir that has .claude/ but no .credentials.json."""
|
||||||
|
empty = self.home / "no-creds"
|
||||||
|
(empty / ".claude").mkdir(parents=True)
|
||||||
|
return empty
|
||||||
|
|
||||||
|
def _mock_keychain(self, stdout: str, returncode: int = 0) -> MagicMock:
|
||||||
|
mock = MagicMock()
|
||||||
|
mock.returncode = returncode
|
||||||
|
mock.stdout = stdout
|
||||||
|
return mock
|
||||||
|
|
||||||
|
def test_keychain_used_when_file_absent(self):
|
||||||
|
key = "sk-ant-oat01-keychain" # gitleaks:allow
|
||||||
|
home = self._home_without_creds()
|
||||||
|
with patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.subprocess.run",
|
||||||
|
return_value=self._mock_keychain(_cred_json(key)),
|
||||||
|
), patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.sys.platform", "darwin",
|
||||||
|
):
|
||||||
|
out = claude_host_access_token({"HOME": str(home)})
|
||||||
|
self.assertEqual(key, out)
|
||||||
|
|
||||||
|
def test_keychain_failure_when_file_absent_dies(self):
|
||||||
|
home = self._home_without_creds()
|
||||||
|
with patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.subprocess.run",
|
||||||
|
return_value=self._mock_keychain("", returncode=44),
|
||||||
|
), patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.sys.platform", "darwin",
|
||||||
|
):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(home)})
|
||||||
|
|
||||||
|
def test_no_file_no_keychain_on_linux_dies(self):
|
||||||
|
home = self._home_without_creds()
|
||||||
|
with patch("bot_bottle.contrib.claude.claude_auth.sys.platform", "linux"):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(home)})
|
||||||
|
|
||||||
|
def test_keychain_non_json_dies(self):
|
||||||
|
home = self._home_without_creds()
|
||||||
|
with patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.subprocess.run",
|
||||||
|
return_value=self._mock_keychain("not-json"),
|
||||||
|
), patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.sys.platform", "darwin",
|
||||||
|
):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(home)})
|
||||||
|
|
||||||
|
def test_keychain_security_not_found_dies(self):
|
||||||
|
home = self._home_without_creds()
|
||||||
|
with patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.subprocess.run",
|
||||||
|
side_effect=FileNotFoundError,
|
||||||
|
), patch(
|
||||||
|
"bot_bottle.contrib.claude.claude_auth.sys.platform", "darwin",
|
||||||
|
):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
claude_host_access_token({"HOME": str(home)})
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import contextlib
|
import contextlib
|
||||||
|
import dataclasses
|
||||||
import io
|
import io
|
||||||
import tempfile
|
import tempfile
|
||||||
import unittest
|
import unittest
|
||||||
@@ -18,6 +19,7 @@ from bot_bottle.backend.docker.bottle_plan import DockerBottlePlan
|
|||||||
from bot_bottle.backend.docker.consolidated_launch import LaunchContext
|
from bot_bottle.backend.docker.consolidated_launch import LaunchContext
|
||||||
from bot_bottle.egress import EgressPlan
|
from bot_bottle.egress import EgressPlan
|
||||||
from bot_bottle.git_gate import GitGatePlan
|
from bot_bottle.git_gate import GitGatePlan
|
||||||
|
from bot_bottle.log import Die
|
||||||
from bot_bottle.manifest import ManifestIndex
|
from bot_bottle.manifest import ManifestIndex
|
||||||
from tests.unit import use_bottle_root
|
from tests.unit import use_bottle_root
|
||||||
|
|
||||||
@@ -92,6 +94,7 @@ class TestLaunchCommittedImage(unittest.TestCase):
|
|||||||
mock.patch.object(launch_mod.docker_mod, "image_exists", return_value=image_present), \
|
mock.patch.object(launch_mod.docker_mod, "image_exists", return_value=image_present), \
|
||||||
mock.patch.object(launch_mod.docker_mod, "build_image", side_effect=_build), \
|
mock.patch.object(launch_mod.docker_mod, "build_image", side_effect=_build), \
|
||||||
mock.patch.object(launch_mod.docker_mod, "verify_agent_image"), \
|
mock.patch.object(launch_mod.docker_mod, "verify_agent_image"), \
|
||||||
|
mock.patch.object(launch_mod.docker_mod, "image_created_at"), \
|
||||||
mock.patch.object(launch_mod, "launch_consolidated", return_value=_CTX), \
|
mock.patch.object(launch_mod, "launch_consolidated", return_value=_CTX), \
|
||||||
mock.patch.object(launch_mod, "teardown_consolidated"), \
|
mock.patch.object(launch_mod, "teardown_consolidated"), \
|
||||||
mock.patch.object(launch_mod, "DockerGateway", return_value=gw), \
|
mock.patch.object(launch_mod, "DockerGateway", return_value=gw), \
|
||||||
@@ -112,7 +115,8 @@ class TestLaunchCommittedImage(unittest.TestCase):
|
|||||||
with self._patched(
|
with self._patched(
|
||||||
committed_tag=committed_tag, image_present=image_present, compose=compose,
|
committed_tag=committed_tag, image_present=image_present, compose=compose,
|
||||||
) as built:
|
) as built:
|
||||||
with launch_mod.launch(plan, provision=mock.Mock(return_value=None)):
|
images = launch_mod.build_or_load_images(plan)
|
||||||
|
with launch_mod.launch(plan, images, provision=mock.Mock(return_value=None)):
|
||||||
pass
|
pass
|
||||||
return built
|
return built
|
||||||
|
|
||||||
@@ -127,14 +131,34 @@ class TestLaunchCommittedImage(unittest.TestCase):
|
|||||||
captured.append(p)
|
captured.append(p)
|
||||||
return {"services": {"agent": {}}}
|
return {"services": {"agent": {}}}
|
||||||
|
|
||||||
with self._patched(committed_tag=_COMMITTED_TAG, image_present=True, compose=compose):
|
with self._patched(committed_tag=_COMMITTED_TAG, image_present=True, compose=compose) as _:
|
||||||
with launch_mod.launch(_plan(self._tmp), provision=mock.Mock(return_value=None)):
|
plan = _plan(self._tmp)
|
||||||
|
images = launch_mod.build_or_load_images(plan)
|
||||||
|
with launch_mod.launch(plan, images, provision=mock.Mock(return_value=None)):
|
||||||
pass
|
pass
|
||||||
self.assertEqual(_COMMITTED_TAG, captured[0].image)
|
self.assertEqual(_COMMITTED_TAG, captured[0].image)
|
||||||
|
|
||||||
def test_falls_back_to_build_when_no_committed_image(self) -> None:
|
def test_falls_back_to_build_when_no_committed_image(self) -> None:
|
||||||
self.assertEqual([_DEFAULT_IMAGE], self._run_launch(_plan(self._tmp), committed_tag=None))
|
self.assertEqual([_DEFAULT_IMAGE], self._run_launch(_plan(self._tmp), committed_tag=None))
|
||||||
|
|
||||||
|
def test_cached_images_skip_build_when_present(self) -> None:
|
||||||
|
base = _plan(self._tmp)
|
||||||
|
plan = dataclasses.replace(
|
||||||
|
base,
|
||||||
|
spec=dataclasses.replace(base.spec, image_policy="cached"),
|
||||||
|
)
|
||||||
|
built = self._run_launch(plan, committed_tag=None, image_present=True)
|
||||||
|
self.assertEqual([], built)
|
||||||
|
|
||||||
|
def test_cached_images_die_when_agent_missing(self) -> None:
|
||||||
|
base = _plan(self._tmp)
|
||||||
|
plan = dataclasses.replace(
|
||||||
|
base,
|
||||||
|
spec=dataclasses.replace(base.spec, image_policy="cached"),
|
||||||
|
)
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
self._run_launch(plan, committed_tag=None, image_present=False)
|
||||||
|
|
||||||
def test_falls_back_to_build_when_committed_image_missing_from_daemon(self) -> None:
|
def test_falls_back_to_build_when_committed_image_missing_from_daemon(self) -> None:
|
||||||
built = self._run_launch(_plan(self._tmp), committed_tag=_COMMITTED_TAG, image_present=False)
|
built = self._run_launch(_plan(self._tmp), committed_tag=_COMMITTED_TAG, image_present=False)
|
||||||
self.assertEqual([_DEFAULT_IMAGE], built)
|
self.assertEqual([_DEFAULT_IMAGE], built)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ from pathlib import Path
|
|||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from bot_bottle.agent_provider import AgentProvisionPlan
|
from bot_bottle.agent_provider import AgentProvisionPlan
|
||||||
from bot_bottle.backend import BottleSpec
|
from bot_bottle.backend import BottleImages, BottleSpec
|
||||||
from bot_bottle.backend.docker import launch as launch_mod
|
from bot_bottle.backend.docker import launch as launch_mod
|
||||||
from bot_bottle.backend.docker.bottle_plan import DockerBottlePlan
|
from bot_bottle.backend.docker.bottle_plan import DockerBottlePlan
|
||||||
from bot_bottle.backend.docker.consolidated_launch import LaunchContext
|
from bot_bottle.backend.docker.consolidated_launch import LaunchContext
|
||||||
@@ -93,6 +93,8 @@ class TestTeardownWarning(unittest.TestCase):
|
|||||||
orchestrator_url="http://orch:8099",
|
orchestrator_url="http://orch:8099",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
images = BottleImages(agent="bot-bottle-claude:latest", sidecar="bot-bottle-sidecars:latest")
|
||||||
|
|
||||||
with mock.patch.object(launch_mod.docker_mod, "build_image"), \
|
with mock.patch.object(launch_mod.docker_mod, "build_image"), \
|
||||||
mock.patch.object(launch_mod.docker_mod, "verify_agent_image"), \
|
mock.patch.object(launch_mod.docker_mod, "verify_agent_image"), \
|
||||||
mock.patch.object(launch_mod, "launch_consolidated", return_value=ctx), \
|
mock.patch.object(launch_mod, "launch_consolidated", return_value=ctx), \
|
||||||
@@ -113,7 +115,7 @@ class TestTeardownWarning(unittest.TestCase):
|
|||||||
), \
|
), \
|
||||||
contextlib.redirect_stderr(buf):
|
contextlib.redirect_stderr(buf):
|
||||||
provision = mock.Mock(return_value=None)
|
provision = mock.Mock(return_value=None)
|
||||||
with launch_mod.launch(plan, provision=provision):
|
with launch_mod.launch(plan, images, provision=provision):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
output = buf.getvalue()
|
output = buf.getvalue()
|
||||||
|
|||||||
@@ -45,12 +45,15 @@ _PROVIDER = _Provider()
|
|||||||
|
|
||||||
|
|
||||||
def _plan(*, git_user: dict | None = None, # type: ignore
|
def _plan(*, git_user: dict | None = None, # type: ignore
|
||||||
|
git_repos: dict | None = None, # type: ignore
|
||||||
copy_cwd: bool = False,
|
copy_cwd: bool = False,
|
||||||
user_cwd: str = "/tmp/x",
|
user_cwd: str = "/tmp/x",
|
||||||
stage_dir: Path | None = None) -> DockerBottlePlan:
|
stage_dir: Path | None = None) -> DockerBottlePlan:
|
||||||
bottle_json: dict = {} # type: ignore
|
bottle_json: dict = {} # type: ignore
|
||||||
if git_user is not None:
|
if git_user is not None:
|
||||||
bottle_json["git-gate"] = {"user": git_user}
|
bottle_json["git-gate"] = {"user": git_user}
|
||||||
|
if git_repos is not None:
|
||||||
|
bottle_json.setdefault("git-gate", {})["repos"] = git_repos
|
||||||
index = ManifestIndex.from_json_obj({
|
index = ManifestIndex.from_json_obj({
|
||||||
"bottles": {"dev": bottle_json},
|
"bottles": {"dev": bottle_json},
|
||||||
"agents": {"demo": {"skills": [], "prompt": "", "bottle": "dev"}},
|
"agents": {"demo": {"skills": [], "prompt": "", "bottle": "dev"}},
|
||||||
@@ -125,6 +128,62 @@ class TestProvisionGitUser(unittest.TestCase):
|
|||||||
_PROVIDER.provision_git(bottle, _plan(stage_dir=self.stage))
|
_PROVIDER.provision_git(bottle, _plan(stage_dir=self.stage))
|
||||||
self.assertEqual([], _git_config_exec_calls(bottle))
|
self.assertEqual([], _git_config_exec_calls(bottle))
|
||||||
|
|
||||||
|
def test_repairs_git_xdg_directory_for_runtime_user(self):
|
||||||
|
bottle = _make_bottle()
|
||||||
|
_PROVIDER.provision_git(bottle, _plan(stage_dir=self.stage))
|
||||||
|
|
||||||
|
script, user = next(
|
||||||
|
(call.args[0], call.kwargs.get("user", "node"))
|
||||||
|
for call in bottle.exec.call_args_list
|
||||||
|
if "/home/node/.config/git" in call.args[0]
|
||||||
|
)
|
||||||
|
self.assertEqual("root", user)
|
||||||
|
self.assertIn("chown node:node /home/node", script)
|
||||||
|
self.assertIn("chmod 755 /home/node", script)
|
||||||
|
self.assertIn("mkdir -p /home/node/.config/git", script)
|
||||||
|
self.assertIn("chown -R node:node /home/node/.config", script)
|
||||||
|
self.assertIn("chmod -R u+rwX,go+rX /home/node/.config", script)
|
||||||
|
|
||||||
|
def test_fails_closed_when_home_permissions_cannot_be_repaired(self):
|
||||||
|
bottle = _make_bottle()
|
||||||
|
bottle.exec.return_value = ExecResult(1, "", "read-only filesystem")
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
_PROVIDER.provision_git(bottle, _plan(stage_dir=self.stage))
|
||||||
|
|
||||||
|
def _git_plan(self) -> DockerBottlePlan:
|
||||||
|
return _plan(
|
||||||
|
git_repos={
|
||||||
|
"repo": {
|
||||||
|
"url": "ssh://git@example.com/repo.git",
|
||||||
|
"key": {"provider": "static", "path": "/dev/null"},
|
||||||
|
"host_key": "ssh-ed25519 AAAA",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
stage_dir=self.stage,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_fails_closed_when_gitconfig_permissions_cannot_be_set(self):
|
||||||
|
bottle = _make_bottle()
|
||||||
|
bottle.exec.side_effect = [
|
||||||
|
ExecResult(0, "", ""),
|
||||||
|
ExecResult(1, "", "chown failed"),
|
||||||
|
]
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
_PROVIDER.provision_git(bottle, self._git_plan())
|
||||||
|
|
||||||
|
def test_fails_closed_when_runtime_user_cannot_read_gitconfig(self):
|
||||||
|
bottle = _make_bottle()
|
||||||
|
bottle.exec.side_effect = [
|
||||||
|
ExecResult(0, "", ""),
|
||||||
|
ExecResult(0, "", ""),
|
||||||
|
ExecResult(1, "", "permission denied"),
|
||||||
|
]
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
_PROVIDER.provision_git(bottle, self._git_plan())
|
||||||
|
|
||||||
def test_sets_name_and_email(self):
|
def test_sets_name_and_email(self):
|
||||||
plan = _plan(
|
plan = _plan(
|
||||||
git_user={"name": "Eric Bauerfeld", "email": "eric@dideric.is"},
|
git_user={"name": "Eric Bauerfeld", "email": "eric@dideric.is"},
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import unittest
|
import unittest
|
||||||
|
from datetime import timezone
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
|
|
||||||
from bot_bottle.backend.docker import util as docker_mod
|
from bot_bottle.backend.docker import util as docker_mod
|
||||||
@@ -26,6 +27,59 @@ def _fail(stderr: str = "boom") -> subprocess.CompletedProcess: # type: ignore
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class TestImageCreatedAt(unittest.TestCase):
|
||||||
|
def test_parses_docker_timestamp_with_nanoseconds(self):
|
||||||
|
with patch.object(
|
||||||
|
docker_mod.subprocess, "run",
|
||||||
|
return_value=_ok(stdout="2026-07-06T15:33:47.123456789Z\n"),
|
||||||
|
) as run:
|
||||||
|
created = docker_mod.image_created_at("bot-bottle-claude:latest")
|
||||||
|
self.assertIsNotNone(created)
|
||||||
|
assert created is not None
|
||||||
|
self.assertEqual(2026, created.year)
|
||||||
|
self.assertEqual(123456, created.microsecond)
|
||||||
|
self.assertEqual(timezone.utc, created.tzinfo)
|
||||||
|
self.assertEqual(
|
||||||
|
["docker", "image", "inspect", "--format", "{{.Created}}", "bot-bottle-claude:latest"],
|
||||||
|
run.call_args.args[0],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_dies_on_inspect_failure(self):
|
||||||
|
with patch.object(
|
||||||
|
docker_mod.subprocess, "run", return_value=_fail("No such image"),
|
||||||
|
), patch.object(
|
||||||
|
docker_mod, "die", side_effect=SystemExit("die"),
|
||||||
|
) as die:
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
docker_mod.image_created_at("missing:tag")
|
||||||
|
die.assert_called_once()
|
||||||
|
self.assertIn("missing:tag", die.call_args.args[0])
|
||||||
|
|
||||||
|
def test_returns_none_on_invalid_timestamp(self):
|
||||||
|
with patch.object(
|
||||||
|
docker_mod.subprocess, "run",
|
||||||
|
return_value=_ok(stdout="not-a-timestamp\n"),
|
||||||
|
):
|
||||||
|
result = docker_mod.image_created_at("some:tag")
|
||||||
|
self.assertIsNone(result)
|
||||||
|
|
||||||
|
def test_returns_none_on_empty_stdout(self):
|
||||||
|
with patch.object(
|
||||||
|
docker_mod.subprocess, "run",
|
||||||
|
return_value=_ok(stdout=""),
|
||||||
|
):
|
||||||
|
result = docker_mod.image_created_at("some:tag")
|
||||||
|
self.assertIsNone(result)
|
||||||
|
|
||||||
|
def test_parse_docker_timestamp_no_tzinfo_defaults_to_utc(self):
|
||||||
|
# A bare datetime with no tz offset should be treated as UTC.
|
||||||
|
dt = docker_mod._parse_docker_timestamp("2024-05-01T10:00:00.000000")
|
||||||
|
self.assertIsNotNone(dt.tzinfo)
|
||||||
|
self.assertEqual(timezone.utc, dt.tzinfo)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
class TestCommitContainer(unittest.TestCase):
|
class TestCommitContainer(unittest.TestCase):
|
||||||
def test_runs_docker_commit(self):
|
def test_runs_docker_commit(self):
|
||||||
with patch.object(
|
with patch.object(
|
||||||
|
|||||||
@@ -379,6 +379,25 @@ class TestRenderRoutes(unittest.TestCase):
|
|||||||
addon_routes = load_config(rendered).routes
|
addon_routes = load_config(rendered).routes
|
||||||
self.assertTrue(addon_routes[0].git_fetch)
|
self.assertTrue(addon_routes[0].git_fetch)
|
||||||
|
|
||||||
|
def test_preserve_auth_round_trips_to_the_addon(self):
|
||||||
|
"""Regression: the manifest parsed preserve_auth and the addon honored
|
||||||
|
it, but the renderer in between dropped it — so the flag never reached
|
||||||
|
the proxy and registry pulls kept failing with "unauthorized" while
|
||||||
|
the config looked correct everywhere it was inspected."""
|
||||||
|
from bot_bottle.egress_addon_core import load_config
|
||||||
|
b = _bottle([{"host": "registry-1.docker.io", "preserve_auth": True}])
|
||||||
|
routes = egress_routes_for_bottle(b)
|
||||||
|
rendered = egress_render_routes(routes)
|
||||||
|
self.assertIn("preserve_auth: true", rendered)
|
||||||
|
self.assertTrue(load_config(rendered).routes[0].preserve_auth)
|
||||||
|
|
||||||
|
def test_preserve_auth_omitted_when_unset(self):
|
||||||
|
b = _bottle([{"host": "x.example"}])
|
||||||
|
rendered = egress_render_routes(egress_routes_for_bottle(b))
|
||||||
|
self.assertNotIn("preserve_auth", rendered)
|
||||||
|
from bot_bottle.egress_addon_core import load_config
|
||||||
|
self.assertFalse(load_config(rendered).routes[0].preserve_auth)
|
||||||
|
|
||||||
def test_log_zero_omitted_from_render(self):
|
def test_log_zero_omitted_from_render(self):
|
||||||
b = _bottle([{"host": "x.example"}])
|
b = _bottle([{"host": "x.example"}])
|
||||||
routes = egress_routes_for_bottle(b)
|
routes = egress_routes_for_bottle(b)
|
||||||
|
|||||||
@@ -413,6 +413,28 @@ class TestAuthInjection(unittest.TestCase):
|
|||||||
assert flow.response is not None
|
assert flow.response is not None
|
||||||
self.assertEqual(403, flow.response.status_code)
|
self.assertEqual(403, flow.response.status_code)
|
||||||
|
|
||||||
|
def test_preserve_auth_passes_agent_token_through(self) -> None:
|
||||||
|
route = Route(host="registry-1.docker.io", preserve_auth=True)
|
||||||
|
addon = _addon(Config(routes=(route,)))
|
||||||
|
flow = _Flow(_Request(
|
||||||
|
host="registry-1.docker.io",
|
||||||
|
headers={"authorization": "Bearer agent-registry-token"},
|
||||||
|
))
|
||||||
|
_run_request(addon, flow)
|
||||||
|
self.assertEqual("Bearer agent-registry-token", flow.request.headers.get("authorization"))
|
||||||
|
self.assertIsNone(flow.response)
|
||||||
|
|
||||||
|
def test_default_route_strips_agent_auth(self) -> None:
|
||||||
|
route = Route(host="registry-1.docker.io")
|
||||||
|
addon = _addon(Config(routes=(route,)))
|
||||||
|
flow = _Flow(_Request(
|
||||||
|
host="registry-1.docker.io",
|
||||||
|
headers={"authorization": "Bearer agent-registry-token"},
|
||||||
|
))
|
||||||
|
_run_request(addon, flow)
|
||||||
|
self.assertIsNone(flow.request.headers.get("authorization"))
|
||||||
|
self.assertIsNone(flow.response)
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# git push / fetch over HTTPS
|
# git push / fetch over HTTPS
|
||||||
|
|||||||
@@ -4,7 +4,14 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import unittest
|
import unittest
|
||||||
|
|
||||||
from bot_bottle.egress_addon_core import resolve_client_config, resolve_client_context
|
from bot_bottle.egress_addon_core import (
|
||||||
|
DENY_RESOLVER_ERROR,
|
||||||
|
DENY_UNATTRIBUTED,
|
||||||
|
DENY_UNPARSEABLE,
|
||||||
|
decide,
|
||||||
|
resolve_client_config,
|
||||||
|
resolve_client_context,
|
||||||
|
)
|
||||||
from bot_bottle.policy_resolver import PolicyResolveError
|
from bot_bottle.policy_resolver import PolicyResolveError
|
||||||
|
|
||||||
|
|
||||||
@@ -108,3 +115,55 @@ class TestResolveClientContext(unittest.TestCase):
|
|||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|
||||||
|
|
||||||
|
class TestDenyReasonNamesTheRealFault(unittest.TestCase):
|
||||||
|
"""A deny-all must not masquerade as a missing allowlist entry.
|
||||||
|
|
||||||
|
Regression: an unregistered bottle resolves no policy, so *every* host is
|
||||||
|
denied — but the block message said `host X is not in the allowlist`,
|
||||||
|
which reads as a config problem and sends the operator hunting for a route
|
||||||
|
that was never missing. The structural reason wins over that wording.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _reason(self, resolver: object, host: str = "chatgpt.com") -> str:
|
||||||
|
cfg = resolve_client_config(resolver, "10.243.0.1") # type: ignore[arg-type]
|
||||||
|
return decide(cfg.routes, host, "/v1/x", {}, deny_reason=cfg.deny_reason).reason
|
||||||
|
|
||||||
|
def test_unattributed_says_unattributed_not_allowlist(self) -> None:
|
||||||
|
reason = self._reason(_FakeResolver(result=None))
|
||||||
|
self.assertEqual(DENY_UNATTRIBUTED, reason)
|
||||||
|
# The misleading claim is the one that must be gone: the host was
|
||||||
|
# never "not in the allowlist" — there was no allowlist at all.
|
||||||
|
self.assertNotIn("is not in the bottle's egress.routes allowlist", reason)
|
||||||
|
# Both causes must be named. `/resolve` fail-closes on a missing row
|
||||||
|
# *and* on a token mismatch, and the message pointing only at the row
|
||||||
|
# sent us hunting for a deregistered bottle that was registered fine.
|
||||||
|
self.assertIn("registry row", reason)
|
||||||
|
self.assertIn("identity token", reason)
|
||||||
|
|
||||||
|
def test_resolver_error_says_orchestrator_unreachable(self) -> None:
|
||||||
|
self.assertEqual(DENY_RESOLVER_ERROR, self._reason(_FakeResolver(raises=True)))
|
||||||
|
|
||||||
|
def test_unparseable_policy_says_so(self) -> None:
|
||||||
|
self.assertEqual(
|
||||||
|
DENY_UNPARSEABLE, self._reason(_FakeResolver(result="routes: notalist\n")))
|
||||||
|
|
||||||
|
def test_a_real_allowlist_miss_keeps_the_allowlist_wording(self) -> None:
|
||||||
|
"""The message only changes for structural deny-alls — a loaded policy
|
||||||
|
that genuinely lacks the host still points at the allowlist."""
|
||||||
|
reason = self._reason(_FakeResolver(result='routes:\n - host: "api.example.com"\n'))
|
||||||
|
self.assertIn("is not in the bottle's egress.routes allowlist", reason)
|
||||||
|
self.assertIn("chatgpt.com", reason)
|
||||||
|
|
||||||
|
def test_allowed_host_is_still_forwarded(self) -> None:
|
||||||
|
cfg = resolve_client_config(
|
||||||
|
_FakeResolver(result='routes:\n - host: "api.example.com"\n'), "10.243.0.1")
|
||||||
|
decision = decide(
|
||||||
|
cfg.routes, "api.example.com", "/v1/x", {}, deny_reason=cfg.deny_reason)
|
||||||
|
self.assertEqual("forward", decision.action)
|
||||||
|
|
||||||
|
def test_a_parsed_policy_carries_no_deny_reason(self) -> None:
|
||||||
|
cfg = resolve_client_config(
|
||||||
|
_FakeResolver(result='routes:\n - host: "api.example.com"\n'), "10.243.0.1")
|
||||||
|
self.assertEqual("", cfg.deny_reason)
|
||||||
|
|||||||
@@ -61,6 +61,12 @@ class TestNetpoolSlots(unittest.TestCase):
|
|||||||
|
|
||||||
|
|
||||||
class TestNetpoolRenderers(unittest.TestCase):
|
class TestNetpoolRenderers(unittest.TestCase):
|
||||||
|
def test_guest_init_restores_node_home_boundary(self):
|
||||||
|
from bot_bottle.backend.firecracker import util
|
||||||
|
|
||||||
|
self.assertIn("chown node:node /home/node", util._GUEST_INIT)
|
||||||
|
self.assertIn("chmod 755 /home/node", util._GUEST_INIT)
|
||||||
|
|
||||||
def test_nixos_module_is_non_invasive(self):
|
def test_nixos_module_is_non_invasive(self):
|
||||||
# The NixOS module must NOT flip the host firewall backend or
|
# The NixOS module must NOT flip the host firewall backend or
|
||||||
# hand interfaces to systemd-networkd; it brings the pool up via
|
# hand interfaces to systemd-networkd; it brings the pool up via
|
||||||
@@ -422,10 +428,15 @@ class TestBottlePlanProperties(unittest.TestCase):
|
|||||||
ap.command = "claude"
|
ap.command = "claude"
|
||||||
ap.prompt_mode = "append_file"
|
ap.prompt_mode = "append_file"
|
||||||
ap.template = "claude"
|
ap.template = "claude"
|
||||||
|
ap.guest_home = "/home/node"
|
||||||
|
ap.guest_env = {}
|
||||||
|
egress_plan = cast(Any, MagicMock())
|
||||||
|
egress_plan.canary = ""
|
||||||
|
egress_plan.canary_env = ""
|
||||||
fields = dict(
|
fields = dict(
|
||||||
spec=cast(Any, MagicMock()), manifest=cast(Any, MagicMock()),
|
spec=cast(Any, MagicMock()), manifest=cast(Any, MagicMock()),
|
||||||
stage_dir=Path("/stage"), git_gate_plan=cast(Any, MagicMock()),
|
stage_dir=Path("/stage"), git_gate_plan=cast(Any, MagicMock()),
|
||||||
egress_plan=cast(Any, MagicMock()), supervise_plan=None,
|
egress_plan=egress_plan, supervise_plan=None,
|
||||||
agent_provision=ap, slug="demo-x", forwarded_env={},
|
agent_provision=ap, slug="demo-x", forwarded_env={},
|
||||||
)
|
)
|
||||||
fields.update(overrides)
|
fields.update(overrides)
|
||||||
@@ -451,6 +462,12 @@ class TestBottlePlanProperties(unittest.TestCase):
|
|||||||
self.assertEqual("10.243.0.0:9420", p.git_gate_insteadof_host)
|
self.assertEqual("10.243.0.0:9420", p.git_gate_insteadof_host)
|
||||||
self.assertEqual("http", p.git_gate_insteadof_scheme)
|
self.assertEqual("http", p.git_gate_insteadof_scheme)
|
||||||
|
|
||||||
|
def test_guest_env_pins_global_git_config(self):
|
||||||
|
from bot_bottle.backend.firecracker.launch import _agent_guest_env
|
||||||
|
|
||||||
|
env = _agent_guest_env(self._plan(), "10.243.0.0")
|
||||||
|
self.assertEqual("/home/node/.gitconfig", env["GIT_CONFIG_GLOBAL"])
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
@@ -35,6 +35,15 @@ class TestBuildAgentRootfsDir(unittest.TestCase):
|
|||||||
build.assert_not_called()
|
build.assert_not_called()
|
||||||
self.assertEqual(base, out)
|
self.assertEqual(base, out)
|
||||||
|
|
||||||
|
def test_cached_lookup_requires_ready_marker(self):
|
||||||
|
digest = image_builder._rootfs_digest(self.dockerfile)
|
||||||
|
base = self.cache / "rootfs" / f"agent-{digest}"
|
||||||
|
base.mkdir(parents=True)
|
||||||
|
with patch.object(image_builder.util, "cache_dir", return_value=self.cache):
|
||||||
|
self.assertIsNone(image_builder.cached_agent_rootfs_dir(self.dockerfile))
|
||||||
|
(base / ".bb-ready").write_text("ok\n")
|
||||||
|
self.assertEqual(base, image_builder.cached_agent_rootfs_dir(self.dockerfile))
|
||||||
|
|
||||||
def test_cache_miss_builds_injects_and_marks_ready(self):
|
def test_cache_miss_builds_injects_and_marks_ready(self):
|
||||||
with patch.object(image_builder.util, "cache_dir", return_value=self.cache), \
|
with patch.object(image_builder.util, "cache_dir", return_value=self.cache), \
|
||||||
patch.object(image_builder, "_build_in_infra") as build, \
|
patch.object(image_builder, "_build_in_infra") as build, \
|
||||||
|
|||||||
@@ -71,6 +71,16 @@ class TestSshGatewayTransport(unittest.TestCase):
|
|||||||
t.exec(["mkdir", "-p", "/git-gate"])
|
t.exec(["mkdir", "-p", "/git-gate"])
|
||||||
|
|
||||||
|
|
||||||
|
class TestGatewayCaPem(unittest.TestCase):
|
||||||
|
def test_dies_when_cert_never_appears(self) -> None:
|
||||||
|
from subprocess import CompletedProcess
|
||||||
|
infra = infra_vm.InfraVm(vm=None, guest_ip="10.0.0.1", private_key=Path("/k"))
|
||||||
|
with patch.object(infra_vm.subprocess, "run",
|
||||||
|
return_value=CompletedProcess([], 1, stdout="", stderr="")), \
|
||||||
|
self.assertRaises(SystemExit):
|
||||||
|
infra.gateway_ca_pem(timeout=0)
|
||||||
|
|
||||||
|
|
||||||
class TestRegistryVolume(unittest.TestCase):
|
class TestRegistryVolume(unittest.TestCase):
|
||||||
def test_reuses_existing_volume(self):
|
def test_reuses_existing_volume(self):
|
||||||
import tempfile
|
import tempfile
|
||||||
|
|||||||
@@ -0,0 +1,81 @@
|
|||||||
|
"""Unit: image_cache.py — check_stale / check_stale_path."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from bot_bottle.image_cache import StaleImageError, check_stale, check_stale_path
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckStale(unittest.TestCase):
|
||||||
|
def _run(self, threshold: int, age_days: float) -> None:
|
||||||
|
created = datetime.now(tz=timezone.utc) - timedelta(days=age_days)
|
||||||
|
with patch("bot_bottle.image_cache.ConfigStore") as cs:
|
||||||
|
cs.return_value.cached_image_stale_warning_days.return_value = threshold
|
||||||
|
check_stale("test image", created)
|
||||||
|
|
||||||
|
def test_negative_threshold_never_raises(self):
|
||||||
|
# Threshold < 0 means the check is disabled — always passes.
|
||||||
|
self._run(threshold=-1, age_days=9999)
|
||||||
|
|
||||||
|
def test_zero_threshold_raises_immediately(self):
|
||||||
|
# threshold=0 means any image is stale the moment it exists.
|
||||||
|
with self.assertRaises(StaleImageError):
|
||||||
|
self._run(threshold=0, age_days=0.1)
|
||||||
|
|
||||||
|
def test_within_threshold_does_not_raise(self):
|
||||||
|
# Age well under threshold — should pass silently.
|
||||||
|
self._run(threshold=7, age_days=2)
|
||||||
|
|
||||||
|
def test_at_threshold_does_not_raise(self):
|
||||||
|
# Exactly at the boundary is fine (<=, not <).
|
||||||
|
self._run(threshold=1, age_days=0.9999)
|
||||||
|
|
||||||
|
def test_exceeds_threshold_raises(self):
|
||||||
|
created = datetime.now(tz=timezone.utc) - timedelta(days=3)
|
||||||
|
with patch("bot_bottle.image_cache.ConfigStore") as cs:
|
||||||
|
cs.return_value.cached_image_stale_warning_days.return_value = 1
|
||||||
|
with self.assertRaises(StaleImageError) as ctx:
|
||||||
|
check_stale("agent image 'bot-bottle:latest'", created)
|
||||||
|
self.assertIn("agent image", str(ctx.exception))
|
||||||
|
self.assertIn("day(s) old", str(ctx.exception))
|
||||||
|
|
||||||
|
def test_naive_datetime_treated_as_utc(self):
|
||||||
|
# check_stale calls .astimezone(utc) on the input; naive datetimes
|
||||||
|
# that would be interpreted as local time should still work.
|
||||||
|
# We can't control the local tz in a unit test, so just ensure
|
||||||
|
# no exception is thrown for a very recent naive datetime.
|
||||||
|
naive_now = datetime(2099, 1, 1) # far future, always "fresh"
|
||||||
|
with patch("bot_bottle.image_cache.ConfigStore") as cs:
|
||||||
|
cs.return_value.cached_image_stale_warning_days.return_value = 1
|
||||||
|
# Should not raise — the image is brand new.
|
||||||
|
check_stale("test image", naive_now)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckStalePath(unittest.TestCase):
|
||||||
|
def test_delegates_to_check_stale_with_mtime(self):
|
||||||
|
with tempfile.NamedTemporaryFile() as f:
|
||||||
|
path = Path(f.name)
|
||||||
|
with patch("bot_bottle.image_cache.check_stale") as mock_check:
|
||||||
|
check_stale_path("some artifact", path)
|
||||||
|
mock_check.assert_called_once()
|
||||||
|
label, dt = mock_check.call_args.args
|
||||||
|
self.assertEqual("some artifact", label)
|
||||||
|
self.assertIsInstance(dt, datetime)
|
||||||
|
self.assertIsNotNone(dt.tzinfo)
|
||||||
|
|
||||||
|
def test_raises_stale_for_old_file(self):
|
||||||
|
with tempfile.NamedTemporaryFile() as f:
|
||||||
|
path = Path(f.name)
|
||||||
|
with patch("bot_bottle.image_cache.ConfigStore") as cs:
|
||||||
|
cs.return_value.cached_image_stale_warning_days.return_value = 0
|
||||||
|
with self.assertRaises(StaleImageError):
|
||||||
|
check_stale_path("cached artifact", path)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -96,7 +96,7 @@ class TestVersionInputs(unittest.TestCase):
|
|||||||
(pkg / "app.py").write_text("print('hi')\n")
|
(pkg / "app.py").write_text("print('hi')\n")
|
||||||
(pkg / "egress_entrypoint.sh").write_text("#!/bin/sh\nexec mitmdump\n")
|
(pkg / "egress_entrypoint.sh").write_text("#!/bin/sh\nexec mitmdump\n")
|
||||||
(pkg / "netpool.defaults.env").write_text("FOO=1\n")
|
(pkg / "netpool.defaults.env").write_text("FOO=1\n")
|
||||||
for name in ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra"):
|
for name in ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra", "Dockerfile.infra.fc"):
|
||||||
(root / name).write_text(f"FROM scratch # {name}\n")
|
(root / name).write_text(f"FROM scratch # {name}\n")
|
||||||
(root / "pyproject.toml").write_text("[project]\nname = 'bot-bottle'\n")
|
(root / "pyproject.toml").write_text("[project]\nname = 'bot-bottle'\n")
|
||||||
|
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ from bot_bottle.git_gate import GitGatePlan
|
|||||||
from bot_bottle.orchestrator.client import RegisteredBottle
|
from bot_bottle.orchestrator.client import RegisteredBottle
|
||||||
|
|
||||||
_MOD = "bot_bottle.backend.macos_container.consolidated_launch"
|
_MOD = "bot_bottle.backend.macos_container.consolidated_launch"
|
||||||
|
_UTIL = "bot_bottle.backend.consolidated_util"
|
||||||
|
|
||||||
|
|
||||||
def _egress_plan() -> EgressPlan:
|
def _egress_plan() -> EgressPlan:
|
||||||
@@ -87,7 +88,8 @@ class TestRegisterAgent(unittest.TestCase):
|
|||||||
*, source_ip: str = "192.168.128.9",
|
*, source_ip: str = "192.168.128.9",
|
||||||
):
|
):
|
||||||
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_MOD}.provision_git_gate", provision or Mock()):
|
patch(f"{_UTIL}.provision_git_gate", provision or Mock()), \
|
||||||
|
patch(f"{_MOD}.live_source_ips", return_value=[]):
|
||||||
return register_agent(
|
return register_agent(
|
||||||
_egress_plan(), _git_plan(),
|
_egress_plan(), _git_plan(),
|
||||||
source_ip=source_ip, endpoint=_endpoint(), image_ref="img:1",
|
source_ip=source_ip, endpoint=_endpoint(), image_ref="img:1",
|
||||||
@@ -125,8 +127,8 @@ class TestTeardown(unittest.TestCase):
|
|||||||
def test_deregisters_and_deprovisions(self) -> None:
|
def test_deregisters_and_deprovisions(self) -> None:
|
||||||
client = Mock()
|
client = Mock()
|
||||||
deprovision = Mock()
|
deprovision = Mock()
|
||||||
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
with patch(f"{_UTIL}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_MOD}.deprovision_git_gate", deprovision):
|
patch(f"{_UTIL}.deprovision_git_gate", deprovision):
|
||||||
teardown_consolidated("b1", orchestrator_url="http://o:8099")
|
teardown_consolidated("b1", orchestrator_url="http://o:8099")
|
||||||
client.teardown_bottle.assert_called_once_with("b1")
|
client.teardown_bottle.assert_called_once_with("b1")
|
||||||
self.assertEqual("b1", deprovision.call_args.args[1])
|
self.assertEqual("b1", deprovision.call_args.args[1])
|
||||||
@@ -134,3 +136,104 @@ class TestTeardown(unittest.TestCase):
|
|||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|
||||||
|
|
||||||
|
class TestLiveSourceIps(unittest.TestCase):
|
||||||
|
"""The reconciliation input: the host enumerates its own bottles because
|
||||||
|
the orchestrator, inside the infra container, cannot see the backend."""
|
||||||
|
|
||||||
|
def _agents(self, *slugs: str) -> list[Mock]:
|
||||||
|
return [Mock(slug=s) for s in slugs]
|
||||||
|
|
||||||
|
def test_maps_slugs_to_container_addresses(self) -> None:
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import live_source_ips
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=self._agents("a", "b")), \
|
||||||
|
patch(f"{_MOD}.container_mod.inspect_container_network_ip",
|
||||||
|
side_effect=["10.0.0.1", "10.0.0.2"]) as ip:
|
||||||
|
got = live_source_ips("net0")
|
||||||
|
self.assertEqual(["10.0.0.1", "10.0.0.2"], got)
|
||||||
|
self.assertEqual("bot-bottle-a", ip.call_args_list[0].args[0])
|
||||||
|
|
||||||
|
def test_containers_without_an_address_are_skipped(self) -> None:
|
||||||
|
"""A container that hasn't been given a DHCP address yet contributes
|
||||||
|
nothing — the reap's grace window, not this list, protects it."""
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import live_source_ips
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=self._agents("a", "b")), \
|
||||||
|
patch(f"{_MOD}.container_mod.inspect_container_network_ip",
|
||||||
|
side_effect=["", "10.0.0.2"]):
|
||||||
|
self.assertEqual(["10.0.0.2"], live_source_ips("net0"))
|
||||||
|
|
||||||
|
def test_container_list_failure_raises(self) -> None:
|
||||||
|
"""If container list fails, the live set is not authoritative and
|
||||||
|
reconciliation must be skipped."""
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import live_source_ips
|
||||||
|
from bot_bottle.backend.macos_container.enumerate import EnumerationError
|
||||||
|
with patch(f"{_MOD}.enumerate_active",
|
||||||
|
side_effect=EnumerationError("container list failed")):
|
||||||
|
with self.assertRaises(EnumerationError):
|
||||||
|
live_source_ips("net0")
|
||||||
|
|
||||||
|
def test_per_container_inspect_failure_raises(self) -> None:
|
||||||
|
"""If any individual inspect fails, the live set is not authoritative."""
|
||||||
|
from bot_bottle.backend.macos_container.consolidated_launch import live_source_ips
|
||||||
|
from bot_bottle.backend.macos_container.enumerate import EnumerationError
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=self._agents("a", "b")), \
|
||||||
|
patch(f"{_MOD}.container_mod.inspect_container_network_ip",
|
||||||
|
side_effect=["10.0.0.1", None]):
|
||||||
|
with self.assertRaises(EnumerationError):
|
||||||
|
live_source_ips("net0")
|
||||||
|
|
||||||
|
|
||||||
|
class TestRegisterAgentReconciles(unittest.TestCase):
|
||||||
|
"""Registration self-heals the registry first: an orphan row at a recycled
|
||||||
|
address makes attribution ambiguous, which resolves no policy at all and
|
||||||
|
denies every host for the bottle being launched."""
|
||||||
|
|
||||||
|
def _register(self, client: Mock) -> None:
|
||||||
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
|
patch(f"{_UTIL}.provision_git_gate"), \
|
||||||
|
patch(f"{_MOD}.live_source_ips", return_value=["10.0.0.7"]):
|
||||||
|
register_agent(
|
||||||
|
_egress_plan(), _git_plan(),
|
||||||
|
source_ip="10.0.0.7", endpoint=_endpoint(),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_reconciles_before_registering(self) -> None:
|
||||||
|
client = _client()
|
||||||
|
calls: list[str] = []
|
||||||
|
|
||||||
|
def _reconcile(*_args: object, **_kwargs: object) -> list[str]:
|
||||||
|
calls.append("reconcile")
|
||||||
|
return []
|
||||||
|
|
||||||
|
def _register_bottle(*_args: object, **_kwargs: object) -> RegisteredBottle:
|
||||||
|
calls.append("register")
|
||||||
|
return RegisteredBottle("b1", "tok")
|
||||||
|
|
||||||
|
client.reconcile.side_effect = _reconcile
|
||||||
|
client.register_bottle.side_effect = _register_bottle
|
||||||
|
self._register(client)
|
||||||
|
self.assertEqual(["reconcile", "register"], calls)
|
||||||
|
client.reconcile.assert_called_once_with(["10.0.0.7"])
|
||||||
|
|
||||||
|
def test_a_reconcile_failure_does_not_block_the_launch(self) -> None:
|
||||||
|
from bot_bottle.orchestrator.client import OrchestratorClientError
|
||||||
|
client = _client()
|
||||||
|
client.reconcile.side_effect = OrchestratorClientError("unreachable")
|
||||||
|
self._register(client)
|
||||||
|
client.register_bottle.assert_called_once()
|
||||||
|
|
||||||
|
def test_enumeration_error_does_not_block_the_launch(self) -> None:
|
||||||
|
"""A partial container listing must not abort the launch — skip
|
||||||
|
reconciliation and proceed, just as with an unreachable orchestrator."""
|
||||||
|
from bot_bottle.backend.macos_container.enumerate import EnumerationError
|
||||||
|
client = _client()
|
||||||
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
|
patch(f"{_UTIL}.provision_git_gate"), \
|
||||||
|
patch(f"{_MOD}.live_source_ips",
|
||||||
|
side_effect=EnumerationError("container list failed")):
|
||||||
|
register_agent(
|
||||||
|
_egress_plan(), _git_plan(),
|
||||||
|
source_ip="10.0.0.7", endpoint=_endpoint(),
|
||||||
|
)
|
||||||
|
client.register_bottle.assert_called_once()
|
||||||
|
|||||||
@@ -66,8 +66,10 @@ class TestMacosContainerEnumerate(unittest.TestCase):
|
|||||||
agents = self._enumerate("bot-bottle-mac-infra\nbot-bottle-dev-abc\n")
|
agents = self._enumerate("bot-bottle-mac-infra\nbot-bottle-dev-abc\n")
|
||||||
self.assertEqual(["dev-abc"], [a.slug for a in agents])
|
self.assertEqual(["dev-abc"], [a.slug for a in agents])
|
||||||
|
|
||||||
def test_empty_when_the_cli_fails(self):
|
def test_raises_when_the_cli_fails(self):
|
||||||
self.assertEqual([], self._enumerate("", returncode=1))
|
from bot_bottle.backend.macos_container.enumerate import EnumerationError
|
||||||
|
with self.assertRaises(EnumerationError):
|
||||||
|
self._enumerate("", returncode=1)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import unittest
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from types import SimpleNamespace
|
from types import SimpleNamespace
|
||||||
from typing import cast
|
from typing import cast
|
||||||
from unittest.mock import patch
|
from unittest.mock import ANY, patch
|
||||||
|
|
||||||
from bot_bottle.backend.macos_container.bottle import MacosContainerBottle
|
from bot_bottle.backend.macos_container.bottle import MacosContainerBottle
|
||||||
from bot_bottle.backend.macos_container.bottle_plan import MacosContainerBottlePlan
|
from bot_bottle.backend.macos_container.bottle_plan import MacosContainerBottlePlan
|
||||||
@@ -21,7 +21,9 @@ from bot_bottle.backend.macos_container.gateway_hosts import GATEWAY_HOSTNAME
|
|||||||
from bot_bottle.backend.macos_container.launch import (
|
from bot_bottle.backend.macos_container.launch import (
|
||||||
_agent_run_argv,
|
_agent_run_argv,
|
||||||
_identity_proxy_env,
|
_identity_proxy_env,
|
||||||
|
build_or_load_images,
|
||||||
)
|
)
|
||||||
|
from bot_bottle.log import Die
|
||||||
from bot_bottle.manifest import ManifestIndex
|
from bot_bottle.manifest import ManifestIndex
|
||||||
|
|
||||||
_BOTTLE = "bot_bottle.backend.macos_container.bottle"
|
_BOTTLE = "bot_bottle.backend.macos_container.bottle"
|
||||||
@@ -46,6 +48,8 @@ def _plan(
|
|||||||
*,
|
*,
|
||||||
agent_git_gate_url: str = "",
|
agent_git_gate_url: str = "",
|
||||||
agent_supervise_url: str = "",
|
agent_supervise_url: str = "",
|
||||||
|
image_policy: str = "fresh",
|
||||||
|
nested_containers: bool = False,
|
||||||
) -> MacosContainerBottlePlan:
|
) -> MacosContainerBottlePlan:
|
||||||
routes_path = stage_dir / "routes.yaml"
|
routes_path = stage_dir / "routes.yaml"
|
||||||
routes_path.write_text("routes: []\n", encoding="utf-8")
|
routes_path.write_text("routes: []\n", encoding="utf-8")
|
||||||
@@ -60,12 +64,14 @@ def _plan(
|
|||||||
canary_env="",
|
canary_env="",
|
||||||
)
|
)
|
||||||
return cast(MacosContainerBottlePlan, SimpleNamespace(
|
return cast(MacosContainerBottlePlan, SimpleNamespace(
|
||||||
spec=SimpleNamespace(),
|
spec=SimpleNamespace(image_policy=image_policy),
|
||||||
manifest=_MANIFEST,
|
manifest=_MANIFEST,
|
||||||
stage_dir=stage_dir,
|
stage_dir=stage_dir,
|
||||||
slug="dev-abc",
|
slug="dev-abc",
|
||||||
|
nested_containers=nested_containers,
|
||||||
container_name="bot-bottle-dev-abc",
|
container_name="bot-bottle-dev-abc",
|
||||||
image="bot-bottle-agent:latest",
|
image="bot-bottle-agent:latest",
|
||||||
|
dockerfile_path="/repo/Dockerfile",
|
||||||
forwarded_env={"OAUTH_TOKEN": "host-value"},
|
forwarded_env={"OAUTH_TOKEN": "host-value"},
|
||||||
egress_plan=egress_plan,
|
egress_plan=egress_plan,
|
||||||
git_gate_plan=SimpleNamespace(upstreams=()),
|
git_gate_plan=SimpleNamespace(upstreams=()),
|
||||||
@@ -79,6 +85,88 @@ def _plan(
|
|||||||
))
|
))
|
||||||
|
|
||||||
|
|
||||||
|
class TestBuildOrLoadImages(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self._tmp = tempfile.TemporaryDirectory()
|
||||||
|
self.plan = _plan(Path(self._tmp.name))
|
||||||
|
|
||||||
|
def tearDown(self) -> None:
|
||||||
|
self._tmp.cleanup()
|
||||||
|
|
||||||
|
def test_reuses_present_committed_image(self) -> None:
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.read_committed_image",
|
||||||
|
return_value="committed:latest",
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.image_exists",
|
||||||
|
return_value=True,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.build_image"
|
||||||
|
) as build,
|
||||||
|
):
|
||||||
|
images = build_or_load_images(self.plan)
|
||||||
|
|
||||||
|
self.assertEqual("committed:latest", images.agent)
|
||||||
|
build.assert_not_called()
|
||||||
|
|
||||||
|
def test_reuses_present_cached_image(self) -> None:
|
||||||
|
plan = _plan(Path(self._tmp.name), image_policy="cached")
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.read_committed_image",
|
||||||
|
return_value=None,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.image_exists",
|
||||||
|
return_value=True,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.build_image"
|
||||||
|
) as build,
|
||||||
|
):
|
||||||
|
images = build_or_load_images(plan)
|
||||||
|
|
||||||
|
self.assertEqual(plan.image, images.agent)
|
||||||
|
build.assert_not_called()
|
||||||
|
|
||||||
|
def test_cached_policy_rejects_missing_image(self) -> None:
|
||||||
|
plan = _plan(Path(self._tmp.name), image_policy="cached")
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.read_committed_image",
|
||||||
|
return_value=None,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.image_exists",
|
||||||
|
return_value=False,
|
||||||
|
),
|
||||||
|
):
|
||||||
|
with self.assertRaises(Die):
|
||||||
|
build_or_load_images(plan)
|
||||||
|
|
||||||
|
def test_fresh_policy_builds_image(self) -> None:
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.read_committed_image",
|
||||||
|
return_value=None,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"bot_bottle.backend.macos_container.launch.container_mod.build_image"
|
||||||
|
) as build,
|
||||||
|
):
|
||||||
|
images = build_or_load_images(self.plan)
|
||||||
|
|
||||||
|
self.assertEqual(self.plan.image, images.agent)
|
||||||
|
build.assert_called_once_with(
|
||||||
|
self.plan.image,
|
||||||
|
ANY,
|
||||||
|
dockerfile=self.plan.dockerfile_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class TestAgentRunArgv(unittest.TestCase):
|
class TestAgentRunArgv(unittest.TestCase):
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
self._tmp = tempfile.TemporaryDirectory()
|
self._tmp = tempfile.TemporaryDirectory()
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user