Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c527841d55 | |||
| 5940b75bb7 | |||
| 5e01c28016 | |||
| 2f8539c2c7 | |||
| ad100b8a84 | |||
| c7375051fd | |||
| d9e685e860 | |||
| b4b73a8acc | |||
| b1ebc6f1b8 | |||
| 8b5b5730ae |
@@ -1,6 +1,10 @@
|
|||||||
[run]
|
[run]
|
||||||
branch = True
|
branch = True
|
||||||
source = .
|
source = .
|
||||||
|
# Store paths relative to the project root so .coverage.* files produced on
|
||||||
|
# different runners (ubuntu-latest vs self-hosted KVM) can be combined by the
|
||||||
|
# coverage job without a [paths] remapping section.
|
||||||
|
relative_files = True
|
||||||
|
|
||||||
[report]
|
[report]
|
||||||
# Coverage policy: see docs/decisions/0004-coverage-policy.md.
|
# Coverage policy: see docs/decisions/0004-coverage-policy.md.
|
||||||
|
|||||||
+99
-112
@@ -9,10 +9,12 @@
|
|||||||
# tests/canaries/ — upstream regression canaries; run on a separate
|
# tests/canaries/ — upstream regression canaries; run on a separate
|
||||||
# schedule (see canaries.yml), not here
|
# schedule (see canaries.yml), not here
|
||||||
#
|
#
|
||||||
# Integration tests run once per backend in separate jobs. Each job sets
|
# Each test job runs once under coverage and uploads a small .coverage.*
|
||||||
# BOT_BOTTLE_BACKEND explicitly so the test suite uses the right backend.
|
# artifact. The `coverage` job combines them — no test reruns, no KVM
|
||||||
# Backends that aren't available on the runner fail the preflight step
|
# dependency on that job. For main-branch pushes only, the tested rootfs
|
||||||
# rather than silently skipping inside the test output.
|
# and matching dropbear are uploaded so `publish-infra` can publish the
|
||||||
|
# byte-identical artifact that was tested. PRs avoid the ~194 MB rootfs
|
||||||
|
# transfer entirely.
|
||||||
|
|
||||||
name: test
|
name: test
|
||||||
|
|
||||||
@@ -40,53 +42,6 @@ on:
|
|||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
stage-firecracker-inputs:
|
|
||||||
runs-on: [self-hosted, kvm]
|
|
||||||
# Same guard as the other KVM-runner jobs: don't spin the privileged
|
|
||||||
# runner for fork PRs (this only copies a non-secret static binary, but
|
|
||||||
# keep the posture consistent — build-infra/integration/coverage all
|
|
||||||
# depend on it, so gating here gates the whole Firecracker chain).
|
|
||||||
if: >-
|
|
||||||
github.event_name == 'push' ||
|
|
||||||
github.event_name == 'workflow_dispatch' ||
|
|
||||||
(github.event_name == 'pull_request' &&
|
|
||||||
github.event.pull_request.head.repo.full_name == github.repository)
|
|
||||||
steps:
|
|
||||||
- name: Stage the provisioned static dropbear
|
|
||||||
run: |
|
|
||||||
mkdir -p firecracker-inputs
|
|
||||||
cp /var/cache/bot-bottle-fc/dropbear firecracker-inputs/dropbear
|
|
||||||
|
|
||||||
- name: Upload Firecracker build inputs
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: firecracker-inputs
|
|
||||||
path: firecracker-inputs/
|
|
||||||
|
|
||||||
build-infra:
|
|
||||||
needs: stage-firecracker-inputs
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Download Firecracker build inputs
|
|
||||||
uses: actions/download-artifact@v3
|
|
||||||
with:
|
|
||||||
name: firecracker-inputs
|
|
||||||
path: firecracker-inputs
|
|
||||||
|
|
||||||
- name: Build infra candidate from this checkout
|
|
||||||
env:
|
|
||||||
BOT_BOTTLE_FC_DROPBEAR: ${{ github.workspace }}/firecracker-inputs/dropbear
|
|
||||||
run: python3 -m bot_bottle.backend.firecracker.publish_infra --output infra-candidate
|
|
||||||
|
|
||||||
- name: Upload infra candidate
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: infra-candidate
|
|
||||||
path: infra-candidate/
|
|
||||||
|
|
||||||
unit:
|
unit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
@@ -101,11 +56,17 @@ jobs:
|
|||||||
- name: Install dev requirements
|
- name: Install dev requirements
|
||||||
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
|
- name: Run unit tests with coverage
|
||||||
run: python3 -m coverage run -m unittest discover -t . -s tests/unit -v
|
run: python3 -m coverage run --data-file=.coverage.unit -m unittest discover -t . -s tests/unit -v
|
||||||
|
|
||||||
- name: Report unit coverage
|
- name: Report unit coverage
|
||||||
run: python3 -m coverage report -m
|
run: python3 -m coverage report --data-file=.coverage.unit -m
|
||||||
|
|
||||||
|
- name: Upload unit coverage artifact
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-unit
|
||||||
|
path: ${{ github.workspace }}/.coverage.unit
|
||||||
|
|
||||||
integration-docker:
|
integration-docker:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -115,6 +76,9 @@ jobs:
|
|||||||
|
|
||||||
# No actions/setup-python (see the note in the `unit` job); the
|
# No actions/setup-python (see the note in the `unit` job); the
|
||||||
# container's system Python 3.12 runs the stdlib test suite directly.
|
# container's system Python 3.12 runs the stdlib test suite directly.
|
||||||
|
- name: Install coverage
|
||||||
|
run: python3 -m pip install --break-system-packages coverage
|
||||||
|
|
||||||
- name: Show environment
|
- name: Show environment
|
||||||
run: |
|
run: |
|
||||||
python3 --version
|
python3 --version
|
||||||
@@ -124,10 +88,16 @@ jobs:
|
|||||||
echo "docker not on PATH — integration tests will skip"
|
echo "docker not on PATH — integration tests will skip"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Run integration tests (docker)
|
- name: Run integration tests (docker) with coverage
|
||||||
env:
|
env:
|
||||||
BOT_BOTTLE_BACKEND: docker
|
BOT_BOTTLE_BACKEND: docker
|
||||||
run: python3 -m unittest discover -t . -s tests/integration -v
|
run: python3 -m coverage run --data-file=.coverage.docker -m unittest discover -t . -s tests/integration -v
|
||||||
|
|
||||||
|
- name: Upload docker coverage artifact
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-docker
|
||||||
|
path: ${{ github.workspace }}/.coverage.docker
|
||||||
|
|
||||||
# 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.
|
||||||
@@ -137,9 +107,16 @@ jobs:
|
|||||||
#
|
#
|
||||||
# Runner prerequisites (provision once; see README "Firecracker on Linux"):
|
# Runner prerequisites (provision once; see README "Firecracker on Linux"):
|
||||||
# `firecracker` on PATH, `/dev/kvm` accessible, cached kernel +
|
# `firecracker` on PATH, `/dev/kvm` accessible, cached kernel +
|
||||||
# static dropbear, and the pool as a persistent systemd unit.
|
# static dropbear at /var/cache/bot-bottle-fc/dropbear, and the pool as a
|
||||||
|
# persistent systemd unit.
|
||||||
|
#
|
||||||
|
# The infra candidate is built here directly (no artifact download) to
|
||||||
|
# eliminate the ~70 s ubuntu-latest upload + ~83 s combined download that
|
||||||
|
# the old build-infra → integration-firecracker + coverage chain incurred.
|
||||||
|
# For main-branch pushes the tested rootfs and matching dropbear are
|
||||||
|
# uploaded so publish-infra can publish the byte-identical artifact; PRs
|
||||||
|
# skip those uploads entirely.
|
||||||
integration-firecracker:
|
integration-firecracker:
|
||||||
needs: build-infra
|
|
||||||
runs-on: [self-hosted, kvm]
|
runs-on: [self-hosted, kvm]
|
||||||
if: >-
|
if: >-
|
||||||
github.event_name == 'push' ||
|
github.event_name == 'push' ||
|
||||||
@@ -159,49 +136,58 @@ jobs:
|
|||||||
# range overlap; it prints the exact `backend setup` fix.
|
# range overlap; it prints the exact `backend setup` fix.
|
||||||
python3 cli.py backend status --backend=firecracker
|
python3 cli.py backend status --backend=firecracker
|
||||||
|
|
||||||
- name: Download the candidate built from this checkout
|
- name: Build infra candidate from this checkout
|
||||||
uses: actions/download-artifact@v3
|
env:
|
||||||
with:
|
BOT_BOTTLE_FC_DROPBEAR: /var/cache/bot-bottle-fc/dropbear
|
||||||
name: infra-candidate
|
run: python3 -m bot_bottle.backend.firecracker.publish_infra --output infra-candidate
|
||||||
path: infra-candidate
|
|
||||||
|
|
||||||
- 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()'
|
||||||
|
|
||||||
# No dev-requirements install: the integration suite runs on stdlib
|
# No dev-requirements install: `coverage` is already provided by the
|
||||||
# `unittest` (pylint/pyright are lint.yml's concern, not this job's),
|
# self-hosted runner's Nix python env, and that env has no `pip`
|
||||||
# and the self-hosted runner's Nix python env has no `pip` module
|
# module to install into anyway.
|
||||||
# (`python3 -m pip` → "No module named pip"). Nothing to install.
|
- name: Run integration tests (firecracker) with coverage
|
||||||
- name: Run integration tests (firecracker)
|
|
||||||
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 unittest discover -t . -s tests/integration -v
|
run: python3 -m coverage run --data-file=.coverage.firecracker -m unittest discover -t . -s tests/integration -v
|
||||||
|
|
||||||
# Combined unit+integration coverage + the diff-coverage gate (the hard
|
- name: Upload firecracker coverage artifact
|
||||||
# gate: new/changed lines >= 90%). See docs/decisions/0004-coverage-policy.md.
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-firecracker
|
||||||
|
path: ${{ github.workspace }}/.coverage.firecracker
|
||||||
|
|
||||||
|
# Only upload the large rootfs artifact on main-branch pushes;
|
||||||
|
# PRs avoid the ~194 MB transfer. publish-infra only runs on main
|
||||||
|
# and downloads these to publish the byte-identical tested rootfs.
|
||||||
|
- name: Upload tested rootfs (main branch only)
|
||||||
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: infra-candidate
|
||||||
|
path: infra-candidate/
|
||||||
|
|
||||||
|
- name: Upload dropbear for publish verification (main branch only)
|
||||||
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: firecracker-inputs
|
||||||
|
path: /var/cache/bot-bottle-fc/dropbear
|
||||||
|
|
||||||
|
# Combined coverage gate: aggregates .coverage.* artifacts uploaded by each
|
||||||
|
# test job, then runs the diff-coverage gate (new/changed lines >= 90%).
|
||||||
#
|
#
|
||||||
# This runs on a self-hosted KVM runner (label `kvm`), NOT ubuntu-latest,
|
# Runs on ubuntu-latest — no KVM needed, no test reruns. Coverage files use
|
||||||
# because the Firecracker backend's subprocess/VM orchestration
|
# relative_files = True (.coveragerc) so they combine cleanly across runners.
|
||||||
# (launch/boot/SSH/isolation-probe) is covered by the integration suite,
|
|
||||||
# and that suite needs `/dev/kvm` + the provisioned TAP/nft pool — which a
|
|
||||||
# container-based runner doesn't have. On such a runner the firecracker
|
|
||||||
# integration test skips and its ~230 orchestration lines read as
|
|
||||||
# uncovered, so the gate can't pass there.
|
|
||||||
#
|
#
|
||||||
# Restricted to the same events as integration-firecracker (same-repo PRs,
|
# Restricted to the same events as integration-firecracker: it depends on
|
||||||
# push, workflow_dispatch) for the same security reason.
|
# that job's coverage artifact and skips for fork PRs alongside it.
|
||||||
#
|
|
||||||
# See #414 for the planned follow-up: artifact-based coverage combination
|
|
||||||
# (run tests once in their respective jobs, combine .coverage files here).
|
|
||||||
#
|
|
||||||
# build-infra creates one candidate from the checkout. This job boots that
|
|
||||||
# same candidate after integration-firecracker has exercised it; the main
|
|
||||||
# push path publishes the identical bytes only after every required job.
|
|
||||||
coverage:
|
coverage:
|
||||||
needs: [build-infra, integration-firecracker]
|
needs: [unit, integration-docker, integration-firecracker]
|
||||||
timeout-minutes: 15
|
timeout-minutes: 15
|
||||||
runs-on: [self-hosted, kvm]
|
runs-on: ubuntu-latest
|
||||||
if: >-
|
if: >-
|
||||||
github.event_name == 'push' ||
|
github.event_name == 'push' ||
|
||||||
github.event_name == 'workflow_dispatch' ||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
@@ -213,29 +199,29 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Preflight — Firecracker host is ready
|
- name: Install coverage
|
||||||
run: |
|
run: python3 -m pip install --break-system-packages coverage
|
||||||
command -v firecracker >/dev/null || {
|
|
||||||
echo "firecracker not on PATH — provision the runner (README: Firecracker on Linux)"; exit 1; }
|
|
||||||
test -e /dev/kvm || { echo "/dev/kvm missing — KVM not available on this runner"; exit 1; }
|
|
||||||
# `backend status` exits non-zero unless the TAP pool is up + no
|
|
||||||
# range overlap; it prints the exact `backend setup` fix.
|
|
||||||
python3 cli.py backend status --backend=firecracker
|
|
||||||
|
|
||||||
- name: Download the candidate already exercised by integration
|
- name: Download unit coverage artifact
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: infra-candidate
|
name: coverage-unit
|
||||||
path: infra-candidate
|
path: ${{ github.workspace }}
|
||||||
|
|
||||||
|
- name: Download docker coverage artifact
|
||||||
|
uses: actions/download-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-docker
|
||||||
|
path: ${{ github.workspace }}
|
||||||
|
|
||||||
|
- name: Download firecracker coverage artifact
|
||||||
|
uses: actions/download-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-firecracker
|
||||||
|
path: ${{ github.workspace }}
|
||||||
|
|
||||||
# No dev-requirements install: `coverage` is already provided by the
|
|
||||||
# self-hosted runner's Nix python env, and that env has no `pip`
|
|
||||||
# module to install into anyway. `scripts/coverage.sh` +
|
|
||||||
# `diff_coverage.py` need only `coverage` (not pylint/pyright).
|
|
||||||
- name: Combined coverage (unit + integration, incl. firecracker)
|
- name: Combined coverage (unit + integration, incl. firecracker)
|
||||||
env:
|
run: PYTHON=python3 bash scripts/coverage.sh aggregate critical
|
||||||
BOT_BOTTLE_CI_INFRA_ARTIFACT_DIR: ${{ github.workspace }}/infra-candidate
|
|
||||||
run: PYTHON=python3 bash scripts/coverage.sh critical
|
|
||||||
|
|
||||||
- name: Diff-coverage gate (changed lines >= 90%)
|
- name: Diff-coverage gate (changed lines >= 90%)
|
||||||
run: |
|
run: |
|
||||||
@@ -243,14 +229,14 @@ jobs:
|
|||||||
python3 scripts/diff_coverage.py --base origin/main --min 90
|
python3 scripts/diff_coverage.py --base origin/main --min 90
|
||||||
|
|
||||||
publish-infra:
|
publish-infra:
|
||||||
needs: [stage-firecracker-inputs, build-infra, unit, integration-docker, integration-firecracker, coverage]
|
needs: [unit, integration-docker, integration-firecracker, coverage]
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the tested revision
|
- name: Checkout the tested revision
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Download the tested candidate
|
- name: Download the tested rootfs
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: infra-candidate
|
name: infra-candidate
|
||||||
@@ -258,9 +244,10 @@ jobs:
|
|||||||
|
|
||||||
# publish_infra re-derives the version from the checkout to confirm the
|
# publish_infra re-derives the version from the checkout to confirm the
|
||||||
# bundle matches before uploading, and the version hashes the dropbear
|
# bundle matches before uploading, and the version hashes the dropbear
|
||||||
# bytes. Stage the SAME dropbear build-infra used, or the recheck
|
# bytes. Download the SAME dropbear integration-firecracker used, or
|
||||||
# computes a "<missing>"-dropbear version and rejects the candidate.
|
# the recheck computes a "<missing>"-dropbear version and rejects the
|
||||||
- name: Download the staged dropbear (matches build-infra's version)
|
# candidate.
|
||||||
|
- name: Download the staged dropbear (matches build's version)
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v3
|
||||||
with:
|
with:
|
||||||
name: firecracker-inputs
|
name: firecracker-inputs
|
||||||
|
|||||||
+36
-13
@@ -1,22 +1,45 @@
|
|||||||
# Shared infra image: gateway data plane + orchestrator control plane.
|
# Firecracker single infra-VM image (PRD 0070 Stage B).
|
||||||
#
|
#
|
||||||
# Used directly by the Docker backend (run as one `bot-bottle-infra`
|
# The per-host infra VM runs the orchestrator control plane, the gateway
|
||||||
# container, replacing the prior two-container split). The Firecracker
|
# data plane, AND builds agent images (buildah) — all in one microVM (see
|
||||||
# backend extends this via Dockerfile.infra.fc, adding buildah/crun/
|
# backend/firecracker/infra_vm.py). It composes:
|
||||||
# netavark for in-VM agent-image building.
|
# * FROM the gateway image (mitmproxy / git / gitleaks / supervise + the
|
||||||
#
|
# flat daemon modules) — now trixie-based, so buildah 1.39 is available;
|
||||||
# Dockerfile.orchestrator is the single definition of the orchestrator
|
# * `COPY --from` the orchestrator image's content (the single definition
|
||||||
# content (the lean `bot_bottle` package on python:3.12-slim). Both this
|
# of the control-plane payload — see Dockerfile.orchestrator), so this
|
||||||
# image and Dockerfile.infra.fc pull it in via `COPY --from`.
|
# VM and the docker backend share one orchestrator definition; and
|
||||||
|
# * 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
|
||||||
|
|
||||||
# The orchestrator content, from its single definition. The gateway image
|
# --- in-VM agent-image builder (PRD 0069 Stage 3) -------------------
|
||||||
# already has the flat daemon modules under /app; this adds the full
|
# The Firecracker backend builds users' agent Dockerfiles *inside this VM*
|
||||||
# `bot_bottle` package so `python3 -m bot_bottle.orchestrator` resolves —
|
# with buildah (rootless, daemonless) instead of on the host — no host
|
||||||
# used by gateway_init when BOT_BOTTLE_GATEWAY_DAEMONS includes `orchestrator`.
|
# Docker daemon, no root-equivalent `docker` group. `crun` is the OCI
|
||||||
|
# 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
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -45,7 +45,8 @@ from typing import TYPE_CHECKING, Any, 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
|
||||||
from ..git_gate import GitGatePlan
|
from ..git_gate import GitGatePlan
|
||||||
from ..log import die, info
|
from ..log import die, info, warn
|
||||||
|
from ..util import read_tty_line
|
||||||
from ..manifest import Manifest, ManifestIndex
|
from ..manifest import Manifest, ManifestIndex
|
||||||
from ..supervise import SupervisePlan
|
from ..supervise import SupervisePlan
|
||||||
from ..util import expand_tilde
|
from ..util import expand_tilde
|
||||||
@@ -648,19 +649,26 @@ def __getattr__(name: str) -> Any:
|
|||||||
|
|
||||||
def get_bottle_backend(
|
def get_bottle_backend(
|
||||||
name: str | None = None,
|
name: str | None = None,
|
||||||
|
*,
|
||||||
|
prompt: bool = True,
|
||||||
) -> BottleBackend[Any, Any]:
|
) -> BottleBackend[Any, Any]:
|
||||||
"""Resolve the bottle backend.
|
"""Resolve the bottle backend.
|
||||||
|
|
||||||
`name` precedence:
|
`name` precedence:
|
||||||
1. explicit arg (CLI `--backend=<name>` passes through here)
|
1. explicit arg (e.g. resume passes the recorded backend name)
|
||||||
2. BOT_BOTTLE_BACKEND env var
|
2. BOT_BOTTLE_BACKEND env var
|
||||||
3. `macos-container` on compatible macOS hosts
|
3. auto-selection: VM backend first, docker fallback with prompt
|
||||||
4. `firecracker` on KVM-capable Linux hosts
|
|
||||||
5. default `docker`
|
`prompt` controls whether auto-selection may block on an interactive
|
||||||
|
[i/d/q] prompt when falling back to docker. Pass `prompt=False` in
|
||||||
|
non-interactive contexts (headless launches, CI) so the call dies
|
||||||
|
with an actionable message instead of hanging.
|
||||||
|
|
||||||
Dies with a pointer at the known backends if the chosen name
|
Dies with a pointer at the known backends if the chosen name
|
||||||
isn't implemented."""
|
isn't implemented."""
|
||||||
resolved = name or os.environ.get("BOT_BOTTLE_BACKEND") or _default_backend_name()
|
resolved = name or os.environ.get("BOT_BOTTLE_BACKEND")
|
||||||
|
if resolved is None:
|
||||||
|
resolved = _auto_select_backend(prompt=prompt)
|
||||||
backends = _get_backends()
|
backends = _get_backends()
|
||||||
if resolved not in backends:
|
if resolved not in backends:
|
||||||
known = ", ".join(sorted(backends))
|
known = ", ".join(sorted(backends))
|
||||||
@@ -668,7 +676,35 @@ def get_bottle_backend(
|
|||||||
return backends[resolved]
|
return backends[resolved]
|
||||||
|
|
||||||
|
|
||||||
def _default_backend_name() -> str:
|
def _platform_vm_suggestion() -> str:
|
||||||
|
"""Platform-appropriate VM backend name for install suggestions."""
|
||||||
|
return "macos-container" if sys.platform == "darwin" else "firecracker"
|
||||||
|
|
||||||
|
|
||||||
|
def _print_vm_install_instructions() -> None:
|
||||||
|
"""Print platform-appropriate VM backend install instructions to stderr."""
|
||||||
|
vm = _platform_vm_suggestion()
|
||||||
|
if vm == "macos-container":
|
||||||
|
info("Install Apple Container: https://github.com/apple/container/releases")
|
||||||
|
info("Then start the service: container system start")
|
||||||
|
else:
|
||||||
|
info("Install Firecracker: https://github.com/firecracker-microvm/firecracker/releases")
|
||||||
|
info("Configure the host: ./cli.py backend setup")
|
||||||
|
|
||||||
|
|
||||||
|
def _auto_select_backend(prompt: bool = True) -> str:
|
||||||
|
"""Tier-1 / tier-2 backend auto-selection.
|
||||||
|
|
||||||
|
Tier 1: VM backend — macos-container on macOS when Apple Container is
|
||||||
|
installed; firecracker on KVM-capable Linux even before the binary is
|
||||||
|
present (its preflight prints an install pointer).
|
||||||
|
|
||||||
|
Tier 2: docker, with a security warning and an interactive prompt.
|
||||||
|
When `prompt=False` (headless / CI), dies with an actionable message
|
||||||
|
instead of blocking on a TTY read. When docker is also absent, prints
|
||||||
|
VM install instructions and exits.
|
||||||
|
"""
|
||||||
|
# --- Tier 1: VM backend -----------------------------------------
|
||||||
if has_backend("macos-container"):
|
if has_backend("macos-container"):
|
||||||
return "macos-container"
|
return "macos-container"
|
||||||
# A KVM-capable Linux host defaults to firecracker even when the
|
# A KVM-capable Linux host defaults to firecracker even when the
|
||||||
@@ -678,7 +714,37 @@ def _default_backend_name() -> str:
|
|||||||
from .firecracker import FirecrackerBottleBackend
|
from .firecracker import FirecrackerBottleBackend
|
||||||
if FirecrackerBottleBackend.is_host_capable():
|
if FirecrackerBottleBackend.is_host_capable():
|
||||||
return "firecracker"
|
return "firecracker"
|
||||||
|
|
||||||
|
# --- Tier 2: docker fallback ------------------------------------
|
||||||
|
if not has_backend("docker"):
|
||||||
|
info("No backend available on this host.")
|
||||||
|
_print_vm_install_instructions()
|
||||||
|
die("no backend available; install a VM backend and re-run")
|
||||||
|
|
||||||
|
vm = _platform_vm_suggestion()
|
||||||
|
warn(
|
||||||
|
"docker is less secure than VM backends — "
|
||||||
|
"containers share the host kernel."
|
||||||
|
)
|
||||||
|
if not prompt:
|
||||||
|
die(
|
||||||
|
f"no VM backend available; set BOT_BOTTLE_BACKEND=docker to proceed "
|
||||||
|
f"with docker, or install the {vm!r} backend."
|
||||||
|
)
|
||||||
|
sys.stderr.write(
|
||||||
|
f"bot-bottle: For better isolation, install the {vm!r} backend.\n"
|
||||||
|
f" [i] show {vm} install instructions and exit\n"
|
||||||
|
" [d] use docker anyway\n"
|
||||||
|
" [q] quit\n"
|
||||||
|
"bot-bottle: choice [i/d/q]: "
|
||||||
|
)
|
||||||
|
sys.stderr.flush()
|
||||||
|
reply = read_tty_line().strip().lower()
|
||||||
|
if reply == "d":
|
||||||
return "docker"
|
return "docker"
|
||||||
|
if reply == "i":
|
||||||
|
_print_vm_install_instructions()
|
||||||
|
die("not proceeding with docker; install a VM backend or set BOT_BOTTLE_BACKEND=docker")
|
||||||
|
|
||||||
|
|
||||||
def known_backend_names() -> tuple[str, ...]:
|
def known_backend_names() -> tuple[str, ...]:
|
||||||
|
|||||||
@@ -1,55 +0,0 @@
|
|||||||
"""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,
|
|
||||||
) -> None:
|
|
||||||
"""Deregister the bottle and remove its git-gate state. Both steps are
|
|
||||||
idempotent so this is safe from a cleanup trap."""
|
|
||||||
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
|
||||||
deprovision_git_gate(transport, bottle_id)
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = ["provision_bottle", "teardown_consolidated"]
|
|
||||||
@@ -1,13 +1,19 @@
|
|||||||
"""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:
|
Composes the orchestrator primitives into the register/teardown sequence that
|
||||||
|
replaces the per-bottle gateway:
|
||||||
|
|
||||||
1. ensure the single infra container (control plane + gateway) is up;
|
1. ensure the orchestrator control plane + shared gateway are up;
|
||||||
2. allocate the bottle a pinned source IP on the gateway network;
|
2. allocate the bottle a pinned source IP on the gateway network (the
|
||||||
3. register it and provision its git-gate repos/creds into the gateway.
|
attribution key), skipping the gateway's own address + live bottles;
|
||||||
|
3. register it (egress policy blob + slug metadata) → bottle id + identity
|
||||||
|
token;
|
||||||
|
4. provision its git-gate repos/creds into the running gateway.
|
||||||
|
|
||||||
Returns a `LaunchContext` with everything the agent container needs to
|
It returns a `LaunchContext` with everything the agent container needs to
|
||||||
attach. The agent `docker run` itself is the backend's job; this owns the
|
attach — network, pinned IP, the gateway's address (its proxy target), 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.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -19,12 +25,15 @@ 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_NETWORK
|
from ...orchestrator.gateway import GATEWAY_NAME, GATEWAY_NETWORK
|
||||||
from ...orchestrator.lifecycle import INFRA_NAME, OrchestratorService
|
from ...orchestrator.lifecycle import OrchestratorService
|
||||||
from ..consolidated_util import provision_bottle
|
from ...orchestrator.registration import registration_inputs
|
||||||
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):
|
||||||
@@ -66,21 +75,24 @@ 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"container {name} has no address on {network}: {proc.stderr.strip()}"
|
f"gateway {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 infra container and every live agent. Read from
|
truth for "in use": the gateway + orchestrator infrastructure containers
|
||||||
the network so a new bottle can't collide with anything actually attached."""
|
and every live agent. Read from the network so a new bottle can't collide
|
||||||
|
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
|
||||||
|
|
||||||
@@ -92,24 +104,33 @@ 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,
|
||||||
infra_name: str = INFRA_NAME,
|
gateway_name: str = GATEWAY_NAME,
|
||||||
network: str = GATEWAY_NETWORK,
|
network: str = GATEWAY_NETWORK,
|
||||||
) -> LaunchContext:
|
) -> LaunchContext:
|
||||||
"""Ensure the infra container is up, allocate + register the bottle, and
|
"""Ensure the orchestrator + gateway are up, allocate + register the
|
||||||
provision its git-gate state. Returns the agent's attach context."""
|
bottle, and provision its git-gate state. Returns the agent's attach
|
||||||
|
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(infra_name, network)
|
gateway_ip = _container_ip(gateway_name, network)
|
||||||
source_ip = next_free_ip(cidr, _network_container_ips(network))
|
source_ip = next_free_ip(cidr, _network_container_ips(network))
|
||||||
|
|
||||||
transport = DockerGatewayTransport(infra_name)
|
inputs = registration_inputs(egress_plan)
|
||||||
reg = provision_bottle(
|
reg = client.register_bottle(
|
||||||
client, source_ip, egress_plan, git_gate_plan, transport,
|
source_ip, image_ref=image_ref, policy=inputs.policy,
|
||||||
image_ref=image_ref, tokens=tokens,
|
metadata=inputs.metadata, 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,
|
||||||
@@ -121,11 +142,12 @@ def launch_consolidated(
|
|||||||
|
|
||||||
|
|
||||||
def teardown_consolidated(
|
def teardown_consolidated(
|
||||||
bottle_id: str, *, orchestrator_url: str, infra_name: str = INFRA_NAME,
|
bottle_id: str, *, orchestrator_url: str, gateway_name: str = GATEWAY_NAME,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Deregister the bottle and remove its git-gate state. Idempotent."""
|
"""Deregister the bottle and remove its git-gate state from the gateway.
|
||||||
_teardown_util(bottle_id, DockerGatewayTransport(infra_name),
|
Both steps are idempotent so this is safe from a cleanup trap."""
|
||||||
orchestrator_url=orchestrator_url)
|
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
||||||
|
deprovision_git_gate(DockerGatewayTransport(gateway_name), bottle_id)
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
|||||||
@@ -33,7 +33,8 @@ 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 ..consolidated_util import provision_bottle, teardown_consolidated as _teardown_util
|
from ...orchestrator.registration import registration_inputs
|
||||||
|
from ..docker.gateway_provision import deprovision_git_gate, provision_git_gate
|
||||||
from . import infra_vm
|
from . import infra_vm
|
||||||
|
|
||||||
|
|
||||||
@@ -67,11 +68,18 @@ def launch_consolidated(
|
|||||||
url = infra.control_plane_url
|
url = infra.control_plane_url
|
||||||
client = OrchestratorClient(url)
|
client = OrchestratorClient(url)
|
||||||
|
|
||||||
transport = infra_vm.gateway_transport()
|
inputs = registration_inputs(egress_plan)
|
||||||
reg = provision_bottle(
|
reg = client.register_bottle(
|
||||||
client, guest_ip, egress_plan, git_gate_plan, transport,
|
guest_ip, image_ref=image_ref, policy=inputs.policy,
|
||||||
image_ref=image_ref, tokens=tokens,
|
metadata=inputs.metadata, 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(
|
||||||
@@ -88,7 +96,8 @@ def teardown_consolidated(bottle_id: str, *, orchestrator_url: str) -> None:
|
|||||||
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."""
|
||||||
_teardown_util(bottle_id, infra_vm.gateway_transport(), orchestrator_url=orchestrator_url)
|
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
||||||
|
deprovision_git_gate(infra_vm.gateway_transport(), bottle_id)
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
|||||||
@@ -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", "Dockerfile.infra.fc")
|
_DOCKERFILES = ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra")
|
||||||
|
|
||||||
_DEFAULT_BASE = "https://gitea.dideric.is"
|
_DEFAULT_BASE = "https://gitea.dideric.is"
|
||||||
_DEFAULT_OWNER = "didericis"
|
_DEFAULT_OWNER = "didericis"
|
||||||
|
|||||||
@@ -125,19 +125,16 @@ def ensure_built() -> None:
|
|||||||
|
|
||||||
|
|
||||||
def build_infra_images_with_docker() -> None:
|
def build_infra_images_with_docker() -> None:
|
||||||
"""Build the four fixed images from source with host Docker: orchestrator,
|
"""Build the three fixed images from source with host Docker: orchestrator,
|
||||||
gateway, the shared infra base (Dockerfile.infra), then the Firecracker
|
gateway, then the combined infra image (`COPY --from` orchestrator, `FROM`
|
||||||
infra image (Dockerfile.infra.fc: FROM infra + buildah). The launch host
|
gateway). The launch host uses this only in `BOT_BOTTLE_INFRA_BUILD=local`
|
||||||
uses this only in `BOT_BOTTLE_INFRA_BUILD=local` mode; `publish_infra`
|
mode; `publish_infra` uses it off-host to produce the published artifact."""
|
||||||
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(
|
||||||
"bot-bottle-infra:latest", str(_REPO_ROOT), dockerfile="Dockerfile.infra")
|
_INFRA_IMAGE, 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:
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ def require_firecracker() -> None:
|
|||||||
booting a VM without it."""
|
booting a VM without it."""
|
||||||
if not is_linux():
|
if not is_linux():
|
||||||
die("firecracker backend is only supported on Linux (KVM). "
|
die("firecracker backend is only supported on Linux (KVM). "
|
||||||
"On macOS use --backend=macos-container.")
|
"On macOS use the macos-container backend.")
|
||||||
if shutil.which("firecracker") is None:
|
if shutil.which("firecracker") is None:
|
||||||
info("Firecracker is required but was not found on PATH.")
|
info("Firecracker is required but was not found on PATH.")
|
||||||
info("Install: https://github.com/firecracker-microvm/firecracker/releases")
|
info("Install: https://github.com/firecracker-microvm/firecracker/releases")
|
||||||
|
|||||||
@@ -68,9 +68,14 @@ class MacosContainerBottle(Bottle):
|
|||||||
# reaches the agent (PRD 0070): registration mints it *after* the
|
# reaches the agent (PRD 0070): registration mints it *after* the
|
||||||
# container exists — its source IP is the registration key and Apple
|
# container exists — its source IP is the registration key and Apple
|
||||||
# Container assigns that by DHCP — so it cannot be in the run-time env
|
# Container assigns that by DHCP — so it cannot be in the run-time env
|
||||||
# the way docker's compose spec does it. `container exec --env` wins
|
# the way docker's compose spec does it.
|
||||||
# over the run-time value, so the token-bearing proxy URL set here
|
#
|
||||||
# supersedes the token-less one baked in at launch.
|
# `container exec --env` does NOT override a run-time value — it
|
||||||
|
# appends, leaving duplicate entries in the agent's `environ` whose
|
||||||
|
# resolution is runtime-specific (Node last-wins, Rust first-wins). So
|
||||||
|
# nothing here may rely on superseding: the proxy vars are supplied
|
||||||
|
# *only* at exec time and are deliberately absent from the run-time
|
||||||
|
# env. See `launch._agent_env_entries`.
|
||||||
self._exec_env = dict(exec_env or {})
|
self._exec_env = dict(exec_env or {})
|
||||||
self._closed = False
|
self._closed = False
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,8 @@ 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 ...orchestrator.client import OrchestratorClient
|
||||||
from ..consolidated_util import provision_bottle, teardown_consolidated as _teardown_util
|
from ...orchestrator.registration import registration_inputs
|
||||||
|
from ..docker.gateway_provision import deprovision_git_gate, provision_git_gate
|
||||||
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
|
||||||
@@ -102,10 +103,17 @@ 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)
|
||||||
reg = provision_bottle(
|
inputs = registration_inputs(egress_plan)
|
||||||
client, source_ip, egress_plan, git_gate_plan, AppleGatewayTransport(),
|
reg = client.register_bottle(
|
||||||
image_ref=image_ref, tokens=tokens,
|
source_ip, image_ref=image_ref, policy=inputs.policy,
|
||||||
|
metadata=inputs.metadata, tokens=tokens,
|
||||||
)
|
)
|
||||||
|
try:
|
||||||
|
provision_git_gate(AppleGatewayTransport(), 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,
|
||||||
@@ -120,7 +128,8 @@ def teardown_consolidated(bottle_id: str, *, orchestrator_url: str) -> 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."""
|
||||||
_teardown_util(bottle_id, AppleGatewayTransport(), orchestrator_url=orchestrator_url)
|
OrchestratorClient(orchestrator_url).teardown_bottle(bottle_id)
|
||||||
|
deprovision_git_gate(AppleGatewayTransport(), bottle_id)
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
|
|||||||
@@ -8,7 +8,11 @@ from ...bottle_state import read_metadata
|
|||||||
from .. import ActiveAgent
|
from .. import ActiveAgent
|
||||||
from .infra import INFRA_NAME
|
from .infra import INFRA_NAME
|
||||||
|
|
||||||
_PREFIX = "bot-bottle-"
|
# The name every agent container carries: `bot-bottle-<slug>`. Exported
|
||||||
|
# because callers that act on a running bottle (gateway-host rewrites,
|
||||||
|
# registry reconciliation) have to map an enumerated slug back to a
|
||||||
|
# container name.
|
||||||
|
CONTAINER_NAME_PREFIX = "bot-bottle-"
|
||||||
# The shared per-host infra container carries the same prefix as agent
|
# The shared per-host infra container carries the same prefix as agent
|
||||||
# containers but is infrastructure, not a bottle — one control plane + gateway
|
# containers but is infrastructure, not a bottle — one control plane + gateway
|
||||||
# serves every agent, so listing it as an agent would invent one per host.
|
# serves every agent, so listing it as an agent would invent one per host.
|
||||||
@@ -26,9 +30,9 @@ def enumerate_active() -> list[ActiveAgent]:
|
|||||||
return []
|
return []
|
||||||
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(_PREFIX) or name in _INFRA_NAMES:
|
if not name.startswith(CONTAINER_NAME_PREFIX) or name in _INFRA_NAMES:
|
||||||
continue
|
continue
|
||||||
slug = name[len(_PREFIX):]
|
slug = name[len(CONTAINER_NAME_PREFIX):]
|
||||||
metadata = read_metadata(slug)
|
metadata = read_metadata(slug)
|
||||||
out.append(ActiveAgent(
|
out.append(ActiveAgent(
|
||||||
backend_name="macos-container",
|
backend_name="macos-container",
|
||||||
|
|||||||
@@ -0,0 +1,96 @@
|
|||||||
|
"""Stable gateway name for macOS agents, via each bottle's `/etc/hosts`.
|
||||||
|
|
||||||
|
The shared gateway's address is assigned by vmnet's DHCP and changes whenever
|
||||||
|
the infra container is recreated — a source-hash bump, an image upgrade, a
|
||||||
|
crash. Every agent-facing URL (egress proxy, git-http, supervise) embeds that
|
||||||
|
address, and the proxy URL reaches the agent as **process environment** at
|
||||||
|
`container exec` time. A running process's `environ` cannot be rewritten from
|
||||||
|
outside, so a moved gateway used to strand every running bottle permanently:
|
||||||
|
not degraded, unreachable, until the bottle was relaunched and its session
|
||||||
|
thrown away.
|
||||||
|
|
||||||
|
So the agent never learns the address. It is given a stable *name*
|
||||||
|
(`GATEWAY_HOSTNAME`) in every URL, resolved through its own `/etc/hosts`.
|
||||||
|
Unlike `environ`, that is a file — it can be rewritten inside a container that
|
||||||
|
is already running, so a gateway that comes back at a new address is picked up
|
||||||
|
by live bottles instead of orphaning them.
|
||||||
|
|
||||||
|
Apple Container 1.0 offers no container-name DNS on a user network (the only
|
||||||
|
nameserver an agent sees is vmnet's, which does not know container names) and
|
||||||
|
`container run` has no `--add-host`, so the entry is written by exec after the
|
||||||
|
container starts.
|
||||||
|
|
||||||
|
Writing it needs root, and the agent runs as `node`: the agent therefore
|
||||||
|
cannot repoint its own gateway name, while the host (which drives `container
|
||||||
|
exec --user root`) can. That asymmetry is deliberate — keep it.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from ...log import warn
|
||||||
|
from . import util as container_mod
|
||||||
|
from .enumerate import CONTAINER_NAME_PREFIX, enumerate_active
|
||||||
|
|
||||||
|
# The name every agent-facing gateway URL uses. Must not collide with a real
|
||||||
|
# DNS name the agent might resolve; it is bottle-local by construction.
|
||||||
|
GATEWAY_HOSTNAME = "bot-bottle-gateway"
|
||||||
|
|
||||||
|
# Marker so the rewrite is idempotent and only ever touches our own line —
|
||||||
|
# the rest of /etc/hosts (localhost, the container's own name) is preserved.
|
||||||
|
_MARKER = "# bot-bottle gateway"
|
||||||
|
|
||||||
|
|
||||||
|
def _rewrite_script(gateway_ip: str) -> str:
|
||||||
|
"""A shell one-liner that replaces our managed line in `/etc/hosts`.
|
||||||
|
|
||||||
|
Rewrites in place via a temp file + `cat` rather than `mv`, so the file
|
||||||
|
keeps its original inode, ownership, and mode — a bind-mounted or
|
||||||
|
pre-created `/etc/hosts` must not be replaced by a root-owned 0644 copy
|
||||||
|
that the runtime then refuses to update.
|
||||||
|
"""
|
||||||
|
return (
|
||||||
|
"set -e; "
|
||||||
|
f"grep -v '{_MARKER}' /etc/hosts > /tmp/.bb-hosts || true; "
|
||||||
|
f"printf '%s %s %s\\n' '{gateway_ip}' '{GATEWAY_HOSTNAME}' "
|
||||||
|
f"'{_MARKER}' >> /tmp/.bb-hosts; "
|
||||||
|
"cat /tmp/.bb-hosts > /etc/hosts; "
|
||||||
|
"rm -f /tmp/.bb-hosts"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def set_gateway_host(container_name: str, gateway_ip: str) -> None:
|
||||||
|
"""Point `GATEWAY_HOSTNAME` at `gateway_ip` inside one running container.
|
||||||
|
|
||||||
|
Must run before the agent is exec'd: the agent's proxy URL names the
|
||||||
|
gateway, so the entry has to exist for its first connection. Idempotent —
|
||||||
|
re-running with the same address is a no-op in effect.
|
||||||
|
"""
|
||||||
|
container_mod.exec_container_as_root(
|
||||||
|
container_name, ["sh", "-c", _rewrite_script(gateway_ip)],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def refresh_gateway_host(gateway_ip: str) -> list[str]:
|
||||||
|
"""Re-point every running bottle at the current gateway address.
|
||||||
|
|
||||||
|
Called once the shared gateway is known to be up, so a bottle stranded by
|
||||||
|
an earlier gateway restart re-attaches instead of needing a relaunch.
|
||||||
|
Returns the containers updated.
|
||||||
|
|
||||||
|
Best-effort per bottle: one container that refuses the write (already
|
||||||
|
exiting, say) must not stop the others from being repaired, and must not
|
||||||
|
fail the launch that triggered the sweep.
|
||||||
|
"""
|
||||||
|
updated: list[str] = []
|
||||||
|
for agent in enumerate_active():
|
||||||
|
name = f"{CONTAINER_NAME_PREFIX}{agent.slug}"
|
||||||
|
try:
|
||||||
|
set_gateway_host(name, gateway_ip)
|
||||||
|
updated.append(name)
|
||||||
|
# One bad bottle must not stop the sweep, so this is deliberately broad.
|
||||||
|
except Exception as e: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
||||||
|
warn(f"could not re-point {name} at the gateway: {e}")
|
||||||
|
return updated
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["GATEWAY_HOSTNAME", "set_gateway_host", "refresh_gateway_host"]
|
||||||
@@ -59,6 +59,11 @@ 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 util as container_mod
|
from . import util as container_mod
|
||||||
from .bottle import MacosContainerBottle
|
from .bottle import MacosContainerBottle
|
||||||
|
from .gateway_hosts import (
|
||||||
|
GATEWAY_HOSTNAME,
|
||||||
|
refresh_gateway_host,
|
||||||
|
set_gateway_host,
|
||||||
|
)
|
||||||
from .bottle_plan import MacosContainerBottlePlan
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
from .consolidated_launch import (
|
from .consolidated_launch import (
|
||||||
GatewayEndpoint,
|
GatewayEndpoint,
|
||||||
@@ -100,6 +105,11 @@ def launch(
|
|||||||
# 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()
|
||||||
|
# The gateway's address may have changed since these bottles launched
|
||||||
|
# (any infra recreate re-runs DHCP). They name the gateway rather than
|
||||||
|
# address it, so re-pointing /etc/hosts re-attaches them in place
|
||||||
|
# instead of leaving them stranded until relaunch.
|
||||||
|
refresh_gateway_host(endpoint.gateway_ip)
|
||||||
|
|
||||||
# Step 2: mint this bottle's deploy keys, then point it at the SHARED
|
# Step 2: mint this bottle's deploy keys, then point it at the SHARED
|
||||||
# gateway's CA + git-http/supervise ports.
|
# gateway's CA + git-http/supervise ports.
|
||||||
@@ -117,6 +127,9 @@ def launch(
|
|||||||
# attribution key; `--cap-drop CAP_NET_RAW` at run is what makes it
|
# attribution key; `--cap-drop CAP_NET_RAW` at run is what makes it
|
||||||
# unforgeable. Poll: `container run --detach` can return before vmnet's
|
# unforgeable. Poll: `container run --detach` can return before vmnet's
|
||||||
# DHCP has assigned the address.
|
# DHCP has assigned the address.
|
||||||
|
# Resolve the gateway name before anything execs: every agent-facing
|
||||||
|
# URL uses it, so the entry must exist for the first connection.
|
||||||
|
set_gateway_host(plan.container_name, endpoint.gateway_ip)
|
||||||
source_ip = container_mod.wait_container_ipv4_on_network(
|
source_ip = container_mod.wait_container_ipv4_on_network(
|
||||||
plan.container_name, endpoint.network,
|
plan.container_name, endpoint.network,
|
||||||
)
|
)
|
||||||
@@ -231,13 +244,20 @@ def _stamp_agent_urls(
|
|||||||
) -> MacosContainerBottlePlan:
|
) -> MacosContainerBottlePlan:
|
||||||
"""Point the agent's git-gate insteadOf rewrites + supervise MCP at the
|
"""Point the agent's git-gate insteadOf rewrites + supervise MCP at the
|
||||||
shared gateway's ports. Both bypass the egress proxy (NO_PROXY covers the
|
shared gateway's ports. Both bypass the egress proxy (NO_PROXY covers the
|
||||||
gateway address)."""
|
gateway name).
|
||||||
|
|
||||||
|
Addressed by `GATEWAY_HOSTNAME`, never by IP: these URLs are baked into
|
||||||
|
the agent's gitconfig and MCP config at provision time, so an address here
|
||||||
|
would strand the bottle the moment the gateway moved. The name is resolved
|
||||||
|
per connection through `/etc/hosts`, which stays rewritable while the
|
||||||
|
bottle runs."""
|
||||||
|
del endpoint # addressed by name; the address reaches the bottle via /etc/hosts
|
||||||
git_gate_url = (
|
git_gate_url = (
|
||||||
f"http://{endpoint.gateway_ip}:{_GIT_HTTP_PORT}"
|
f"http://{GATEWAY_HOSTNAME}:{_GIT_HTTP_PORT}"
|
||||||
if plan.git_gate_plan.upstreams else ""
|
if plan.git_gate_plan.upstreams else ""
|
||||||
)
|
)
|
||||||
supervise_url = (
|
supervise_url = (
|
||||||
f"http://{endpoint.gateway_ip}:{SUPERVISE_PORT}/"
|
f"http://{GATEWAY_HOSTNAME}:{SUPERVISE_PORT}/"
|
||||||
if plan.supervise_plan is not None else ""
|
if plan.supervise_plan is not None else ""
|
||||||
)
|
)
|
||||||
return dataclasses.replace(
|
return dataclasses.replace(
|
||||||
@@ -247,30 +267,43 @@ def _stamp_agent_urls(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _proxy_url(gateway_ip: str, identity_token: str = "") -> str:
|
def _proxy_url(identity_token: str = "") -> str:
|
||||||
"""The agent's egress proxy URL. The identity token rides as proxy
|
"""The agent's egress proxy URL. The identity token rides as proxy
|
||||||
credentials — the gateway reads Proxy-Authorization, resolves the
|
credentials — the gateway reads Proxy-Authorization, resolves the
|
||||||
(source_ip, token) pair against the control plane, and strips it before
|
(source_ip, token) pair against the control plane, and strips it before
|
||||||
upstream. Without a valid pair `/resolve` denies the request (#366)."""
|
upstream. Without a valid pair `/resolve` denies the request (#366).
|
||||||
|
|
||||||
|
Names the gateway rather than addressing it: this URL reaches the agent as
|
||||||
|
process environment, which cannot be rewritten once the agent is running,
|
||||||
|
so an address baked here is unfixable if the gateway moves."""
|
||||||
cred = f"bottle:{identity_token}@" if identity_token else ""
|
cred = f"bottle:{identity_token}@" if identity_token else ""
|
||||||
return f"http://{cred}{gateway_ip}:{EGRESS_PORT}"
|
return f"http://{cred}{GATEWAY_HOSTNAME}:{EGRESS_PORT}"
|
||||||
|
|
||||||
|
|
||||||
def _no_proxy(gateway_ip: str) -> str:
|
def _no_proxy() -> str:
|
||||||
# git-http + supervise live on the gateway and must NOT go through the
|
# git-http + supervise live on the gateway and must NOT go through the
|
||||||
# egress proxy — the agent reaches them directly by its address.
|
# egress proxy — the agent reaches them directly by name. Deliberately
|
||||||
return f"localhost,127.0.0.1,{gateway_ip}"
|
# address-free: NO_PROXY is baked into the run-time env and is therefore
|
||||||
|
# just as unfixable as the proxy URL if the gateway moves.
|
||||||
|
return f"localhost,127.0.0.1,{GATEWAY_HOSTNAME}"
|
||||||
|
|
||||||
|
|
||||||
def _identity_proxy_env(
|
def _identity_proxy_env(
|
||||||
endpoint: GatewayEndpoint, identity_token: str,
|
endpoint: GatewayEndpoint, identity_token: str,
|
||||||
) -> dict[str, str]:
|
) -> dict[str, str]:
|
||||||
"""The token-bearing proxy env applied at `container exec`. It supersedes
|
"""The token-bearing proxy env applied at `container exec` — the only way
|
||||||
the token-less run-time value (exec `--env` wins), which is the only way to
|
to get the token in, since it does not exist until after the container
|
||||||
get the token in: it does not exist until after the container runs."""
|
runs (registration keys on the DHCP-assigned address).
|
||||||
|
|
||||||
|
This is the *sole* source of `*_PROXY` for the agent. It deliberately does
|
||||||
|
not rely on overriding a run-time value: `container exec --env` appends
|
||||||
|
rather than replaces, so a run-time `HTTPS_PROXY` would survive alongside
|
||||||
|
this one and first-wins runtimes would read the wrong entry. See
|
||||||
|
`_agent_env_entries`."""
|
||||||
if not identity_token:
|
if not identity_token:
|
||||||
return {}
|
return {}
|
||||||
url = _proxy_url(endpoint.gateway_ip, identity_token)
|
del endpoint # the gateway is named, not addressed
|
||||||
|
url = _proxy_url(identity_token)
|
||||||
return {
|
return {
|
||||||
"HTTPS_PROXY": url, "HTTP_PROXY": url,
|
"HTTPS_PROXY": url, "HTTP_PROXY": url,
|
||||||
"https_proxy": url, "http_proxy": url,
|
"https_proxy": url, "http_proxy": url,
|
||||||
@@ -317,16 +350,23 @@ def _agent_run_argv(
|
|||||||
def _agent_env_entries(
|
def _agent_env_entries(
|
||||||
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
plan: MacosContainerBottlePlan, endpoint: GatewayEndpoint,
|
||||||
) -> tuple[str, ...]:
|
) -> tuple[str, ...]:
|
||||||
# Token-less at run time — the token does not exist yet (see
|
# No `*_PROXY` here on purpose. The token-bearing URL is applied at
|
||||||
# `_identity_proxy_env`). Anything egressing before the exec-time override
|
# `container exec` (`_identity_proxy_env`), and Apple's `container exec
|
||||||
# is denied by `/resolve`, which is the safe direction.
|
# --env` **appends** to the run-time environment rather than replacing it:
|
||||||
proxy_url = _proxy_url(endpoint.gateway_ip)
|
# setting a token-less value here leaves two `HTTPS_PROXY` entries in the
|
||||||
no_proxy = _no_proxy(endpoint.gateway_ip)
|
# agent's `environ`, token-less first. Which one a runtime reads is then
|
||||||
|
# pure luck — Node takes the last (and worked), Rust's `std::env::var`
|
||||||
|
# takes the first, so Codex proxied without its identity token and
|
||||||
|
# `/resolve` fail-closed on every request.
|
||||||
|
#
|
||||||
|
# A token-less proxy URL has no legitimate consumer anyway: the init
|
||||||
|
# process is `sleep` and everything that egresses arrives via exec. Its
|
||||||
|
# only value was a tidy 403 for unattributed callers, which is not worth
|
||||||
|
# silently dropping attribution for. Without it a process that egresses
|
||||||
|
# before the exec-time env still fails closed — the agent network is
|
||||||
|
# host-only, so there is no route off it except the gateway.
|
||||||
|
no_proxy = _no_proxy()
|
||||||
env = [
|
env = [
|
||||||
f"HTTPS_PROXY={proxy_url}",
|
|
||||||
f"HTTP_PROXY={proxy_url}",
|
|
||||||
f"https_proxy={proxy_url}",
|
|
||||||
f"http_proxy={proxy_url}",
|
|
||||||
f"NO_PROXY={no_proxy}",
|
f"NO_PROXY={no_proxy}",
|
||||||
f"no_proxy={no_proxy}",
|
f"no_proxy={no_proxy}",
|
||||||
f"NODE_EXTRA_CA_CERTS={AGENT_CA_PATH}",
|
f"NODE_EXTRA_CA_CERTS={AGENT_CA_PATH}",
|
||||||
|
|||||||
@@ -360,6 +360,21 @@ def exec_container(name: str, argv: list[str]) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def exec_container_as_root(name: str, argv: list[str]) -> None:
|
||||||
|
"""`exec_container`, but as uid 0 inside the container.
|
||||||
|
|
||||||
|
For host-driven maintenance the agent itself must not be able to perform —
|
||||||
|
rewriting `/etc/hosts` to point the gateway name at an address. The agent
|
||||||
|
runs as `node`, so it cannot repoint its own gateway; the host can.
|
||||||
|
"""
|
||||||
|
result = _run_container_op([_CONTAINER, "exec", "--user", "root", name, *argv])
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container exec (root) in {name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _run_container_op(cmd: list[str]) -> subprocess.CompletedProcess[str]:
|
def _run_container_op(cmd: list[str]) -> subprocess.CompletedProcess[str]:
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
cmd,
|
cmd,
|
||||||
|
|||||||
@@ -3,18 +3,10 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ..util import read_tty_line as read_tty_line
|
||||||
|
|
||||||
PROG = "cli.py"
|
PROG = "cli.py"
|
||||||
USER_CWD = os.getcwd()
|
USER_CWD = os.getcwd()
|
||||||
REPO_DIR = str(Path(__file__).resolve().parent.parent.parent)
|
REPO_DIR = str(Path(__file__).resolve().parent.parent.parent)
|
||||||
|
|
||||||
|
|
||||||
def read_tty_line() -> str:
|
|
||||||
"""Mirror `IFS= read -r REPLY </dev/tty`. Falls back to stdin."""
|
|
||||||
try:
|
|
||||||
with open("/dev/tty", "r", encoding="utf-8") as tty:
|
|
||||||
return tty.readline().rstrip("\n")
|
|
||||||
except OSError:
|
|
||||||
return sys.stdin.readline().rstrip("\n")
|
|
||||||
|
|||||||
@@ -21,16 +21,20 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from ..backend import get_bottle_backend, known_backend_names
|
from ..backend import get_bottle_backend, has_backend, known_backend_names
|
||||||
from ..log import info
|
from ..log import info
|
||||||
from ._common import read_tty_line
|
from ._common import read_tty_line
|
||||||
|
|
||||||
|
|
||||||
def cmd_cleanup(_argv: list[str]) -> int:
|
def cmd_cleanup(_argv: list[str]) -> int:
|
||||||
# Order: stable backend iteration so the y/N output is
|
# Order: stable backend iteration so the y/N output is
|
||||||
# deterministic across runs.
|
# deterministic across runs. Skip backends whose runtime
|
||||||
|
# isn't available on this host so e.g. macos-container
|
||||||
|
# doesn't error on Linux.
|
||||||
plans = [
|
plans = [
|
||||||
(name, get_bottle_backend(name)) for name in known_backend_names()
|
(name, get_bottle_backend(name))
|
||||||
|
for name in known_backend_names()
|
||||||
|
if has_backend(name)
|
||||||
]
|
]
|
||||||
prepared = [(name, b, b.prepare_cleanup()) for name, b in plans]
|
prepared = [(name, b, b.prepare_cleanup()) for name, b in plans]
|
||||||
|
|
||||||
|
|||||||
+7
-18
@@ -27,7 +27,6 @@ from ..backend import (
|
|||||||
BottleSpec,
|
BottleSpec,
|
||||||
enumerate_active_agents,
|
enumerate_active_agents,
|
||||||
get_bottle_backend,
|
get_bottle_backend,
|
||||||
known_backend_names,
|
|
||||||
)
|
)
|
||||||
from ..backend.docker import util as docker_mod
|
from ..backend.docker import util as docker_mod
|
||||||
from ..backend.docker.bottle_plan import DockerBottlePlan
|
from ..backend.docker.bottle_plan import DockerBottlePlan
|
||||||
@@ -57,15 +56,6 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
"into a cached layer."
|
"into a cached layer."
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
|
||||||
"--backend",
|
|
||||||
choices=known_backend_names(),
|
|
||||||
default=None,
|
|
||||||
help=(
|
|
||||||
"backend to launch the bottle on (default: $BOT_BOTTLE_BACKEND "
|
|
||||||
"or host auto-selection). Overrides the env var when set."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--headless",
|
"--headless",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
@@ -115,11 +105,10 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
os.environ["BOT_BOTTLE_NO_CACHE"] = "1"
|
os.environ["BOT_BOTTLE_NO_CACHE"] = "1"
|
||||||
|
|
||||||
manifest = ManifestIndex.resolve(USER_CWD)
|
manifest = ManifestIndex.resolve(USER_CWD)
|
||||||
backend_name: str | None = args.backend
|
|
||||||
|
|
||||||
if args.headless:
|
if args.headless:
|
||||||
return _start_headless(
|
return _start_headless(
|
||||||
manifest, args, dry_run=dry_run, backend_name=backend_name
|
manifest, args, dry_run=dry_run
|
||||||
)
|
)
|
||||||
|
|
||||||
agent_name: str | None = args.name
|
agent_name: str | None = args.name
|
||||||
@@ -170,7 +159,6 @@ def cmd_start(argv: list[str]) -> int:
|
|||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
dry_run=dry_run,
|
dry_run=dry_run,
|
||||||
backend_name=backend_name,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -182,7 +170,6 @@ def _start_headless(
|
|||||||
args: argparse.Namespace,
|
args: argparse.Namespace,
|
||||||
*,
|
*,
|
||||||
dry_run: bool,
|
dry_run: bool,
|
||||||
backend_name: str | None,
|
|
||||||
) -> int:
|
) -> int:
|
||||||
"""Non-interactive launch path for orchestrators / CI / webhooks.
|
"""Non-interactive launch path for orchestrators / CI / webhooks.
|
||||||
|
|
||||||
@@ -230,7 +217,6 @@ def _start_headless(
|
|||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
dry_run=dry_run,
|
dry_run=dry_run,
|
||||||
backend_name=backend_name,
|
|
||||||
assume_yes=True,
|
assume_yes=True,
|
||||||
headless_prompt_text=prompt,
|
headless_prompt_text=prompt,
|
||||||
)
|
)
|
||||||
@@ -268,15 +254,18 @@ def prepare_with_preflight(
|
|||||||
injected callable, prompt y/N via the injected callable.
|
injected callable, prompt y/N via the injected callable.
|
||||||
|
|
||||||
`backend_name` selects which backend prepares the plan
|
`backend_name` selects which backend prepares the plan
|
||||||
(`None` → `$BOT_BOTTLE_BACKEND` → host auto-selection). The CLI
|
(`None` → `$BOT_BOTTLE_BACKEND` → host auto-selection).
|
||||||
passes whatever `--backend` resolved to.
|
|
||||||
|
When `spec.headless` is True the docker-fallback prompt is suppressed:
|
||||||
|
auto-selection dies with an actionable message rather than blocking
|
||||||
|
on a TTY read (which would hang CI, webhook dispatch, and orchestrators).
|
||||||
|
|
||||||
Returns `(plan, identity)`. `plan` is None on dry-run or
|
Returns `(plan, identity)`. `plan` is None on dry-run or
|
||||||
operator-N, but `identity` is set as soon as `backend.prepare`
|
operator-N, but `identity` is set as soon as `backend.prepare`
|
||||||
returns so callers can reap the prepare-time state dir via
|
returns so callers can reap the prepare-time state dir via
|
||||||
`settle_state(identity)` in their finally — exactly the existing
|
`settle_state(identity)` in their finally — exactly the existing
|
||||||
semantics."""
|
semantics."""
|
||||||
backend = get_bottle_backend(backend_name)
|
backend = get_bottle_backend(backend_name, prompt=not spec.headless)
|
||||||
plan = backend.prepare(spec, stage_dir=stage_dir)
|
plan = backend.prepare(spec, stage_dir=stage_dir)
|
||||||
identity = _identity_from_plan(plan)
|
identity = _identity_from_plan(plan)
|
||||||
|
|
||||||
|
|||||||
+15
-35
@@ -61,11 +61,6 @@ 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
|
||||||
@@ -80,14 +75,7 @@ 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")),
|
||||||
@@ -115,20 +103,18 @@ 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 var.
|
"""Filter the daemon set by the BOT_BOTTLE_GATEWAY_DAEMONS env
|
||||||
|
var. Unknown names in the list are ignored — the caller is the
|
||||||
|
source of truth for which daemons are wired.
|
||||||
|
|
||||||
When the var is unset/empty, return all non-opt-in daemons (the
|
`all_daemons` defaults to `_DAEMONS` resolved at call time (not
|
||||||
standard gateway subset). Opt-in daemons (e.g. `orchestrator`) only
|
at definition time), so tests can monkey-patch the module-level
|
||||||
run when explicitly named — they never start in a plain gateway
|
`_DAEMONS` and have the new value take effect."""
|
||||||
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(d for d in all_daemons if d.name not in _OPT_IN_DAEMONS)
|
return tuple(all_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)
|
||||||
|
|
||||||
@@ -150,7 +136,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( # pylint: disable=consider-using-with
|
proc = subprocess.Popen(
|
||||||
_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,
|
||||||
@@ -197,14 +183,6 @@ 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.
|
||||||
|
|
||||||
@@ -257,7 +235,12 @@ 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)}"
|
||||||
)
|
)
|
||||||
self._sigkill_all()
|
for _, p in self.procs:
|
||||||
|
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:
|
||||||
@@ -378,10 +361,7 @@ 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.signal(signal.SIGHUP, lambda *_: sup.forward_signal(signal.SIGHUP, "egress")) # type: ignore
|
||||||
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)
|
||||||
|
|||||||
@@ -1,15 +1,17 @@
|
|||||||
"""Orchestrator + gateway lifecycle (PRD 0070, docker slice).
|
"""Orchestrator + gateway lifecycle (PRD 0070, docker slice).
|
||||||
|
|
||||||
Runs both the orchestrator control plane and the gateway data plane inside
|
Runs the orchestrator control plane **as a container** on the shared gateway
|
||||||
a single `bot-bottle-infra` container on the shared gateway network —
|
network, alongside the gateway container. This is the PRD's "virtualize the
|
||||||
matching the structure already used by the macOS and Firecracker backends.
|
orchestrator": container↔container between the gateway and the orchestrator
|
||||||
`gateway_init` is PID 1 and supervises both; the infra container is an
|
avoids the host firewall (which drops container→host traffic), and the gateway
|
||||||
idempotent per-host singleton.
|
reaches the control plane by container name over docker DNS. The host CLI
|
||||||
|
reaches it via a published loopback port.
|
||||||
|
|
||||||
The combined container replaces the prior two-container split
|
The orchestrator runs with the **register-only broker** — the *backend*
|
||||||
(bot-bottle-orchestrator + bot-bottle-orch-gateway). The host CLI reaches
|
launches agent containers (compose), so the orchestrator needs no docker
|
||||||
the control plane via a published loopback port; gateway daemons reach it
|
socket. That keeps this control-plane container unprivileged; the host manages
|
||||||
over 127.0.0.1 (same container).
|
both containers. `ensure_running` is an idempotent singleton (fixed container
|
||||||
|
names + the published port).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -24,68 +26,49 @@ 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 CONTROL_PLANE_TOKEN_ENV, bot_bottle_root, host_control_plane_token
|
||||||
from ..supervise import DB_PATH_IN_CONTAINER
|
from .gateway import GATEWAY_IMAGE, GATEWAY_NAME, GATEWAY_NETWORK, DockerGateway, GatewayError
|
||||||
from .gateway import (
|
|
||||||
GATEWAY_CA_VOLUME,
|
|
||||||
GATEWAY_NETWORK,
|
|
||||||
GatewayError,
|
|
||||||
MITMPROXY_HOME,
|
|
||||||
_host_db_dir,
|
|
||||||
)
|
|
||||||
|
|
||||||
DEFAULT_PORT = 8099
|
DEFAULT_PORT = 8099
|
||||||
DEFAULT_STARTUP_TIMEOUT_SECONDS = 45.0
|
ORCHESTRATOR_NAME = "bot-bottle-orchestrator"
|
||||||
|
ORCHESTRATOR_LABEL = "bot-bottle-orchestrator=1"
|
||||||
INFRA_NAME = "bot-bottle-infra"
|
# The control-plane's own runtime image — lean (python + the stdlib-only
|
||||||
INFRA_LABEL = "bot-bottle-infra=1"
|
# `bot_bottle` package, bind-mounted at run time), distinct from the heavy
|
||||||
# The combined infra image: gateway data plane + orchestrator content.
|
# gateway data-plane image it used to borrow (#384). Env override for
|
||||||
# Built from Dockerfile.infra (FROM gateway + COPY --from orchestrator).
|
# operators pinning a published build.
|
||||||
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 gateway daemons + orchestrator the infra container runs.
|
# The repo root is bind-mounted into the control-plane container so
|
||||||
# BOT_BOTTLE_GATEWAY_DAEMONS listing `orchestrator` opts it in to
|
# `python -m bot_bottle.orchestrator` resolves the package (the orchestrator
|
||||||
# gateway_init's supervise tree (see gateway_init._OPT_IN_DAEMONS).
|
# is stdlib-only, so the lean orchestrator image's python is enough).
|
||||||
_INFRA_DAEMONS = "egress,git-http,supervise,orchestrator"
|
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
_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 infra container did not become healthy within the timeout."""
|
"""The orchestrator 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). Changes only
|
`bot_bottle` package the control-plane process imports). This only
|
||||||
when the code that would actually run changes — `ensure_running`
|
changes when the code that would actually run inside the container
|
||||||
recreates the container on a mismatch so a code change takes effect,
|
changes — `ensure_running` recreates the container on a mismatch and
|
||||||
but leaves a healthy up-to-date container alone to preserve in-memory
|
otherwise leaves a healthy one alone, so a bottle launch that isn't
|
||||||
egress tokens."""
|
accompanied by a code change doesn't restart the process and drop every
|
||||||
|
*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())
|
||||||
@@ -94,37 +77,57 @@ def source_hash(repo_root: Path) -> str:
|
|||||||
|
|
||||||
|
|
||||||
class OrchestratorService:
|
class OrchestratorService:
|
||||||
"""Manages the single per-host infra container (control plane + gateway).
|
"""Manages the orchestrator control-plane container + the shared gateway.
|
||||||
Callers only need `ensure_running()` + `url`.
|
Callers only need `ensure_running()` + `url`.
|
||||||
|
|
||||||
`infra_name` / `infra_label` let backends run independent infra containers
|
`orchestrator_name` / `orchestrator_label` let backends run independent
|
||||||
on the same host without name collisions (e.g. isolated integration tests
|
orchestrators on the same host without name collisions (e.g. the
|
||||||
that can't share the production INFRA_NAME singleton)."""
|
Firecracker backend uses `bot-bottle-fc-orchestrator` alongside the Docker
|
||||||
|
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 = INFRA_IMAGE,
|
image: str = ORCHESTRATOR_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,
|
||||||
infra_name: str = INFRA_NAME,
|
orchestrator_name: str = ORCHESTRATOR_NAME,
|
||||||
infra_label: str = INFRA_LABEL,
|
orchestrator_label: str = ORCHESTRATOR_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._infra_name = infra_name
|
self._orchestrator_name = orchestrator_name
|
||||||
self._infra_label = infra_label
|
self._orchestrator_label = orchestrator_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:
|
||||||
@@ -136,125 +139,139 @@ 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 _infra_source_current(self, current_hash: str) -> bool:
|
def _run_orchestrator_container(self, current_hash: str) -> None:
|
||||||
"""True iff the running infra container was started from the current
|
"""Start the control-plane container (idempotent: clears a stale
|
||||||
bind-mounted source. Mirrors the macOS backend's `_source_current`."""
|
fixed-name container first). Register-only broker → no docker socket.
|
||||||
if not self._container_running(self._infra_name):
|
Labels the container with `current_hash` so a later `ensure_running`
|
||||||
return False
|
can detect a real code change (see `source_hash`)."""
|
||||||
|
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
||||||
proc = run_docker([
|
proc = run_docker([
|
||||||
"docker", "inspect", "--format",
|
"docker", "run", "--detach",
|
||||||
"{{ index .Config.Labels \"" + INFRA_SOURCE_HASH_LABEL + "\" }}",
|
"--name", self._orchestrator_name,
|
||||||
self._infra_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:
|
if proc.returncode != 0:
|
||||||
return True # can't compare → don't churn a working container
|
raise OrchestratorStartError(
|
||||||
return proc.stdout.strip() == current_hash
|
f"orchestrator container failed to start: {proc.stderr.strip()}"
|
||||||
|
|
||||||
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:
|
def _gateway(self) -> DockerGateway:
|
||||||
"""Build the orchestrator image (build intermediate), then the infra
|
return DockerGateway(
|
||||||
image. Both are cache-aware: a no-op when nothing changed."""
|
self._gateway_image,
|
||||||
for tag, dockerfile in (
|
name=self._gateway_name,
|
||||||
(ORCHESTRATOR_IMAGE, ORCHESTRATOR_DOCKERFILE),
|
network=self.network,
|
||||||
(self.image, INFRA_DOCKERFILE),
|
orchestrator_url=self.internal_url,
|
||||||
):
|
)
|
||||||
argv = ["docker", "build", "-t", tag,
|
|
||||||
"-f", str(self._repo_root / dockerfile),
|
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)]
|
str(self._repo_root)]
|
||||||
if os.environ.get("BOT_BOTTLE_NO_CACHE"):
|
if os.environ.get("BOT_BOTTLE_NO_CACHE"):
|
||||||
argv.insert(2, "--no-cache")
|
argv.insert(2, "--no-cache")
|
||||||
proc = run_docker(argv)
|
proc = run_docker(argv)
|
||||||
if proc.returncode != 0:
|
if proc.returncode != 0:
|
||||||
raise GatewayError(f"{dockerfile} build failed: {proc.stderr.strip()}")
|
raise GatewayError(
|
||||||
|
f"orchestrator image 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).
|
|
||||||
"--publish", f"127.0.0.1:{self.port}:{self.port}",
|
|
||||||
# Persist the mitmproxy CA so it survives container recreation.
|
|
||||||
"--volume", f"{GATEWAY_CA_VOLUME}:{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.
|
|
||||||
"--env", f"BOT_BOTTLE_ORCHESTRATOR_URL=http://127.0.0.1:{self.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 _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
|
||||||
|
proc = run_docker([
|
||||||
|
"docker", "inspect", "--format",
|
||||||
|
"{{ index .Config.Labels \"" + ORCHESTRATOR_SOURCE_HASH_LABEL + "\" }}",
|
||||||
|
self._orchestrator_name,
|
||||||
|
])
|
||||||
|
if proc.returncode != 0:
|
||||||
|
return True # can't compare -> don't churn a working container
|
||||||
|
return proc.stdout.strip() == current_hash
|
||||||
|
|
||||||
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 infra container (control plane + gateway) is up; return
|
"""Ensure the control plane + shared gateway are up; return the host
|
||||||
the host control-plane URL. Idempotent — a healthy container on current
|
control-plane URL. Idempotent — a healthy control plane running
|
||||||
source is left untouched. Raises `OrchestratorStartError` on timeout."""
|
current code and a running gateway are left untouched. Raises
|
||||||
self._build_images()
|
`OrchestratorStartError` on timeout."""
|
||||||
|
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._infra_source_current(current_hash):
|
if self.is_healthy() and self._orchestrator_source_current(current_hash):
|
||||||
return self.url
|
return self.url
|
||||||
|
|
||||||
log.info("starting infra container", context={"name": self._infra_name})
|
self._ensure_orchestrator_image()
|
||||||
self._run_infra_container(current_hash)
|
log.info(
|
||||||
|
"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("infra container healthy", context={"url": self.url})
|
log.info("orchestrator 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"infra container at {self.url} did not become healthy within {startup_timeout:g}s"
|
f"orchestrator at {self.url} did not become healthy within {startup_timeout:g}s"
|
||||||
)
|
)
|
||||||
|
|
||||||
def stop(self) -> None:
|
def stop(self) -> None:
|
||||||
"""Remove the infra container (idempotent)."""
|
"""Remove the orchestrator + gateway containers (idempotent)."""
|
||||||
run_docker(["docker", "rm", "--force", self._infra_name])
|
run_docker(["docker", "rm", "--force", self._orchestrator_name])
|
||||||
|
self._gateway().stop()
|
||||||
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"OrchestratorService",
|
"OrchestratorService",
|
||||||
"OrchestratorStartError",
|
"OrchestratorStartError",
|
||||||
"INFRA_NAME",
|
"ORCHESTRATOR_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",
|
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import ipaddress
|
import ipaddress
|
||||||
import os
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
def is_ip_literal(value: str) -> bool:
|
def is_ip_literal(value: str) -> bool:
|
||||||
@@ -17,6 +18,15 @@ def is_ip_literal(value: str) -> bool:
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def read_tty_line() -> str:
|
||||||
|
"""Mirror `IFS= read -r REPLY </dev/tty`. Falls back to stdin."""
|
||||||
|
try:
|
||||||
|
with open("/dev/tty", "r", encoding="utf-8") as tty:
|
||||||
|
return tty.readline().rstrip("\n")
|
||||||
|
except OSError:
|
||||||
|
return sys.stdin.readline().rstrip("\n")
|
||||||
|
|
||||||
|
|
||||||
def expand_tilde(path: str) -> str:
|
def expand_tilde(path: str) -> str:
|
||||||
"""Expand a leading '~' to $HOME. Leaves paths without a leading
|
"""Expand a leading '~' to $HOME. Leaves paths without a leading
|
||||||
tilde unchanged. Falls back to the empty string if $HOME is unset
|
tilde unchanged. Falls back to the empty string if $HOME is unset
|
||||||
|
|||||||
@@ -0,0 +1,110 @@
|
|||||||
|
# PRD prd-new: CI artifact-based coverage and local Firecracker candidate flow
|
||||||
|
|
||||||
|
- **Status:** Active
|
||||||
|
- **Author:** Claude
|
||||||
|
- **Created:** 2026-07-21
|
||||||
|
- **Issue:** #446
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Restructure the CI test pipeline to run each test suite exactly once, upload
|
||||||
|
small `.coverage.*` artifacts, and combine them in a lightweight aggregation
|
||||||
|
job. Move the infra build onto the KVM runner so the ~194 MB rootfs never
|
||||||
|
crosses the network for PRs. On main-branch pushes, publish the byte-identical
|
||||||
|
rootfs that was tested.
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
The prior pipeline had two redundant costs:
|
||||||
|
|
||||||
|
1. **Duplicate artifact transfers.** `build-infra` (ubuntu-latest) built and
|
||||||
|
uploaded the ~194 MB rootfs; `integration-firecracker` downloaded it; the
|
||||||
|
`coverage` job downloaded it a second time. Combined download overhead: ~83
|
||||||
|
seconds per run, plus the ~70-second upload.
|
||||||
|
|
||||||
|
2. **Duplicate test execution.** `integration-firecracker` ran the Firecracker
|
||||||
|
integration suite; `coverage` ran the entire unit + integration suite again
|
||||||
|
on the same KVM runner to collect coverage data. Every line of Firecracker
|
||||||
|
code was tested twice per CI run.
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
- Each test suite (unit, integration-docker, integration-firecracker) executes
|
||||||
|
exactly once per workflow run.
|
||||||
|
- PRs incur no large artifact transfers — the rootfs stays on the KVM runner.
|
||||||
|
- Main-branch pushes publish a byte-for-byte identical rootfs to the one that
|
||||||
|
passed the integration tests.
|
||||||
|
- Concurrent workflow runs cannot cross-publish candidates (naturally enforced
|
||||||
|
by Gitea Actions' per-run artifact scoping).
|
||||||
|
- Failed or cancelled runs block publication (enforced by the `needs:` chain on
|
||||||
|
`publish-infra`).
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Changing test semantics or the coverage policy (ADR 0004).
|
||||||
|
- Removing the KVM runner guard on `integration-firecracker` and `coverage`.
|
||||||
|
- Changing how `publish_infra.py` builds or uploads the rootfs.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
### Job graph
|
||||||
|
|
||||||
|
```
|
||||||
|
unit ──────────────────────────────────┐
|
||||||
|
integration-docker ────────────────────┤──► coverage ──► publish-infra (main only)
|
||||||
|
integration-firecracker (KVM) ─────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### `unit`
|
||||||
|
|
||||||
|
Unchanged except: `coverage run` writes `--data-file=.coverage.unit`; the file
|
||||||
|
is uploaded as the `coverage-unit` artifact.
|
||||||
|
|
||||||
|
### `integration-docker`
|
||||||
|
|
||||||
|
Adds a `coverage` install step. `coverage run` writes `--data-file=.coverage.docker`;
|
||||||
|
the file is uploaded as `coverage-docker`.
|
||||||
|
|
||||||
|
### `integration-firecracker` (KVM runner)
|
||||||
|
|
||||||
|
Replaces the old `stage-firecracker-inputs` → `build-infra` → download chain:
|
||||||
|
|
||||||
|
1. Builds the infra candidate locally with
|
||||||
|
`BOT_BOTTLE_FC_DROPBEAR=/var/cache/bot-bottle-fc/dropbear`.
|
||||||
|
2. Boots the candidate and runs integration tests with coverage, writing
|
||||||
|
`.coverage.firecracker`.
|
||||||
|
3. Uploads the small `coverage-firecracker` artifact unconditionally.
|
||||||
|
4. On main-branch pushes only, uploads the rootfs as `infra-candidate` and the
|
||||||
|
dropbear as `firecracker-inputs` so `publish-infra` can verify and publish
|
||||||
|
the byte-identical artifact.
|
||||||
|
|
||||||
|
### `coverage`
|
||||||
|
|
||||||
|
Moves from a KVM runner to `ubuntu-latest`. No tests are re-executed:
|
||||||
|
|
||||||
|
1. Downloads `coverage-unit`, `coverage-docker`, and `coverage-firecracker`.
|
||||||
|
2. Runs `scripts/coverage.sh aggregate critical`, which calls
|
||||||
|
`coverage combine` then `coverage report`.
|
||||||
|
3. Runs the diff-coverage gate (`scripts/diff_coverage.py`).
|
||||||
|
|
||||||
|
Coverage files use `relative_files = True` (`.coveragerc`) so they combine
|
||||||
|
cleanly across runners with different absolute workspace paths.
|
||||||
|
|
||||||
|
### `publish-infra`
|
||||||
|
|
||||||
|
Depends on all four predecessor jobs (unchanged gate). Downloads `infra-candidate`
|
||||||
|
and `firecracker-inputs` that were uploaded by `integration-firecracker` on
|
||||||
|
main — the same byte sequence that passed the integration tests.
|
||||||
|
|
||||||
|
### Eliminated jobs
|
||||||
|
|
||||||
|
- `stage-firecracker-inputs`: existed only to copy the dropbear to ubuntu-latest
|
||||||
|
for `build-infra`. No longer needed.
|
||||||
|
- `build-infra`: the infra candidate is now built on the KVM runner in
|
||||||
|
`integration-firecracker`.
|
||||||
|
|
||||||
|
### Script changes
|
||||||
|
|
||||||
|
`scripts/coverage.sh` gains an `aggregate` mode (`coverage.sh aggregate [critical]`)
|
||||||
|
that combines pre-existing `.coverage.*` files instead of re-running tests.
|
||||||
|
The existing run mode (`coverage.sh [critical]`) is preserved for local dev.
|
||||||
@@ -1,155 +0,0 @@
|
|||||||
# 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:{port}:{port}` for the control plane (same as
|
|
||||||
today)
|
|
||||||
- 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.
|
|
||||||
+28
-8
@@ -1,15 +1,19 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# Combined unit + integration coverage (see docs/decisions/0004-coverage-policy.md).
|
# Combined unit + integration coverage (see docs/decisions/0004-coverage-policy.md).
|
||||||
#
|
#
|
||||||
# Runs the unit suite, then appends the integration suite (which skips
|
# Two modes:
|
||||||
# cleanly when Docker / the backend CLIs are unavailable), and prints one
|
|
||||||
# combined report. The integration suite is what scores the subprocess /
|
|
||||||
# backend orchestration modules, so the number here is the policy's
|
|
||||||
# yardstick — not the unit-only badge.
|
|
||||||
#
|
#
|
||||||
# Usage:
|
# scripts/coverage.sh [critical]
|
||||||
# scripts/coverage.sh # combined report
|
# Run mode (default, for local dev): executes the unit suite then the
|
||||||
# scripts/coverage.sh critical # also report just the critical modules
|
# integration suite under coverage and prints a combined report.
|
||||||
|
#
|
||||||
|
# scripts/coverage.sh aggregate [critical]
|
||||||
|
# Aggregate mode (used by CI): combines pre-existing .coverage.* files
|
||||||
|
# produced by individual test jobs and prints a combined report. No tests
|
||||||
|
# are re-executed; no KVM or Docker dependency.
|
||||||
|
#
|
||||||
|
# Pass "critical" as the last argument in either mode to also report just the
|
||||||
|
# critical modules (ADR 0004 target: 90%).
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cd "$(dirname "$0")/.."
|
cd "$(dirname "$0")/.."
|
||||||
@@ -21,6 +25,22 @@ PY="${PYTHON:-python3}"
|
|||||||
# README "core coverage" badge can't drift; comma-join it for --include.
|
# README "core coverage" badge can't drift; comma-join it for --include.
|
||||||
CRITICAL=$(grep -vE '^[[:space:]]*(#|$)' scripts/critical-modules.txt | paste -sd, -)
|
CRITICAL=$(grep -vE '^[[:space:]]*(#|$)' scripts/critical-modules.txt | paste -sd, -)
|
||||||
|
|
||||||
|
if [ "${1:-}" = "aggregate" ]; then
|
||||||
|
# Aggregate mode: combine .coverage.* artifacts already in the workspace.
|
||||||
|
echo "== combining coverage artifacts ==" >&2
|
||||||
|
"$PY" -m coverage combine
|
||||||
|
|
||||||
|
echo "== combined report ==" >&2
|
||||||
|
"$PY" -m coverage report -m
|
||||||
|
|
||||||
|
if [ "${2:-}" = "critical" ]; then
|
||||||
|
echo "== critical modules (ADR 0004 target: 90%) ==" >&2
|
||||||
|
"$PY" -m coverage report --include="$CRITICAL"
|
||||||
|
fi
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run mode (default): execute both suites under coverage in this process.
|
||||||
rm -f .coverage
|
rm -f .coverage
|
||||||
|
|
||||||
echo "== unit ==" >&2
|
echo "== unit ==" >&2
|
||||||
|
|||||||
@@ -34,7 +34,6 @@ 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()
|
||||||
@@ -70,17 +69,20 @@ 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)
|
||||||
|
|
||||||
infra_name = f"bot-bottle-infra-itest-{suffix}"
|
orchestrator_name = f"bot-bottle-orch-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, infra_name, network, host_root
|
cls._teardown_docker, orchestrator_name, gateway_name, network, host_root
|
||||||
)
|
)
|
||||||
|
|
||||||
cls.svc = OrchestratorService(
|
cls.svc = OrchestratorService(
|
||||||
infra_name=infra_name,
|
orchestrator_name=orchestrator_name,
|
||||||
|
gateway_name=gateway_name,
|
||||||
network=network,
|
network=network,
|
||||||
image=_TEST_INFRA_IMAGE,
|
image=_TEST_ORCHESTRATOR_IMAGE,
|
||||||
|
gateway_image=_TEST_GATEWAY_IMAGE,
|
||||||
port=20000 + secrets.randbelow(10000),
|
port=20000 + secrets.randbelow(10000),
|
||||||
host_root=host_root,
|
host_root=host_root,
|
||||||
)
|
)
|
||||||
@@ -89,23 +91,23 @@ class TestDockerControlPlaneAuthIntegration(unittest.TestCase):
|
|||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _teardown_docker(
|
def _teardown_docker(
|
||||||
infra_name: str, network: str, host_root: Path
|
orchestrator_name: str, gateway_name: str, network: str, host_root: Path
|
||||||
) -> None:
|
) -> None:
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["docker", "rm", "--force", infra_name],
|
["docker", "rm", "--force", orchestrator_name, gateway_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 infra container (no USER directive) wrote the registry
|
# The orchestrator 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_INFRA_IMAGE, "-R",
|
"--entrypoint", "chown", _TEST_GATEWAY_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,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -57,14 +57,16 @@ class TestGetBottleBackend(unittest.TestCase):
|
|||||||
return self._available
|
return self._available
|
||||||
|
|
||||||
# No macOS container and the host can't run firecracker (no
|
# No macOS container and the host can't run firecracker (no
|
||||||
# KVM / not Linux) → docker is the last resort.
|
# KVM / not Linux) → docker fallback with a prompt. Simulate
|
||||||
|
# the user picking "d" (use docker anyway).
|
||||||
with patch.dict(os.environ, {}, clear=True), \
|
with patch.dict(os.environ, {}, clear=True), \
|
||||||
patch.object(backend_mod.FirecrackerBottleBackend,
|
patch.object(backend_mod.FirecrackerBottleBackend,
|
||||||
"is_host_capable", classmethod(lambda cls: False)), \
|
"is_host_capable", classmethod(lambda cls: False)), \
|
||||||
patch.object(backend_mod, "_backends", {
|
patch.object(backend_mod, "_backends", {
|
||||||
"macos-container": _FakeBackend("macos-container", False),
|
"macos-container": _FakeBackend("macos-container", False),
|
||||||
"docker": _FakeBackend("docker", True),
|
"docker": _FakeBackend("docker", True),
|
||||||
}):
|
}), \
|
||||||
|
patch.object(backend_mod, "read_tty_line", return_value="d"):
|
||||||
b = get_bottle_backend()
|
b = get_bottle_backend()
|
||||||
self.assertEqual("docker", b.name)
|
self.assertEqual("docker", b.name)
|
||||||
|
|
||||||
@@ -96,6 +98,145 @@ class TestGetBottleBackend(unittest.TestCase):
|
|||||||
with self.assertRaises(SystemExit):
|
with self.assertRaises(SystemExit):
|
||||||
get_bottle_backend("nonexistent")
|
get_bottle_backend("nonexistent")
|
||||||
|
|
||||||
|
def test_no_backend_available_dies(self):
|
||||||
|
# No VM and no docker → print install instructions and die.
|
||||||
|
class _FakeBackend:
|
||||||
|
def __init__(self, name: str, available: bool) -> None:
|
||||||
|
self.name = name
|
||||||
|
self._available = available
|
||||||
|
|
||||||
|
def is_available(self) -> bool:
|
||||||
|
return self._available
|
||||||
|
|
||||||
|
with patch.dict(os.environ, {}, clear=True), \
|
||||||
|
patch.object(backend_mod.FirecrackerBottleBackend,
|
||||||
|
"is_host_capable", classmethod(lambda cls: False)), \
|
||||||
|
patch.object(backend_mod, "_backends", {
|
||||||
|
"macos-container": _FakeBackend("macos-container", False),
|
||||||
|
"docker": _FakeBackend("docker", False),
|
||||||
|
}), \
|
||||||
|
patch.object(backend_mod, "die", side_effect=SystemExit("die")):
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
get_bottle_backend()
|
||||||
|
|
||||||
|
def test_docker_fallback_user_quits(self):
|
||||||
|
# VM unavailable, docker available, user picks "q" → die.
|
||||||
|
class _FakeBackend:
|
||||||
|
def __init__(self, name: str, available: bool) -> None:
|
||||||
|
self.name = name
|
||||||
|
self._available = available
|
||||||
|
|
||||||
|
def is_available(self) -> bool:
|
||||||
|
return self._available
|
||||||
|
|
||||||
|
with patch.dict(os.environ, {}, clear=True), \
|
||||||
|
patch.object(backend_mod.FirecrackerBottleBackend,
|
||||||
|
"is_host_capable", classmethod(lambda cls: False)), \
|
||||||
|
patch.object(backend_mod, "_backends", {
|
||||||
|
"macos-container": _FakeBackend("macos-container", False),
|
||||||
|
"docker": _FakeBackend("docker", True),
|
||||||
|
}), \
|
||||||
|
patch.object(backend_mod, "read_tty_line", return_value="q"), \
|
||||||
|
patch.object(backend_mod, "die", side_effect=SystemExit("die")):
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
get_bottle_backend()
|
||||||
|
|
||||||
|
|
||||||
|
def test_docker_fallback_non_interactive_dies(self):
|
||||||
|
# prompt=False: headless/CI contexts must not block on a TTY read.
|
||||||
|
class _FakeBackend:
|
||||||
|
def __init__(self, name: str, available: bool) -> None:
|
||||||
|
self.name = name
|
||||||
|
self._available = available
|
||||||
|
|
||||||
|
def is_available(self) -> bool:
|
||||||
|
return self._available
|
||||||
|
|
||||||
|
with patch.dict(os.environ, {}, clear=True), \
|
||||||
|
patch.object(backend_mod.FirecrackerBottleBackend,
|
||||||
|
"is_host_capable", classmethod(lambda cls: False)), \
|
||||||
|
patch.object(backend_mod, "_backends", {
|
||||||
|
"macos-container": _FakeBackend("macos-container", False),
|
||||||
|
"docker": _FakeBackend("docker", True),
|
||||||
|
}), \
|
||||||
|
patch.object(backend_mod, "die", side_effect=SystemExit("die")):
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
get_bottle_backend(prompt=False)
|
||||||
|
|
||||||
|
def test_docker_fallback_user_picks_install(self):
|
||||||
|
# User picks [i] → print install instructions then die.
|
||||||
|
class _FakeBackend:
|
||||||
|
def __init__(self, name: str, available: bool) -> None:
|
||||||
|
self.name = name
|
||||||
|
self._available = available
|
||||||
|
|
||||||
|
def is_available(self) -> bool:
|
||||||
|
return self._available
|
||||||
|
|
||||||
|
with patch.dict(os.environ, {}, clear=True), \
|
||||||
|
patch.object(backend_mod.FirecrackerBottleBackend,
|
||||||
|
"is_host_capable", classmethod(lambda cls: False)), \
|
||||||
|
patch.object(backend_mod, "_backends", {
|
||||||
|
"macos-container": _FakeBackend("macos-container", False),
|
||||||
|
"docker": _FakeBackend("docker", True),
|
||||||
|
}), \
|
||||||
|
patch.object(backend_mod, "read_tty_line", return_value="i"), \
|
||||||
|
patch.object(backend_mod, "_print_vm_install_instructions") as mock_inst, \
|
||||||
|
patch.object(backend_mod, "die", side_effect=SystemExit("die")):
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
get_bottle_backend()
|
||||||
|
mock_inst.assert_called_once()
|
||||||
|
|
||||||
|
|
||||||
|
class TestReadTtyLine(unittest.TestCase):
|
||||||
|
"""Unit tests for the shared read_tty_line helper in bot_bottle.util."""
|
||||||
|
|
||||||
|
def test_reads_from_dev_tty(self):
|
||||||
|
from unittest.mock import mock_open
|
||||||
|
from bot_bottle.util import read_tty_line
|
||||||
|
|
||||||
|
m = mock_open(read_data="hello\n")
|
||||||
|
with patch("builtins.open", m):
|
||||||
|
result = read_tty_line()
|
||||||
|
self.assertEqual("hello", result)
|
||||||
|
m.assert_called_once_with("/dev/tty", "r", encoding="utf-8")
|
||||||
|
|
||||||
|
def test_falls_back_to_stdin_on_oserror(self):
|
||||||
|
import io
|
||||||
|
from bot_bottle.util import read_tty_line
|
||||||
|
import sys as _sys
|
||||||
|
|
||||||
|
with patch("builtins.open", side_effect=OSError("no tty")), \
|
||||||
|
patch.object(_sys, "stdin", io.StringIO("world\n")):
|
||||||
|
result = read_tty_line()
|
||||||
|
self.assertEqual("world", result)
|
||||||
|
|
||||||
|
|
||||||
|
class TestPrintVmInstallInstructions(unittest.TestCase):
|
||||||
|
"""Unit tests for _print_vm_install_instructions platform branches."""
|
||||||
|
|
||||||
|
def test_linux_prints_firecracker_instructions(self):
|
||||||
|
from bot_bottle.backend import _print_vm_install_instructions
|
||||||
|
|
||||||
|
with patch.object(backend_mod, "_platform_vm_suggestion",
|
||||||
|
return_value="firecracker"), \
|
||||||
|
patch.object(backend_mod, "info") as mock_info:
|
||||||
|
_print_vm_install_instructions()
|
||||||
|
|
||||||
|
messages = [str(c[0][0]) for c in mock_info.call_args_list]
|
||||||
|
self.assertTrue(any("Firecracker" in m for m in messages))
|
||||||
|
|
||||||
|
def test_macos_prints_apple_container_instructions(self):
|
||||||
|
from bot_bottle.backend import _print_vm_install_instructions
|
||||||
|
|
||||||
|
with patch.object(backend_mod, "_platform_vm_suggestion",
|
||||||
|
return_value="macos-container"), \
|
||||||
|
patch.object(backend_mod, "info") as mock_info:
|
||||||
|
_print_vm_install_instructions()
|
||||||
|
|
||||||
|
messages = [str(c[0][0]) for c in mock_info.call_args_list]
|
||||||
|
self.assertTrue(any("Apple Container" in m for m in messages))
|
||||||
|
|
||||||
|
|
||||||
class TestKnownBackendNames(unittest.TestCase):
|
class TestKnownBackendNames(unittest.TestCase):
|
||||||
def test_returns_backends_sorted(self):
|
def test_returns_backends_sorted(self):
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
"""Unit: `cli.py cleanup` walks every backend (issue follow-up).
|
"""Unit: `cli.py cleanup` walks every available backend.
|
||||||
|
|
||||||
Asserts cmd_cleanup queries each backend's `prepare_cleanup`,
|
Asserts cmd_cleanup queries each available backend's `prepare_cleanup`,
|
||||||
combines the y/N output, and runs each backend's `cleanup` when
|
combines the y/N output, and runs each backend's `cleanup` when the
|
||||||
the operator confirms. Mocks the backends and stdin."""
|
operator confirms. Unavailable backends (e.g. macos-container on Linux)
|
||||||
|
are skipped so that `cleanup` never errors on a platform where a backend
|
||||||
|
is not installed. Mocks the backends and stdin."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -21,7 +23,7 @@ def _make_backend(empty: bool = True):
|
|||||||
|
|
||||||
|
|
||||||
class TestCmdCleanup(unittest.TestCase):
|
class TestCmdCleanup(unittest.TestCase):
|
||||||
def test_iterates_every_backend(self):
|
def test_iterates_every_available_backend(self):
|
||||||
docker, docker_plan = _make_backend(empty=False)
|
docker, docker_plan = _make_backend(empty=False)
|
||||||
fc, fc_plan = _make_backend(empty=False)
|
fc, fc_plan = _make_backend(empty=False)
|
||||||
backends_by_name = {"docker": docker, "firecracker": fc}
|
backends_by_name = {"docker": docker, "firecracker": fc}
|
||||||
@@ -32,6 +34,8 @@ class TestCmdCleanup(unittest.TestCase):
|
|||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "get_bottle_backend",
|
cmd, "get_bottle_backend",
|
||||||
side_effect=lambda name: backends_by_name[name], # type: ignore
|
side_effect=lambda name: backends_by_name[name], # type: ignore
|
||||||
|
), patch.object(
|
||||||
|
cmd, "has_backend", return_value=True,
|
||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "_prompt_yes", return_value=True,
|
cmd, "_prompt_yes", return_value=True,
|
||||||
):
|
):
|
||||||
@@ -42,6 +46,32 @@ class TestCmdCleanup(unittest.TestCase):
|
|||||||
docker.cleanup.assert_called_once_with(docker_plan)
|
docker.cleanup.assert_called_once_with(docker_plan)
|
||||||
fc.cleanup.assert_called_once_with(fc_plan)
|
fc.cleanup.assert_called_once_with(fc_plan)
|
||||||
|
|
||||||
|
def test_skips_unavailable_backends(self):
|
||||||
|
# macos-container is not available on Linux — must be silently skipped.
|
||||||
|
docker, docker_plan = _make_backend(empty=False)
|
||||||
|
macos = MagicMock()
|
||||||
|
backends_by_name = {"docker": docker}
|
||||||
|
|
||||||
|
def _has(name: str) -> bool:
|
||||||
|
return name == "docker"
|
||||||
|
|
||||||
|
with patch.object(
|
||||||
|
cmd, "known_backend_names",
|
||||||
|
return_value=("docker", "macos-container"),
|
||||||
|
), patch.object(
|
||||||
|
cmd, "get_bottle_backend",
|
||||||
|
side_effect=lambda name: backends_by_name[name], # type: ignore
|
||||||
|
), patch.object(
|
||||||
|
cmd, "has_backend", side_effect=_has,
|
||||||
|
), patch.object(
|
||||||
|
cmd, "_prompt_yes", return_value=True,
|
||||||
|
):
|
||||||
|
self.assertEqual(0, cmd.cmd_cleanup([]))
|
||||||
|
|
||||||
|
docker.prepare_cleanup.assert_called_once()
|
||||||
|
docker.cleanup.assert_called_once_with(docker_plan)
|
||||||
|
macos.prepare_cleanup.assert_not_called()
|
||||||
|
|
||||||
def test_short_circuits_when_all_empty(self):
|
def test_short_circuits_when_all_empty(self):
|
||||||
docker, _ = _make_backend(empty=True)
|
docker, _ = _make_backend(empty=True)
|
||||||
fc, _ = _make_backend(empty=True)
|
fc, _ = _make_backend(empty=True)
|
||||||
@@ -53,6 +83,8 @@ class TestCmdCleanup(unittest.TestCase):
|
|||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "get_bottle_backend",
|
cmd, "get_bottle_backend",
|
||||||
side_effect=lambda name: backends_by_name[name], # type: ignore
|
side_effect=lambda name: backends_by_name[name], # type: ignore
|
||||||
|
), patch.object(
|
||||||
|
cmd, "has_backend", return_value=True,
|
||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "_prompt_yes",
|
cmd, "_prompt_yes",
|
||||||
) as prompt:
|
) as prompt:
|
||||||
@@ -72,6 +104,8 @@ class TestCmdCleanup(unittest.TestCase):
|
|||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "get_bottle_backend",
|
cmd, "get_bottle_backend",
|
||||||
side_effect=lambda name: backends_by_name[name], # type: ignore
|
side_effect=lambda name: backends_by_name[name], # type: ignore
|
||||||
|
), patch.object(
|
||||||
|
cmd, "has_backend", return_value=True,
|
||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "_prompt_yes", return_value=False,
|
cmd, "_prompt_yes", return_value=False,
|
||||||
):
|
):
|
||||||
@@ -92,6 +126,8 @@ class TestCmdCleanup(unittest.TestCase):
|
|||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "get_bottle_backend",
|
cmd, "get_bottle_backend",
|
||||||
side_effect=lambda name: backends_by_name[name], # type: ignore
|
side_effect=lambda name: backends_by_name[name], # type: ignore
|
||||||
|
), patch.object(
|
||||||
|
cmd, "has_backend", return_value=True,
|
||||||
), patch.object(
|
), patch.object(
|
||||||
cmd, "_prompt_yes", return_value=True,
|
cmd, "_prompt_yes", return_value=True,
|
||||||
):
|
):
|
||||||
|
|||||||
@@ -1,61 +1,29 @@
|
|||||||
"""Unit: `cli.py start --backend=<name>` flag (issue #77).
|
"""Unit: backend resolution priority — explicit name > env var.
|
||||||
|
|
||||||
Asserts that the flag wins over the env var, that the env var is
|
The `--backend` flag has been removed from `cli.py start`; backend
|
||||||
the fallback, and that the choices are pulled from the backend
|
selection is driven by BOT_BOTTLE_BACKEND or auto-selection only.
|
||||||
registry (so adding a backend lights up in argparse without code
|
`get_bottle_backend` still accepts an explicit name so that `resume`
|
||||||
edits)."""
|
(which records the backend from a prior session) and the `backend`
|
||||||
|
sub-command can pass one directly."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import argparse
|
|
||||||
import os
|
import os
|
||||||
import unittest
|
import unittest
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
|
||||||
from bot_bottle.backend import known_backend_names
|
class TestBackendResolutionPriority(unittest.TestCase):
|
||||||
|
def test_explicit_name_overrides_env_var(self):
|
||||||
|
|
||||||
class TestStartBackendFlag(unittest.TestCase):
|
|
||||||
"""The flag is wired by `cmd_start`'s argparse and threaded
|
|
||||||
through `prepare_with_preflight(backend_name=...)`. Rather than
|
|
||||||
drive the whole start flow (which builds containers), we test
|
|
||||||
the argparse shape and the resolution function separately."""
|
|
||||||
|
|
||||||
def _build_parser(self):
|
|
||||||
# Mirror the parser definition from `cmd_start` so this
|
|
||||||
# test doesn't have to invoke the full command.
|
|
||||||
parser = argparse.ArgumentParser(prog="cb start")
|
|
||||||
parser.add_argument(
|
|
||||||
"--backend",
|
|
||||||
choices=known_backend_names(),
|
|
||||||
default=None,
|
|
||||||
)
|
|
||||||
parser.add_argument("name")
|
|
||||||
return parser
|
|
||||||
|
|
||||||
def test_flag_recognized(self):
|
|
||||||
args = self._build_parser().parse_args(["--backend=firecracker", "researcher"])
|
|
||||||
self.assertEqual("firecracker", args.backend)
|
|
||||||
self.assertEqual("researcher", args.name)
|
|
||||||
|
|
||||||
def test_flag_default_none_means_env_or_default_backend(self):
|
|
||||||
args = self._build_parser().parse_args(["researcher"])
|
|
||||||
self.assertIsNone(args.backend)
|
|
||||||
|
|
||||||
def test_invalid_backend_rejected_by_argparse(self):
|
|
||||||
parser = self._build_parser()
|
|
||||||
with self.assertRaises(SystemExit):
|
|
||||||
parser.parse_args(["--backend=garbage", "researcher"])
|
|
||||||
|
|
||||||
def test_resolution_priority_explicit_over_env(self):
|
|
||||||
# Independent assertion that get_bottle_backend (where
|
|
||||||
# `--backend` ultimately threads to) prefers the explicit
|
|
||||||
# name over BOT_BOTTLE_BACKEND.
|
|
||||||
from bot_bottle.backend import get_bottle_backend
|
from bot_bottle.backend import get_bottle_backend
|
||||||
with patch.dict(os.environ, {"BOT_BOTTLE_BACKEND": "firecracker"}):
|
with patch.dict(os.environ, {"BOT_BOTTLE_BACKEND": "firecracker"}):
|
||||||
self.assertEqual("docker", get_bottle_backend("docker").name)
|
self.assertEqual("docker", get_bottle_backend("docker").name)
|
||||||
|
|
||||||
|
def test_env_var_used_when_no_explicit_name(self):
|
||||||
|
from bot_bottle.backend import get_bottle_backend
|
||||||
|
with patch.dict(os.environ, {"BOT_BOTTLE_BACKEND": "firecracker"}):
|
||||||
|
self.assertEqual("firecracker", get_bottle_backend().name)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
@@ -175,14 +175,6 @@ class TestCmdStartHeadless(unittest.TestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual("researcher-2", self._spec().label)
|
self.assertEqual("researcher-2", self._spec().label)
|
||||||
|
|
||||||
# -- backend wiring ------------------------------------------------
|
|
||||||
|
|
||||||
def test_backend_flag_forwarded(self):
|
|
||||||
start_mod.cmd_start(
|
|
||||||
["--headless", "--backend=docker", "researcher", "--bottle", "claude",
|
|
||||||
"--prompt", "Do it"]
|
|
||||||
)
|
|
||||||
self.assertEqual("docker", self._launch_mock.call_args[1]["backend_name"])
|
|
||||||
|
|
||||||
|
|
||||||
class TestPrepareWithPreflight(unittest.TestCase):
|
class TestPrepareWithPreflight(unittest.TestCase):
|
||||||
|
|||||||
@@ -82,7 +82,7 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
def test_explicit_agent_skips_agent_picker(self):
|
def test_explicit_agent_skips_agent_picker(self):
|
||||||
rc = start_mod.cmd_start(["--backend=docker", "researcher"])
|
rc = start_mod.cmd_start(["researcher"])
|
||||||
self.assertEqual(0, rc)
|
self.assertEqual(0, rc)
|
||||||
self._agent_picker_mock.assert_not_called()
|
self._agent_picker_mock.assert_not_called()
|
||||||
self._bottle_picker_mock.assert_called_once()
|
self._bottle_picker_mock.assert_called_once()
|
||||||
@@ -100,7 +100,7 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
|
|
||||||
def test_agent_absent_shows_agent_picker(self):
|
def test_agent_absent_shows_agent_picker(self):
|
||||||
self._agent_picker_mock.return_value = "researcher"
|
self._agent_picker_mock.return_value = "researcher"
|
||||||
rc = start_mod.cmd_start(["--backend=docker"])
|
rc = start_mod.cmd_start([])
|
||||||
self.assertEqual(0, rc)
|
self.assertEqual(0, rc)
|
||||||
self._agent_picker_mock.assert_called_once()
|
self._agent_picker_mock.assert_called_once()
|
||||||
call_kwargs = self._agent_picker_mock.call_args
|
call_kwargs = self._agent_picker_mock.call_args
|
||||||
@@ -111,7 +111,7 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
|
|
||||||
def test_agent_picker_cancel_skips_bottle_picker(self):
|
def test_agent_picker_cancel_skips_bottle_picker(self):
|
||||||
self._agent_picker_mock.return_value = None
|
self._agent_picker_mock.return_value = None
|
||||||
rc = start_mod.cmd_start(["--backend=docker"])
|
rc = start_mod.cmd_start([])
|
||||||
self.assertEqual(0, rc)
|
self.assertEqual(0, rc)
|
||||||
self._bottle_picker_mock.assert_not_called()
|
self._bottle_picker_mock.assert_not_called()
|
||||||
self._launch_mock.assert_not_called()
|
self._launch_mock.assert_not_called()
|
||||||
@@ -168,16 +168,6 @@ class TestCmdStartSelector(unittest.TestCase):
|
|||||||
# Backend wiring
|
# Backend wiring
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
def test_explicit_backend_forwarded(self):
|
|
||||||
start_mod.cmd_start(["--backend=docker", "researcher"])
|
|
||||||
_, kwargs = self._launch_mock.call_args
|
|
||||||
self.assertEqual("docker", kwargs["backend_name"])
|
|
||||||
|
|
||||||
def test_absent_backend_uses_default(self):
|
|
||||||
start_mod.cmd_start(["researcher"])
|
|
||||||
_, kwargs = self._launch_mock.call_args
|
|
||||||
self.assertIsNone(kwargs["backend_name"])
|
|
||||||
|
|
||||||
def test_bot_bottle_backend_env_skips_backend_picker(self):
|
def test_bot_bottle_backend_env_skips_backend_picker(self):
|
||||||
os.environ["BOT_BOTTLE_BACKEND"] = "docker"
|
os.environ["BOT_BOTTLE_BACKEND"] = "docker"
|
||||||
try:
|
try:
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ 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:
|
||||||
@@ -50,7 +49,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"{_UTIL}.provision_git_gate", provision or Mock()):
|
patch(f"{_MOD}.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:
|
||||||
@@ -85,8 +84,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"{_UTIL}.OrchestratorClient", return_value=client), \
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_UTIL}.deprovision_git_gate") as deprov:
|
patch(f"{_MOD}.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()
|
||||||
|
|||||||
@@ -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", "Dockerfile.infra.fc"):
|
for name in ("Dockerfile.orchestrator", "Dockerfile.gateway", "Dockerfile.infra"):
|
||||||
(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,7 +17,6 @@ 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:
|
||||||
@@ -88,7 +87,7 @@ 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"{_UTIL}.provision_git_gate", provision or Mock()):
|
patch(f"{_MOD}.provision_git_gate", provision or Mock()):
|
||||||
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",
|
||||||
@@ -126,8 +125,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"{_UTIL}.OrchestratorClient", return_value=client), \
|
with patch(f"{_MOD}.OrchestratorClient", return_value=client), \
|
||||||
patch(f"{_UTIL}.deprovision_git_gate", deprovision):
|
patch(f"{_MOD}.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])
|
||||||
|
|||||||
@@ -17,10 +17,10 @@ from unittest.mock import 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
|
||||||
from bot_bottle.backend.macos_container.consolidated_launch import GatewayEndpoint
|
from bot_bottle.backend.macos_container.consolidated_launch import GatewayEndpoint
|
||||||
|
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,
|
||||||
_proxy_url,
|
|
||||||
)
|
)
|
||||||
from bot_bottle.manifest import ManifestIndex
|
from bot_bottle.manifest import ManifestIndex
|
||||||
|
|
||||||
@@ -104,19 +104,38 @@ class TestAgentRunArgv(unittest.TestCase):
|
|||||||
read back after start."""
|
read back after start."""
|
||||||
self.assertNotIn("--ip", self.argv)
|
self.assertNotIn("--ip", self.argv)
|
||||||
|
|
||||||
def test_run_time_proxy_carries_no_identity_token(self) -> None:
|
def test_run_time_env_sets_no_proxy_vars_at_all(self) -> None:
|
||||||
"""The token is minted by registration, which happens after this run —
|
"""Regression: the proxy vars must exist *only* in the exec-time env.
|
||||||
so it cannot be here. `/resolve` denies the token-less pair (#366),
|
|
||||||
which is the safe direction; the real value arrives at exec time."""
|
`container exec --env` appends rather than replaces, so a token-less
|
||||||
joined = " ".join(self.argv)
|
`HTTPS_PROXY` here would survive next to the token-bearing one and
|
||||||
self.assertIn(f"HTTP_PROXY={_proxy_url('192.168.128.3')}", joined)
|
leave two entries in the agent's `environ`. Resolution is then
|
||||||
self.assertNotIn("bottle:", joined)
|
runtime-specific — Node reads the last, Rust's `std::env::var` reads
|
||||||
|
the first — so Codex proxied without its identity token and every
|
||||||
|
request fail-closed at `/resolve`.
|
||||||
|
"""
|
||||||
|
for entry in self.argv:
|
||||||
|
self.assertFalse(
|
||||||
|
entry.upper().startswith(("HTTP_PROXY=", "HTTPS_PROXY=")),
|
||||||
|
f"run-time env must not set a proxy var, got {entry!r}",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_run_time_env_carries_no_identity_token(self) -> None:
|
||||||
|
"""The token is minted by registration, which happens after this run,
|
||||||
|
so it cannot be here under any name."""
|
||||||
|
self.assertNotIn("bottle:", " ".join(self.argv))
|
||||||
|
|
||||||
def test_gateway_bypasses_the_proxy(self) -> None:
|
def test_gateway_bypasses_the_proxy(self) -> None:
|
||||||
"""git-http + supervise live on the gateway and must be reached
|
"""git-http + supervise live on the gateway and must be reached
|
||||||
directly, not through its own egress proxy."""
|
directly, not through its own egress proxy."""
|
||||||
entry = next(a for a in self.argv if a.startswith("NO_PROXY="))
|
entry = next(a for a in self.argv if a.startswith("NO_PROXY="))
|
||||||
self.assertIn("192.168.128.3", entry)
|
self.assertIn(GATEWAY_HOSTNAME, entry)
|
||||||
|
|
||||||
|
def test_no_proxy_names_the_gateway_and_never_addresses_it(self) -> None:
|
||||||
|
"""NO_PROXY is baked into the run-time env, so an address here is as
|
||||||
|
unfixable as the proxy URL if the gateway moves."""
|
||||||
|
entry = next(a for a in self.argv if a.startswith("NO_PROXY="))
|
||||||
|
self.assertNotIn("192.168.128.3", entry)
|
||||||
|
|
||||||
def test_forwarded_secrets_stay_off_argv(self) -> None:
|
def test_forwarded_secrets_stay_off_argv(self) -> None:
|
||||||
"""Bare name → inherited from the run process env, so the value never
|
"""Bare name → inherited from the run process env, so the value never
|
||||||
@@ -134,7 +153,7 @@ class TestIdentityTokenDelivery(unittest.TestCase):
|
|||||||
def test_exec_env_carries_the_token_as_proxy_credentials(self) -> None:
|
def test_exec_env_carries_the_token_as_proxy_credentials(self) -> None:
|
||||||
env = _identity_proxy_env(_endpoint(), "s3cret")
|
env = _identity_proxy_env(_endpoint(), "s3cret")
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
"http://bottle:s3cret@192.168.128.3:9099", env["HTTP_PROXY"],
|
f"http://bottle:s3cret@{GATEWAY_HOSTNAME}:9099", env["HTTP_PROXY"],
|
||||||
)
|
)
|
||||||
self.assertEqual(env["HTTP_PROXY"], env["https_proxy"])
|
self.assertEqual(env["HTTP_PROXY"], env["https_proxy"])
|
||||||
|
|
||||||
@@ -202,7 +221,7 @@ class TestPlanIdentityToken(unittest.TestCase):
|
|||||||
self.assertIn("HTTP_PROXY", argv)
|
self.assertIn("HTTP_PROXY", argv)
|
||||||
self.assertNotIn("s3cret", " ".join(argv))
|
self.assertNotIn("s3cret", " ".join(argv))
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
"http://bottle:s3cret@192.168.128.3:9099", kwargs["env"]["HTTP_PROXY"],
|
f"http://bottle:s3cret@{GATEWAY_HOSTNAME}:9099", kwargs["env"]["HTTP_PROXY"],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -272,6 +272,30 @@ resolver #2
|
|||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_exec_container_as_root_selects_root_user(self):
|
||||||
|
completed = util.subprocess.CompletedProcess(
|
||||||
|
args=[], returncode=0, stdout="", stderr="",
|
||||||
|
)
|
||||||
|
with patch.object(util, "_run_container_op", return_value=completed) as run:
|
||||||
|
util.exec_container_as_root("bot-bottle-demo", ["true"])
|
||||||
|
|
||||||
|
run.assert_called_once_with([
|
||||||
|
"container", "exec", "--user", "root", "bot-bottle-demo", "true",
|
||||||
|
])
|
||||||
|
|
||||||
|
def test_exec_container_as_root_reports_failure(self):
|
||||||
|
failed = util.subprocess.CompletedProcess(
|
||||||
|
args=[], returncode=1, stdout="", stderr="permission denied\n",
|
||||||
|
)
|
||||||
|
with patch.object(util, "_run_container_op", return_value=failed), \
|
||||||
|
patch.object(util, "die", side_effect=SystemExit("die")) as die:
|
||||||
|
with self.assertRaises(SystemExit):
|
||||||
|
util.exec_container_as_root("bot-bottle-demo", ["true"])
|
||||||
|
|
||||||
|
die.assert_called_once_with(
|
||||||
|
"container exec (root) in bot-bottle-demo failed: permission denied",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _completed(stdout: str, returncode: int = 0):
|
def _completed(stdout: str, returncode: int = 0):
|
||||||
return util.subprocess.CompletedProcess(args=[], returncode=returncode, stdout=stdout, stderr="")
|
return util.subprocess.CompletedProcess(args=[], returncode=returncode, stdout=stdout, stderr="")
|
||||||
|
|||||||
@@ -0,0 +1,140 @@
|
|||||||
|
"""Unit: stable gateway name via each bottle's /etc/hosts (issue #443).
|
||||||
|
|
||||||
|
The gateway's address moves whenever the infra container is recreated. Agents
|
||||||
|
name it instead of addressing it, and the name resolves through `/etc/hosts` —
|
||||||
|
a file, so it stays rewritable while the bottle runs, unlike the `environ` the
|
||||||
|
proxy URL is delivered in.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container.gateway_hosts import (
|
||||||
|
GATEWAY_HOSTNAME,
|
||||||
|
refresh_gateway_host,
|
||||||
|
set_gateway_host,
|
||||||
|
)
|
||||||
|
|
||||||
|
_MOD = "bot_bottle.backend.macos_container.gateway_hosts"
|
||||||
|
|
||||||
|
|
||||||
|
class TestSetGatewayHost(unittest.TestCase):
|
||||||
|
def _script(self, exec_root: object) -> str:
|
||||||
|
argv = exec_root.call_args.args[1] # type: ignore[attr-defined]
|
||||||
|
self.assertEqual(["sh", "-c"], argv[:2])
|
||||||
|
return argv[2]
|
||||||
|
|
||||||
|
def test_writes_the_address_against_the_stable_name(self) -> None:
|
||||||
|
with patch(f"{_MOD}.container_mod.exec_container_as_root") as ex:
|
||||||
|
set_gateway_host("bot-bottle-demo", "192.168.128.19")
|
||||||
|
self.assertEqual("bot-bottle-demo", ex.call_args.args[0])
|
||||||
|
script = self._script(ex)
|
||||||
|
self.assertIn("192.168.128.19", script)
|
||||||
|
self.assertIn(GATEWAY_HOSTNAME, script)
|
||||||
|
|
||||||
|
def test_runs_as_root_so_the_agent_cannot_repoint_itself(self) -> None:
|
||||||
|
"""The agent runs as `node`. If it could rewrite /etc/hosts it could
|
||||||
|
aim its own gateway name elsewhere, so the write must go through the
|
||||||
|
root-only helper."""
|
||||||
|
with patch(f"{_MOD}.container_mod.exec_container_as_root") as ex:
|
||||||
|
set_gateway_host("bot-bottle-demo", "10.0.0.1")
|
||||||
|
ex.assert_called_once()
|
||||||
|
|
||||||
|
def test_is_idempotent_by_removing_its_own_line_first(self) -> None:
|
||||||
|
"""Re-pointing must replace the managed entry, not append a second one
|
||||||
|
— two entries for the same name would resolve by luck of ordering."""
|
||||||
|
with patch(f"{_MOD}.container_mod.exec_container_as_root") as ex:
|
||||||
|
set_gateway_host("bot-bottle-demo", "10.0.0.1")
|
||||||
|
self.assertIn("grep -v", self._script(ex))
|
||||||
|
|
||||||
|
def test_preserves_the_rest_of_the_hosts_file(self) -> None:
|
||||||
|
"""localhost and the container's own name must survive the rewrite."""
|
||||||
|
with patch(f"{_MOD}.container_mod.exec_container_as_root") as ex:
|
||||||
|
set_gateway_host("bot-bottle-demo", "10.0.0.1")
|
||||||
|
script = self._script(ex)
|
||||||
|
# Filter-and-append, never a truncating write of just our line.
|
||||||
|
self.assertIn("/etc/hosts >", script)
|
||||||
|
self.assertIn(">> /tmp/.bb-hosts", script)
|
||||||
|
|
||||||
|
def test_keeps_the_original_inode(self) -> None:
|
||||||
|
"""`cat >` rather than `mv`: a pre-created /etc/hosts must keep its
|
||||||
|
ownership and mode, not be replaced by a root-owned copy."""
|
||||||
|
script = None
|
||||||
|
with patch(f"{_MOD}.container_mod.exec_container_as_root") as ex:
|
||||||
|
set_gateway_host("bot-bottle-demo", "10.0.0.1")
|
||||||
|
script = self._script(ex)
|
||||||
|
self.assertIn("cat /tmp/.bb-hosts > /etc/hosts", script)
|
||||||
|
self.assertNotIn("mv ", script)
|
||||||
|
|
||||||
|
|
||||||
|
class TestRefreshGatewayHost(unittest.TestCase):
|
||||||
|
"""The re-attach sweep: bottles stranded by an earlier gateway restart get
|
||||||
|
re-pointed in place instead of needing a relaunch."""
|
||||||
|
|
||||||
|
def _agents(self, *slugs: str) -> list[SimpleNamespace]:
|
||||||
|
return [SimpleNamespace(slug=s) for s in slugs]
|
||||||
|
|
||||||
|
def test_repoints_every_running_bottle(self) -> None:
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=self._agents("a", "b")), \
|
||||||
|
patch(f"{_MOD}.set_gateway_host") as setter:
|
||||||
|
updated = refresh_gateway_host("192.168.128.19")
|
||||||
|
self.assertEqual(["bot-bottle-a", "bot-bottle-b"], updated)
|
||||||
|
self.assertEqual(
|
||||||
|
[("bot-bottle-a", "192.168.128.19"), ("bot-bottle-b", "192.168.128.19")],
|
||||||
|
[c.args for c in setter.call_args_list],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_one_failing_bottle_does_not_stop_the_sweep(self) -> None:
|
||||||
|
"""A container that is already exiting must not block the repair of
|
||||||
|
its neighbours, nor fail the launch that triggered the sweep."""
|
||||||
|
def _flaky(name: str, _ip: str) -> None:
|
||||||
|
if name == "bot-bottle-a":
|
||||||
|
raise RuntimeError("container is exiting")
|
||||||
|
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=self._agents("a", "b")), \
|
||||||
|
patch(f"{_MOD}.set_gateway_host", side_effect=_flaky), \
|
||||||
|
patch(f"{_MOD}.warn") as warn:
|
||||||
|
updated = refresh_gateway_host("10.0.0.1")
|
||||||
|
self.assertEqual(["bot-bottle-b"], updated)
|
||||||
|
warn.assert_called_once()
|
||||||
|
|
||||||
|
def test_no_running_bottles_is_a_clean_no_op(self) -> None:
|
||||||
|
with patch(f"{_MOD}.enumerate_active", return_value=[]), \
|
||||||
|
patch(f"{_MOD}.set_gateway_host") as setter:
|
||||||
|
self.assertEqual([], refresh_gateway_host("10.0.0.1"))
|
||||||
|
setter.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class TestLaunchWiring(unittest.TestCase):
|
||||||
|
"""Ordering matters: the name must resolve before anything execs, and the
|
||||||
|
stranded-bottle sweep must run once the gateway is known to be up."""
|
||||||
|
|
||||||
|
def test_launch_sets_the_host_entry_before_reading_the_source_ip(self) -> None:
|
||||||
|
"""The agent's every URL names the gateway, so the entry has to exist
|
||||||
|
before the first connection — which means before the agent execs."""
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container import launch
|
||||||
|
|
||||||
|
src = inspect.getsource(launch)
|
||||||
|
set_at = src.index("set_gateway_host(plan.container_name")
|
||||||
|
exec_at = src.index("wait_container_ipv4_on_network")
|
||||||
|
self.assertLess(set_at, exec_at)
|
||||||
|
|
||||||
|
def test_launch_refreshes_stranded_bottles_after_ensure_gateway(self) -> None:
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
from bot_bottle.backend.macos_container import launch
|
||||||
|
|
||||||
|
src = inspect.getsource(launch)
|
||||||
|
ensure_at = src.index("endpoint = ensure_gateway()")
|
||||||
|
refresh_at = src.index("refresh_gateway_host(endpoint.gateway_ip)")
|
||||||
|
self.assertLess(ensure_at, refresh_at)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
"""Unit: infra container lifecycle — idempotent singleton (PRD 0070)."""
|
"""Unit: orchestrator+gateway container lifecycle — idempotent singleton (PRD 0070)."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -8,10 +8,10 @@ import urllib.error
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import MagicMock, Mock, patch
|
from unittest.mock import MagicMock, Mock, patch
|
||||||
|
|
||||||
from bot_bottle.orchestrator.gateway import GatewayError
|
|
||||||
from bot_bottle.orchestrator.lifecycle import (
|
from bot_bottle.orchestrator.lifecycle import (
|
||||||
INFRA_NAME,
|
ORCHESTRATOR_IMAGE,
|
||||||
INFRA_SOURCE_HASH_LABEL,
|
ORCHESTRATOR_NAME,
|
||||||
|
ORCHESTRATOR_SOURCE_HASH_LABEL,
|
||||||
OrchestratorService,
|
OrchestratorService,
|
||||||
OrchestratorStartError,
|
OrchestratorStartError,
|
||||||
source_hash,
|
source_hash,
|
||||||
@@ -20,6 +20,7 @@ from tests.unit import use_bottle_root
|
|||||||
|
|
||||||
_URLOPEN = "bot_bottle.orchestrator.lifecycle.urllib.request.urlopen"
|
_URLOPEN = "bot_bottle.orchestrator.lifecycle.urllib.request.urlopen"
|
||||||
_RUN = "bot_bottle.orchestrator.lifecycle.run_docker"
|
_RUN = "bot_bottle.orchestrator.lifecycle.run_docker"
|
||||||
|
_GATEWAY = "bot_bottle.orchestrator.lifecycle.DockerGateway"
|
||||||
_SLEEP = "bot_bottle.orchestrator.lifecycle.time.sleep"
|
_SLEEP = "bot_bottle.orchestrator.lifecycle.time.sleep"
|
||||||
_MONOTONIC = "bot_bottle.orchestrator.lifecycle.time.monotonic"
|
_MONOTONIC = "bot_bottle.orchestrator.lifecycle.time.monotonic"
|
||||||
|
|
||||||
@@ -41,8 +42,10 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
self.addCleanup(use_bottle_root(Path(self._tmp.name)))
|
self.addCleanup(use_bottle_root(Path(self._tmp.name)))
|
||||||
self.svc = OrchestratorService(port=8099)
|
self.svc = OrchestratorService(port=8099)
|
||||||
|
|
||||||
def test_url(self) -> None:
|
def test_urls(self) -> None:
|
||||||
self.assertEqual("http://127.0.0.1:8099", self.svc.url)
|
self.assertEqual("http://127.0.0.1:8099", self.svc.url)
|
||||||
|
# The gateway reaches the control plane by container name over docker DNS.
|
||||||
|
self.assertEqual(f"http://{ORCHESTRATOR_NAME}:8099", self.svc.internal_url)
|
||||||
|
|
||||||
def test_is_healthy(self) -> None:
|
def test_is_healthy(self) -> None:
|
||||||
with patch(_URLOPEN, return_value=_health(200)):
|
with patch(_URLOPEN, return_value=_health(200)):
|
||||||
@@ -51,147 +54,126 @@ class TestOrchestratorService(unittest.TestCase):
|
|||||||
self.assertFalse(self.svc.is_healthy())
|
self.assertFalse(self.svc.is_healthy())
|
||||||
|
|
||||||
def test_ensure_running_noop_when_healthy_and_source_unchanged(self) -> None:
|
def test_ensure_running_noop_when_healthy_and_source_unchanged(self) -> None:
|
||||||
# A healthy container on current source is left alone — recreating it
|
# A healthy control plane already running the *current* bind-mounted
|
||||||
# on every launch drops in-memory egress tokens (#381).
|
# source is left alone — recreating it on every launch would drop
|
||||||
|
# every other active bottle's in-memory egress tokens (#381).
|
||||||
current = source_hash(self.svc._repo_root)
|
current = source_hash(self.svc._repo_root)
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=INFRA_NAME)
|
return _proc(stdout=ORCHESTRATOR_NAME)
|
||||||
if argv[:2] == ["docker", "inspect"]:
|
if argv[:2] == ["docker", "inspect"]:
|
||||||
return _proc(stdout=current)
|
return _proc(stdout=current)
|
||||||
return _proc()
|
return _proc()
|
||||||
|
|
||||||
with patch(_URLOPEN, return_value=_health(200)), \
|
with patch(_URLOPEN, return_value=_health(200)), \
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
patch(_GATEWAY) as gw_cls, patch(_RUN, side_effect=fake), patch(_SLEEP):
|
||||||
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
||||||
|
gw_cls.return_value.ensure_running.assert_called() # gateway kept up
|
||||||
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
||||||
rms = [c for c in calls if c[:3] == ["docker", "rm", "--force"] and INFRA_NAME in c]
|
rms = [c for c in calls if c[:3] == ["docker", "rm", "--force"] and ORCHESTRATOR_NAME in c]
|
||||||
self.assertEqual([], runs)
|
self.assertEqual([], runs) # not recreated
|
||||||
self.assertEqual([], rms)
|
self.assertEqual([], rms)
|
||||||
|
|
||||||
def test_ensure_running_recreates_when_source_changed(self) -> None:
|
def test_ensure_running_recreates_when_source_changed(self) -> None:
|
||||||
|
# Healthy, but the running container's label doesn't match the
|
||||||
|
# current source hash (a real code change) — recreate so it takes
|
||||||
|
# effect, same as the gateway's image-staleness check.
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout=INFRA_NAME)
|
return _proc(stdout=ORCHESTRATOR_NAME)
|
||||||
if argv[:2] == ["docker", "inspect"]:
|
if argv[:2] == ["docker", "inspect"]:
|
||||||
return _proc(stdout="stale-hash")
|
return _proc(stdout="stale-hash")
|
||||||
return _proc()
|
return _proc()
|
||||||
|
|
||||||
with patch(_URLOPEN, return_value=_health(200)), \
|
with patch(_URLOPEN, return_value=_health(200)), \
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
patch(_GATEWAY), patch(_RUN, side_effect=fake), patch(_SLEEP):
|
||||||
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
||||||
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
||||||
self.assertEqual(1, len(runs))
|
self.assertEqual(1, len(runs))
|
||||||
self.assertIn(INFRA_NAME, runs[0])
|
self.assertIn(ORCHESTRATOR_NAME, runs[0])
|
||||||
|
# the fresh container is labeled with the current hash, not the stale one
|
||||||
current = source_hash(self.svc._repo_root)
|
current = source_hash(self.svc._repo_root)
|
||||||
self.assertIn(f"{INFRA_SOURCE_HASH_LABEL}={current}", runs[0])
|
self.assertIn(f"{ORCHESTRATOR_SOURCE_HASH_LABEL}={current}", runs[0])
|
||||||
|
|
||||||
def test_ensure_running_starts_infra_container_when_absent(self) -> None:
|
def test_ensure_running_starts_orchestrator_container_when_absent(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="")
|
return _proc(stdout="") # not running
|
||||||
return _proc()
|
return _proc()
|
||||||
|
|
||||||
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
patch(_GATEWAY), patch(_RUN, side_effect=fake), patch(_SLEEP):
|
||||||
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
self.assertEqual(self.svc.url, self.svc.ensure_running())
|
||||||
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
runs = [c for c in calls if c[:2] == ["docker", "run"]]
|
||||||
self.assertEqual(1, len(runs))
|
self.assertEqual(1, len(runs))
|
||||||
argv = runs[0]
|
argv = runs[0]
|
||||||
self.assertIn(INFRA_NAME, argv)
|
self.assertIn(ORCHESTRATOR_NAME, argv)
|
||||||
# Published on loopback — not exposed on external interfaces.
|
self.assertIn("--broker", argv)
|
||||||
|
self.assertEqual("stub", argv[argv.index("--broker") + 1]) # register-only, no socket
|
||||||
|
self.assertIn("bot_bottle.orchestrator", argv)
|
||||||
self.assertEqual("127.0.0.1:8099:8099", argv[argv.index("--publish") + 1])
|
self.assertEqual("127.0.0.1:8099:8099", argv[argv.index("--publish") + 1])
|
||||||
# Both processes in one container — no separate entrypoint override.
|
|
||||||
self.assertNotIn("--entrypoint", argv)
|
|
||||||
# Gateway daemons + orchestrator explicitly opted in.
|
|
||||||
daemons_flag = "BOT_BOTTLE_GATEWAY_DAEMONS=egress,git-http,supervise,orchestrator"
|
|
||||||
self.assertIn("orchestrator", argv[argv.index(daemons_flag)])
|
|
||||||
|
|
||||||
def test_ensure_running_builds_both_images(self) -> None:
|
def test_ensure_running_builds_lean_orchestrator_image_when_missing(self) -> None:
|
||||||
|
# The control plane runs its own lean image (#384), distinct from the
|
||||||
|
# gateway data plane — built from Dockerfile.orchestrator when absent.
|
||||||
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
|
calls.append(argv)
|
||||||
|
if argv[:2] == ["docker", "ps"]:
|
||||||
|
return _proc(stdout="") # orchestrator not running
|
||||||
|
if argv[:3] == ["docker", "image", "inspect"]:
|
||||||
|
return _proc(returncode=1) # image absent -> build
|
||||||
|
return _proc()
|
||||||
|
|
||||||
|
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
||||||
|
patch(_GATEWAY), patch(_RUN, side_effect=fake), patch(_SLEEP):
|
||||||
|
self.svc.ensure_running()
|
||||||
|
builds = [c for c in calls if c[:2] == ["docker", "build"]]
|
||||||
|
self.assertEqual(1, len(builds))
|
||||||
|
self.assertIn(ORCHESTRATOR_IMAGE, builds[0])
|
||||||
|
self.assertTrue(any(a.endswith("Dockerfile.orchestrator") for a in builds[0]))
|
||||||
|
# It is NOT the gateway image/dockerfile — the split is the point.
|
||||||
|
self.assertFalse(any("Dockerfile.gateway" in a for a in builds[0]))
|
||||||
|
|
||||||
|
def test_ensure_running_skips_orchestrator_image_build_when_present(self) -> None:
|
||||||
calls: list[list[str]] = []
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
def fake(argv: list[str], **_kw: object) -> Mock:
|
||||||
calls.append(argv)
|
calls.append(argv)
|
||||||
if argv[:2] == ["docker", "ps"]:
|
if argv[:2] == ["docker", "ps"]:
|
||||||
return _proc(stdout="")
|
return _proc(stdout="")
|
||||||
|
if argv[:3] == ["docker", "image", "inspect"]:
|
||||||
|
return _proc(returncode=0) # image present -> no build
|
||||||
return _proc()
|
return _proc()
|
||||||
|
|
||||||
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
patch(_GATEWAY), patch(_RUN, side_effect=fake), patch(_SLEEP):
|
||||||
self.svc.ensure_running()
|
self.svc.ensure_running()
|
||||||
builds = [c for c in calls if c[:2] == ["docker", "build"]]
|
self.assertEqual([], [c for c in calls if c[:2] == ["docker", "build"]])
|
||||||
# Orchestrator (build intermediate) + infra image both built.
|
|
||||||
self.assertEqual(2, len(builds))
|
|
||||||
dockerfiles = [next(a for a in b if "Dockerfile" in a) for b in builds]
|
|
||||||
self.assertIn("Dockerfile.orchestrator", dockerfiles[0])
|
|
||||||
self.assertIn("Dockerfile.infra", dockerfiles[1])
|
|
||||||
# Images are distinct — the point of the split.
|
|
||||||
tags = [b[b.index("-t") + 1] for b in builds]
|
|
||||||
self.assertNotEqual(tags[0], tags[1])
|
|
||||||
|
|
||||||
def test_ensure_running_raises_on_timeout(self) -> None:
|
def test_ensure_running_raises_on_timeout(self) -> None:
|
||||||
with patch(_URLOPEN, side_effect=urllib.error.URLError("down")), \
|
with patch(_URLOPEN, side_effect=urllib.error.URLError("down")), \
|
||||||
patch(_RUN, return_value=Mock(returncode=0, stdout="", stderr="")), \
|
patch(_GATEWAY), patch(_RUN, return_value=Mock(returncode=0, stderr="")), \
|
||||||
patch(_SLEEP), patch(_MONOTONIC, side_effect=[0.0, 0.5, 2.0]):
|
patch(_SLEEP), patch(_MONOTONIC, side_effect=[0.0, 0.5, 2.0]):
|
||||||
with self.assertRaises(OrchestratorStartError):
|
with self.assertRaises(OrchestratorStartError):
|
||||||
self.svc.ensure_running(startup_timeout=1.0)
|
self.svc.ensure_running(startup_timeout=1.0)
|
||||||
|
|
||||||
def test_noop_when_healthy_and_inspect_fails(self) -> None:
|
def test_stop_removes_orchestrator_and_gateway(self) -> None:
|
||||||
"""If docker inspect fails (e.g. docker daemon hiccup), leave the
|
with patch(_RUN) as run, patch(_GATEWAY) as gw_cls:
|
||||||
working container alone rather than churning it."""
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
|
||||||
if argv[:2] == ["docker", "ps"]:
|
|
||||||
return _proc(stdout=INFRA_NAME)
|
|
||||||
if argv[:2] == ["docker", "inspect"]:
|
|
||||||
return _proc(returncode=1, stderr="daemon error")
|
|
||||||
return _proc()
|
|
||||||
|
|
||||||
with patch(_URLOPEN, return_value=_health(200)), \
|
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
|
||||||
self.svc.ensure_running()
|
|
||||||
# no docker run — the working container was left alone
|
|
||||||
|
|
||||||
def test_build_failure_raises(self) -> None:
|
|
||||||
with patch(_URLOPEN, side_effect=urllib.error.URLError("down")), \
|
|
||||||
patch(_RUN, return_value=_proc(returncode=1, stderr="no space left on device")):
|
|
||||||
with self.assertRaises(GatewayError):
|
|
||||||
self.svc.ensure_running()
|
|
||||||
|
|
||||||
def test_ensure_network_creates_if_missing(self) -> None:
|
|
||||||
"""If the gateway network doesn't exist yet, create it."""
|
|
||||||
calls: list[list[str]] = []
|
|
||||||
|
|
||||||
def fake(argv: list[str], **_kw: object) -> Mock:
|
|
||||||
calls.append(argv)
|
|
||||||
if argv[:3] == ["docker", "network", "inspect"]:
|
|
||||||
return _proc(returncode=1, stderr="not found")
|
|
||||||
if argv[:2] == ["docker", "ps"]:
|
|
||||||
return _proc(stdout="")
|
|
||||||
return _proc()
|
|
||||||
|
|
||||||
with patch(_URLOPEN, side_effect=[urllib.error.URLError("down"), _health(200)]), \
|
|
||||||
patch(_RUN, side_effect=fake), patch(_SLEEP):
|
|
||||||
self.svc.ensure_running()
|
|
||||||
creates = [c for c in calls if c[:3] == ["docker", "network", "create"]]
|
|
||||||
self.assertEqual(1, len(creates))
|
|
||||||
|
|
||||||
def test_stop_removes_infra_container(self) -> None:
|
|
||||||
with patch(_RUN) as run:
|
|
||||||
self.svc.stop()
|
self.svc.stop()
|
||||||
rms = [
|
rms = [c.args[0] for c in run.call_args_list if c.args[0][:3] == ["docker", "rm", "--force"]]
|
||||||
c.args[0] for c in run.call_args_list
|
self.assertTrue(any(ORCHESTRATOR_NAME in a for a in rms))
|
||||||
if c.args[0][:3] == ["docker", "rm", "--force"]
|
gw_cls.return_value.stop.assert_called_once()
|
||||||
]
|
|
||||||
self.assertTrue(any(INFRA_NAME in a for a in rms))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
Reference in New Issue
Block a user