Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c527841d55 | |||
| 5940b75bb7 | |||
| 5e01c28016 | |||
| 2f8539c2c7 |
@@ -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
|
||||||
|
|||||||
@@ -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,19 +267,25 @@ 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(
|
||||||
@@ -276,7 +302,8 @@ def _identity_proxy_env(
|
|||||||
`_agent_env_entries`."""
|
`_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,
|
||||||
@@ -338,7 +365,7 @@ def _agent_env_entries(
|
|||||||
# silently dropping attribution for. Without it a process that egresses
|
# silently dropping attribution for. Without it a process that egresses
|
||||||
# before the exec-time env still fails closed — the agent network is
|
# before the exec-time env still fails closed — the agent network is
|
||||||
# host-only, so there is no route off it except the gateway.
|
# host-only, so there is no route off it except the gateway.
|
||||||
no_proxy = _no_proxy(endpoint.gateway_ip)
|
no_proxy = _no_proxy()
|
||||||
env = [
|
env = [
|
||||||
f"NO_PROXY={no_proxy}",
|
f"NO_PROXY={no_proxy}",
|
||||||
f"no_proxy={no_proxy}",
|
f"no_proxy={no_proxy}",
|
||||||
|
|||||||
@@ -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,
|
||||||
|
|||||||
@@ -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.
|
||||||
+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
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ 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,
|
||||||
@@ -128,7 +129,13 @@ class TestAgentRunArgv(unittest.TestCase):
|
|||||||
"""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
|
||||||
@@ -146,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"])
|
||||||
|
|
||||||
@@ -214,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()
|
||||||
Reference in New Issue
Block a user