Compare commits
391 Commits
4859040c6f
...
pr-211
| Author | SHA1 | Date | |
|---|---|---|---|
| df469b2f47 | |||
| d1d9e7a105 | |||
| 7a124d7d25 | |||
| f00c567469 | |||
| 6f0e5b4589 | |||
| 5da4d05bf2 | |||
| 1a8718ca9d | |||
| c1c225aa05 | |||
| dc7c10d6fe | |||
| a827b0841e | |||
| a9c93ea9df | |||
| bb69af31f8 | |||
| 7644da4280 | |||
| 13e4af421d | |||
| f2d5307573 | |||
| bc9a22b46a | |||
| 932e71c0bf | |||
| d3b0b330aa | |||
| 5e927bcd13 | |||
| 890a146413 | |||
| afdf0779a1 | |||
| eb7cae1fea | |||
| fe82dc7f2b | |||
| b00b0ba4aa | |||
| 3f04567290 | |||
| acb9cd67c6 | |||
| d90ab7e646 | |||
| 8ea90adcaf | |||
| de803e1e76 | |||
| 019efab804 | |||
| 957d37f51f | |||
| 8e084262a0 | |||
| 504144eb9c | |||
| 86374ab293 | |||
| 199edb228c | |||
| 598a20a3f0 | |||
| c8b5ba3812 | |||
| 5ea9fda69b | |||
| 4f7cfc0418 | |||
| 1f38a96561 | |||
| 660b9b3810 | |||
| 328069809b | |||
| b1551045dc | |||
| d02226aab9 | |||
| 39811c9b32 | |||
| f7f161e60f | |||
| e6040fc824 | |||
| 17fc44d0d8 | |||
| 1bebb7467f | |||
| cc1d986a74 | |||
| fabcd026af | |||
| aff042855a | |||
| 39b0c4f720 | |||
| 43a5700ae6 | |||
| 7acdabaf96 | |||
| dfd2d5f620 | |||
| f24e2857ab | |||
| d38432f640 | |||
| 4e570e3e2b | |||
| a64e3170cd | |||
| 4da4babcf4 | |||
| 384e496a1b | |||
| b38c6110f2 | |||
| 74efb1c143 | |||
| f23b2b9683 | |||
| 423003aa05 | |||
| af82f2ba20 | |||
| fe8e15d211 | |||
| b098556757 | |||
| 5c5f277d6d | |||
| 2fa5229695 | |||
| c3caa3ea94 | |||
| ee0607f022 | |||
| afe5d43a9a | |||
| dd332a5759 | |||
| 103f9adcfd | |||
| 652c8cb5a7 | |||
| 11a8f3ba99 | |||
| 451e6fc2fc | |||
| 1ecef55fea | |||
| 76e38b24e6 | |||
| b1283a0e7b | |||
| 2c51bc47e8 | |||
| ff495c1521 | |||
| a04aed098d | |||
| 916b70c595 | |||
| 55cb3429d4 | |||
| 545ff3582f | |||
| 8743299226 | |||
| 205e94f960 | |||
| 86b0a4d285 | |||
| 79212481c9 | |||
| 76dd153760 | |||
| b8d10abec9 | |||
| 7ebddf7792 | |||
| 04d7ca2e6a | |||
| f6f47c2f23 | |||
| 39e0976ace | |||
| 299579ab7b | |||
| 3a10c38511 | |||
| db54f3d0b4 | |||
| 8105e93031 | |||
| 0d5c2f1a2e | |||
| bba24d87f7 | |||
| efb3af4a93 | |||
| 65746af720 | |||
| d9e9d27e01 | |||
| 83351606c6 | |||
| d528f578aa | |||
| cf3310e818 | |||
| 74d6b25183 | |||
| dc837a5400 | |||
| 4eff49c9c5 | |||
| 965d5073c3 | |||
| e82bbb587f | |||
| c89a0d334a | |||
| ac9b6d593f | |||
| 8c0a9c5bc6 | |||
| 63a3b9b50a | |||
| 7e6e0b1f5a | |||
| ab528d9163 | |||
| 7967d32f12 | |||
| a7de3dbb9f | |||
| 0fbf2ab513 | |||
| 436f42c00c | |||
| 881869352d | |||
| 3f982009e2 | |||
| 52820278fd | |||
| abcb336e7c | |||
| 1c7812fa9f | |||
| 4c60779fac | |||
| 726713d081 | |||
| 5265e25f9b | |||
| 035ed430ba | |||
| f145203eee | |||
| eafd1c1fb2 | |||
| e6ad7ae10e | |||
| 05b12b41b6 | |||
| a59da9921e | |||
| bbd6ec85ac | |||
| ce8cb5f0f1 | |||
| 9eb5eef676 | |||
| c94a2542bd | |||
| e6b3cd1824 | |||
| 49f77f2d1e | |||
| d3c2d9e8f6 | |||
| f114c861b4 | |||
| 544a024e22 | |||
| 7f43f64c24 | |||
| 059bba8c4f | |||
| 82b8dffc54 | |||
| 8795616a99 | |||
| f548c30608 | |||
| 24c302ae0f | |||
| a5d08bd64e | |||
| e1ec0afd86 | |||
| b0679dc4c3 | |||
| 3afae56a35 | |||
| 2c18581e04 | |||
| 9800269d11 | |||
| a5078daf1c | |||
| 6316f8379f | |||
| dfe85a201d | |||
| 7c30cd2f52 | |||
| a0c6f938cb | |||
| a430bac1bf | |||
| 59b87bdaab | |||
| 0de3c93ad0 | |||
| 570cd42532 | |||
| 73a4fbe0a7 | |||
| b032ff746d | |||
| 873d75f852 | |||
| 1bd676de06 | |||
| 0bf1532557 | |||
| 58169e2ce9 | |||
| 86bb8e1908 | |||
| 0ca81b102c | |||
| 4e185fab6b | |||
| f665d62712 | |||
| 7b8f40a5f0 | |||
| 605a70408e | |||
| 832808ff9a | |||
| ea66f63d45 | |||
| 83db7336c8 | |||
| bcdffc8400 | |||
| f44751c4b8 | |||
| 3d557beeee | |||
| 44365ecf68 | |||
| 703b12ee9a | |||
| d1556f4659 | |||
| 06eed5b236 | |||
| 98e4e2b7dc | |||
| 9eca46b408 | |||
| 0efc07ba67 | |||
| f12b0f754e | |||
| a593b157d6 | |||
| 15b54cdff2 | |||
| d3bc463295 | |||
| 50ec920243 | |||
| 4372b8a6dd | |||
| 63a7e63ce9 | |||
| c0e1f5fd70 | |||
| 41570e04c0 | |||
| 6f0a42159f | |||
| 5c17f0de95 | |||
| 8a09e32fcc | |||
| 83463f1cc8 | |||
| 0b5d59cf9e | |||
| 464012d97c | |||
| b5f8a27c47 | |||
| f0ca4e3527 | |||
| ca6d257f30 | |||
| cc0c952d0b | |||
| 8c9d4fbc46 | |||
| b9ab1263c2 | |||
| 9282bceaf8 | |||
| 3e50079bcc | |||
| cf9aaf68e7 | |||
| 4cf2cfc55d | |||
| 7c285fde7a | |||
| 64ac204c05 | |||
| 59fd132b9d | |||
| f427d35e72 | |||
| 1105d9a269 | |||
| 46e596d0b1 | |||
| a3a8a01b09 | |||
| 941f316462 | |||
| be3defe5d8 | |||
| 3885e2f5ad | |||
| a08829573d | |||
| d5fcbe53ef | |||
| 6150497b47 | |||
| 5308d53288 | |||
| d01f4b6613 | |||
| 44273be9eb | |||
| 096c7b8196 | |||
| 0432a5d3ff | |||
| fcd1b34e49 | |||
| a0762ac2d3 | |||
| 53219a55e1 | |||
| 71ac555f25 | |||
| f25fa589fe | |||
| 4fdf354b4f | |||
| 5a2011c48f | |||
| 19ebcd52a1 | |||
| 2c061d9cd9 | |||
| cceb300d58 | |||
| b63927368a | |||
| 4319b4ef3b | |||
| 71005d56e2 | |||
| 96b0c3f1fa | |||
| 3087a9aa8b | |||
| e43f75dd1b | |||
| 4ad1ff3898 | |||
| a3d9ac9605 | |||
| 70c9f7254c | |||
| b9108339e7 | |||
| e5b5dd16f1 | |||
| cf76d1a245 | |||
| 717a9126e1 | |||
| 8830306101 | |||
| 1c242b0ad9 | |||
| f95ef0c446 | |||
| 6e954da9b7 | |||
| 9185c145a1 | |||
| a79ef61b62 | |||
| 0a8bba58c7 | |||
| 2247d730cd | |||
| 3472e06efb | |||
| 82ce5d3034 | |||
| 7c260eeff9 | |||
| fe6059e4a6 | |||
| 31708abfad | |||
| 1b34b1df85 | |||
| 51831bf9c0 | |||
| 8f28bd81a7 | |||
| 662e3e1f95 | |||
| 6315456a59 | |||
| a81f0ffa49 | |||
| c39bbe265b | |||
| 0d922371b0 | |||
| fe97b6014d | |||
| 07c8593999 | |||
| f15721b424 | |||
| 10d0872043 | |||
| ae33d1abfb | |||
| f596464f3f | |||
| e528d5c5af | |||
| 0e29bcc829 | |||
| 8c2b59ca94 | |||
| 75f0f9d907 | |||
| 6682357fbb | |||
| 2dd8113f7c | |||
| 36e3443d2e | |||
| d6ebd0d2eb | |||
| eb6bace84f | |||
| f8fc29ce87 | |||
| 938a0e05d6 | |||
| f768d3a853 | |||
| f32b7eb299 | |||
| de9bd7eb83 | |||
| 952dcd7eec | |||
| 59df0b0f0f | |||
| c0219dddd5 | |||
| 884cedc160 | |||
| 76a7921ae6 | |||
| c8ab0c67a8 | |||
| e808e81b87 | |||
| 36ce7aed4f | |||
| a5d83bdcdc | |||
| 8e6583fcb7 | |||
| ac1aa197d4 | |||
| 68e5097534 | |||
| f8a4e6f40b | |||
| a6332b9535 | |||
| 62dd7b2aa5 | |||
| 711cb9c194 | |||
| 0b80ffb16a | |||
| 2350cd11e0 | |||
| 6ea19a8d53 | |||
| 630e65e9a4 | |||
| 7bffaa791c | |||
| de2267d1b4 | |||
| dcaee53cec | |||
| cea832b21d | |||
| 50baf63669 | |||
| 6c673bece6 | |||
| 9dc0dfd5ee | |||
| 2ea73e40a8 | |||
| 7b2474a5d3 | |||
| 847baa84be | |||
| 99ec267c74 | |||
| 848515e5d4 | |||
| ae1531835d | |||
| 5c5f576df0 | |||
| d329e511fd | |||
| 1308e61c7e | |||
| 2141a85884 | |||
| ccbed97776 | |||
| 1df78ee77f | |||
| c840182d12 | |||
| 7b4c1cd091 | |||
| 47c3ba63f8 | |||
| dcd90cd45e | |||
| 0708e99e4e | |||
| f9e3b6adda | |||
| 18e3b62b72 | |||
| e641bacf2d | |||
| c9b18ea17e | |||
| c854db87c6 | |||
| f86349ca92 | |||
| 1f0434bffc | |||
| fed006441d | |||
| bcadc07d09 | |||
| 3299674c30 | |||
| c31845a5b8 | |||
| 9399626ba6 | |||
| 43cd83d77b | |||
| c4449001d1 | |||
| 7f3998e79e | |||
| cdb1870b1c | |||
| cacba087c9 | |||
| 1cbedc91c0 | |||
| c08b09dc9f | |||
| 8875d8cc17 | |||
| c9291f97e6 | |||
| 500fd910c4 | |||
| e03d90962d | |||
| 9183c64225 | |||
| f029a3d7f5 | |||
| 59ee32cc8d | |||
| 85104742ca | |||
| a5c8b4e7b2 | |||
| 4f7a506a9e | |||
| d0712fb757 | |||
| c9cdd41110 | |||
| 9e69aaa99a | |||
| 689675160a | |||
| 574551e2eb | |||
| b3c6d66850 | |||
| aa5aa1f031 | |||
| 9c83ea6428 | |||
| b9853ae0c7 | |||
| 37bd11b375 | |||
| 794e8666e1 | |||
| 3fb305f654 | |||
| a3a9ec065e | |||
| 3103266053 | |||
| 5e0130b56f | |||
| 5d740a6948 | |||
| 3b418580a9 |
@@ -0,0 +1,76 @@
|
|||||||
|
---
|
||||||
|
name: quality-eval
|
||||||
|
description: Use when the user asks to objectively evaluate, score, rate, audit, or quality-gate code, codebases, files, pull requests, or snippets using a strict 5-dimension engineering rubric with scores and refactoring steps.
|
||||||
|
metadata:
|
||||||
|
short-description: Score code quality with a strict rubric
|
||||||
|
---
|
||||||
|
|
||||||
|
# Quality Eval
|
||||||
|
|
||||||
|
## Role
|
||||||
|
|
||||||
|
Act as a Staff Software Engineer and automated quality gate. Evaluate code objectively against the rubric below, surface hidden anti-patterns, and provide a mathematical grade with atomic refactoring steps.
|
||||||
|
|
||||||
|
## Evaluation Rules
|
||||||
|
|
||||||
|
- Evaluate only against the five rubric dimensions.
|
||||||
|
- Be candid. Do not inflate scores for politeness.
|
||||||
|
- Avoid generic advice. Every recommendation must name a specific code location, behavior, or pattern and include a concrete improvement direction.
|
||||||
|
- Inspect the code before scoring. For codebases, read enough representative files, tests, and architecture boundaries to justify the scope.
|
||||||
|
- When exact line numbers are available, cite them.
|
||||||
|
- Do not reveal private chain-of-thought. In the required `Chain of Thought Analysis` section, provide a concise, step-by-step audit rationale with observable findings and score justifications.
|
||||||
|
|
||||||
|
## Rubric
|
||||||
|
|
||||||
|
Score each dimension from 1 to 5 using these anchors:
|
||||||
|
|
||||||
|
| Dimension | Score 1 (Fail) | Score 3 (Pass) | Score 5 (Exemplary) |
|
||||||
|
| :--- | :--- | :--- | :--- |
|
||||||
|
| **Architecture** | Spaghettified; tight coupling; violated separation of concerns. | Modular but relies on leaky abstractions or mixed domains. | Strict domain isolation; follows SOLID; clear dependency inversion. |
|
||||||
|
| **Readability** | Cryptic naming; deep nesting (>3 levels); widespread DRY violations. | Idiomatic but features over-complex functions or sparse documentation. | Self-documenting; expressive naming; high cohesion; flat structure. |
|
||||||
|
| **Resilience** | Swallows errors blindly; lacks contextual logging; fragile to bad input. | Basic try/catch blocks present but lacks granular, typed error handling. | Explicit error boundaries; contextual logging; structured failure modes. |
|
||||||
|
| **Testability** | Hardcoded dependencies make mocking or isolated testing impossible. | Pure functions are testable, but side-effect heavy logic lacks test hooks. | Decoupled IO; deterministic execution; structured for unit and integration tests. |
|
||||||
|
| **SecOps** | Hardcoded secrets; O(n^2) bottlenecks; zero input sanitization. | Safe from obvious flaws but lacks deep defensive optimization. | Validated inputs; optimized algorithmic complexity; zero security debt. |
|
||||||
|
|
||||||
|
## Scoring Method
|
||||||
|
|
||||||
|
1. Determine the evaluated scope and primary language.
|
||||||
|
2. Identify concrete evidence for each dimension.
|
||||||
|
3. Assign integer dimension scores from 1 to 5.
|
||||||
|
4. Compute `composite_score` as the arithmetic mean of the five dimension scores, rounded to one decimal place.
|
||||||
|
5. Include code snippets only when they make a refactoring step more actionable.
|
||||||
|
|
||||||
|
## Required Output
|
||||||
|
|
||||||
|
Structure every response into exactly these three Markdown sections:
|
||||||
|
|
||||||
|
### 1. Chain of Thought Analysis
|
||||||
|
|
||||||
|
Provide a concise step-by-step audit rationale. Name specific files, functions, patterns, anti-patterns, and rubric anchors. Keep it evidence-based and do not include hidden private reasoning.
|
||||||
|
|
||||||
|
### 2. Normalized Score Report
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"evaluation_metadata": {
|
||||||
|
"target_scope": "string",
|
||||||
|
"primary_language": "string"
|
||||||
|
},
|
||||||
|
"metrics": {
|
||||||
|
"architecture_and_modularity": 0,
|
||||||
|
"readability_and_maintainability": 0,
|
||||||
|
"error_handling_and_resilience": 0,
|
||||||
|
"testability_and_mocking": 0,
|
||||||
|
"security_and_performance": 0
|
||||||
|
},
|
||||||
|
"composite_score": 0.0
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Atomic Refactoring Playbook
|
||||||
|
|
||||||
|
* **High Priority (To lift Score 1/2 to 3):**
|
||||||
|
- [ ] Actionable, specific refactoring step with file/line/context reference.
|
||||||
|
* **Medium Priority (To lift Score 3 to 4/5):**
|
||||||
|
- [ ] Optimization or architectural pattern implementation step.
|
||||||
|
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
display_name: Quality Eval
|
||||||
|
short_description: Scores code quality with a strict five-dimension rubric and refactoring playbook.
|
||||||
|
default_prompt: Evaluate this code objectively using the quality-eval rubric and return the three-section score report.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# Weekly canary suite. Catches upstream regressions (broken pipelock
|
# Weekly canary suite. Catches upstream regressions (broken pinned
|
||||||
# image packaging at the pinned digest, etc.) without coupling every
|
# digest, etc.) without coupling every dev push to upstream registry
|
||||||
# dev push to upstream registry availability.
|
# availability.
|
||||||
#
|
#
|
||||||
# Opt-in via CLAUDE_BOTTLE_RUN_CANARIES=1 so the same files can be run
|
# Opt-in via CLAUDE_BOTTLE_RUN_CANARIES=1 so the same files can be run
|
||||||
# locally with the same gating.
|
# locally with the same gating.
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
name: lint
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- "**.py"
|
||||||
|
- ".pylintrc"
|
||||||
|
- ".gitea/workflows/lint.yml"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: Install dev dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
|
- name: Run pylint
|
||||||
|
run: |
|
||||||
|
# Run pylint on all Python files in the repo
|
||||||
|
find . -name '*.py' -not -path './.venv/*' -not -path './.git/*' | xargs pylint --fail-under=8.0
|
||||||
|
|
||||||
|
- name: Run pyright
|
||||||
|
run: |
|
||||||
|
# Run pyright type checking
|
||||||
|
pyright .
|
||||||
@@ -0,0 +1,125 @@
|
|||||||
|
# Assign sequential numbers to prd-new-*.md files on merge to main.
|
||||||
|
#
|
||||||
|
# When a PR merges to main and includes prd-new-*.md files this workflow:
|
||||||
|
# 1. Finds the next available NNNN number by scanning existing PRDs.
|
||||||
|
# 2. Renames each prd-new-*.md to NNNN-<slug>.md.
|
||||||
|
# 3. Updates the title header (# PRD prd-new: → # PRD NNNN:).
|
||||||
|
# 4. Flips Status: Draft → Active when the push touched files outside
|
||||||
|
# docs/prds/ anywhere in its commit range (i.e. the implementation
|
||||||
|
# shipped together with the PRD).
|
||||||
|
# 5. Commits the renaming back to main.
|
||||||
|
#
|
||||||
|
# No-op if the working tree contains no prd-new-*.md files.
|
||||||
|
#
|
||||||
|
# NOTE: The workflow scans the working tree (not just HEAD~1..HEAD) because
|
||||||
|
# PRs land as multi-commit pushes and the prd-new file is often added in an
|
||||||
|
# earlier commit on the branch, not in the final squash/merge commit.
|
||||||
|
|
||||||
|
name: prd-number
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- 'docs/prds/prd-new-*.md'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
assign-numbers:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: Configure git
|
||||||
|
run: |
|
||||||
|
git config user.name "github-actions[bot]"
|
||||||
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
|
- name: Assign PRD numbers
|
||||||
|
run: |
|
||||||
|
python3 - <<'EOF'
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
prds_dir = Path("docs/prds")
|
||||||
|
|
||||||
|
# Scan the working tree — prd-new files may have landed in any
|
||||||
|
# commit of a multi-commit push, not just HEAD.
|
||||||
|
new_prds = sorted(prds_dir.glob("prd-new-*.md"))
|
||||||
|
|
||||||
|
if not new_prds:
|
||||||
|
print("No prd-new-*.md files found — nothing to do.")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
# Determine whether non-PRD files were also changed anywhere in
|
||||||
|
# the push range (BEFORE_SHA → HEAD). Falls back to HEAD~1 when
|
||||||
|
# the env var isn't set (e.g. local act runs).
|
||||||
|
before_sha = os.environ.get("GITHUB_EVENT_BEFORE", "HEAD~1")
|
||||||
|
all_changed = subprocess.run(
|
||||||
|
["git", "diff", "--name-only", before_sha, "HEAD"],
|
||||||
|
capture_output=True, text=True, check=True,
|
||||||
|
).stdout.splitlines()
|
||||||
|
non_prd_changed = any(
|
||||||
|
not f.startswith("docs/prds/") for f in all_changed
|
||||||
|
)
|
||||||
|
|
||||||
|
# Find next available number.
|
||||||
|
existing = sorted(
|
||||||
|
int(m.group(1))
|
||||||
|
for p in prds_dir.glob("*.md")
|
||||||
|
if (m := re.match(r"^(\d{4})-", p.name))
|
||||||
|
)
|
||||||
|
next_num = (max(existing) + 1) if existing else 1
|
||||||
|
|
||||||
|
for prd_path in sorted(new_prds):
|
||||||
|
slug = re.sub(r"^prd-new-", "", prd_path.stem)
|
||||||
|
new_name = f"{next_num:04d}-{slug}.md"
|
||||||
|
new_path = prds_dir / new_name
|
||||||
|
print(f" {prd_path.name} → {new_name}")
|
||||||
|
|
||||||
|
content = prd_path.read_text()
|
||||||
|
|
||||||
|
# Update title header.
|
||||||
|
content = re.sub(
|
||||||
|
r"^(#\s+PRD\s+)prd-new(:)",
|
||||||
|
rf"\g<1>{next_num:04d}\2",
|
||||||
|
content,
|
||||||
|
count=1,
|
||||||
|
flags=re.MULTILINE,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Conditionally flip Status.
|
||||||
|
if non_prd_changed:
|
||||||
|
content = re.sub(
|
||||||
|
r"(\*\*Status:\*\*\s*)Draft",
|
||||||
|
r"\g<1>Active",
|
||||||
|
content,
|
||||||
|
count=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
new_path.write_text(content)
|
||||||
|
subprocess.run(["git", "rm", str(prd_path)], check=True)
|
||||||
|
subprocess.run(["git", "add", str(new_path)], check=True)
|
||||||
|
next_num += 1
|
||||||
|
|
||||||
|
subprocess.run(
|
||||||
|
["git", "commit", "-m", "ci(prd): assign sequential numbers to new PRDs"],
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
subprocess.run(["git", "push"], check=True)
|
||||||
|
EOF
|
||||||
@@ -21,7 +21,11 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
paths:
|
||||||
|
- '**.py'
|
||||||
pull_request:
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- '**.py'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
unit:
|
unit:
|
||||||
|
|||||||
@@ -0,0 +1,79 @@
|
|||||||
|
name: Update Quality Badges
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- '**.py'
|
||||||
|
- '.pylintrc'
|
||||||
|
- 'pyrightconfig.json'
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-badges:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.12'
|
||||||
|
|
||||||
|
- name: Install dev dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
|
- name: Run pylint and extract score
|
||||||
|
id: pylint
|
||||||
|
run: |
|
||||||
|
PYLINT_OUTPUT=$(python -m pylint bot_bottle/ 2>&1) || true
|
||||||
|
SCORE=$(echo "$PYLINT_OUTPUT" | grep -oP '(?<=rated at )\d+\.\d+/10' | head -1)
|
||||||
|
echo "score=$SCORE" >> $GITHUB_OUTPUT
|
||||||
|
echo "Pylint score: $SCORE"
|
||||||
|
|
||||||
|
- name: Run pyright and check errors
|
||||||
|
id: pyright
|
||||||
|
run: |
|
||||||
|
PYRIGHT_OUTPUT=$(python -m pyright 2>&1) || true
|
||||||
|
ERRORS=$(echo "$PYRIGHT_OUTPUT" | grep -oP '\d+(?= error)' | head -1)
|
||||||
|
echo "errors=$ERRORS" >> $GITHUB_OUTPUT
|
||||||
|
echo "Pyright errors: $ERRORS"
|
||||||
|
|
||||||
|
- name: Update badges in README
|
||||||
|
run: |
|
||||||
|
PYLINT_SCORE="${{ steps.pylint.outputs.score }}"
|
||||||
|
PYRIGHT_ERRORS="${{ steps.pyright.outputs.errors }}"
|
||||||
|
|
||||||
|
PYLINT_SCORE_ENCODED=$(echo "$PYLINT_SCORE" | sed 's|/|%2F|g')
|
||||||
|
|
||||||
|
if [ -n "$PYLINT_SCORE_ENCODED" ]; then
|
||||||
|
sed -i "s|/badge/pylint-[^)]*|/badge/pylint-${PYLINT_SCORE_ENCODED}-brightgreen|" README.md
|
||||||
|
fi
|
||||||
|
if [ -n "$PYRIGHT_ERRORS" ]; then
|
||||||
|
sed -i "s|/badge/pyright-[^)]*|/badge/pyright-${PYRIGHT_ERRORS}%20errors-brightgreen|" README.md
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Updated badges:"
|
||||||
|
grep -E "pylint|pyright" README.md | head -2
|
||||||
|
|
||||||
|
- name: Commit and push badge updates
|
||||||
|
run: |
|
||||||
|
git config --local user.email "action@gitea.local"
|
||||||
|
git config --local user.name "Quality Badge Bot"
|
||||||
|
|
||||||
|
# Check if there are changes
|
||||||
|
if git diff --quiet README.md; then
|
||||||
|
echo "No badge changes needed"
|
||||||
|
else
|
||||||
|
echo "Badge changes detected, committing..."
|
||||||
|
git add README.md
|
||||||
|
MSG="chore: update quality badges"$'\n\n'"- Pylint: ${{ steps.pylint.outputs.score }}"$'\n'"- Pyright: ${{ steps.pyright.outputs.errors }} errors"$'\n\n'"[skip ci]"
|
||||||
|
git commit -m "$MSG"
|
||||||
|
git push
|
||||||
|
fi
|
||||||
@@ -0,0 +1,632 @@
|
|||||||
|
[MAIN]
|
||||||
|
|
||||||
|
# Analyse import fallback blocks. This can be used to support both Python 2 and
|
||||||
|
# 3 compatible code, which means that the block might have code that exists
|
||||||
|
# only in one or another interpreter, leading to false positives when analysed.
|
||||||
|
analyse-fallback-blocks=no
|
||||||
|
|
||||||
|
# Clear in-memory caches upon conclusion of linting. Useful if running pylint
|
||||||
|
# in a server-like mode.
|
||||||
|
clear-cache-post-run=no
|
||||||
|
|
||||||
|
# Load and enable all available extensions. Use --list-extensions to see a list
|
||||||
|
# all available extensions.
|
||||||
|
#enable-all-extensions=
|
||||||
|
|
||||||
|
# In error mode, messages with a category besides ERROR or FATAL are
|
||||||
|
# suppressed, and no reports are done by default. Error mode is compatible with
|
||||||
|
# disabling specific errors.
|
||||||
|
#errors-only=
|
||||||
|
|
||||||
|
# Always return a 0 (non-error) status code, even if lint errors are found.
|
||||||
|
# This is primarily useful in continuous integration scripts.
|
||||||
|
#exit-zero=
|
||||||
|
|
||||||
|
# A comma-separated list of package or module names from where C extensions may
|
||||||
|
# be loaded. Extensions are loading into the active Python interpreter and may
|
||||||
|
# run arbitrary code.
|
||||||
|
extension-pkg-allow-list=
|
||||||
|
|
||||||
|
# A comma-separated list of package or module names from where C extensions may
|
||||||
|
# be loaded. Extensions are loading into the active Python interpreter and may
|
||||||
|
# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
|
||||||
|
# for backward compatibility.)
|
||||||
|
extension-pkg-whitelist=
|
||||||
|
|
||||||
|
# Return non-zero exit code if any of these messages/categories are detected,
|
||||||
|
# even if score is above --fail-under value. Syntax same as enable. Messages
|
||||||
|
# specified are enabled, while categories only check already-enabled messages.
|
||||||
|
fail-on=
|
||||||
|
|
||||||
|
# Specify a score threshold under which the program will exit with error.
|
||||||
|
fail-under=10
|
||||||
|
|
||||||
|
# Interpret the stdin as a python script, whose filename needs to be passed as
|
||||||
|
# the module_or_package argument.
|
||||||
|
#from-stdin=
|
||||||
|
|
||||||
|
# Files or directories to be skipped. They should be base names, not paths.
|
||||||
|
ignore=CVS
|
||||||
|
|
||||||
|
# Add files or directories matching the regular expressions patterns to the
|
||||||
|
# ignore-list. The regex matches against paths and can be in Posix or Windows
|
||||||
|
# format. Because '\\' represents the directory delimiter on Windows systems,
|
||||||
|
# it can't be used as an escape character.
|
||||||
|
ignore-paths=
|
||||||
|
|
||||||
|
# Files or directories matching the regular expression patterns are skipped.
|
||||||
|
# The regex matches against base names, not paths. The default value ignores
|
||||||
|
# Emacs file locks
|
||||||
|
ignore-patterns=^\.#
|
||||||
|
|
||||||
|
# List of module names for which member attributes should not be checked and
|
||||||
|
# will not be imported (useful for modules/projects where namespaces are
|
||||||
|
# manipulated during runtime and thus existing member attributes cannot be
|
||||||
|
# deduced by static analysis). It supports qualified module names, as well as
|
||||||
|
# Unix pattern matching.
|
||||||
|
ignored-modules=
|
||||||
|
|
||||||
|
# Python code to execute, usually for sys.path manipulation such as
|
||||||
|
# pygtk.require().
|
||||||
|
#init-hook=
|
||||||
|
|
||||||
|
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
|
||||||
|
# number of processors available to use, and will cap the count on Windows to
|
||||||
|
# avoid hangs.
|
||||||
|
jobs=1
|
||||||
|
|
||||||
|
# Control the amount of potential inferred values when inferring a single
|
||||||
|
# object. This can help the performance when dealing with large functions or
|
||||||
|
# complex, nested conditions.
|
||||||
|
limit-inference-results=100
|
||||||
|
|
||||||
|
# List of plugins (as comma separated values of python module names) to load,
|
||||||
|
# usually to register additional checkers.
|
||||||
|
load-plugins=
|
||||||
|
|
||||||
|
# Pickle collected data for later comparisons.
|
||||||
|
persistent=yes
|
||||||
|
|
||||||
|
# Resolve imports to .pyi stubs if available. May reduce no-member messages and
|
||||||
|
# increase not-an-iterable messages.
|
||||||
|
prefer-stubs=no
|
||||||
|
|
||||||
|
# Minimum Python version to use for version dependent checks. Will default to
|
||||||
|
# the version used to run pylint.
|
||||||
|
py-version=3.14
|
||||||
|
|
||||||
|
# Discover python modules and packages in the file system subtree.
|
||||||
|
recursive=no
|
||||||
|
|
||||||
|
# Add paths to the list of the source roots. Supports globbing patterns. The
|
||||||
|
# source root is an absolute path or a path relative to the current working
|
||||||
|
# directory used to determine a package namespace for modules located under the
|
||||||
|
# source root.
|
||||||
|
source-roots=
|
||||||
|
|
||||||
|
# Allow loading of arbitrary C extensions. Extensions are imported into the
|
||||||
|
# active Python interpreter and may run arbitrary code.
|
||||||
|
unsafe-load-any-extension=no
|
||||||
|
|
||||||
|
# In verbose mode, extra non-checker-related info will be displayed.
|
||||||
|
#verbose=
|
||||||
|
|
||||||
|
|
||||||
|
[BASIC]
|
||||||
|
|
||||||
|
# Naming style matching correct argument names.
|
||||||
|
argument-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct argument names. Overrides argument-
|
||||||
|
# naming-style. If left empty, argument names will be checked with the set
|
||||||
|
# naming style.
|
||||||
|
#argument-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct attribute names.
|
||||||
|
attr-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct attribute names. Overrides attr-naming-
|
||||||
|
# style. If left empty, attribute names will be checked with the set naming
|
||||||
|
# style.
|
||||||
|
#attr-rgx=
|
||||||
|
|
||||||
|
# Bad variable names which should always be refused, separated by a comma.
|
||||||
|
bad-names=foo,
|
||||||
|
bar,
|
||||||
|
baz,
|
||||||
|
toto,
|
||||||
|
tutu,
|
||||||
|
tata
|
||||||
|
|
||||||
|
# Bad variable names regexes, separated by a comma. If names match any regex,
|
||||||
|
# they will always be refused
|
||||||
|
bad-names-rgxs=
|
||||||
|
|
||||||
|
# Naming style matching correct class attribute names.
|
||||||
|
class-attribute-naming-style=any
|
||||||
|
|
||||||
|
# Regular expression matching correct class attribute names. Overrides class-
|
||||||
|
# attribute-naming-style. If left empty, class attribute names will be checked
|
||||||
|
# with the set naming style.
|
||||||
|
#class-attribute-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct class constant names.
|
||||||
|
class-const-naming-style=UPPER_CASE
|
||||||
|
|
||||||
|
# Regular expression matching correct class constant names. Overrides class-
|
||||||
|
# const-naming-style. If left empty, class constant names will be checked with
|
||||||
|
# the set naming style.
|
||||||
|
#class-const-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct class names.
|
||||||
|
class-naming-style=PascalCase
|
||||||
|
|
||||||
|
# Regular expression matching correct class names. Overrides class-naming-
|
||||||
|
# style. If left empty, class names will be checked with the set naming style.
|
||||||
|
#class-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct constant names.
|
||||||
|
const-naming-style=UPPER_CASE
|
||||||
|
|
||||||
|
# Regular expression matching correct constant names. Overrides const-naming-
|
||||||
|
# style. If left empty, constant names will be checked with the set naming
|
||||||
|
# style.
|
||||||
|
#const-rgx=
|
||||||
|
|
||||||
|
# Minimum line length for functions/classes that require docstrings, shorter
|
||||||
|
# ones are exempt.
|
||||||
|
docstring-min-length=-1
|
||||||
|
|
||||||
|
# Naming style matching correct function names.
|
||||||
|
function-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct function names. Overrides function-
|
||||||
|
# naming-style. If left empty, function names will be checked with the set
|
||||||
|
# naming style.
|
||||||
|
#function-rgx=
|
||||||
|
|
||||||
|
# Good variable names which should always be accepted, separated by a comma.
|
||||||
|
good-names=i,
|
||||||
|
j,
|
||||||
|
k,
|
||||||
|
ex,
|
||||||
|
Run,
|
||||||
|
_
|
||||||
|
|
||||||
|
# Good variable names regexes, separated by a comma. If names match any regex,
|
||||||
|
# they will always be accepted
|
||||||
|
good-names-rgxs=
|
||||||
|
|
||||||
|
# Include a hint for the correct naming format with invalid-name.
|
||||||
|
include-naming-hint=no
|
||||||
|
|
||||||
|
# Naming style matching correct inline iteration names.
|
||||||
|
inlinevar-naming-style=any
|
||||||
|
|
||||||
|
# Regular expression matching correct inline iteration names. Overrides
|
||||||
|
# inlinevar-naming-style. If left empty, inline iteration names will be checked
|
||||||
|
# with the set naming style.
|
||||||
|
#inlinevar-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct method names.
|
||||||
|
method-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct method names. Overrides method-naming-
|
||||||
|
# style. If left empty, method names will be checked with the set naming style.
|
||||||
|
#method-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct module names.
|
||||||
|
module-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct module names. Overrides module-naming-
|
||||||
|
# style. If left empty, module names will be checked with the set naming style.
|
||||||
|
#module-rgx=
|
||||||
|
|
||||||
|
# Colon-delimited sets of names that determine each other's naming style when
|
||||||
|
# the name regexes allow several styles.
|
||||||
|
name-group=
|
||||||
|
|
||||||
|
# Regular expression which should only match function or class names that do
|
||||||
|
# not require a docstring.
|
||||||
|
no-docstring-rgx=^_
|
||||||
|
|
||||||
|
# Regular expression matching correct parameter specification variable names.
|
||||||
|
# If left empty, parameter specification variable names will be checked with
|
||||||
|
# the set naming style.
|
||||||
|
#paramspec-rgx=
|
||||||
|
|
||||||
|
# List of decorators that produce properties, such as abc.abstractproperty. Add
|
||||||
|
# to this list to register other decorators that produce valid properties.
|
||||||
|
# These decorators are taken in consideration only for invalid-name.
|
||||||
|
property-classes=abc.abstractproperty
|
||||||
|
|
||||||
|
# Regular expression matching correct type alias names. If left empty, type
|
||||||
|
# alias names will be checked with the set naming style.
|
||||||
|
#typealias-rgx=
|
||||||
|
|
||||||
|
# Regular expression matching correct type variable names. If left empty, type
|
||||||
|
# variable names will be checked with the set naming style.
|
||||||
|
#typevar-rgx=
|
||||||
|
|
||||||
|
# Regular expression matching correct type variable tuple names. If left empty,
|
||||||
|
# type variable tuple names will be checked with the set naming style.
|
||||||
|
#typevartuple-rgx=
|
||||||
|
|
||||||
|
# Naming style matching correct variable names.
|
||||||
|
variable-naming-style=snake_case
|
||||||
|
|
||||||
|
# Regular expression matching correct variable names. Overrides variable-
|
||||||
|
# naming-style. If left empty, variable names will be checked with the set
|
||||||
|
# naming style.
|
||||||
|
#variable-rgx=
|
||||||
|
|
||||||
|
|
||||||
|
[CLASSES]
|
||||||
|
|
||||||
|
# Warn about protected attribute access inside special methods
|
||||||
|
check-protected-access-in-special-methods=no
|
||||||
|
|
||||||
|
# List of method names used to declare (i.e. assign) instance attributes.
|
||||||
|
defining-attr-methods=__init__,
|
||||||
|
__new__,
|
||||||
|
setUp,
|
||||||
|
asyncSetUp,
|
||||||
|
__post_init__
|
||||||
|
|
||||||
|
# List of member names, which should be excluded from the protected access
|
||||||
|
# warning.
|
||||||
|
exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
|
||||||
|
|
||||||
|
# List of valid names for the first argument in a class method.
|
||||||
|
valid-classmethod-first-arg=cls
|
||||||
|
|
||||||
|
# List of valid names for the first argument in a metaclass class method.
|
||||||
|
valid-metaclass-classmethod-first-arg=mcs
|
||||||
|
|
||||||
|
|
||||||
|
[DESIGN]
|
||||||
|
|
||||||
|
# List of regular expressions of class ancestor names to ignore when counting
|
||||||
|
# public methods (see R0903)
|
||||||
|
exclude-too-few-public-methods=
|
||||||
|
|
||||||
|
# List of qualified class names to ignore when counting class parents (see
|
||||||
|
# R0901)
|
||||||
|
ignored-parents=
|
||||||
|
|
||||||
|
# Maximum number of arguments for function / method.
|
||||||
|
max-args=5
|
||||||
|
|
||||||
|
# Maximum number of attributes for a class (see R0902).
|
||||||
|
max-attributes=7
|
||||||
|
|
||||||
|
# Maximum number of boolean expressions in an if statement (see R0916).
|
||||||
|
max-bool-expr=5
|
||||||
|
|
||||||
|
# Maximum number of branch for function / method body.
|
||||||
|
max-branches=12
|
||||||
|
|
||||||
|
# Maximum number of locals for function / method body.
|
||||||
|
max-locals=15
|
||||||
|
|
||||||
|
# Maximum number of parents for a class (see R0901).
|
||||||
|
max-parents=7
|
||||||
|
|
||||||
|
# Maximum number of positional arguments for function / method.
|
||||||
|
max-positional-arguments=5
|
||||||
|
|
||||||
|
# Maximum number of public methods for a class (see R0904).
|
||||||
|
max-public-methods=20
|
||||||
|
|
||||||
|
# Maximum number of return / yield for function / method body.
|
||||||
|
max-returns=6
|
||||||
|
|
||||||
|
# Maximum number of statements in function / method body.
|
||||||
|
max-statements=50
|
||||||
|
|
||||||
|
# Minimum number of public methods for a class (see R0903).
|
||||||
|
min-public-methods=2
|
||||||
|
|
||||||
|
|
||||||
|
[EXCEPTIONS]
|
||||||
|
|
||||||
|
# Exceptions that will emit a warning when caught.
|
||||||
|
overgeneral-exceptions=builtins.BaseException,builtins.Exception
|
||||||
|
|
||||||
|
|
||||||
|
[FORMAT]
|
||||||
|
|
||||||
|
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
|
||||||
|
expected-line-ending-format=
|
||||||
|
|
||||||
|
# Regexp for a line that is allowed to be longer than the limit.
|
||||||
|
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
|
||||||
|
|
||||||
|
# Number of spaces of indent required inside a hanging or continued line.
|
||||||
|
indent-after-paren=4
|
||||||
|
|
||||||
|
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
|
||||||
|
# tab).
|
||||||
|
indent-string=' '
|
||||||
|
|
||||||
|
# Maximum number of characters on a single line. Pylint's default of 100 is
|
||||||
|
# based on PEP 8's guidance that teams may choose line lengths up to 99
|
||||||
|
# characters.
|
||||||
|
max-line-length=100
|
||||||
|
|
||||||
|
# Maximum number of lines in a module.
|
||||||
|
max-module-lines=1000
|
||||||
|
|
||||||
|
# Allow the body of a class to be on the same line as the declaration if body
|
||||||
|
# contains single statement.
|
||||||
|
single-line-class-stmt=no
|
||||||
|
|
||||||
|
# Allow the body of an if to be on the same line as the test if there is no
|
||||||
|
# else.
|
||||||
|
single-line-if-stmt=no
|
||||||
|
|
||||||
|
|
||||||
|
[LOGGING]
|
||||||
|
|
||||||
|
# The type of string formatting that logging methods do. `old` means using %
|
||||||
|
# formatting, `new` is for `{}` formatting.
|
||||||
|
logging-format-style=old
|
||||||
|
|
||||||
|
# Logging modules to check that the string format arguments are in logging
|
||||||
|
# function parameter format.
|
||||||
|
logging-modules=logging
|
||||||
|
|
||||||
|
|
||||||
|
[MESSAGES CONTROL]
|
||||||
|
|
||||||
|
# Only show warnings with the listed confidence levels. Leave empty to show
|
||||||
|
# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
|
||||||
|
# UNDEFINED.
|
||||||
|
confidence=HIGH,
|
||||||
|
CONTROL_FLOW,
|
||||||
|
INFERENCE,
|
||||||
|
INFERENCE_FAILURE,
|
||||||
|
UNDEFINED
|
||||||
|
|
||||||
|
# Disable the message, report, category or checker with the given id(s). You
|
||||||
|
# can either give multiple identifiers separated by comma (,) or put this
|
||||||
|
# option multiple times (only on the command line, not in the configuration
|
||||||
|
# file where it should appear only once). You can also use "--disable=all" to
|
||||||
|
# disable everything first and then re-enable specific checks. For example, if
|
||||||
|
# you want to run only the similarities checker, you can use "--disable=all
|
||||||
|
# --enable=similarities". If you want to run only the classes checker, but have
|
||||||
|
# no Warning level messages displayed, use "--disable=all --enable=classes
|
||||||
|
# --disable=W".
|
||||||
|
disable=raw-checker-failed,
|
||||||
|
bad-inline-option,
|
||||||
|
locally-disabled,
|
||||||
|
file-ignored,
|
||||||
|
suppressed-message,
|
||||||
|
useless-suppression,
|
||||||
|
deprecated-pragma,
|
||||||
|
use-symbolic-message-instead,
|
||||||
|
use-implicit-booleaness-not-comparison-to-string,
|
||||||
|
use-implicit-booleaness-not-comparison-to-zero,
|
||||||
|
missing-function-docstring,
|
||||||
|
missing-class-docstring,
|
||||||
|
missing-module-docstring,
|
||||||
|
invalid-name,
|
||||||
|
cyclic-import,
|
||||||
|
too-many-arguments,
|
||||||
|
too-many-locals,
|
||||||
|
too-many-branches,
|
||||||
|
too-many-statements,
|
||||||
|
too-many-instance-attributes,
|
||||||
|
duplicate-code,
|
||||||
|
import-outside-toplevel,
|
||||||
|
too-few-public-methods,
|
||||||
|
unnecessary-ellipsis
|
||||||
|
|
||||||
|
# Enable the message, report, category or checker with the given id(s). You can
|
||||||
|
# either give multiple identifier separated by comma (,) or put this option
|
||||||
|
# multiple time (only on the command line, not in the configuration file where
|
||||||
|
# it should appear only once). See also the "--disable" option for examples.
|
||||||
|
enable=
|
||||||
|
|
||||||
|
|
||||||
|
[METHOD_ARGS]
|
||||||
|
|
||||||
|
# List of qualified names (i.e., library.method) which require a timeout
|
||||||
|
# parameter e.g. 'requests.api.get,requests.api.post'
|
||||||
|
timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
|
||||||
|
|
||||||
|
|
||||||
|
[MISCELLANEOUS]
|
||||||
|
|
||||||
|
# Whether or not to search for fixme's in docstrings.
|
||||||
|
check-fixme-in-docstring=no
|
||||||
|
|
||||||
|
# List of note tags to take in consideration, separated by a comma.
|
||||||
|
notes=FIXME,
|
||||||
|
XXX,
|
||||||
|
TODO
|
||||||
|
|
||||||
|
# Regular expression of note tags to take in consideration.
|
||||||
|
notes-rgx=
|
||||||
|
|
||||||
|
|
||||||
|
[REFACTORING]
|
||||||
|
|
||||||
|
# Maximum number of nested blocks for function / method body
|
||||||
|
max-nested-blocks=5
|
||||||
|
|
||||||
|
# Complete name of functions that never returns. When checking for
|
||||||
|
# inconsistent-return-statements if a never returning function is called then
|
||||||
|
# it will be considered as an explicit return statement and no message will be
|
||||||
|
# printed.
|
||||||
|
never-returning-functions=sys.exit,argparse.parse_error
|
||||||
|
|
||||||
|
# Let 'consider-using-join' be raised when the separator to join on would be
|
||||||
|
# non-empty (resulting in expected fixes of the type: ``"- " + " -
|
||||||
|
# ".join(items)``)
|
||||||
|
suggest-join-with-non-empty-separator=yes
|
||||||
|
|
||||||
|
|
||||||
|
[REPORTS]
|
||||||
|
|
||||||
|
# Python expression which should return a score less than or equal to 10. You
|
||||||
|
# have access to the variables 'fatal', 'error', 'warning', 'refactor',
|
||||||
|
# 'convention', and 'info' which contain the number of messages in each
|
||||||
|
# category, as well as 'statement' which is the total number of statements
|
||||||
|
# analyzed. This score is used by the global evaluation report (RP0004).
|
||||||
|
evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
|
||||||
|
|
||||||
|
# Template used to display messages. This is a python new-style format string
|
||||||
|
# used to format the message information. See doc for all details.
|
||||||
|
msg-template=
|
||||||
|
|
||||||
|
# Set the output format. Available formats are: 'text', 'parseable',
|
||||||
|
# 'colorized', 'json2' (improved json format), 'json' (old json format), msvs
|
||||||
|
# (visual studio) and 'github' (GitHub actions). You can also give a reporter
|
||||||
|
# class, e.g. mypackage.mymodule.MyReporterClass.
|
||||||
|
#output-format=
|
||||||
|
|
||||||
|
# Tells whether to display a full report or only the messages.
|
||||||
|
reports=no
|
||||||
|
|
||||||
|
# Activate the evaluation score.
|
||||||
|
score=yes
|
||||||
|
|
||||||
|
|
||||||
|
[SIMILARITIES]
|
||||||
|
|
||||||
|
# Comments are removed from the similarity computation
|
||||||
|
ignore-comments=yes
|
||||||
|
|
||||||
|
# Docstrings are removed from the similarity computation
|
||||||
|
ignore-docstrings=yes
|
||||||
|
|
||||||
|
# Imports are removed from the similarity computation
|
||||||
|
ignore-imports=yes
|
||||||
|
|
||||||
|
# Signatures are removed from the similarity computation
|
||||||
|
ignore-signatures=yes
|
||||||
|
|
||||||
|
# Minimum lines number of a similarity.
|
||||||
|
min-similarity-lines=4
|
||||||
|
|
||||||
|
|
||||||
|
[SPELLING]
|
||||||
|
|
||||||
|
# Limits count of emitted suggestions for spelling mistakes.
|
||||||
|
max-spelling-suggestions=4
|
||||||
|
|
||||||
|
# Spelling dictionary name. No available dictionaries : You need to install
|
||||||
|
# both the python package and the system dependency for enchant to work.
|
||||||
|
spelling-dict=
|
||||||
|
|
||||||
|
# List of comma separated words that should be considered directives if they
|
||||||
|
# appear at the beginning of a comment and should not be checked.
|
||||||
|
spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
|
||||||
|
|
||||||
|
# List of comma separated words that should not be checked.
|
||||||
|
spelling-ignore-words=
|
||||||
|
|
||||||
|
# A path to a file that contains the private dictionary; one word per line.
|
||||||
|
spelling-private-dict-file=
|
||||||
|
|
||||||
|
# Tells whether to store unknown words to the private dictionary (see the
|
||||||
|
# --spelling-private-dict-file option) instead of raising a message.
|
||||||
|
spelling-store-unknown-words=no
|
||||||
|
|
||||||
|
|
||||||
|
[STRING]
|
||||||
|
|
||||||
|
# This flag controls whether inconsistent-quotes generates a warning when the
|
||||||
|
# character used as a quote delimiter is used inconsistently within a module.
|
||||||
|
check-quote-consistency=no
|
||||||
|
|
||||||
|
# This flag controls whether the implicit-str-concat should generate a warning
|
||||||
|
# on implicit string concatenation in sequences defined over several lines.
|
||||||
|
check-str-concat-over-line-jumps=no
|
||||||
|
|
||||||
|
|
||||||
|
[TYPECHECK]
|
||||||
|
|
||||||
|
# List of decorators that produce context managers, such as
|
||||||
|
# contextlib.contextmanager. Add to this list to register other decorators that
|
||||||
|
# produce valid context managers.
|
||||||
|
contextmanager-decorators=contextlib.contextmanager
|
||||||
|
|
||||||
|
# List of members which are set dynamically and missed by pylint inference
|
||||||
|
# system, and so shouldn't trigger E1101 when accessed. Python regular
|
||||||
|
# expressions are accepted.
|
||||||
|
generated-members=
|
||||||
|
|
||||||
|
# Tells whether to warn about missing members when the owner of the attribute
|
||||||
|
# is inferred to be None.
|
||||||
|
ignore-none=yes
|
||||||
|
|
||||||
|
# This flag controls whether pylint should warn about no-member and similar
|
||||||
|
# checks whenever an opaque object is returned when inferring. The inference
|
||||||
|
# can return multiple potential results while evaluating a Python object, but
|
||||||
|
# some branches might not be evaluated, which results in partial inference. In
|
||||||
|
# that case, it might be useful to still emit no-member and other checks for
|
||||||
|
# the rest of the inferred objects.
|
||||||
|
ignore-on-opaque-inference=yes
|
||||||
|
|
||||||
|
# List of symbolic message names to ignore for Mixin members.
|
||||||
|
ignored-checks-for-mixins=no-member,
|
||||||
|
not-async-context-manager,
|
||||||
|
not-context-manager,
|
||||||
|
attribute-defined-outside-init
|
||||||
|
|
||||||
|
# List of class names for which member attributes should not be checked (useful
|
||||||
|
# for classes with dynamically set attributes). This supports the use of
|
||||||
|
# qualified names.
|
||||||
|
ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
|
||||||
|
|
||||||
|
# Show a hint with possible names when a member name was not found. The aspect
|
||||||
|
# of finding the hint is based on edit distance.
|
||||||
|
missing-member-hint=yes
|
||||||
|
|
||||||
|
# The maximum edit distance a name should have in order to be considered a
|
||||||
|
# similar match for a missing member name.
|
||||||
|
missing-member-hint-distance=1
|
||||||
|
|
||||||
|
# The total number of similar names that should be taken in consideration when
|
||||||
|
# showing a hint for a missing member.
|
||||||
|
missing-member-max-choices=1
|
||||||
|
|
||||||
|
# Regex pattern to define which classes are considered mixins.
|
||||||
|
mixin-class-rgx=.*[Mm]ixin
|
||||||
|
|
||||||
|
# List of decorators that change the signature of a decorated function.
|
||||||
|
signature-mutators=
|
||||||
|
|
||||||
|
|
||||||
|
[VARIABLES]
|
||||||
|
|
||||||
|
# List of additional names supposed to be defined in builtins. Remember that
|
||||||
|
# you should avoid defining new builtins when possible.
|
||||||
|
additional-builtins=
|
||||||
|
|
||||||
|
# Tells whether unused global variables should be treated as a violation.
|
||||||
|
allow-global-unused-variables=yes
|
||||||
|
|
||||||
|
# List of names allowed to shadow builtins
|
||||||
|
allowed-redefined-builtins=
|
||||||
|
|
||||||
|
# List of strings which can identify a callback function by name. A callback
|
||||||
|
# name must start or end with one of those strings.
|
||||||
|
callbacks=cb_,
|
||||||
|
_cb
|
||||||
|
|
||||||
|
# A regular expression matching the name of dummy variables (i.e. expected to
|
||||||
|
# not be used).
|
||||||
|
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
|
||||||
|
|
||||||
|
# Argument names that match this expression will be ignored.
|
||||||
|
ignored-argument-names=_.*|^ignored_|^unused_
|
||||||
|
|
||||||
|
# Tells whether we should check for unused import in __init__ files.
|
||||||
|
init-import=no
|
||||||
|
|
||||||
|
# List of qualified module names which can have objects that can redefine
|
||||||
|
# builtins.
|
||||||
|
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
# bot-bottle
|
||||||
|
|
||||||
|
## What this is
|
||||||
|
|
||||||
|
bot-bottle spins up an isolated backend runtime for running AI coding agents
|
||||||
|
with a curated set of skills and env vars. The point is to run agents with
|
||||||
|
broad permissions inside a sandbox, so a misbehaving agent cannot reach the
|
||||||
|
host. A Python CLI (entry point `cli.py`, package `bot_bottle/`) orchestrates
|
||||||
|
the runtime lifecycle and the copying of skills and env vars into it.
|
||||||
|
The default backend on compatible macOS hosts is macos-container:
|
||||||
|
agents and sidecar bundles run through Apple's `container` CLI without
|
||||||
|
requiring Docker. The smolmachines backend remains available with
|
||||||
|
`BOT_BOTTLE_BACKEND=smolmachines` or `--backend=smolmachines`; agents
|
||||||
|
run in a libkrun micro-VM, while the sidecar bundle still uses Docker.
|
||||||
|
The legacy Docker backend remains available with `BOT_BOTTLE_BACKEND=docker`
|
||||||
|
or `--backend=docker`.
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
- Minimize risk of running agents with full permissions
|
||||||
|
- Allow me to easily spin up agent tasks in parallel
|
||||||
|
- Create isolated, well defined, easily updated, shareable agents
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Communicating between agents directly
|
||||||
|
- Removing the Docker backend
|
||||||
|
- Advanced agent auditing (lean on git history for auditing)
|
||||||
|
|
||||||
|
## Repository layout
|
||||||
|
|
||||||
|
- `README.md` — short public-facing description.
|
||||||
|
- `AGENTS.md` — this file, orientation for future agent sessions.
|
||||||
|
- `.gitignore` — OS junk.
|
||||||
|
- `.bot-bottle/` — per-repo agent and bottle manifests (YAML markdown format).
|
||||||
|
- `examples/` — example bottles and agents showing the manifest format.
|
||||||
|
- `docs/README.md` — docs overview; when to write which document.
|
||||||
|
- `docs/prds/` — product requirement docs (see `docs/prds/README.md` for format).
|
||||||
|
- `docs/research/` — research notes (see `docs/research/README.md`).
|
||||||
|
- `docs/decisions/` — decision records (ADR-lite).
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Three kinds of doc, each with its own conventions in-folder; see
|
||||||
|
`docs/README.md` for when to write which:
|
||||||
|
- **PRDs** (`docs/prds/`) — one feature per file. While a PR is open
|
||||||
|
the file is named `prd-new-<kebab>.md`; CI assigns a sequential
|
||||||
|
number on merge to `main` and renames it. A `Status:` line tracks
|
||||||
|
lifecycle: Draft → Active (shipped to `main`) →
|
||||||
|
Superseded/Retargeted. Format in `docs/prds/README.md`.
|
||||||
|
- **Research notes** (`docs/research/`) — opinionated investigations;
|
||||||
|
unnumbered kebab-case, freeform and verdict-first. See
|
||||||
|
`docs/research/README.md`.
|
||||||
|
- **Decision records** (`docs/decisions/`) — ADR-lite, numbered
|
||||||
|
`NNNN-kebab.md`, for policies and non-feature decisions. See
|
||||||
|
`docs/decisions/README.md`.
|
||||||
|
- Keep decision rationale self-contained in the repo, not in Gitea
|
||||||
|
issue threads. Issues are an ephemeral inbox; the durable "why" lives
|
||||||
|
in a PRD, research note, or decision record.
|
||||||
|
- Low dependencies by default. The project is Python, stdlib-first (no
|
||||||
|
runtime pip dependencies in the package itself; the only language
|
||||||
|
runtime is the Python 3.13 used by the CLI + sidecars). Ask before
|
||||||
|
adding new tools, runtimes, or package managers.
|
||||||
|
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
|
||||||
|
`<type>[(scope)][!]: <description>`, where `<type>` is one of `feat`, `fix`,
|
||||||
|
`docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
|
||||||
|
A `commit-msg` hook in `.githooks/` enforces this. Activate it once per clone
|
||||||
|
with `git config core.hooksPath .githooks`.
|
||||||
|
|
||||||
|
## When you're unsure
|
||||||
|
|
||||||
|
Ask. Default to drafting in chat over editing files when the request is ambiguous.
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# claude-bottle
|
|
||||||
|
|
||||||
## What this is
|
|
||||||
|
|
||||||
claude-bottle spins up an isolated container for running Claude Code with a
|
|
||||||
curated set of skills and env vars. The point is to run Claude with broad
|
|
||||||
permissions inside a sandbox, so a misbehaving agent cannot reach the host.
|
|
||||||
A Python CLI (entry point `cli.py`, package `claude_bottle/`) orchestrates
|
|
||||||
the container lifecycle and the copying of skills and env vars into it.
|
|
||||||
|
|
||||||
## Goals
|
|
||||||
|
|
||||||
- Minimize risk of running claude with full permissions
|
|
||||||
- Allow me to easily spin up agent tasks in parallel
|
|
||||||
- Create isolated, well defined, easily updated, shareable agents
|
|
||||||
|
|
||||||
## Non-goals
|
|
||||||
|
|
||||||
- Communicating between agents directly
|
|
||||||
- Self hosted VMs (v1 uses local Docker containers, not VMs)
|
|
||||||
- Advanced agent auditing (lean on git history for auditing)
|
|
||||||
|
|
||||||
## Repository layout
|
|
||||||
|
|
||||||
- `README.md` — short public-facing description.
|
|
||||||
- `CLAUDE.md` — this file, orientation for future Claude sessions.
|
|
||||||
- `.gitignore` — OS junk.
|
|
||||||
- `claude-bottle.json` — manifest of named agents (env / skills / prompt
|
|
||||||
per agent), consumed by `cli.py`. See "Manifest" under
|
|
||||||
"Intended design".
|
|
||||||
- `docs/INDEX.md` — pointer to the research notes.
|
|
||||||
- `docs/prds/` — product requirement docs.
|
|
||||||
- `docs/research/` — research notes (empty for now, kept tracked via `.gitkeep`).
|
|
||||||
|
|
||||||
## Conventions
|
|
||||||
|
|
||||||
- Product requirement docs live in `docs/prds/`.
|
|
||||||
- Research notes live in `docs/research/`.
|
|
||||||
- Low dependencies by default. The project is Python, stdlib-first (no
|
|
||||||
runtime pip dependencies in the package itself; the only language
|
|
||||||
runtime is the Python 3.13 used by the CLI + sidecars). Ask before
|
|
||||||
adding new tools, runtimes, or package managers.
|
|
||||||
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
|
|
||||||
`<type>[(scope)][!]: <description>`, where `<type>` is one of `feat`, `fix`,
|
|
||||||
`docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
|
|
||||||
A `commit-msg` hook in `.githooks/` enforces this. Activate it once per clone
|
|
||||||
with `git config core.hooksPath .githooks`.
|
|
||||||
|
|
||||||
## When you're unsure
|
|
||||||
|
|
||||||
Ask. Default to drafting in chat over editing files when the request is ambiguous.
|
|
||||||
+22
-34
@@ -1,23 +1,18 @@
|
|||||||
# Per-bottle sidecar bundle image (PRD 0024).
|
# Per-bottle sidecar bundle image (PRD 0024).
|
||||||
#
|
#
|
||||||
# Collapses the four prior per-sidecar images (pipelock, egress,
|
# Collapses the prior per-sidecar images (egress, git-gate,
|
||||||
# git-gate, supervise) into one. A small stdlib-Python init
|
# supervise) into one. A small stdlib-Python init supervisor at
|
||||||
# supervisor at /app/sidecar_init.py spawns all four daemons,
|
# /app/sidecar_init.py spawns all daemons, forwards SIGTERM, and
|
||||||
# forwards SIGTERM, and propagates per-daemon stdout/stderr to the
|
# propagates per-daemon stdout/stderr to the container log with a
|
||||||
# container log with a `[name]` prefix. See PRD 0024 for the
|
# `[name]` prefix. See PRD 0024 for the rationale.
|
||||||
# rationale.
|
|
||||||
#
|
#
|
||||||
# Layout (preserved verbatim from the prior four Dockerfiles so the
|
# Layout:
|
||||||
# compose renderer's bind-mount paths and docker-cp targets keep
|
|
||||||
# working):
|
|
||||||
#
|
#
|
||||||
# /usr/local/bin/pipelock pipelock binary
|
|
||||||
# /usr/bin/gitleaks gitleaks binary
|
# /usr/bin/gitleaks gitleaks binary
|
||||||
# /app/egress_addon.py + siblings mitmproxy addon (egress)
|
# /app/egress_addon.py + siblings mitmproxy addon (egress)
|
||||||
# /app/egress-entrypoint.sh mitmdump launcher
|
# /app/egress-entrypoint.sh mitmdump launcher
|
||||||
# /app/supervise_server.py + .py supervise MCP server
|
# /app/supervise_server.py + .py supervise MCP server
|
||||||
# /app/sidecar_init.py PID 1 supervisor
|
# /app/sidecar_init.py PID 1 supervisor
|
||||||
# /etc/pipelock.yaml bind-mounted at run time
|
|
||||||
# /etc/egress/routes.yaml bind-mounted at run time
|
# /etc/egress/routes.yaml bind-mounted at run time
|
||||||
# /etc/git-gate/pre-receive docker-cp'd at start time
|
# /etc/git-gate/pre-receive docker-cp'd at start time
|
||||||
# /git-gate-entrypoint.sh docker-cp'd at start time
|
# /git-gate-entrypoint.sh docker-cp'd at start time
|
||||||
@@ -27,24 +22,17 @@
|
|||||||
# /home/mitmproxy/.mitmproxy/ mitmproxy CA dir
|
# /home/mitmproxy/.mitmproxy/ mitmproxy CA dir
|
||||||
#
|
#
|
||||||
# Exposed ports inside the container:
|
# Exposed ports inside the container:
|
||||||
# 8888 pipelock (HTTPS_PROXY)
|
# 9099 egress (mitmproxy, agent-facing HTTPS proxy)
|
||||||
# 9099 egress (mitmproxy, pipelock's upstream — not externally
|
|
||||||
# addressed by the agent)
|
|
||||||
# 9418 git-gate (git-daemon)
|
# 9418 git-gate (git-daemon)
|
||||||
|
# 9420 git-gate smart HTTP (smolmachines agent-facing transport)
|
||||||
# 9100 supervise (MCP HTTP)
|
# 9100 supervise (MCP HTTP)
|
||||||
|
|
||||||
# Stage 1: pipelock binary. The upstream pipelock image is a
|
# Stage 1: gitleaks binary. The upstream gitleaks image is alpine
|
||||||
# scratch image with the binary at /pipelock (entrypoint).
|
|
||||||
# Pinned by digest in lockstep with
|
|
||||||
# claude_bottle/backend/docker/pipelock.py:PIPELOCK_IMAGE.
|
|
||||||
FROM ghcr.io/luckypipewrench/pipelock@sha256:3b1a39417b98406ddc5dc2d8fcb42865ddc0c68a43d355db55f0f8cb06bc6de9 AS pipelock-src
|
|
||||||
|
|
||||||
# Stage 2: gitleaks binary. The upstream gitleaks image is alpine
|
|
||||||
# with the binary at /usr/bin/gitleaks. Pinned by digest in lockstep
|
# with the binary at /usr/bin/gitleaks. Pinned by digest in lockstep
|
||||||
# with Dockerfile.git-gate's prior base (now deleted at chunk 3).
|
# with Dockerfile.git-gate's prior base (now deleted at chunk 3).
|
||||||
FROM zricethezav/gitleaks@sha256:c00b6bd0aeb3071cbcb79009cb16a60dd9e0a7c60e2be9ab65d25e6bc8abbb7f AS gitleaks-src
|
FROM zricethezav/gitleaks@sha256:c00b6bd0aeb3071cbcb79009cb16a60dd9e0a7c60e2be9ab65d25e6bc8abbb7f AS gitleaks-src
|
||||||
|
|
||||||
# Stage 3: assembly. mitmproxy/mitmproxy is debian-slim-based with
|
# Stage 2: assembly. mitmproxy/mitmproxy is debian-slim-based with
|
||||||
# Python + mitmdump pre-installed — heavier than the others, so
|
# Python + mitmdump pre-installed — heavier than the others, so
|
||||||
# this stage starts there and pulls the standalone binaries in.
|
# this stage starts there and pulls the standalone binaries in.
|
||||||
FROM mitmproxy/mitmproxy:11.1.3
|
FROM mitmproxy/mitmproxy:11.1.3
|
||||||
@@ -59,29 +47,29 @@ USER root
|
|||||||
# plus the core `git` binary the pre-receive hook invokes.
|
# plus the core `git` binary the pre-receive hook invokes.
|
||||||
# openssh-client supplies the upstream SSH transport the
|
# openssh-client supplies the upstream SSH transport the
|
||||||
# pre-receive hook uses to forward accepted refs.
|
# pre-receive hook uses to forward accepted refs.
|
||||||
# ca-certificates is needed for both pipelock and mitmdump
|
# ca-certificates is needed for mitmdump upstream TLS (the
|
||||||
# upstream TLS (the base image already has it; listed for
|
# base image already has it; listed for explicitness).
|
||||||
# explicitness).
|
|
||||||
RUN apt-get update \
|
RUN apt-get update \
|
||||||
&& apt-get install -y --no-install-recommends \
|
&& apt-get install -y --no-install-recommends \
|
||||||
git openssh-client ca-certificates \
|
git openssh-client ca-certificates \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
# Pull the standalone binaries into the final image.
|
# Pull the standalone binaries into the final image.
|
||||||
COPY --from=pipelock-src /pipelock /usr/local/bin/pipelock
|
|
||||||
COPY --from=gitleaks-src /usr/bin/gitleaks /usr/bin/gitleaks
|
COPY --from=gitleaks-src /usr/bin/gitleaks /usr/bin/gitleaks
|
||||||
|
|
||||||
# Project Python: addon + server modules + the init supervisor.
|
# Project Python: addon + server modules + the init supervisor.
|
||||||
# Kept flat under /app/ so mitmdump's loader resolves them as
|
# Kept flat under /app/ so mitmdump's loader resolves them as
|
||||||
# top-level siblings (absolute imports), matching the prior
|
# top-level siblings (absolute imports), matching the prior
|
||||||
# Dockerfile.egress / Dockerfile.supervise layout.
|
# Dockerfile.egress / Dockerfile.supervise layout.
|
||||||
COPY claude_bottle/egress_addon_core.py /app/egress_addon_core.py
|
COPY bot_bottle/egress_addon_core.py /app/egress_addon_core.py
|
||||||
COPY claude_bottle/egress_addon.py /app/egress_addon.py
|
COPY bot_bottle/egress_addon.py /app/egress_addon.py
|
||||||
COPY claude_bottle/yaml_subset.py /app/yaml_subset.py
|
COPY bot_bottle/dlp_detectors.py /app/dlp_detectors.py
|
||||||
COPY claude_bottle/supervise.py /app/supervise.py
|
COPY bot_bottle/yaml_subset.py /app/yaml_subset.py
|
||||||
COPY claude_bottle/supervise_server.py /app/supervise_server.py
|
COPY bot_bottle/supervise.py /app/supervise.py
|
||||||
COPY claude_bottle/sidecar_init.py /app/sidecar_init.py
|
COPY bot_bottle/supervise_server.py /app/supervise_server.py
|
||||||
COPY claude_bottle/egress_entrypoint.sh /app/egress-entrypoint.sh
|
COPY bot_bottle/sidecar_init.py /app/sidecar_init.py
|
||||||
|
COPY bot_bottle/git_http_backend.py /app/git_http_backend.py
|
||||||
|
COPY bot_bottle/egress_entrypoint.sh /app/egress-entrypoint.sh
|
||||||
RUN chmod +x /app/egress-entrypoint.sh
|
RUN chmod +x /app/egress-entrypoint.sh
|
||||||
|
|
||||||
# Pre-create runtime directories the compose renderer + start
|
# Pre-create runtime directories the compose renderer + start
|
||||||
@@ -97,7 +85,7 @@ RUN mkdir -p \
|
|||||||
|
|
||||||
# Documentation only — the compose renderer publishes whichever
|
# Documentation only — the compose renderer publishes whichever
|
||||||
# subset the bottle uses.
|
# subset the bottle uses.
|
||||||
EXPOSE 8888 9099 9418 9100
|
EXPOSE 8888 9099 9418 9420 9100
|
||||||
|
|
||||||
# WORKDIR matches Dockerfile.supervise's prior layout so the
|
# WORKDIR matches Dockerfile.supervise's prior layout so the
|
||||||
# in-app same-dir import in supervise_server.py stays deterministic.
|
# in-app same-dir import in supervise_server.py stays deterministic.
|
||||||
|
|||||||
@@ -1,90 +1,41 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="docs/logo.svg" alt="claude-bottle logo" width="140">
|
<img src="docs/logo.svg" alt="bot-bottle logo" width="140">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# claude-bottle
|
# bot-bottle
|
||||||
|
|
||||||
[](https://gitea.dideric.is/didericis/claude-bottle/actions?workflow=test.yml)
|
[](https://gitea.dideric.is/didericis/bot-bottle/actions?workflow=test.yml)
|
||||||
|
[](https://github.com/PyCQA/pylint)
|
||||||
|
[](https://github.com/microsoft/pyright)
|
||||||
|
|
||||||
Run multiple Claude Code agents on your own machine, each scoped to its own secrets, skills, and egress allowlist.
|
**Problem:** Developer wants to run a coding agent without supervision, but they don't want a prompt injected or misbehaving agent wrecking their environment or exfiltrating sensitive data.
|
||||||
|
|
||||||

|
**Solution:** Ephemeral, per agent "bottles" the agent cannot modify that scan all traffic for data exfiltration and limit capabilities and egress to only what the agent needs.
|
||||||
|
|
||||||
Four prompts to the agent inside a real bottle:
|
## Features
|
||||||
claude replies to `hello there` — proof api.anthropic.com routes
|
|
||||||
through pipelock's bumped TLS end-to-end;
|
|
||||||
asked to GET a non-allowlisted host, the agent's curl gets 403 back
|
|
||||||
from pipelock;
|
|
||||||
asked to POST a credential-shaped body to an allowlisted host, the
|
|
||||||
same 403 — pipelock's DLP body scanner caught it;
|
|
||||||
asked to commit and push an AKIA-shaped key, git-gate's gitleaks
|
|
||||||
pre-receive hook rejects the ref.
|
|
||||||
Run it yourself with `bash scripts/demo.sh`.
|
|
||||||
|
|
||||||
## Why "claude-bottle"?
|
- **Per-bottle egress allowlist** — TLS-bumped HTTP/HTTPS chokepoint with a per-manifest host allowlist; per-route path/method/header `matches` filtering; outbound DLP scanning for known tokens and secrets, inbound DLP scanning for prompt-injection attempts; DoH and arbitrary hosts blocked by default.
|
||||||
|
- **Tokens the agent never sees** — host secrets live in a sidecar; the agent dials `http://sidecar:9099/<path>` and the proxy strips inbound `Authorization` and injects the real token before forwarding. `printenv` in the agent shows proxy URLs only.
|
||||||
Each container is a bottle; Claude is the genie inside. The genie's
|
- **Gitleaks-scanned push (git-gate)** — `bottle.git` remotes route through a per-bottle `git daemon` that gitleaks-scans incoming refs pre-receive and forwards clean refs upstream over SSH. The agent never holds the upstream credential.
|
||||||
powers are exactly what the manifest grants it — a specific set of
|
- **Manifest-scoped skills + secrets** — each bottle declares its skills, env, git identity, remotes, and egress routes; unknown keys die at load.
|
||||||
skills, a specific set of secrets, and a specific set of hosts it can
|
- **Trust boundary at `$HOME`** — bottles (credentials, egress, remotes) live only under `~/.bot-bottle/bottles/`. Repos may ship agents but not bottles, so a cloned repo can't redirect an env var to an attacker host.
|
||||||
reach — nothing more. You uncork one bottle per agent
|
- **Composable bottles (`extends:`)** — keep provider/runtime policy in one base bottle (e.g. `claude.md`) and overlay task bottles on top.
|
||||||
(`./cli.py start <agent>`), many bottles run in parallel, and each is
|
- **Parallel, isolated bottles** — each bottle runs in its own backend-owned isolation boundary; bottles don't share state or talk to each other.
|
||||||
scoped to its task. When the session ends the bottle is destroyed and
|
- **Provider templates (Claude, Codex)** — `Dockerfile.claude` / `Dockerfile.codex`, or a bottle-supplied Dockerfile. Claude auth via long-lived OAuth token; Codex via opt-in host device-auth forwarding.
|
||||||
the genie does not persist.
|
- **gVisor auto-detect** — on Linux hosts where `runsc` is registered with Docker, every bottle launches under it for a userspace syscall barrier; no manifest config required.
|
||||||
|
- **Apple Container backend (macOS default when available)** — runs the agent and sidecar bundle with Apple's `container` CLI, using a host-only agent network plus a separate sidecar egress network.
|
||||||
## Goals
|
- **Smolmachines backend** — runs the agent in a libkrun micro-VM while the sidecar bundle stays in Docker. TSI and smolmachines DNS filtering close the raw DNS exfiltration gap that exists in the legacy Docker backend.
|
||||||
|
- **Legacy Docker backend** — still available for examples, CI, and hosts without Apple Container via `BOT_BOTTLE_BACKEND=docker` or `--backend=docker`.
|
||||||
- Scope each agent to the minimum credentials and network egress its task actually needs
|
|
||||||
- Run multiple agents in parallel, isolated from each other
|
|
||||||
- Keep code, credentials, and agent activity on infrastructure I control — no third-party agent runtime
|
|
||||||
|
|
||||||
## Security model
|
|
||||||
|
|
||||||
Each agent runs in its own bottle: its own container, its own internal
|
|
||||||
Docker network, and its own pipelock sidecar. Bottles don't share
|
|
||||||
state, don't talk to each other, and only get the env vars, skills,
|
|
||||||
SSH identities, and egress hosts the manifest grants them — nothing
|
|
||||||
more. Any one agent only has the access it needs to do its job.
|
|
||||||
|
|
||||||
The bottle limits both what an agent can see and where it can send
|
|
||||||
it. Each bottle gets only the secrets and SSH identities the manifest
|
|
||||||
grants it — a Gitea token but not a GitHub token, a deploy key but
|
|
||||||
not a personal SSH key — so even a compromised or misbehaving agent
|
|
||||||
only handles credentials it was already trusted with for its job.
|
|
||||||
Egress flows through pipelock, which constrains where those
|
|
||||||
credentials can travel: an agent with a Gitea token can reach
|
|
||||||
`gitea.dideric.is`, not arbitrary attacker-controlled hosts. The same
|
|
||||||
constraint blocks DNS-over-HTTPS as an exfil channel — a DoH resolver
|
|
||||||
like `cloudflare-dns.com` would have to be on the allowlist for the
|
|
||||||
agent to reach it at all. The container itself adds a layer between
|
|
||||||
the agent and the host, but the v1 design leans more on secret
|
|
||||||
minimization and egress allowlisting than on the container as a
|
|
||||||
hardened boundary. On Linux hosts where [gVisor](https://gvisor.dev/)
|
|
||||||
is registered with Docker, claude-bottle auto-detects it and launches
|
|
||||||
every bottle under `runsc` for a userspace syscall barrier — no
|
|
||||||
manifest configuration required. The broader v2 discussion lives in
|
|
||||||
`docs/research/stronger-isolation-alternatives.md`.
|
|
||||||
|
|
||||||
The egress proxy and OAuth-token handling below are the load-bearing
|
|
||||||
pieces of v1.
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
A bottle is two containers per agent: an `agent` container, and a
|
On the default macOS Apple Container backend, a bottle is an agent container on a host-only internal network plus a sidecar bundle attached to both that internal network and a NAT egress network. The agent gets HTTP(S)_PROXY and CA bundle env vars pointing at the sidecar's internal-network IP, so HTTP/HTTPS traffic flows through the sidecar instead of direct egress. `bottle.git` / git-gate is intentionally deferred on this backend until a safe Apple Container key-delivery path exists.
|
||||||
`sidecars` container that bundles pipelock + egress + git-gate +
|
|
||||||
supervise behind a Python init supervisor (PRD 0024). They share a
|
|
||||||
per-agent Docker `--internal` network; the agent has no default
|
|
||||||
route off-box. All HTTP and HTTPS egress funnels through pipelock,
|
|
||||||
where the egress allowlist, TLS interception, and request-body DLP
|
|
||||||
scanner enforce the manifest before any byte leaves the host. The
|
|
||||||
only egress that doesn't traverse pipelock is git-gate's SSH
|
|
||||||
push/fetch to `bottle.git` upstreams — pipelock can't proxy SSH,
|
|
||||||
so git-gate is its own L4-style egress path with gitleaks doing
|
|
||||||
the pre-receive scan.
|
|
||||||
|
|
||||||
The agent dials the bundle by the legacy short names (`pipelock`,
|
On the smolmachines backend, a bottle is an agent micro-VM plus a Docker sidecar bundle for egress, git-gate, and supervise. The VM reaches the sidecars through a per-bottle loopback alias allowed by TSI; smolmachines handles DNS filtering below the guest OS.
|
||||||
`egress`, `git-gate`, `supervise`); the renderer registers those as
|
|
||||||
docker-network aliases on the bundle so existing HTTPS_PROXY URLs
|
On the legacy Docker backend, the same logical bottle is two containers per agent: an `agent` container and a `sidecars` container. They share a per-agent Docker `--internal` network; the agent has no default route off-box.
|
||||||
and MCP endpoints resolve without an agent-side change.
|
|
||||||
|
The Docker topology looks like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
host ( ./cli.py )
|
host ( ./cli.py )
|
||||||
@@ -93,225 +44,84 @@ and MCP endpoints resolve without an agent-side change.
|
|||||||
▼
|
▼
|
||||||
┌─────────────────────────── bottle ──────────────────────────────────┐
|
┌─────────────────────────── bottle ──────────────────────────────────┐
|
||||||
│ │
|
│ │
|
||||||
│ ┌──────────────────┐ │
|
│ ┌──────────────────┐ ┌──────────────────────┐ │
|
||||||
│ │ agent image │ HTTPS_PROXY │
|
│ │ agent image │ HTTP(S) proxy │ egress image │ │
|
||||||
│ │ (claude-code, │ ────────────────────────┐ │
|
│ │ (claude-code, │ ─────────────────►│ (mitmproxy; TLS bump │ │ HTTPS to
|
||||||
│ │ built locally) │ │ │
|
│ │ codex, etc) │ │ DLP scan, path │───┼──► allowlisted
|
||||||
│ │ │ plain HTTP │ │
|
│ │ │ │ matching, auth │ │ hosts
|
||||||
│ │ skills, env, │ (token injection) ┌────▼─────────┐ │
|
│ │ environ: proxy │ │ injection) │ │
|
||||||
│ │ ~/.gitconfig, │ ──────────────────►│ cred-proxy │ │
|
│ │ URLs only, no │ └──────────────────────┘ │
|
||||||
│ │ ~/.npmrc, tea │ │ (strips/inj │ │
|
│ │ real tokens │ │
|
||||||
│ │ │ │ Authoriz.) │ │
|
│ │ │ git proxy ┌────────────────┐ │ SSH push/fetch
|
||||||
│ │ environ: URLs │ └─────┬────────┘ │
|
|
||||||
│ │ only, no real │ HTTPS_PROXY │ │
|
|
||||||
│ │ tokens │ ▼ │
|
|
||||||
│ │ │ ┌────────────────┐ │ HTTPS to
|
|
||||||
│ │ │ │ pipelock image │──────────┼──► allowlisted
|
|
||||||
│ │ │ │ (TLS bump, DLP │ │ hosts (incl.
|
|
||||||
│ │ │ │ body scan, │ │ cred-proxy
|
|
||||||
│ │ │ │ allowlist) │ │ upstreams)
|
|
||||||
│ │ │ └────────────────┘ │
|
|
||||||
│ │ │ │
|
|
||||||
│ │ │ git:// ┌────────────────┐ │ SSH push/fetch
|
|
||||||
│ │ │ ────────────────►│ git-gate image │──────────┼──► to bottle.git
|
│ │ │ ────────────────►│ git-gate image │──────────┼──► to bottle.git
|
||||||
│ │ │ │ (gitleaks + │ │ upstreams
|
│ │ │ │ (gitleaks + │ │ upstreams
|
||||||
│ └──────────────────┘ │ git daemon) │ │ (direct — not
|
│ └──────────────────┘ │ git daemon) │ │ (direct — not
|
||||||
│ └────────────────┘ │ via pipelock)
|
│ └────────────────┘ │ via egress)
|
||||||
│ │
|
│ │
|
||||||
│ agent on internal network (no default route); pipelock, │
|
│ agent on internal network (no default route); egress and │
|
||||||
│ cred-proxy, and git-gate straddle internal + egress networks. │
|
│ git-gate straddle internal + egress networks. │
|
||||||
│ pipelock is the single HTTP/HTTPS chokepoint — cred-proxy's │
|
│ egress is the single HTTP/HTTPS chokepoint — all agent HTTP/HTTPS │
|
||||||
│ outbound traverses it too. git-gate's SSH egress is direct │
|
│ traffic flows through it. git-gate's SSH egress is direct │
|
||||||
│ because pipelock is HTTP-only. │
|
│ because egress is HTTP-only. │
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
└─────────────────────────────────────────────────────────────────────┘
|
||||||
```
|
```
|
||||||
|
|
||||||
- **agent image** — built from the repo `Dockerfile` (`node:22-slim`
|
When the agent exits, `cli.py` tears down every sidecar and both networks; nothing about a bottle persists between runs.
|
||||||
base) on first run; runs `claude` with the manifest-granted skills,
|
|
||||||
env vars, and `~/.gitconfig` (the latter for the git-gate's
|
|
||||||
`insteadOf` rules when `bottle.git` is set).
|
|
||||||
- **pipelock image** — per-agent sidecar. Terminates the agent's
|
|
||||||
outbound HTTP/HTTPS, enforces the resolved allowlist, runs DLP
|
|
||||||
scanning. Design in `docs/prds/0001-per-agent-egress-proxy-via-pipelock.md`
|
|
||||||
and `docs/prds/0006-pipelock-tls-interception.md`.
|
|
||||||
- **git-gate image** — per-agent sidecar built on `zricethezav/gitleaks`
|
|
||||||
(alpine + gitleaks + git-daemon + openssh-client). Runs
|
|
||||||
`git daemon` over `git://` as a bidirectional mirror of each
|
|
||||||
declared upstream. A pre-receive hook gitleaks-scans incoming
|
|
||||||
refs and forwards clean refs to the real upstream over SSH; an
|
|
||||||
access-hook runs `git fetch origin --prune` against the upstream
|
|
||||||
before every upload-pack so an agent fetch returns whatever the
|
|
||||||
upstream has *now* (fail-closed if unreachable). The agent's
|
|
||||||
`~/.gitconfig` rewrites the real URL to the gate via `insteadOf`,
|
|
||||||
so push, fetch, clone, and pull all route through. The agent
|
|
||||||
never sees the upstream credential. If the upstream's hostname
|
|
||||||
isn't resolvable from the gate container (e.g. a Tailscale-only
|
|
||||||
host whose public DNS points elsewhere), pin its IP via
|
|
||||||
`ExtraHosts: { "<hostname>": "<ip>" }` on the `bottle.git` entry —
|
|
||||||
the gate's `/etc/hosts` gets the override while the agent's
|
|
||||||
`insteadOf` rewrite still keys off the original hostname. Brought
|
|
||||||
up only when `bottle.git` has entries. Design in
|
|
||||||
`docs/prds/0008-git-gate.md`.
|
|
||||||
- **cred-proxy image** — per-bottle sidecar (`python:3.13-alpine`
|
|
||||||
base, stdlib-only) that holds API tokens declared in
|
|
||||||
`bottle.cred_proxy.routes`. Each route names a `path`,
|
|
||||||
`upstream`, `auth_scheme`, and `token_ref` (host env var); the
|
|
||||||
agent dials `http://cred-proxy:9099<path>...` over plain HTTP
|
|
||||||
and the proxy strips any inbound `Authorization`, injects
|
|
||||||
`<auth_scheme> <token>` using the value held only in its own
|
|
||||||
container's environ, and forwards to the real upstream over
|
|
||||||
HTTPS. SSE responses stream back unbuffered. The cred-proxy's
|
|
||||||
outbound HTTPS routes through pipelock (it trusts pipelock's
|
|
||||||
per-bottle CA), so pipelock's egress allowlist + body scanner
|
|
||||||
apply to cred-proxy traffic the same way they apply to direct
|
|
||||||
agent traffic. Smart-HTTP push paths (`/git-receive-pack`,
|
|
||||||
`/info/refs?service=git-receive-pack`) are refused at the
|
|
||||||
proxy — push must go through `bottle.git` / git-gate where
|
|
||||||
gitleaks runs. Optional per-route `role` tags drive agent-side
|
|
||||||
rewrites: `anthropic-base-url`, `npm-registry`, `git-insteadof`,
|
|
||||||
`tea-login`. The agent's `printenv` shows only proxy URLs —
|
|
||||||
none of the real token values. Design in
|
|
||||||
`docs/prds/0010-cred-proxy.md`.
|
|
||||||
|
|
||||||
When the agent exits, `cli.py` tears down every sidecar that was
|
|
||||||
brought up and the two networks; nothing about a bottle persists
|
|
||||||
between runs.
|
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
Requires Docker on the host and a long-lived Claude Code OAuth token in
|
On compatible macOS hosts, the default backend requires Apple's `container` CLI and does not require Docker. The smolmachines backend requires Docker on the host for the sidecar bundle plus smolvm. The legacy Docker backend requires Docker. Claude bottles also need a long-lived Claude Code OAuth token (`claude setup-token`) exported as `BOT_BOTTLE_CLAUDE_OAUTH_TOKEN`.
|
||||||
your shell env.
|
|
||||||
|
Use `BOT_BOTTLE_BACKEND=docker ./cli.py start <agent>` on hosts where Apple Container is not installed and Docker is the desired backend.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./cli.py start <agent> # builds the image on first run, drops you into claude
|
./cli.py start <agent> # builds the image on first run, drops you into claude
|
||||||
```
|
```
|
||||||
|
|
||||||
The container is removed automatically when the session ends. If the script
|
|
||||||
is killed with SIGKILL the exit trap won't fire and the container may be
|
|
||||||
left running; remove it with `docker rm -f <container-name>`.
|
|
||||||
|
|
||||||
### Smolmachines backend (experimental, macOS-only)
|
|
||||||
|
|
||||||
A second backend runs the agent in a smolvm micro-VM (libkrun) with the
|
|
||||||
sidecar bundle still in Docker. Selected via
|
|
||||||
`CLAUDE_BOTTLE_BACKEND=smolmachines ./cli.py start <agent>`. Requires
|
|
||||||
`smolvm` on PATH (`curl -sSL https://smolmachines.com/install.sh | sh`).
|
|
||||||
|
|
||||||
The integration tests run against whichever backend the env var
|
|
||||||
selects and skip cleanly when its prerequisites are missing.
|
|
||||||
|
|
||||||
**One-time sudo on first launch (macOS):** smolmachines bottles
|
|
||||||
each reserve a loopback alias from a pool (`127.0.0.16` ..
|
|
||||||
`127.0.0.31`) and bind their bundle's port-forwards to it; the
|
|
||||||
first `./cli.py start` after each reboot prompts for sudo to add
|
|
||||||
missing aliases via `ifconfig lo0 alias`. Aliases persist until
|
|
||||||
reboot; subsequent launches don't prompt. The agent's TSI
|
|
||||||
allowlist is the alias's `/32`, so each bottle can only reach
|
|
||||||
its own bundle's published ports — not other bottles' ports,
|
|
||||||
not other host loopback services (postgres, dev servers, etc.).
|
|
||||||
|
|
||||||
This enforcement requires a workaround for a smolvm 0.8.0 bug:
|
|
||||||
the CLI's `--allow-cidr` flag is silently dropped when combined
|
|
||||||
with `--from <smolmachine>`. The launcher patches smolvm's
|
|
||||||
persistent state DB
|
|
||||||
(`~/Library/Application Support/smolvm/server/smolvm.db`)
|
|
||||||
directly between `machine create` and `machine start` to set
|
|
||||||
the allowlist. The hack falls away automatically when smolvm
|
|
||||||
honors the flag upstream — see the `loopback_alias` module's
|
|
||||||
docstring for the investigation trail.
|
|
||||||
|
|
||||||
## Manifest
|
## Manifest
|
||||||
|
|
||||||
Bottles and agents live as Markdown files with YAML frontmatter under
|
Bottles and agents are Markdown files with YAML frontmatter under `~/.bot-bottle/`. The Markdown body is the system prompt. Bottles live in `~/.bot-bottle/bottles/`; agents may also be shipped by a repo at `<repo>/.bot-bottle/agents/<name>.md`.
|
||||||
`~/.claude-bottle/`. Each bottle is one file in `bottles/`, each agent
|
|
||||||
is one file in `agents/`:
|
|
||||||
|
|
||||||
```
|
**Bottle** (`~/.bot-bottle/bottles/gitea-dev.md`):
|
||||||
~/.claude-bottle/
|
|
||||||
├── bottles/
|
|
||||||
│ ├── dev.md
|
|
||||||
│ └── gitea-dev.md
|
|
||||||
└── agents/
|
|
||||||
├── implementer.md
|
|
||||||
└── researcher.md
|
|
||||||
```
|
|
||||||
|
|
||||||
The filename (without `.md`) is the entity's name. Filenames must
|
|
||||||
match `[a-z][a-z0-9-]*`; files that don't are skipped with a warning.
|
|
||||||
|
|
||||||
A repo can ship its own agent files alongside its code at
|
|
||||||
`<repo>/.claude-bottle/agents/<name>.md`. Those agents reference
|
|
||||||
bottles defined in `~/.claude-bottle/bottles/` (the only place
|
|
||||||
bottles can come from); a `bottles/` subdir in a repo is ignored
|
|
||||||
with a warning. **This is the trust boundary**: bottle infrastructure
|
|
||||||
— credentials, egress allowlists, git remotes — comes from your home
|
|
||||||
directory only. A cloned repo cannot redirect a host env var to an
|
|
||||||
attacker-named upstream because it has no way to declare a bottle.
|
|
||||||
|
|
||||||
### Example bottle (`~/.claude-bottle/bottles/gitea-dev.md`)
|
|
||||||
|
|
||||||
````markdown
|
````markdown
|
||||||
---
|
---
|
||||||
|
extends: claude # inherit the Claude provider boundary
|
||||||
|
|
||||||
env:
|
env:
|
||||||
GIT_AUTHOR_NAME: didericis
|
GIT_AUTHOR_NAME: didericis
|
||||||
|
|
||||||
git:
|
git:
|
||||||
- Name: claude-bottle
|
user:
|
||||||
Upstream: ssh://git@gitea.dideric.is:30009/didericis/claude-bottle.git
|
name: "Eric Bauerfeld"
|
||||||
IdentityFile: /Users/didericis/.ssh/id_ed25519_gitea
|
email: "eric+claude@dideric.is"
|
||||||
KnownHostKey: ssh-ed25519 AAAA...
|
remotes:
|
||||||
|
gitea.dideric.is:
|
||||||
|
Name: bot-bottle
|
||||||
|
Upstream: ssh://git@gitea.dideric.is:30009/didericis/bot-bottle.git
|
||||||
|
IdentityFile: /Users/didericis/.ssh/id_ed25519_gitea
|
||||||
|
KnownHostKey: ssh-ed25519 AAAA...
|
||||||
|
|
||||||
# Routes declared here are held by a per-bottle cred-proxy sidecar,
|
|
||||||
# not the agent. Each route names a path the agent dials, the
|
|
||||||
# upstream the proxy forwards to, an auth_scheme, and a token_ref
|
|
||||||
# (host env var). The value goes into the sidecar's environ via
|
|
||||||
# `docker create -e`, never touches argv or disk. Optional `role`
|
|
||||||
# tags drive agent-side rewrites: anthropic-base-url (sets
|
|
||||||
# ANTHROPIC_BASE_URL), npm-registry (writes ~/.npmrc), git-insteadof
|
|
||||||
# (writes ~/.gitconfig), tea-login (writes ~/.config/tea/config.yml).
|
|
||||||
# See docs/prds/0010-cred-proxy.md.
|
|
||||||
cred_proxy:
|
|
||||||
routes:
|
|
||||||
- path: /anthropic/
|
|
||||||
upstream: https://api.anthropic.com
|
|
||||||
auth_scheme: Bearer
|
|
||||||
token_ref: CLAUDE_BOTTLE_OAUTH_TOKEN
|
|
||||||
role: anthropic-base-url
|
|
||||||
- path: /gh-api/
|
|
||||||
upstream: https://api.github.com
|
|
||||||
auth_scheme: Bearer
|
|
||||||
token_ref: GH_PAT
|
|
||||||
- path: /gh-git/
|
|
||||||
upstream: https://github.com
|
|
||||||
auth_scheme: Bearer
|
|
||||||
token_ref: GH_PAT
|
|
||||||
role: git-insteadof
|
|
||||||
- path: /npm/
|
|
||||||
upstream: https://registry.npmjs.org
|
|
||||||
auth_scheme: Bearer
|
|
||||||
token_ref: NPM_TOKEN
|
|
||||||
role: npm-registry
|
|
||||||
|
|
||||||
# Egress is forced through a per-agent pipelock sidecar on a Docker
|
|
||||||
# `--internal` network — without the proxy the agent has no route
|
|
||||||
# off-box. The effective allowlist is the union of baked-in defaults
|
|
||||||
# (api.anthropic.com, claude.ai, ...) and the hostnames listed here.
|
|
||||||
# Pipelock also runs DLP scanning and detects URL-embedded
|
|
||||||
# high-entropy secrets. The resolved allowlist is shown in the y/N
|
|
||||||
# preflight before launch.
|
|
||||||
egress:
|
egress:
|
||||||
allowlist:
|
routes:
|
||||||
- github.com
|
- host: gitea.dideric.is
|
||||||
- registry.npmjs.org
|
auth:
|
||||||
- pypi.org
|
scheme: token # Bearer | token
|
||||||
|
token_ref: BOT_BOTTLE_GITEA_TOKEN
|
||||||
|
matches: # optional — restrict to specific paths/methods/headers
|
||||||
|
- paths:
|
||||||
|
- {type: prefix, value: /api/v1/}
|
||||||
|
methods: [GET, POST, PATCH, DELETE]
|
||||||
|
dlp: # optional — per-route detector overrides (default: all on)
|
||||||
|
outbound_detectors: [token_patterns, known_secrets]
|
||||||
|
inbound_detectors: false # disable response scanning for this host
|
||||||
---
|
---
|
||||||
|
|
||||||
The `gitea-dev` bottle. Backs my work on personal projects: Anthropic
|
The `gitea-dev` bottle. Provider auth via the inherited Claude route;
|
||||||
OAuth via cred-proxy, gitea.dideric.is over SSH (with PAT for tea
|
gitea over SSH for push, token over HTTPS for the API.
|
||||||
API), and npm for publishing scoped packages.
|
|
||||||
````
|
````
|
||||||
|
|
||||||
### Example agent (`~/.claude-bottle/agents/gitea-helper.md`)
|
**Agent** (`~/.bot-bottle/agents/gitea-helper.md`):
|
||||||
|
|
||||||
````markdown
|
````markdown
|
||||||
---
|
---
|
||||||
@@ -323,99 +133,29 @@ skills:
|
|||||||
You help maintain Gitea-hosted projects.
|
You help maintain Gitea-hosted projects.
|
||||||
````
|
````
|
||||||
|
|
||||||
The agent's Markdown body is its system prompt (whitespace
|
**Egress route fields:**
|
||||||
stripped). The frontmatter declares the bottle to launch in and any
|
|
||||||
skills to mount. You can also include Claude Code subagent fields
|
|
||||||
(`name`, `description`, `model`, `color`, `memory`) in the
|
|
||||||
frontmatter — claude-bottle ignores them at launch but doesn't
|
|
||||||
reject them, so the same file can drop into `~/.claude/agents/` as a
|
|
||||||
Claude Code subagent.
|
|
||||||
|
|
||||||
Unknown top-level frontmatter keys die at load with a "did you mean"
|
| Field | Required | Description |
|
||||||
pointer; typos don't silently ghost into an empty config.
|
|---|---|---|
|
||||||
|
| `host` | yes | Hostname to allowlist. One entry per host. |
|
||||||
|
| `role` | no | Provider-specific role string (e.g. `claude_code_oauth`). Wires built-in auth flows; set by provider templates, not manually. |
|
||||||
|
| `auth.scheme` | when `auth` present | `Bearer` or `token`. Injected by the proxy; the agent never sees the value. |
|
||||||
|
| `auth.token_ref` | when `auth` present | Env-var name holding the secret on the host. |
|
||||||
|
| `matches` | no | Array of `{paths, methods, headers}` filters. A request must match at least one entry (if any are given) to be forwarded. |
|
||||||
|
| `matches[].paths` | no | Array of `{type, value}`. `type` is `prefix` (default), `exact`, or `regex`. |
|
||||||
|
| `matches[].methods` | no | Array of HTTP method strings, e.g. `[GET, POST]`. |
|
||||||
|
| `matches[].headers` | no | Array of `{name, value, type}`. `type` is `exact` (default) or `regex`. |
|
||||||
|
| `dlp` | no | Per-route DLP overrides. Omit to use defaults (all detectors on). |
|
||||||
|
| `dlp.outbound_detectors` | no | `false` disables outbound scanning; list restricts to named detectors (`token_patterns`, `known_secrets`). |
|
||||||
|
| `dlp.inbound_detectors` | no | `false` disables inbound scanning; list restricts to named detectors (`naive_injection_detection`). |
|
||||||
|
| `git.fetch` | no | `true` permits smart HTTP clone/fetch (`git-upload-pack`) for this host. Push (`git-receive-pack`) remains blocked. |
|
||||||
|
|
||||||
The YAML subset the frontmatter accepts is bounded (flat keys,
|
More examples in `examples/`. Full design lives under `docs/prds/`; the trust-boundary rationale is in `docs/prds/0011-per-file-md-manifest.md`.
|
||||||
strings / ints / true-or-false bools / null / lists / one-level
|
|
||||||
nested dicts). Anchors, multi-line block scalars, tags, and
|
|
||||||
ambiguous bare strings (`yes` / `NO` / `2026-05-24` /
|
|
||||||
`0x...`) all die with a clear pointer at the spec — quote your
|
|
||||||
strings when in doubt. The full schema lives in
|
|
||||||
`claude_bottle/yaml_subset.py` (~450 lines, stdlib-only, no PyYAML).
|
|
||||||
|
|
||||||
Working examples live under `examples/`. Pipelock's design lives in
|
|
||||||
`docs/prds/0001-per-agent-egress-proxy-via-pipelock.md` and the
|
|
||||||
rationale in `docs/research/pipelock-assessment.md`. The trust
|
|
||||||
boundary rationale lives in `docs/prds/0011-per-file-md-manifest.md`.
|
|
||||||
|
|
||||||
## Auth: OAuth token, not API key
|
|
||||||
|
|
||||||
claude-bottle authenticates `claude` inside the container with the same
|
|
||||||
Pro/Max subscription you already use on the host, via a long-lived OAuth
|
|
||||||
token. No `ANTHROPIC_API_KEY` is needed.
|
|
||||||
|
|
||||||
**Why a token instead of mounting `~/.claude.json`:** on macOS, Claude
|
|
||||||
Code stores OAuth credentials in the encrypted Keychain, not in
|
|
||||||
`~/.claude.json`. Mounting that file into a Linux container does not
|
|
||||||
carry the credentials with it. Linux hosts keep credentials in
|
|
||||||
`~/.claude/.credentials.json`, but to keep the launcher portable
|
|
||||||
claude-bottle uses the env-var path on every host.
|
|
||||||
|
|
||||||
**One-time setup on the host:**
|
|
||||||
|
|
||||||
```sh
|
|
||||||
claude setup-token # browser login, prints a ~1-year OAuth token
|
|
||||||
```
|
|
||||||
|
|
||||||
Stash the token in your shell env (e.g. `~/.zshrc` or a secret manager)
|
|
||||||
as `CLAUDE_BOTTLE_OAUTH_TOKEN`:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
export CLAUDE_BOTTLE_OAUTH_TOKEN="<token>"
|
|
||||||
```
|
|
||||||
|
|
||||||
The bottle reaches the Anthropic API only through the cred-proxy
|
|
||||||
sidecar. To let `claude` authenticate, declare a route in
|
|
||||||
`bottle.cred_proxy.routes` with `role: "anthropic-base-url"` and
|
|
||||||
`token_ref: "CLAUDE_BOTTLE_OAUTH_TOKEN"`:
|
|
||||||
|
|
||||||
```jsonc
|
|
||||||
{
|
|
||||||
"path": "/anthropic/",
|
|
||||||
"upstream": "https://api.anthropic.com",
|
|
||||||
"auth_scheme": "Bearer",
|
|
||||||
"token_ref": "CLAUDE_BOTTLE_OAUTH_TOKEN",
|
|
||||||
"role": "anthropic-base-url"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
At launch, `cli.py` reads `CLAUDE_BOTTLE_OAUTH_TOKEN` from the host
|
|
||||||
env and forwards it into the cred-proxy container's environ — never
|
|
||||||
into the agent's. The agent receives `ANTHROPIC_BASE_URL` pointing at
|
|
||||||
`http://cred-proxy:9099/anthropic` and a non-secret placeholder for
|
|
||||||
`CLAUDE_CODE_OAUTH_TOKEN` (claude-code refuses to start without one;
|
|
||||||
the proxy strips and replaces the header on every request). `printenv`
|
|
||||||
inside the agent does not surface the real token, and the value is
|
|
||||||
never written to disk or placed on argv on the host.
|
|
||||||
|
|
||||||
A bottle without an `anthropic-base-url` route has no path to the
|
|
||||||
Anthropic API — there is no fallback that forwards the token directly
|
|
||||||
to the agent. Caveats: the token is bound to your subscription tier
|
|
||||||
(Pro/Max/Team/Enterprise), it does not work with `claude --bare`
|
|
||||||
(which only reads `ANTHROPIC_API_KEY`), and if it leaks, regenerate
|
|
||||||
via `claude setup-token` again. Reference:
|
|
||||||
<https://code.claude.com/docs/en/authentication>.
|
|
||||||
|
|
||||||
## Trademarks
|
## Trademarks
|
||||||
|
|
||||||
claude-bottle is an independent project and is not affiliated with,
|
bot-bottle is an independent project and is not affiliated with, endorsed by, or sponsored by Anthropic, PBC. "Claude" and "Claude Code" are trademarks of Anthropic, PBC; the project name uses "claude" descriptively to indicate that the tool runs Claude Code inside a sandbox.
|
||||||
endorsed by, or sponsored by Anthropic, PBC. "Claude" and "Claude
|
|
||||||
Code" are trademarks of Anthropic, PBC; the project name uses
|
|
||||||
"claude" descriptively to indicate that the tool runs Claude Code
|
|
||||||
inside a sandbox.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Copyright 2026 Eric Bauerfeld
|
Copyright 2026 Eric Bauerfeld. Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE)
|
|
||||||
for the full text.
|
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
"""bot-bottle: Python implementation of the agent container launcher."""
|
||||||
@@ -0,0 +1,392 @@
|
|||||||
|
"""Agent provider runtime mapping.
|
||||||
|
|
||||||
|
The manifest owns the user-facing AgentProvider shape. This module is
|
||||||
|
the launch-time table that turns a provider template into an executable
|
||||||
|
command, default image, and prompt/auth behavior.
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider implementations live under
|
||||||
|
`bot_bottle/contrib/<template>/agent_provider.py`. This module exposes:
|
||||||
|
|
||||||
|
- `AgentProvider` (ABC) — the contract each plugin implements.
|
||||||
|
- `get_provider(template)` — lazy-imported registry; the analogue
|
||||||
|
of `bot_bottle/deploy_key_provisioner.get_provisioner`.
|
||||||
|
- `AgentProvisionPlan` (+ helper dataclasses) — declarative shape
|
||||||
|
each provider produces and the backends consume unchanged.
|
||||||
|
- `agent_provision_plan` / `runtime_for` — thin wrappers around the
|
||||||
|
registry kept so existing callers keep working without per-call
|
||||||
|
edits.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import inspect
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
import tempfile
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING, Literal
|
||||||
|
|
||||||
|
from .egress import EgressRoute
|
||||||
|
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from .backend import Bottle, BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
PROVIDER_CLAUDE = "claude"
|
||||||
|
PROVIDER_CODEX = "codex"
|
||||||
|
PROVIDER_PI = "pi"
|
||||||
|
PROVIDER_TEMPLATES = frozenset({PROVIDER_CLAUDE, PROVIDER_CODEX, PROVIDER_PI})
|
||||||
|
|
||||||
|
# Hosts that egress injects the host ChatGPT bearer on when Codex
|
||||||
|
# forward_host_credentials is enabled. Pipelock must pass these through
|
||||||
|
# (no TLS MITM) or its header DLP blocks the injected JWT.
|
||||||
|
CODEX_HOST_CREDENTIAL_HOSTS = ("api.openai.com", "chatgpt.com")
|
||||||
|
PromptMode = Literal[
|
||||||
|
"append_file",
|
||||||
|
"read_prompt_file",
|
||||||
|
"print_read_prompt_file",
|
||||||
|
"append_system_prompt",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class AgentProviderRuntime:
|
||||||
|
template: str
|
||||||
|
command: str
|
||||||
|
image: str
|
||||||
|
prompt_mode: PromptMode
|
||||||
|
bypass_args: tuple[str, ...]
|
||||||
|
resume_args: tuple[str, ...]
|
||||||
|
remote_control_args: tuple[str, ...]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class AgentProvisionDir:
|
||||||
|
guest_path: str
|
||||||
|
mode: str = "700"
|
||||||
|
owner: str = "node:node"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class AgentProvisionFile:
|
||||||
|
host_path: Path
|
||||||
|
guest_path: str
|
||||||
|
mode: str = "600"
|
||||||
|
owner: str = "node:node"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class AgentProvisionCommand:
|
||||||
|
argv: tuple[str, ...]
|
||||||
|
error: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class AgentProvisionPlan:
|
||||||
|
"""Provider-owned guest setup.
|
||||||
|
|
||||||
|
Backends interpret this plan with their own copy/exec primitives.
|
||||||
|
Provider-specific content stays here so future provider plugins can
|
||||||
|
return the same shape without adding backend-plan fields.
|
||||||
|
|
||||||
|
`egress_routes` are provider-declared EgressRoutes that backends
|
||||||
|
pass to `Egress.prepare`. This keeps provider logic out of the
|
||||||
|
egress module — it merges provider routes generically without
|
||||||
|
knowing the provider type.
|
||||||
|
|
||||||
|
`hidden_env_names` is the set of env var names the provider injected
|
||||||
|
as non-secret placeholders. `print_util.visible_agent_env_names` uses
|
||||||
|
this to suppress them from the preflight summary so operators don't
|
||||||
|
mistake them for real credentials.
|
||||||
|
"""
|
||||||
|
|
||||||
|
template: str
|
||||||
|
command: str
|
||||||
|
prompt_mode: PromptMode
|
||||||
|
image: str
|
||||||
|
dockerfile: str
|
||||||
|
guest_home: str
|
||||||
|
instance_name: str
|
||||||
|
prompt_file: Path
|
||||||
|
guest_env: dict[str, str]
|
||||||
|
has_prompt: bool = False
|
||||||
|
startup_args: tuple[str, ...] = ()
|
||||||
|
env_vars: dict[str, str] = field(default_factory=dict)
|
||||||
|
dirs: tuple[AgentProvisionDir, ...] = ()
|
||||||
|
files: tuple[AgentProvisionFile, ...] = ()
|
||||||
|
pre_copy: tuple[AgentProvisionCommand, ...] = ()
|
||||||
|
verify: tuple[AgentProvisionCommand, ...] = ()
|
||||||
|
egress_routes: tuple[EgressRoute, ...] = ()
|
||||||
|
hidden_env_names: frozenset[str] = field(default_factory=frozenset)
|
||||||
|
provisioned_env: dict[str, str] = field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class AgentProvider(ABC):
|
||||||
|
"""Per-template plugin: produces the provision plan and applies
|
||||||
|
the provider-specific in-guest setup steps (skills, prompt, the
|
||||||
|
declarative `dirs`/`files`/`pre_copy`/`verify` apply loop, and
|
||||||
|
supervise MCP registration). Concrete subclasses live under
|
||||||
|
`bot_bottle/contrib/<template>/agent_provider.py`."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
@abstractmethod
|
||||||
|
def runtime(self) -> AgentProviderRuntime:
|
||||||
|
"""The static command / image / prompt-mode table for this
|
||||||
|
template."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def guest_home(self) -> str:
|
||||||
|
"""In-guest home directory for the agent user. Defaults to
|
||||||
|
`/home/node` to match the Debian-based bot-bottle-* images
|
||||||
|
(USER node). Override for plugins whose image runs as a
|
||||||
|
different user."""
|
||||||
|
return "/home/node"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def dockerfile(self) -> Path:
|
||||||
|
"""Path to the provider's Dockerfile.
|
||||||
|
|
||||||
|
Default: the `Dockerfile` file next to this provider's
|
||||||
|
`agent_provider.py` module. Override to point at a non-standard
|
||||||
|
path."""
|
||||||
|
return Path(inspect.getfile(type(self))).parent / "Dockerfile"
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def provision_plan(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
dockerfile: str,
|
||||||
|
state_dir: Path,
|
||||||
|
instance_name: str,
|
||||||
|
prompt_file: Path,
|
||||||
|
guest_env: dict[str, str] | None = None,
|
||||||
|
auth_token: str = "",
|
||||||
|
forward_host_credentials: bool = False,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
trusted_project_path: str = "",
|
||||||
|
label: str = "",
|
||||||
|
color: str = "",
|
||||||
|
provider_settings: dict[str, object] | None = None,
|
||||||
|
) -> AgentProvisionPlan:
|
||||||
|
"""Build the declarative AgentProvisionPlan for one launch.
|
||||||
|
Backends call this during `prepare` and consume the result as
|
||||||
|
before."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Copy each of the agent's named skills from the host into
|
||||||
|
the guest. No-op when the agent has no skills. The in-guest
|
||||||
|
layout is provider-specific (claude-code's
|
||||||
|
`~/.claude/skills/` today; future providers may differ)."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def provision_prompt(self, plan: "BottlePlan", bottle: "Bottle") -> str | None:
|
||||||
|
"""Copy the prompt file into the guest, fix ownership/mode,
|
||||||
|
and return the in-guest path iff the agent has a non-empty
|
||||||
|
prompt (drives the `--append-system-prompt-file` flag).
|
||||||
|
|
||||||
|
The file is copied either way so the path always exists."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def provision(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Apply the provider's declarative
|
||||||
|
`dirs`/`pre_copy`/`files`/`verify` steps from
|
||||||
|
`plan.agent_provision`. Was called `provision_provider_auth`
|
||||||
|
on `BottleBackend` before PRD 0050."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def provision_supervise_mcp(
|
||||||
|
self,
|
||||||
|
plan: "BottlePlan",
|
||||||
|
bottle: "Bottle",
|
||||||
|
supervise_url: str,
|
||||||
|
) -> None:
|
||||||
|
"""Register the per-bottle supervise sidecar as an MCP server
|
||||||
|
in the provider's in-guest config. Called by the backend after
|
||||||
|
the supervise sidecar is reachable. No-op when
|
||||||
|
`plan.supervise_plan is None`."""
|
||||||
|
|
||||||
|
def provision_ca(self, bottle: "Bottle", plan: "BottlePlan") -> None:
|
||||||
|
"""Install the egress MITM CA into the agent's trust store.
|
||||||
|
|
||||||
|
Default: Debian-style — cp the cert to the standard source path,
|
||||||
|
run update-ca-certificates, log the fingerprint. Override for
|
||||||
|
non-Debian base images or non-standard trust mechanisms."""
|
||||||
|
from .backend.util import AGENT_CA_PATH, log_ca_fingerprint, select_ca_cert
|
||||||
|
from .log import die
|
||||||
|
cert_host_path, label = select_ca_cert(plan.egress_plan)
|
||||||
|
bottle.cp_in(str(cert_host_path), AGENT_CA_PATH)
|
||||||
|
r = bottle.exec(
|
||||||
|
f"chmod 644 {AGENT_CA_PATH} && update-ca-certificates",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"update-ca-certificates failed (exit {r.returncode}): "
|
||||||
|
f"stdout={(r.stdout or '').strip()!r} "
|
||||||
|
f"stderr={(r.stderr or '').strip()!r}"
|
||||||
|
)
|
||||||
|
log_ca_fingerprint(cert_host_path, label)
|
||||||
|
|
||||||
|
def provision_git(self, bottle: "Bottle", plan: "BottlePlan") -> None:
|
||||||
|
"""Configure git inside the agent container.
|
||||||
|
|
||||||
|
Default: Debian/node — writes the git-gate insteadOf gitconfig
|
||||||
|
and sets user.name/email as node. Workspace copy runs through
|
||||||
|
BottleBackend.provision_workspace against the running bottle."""
|
||||||
|
from .log import info
|
||||||
|
|
||||||
|
manifest_bottle = plan.spec.manifest.bottle_for(plan.spec.agent_name)
|
||||||
|
if manifest_bottle.git:
|
||||||
|
from .git_gate import GIT_GATE_HOSTNAME, git_gate_render_gitconfig
|
||||||
|
gate_host = getattr(plan, "git_gate_insteadof_host", GIT_GATE_HOSTNAME)
|
||||||
|
gate_scheme = getattr(plan, "git_gate_insteadof_scheme", "git")
|
||||||
|
content = git_gate_render_gitconfig(
|
||||||
|
manifest_bottle.git, gate_host, scheme=gate_scheme,
|
||||||
|
)
|
||||||
|
guest_gitconfig = f"{plan.guest_home}/.gitconfig"
|
||||||
|
with tempfile.NamedTemporaryFile(
|
||||||
|
"w", dir=str(plan.stage_dir), prefix="gitconfig.", delete=False,
|
||||||
|
) as f:
|
||||||
|
f.write(content)
|
||||||
|
config_file = Path(f.name)
|
||||||
|
os.chmod(config_file, 0o600)
|
||||||
|
info(
|
||||||
|
f"writing {guest_gitconfig} with "
|
||||||
|
f"{len(manifest_bottle.git)} insteadOf rule(s)"
|
||||||
|
)
|
||||||
|
bottle.cp_in(str(config_file), guest_gitconfig)
|
||||||
|
bottle.exec(
|
||||||
|
f"chown node:node {shlex.quote(guest_gitconfig)} && "
|
||||||
|
f"chmod 644 {shlex.quote(guest_gitconfig)}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
|
||||||
|
gu = manifest_bottle.git_user
|
||||||
|
if not gu.is_empty():
|
||||||
|
if gu.name:
|
||||||
|
info(f"git config --global user.name = {gu.name!r}")
|
||||||
|
bottle.exec(
|
||||||
|
f"git config --global user.name {shlex.quote(gu.name)}",
|
||||||
|
user="node",
|
||||||
|
)
|
||||||
|
if gu.email:
|
||||||
|
info(f"git config --global user.email = {gu.email!r}")
|
||||||
|
bottle.exec(
|
||||||
|
f"git config --global user.email {shlex.quote(gu.email)}",
|
||||||
|
user="node",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _load_user_plugin(template: str) -> AgentProvider | None:
|
||||||
|
"""Check ~/.bot-bottle/contrib/<template>/agent_provider.py for a
|
||||||
|
user-defined AgentProvider subclass. Returns an instance if found,
|
||||||
|
None if the plugin directory doesn't exist, raises ValueError if
|
||||||
|
the file exists but exports no AgentProvider subclass."""
|
||||||
|
plugin_path = (
|
||||||
|
Path.home() / ".bot-bottle" / "contrib" / template / "agent_provider.py"
|
||||||
|
)
|
||||||
|
if not plugin_path.exists():
|
||||||
|
return None
|
||||||
|
spec = importlib.util.spec_from_file_location(
|
||||||
|
f"_user_contrib_{template}.agent_provider", plugin_path
|
||||||
|
)
|
||||||
|
if spec is None or spec.loader is None:
|
||||||
|
raise ValueError(f"user plugin at {plugin_path} could not be loaded")
|
||||||
|
mod = importlib.util.module_from_spec(spec)
|
||||||
|
spec.loader.exec_module(mod) # type: ignore[union-attr]
|
||||||
|
for obj in vars(mod).values():
|
||||||
|
if (
|
||||||
|
isinstance(obj, type)
|
||||||
|
and issubclass(obj, AgentProvider)
|
||||||
|
and obj is not AgentProvider
|
||||||
|
):
|
||||||
|
return obj()
|
||||||
|
raise ValueError(
|
||||||
|
f"user plugin at {plugin_path} defines no AgentProvider subclass"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_provider(template: str) -> AgentProvider:
|
||||||
|
"""Resolve a provider template name to its plugin instance.
|
||||||
|
|
||||||
|
Checks ~/.bot-bottle/contrib/<template>/agent_provider.py first so
|
||||||
|
users can shadow a built-in for local testing. Falls through to the
|
||||||
|
built-in registry; raises ValueError for unknown names with no
|
||||||
|
matching user plugin."""
|
||||||
|
user_plugin = _load_user_plugin(template)
|
||||||
|
if user_plugin is not None:
|
||||||
|
return user_plugin
|
||||||
|
if template == PROVIDER_CLAUDE:
|
||||||
|
from .contrib.claude.agent_provider import ClaudeAgentProvider
|
||||||
|
return ClaudeAgentProvider()
|
||||||
|
if template == PROVIDER_CODEX:
|
||||||
|
from .contrib.codex.agent_provider import CodexAgentProvider
|
||||||
|
return CodexAgentProvider()
|
||||||
|
if template == PROVIDER_PI:
|
||||||
|
from .contrib.pi.agent_provider import PiAgentProvider
|
||||||
|
return PiAgentProvider()
|
||||||
|
raise ValueError(f"unknown agent provider template: {template!r}")
|
||||||
|
|
||||||
|
|
||||||
|
def runtime_for(template: str) -> AgentProviderRuntime:
|
||||||
|
return get_provider(template).runtime
|
||||||
|
|
||||||
|
|
||||||
|
def build_agent_provision_plan(
|
||||||
|
*,
|
||||||
|
template: str,
|
||||||
|
dockerfile: str,
|
||||||
|
state_dir: Path,
|
||||||
|
instance_name: str,
|
||||||
|
prompt_file: Path,
|
||||||
|
guest_env: dict[str, str] | None = None,
|
||||||
|
auth_token: str = "",
|
||||||
|
forward_host_credentials: bool = False,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
trusted_project_path: str = "",
|
||||||
|
label: str = "",
|
||||||
|
color: str = "",
|
||||||
|
provider_settings: dict[str, object] | None = None,
|
||||||
|
) -> AgentProvisionPlan:
|
||||||
|
"""Back-compat shim — `prepare` callers stay the same; the work
|
||||||
|
now lives on the provider plugin."""
|
||||||
|
return get_provider(template).provision_plan(
|
||||||
|
dockerfile=dockerfile,
|
||||||
|
state_dir=state_dir,
|
||||||
|
instance_name=instance_name,
|
||||||
|
prompt_file=prompt_file,
|
||||||
|
guest_env=guest_env,
|
||||||
|
auth_token=auth_token,
|
||||||
|
forward_host_credentials=forward_host_credentials,
|
||||||
|
host_env=host_env,
|
||||||
|
trusted_project_path=trusted_project_path,
|
||||||
|
label=label,
|
||||||
|
color=color,
|
||||||
|
provider_settings=provider_settings,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def prompt_args(
|
||||||
|
prompt_mode: PromptMode,
|
||||||
|
prompt_path: str | None,
|
||||||
|
*,
|
||||||
|
argv: list[str] | None = None,
|
||||||
|
) -> list[str]:
|
||||||
|
if not prompt_path:
|
||||||
|
return []
|
||||||
|
if prompt_mode == "append_file":
|
||||||
|
return ["--append-system-prompt-file", prompt_path]
|
||||||
|
if prompt_mode == "read_prompt_file":
|
||||||
|
if argv and "resume" in argv:
|
||||||
|
return []
|
||||||
|
return [f"Read and follow the instructions in {prompt_path}."]
|
||||||
|
if prompt_mode == "print_read_prompt_file":
|
||||||
|
return ["-p", f"Read and follow the instructions in {prompt_path}."]
|
||||||
|
if prompt_mode == "append_system_prompt":
|
||||||
|
return ["--append-system-prompt", prompt_path]
|
||||||
|
raise ValueError(f"unknown provider prompt mode: {prompt_mode}")
|
||||||
@@ -0,0 +1,629 @@
|
|||||||
|
"""Per-backend bottle factories.
|
||||||
|
|
||||||
|
A bottle is a running, isolated environment with claude inside. Each
|
||||||
|
backend exposes five methods:
|
||||||
|
|
||||||
|
prepare(spec, stage_dir=...) -> BottlePlan
|
||||||
|
Resolves names, validates host-side prerequisites, and writes
|
||||||
|
scratch files. No remote/runtime resources are created yet.
|
||||||
|
Safe to call before the y/N preflight.
|
||||||
|
|
||||||
|
launch(plan) -> ContextManager[Bottle]
|
||||||
|
Brings up the container (or VM, or remote machine), provisions
|
||||||
|
it, yields a Bottle handle, and tears everything down on exit.
|
||||||
|
|
||||||
|
prepare_cleanup() -> BottleCleanupPlan
|
||||||
|
Enumerates orphaned resources left behind by previous bottles
|
||||||
|
(containers, networks, ...). Idempotent; no side effects.
|
||||||
|
|
||||||
|
cleanup(plan) -> None
|
||||||
|
Actually removes everything described by the cleanup plan.
|
||||||
|
|
||||||
|
enumerate_active() -> Sequence[ActiveAgent]
|
||||||
|
Return every currently-running bottle on this backend, with
|
||||||
|
enough metadata for callers (CLI `list active`, dashboard
|
||||||
|
agents pane) to render a row.
|
||||||
|
|
||||||
|
Selection is driven by `--backend` on `start` or BOT_BOTTLE_BACKEND
|
||||||
|
(env var). When neither is set, compatible macOS hosts default to
|
||||||
|
`macos-container`; other hosts default to `smolmachines`. Per PRD 0003
|
||||||
|
the manifest does not carry a backend field; the host picks.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
import sys
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from contextlib import AbstractContextManager
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Generic, Sequence, TypeVar
|
||||||
|
|
||||||
|
from ..agent_provider import AgentProvisionPlan, get_provider, build_agent_provision_plan
|
||||||
|
from ..egress import EgressPlan
|
||||||
|
from ..git_gate import GitGatePlan
|
||||||
|
from ..log import die, info
|
||||||
|
from ..manifest import ManifestGitEntry, Manifest
|
||||||
|
from ..supervise import SupervisePlan
|
||||||
|
from ..util import expand_tilde
|
||||||
|
from ..env import resolve_env, ResolvedEnv
|
||||||
|
from ..workspace import WorkspacePlan, workspace_plan
|
||||||
|
from .print_util import print_multi, visible_agent_env_names
|
||||||
|
from .util import host_skill_dir
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BottleSpec:
|
||||||
|
"""CLI-supplied intent. Backend-agnostic — each backend's prepare
|
||||||
|
step consumes it and produces its own backend-specific plan.
|
||||||
|
Resolved values (image names, container name, scratch paths, runsc
|
||||||
|
availability) live on the plan, not the spec."""
|
||||||
|
|
||||||
|
manifest: Manifest
|
||||||
|
agent_name: str
|
||||||
|
copy_cwd: bool
|
||||||
|
user_cwd: str
|
||||||
|
# PRD 0016 follow-up: when set, the backend's prepare step uses
|
||||||
|
# this identity instead of minting a fresh one — the resume path
|
||||||
|
# (`cli.py resume <identity>`) sets this to continue an existing
|
||||||
|
# bottle's state. Empty string for a fresh `start`.
|
||||||
|
identity: str = ""
|
||||||
|
label: str = ""
|
||||||
|
color: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BottlePlan(ABC):
|
||||||
|
"""Base output of a backend's prepare step. Concrete subclasses
|
||||||
|
(e.g. DockerBottlePlan) add backend-specific resolved fields."""
|
||||||
|
|
||||||
|
spec: BottleSpec
|
||||||
|
stage_dir: Path
|
||||||
|
git_gate_plan: GitGatePlan
|
||||||
|
|
||||||
|
@property
|
||||||
|
def guest_home(self) -> str:
|
||||||
|
return self.agent_provision.guest_home
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_host(self) -> str:
|
||||||
|
"""Host (and optional port) used in git-gate insteadOf URLs.
|
||||||
|
Docker uses the compose-network DNS alias; smolmachines
|
||||||
|
overrides with a loopback IP:port since TSI has no DNS."""
|
||||||
|
return "git-gate"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_scheme(self) -> str:
|
||||||
|
"""URL scheme for git-gate insteadOf rewrites. 'git' for
|
||||||
|
Docker (git daemon); 'http' for smolmachines (HTTP proxy
|
||||||
|
over a published host port)."""
|
||||||
|
return "git"
|
||||||
|
egress_plan: EgressPlan
|
||||||
|
supervise_plan: SupervisePlan | None
|
||||||
|
agent_provision: AgentProvisionPlan
|
||||||
|
|
||||||
|
@property
|
||||||
|
def workspace_plan(self) -> WorkspacePlan:
|
||||||
|
return workspace_plan(self.spec, guest_home=self.guest_home)
|
||||||
|
|
||||||
|
def print(self, *, remote_control: bool) -> None:
|
||||||
|
"""Render the y/N preflight summary to stderr."""
|
||||||
|
del remote_control
|
||||||
|
spec = self.spec
|
||||||
|
manifest = spec.manifest
|
||||||
|
agent = manifest.agents[spec.agent_name]
|
||||||
|
bottle = manifest.bottle_for(spec.agent_name)
|
||||||
|
|
||||||
|
env_names = visible_agent_env_names(
|
||||||
|
sorted(
|
||||||
|
set(bottle.env.keys())
|
||||||
|
| set(self.agent_provision.guest_env.keys())
|
||||||
|
),
|
||||||
|
hidden_env_names=self.agent_provision.hidden_env_names,
|
||||||
|
)
|
||||||
|
|
||||||
|
print(file=sys.stderr)
|
||||||
|
info(f"agent : {spec.agent_name}")
|
||||||
|
info(f"provider : {self.agent_provision.template}")
|
||||||
|
print_multi("env ", env_names)
|
||||||
|
print_multi("skills ", list(agent.skills))
|
||||||
|
info(f"bottle : {agent.bottle}")
|
||||||
|
|
||||||
|
identity = manifest.git_identity_summary(spec.agent_name)
|
||||||
|
if identity:
|
||||||
|
info(f" git identity : {identity}")
|
||||||
|
|
||||||
|
git_lines = [
|
||||||
|
f"{u.name} → {u.upstream_host}:{u.upstream_port}"
|
||||||
|
for u in self.git_gate_plan.upstreams
|
||||||
|
]
|
||||||
|
if git_lines:
|
||||||
|
print_multi(" git gate ", git_lines)
|
||||||
|
|
||||||
|
if self.egress_plan.routes:
|
||||||
|
egress_lines = []
|
||||||
|
for r in self.egress_plan.routes:
|
||||||
|
auth = f" [auth:{r.auth_scheme}]" if r.auth_scheme else ""
|
||||||
|
egress_lines.append(f"{r.host}{auth}")
|
||||||
|
print_multi(" egress ", egress_lines)
|
||||||
|
print(file=sys.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BottleCleanupPlan(ABC):
|
||||||
|
"""Base output of a backend's prepare_cleanup step. Concrete
|
||||||
|
subclasses (e.g. DockerBottleCleanupPlan) carry backend-specific
|
||||||
|
lists of resources to be removed and implement `print` + `empty`."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def print(self) -> None:
|
||||||
|
"""Render the cleanup y/N summary to stderr."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
@abstractmethod
|
||||||
|
def empty(self) -> bool:
|
||||||
|
"""True iff there is nothing to clean up; the CLI uses this to
|
||||||
|
short-circuit before showing the y/N."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ExecResult:
|
||||||
|
"""Captured result of `Bottle.exec`. Backend-neutral: the Docker
|
||||||
|
impl populates it from a `subprocess.CompletedProcess`, but a
|
||||||
|
future fly/smolmachines backend could populate it from any source
|
||||||
|
that produces a returncode + captured streams."""
|
||||||
|
|
||||||
|
returncode: int
|
||||||
|
stdout: str
|
||||||
|
stderr: str
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ActiveAgent:
|
||||||
|
"""One currently-running agent, as the CLI `list active` and
|
||||||
|
dashboard agents pane render it. ("Agent" is the project's
|
||||||
|
consistent name for the thing running inside a bottle — the
|
||||||
|
bottle is the container, the agent is what runs in it.)
|
||||||
|
|
||||||
|
Fields are deliberately backend-neutral. `services` is the set
|
||||||
|
of sidecar daemons currently up for this bottle (`egress`,
|
||||||
|
`git-gate`, `supervise`); the dashboard uses it to
|
||||||
|
gate edit verbs. `backend_name` is the matching key in
|
||||||
|
`_BACKENDS` (`docker` / `smolmachines` / `macos-container`) — used by the active-
|
||||||
|
list rendering to disambiguate and by the dashboard's
|
||||||
|
re-attach path."""
|
||||||
|
|
||||||
|
backend_name: str
|
||||||
|
slug: str
|
||||||
|
agent_name: str # from metadata.json; "?" if missing
|
||||||
|
started_at: str # ISO 8601 from metadata.json; "" if missing
|
||||||
|
services: tuple[str, ...] # alphabetical
|
||||||
|
label: str = ""
|
||||||
|
color: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
class Bottle(ABC):
|
||||||
|
"""Handle to a running bottle. Yielded by a backend's launch step.
|
||||||
|
|
||||||
|
`exec_agent` runs the selected agent CLI inside the bottle and
|
||||||
|
blocks until the session ends. `exec` runs a POSIX shell script inside the bottle
|
||||||
|
and returns the captured result. `cp_in` copies a host path into
|
||||||
|
the bottle. `close` is an idempotent alias for context-manager
|
||||||
|
teardown.
|
||||||
|
"""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def agent_argv(
|
||||||
|
self, argv: list[str], *, tty: bool = True,
|
||||||
|
) -> list[str]:
|
||||||
|
"""Return the host-side argv that runs the selected agent
|
||||||
|
inside the bottle. Used by `exec_agent` for foreground
|
||||||
|
handoffs and by the dashboard's tmux `respawn-pane` flow,
|
||||||
|
which needs the argv up front (it spawns claude in a tmux
|
||||||
|
pane rather than as a child of the current process).
|
||||||
|
|
||||||
|
Implementations transparently inject
|
||||||
|
`--append-system-prompt-file` when the bottle was launched
|
||||||
|
with a provisioned prompt path."""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int: ...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
|
"""Run `script` as a POSIX shell script inside the bottle as
|
||||||
|
`user` (default `node`, matching the agent image's USER
|
||||||
|
directive) and return the captured stdout/stderr/returncode.
|
||||||
|
The bottle's environment (including HTTPS_PROXY pointing at
|
||||||
|
the egress sidecar) is inherited by the child. Non-zero
|
||||||
|
exit does not raise — callers inspect `returncode`
|
||||||
|
themselves.
|
||||||
|
|
||||||
|
Pass `user="root"` for shell-outs that need privileged file
|
||||||
|
writes / package install — provisioning calls that need root
|
||||||
|
bypass `Bottle.exec` and use the backend-specific raw
|
||||||
|
machine-exec helper, but the tests have a legitimate use
|
||||||
|
case for arbitrary-user runs."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def cp_in(self, host_path: str, container_path: str) -> None: ...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def close(self) -> None: ...
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
PlanT = TypeVar("PlanT", bound=BottlePlan)
|
||||||
|
CleanupT = TypeVar("CleanupT", bound=BottleCleanupPlan)
|
||||||
|
|
||||||
|
|
||||||
|
class BottleBackend(ABC, Generic[PlanT, CleanupT]):
|
||||||
|
"""Abstract base for selectable bottle backends. Concrete subclasses
|
||||||
|
(e.g. DockerBottleBackend) own their own prepare/launch impls.
|
||||||
|
Parameterized over the backend's concrete plan + cleanup-plan types
|
||||||
|
so subclass methods get the narrow type without isinstance
|
||||||
|
boilerplate."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
|
||||||
|
def prepare(self, spec: BottleSpec, stage_dir: Path) -> PlanT:
|
||||||
|
"""Template method: run cross-backend host-side validation, then
|
||||||
|
delegate to the subclass's `_resolve_plan` for the
|
||||||
|
backend-specific resolution (names, scratch files, etc.). The
|
||||||
|
validation step is enforced here so a future backend cannot
|
||||||
|
accidentally skip it. No remote/runtime resources are created."""
|
||||||
|
from .resolve_common import (
|
||||||
|
merge_provision_env_vars,
|
||||||
|
mint_slug,
|
||||||
|
prepare_agent_state_dir,
|
||||||
|
prepare_egress,
|
||||||
|
prepare_git_gate,
|
||||||
|
prepare_supervise,
|
||||||
|
resolve_manifest_dockerfile,
|
||||||
|
write_launch_metadata,
|
||||||
|
)
|
||||||
|
|
||||||
|
self._validate(spec)
|
||||||
|
|
||||||
|
self._preflight()
|
||||||
|
|
||||||
|
manifest = spec.manifest
|
||||||
|
manifest_bottle = manifest.bottle_for(spec.agent_name)
|
||||||
|
manifest_agent_provider = manifest_bottle.agent_provider
|
||||||
|
agent_provider = get_provider(manifest_agent_provider.template)
|
||||||
|
resolved_env = resolve_env(manifest, spec.agent_name)
|
||||||
|
workspace = workspace_plan(spec, guest_home=agent_provider.guest_home)
|
||||||
|
|
||||||
|
slug = mint_slug(spec)
|
||||||
|
write_launch_metadata(slug, spec, compose_project="", backend=self.name)
|
||||||
|
|
||||||
|
# Manifest may override the Dockerfile per-bottle; otherwise fall
|
||||||
|
# back to the provider plugin's bundled Dockerfile (next to its
|
||||||
|
# agent_provider.py module).
|
||||||
|
if manifest_agent_provider.dockerfile:
|
||||||
|
agent_dockerfile_path = resolve_manifest_dockerfile(
|
||||||
|
manifest_agent_provider.dockerfile, spec,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
agent_dockerfile_path = str(agent_provider.dockerfile)
|
||||||
|
|
||||||
|
agent_dir, prompt_file = prepare_agent_state_dir(slug, spec)
|
||||||
|
|
||||||
|
agent_provision_plan = build_agent_provision_plan(
|
||||||
|
template=manifest_agent_provider.template,
|
||||||
|
dockerfile=agent_dockerfile_path,
|
||||||
|
state_dir=agent_dir,
|
||||||
|
instance_name=f"bot-bottle-{slug}",
|
||||||
|
prompt_file=prompt_file,
|
||||||
|
guest_env=self._build_guest_env(resolved_env),
|
||||||
|
forward_host_credentials=manifest_agent_provider.forward_host_credentials,
|
||||||
|
auth_token=manifest_agent_provider.auth_token,
|
||||||
|
host_env=dict(os.environ),
|
||||||
|
trusted_project_path=workspace.workdir,
|
||||||
|
label=spec.label,
|
||||||
|
color=spec.color,
|
||||||
|
provider_settings=manifest_agent_provider.settings,
|
||||||
|
)
|
||||||
|
agent_provision_plan = merge_provision_env_vars(agent_provision_plan)
|
||||||
|
egress_plan = prepare_egress(manifest_bottle, slug, agent_provision_plan)
|
||||||
|
supervise_plan = prepare_supervise(manifest_bottle, slug)
|
||||||
|
git_gate_plan = prepare_git_gate(manifest_bottle, slug)
|
||||||
|
|
||||||
|
return self._resolve_plan(
|
||||||
|
spec,
|
||||||
|
slug=slug,
|
||||||
|
resolved_env=resolved_env,
|
||||||
|
agent_provision_plan=agent_provision_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
def _build_guest_env(self, resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
def _preflight(self) -> None:
|
||||||
|
"""
|
||||||
|
tasks to do before resolving a plan
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
def _validate(self, spec: BottleSpec) -> None:
|
||||||
|
"""Cross-backend pre-launch checks. Confirms the agent exists,
|
||||||
|
the named skills are present on the host, and every git
|
||||||
|
IdentityFile resolves. Subclasses with additional preconditions
|
||||||
|
should override and call `super()._validate(spec)` first."""
|
||||||
|
manifest = spec.manifest
|
||||||
|
manifest.require_agent(spec.agent_name)
|
||||||
|
agent = manifest.agents[spec.agent_name]
|
||||||
|
bottle = manifest.bottle_for(spec.agent_name)
|
||||||
|
self._validate_skills(agent.skills)
|
||||||
|
self._validate_git_entries(bottle.git)
|
||||||
|
self._validate_agent_provider_dockerfile(spec)
|
||||||
|
|
||||||
|
def _validate_skills(self, skills: Sequence[str]) -> None:
|
||||||
|
"""Each named skill must be a directory under the host's
|
||||||
|
`~/.claude/skills/`. The check is purely host-side, so the
|
||||||
|
default impl covers every backend."""
|
||||||
|
for name in skills:
|
||||||
|
path = host_skill_dir(name)
|
||||||
|
if not os.path.isdir(path):
|
||||||
|
die(
|
||||||
|
f"skill '{name}' not found on host at {path}. "
|
||||||
|
f"Create it under ~/.claude/skills/, then re-run."
|
||||||
|
)
|
||||||
|
|
||||||
|
def _validate_git_entries(self, entries: Sequence[ManifestGitEntry]) -> None:
|
||||||
|
"""Each entry's IdentityFile must exist on the host (after
|
||||||
|
expanding leading ~) — the git-gate copies it in at start time
|
||||||
|
to authenticate the upstream push (PRD 0008). Shape is already
|
||||||
|
enforced by Manifest validation; this only checks presence."""
|
||||||
|
for entry in entries:
|
||||||
|
key = expand_tilde(entry.IdentityFile)
|
||||||
|
if not os.path.isfile(key):
|
||||||
|
die(f"git upstream key file not found for '{entry.Name}': {key}")
|
||||||
|
|
||||||
|
def _validate_agent_provider_dockerfile(self, spec: BottleSpec) -> None:
|
||||||
|
bottle = spec.manifest.bottle_for(spec.agent_name)
|
||||||
|
dockerfile = bottle.agent_provider.dockerfile
|
||||||
|
if not dockerfile:
|
||||||
|
return
|
||||||
|
path = Path(expand_tilde(dockerfile))
|
||||||
|
if not path.is_absolute():
|
||||||
|
path = Path(spec.user_cwd) / path
|
||||||
|
if not path.is_file():
|
||||||
|
die(
|
||||||
|
f"agent_provider.dockerfile for bottle "
|
||||||
|
f"'{spec.manifest.agents[spec.agent_name].bottle}' not found: {path}"
|
||||||
|
)
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def _resolve_plan(self,
|
||||||
|
spec: BottleSpec,
|
||||||
|
*,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
stage_dir: Path) -> PlanT:
|
||||||
|
"""Backend-specific plan resolution: image/container names,
|
||||||
|
env-file, prompt-file, proxy plan, runtime detection. Called by
|
||||||
|
`prepare` after `_validate` succeeds. Instance name, image,
|
||||||
|
prompt file, Dockerfile path, and guest home all live on
|
||||||
|
`agent_provision_plan` — the source of truth."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def launch(self, plan: PlanT) -> AbstractContextManager[Bottle]:
|
||||||
|
"""Build/run the bottle and yield a handle; tear down on exit."""
|
||||||
|
|
||||||
|
def provision(self, plan: PlanT, bottle: "Bottle") -> str | None:
|
||||||
|
"""Copy host-side files (CA cert, prompt, skills, .git) into
|
||||||
|
the running bottle. Called from `launch` after the container
|
||||||
|
/ machine is up. Returns the in-container prompt path if a
|
||||||
|
prompt was provisioned, else None — the Bottle handle uses it
|
||||||
|
to decide whether to add provider-specific prompt args to the
|
||||||
|
agent's argv.
|
||||||
|
|
||||||
|
Default orchestration: ca → prompt → provider apply → skills
|
||||||
|
→ workspace → git → supervise-mcp. CA install runs first so
|
||||||
|
the agent's trust store is rebuilt before anything inside the
|
||||||
|
agent makes a TLS call.
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider steps (prompt, skills,
|
||||||
|
declarative provision-plan apply, supervise MCP registration)
|
||||||
|
live on the `AgentProvider` plugin. The backend only owns the
|
||||||
|
steps that are about backend infrastructure (CA, workspace,
|
||||||
|
git) and surfaces the supervise sidecar URL its launch step
|
||||||
|
knows about via `supervise_mcp_url`.
|
||||||
|
|
||||||
|
PRD 0017: cred-proxy's agent-side dotfile rewrites (~/.npmrc,
|
||||||
|
~/.gitconfig insteadOf, tea config) are gone. Egress-proxy is
|
||||||
|
on the agent's HTTP_PROXY path so every tool that respects
|
||||||
|
HTTPS_PROXY (claude-code, git over HTTPS, npm, curl) is
|
||||||
|
intercepted without per-tool reconfiguration."""
|
||||||
|
provider = get_provider(plan.agent_provision.template)
|
||||||
|
provider.provision_ca(bottle, plan)
|
||||||
|
prompt_path = provider.provision_prompt(plan, bottle)
|
||||||
|
provider.provision(plan, bottle)
|
||||||
|
provider.provision_skills(plan, bottle)
|
||||||
|
self.provision_workspace(plan, bottle)
|
||||||
|
provider.provision_git(bottle, plan)
|
||||||
|
provider.provision_supervise_mcp(
|
||||||
|
plan, bottle, self.supervise_mcp_url(plan),
|
||||||
|
)
|
||||||
|
return prompt_path
|
||||||
|
|
||||||
|
def provision_workspace(self, plan: PlanT, bottle: "Bottle") -> None:
|
||||||
|
"""Copy the operator workspace into the running bottle.
|
||||||
|
|
||||||
|
This is the only supported workspace-provisioning path: Docker
|
||||||
|
does not build a derived image containing the current
|
||||||
|
workspace."""
|
||||||
|
workspace = plan.workspace_plan
|
||||||
|
if not (workspace.enabled and workspace.copy_contents):
|
||||||
|
return
|
||||||
|
|
||||||
|
guest_parent = workspace.guest_path.rsplit("/", 1)[0] or "/"
|
||||||
|
guest_path = shlex.quote(workspace.guest_path)
|
||||||
|
guest_parent = shlex.quote(guest_parent)
|
||||||
|
owner = shlex.quote(workspace.owner)
|
||||||
|
mode = shlex.quote(workspace.mode)
|
||||||
|
info(f"copying {workspace.host_path} -> {bottle.name}:{workspace.guest_path}")
|
||||||
|
bottle.exec(
|
||||||
|
f"rm -rf {guest_path} && mkdir -p {guest_parent}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
bottle.cp_in(str(workspace.host_path), workspace.guest_path)
|
||||||
|
bottle.exec(
|
||||||
|
f"chown -R {owner} {guest_path} && chmod {mode} {guest_path}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
|
||||||
|
def supervise_mcp_url(self, plan: PlanT) -> str:
|
||||||
|
"""Return the agent-side URL of the per-bottle supervise
|
||||||
|
sidecar, or "" when this bottle has no sidecar. The provider
|
||||||
|
plugin's `provision_supervise_mcp` uses it to register the
|
||||||
|
MCP entry inside the guest.
|
||||||
|
|
||||||
|
Default returns "" so backends without supervise support
|
||||||
|
don't have to implement it. Docker and smolmachines override."""
|
||||||
|
del plan
|
||||||
|
return ""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def prepare_cleanup(self) -> CleanupT:
|
||||||
|
"""Enumerate orphaned resources from previous bottles. No side
|
||||||
|
effects; safe to call before the y/N."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def cleanup(self, plan: CleanupT) -> None:
|
||||||
|
"""Remove everything described by the cleanup plan."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def enumerate_active(self) -> Sequence[ActiveAgent]:
|
||||||
|
"""Return every currently-running agent on this backend.
|
||||||
|
Empty when none. Backend-specific: docker queries `docker
|
||||||
|
compose ls`; smolmachines queries `smolvm machine ls --json`
|
||||||
|
+ cross-references its bundle container."""
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
@abstractmethod
|
||||||
|
def is_available(cls) -> bool:
|
||||||
|
"""Whether this backend's runtime prerequisites are satisfied
|
||||||
|
on the current host. Docker → `docker` on PATH; smolmachines
|
||||||
|
→ `smolvm` on PATH. Used by the cross-backend
|
||||||
|
`enumerate_active_agents` / `cmd_cleanup` to skip backends
|
||||||
|
the operator hasn't installed, so a docker-only host
|
||||||
|
doesn't fail when `cli.py list active` walks past
|
||||||
|
smolmachines."""
|
||||||
|
|
||||||
|
|
||||||
|
# Import concrete backend classes AFTER the base types are defined, so
|
||||||
|
# each backend module can pull BottleSpec / BottlePlan / BottleBackend
|
||||||
|
# via `from . import ...` without hitting a partially-initialized module.
|
||||||
|
from .docker import DockerBottleBackend # noqa: E402 # pylint: disable=wrong-import-position
|
||||||
|
from .macos_container import MacosContainerBottleBackend # noqa: E402 # pylint: disable=wrong-import-position
|
||||||
|
from .smolmachines import SmolmachinesBottleBackend # noqa: E402 # pylint: disable=wrong-import-position
|
||||||
|
|
||||||
|
|
||||||
|
# The dict is heterogeneous: each value is a BottleBackend specialized
|
||||||
|
# over its own plan type. Concrete plan types are erased here because
|
||||||
|
# the registry is selected at runtime and the CLI only needs the
|
||||||
|
# unparameterized methods (prepare → plan → launch(plan), cleanup, etc.).
|
||||||
|
_BACKENDS: dict[str, BottleBackend[Any, Any]] = {
|
||||||
|
"docker": DockerBottleBackend(),
|
||||||
|
"macos-container": MacosContainerBottleBackend(),
|
||||||
|
"smolmachines": SmolmachinesBottleBackend(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_bottle_backend(
|
||||||
|
name: str | None = None,
|
||||||
|
) -> BottleBackend[Any, Any]:
|
||||||
|
"""Resolve the bottle backend.
|
||||||
|
|
||||||
|
`name` precedence:
|
||||||
|
1. explicit arg (CLI `--backend=<name>` passes through here)
|
||||||
|
2. BOT_BOTTLE_BACKEND env var
|
||||||
|
3. `macos-container` on compatible macOS hosts
|
||||||
|
4. default `smolmachines`
|
||||||
|
|
||||||
|
Dies with a pointer at the known backends if the chosen name
|
||||||
|
isn't implemented."""
|
||||||
|
resolved = name or os.environ.get("BOT_BOTTLE_BACKEND") or _default_backend_name()
|
||||||
|
if resolved not in _BACKENDS:
|
||||||
|
known = ", ".join(sorted(_BACKENDS))
|
||||||
|
die(f"unknown backend {resolved!r}; known backends: {known}")
|
||||||
|
return _BACKENDS[resolved]
|
||||||
|
|
||||||
|
|
||||||
|
def _default_backend_name() -> str:
|
||||||
|
if has_backend("macos-container"):
|
||||||
|
return "macos-container"
|
||||||
|
return "smolmachines"
|
||||||
|
|
||||||
|
|
||||||
|
def known_backend_names() -> tuple[str, ...]:
|
||||||
|
"""Sorted tuple of all backend keys in `_BACKENDS`. Used by
|
||||||
|
argparse (`--backend` choices) and the dashboard's backend
|
||||||
|
picker."""
|
||||||
|
return tuple(sorted(_BACKENDS))
|
||||||
|
|
||||||
|
|
||||||
|
def has_backend(name: str) -> bool:
|
||||||
|
"""Whether the named backend's runtime prerequisites are
|
||||||
|
available on the current host. Cross-backend callers (list,
|
||||||
|
cleanup) skip unavailable backends so a docker-only host
|
||||||
|
doesn't fail when the smolmachines backend isn't installed,
|
||||||
|
and vice versa.
|
||||||
|
|
||||||
|
Returns False for unknown names so callers can pass
|
||||||
|
arbitrary input without separate validation."""
|
||||||
|
if name not in _BACKENDS:
|
||||||
|
return False
|
||||||
|
return _BACKENDS[name].is_available()
|
||||||
|
|
||||||
|
|
||||||
|
def enumerate_active_agents() -> list[ActiveAgent]:
|
||||||
|
"""All currently-running agents, across every available
|
||||||
|
backend. Used by CLI `list active` and the dashboard's agents
|
||||||
|
pane so neither has to know which backends exist. Skips
|
||||||
|
backends whose `is_available()` reports False.
|
||||||
|
|
||||||
|
Sorted by `(started_at, slug)` so the list is stable across
|
||||||
|
dashboard refresh ticks — agents don't shift position while
|
||||||
|
the operator navigates with arrow keys. ISO 8601 timestamps
|
||||||
|
sort lexicographically in chronological order; `slug` is the
|
||||||
|
deterministic tiebreaker. Agents with missing metadata
|
||||||
|
(`started_at == ""`) sort first."""
|
||||||
|
out: list[ActiveAgent] = []
|
||||||
|
for name in known_backend_names():
|
||||||
|
if not has_backend(name):
|
||||||
|
continue
|
||||||
|
out.extend(_BACKENDS[name].enumerate_active())
|
||||||
|
out.sort(key=lambda a: (a.started_at, a.slug))
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"ActiveAgent",
|
||||||
|
"Bottle",
|
||||||
|
"BottleBackend",
|
||||||
|
"BottleCleanupPlan",
|
||||||
|
"BottlePlan",
|
||||||
|
"BottleSpec",
|
||||||
|
"ExecResult",
|
||||||
|
"enumerate_active_agents",
|
||||||
|
"get_bottle_backend",
|
||||||
|
"has_backend",
|
||||||
|
"known_backend_names",
|
||||||
|
]
|
||||||
@@ -4,7 +4,6 @@ The bulk of the implementation lives in sibling modules:
|
|||||||
|
|
||||||
- util: thin Docker subprocess wrappers
|
- util: thin Docker subprocess wrappers
|
||||||
- network: Docker network plumbing
|
- network: Docker network plumbing
|
||||||
- pipelock: DockerPipelockProxy lifecycle
|
|
||||||
- bottle_plan: DockerBottlePlan
|
- bottle_plan: DockerBottlePlan
|
||||||
- bottle_cleanup_plan: DockerBottleCleanupPlan
|
- bottle_cleanup_plan: DockerBottleCleanupPlan
|
||||||
- bottle: DockerBottle handle
|
- bottle: DockerBottle handle
|
||||||
@@ -14,7 +13,7 @@ The bulk of the implementation lives in sibling modules:
|
|||||||
- backend: DockerBottleBackend façade wiring the above
|
- backend: DockerBottleBackend façade wiring the above
|
||||||
|
|
||||||
This file only re-exports the public names so
|
This file only re-exports the public names so
|
||||||
`from claude_bottle.backend.docker import DockerBottleBackend` keeps
|
`from bot_bottle.backend.docker import DockerBottleBackend` keeps
|
||||||
working.
|
working.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
"""DockerBottleBackend — the Docker implementation of BottleBackend.
|
||||||
|
|
||||||
|
This module is a thin façade. The real work lives in four siblings:
|
||||||
|
|
||||||
|
- resolve_plan.py — Docker-specific resolution into a DockerBottlePlan
|
||||||
|
- launch.py — bring-up + teardown context manager
|
||||||
|
- cleanup.py — orphan enumeration + removal
|
||||||
|
- enumerate.py — active-agent listing
|
||||||
|
|
||||||
|
The base class's `prepare` template runs cross-backend host-side
|
||||||
|
validation before calling `_resolve_plan` here.
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider provisioning steps (prompt, skills,
|
||||||
|
the declarative provision-plan apply, supervise MCP registration)
|
||||||
|
live on the `AgentProvider` plugin under `bot_bottle/contrib/`. The
|
||||||
|
Docker backend only owns the steps that are about backend
|
||||||
|
infrastructure: CA install and git copy-in.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import shutil
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Generator, Sequence
|
||||||
|
|
||||||
|
from ...supervise import SUPERVISE_HOSTNAME, SUPERVISE_PORT
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from .. import ActiveAgent, BottleBackend, BottleSpec
|
||||||
|
from . import cleanup as _cleanup
|
||||||
|
from . import enumerate as _enumerate
|
||||||
|
from . import launch as _launch
|
||||||
|
from . import resolve_plan as _resolve_plan
|
||||||
|
from .bottle import DockerBottle
|
||||||
|
from .bottle_cleanup_plan import DockerBottleCleanupPlan
|
||||||
|
from .bottle_plan import DockerBottlePlan
|
||||||
|
class DockerBottleBackend(BottleBackend["DockerBottlePlan", "DockerBottleCleanupPlan"]):
|
||||||
|
"""Docker backend implementation. Selected by BOT_BOTTLE_BACKEND
|
||||||
|
when set to `docker`; retained as a legacy/example backend."""
|
||||||
|
|
||||||
|
name = "docker"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def is_available(cls) -> bool:
|
||||||
|
"""`docker` on PATH is sufficient; we don't probe `docker info`
|
||||||
|
eagerly because the cross-backend enumerator runs this on
|
||||||
|
every `list active` and we'd pay a subprocess per call. A
|
||||||
|
broken daemon will surface its own error during prepare /
|
||||||
|
launch."""
|
||||||
|
return shutil.which("docker") is not None
|
||||||
|
|
||||||
|
def _preflight(self) -> None:
|
||||||
|
_resolve_plan.preflight()
|
||||||
|
|
||||||
|
def _build_guest_env(self, resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return _resolve_plan.build_guest_env(resolved_env)
|
||||||
|
|
||||||
|
def _resolve_plan(
|
||||||
|
self,
|
||||||
|
spec: BottleSpec,
|
||||||
|
*,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> DockerBottlePlan:
|
||||||
|
return _resolve_plan.resolve_plan(
|
||||||
|
spec,
|
||||||
|
slug=slug,
|
||||||
|
resolved_env=resolved_env,
|
||||||
|
agent_provision_plan=agent_provision_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(self, plan: DockerBottlePlan) -> Generator[DockerBottle, None, None]:
|
||||||
|
with _launch.launch(plan, provision=self.provision) as bottle:
|
||||||
|
yield bottle
|
||||||
|
|
||||||
|
def supervise_mcp_url(self, plan: DockerBottlePlan) -> str:
|
||||||
|
"""Docker bottles reach the supervise sidecar via the
|
||||||
|
compose-network alias `supervise:9100`. No per-bottle URL
|
||||||
|
plumbing needed; the alias resolves inside the bridge."""
|
||||||
|
if plan.supervise_plan is None:
|
||||||
|
return ""
|
||||||
|
return f"http://{SUPERVISE_HOSTNAME}:{SUPERVISE_PORT}/"
|
||||||
|
|
||||||
|
def prepare_cleanup(self) -> DockerBottleCleanupPlan:
|
||||||
|
return _cleanup.prepare_cleanup()
|
||||||
|
|
||||||
|
def cleanup(self, plan: DockerBottleCleanupPlan) -> None:
|
||||||
|
_cleanup.cleanup(plan)
|
||||||
|
|
||||||
|
def enumerate_active(self) -> Sequence[ActiveAgent]:
|
||||||
|
return _enumerate.enumerate_active()
|
||||||
@@ -1,17 +1,15 @@
|
|||||||
"""DockerBottle — concrete Bottle handle yielded by
|
"""DockerBottle — concrete Bottle handle yielded by DockerBottleBackend."""
|
||||||
DockerBottleBackend.launch.
|
|
||||||
|
|
||||||
Holds the container name plus the in-container prompt path so
|
|
||||||
exec_claude can transparently add --append-system-prompt-file when a
|
|
||||||
prompt was provisioned.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
from typing import Callable
|
from typing import Callable
|
||||||
|
|
||||||
|
from typing import cast
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode, prompt_args
|
||||||
from .. import Bottle, ExecResult
|
from .. import Bottle, ExecResult
|
||||||
|
from ..terminal import exec_shell_script
|
||||||
|
|
||||||
|
|
||||||
class DockerBottle(Bottle):
|
class DockerBottle(Bottle):
|
||||||
@@ -22,34 +20,46 @@ class DockerBottle(Bottle):
|
|||||||
container: str,
|
container: str,
|
||||||
teardown: Callable[[], None],
|
teardown: Callable[[], None],
|
||||||
prompt_path_in_container: str | None,
|
prompt_path_in_container: str | None,
|
||||||
|
*,
|
||||||
|
agent_command: str = "claude",
|
||||||
|
agent_prompt_mode: PromptMode = "append_file",
|
||||||
|
agent_provider_template: str = "claude",
|
||||||
|
terminal_title: str = "",
|
||||||
|
terminal_color: str = "",
|
||||||
|
agent_workdir: str = "/home/node",
|
||||||
):
|
):
|
||||||
self.name = container
|
self.name = container
|
||||||
self._teardown = teardown
|
self._teardown = teardown
|
||||||
self._prompt_path = prompt_path_in_container
|
self.prompt_path = prompt_path_in_container
|
||||||
|
self._agent_prompt_mode = agent_prompt_mode
|
||||||
|
self.agent_command = agent_command
|
||||||
|
self.terminal_title = terminal_title
|
||||||
|
self.terminal_color = terminal_color
|
||||||
|
self.agent_provider_template = agent_provider_template
|
||||||
|
self.agent_workdir = agent_workdir
|
||||||
self._closed = False
|
self._closed = False
|
||||||
|
|
||||||
def claude_docker_argv(
|
def agent_argv(
|
||||||
self, argv: list[str], *, tty: bool = True,
|
self, argv: list[str], *, tty: bool = True,
|
||||||
) -> list[str]:
|
) -> list[str]:
|
||||||
"""Return the full `docker exec` argv for running claude in
|
|
||||||
this bottle. Public so callers that want to spawn claude
|
|
||||||
somewhere other than the dashboard's foreground (e.g.,
|
|
||||||
`tmux split-window` / `tmux respawn-pane` from the dashboard
|
|
||||||
when `$TMUX` is set) can build on the same command without
|
|
||||||
duplicating the `--append-system-prompt-file` plumbing."""
|
|
||||||
full_argv = list(argv)
|
full_argv = list(argv)
|
||||||
if self._prompt_path:
|
full_argv.extend(
|
||||||
full_argv.extend(["--append-system-prompt-file", self._prompt_path])
|
prompt_args(cast(PromptMode, self._agent_prompt_mode), self.prompt_path, argv=full_argv)
|
||||||
|
)
|
||||||
cmd = ["docker", "exec"]
|
cmd = ["docker", "exec"]
|
||||||
if tty:
|
if tty:
|
||||||
cmd.append("-it")
|
cmd.append("-it")
|
||||||
cmd.extend([self.name, "claude", *full_argv])
|
if self.agent_workdir and self.agent_workdir != "/home/node":
|
||||||
|
cmd.extend(["-w", self.agent_workdir])
|
||||||
|
cmd.extend([self.name, self.agent_command, *full_argv])
|
||||||
return cmd
|
return cmd
|
||||||
|
|
||||||
def exec_claude(self, argv: list[str], *, tty: bool = True) -> int:
|
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int:
|
||||||
return subprocess.run(
|
agent_argv = self.agent_argv(argv, tty=tty)
|
||||||
self.claude_docker_argv(argv, tty=tty), check=False,
|
script = exec_shell_script(agent_argv, self.terminal_title, self.terminal_color) if tty else None
|
||||||
).returncode
|
if script is None:
|
||||||
|
return subprocess.run(agent_argv, check=False).returncode
|
||||||
|
return subprocess.run(["sh", "-lc", script], check=False).returncode
|
||||||
|
|
||||||
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
# Pipe via stdin to `sh -s` so the caller never has to worry
|
# Pipe via stdin to `sh -s` so the caller never has to worry
|
||||||
+2
-2
@@ -5,12 +5,12 @@ compose ls` is the source of truth for what's running; the plan
|
|||||||
carries the projects to `compose down`, plus three fallback buckets
|
carries the projects to `compose down`, plus three fallback buckets
|
||||||
for legacy / orphan resources:
|
for legacy / orphan resources:
|
||||||
|
|
||||||
- stray_containers: pre-compose `claude-bottle-*` containers not
|
- stray_containers: pre-compose `bot-bottle-*` containers not
|
||||||
attached to any compose project. Cleared via `docker rm -f`.
|
attached to any compose project. Cleared via `docker rm -f`.
|
||||||
- stray_networks: same idea for networks. Cleared via
|
- stray_networks: same idea for networks. Cleared via
|
||||||
`docker network rm`.
|
`docker network rm`.
|
||||||
- orphan_state_dirs: per-bottle state dirs under
|
- orphan_state_dirs: per-bottle state dirs under
|
||||||
~/.claude-bottle/state/ that have no live compose project AND
|
~/.bot-bottle/state/ that have no live compose project AND
|
||||||
no `.preserve` marker. Reaped via `shutil.rmtree`.
|
no `.preserve` marker. Reaped via `shutil.rmtree`.
|
||||||
|
|
||||||
Compose-managed networks are removed by `compose down --volumes`,
|
Compose-managed networks are removed by `compose down --volumes`,
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
"""DockerBottlePlan — concrete subclass of BottlePlan.
|
||||||
|
|
||||||
|
Carries the Docker-specific resolved fields produced by
|
||||||
|
DockerBottleBackend.prepare. The launch step consumes it without
|
||||||
|
further resolution; preflight rendering is inherited from BottlePlan.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode
|
||||||
|
from .. import BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class DockerBottlePlan(BottlePlan):
|
||||||
|
"""Docker-specific resolved fields produced by
|
||||||
|
DockerBottleBackend.prepare. Inherits `spec`, `stage_dir`,
|
||||||
|
`git_gate_plan`, `egress_plan`, `supervise_plan`, and
|
||||||
|
`agent_provision` from BottlePlan."""
|
||||||
|
|
||||||
|
slug: str
|
||||||
|
# name -> value for vars forwarded into the docker-run child process
|
||||||
|
# via subprocess env (so values never land on argv or in a file).
|
||||||
|
# repr=False keeps secret/interpolated/OAuth values out of any
|
||||||
|
# accidental log of the plan dataclass.
|
||||||
|
forwarded_env: dict[str, str] = field(repr=False)
|
||||||
|
use_runsc: bool
|
||||||
|
|
||||||
|
@property
|
||||||
|
def container_name(self) -> str:
|
||||||
|
return self.agent_provision.instance_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def image(self) -> str:
|
||||||
|
return self.agent_provision.image
|
||||||
|
|
||||||
|
@property
|
||||||
|
def dockerfile_path(self) -> str:
|
||||||
|
"""Absolute path to the Dockerfile that builds `image`. Sourced
|
||||||
|
from the agent provision plan — the manifest may override per
|
||||||
|
bottle; otherwise the provider plugin's bundled Dockerfile."""
|
||||||
|
return self.agent_provision.dockerfile
|
||||||
|
|
||||||
|
@property
|
||||||
|
def prompt_file(self) -> Path:
|
||||||
|
return self.agent_provision.prompt_file
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_command(self) -> str:
|
||||||
|
return self.agent_provision.command
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_prompt_mode(self) -> PromptMode:
|
||||||
|
return self.agent_provision.prompt_mode
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_provider_template(self) -> str:
|
||||||
|
return self.agent_provision.template
|
||||||
+10
-19
@@ -5,11 +5,11 @@ On approval of a capability-block proposal, the dashboard calls
|
|||||||
apply_capability_change(slug, new_dockerfile) which:
|
apply_capability_change(slug, new_dockerfile) which:
|
||||||
|
|
||||||
1. Snapshots the agent's transcript dir to
|
1. Snapshots the agent's transcript dir to
|
||||||
~/.claude-bottle/state/<slug>/transcript/ (best-effort).
|
~/.bot-bottle/state/<slug>/transcript/ (best-effort).
|
||||||
2. Pushes the agent's working tree via `git push` (best-effort —
|
2. Pushes the agent's working tree via `git push` (best-effort —
|
||||||
no upstream / no commits / no git repo all skip with a log).
|
no upstream / no commits / no git repo all skip with a log).
|
||||||
3. Writes the new Dockerfile to
|
3. Writes the new Dockerfile to
|
||||||
~/.claude-bottle/state/<slug>/Dockerfile (PRD 0016 Phase 1
|
~/.bot-bottle/state/<slug>/Dockerfile (PRD 0016 Phase 1
|
||||||
state). The next `cli.py start <agent>` picks it up.
|
state). The next `cli.py start <agent>` picks it up.
|
||||||
4. Force-removes the agent container + all sidecars + the
|
4. Force-removes the agent container + all sidecars + the
|
||||||
per-bottle networks. Idempotent — missing resources are not
|
per-bottle networks. Idempotent — missing resources are not
|
||||||
@@ -30,16 +30,14 @@ semantics open question.
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
|
from ...agent_provider import get_provider
|
||||||
from ...log import info, warn
|
from ...log import info, warn
|
||||||
from .bottle_state import (
|
from ...bottle_state import (
|
||||||
mark_preserved,
|
mark_preserved,
|
||||||
per_bottle_dockerfile,
|
per_bottle_dockerfile,
|
||||||
per_bottle_dockerfile_path,
|
|
||||||
transcript_snapshot_dir,
|
transcript_snapshot_dir,
|
||||||
write_per_bottle_dockerfile,
|
write_per_bottle_dockerfile,
|
||||||
)
|
)
|
||||||
@@ -55,7 +53,7 @@ _AGENT_WORKSPACE_IN_CONTAINER = f"{_AGENT_HOME_IN_CONTAINER}/workspace"
|
|||||||
|
|
||||||
# Per-bottle resource name patterns (mirroring prepare.py).
|
# Per-bottle resource name patterns (mirroring prepare.py).
|
||||||
def _agent_container_name(slug: str) -> str:
|
def _agent_container_name(slug: str) -> str:
|
||||||
return f"claude-bottle-{slug}"
|
return f"bot-bottle-{slug}"
|
||||||
|
|
||||||
|
|
||||||
def _per_bottle_container_names(slug: str) -> list[str]:
|
def _per_bottle_container_names(slug: str) -> list[str]:
|
||||||
@@ -70,8 +68,8 @@ def _per_bottle_container_names(slug: str) -> list[str]:
|
|||||||
|
|
||||||
def _per_bottle_network_names(slug: str) -> list[str]:
|
def _per_bottle_network_names(slug: str) -> list[str]:
|
||||||
return [
|
return [
|
||||||
f"claude-bottle-net-{slug}",
|
f"bot-bottle-net-{slug}",
|
||||||
f"claude-bottle-egress-{slug}",
|
f"bot-bottle-egress-{slug}",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
@@ -95,11 +93,11 @@ def fetch_current_dockerfile(slug: str) -> str:
|
|||||||
override = per_bottle_dockerfile(slug)
|
override = per_bottle_dockerfile(slug)
|
||||||
if override is not None:
|
if override is not None:
|
||||||
return override
|
return override
|
||||||
repo_dockerfile = _repo_dockerfile_path()
|
repo_dockerfile = get_provider("claude").dockerfile
|
||||||
if repo_dockerfile.is_file():
|
if repo_dockerfile.is_file():
|
||||||
return repo_dockerfile.read_text()
|
return repo_dockerfile.read_text()
|
||||||
raise CapabilityApplyError(
|
raise CapabilityApplyError(
|
||||||
f"no per-bottle Dockerfile for {slug} and no repo Dockerfile at "
|
f"no per-bottle Dockerfile for {slug} and no provider Dockerfile at "
|
||||||
f"{repo_dockerfile}"
|
f"{repo_dockerfile}"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -127,17 +125,10 @@ def apply_capability_change(slug: str, new_dockerfile: str) -> tuple[str, str]:
|
|||||||
# --- Internals -------------------------------------------------------------
|
# --- Internals -------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
def _repo_dockerfile_path() -> Path:
|
|
||||||
"""Path to the repo's Dockerfile (one dir above this module's
|
|
||||||
package root). Resolved at call time so the path is correct
|
|
||||||
regardless of where this module is imported from."""
|
|
||||||
# claude_bottle/backend/docker/capability_apply.py -> repo root
|
|
||||||
return Path(__file__).resolve().parent.parent.parent.parent / "Dockerfile"
|
|
||||||
|
|
||||||
|
|
||||||
def snapshot_transcript(slug: str) -> None:
|
def snapshot_transcript(slug: str) -> None:
|
||||||
"""`docker cp` /home/node/.claude out of the agent container into
|
"""`docker cp` /home/node/.claude out of the agent container into
|
||||||
~/.claude-bottle/state/<slug>/transcript/. Best-effort: missing
|
~/.bot-bottle/state/<slug>/transcript/. Best-effort: missing
|
||||||
container, missing dir, or cp error all log a warning and return.
|
container, missing dir, or cp error all log a warning and return.
|
||||||
The transcript is what `claude --resume` reads to pick up where
|
The transcript is what `claude --resume` reads to pick up where
|
||||||
the agent left off.
|
the agent left off.
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
"""Cleanup + active-listing for the Docker bottle backend.
|
"""Cleanup for the Docker bottle backend.
|
||||||
|
|
||||||
PRD 0018 chunk 4: cleanup is centered on `docker compose ls`.
|
PRD 0018 chunk 4: cleanup is centered on `docker compose ls`.
|
||||||
Pre-compose code paths could leave bare containers / networks
|
Pre-compose code paths could leave bare containers / networks
|
||||||
@@ -7,19 +7,19 @@ scan, just as a fallback bucket alongside the project list.
|
|||||||
|
|
||||||
`prepare_cleanup` enumerates:
|
`prepare_cleanup` enumerates:
|
||||||
|
|
||||||
- Live compose projects whose name starts with `claude-bottle-`.
|
- Live compose projects whose name starts with `bot-bottle-`.
|
||||||
- `claude-bottle-*` containers that aren't part of any compose
|
- `bot-bottle-*` containers that aren't part of any compose
|
||||||
project (legacy orphans).
|
project (legacy orphans).
|
||||||
- `claude-bottle-*` networks that aren't tied to a compose
|
- `bot-bottle-*` networks that aren't tied to a compose
|
||||||
project (legacy orphans; compose-managed networks come down
|
project (legacy orphans; compose-managed networks come down
|
||||||
with `compose down --volumes` and don't appear here).
|
with `compose down --volumes` and don't appear here).
|
||||||
- State dirs under ~/.claude-bottle/state/<identity>/ with no
|
- State dirs under ~/.bot-bottle/state/<identity>/ with no
|
||||||
live compose project AND no `.preserve` marker.
|
live compose project AND no `.preserve` marker.
|
||||||
|
|
||||||
`cleanup` removes everything in the plan.
|
`cleanup` removes everything in the plan.
|
||||||
|
|
||||||
`list_active` queries the same compose project namespace and prints
|
Active-agent enumeration lives in `backend/docker/enumerate.py`
|
||||||
each project's services for ad-hoc inspection.
|
(mirror of `backend/smolmachines/enumerate.py`).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -29,20 +29,14 @@ import subprocess
|
|||||||
|
|
||||||
from ... import supervise as _supervise
|
from ... import supervise as _supervise
|
||||||
from ...log import info, warn
|
from ...log import info, warn
|
||||||
from .. import ActiveBottle
|
|
||||||
from . import util as docker_mod
|
from . import util as docker_mod
|
||||||
from .bottle_cleanup_plan import DockerBottleCleanupPlan
|
from .bottle_cleanup_plan import DockerBottleCleanupPlan
|
||||||
from .bottle_state import bottle_state_dir, is_preserved, read_metadata
|
from ...bottle_state import bottle_state_dir, is_preserved
|
||||||
from .compose import (
|
from .compose import COMPOSE_PROJECT_PREFIX, list_compose_projects
|
||||||
COMPOSE_PROJECT_PREFIX,
|
|
||||||
compose_project_name,
|
|
||||||
list_active_slugs,
|
|
||||||
list_compose_projects,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _list_prefixed_containers() -> list[str]:
|
def _list_prefixed_containers() -> list[str]:
|
||||||
"""All claude-bottle-prefixed containers, running or stopped."""
|
"""All bot-bottle-prefixed containers, running or stopped."""
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["docker", "ps", "-a",
|
["docker", "ps", "-a",
|
||||||
"--filter", f"name=^{COMPOSE_PROJECT_PREFIX}",
|
"--filter", f"name=^{COMPOSE_PROJECT_PREFIX}",
|
||||||
@@ -66,7 +60,7 @@ def _list_prefixed_containers() -> list[str]:
|
|||||||
|
|
||||||
|
|
||||||
def _list_prefixed_networks() -> list[str]:
|
def _list_prefixed_networks() -> list[str]:
|
||||||
"""All claude-bottle-prefixed networks not currently attached
|
"""All bot-bottle-prefixed networks not currently attached
|
||||||
to a compose project. Compose-managed networks have a
|
to a compose project. Compose-managed networks have a
|
||||||
`com.docker.compose.project` label; bare ones (from pre-compose
|
`com.docker.compose.project` label; bare ones (from pre-compose
|
||||||
code paths) don't."""
|
code paths) don't."""
|
||||||
@@ -89,12 +83,19 @@ def _list_prefixed_networks() -> list[str]:
|
|||||||
return sorted(set(out))
|
return sorted(set(out))
|
||||||
|
|
||||||
|
|
||||||
def _list_orphan_state_dirs(live_projects: set[str]) -> list[str]:
|
def _list_orphan_state_dirs(
|
||||||
|
live_projects: set[str], protected_identities: set[str],
|
||||||
|
) -> list[str]:
|
||||||
"""State identities whose compose project isn't running and
|
"""State identities whose compose project isn't running and
|
||||||
that don't have a `.preserve` marker. `.preserve` means the
|
that don't have a `.preserve` marker. `.preserve` means the
|
||||||
user (or an auto-preserve-on-crash) wants the state kept for
|
user (or an auto-preserve-on-crash) wants the state kept for
|
||||||
`resume`."""
|
`resume`.
|
||||||
state_root = _supervise.claude_bottle_root() / "state"
|
|
||||||
|
`protected_identities` is the set of slugs that are live in
|
||||||
|
ANY backend — used so this docker-side check doesn't reap a
|
||||||
|
running smolmachines bottle's state dir (the layout is shared
|
||||||
|
across both backends)."""
|
||||||
|
state_root = _supervise.bot_bottle_root() / "state"
|
||||||
if not state_root.is_dir():
|
if not state_root.is_dir():
|
||||||
return []
|
return []
|
||||||
orphans: list[str] = []
|
orphans: list[str] = []
|
||||||
@@ -105,6 +106,8 @@ def _list_orphan_state_dirs(live_projects: set[str]) -> list[str]:
|
|||||||
project = f"{COMPOSE_PROJECT_PREFIX}{identity}"
|
project = f"{COMPOSE_PROJECT_PREFIX}{identity}"
|
||||||
if project in live_projects:
|
if project in live_projects:
|
||||||
continue
|
continue
|
||||||
|
if identity in protected_identities:
|
||||||
|
continue
|
||||||
if is_preserved(identity):
|
if is_preserved(identity):
|
||||||
continue
|
continue
|
||||||
orphans.append(identity)
|
orphans.append(identity)
|
||||||
@@ -112,15 +115,25 @@ def _list_orphan_state_dirs(live_projects: set[str]) -> list[str]:
|
|||||||
|
|
||||||
|
|
||||||
def prepare_cleanup() -> DockerBottleCleanupPlan:
|
def prepare_cleanup() -> DockerBottleCleanupPlan:
|
||||||
"""Enumerate everything cleanup will touch. No removals."""
|
"""Enumerate everything cleanup will touch. No removals.
|
||||||
|
|
||||||
|
Pulls the union of live identities across backends via
|
||||||
|
`enumerate_active_agents()` so the orphan-state-dir bucket
|
||||||
|
doesn't include slugs whose smolmachines VM is still up."""
|
||||||
docker_mod.require_docker()
|
docker_mod.require_docker()
|
||||||
projects = list_compose_projects()
|
projects = list_compose_projects()
|
||||||
project_set = set(projects)
|
project_set = set(projects)
|
||||||
|
# Late import to avoid a circular at module-load time —
|
||||||
|
# the backend package's __init__ imports this module.
|
||||||
|
from .. import enumerate_active_agents
|
||||||
|
protected = {a.slug for a in enumerate_active_agents()}
|
||||||
return DockerBottleCleanupPlan(
|
return DockerBottleCleanupPlan(
|
||||||
projects=tuple(projects),
|
projects=tuple(projects),
|
||||||
stray_containers=tuple(_list_prefixed_containers()),
|
stray_containers=tuple(_list_prefixed_containers()),
|
||||||
stray_networks=tuple(_list_prefixed_networks()),
|
stray_networks=tuple(_list_prefixed_networks()),
|
||||||
orphan_state_dirs=tuple(_list_orphan_state_dirs(project_set)),
|
orphan_state_dirs=tuple(
|
||||||
|
_list_orphan_state_dirs(project_set, protected),
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -165,69 +178,3 @@ def cleanup(plan: DockerBottleCleanupPlan) -> None:
|
|||||||
shutil.rmtree(path, ignore_errors=True)
|
shutil.rmtree(path, ignore_errors=True)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
warn(f"failed to remove {path}: {e}")
|
warn(f"failed to remove {path}: {e}")
|
||||||
|
|
||||||
|
|
||||||
def enumerate_active() -> list[ActiveBottle]:
|
|
||||||
"""All currently-running docker-backed bottles as
|
|
||||||
`ActiveBottle` records. Backend-agnostic shape — the CLI
|
|
||||||
`list active` command and the dashboard agents pane both
|
|
||||||
consume this. Empty list when docker is unreachable or
|
|
||||||
nothing's running."""
|
|
||||||
# docker on PATH? Defensive — `list active` shouldn't die
|
|
||||||
# just because the docker backend isn't usable on this host.
|
|
||||||
if shutil.which("docker") is None:
|
|
||||||
return []
|
|
||||||
slugs = list_active_slugs(include_stopped=False)
|
|
||||||
if not slugs:
|
|
||||||
return []
|
|
||||||
services_by_project = _query_services_by_project()
|
|
||||||
out: list[ActiveBottle] = []
|
|
||||||
for slug in slugs:
|
|
||||||
project = compose_project_name(slug)
|
|
||||||
services = services_by_project.get(project, set())
|
|
||||||
metadata = read_metadata(slug)
|
|
||||||
out.append(ActiveBottle(
|
|
||||||
backend_name="docker",
|
|
||||||
slug=slug,
|
|
||||||
agent_name=metadata.agent_name if metadata else "?",
|
|
||||||
started_at=metadata.started_at if metadata else "",
|
|
||||||
services=tuple(sorted(services)),
|
|
||||||
))
|
|
||||||
return out
|
|
||||||
|
|
||||||
|
|
||||||
def _parse_services_by_project(stdout: str) -> dict[str, set[str]]:
|
|
||||||
"""Parse `docker ps` output formatted as
|
|
||||||
`<project-label>\\t<service-label>` (one line per container)
|
|
||||||
into a `{project: {service, ...}}` mapping. Pure function for
|
|
||||||
testing — the docker invocation is in `_query_services_by_project`."""
|
|
||||||
out: dict[str, set[str]] = {}
|
|
||||||
for line in stdout.splitlines():
|
|
||||||
project, _, service = line.partition("\t")
|
|
||||||
if not project or not service:
|
|
||||||
continue
|
|
||||||
out.setdefault(project, set()).add(service)
|
|
||||||
return out
|
|
||||||
|
|
||||||
|
|
||||||
def _query_services_by_project() -> dict[str, set[str]]:
|
|
||||||
"""One `docker ps` call → `{project: {service, ...}}`. Moved
|
|
||||||
here from the dashboard so the same query backs the CLI's
|
|
||||||
`list active` and the dashboard's agents pane."""
|
|
||||||
try:
|
|
||||||
r = subprocess.run(
|
|
||||||
[
|
|
||||||
"docker", "ps",
|
|
||||||
"--filter", "label=com.docker.compose.project",
|
|
||||||
"--format",
|
|
||||||
'{{.Label "com.docker.compose.project"}}'
|
|
||||||
"\t"
|
|
||||||
'{{.Label "com.docker.compose.service"}}',
|
|
||||||
],
|
|
||||||
capture_output=True, text=True, check=False,
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return {}
|
|
||||||
if r.returncode != 0:
|
|
||||||
return {}
|
|
||||||
return _parse_services_by_project(r.stdout or "")
|
|
||||||
@@ -7,34 +7,14 @@ two networks, no named volumes.
|
|||||||
|
|
||||||
Pure function. No I/O, no subprocess. Expects every launch-time
|
Pure function. No I/O, no subprocess. Expects every launch-time
|
||||||
field (network names, CA host paths, etc.) on the plan's inner
|
field (network names, CA host paths, etc.) on the plan's inner
|
||||||
plans to be populated; chunks 2+3 own that ordering. Chunk 1 just
|
plans to be populated; chunks 2+3 own that ordering.
|
||||||
encodes the translation so it can be unit-tested in isolation.
|
|
||||||
|
|
||||||
Conditional services follow the plan content (matches the
|
Conditional services follow the plan content:
|
||||||
SDK-call branching in `launch.py` today):
|
|
||||||
|
|
||||||
- pipelock + agent: always.
|
- agent + sidecars bundle: always.
|
||||||
- git-gate: iff plan.git_gate_plan.upstreams.
|
- git-gate: iff plan.git_gate_plan.upstreams.
|
||||||
- egress: iff plan.egress_plan.routes.
|
- egress: iff plan.egress_plan.routes.
|
||||||
- supervise: iff plan.supervise_plan is not None.
|
- supervise: iff plan.supervise_plan is not None.
|
||||||
|
|
||||||
Naming:
|
|
||||||
|
|
||||||
- Compose project: `claude-bottle-<slug>`.
|
|
||||||
- Service names (inside the file): `agent`, `pipelock`,
|
|
||||||
`egress`, `git-gate`, `supervise`.
|
|
||||||
- `container_name:` matches today's pattern
|
|
||||||
(`claude-bottle-<service>-<slug>`) so dashboard/cleanup discovery
|
|
||||||
via the prefix scan keeps working through the transition.
|
|
||||||
- Network aliases preserve the current dial-by-shortname pattern
|
|
||||||
for `egress` / `supervise`, and add the long container-name as
|
|
||||||
an internal-network alias for `pipelock` / `git-gate` so any
|
|
||||||
caller still referencing the long name resolves.
|
|
||||||
|
|
||||||
Sidecars that are built (egress, git-gate, supervise) get a
|
|
||||||
compose `build:` block pointing at the repo Dockerfile; the
|
|
||||||
`image:` tag is set explicitly so cached images on the daemon
|
|
||||||
aren't rebuilt on every up.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -49,9 +29,8 @@ from ...egress import (
|
|||||||
EGRESS_HOSTNAME,
|
EGRESS_HOSTNAME,
|
||||||
EGRESS_ROUTES_IN_CONTAINER,
|
EGRESS_ROUTES_IN_CONTAINER,
|
||||||
)
|
)
|
||||||
from ...git_gate import GIT_GATE_HOSTNAME, git_gate_aggregate_extra_hosts
|
from ...git_gate import GIT_GATE_HOSTNAME
|
||||||
from ...log import die, warn
|
from ...log import die, warn
|
||||||
from ...pipelock import PIPELOCK_HOSTNAME
|
|
||||||
from ...supervise import (
|
from ...supervise import (
|
||||||
CURRENT_CONFIG_DIR_IN_AGENT,
|
CURRENT_CONFIG_DIR_IN_AGENT,
|
||||||
QUEUE_DIR_IN_CONTAINER,
|
QUEUE_DIR_IN_CONTAINER,
|
||||||
@@ -59,10 +38,11 @@ from ...supervise import (
|
|||||||
SUPERVISE_PORT,
|
SUPERVISE_PORT,
|
||||||
)
|
)
|
||||||
from ...util import expand_tilde
|
from ...util import expand_tilde
|
||||||
|
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
||||||
from .bottle_plan import DockerBottlePlan
|
from .bottle_plan import DockerBottlePlan
|
||||||
from .egress import (
|
from .egress import (
|
||||||
EGRESS_CA_IN_CONTAINER,
|
EGRESS_CA_IN_CONTAINER,
|
||||||
EGRESS_PIPELOCK_CA_IN_CONTAINER,
|
EGRESS_PORT,
|
||||||
)
|
)
|
||||||
from .git_gate import (
|
from .git_gate import (
|
||||||
GIT_GATE_ACCESS_HOOK_IN_CONTAINER,
|
GIT_GATE_ACCESS_HOOK_IN_CONTAINER,
|
||||||
@@ -70,12 +50,7 @@ from .git_gate import (
|
|||||||
GIT_GATE_ENTRYPOINT_IN_CONTAINER,
|
GIT_GATE_ENTRYPOINT_IN_CONTAINER,
|
||||||
GIT_GATE_HOOK_IN_CONTAINER,
|
GIT_GATE_HOOK_IN_CONTAINER,
|
||||||
)
|
)
|
||||||
from .pipelock import (
|
from . import network as network_mod
|
||||||
PIPELOCK_CA_CERT_IN_CONTAINER,
|
|
||||||
PIPELOCK_CA_KEY_IN_CONTAINER,
|
|
||||||
PIPELOCK_PORT,
|
|
||||||
)
|
|
||||||
from .provision.ca import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
|
||||||
from .sidecar_bundle import (
|
from .sidecar_bundle import (
|
||||||
SIDECAR_BUNDLE_DOCKERFILE,
|
SIDECAR_BUNDLE_DOCKERFILE,
|
||||||
SIDECAR_BUNDLE_IMAGE,
|
SIDECAR_BUNDLE_IMAGE,
|
||||||
@@ -91,14 +66,13 @@ def bottle_plan_to_compose(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
"""Render a Compose v2 spec dict from a fully-resolved
|
"""Render a Compose v2 spec dict from a fully-resolved
|
||||||
DockerBottlePlan.
|
DockerBottlePlan.
|
||||||
|
|
||||||
The plan must have its inner plans (`proxy_plan`,
|
The plan must have its inner plans (`git_gate_plan`,
|
||||||
`git_gate_plan`, `egress_plan`, `supervise_plan`) populated
|
`egress_plan`, `supervise_plan`) populated with launch-time
|
||||||
with launch-time fields — network names, CA host paths,
|
fields — network names, CA host paths. The renderer doesn't
|
||||||
pipelock_proxy_url. The renderer doesn't validate; callers
|
validate; callers feed it a fully-resolved plan or get an
|
||||||
feed it a fully-resolved plan or get an incomplete compose
|
incomplete compose spec back.
|
||||||
spec back.
|
|
||||||
"""
|
"""
|
||||||
project = f"claude-bottle-{plan.slug}"
|
project = f"bot-bottle-{plan.slug}"
|
||||||
services: dict[str, Any] = {
|
services: dict[str, Any] = {
|
||||||
"sidecars": _sidecar_bundle_service(plan),
|
"sidecars": _sidecar_bundle_service(plan),
|
||||||
"agent": _agent_service(plan),
|
"agent": _agent_service(plan),
|
||||||
@@ -118,11 +92,11 @@ def _networks(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
bridge."""
|
bridge."""
|
||||||
return {
|
return {
|
||||||
"internal": {
|
"internal": {
|
||||||
"name": plan.proxy_plan.internal_network,
|
"name": network_mod.network_name_for_slug(plan.slug),
|
||||||
"internal": True,
|
"internal": True,
|
||||||
},
|
},
|
||||||
"egress": {
|
"egress": {
|
||||||
"name": plan.proxy_plan.egress_network,
|
"name": network_mod.network_egress_name_for_slug(plan.slug),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -142,63 +116,29 @@ def _bind(host: str | Path, target: str, *, read_only: bool = True) -> dict[str,
|
|||||||
|
|
||||||
def _sidecar_bundle_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
def _sidecar_bundle_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
||||||
"""The `sidecars` service: one container per bottle, bundle
|
"""The `sidecars` service: one container per bottle, bundle
|
||||||
image, all four daemons under a Python init supervisor.
|
image, all daemons under a Python init supervisor.
|
||||||
|
|
||||||
Mechanics:
|
Daemon subset narrows via `BOT_BOTTLE_SIDECAR_DAEMONS` env.
|
||||||
|
egress is always present; git-gate / supervise are conditional.
|
||||||
- Daemon subset narrows via `CLAUDE_BOTTLE_SIDECAR_DAEMONS`
|
|
||||||
env. pipelock is always present; egress / git-gate /
|
|
||||||
supervise are conditional on the plan.
|
|
||||||
- Volumes are the union of the four daemons' bind-mounts,
|
|
||||||
preserving the same in-container paths so each daemon
|
|
||||||
finds its config / hooks / CA where it expects.
|
|
||||||
- Environment is the union of *daemon-private* env vars
|
|
||||||
(EGRESS_UPSTREAM_PROXY, SUPERVISE_BOTTLE_SLUG, etc).
|
|
||||||
HTTPS_PROXY is NOT propagated here — see the comment in
|
|
||||||
egress_entrypoint.sh; setting it at the container level
|
|
||||||
would route git-gate's git fetches through pipelock,
|
|
||||||
which is wrong.
|
|
||||||
- Network aliases register every legacy short/long
|
|
||||||
hostname (pipelock, egress, git-gate, supervise plus
|
|
||||||
their `claude-bottle-<service>-<slug>` long forms) so
|
|
||||||
the agent's HTTPS_PROXY URL and any other inter-service
|
|
||||||
reference resolves to the bundle.
|
|
||||||
"""
|
"""
|
||||||
daemons: list[str] = ["egress", "pipelock"]
|
daemons: list[str] = ["egress"]
|
||||||
if plan.git_gate_plan.upstreams:
|
if plan.git_gate_plan.upstreams:
|
||||||
daemons.append("git-gate")
|
daemons.append("git-gate")
|
||||||
if plan.supervise_plan is not None:
|
if plan.supervise_plan is not None:
|
||||||
daemons.append("supervise")
|
daemons.append("supervise")
|
||||||
|
|
||||||
env: list[str] = [f"CLAUDE_BOTTLE_SIDECAR_DAEMONS={','.join(daemons)}"]
|
env: list[str] = [f"BOT_BOTTLE_SIDECAR_DAEMONS={','.join(daemons)}"]
|
||||||
volumes: list[dict[str, Any]] = []
|
volumes: list[dict[str, Any]] = []
|
||||||
|
|
||||||
# --- pipelock ----------------------------------------------------
|
# --- egress -------------------------------------------------------
|
||||||
pp = plan.proxy_plan
|
|
||||||
volumes += [
|
|
||||||
_bind(pp.yaml_path, "/etc/pipelock.yaml"),
|
|
||||||
_bind(pp.ca_cert_host_path, PIPELOCK_CA_CERT_IN_CONTAINER),
|
|
||||||
_bind(pp.ca_key_host_path, PIPELOCK_CA_KEY_IN_CONTAINER),
|
|
||||||
]
|
|
||||||
|
|
||||||
# --- egress (always part of the bundle; the EGRESS_UPSTREAM_*
|
|
||||||
# env vars + ca bind-mounts are needed iff routes exist; when
|
|
||||||
# the bottle has no routes the egress daemon falls back to its
|
|
||||||
# `regular@9099` mode and is unused) -----------------------------
|
|
||||||
ep = plan.egress_plan
|
ep = plan.egress_plan
|
||||||
|
volumes.append(_bind(ep.mitmproxy_ca_host_path, EGRESS_CA_IN_CONTAINER))
|
||||||
if ep.routes:
|
if ep.routes:
|
||||||
env.append(f"EGRESS_UPSTREAM_PROXY={ep.pipelock_proxy_url}")
|
volumes.append(_bind(ep.routes_path, EGRESS_ROUTES_IN_CONTAINER))
|
||||||
env.append(f"EGRESS_UPSTREAM_CA={EGRESS_PIPELOCK_CA_IN_CONTAINER}")
|
|
||||||
volumes += [
|
|
||||||
_bind(ep.routes_path, EGRESS_ROUTES_IN_CONTAINER),
|
|
||||||
_bind(ep.mitmproxy_ca_host_path, EGRESS_CA_IN_CONTAINER),
|
|
||||||
_bind(ep.pipelock_ca_host_path, EGRESS_PIPELOCK_CA_IN_CONTAINER),
|
|
||||||
]
|
|
||||||
for token_env in sorted(ep.token_env_map.keys()):
|
for token_env in sorted(ep.token_env_map.keys()):
|
||||||
env.append(token_env)
|
env.append(token_env)
|
||||||
|
|
||||||
# --- git-gate ----------------------------------------------------
|
# --- git-gate -----------------------------------------------------
|
||||||
extra_hosts: list[str] = []
|
|
||||||
gp = plan.git_gate_plan
|
gp = plan.git_gate_plan
|
||||||
if gp.upstreams:
|
if gp.upstreams:
|
||||||
volumes += [
|
volumes += [
|
||||||
@@ -212,10 +152,13 @@ def _sidecar_bundle_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
keypath,
|
keypath,
|
||||||
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{u.name}-key",
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{u.name}-key",
|
||||||
))
|
))
|
||||||
extra_map = git_gate_aggregate_extra_hosts(gp.upstreams)
|
if u.known_hosts_file:
|
||||||
extra_hosts = [f"{host}:{ip}" for host, ip in sorted(extra_map.items())]
|
volumes.append(_bind(
|
||||||
|
u.known_hosts_file,
|
||||||
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{u.name}-known_hosts",
|
||||||
|
))
|
||||||
|
|
||||||
# --- supervise ---------------------------------------------------
|
# --- supervise ----------------------------------------------------
|
||||||
sp = plan.supervise_plan
|
sp = plan.supervise_plan
|
||||||
if sp is not None:
|
if sp is not None:
|
||||||
env += [
|
env += [
|
||||||
@@ -230,13 +173,7 @@ def _sidecar_bundle_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
"read_only": False,
|
"read_only": False,
|
||||||
})
|
})
|
||||||
|
|
||||||
# Internal-network aliases: the agent reaches each daemon through
|
internal_aliases = [EGRESS_HOSTNAME]
|
||||||
# its short name (pipelock / egress / git-gate / supervise) which
|
|
||||||
# the bundle answers as if it were the daemon itself.
|
|
||||||
internal_aliases = [
|
|
||||||
PIPELOCK_HOSTNAME,
|
|
||||||
EGRESS_HOSTNAME,
|
|
||||||
]
|
|
||||||
if gp.upstreams:
|
if gp.upstreams:
|
||||||
internal_aliases.append(GIT_GATE_HOSTNAME)
|
internal_aliases.append(GIT_GATE_HOSTNAME)
|
||||||
if sp is not None:
|
if sp is not None:
|
||||||
@@ -256,18 +193,13 @@ def _sidecar_bundle_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
"environment": env,
|
"environment": env,
|
||||||
"volumes": volumes,
|
"volumes": volumes,
|
||||||
}
|
}
|
||||||
if extra_hosts:
|
|
||||||
service["extra_hosts"] = extra_hosts
|
|
||||||
return service
|
return service
|
||||||
|
|
||||||
|
|
||||||
def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
||||||
"""Agent container. Runs `sleep infinity`; claude is `docker
|
"""Agent container. Runs `sleep infinity`; claude is `docker
|
||||||
exec -it`'d into it later. No TTY at the container level —
|
exec -it`'d into it later. HTTP_PROXY/HTTPS_PROXY point at the
|
||||||
interactivity is per-exec. HTTP_PROXY/HTTPS_PROXY point at the
|
egress sidecar."""
|
||||||
egress short-alias when an egress is declared, otherwise
|
|
||||||
straight at pipelock's container name. CA trust trio matches
|
|
||||||
the existing launch.py wiring."""
|
|
||||||
proxy_url = _agent_proxy_url(plan)
|
proxy_url = _agent_proxy_url(plan)
|
||||||
no_proxy = _agent_no_proxy(plan)
|
no_proxy = _agent_no_proxy(plan)
|
||||||
env: list[str] = [
|
env: list[str] = [
|
||||||
@@ -281,6 +213,8 @@ def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
f"SSL_CERT_FILE={AGENT_CA_BUNDLE}",
|
f"SSL_CERT_FILE={AGENT_CA_BUNDLE}",
|
||||||
f"REQUESTS_CA_BUNDLE={AGENT_CA_BUNDLE}",
|
f"REQUESTS_CA_BUNDLE={AGENT_CA_BUNDLE}",
|
||||||
]
|
]
|
||||||
|
for name, value in sorted(plan.agent_provision.guest_env.items()):
|
||||||
|
env.append(f"{name}={value}")
|
||||||
# Forwarded vars (OAuth token, manifest host-interpolations):
|
# Forwarded vars (OAuth token, manifest host-interpolations):
|
||||||
# bare name → inherits from compose-up process env, value
|
# bare name → inherits from compose-up process env, value
|
||||||
# never lands on argv or in the compose file.
|
# never lands on argv or in the compose file.
|
||||||
@@ -288,7 +222,7 @@ def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
env.append(name)
|
env.append(name)
|
||||||
|
|
||||||
service: dict[str, Any] = {
|
service: dict[str, Any] = {
|
||||||
"image": plan.runtime_image,
|
"image": plan.image,
|
||||||
"container_name": plan.container_name,
|
"container_name": plan.container_name,
|
||||||
"command": ["sleep", "infinity"],
|
"command": ["sleep", "infinity"],
|
||||||
"networks": {"internal": None},
|
"networks": {"internal": None},
|
||||||
@@ -296,8 +230,6 @@ def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
}
|
}
|
||||||
if plan.use_runsc:
|
if plan.use_runsc:
|
||||||
service["runtime"] = "runsc"
|
service["runtime"] = "runsc"
|
||||||
if plan.env_file and plan.env_file.exists() and plan.env_file.stat().st_size > 0:
|
|
||||||
service["env_file"] = [str(plan.env_file)]
|
|
||||||
|
|
||||||
volumes: list[dict[str, Any]] = []
|
volumes: list[dict[str, Any]] = []
|
||||||
if plan.supervise_plan is not None:
|
if plan.supervise_plan is not None:
|
||||||
@@ -317,21 +249,14 @@ def _agent_service(plan: DockerBottlePlan) -> dict[str, Any]:
|
|||||||
|
|
||||||
|
|
||||||
def _agent_proxy_url(plan: DockerBottlePlan) -> str:
|
def _agent_proxy_url(plan: DockerBottlePlan) -> str:
|
||||||
"""Pick the agent's HTTP_PROXY. With egress declared, the agent
|
"""Agent's HTTP_PROXY — always points at egress."""
|
||||||
goes through egress (which in turn HTTPS_PROXYs to pipelock on
|
return f"http://{EGRESS_HOSTNAME}:{EGRESS_PORT}"
|
||||||
its outbound leg). Without egress, the agent talks straight to
|
|
||||||
pipelock."""
|
|
||||||
if plan.egress_plan.routes:
|
|
||||||
from .egress import EGRESS_PORT
|
|
||||||
return f"http://{EGRESS_HOSTNAME}:{EGRESS_PORT}"
|
|
||||||
return f"http://{PIPELOCK_HOSTNAME}:{PIPELOCK_PORT}"
|
|
||||||
|
|
||||||
|
|
||||||
def _agent_no_proxy(plan: DockerBottlePlan) -> str:
|
def _agent_no_proxy(plan: DockerBottlePlan) -> str:
|
||||||
"""NO_PROXY for the agent. Matches the launch.py rules:
|
"""NO_PROXY for the agent: loopback always; supervise hostname
|
||||||
loopback always, supervise hostname when the supervise sidecar
|
when the supervise sidecar is up (MCP long-poll must bypass
|
||||||
is up (the MCP long-poll pattern needs to bypass pipelock's
|
the egress proxy)."""
|
||||||
idle timeout)."""
|
|
||||||
hosts = ["localhost", "127.0.0.1"]
|
hosts = ["localhost", "127.0.0.1"]
|
||||||
if plan.supervise_plan is not None:
|
if plan.supervise_plan is not None:
|
||||||
hosts.append(SUPERVISE_HOSTNAME)
|
hosts.append(SUPERVISE_HOSTNAME)
|
||||||
@@ -351,7 +276,7 @@ COMPOSE_FILE_NAME = "docker-compose.yml"
|
|||||||
COMPOSE_LOG_NAME = "compose.log"
|
COMPOSE_LOG_NAME = "compose.log"
|
||||||
|
|
||||||
|
|
||||||
COMPOSE_PROJECT_PREFIX = "claude-bottle-"
|
COMPOSE_PROJECT_PREFIX = "bot-bottle-"
|
||||||
|
|
||||||
|
|
||||||
def compose_project_name(slug: str) -> str:
|
def compose_project_name(slug: str) -> str:
|
||||||
@@ -371,15 +296,20 @@ def slug_from_compose_project(project: str) -> str:
|
|||||||
return project[len(COMPOSE_PROJECT_PREFIX):]
|
return project[len(COMPOSE_PROJECT_PREFIX):]
|
||||||
|
|
||||||
|
|
||||||
def list_compose_projects(*, include_stopped: bool = True) -> list[str]:
|
def list_compose_projects(
|
||||||
"""All compose project names starting with `claude-bottle-`.
|
*, include_stopped: bool = True, warn_on_error: bool = True,
|
||||||
|
) -> list[str]:
|
||||||
|
"""All compose project names starting with `bot-bottle-`.
|
||||||
`include_stopped=True` (default) runs `docker compose ls --all`
|
`include_stopped=True` (default) runs `docker compose ls --all`
|
||||||
so exited projects appear too; pass False to get only projects
|
so exited projects appear too; pass False to get only projects
|
||||||
with at least one running container.
|
with at least one running container.
|
||||||
|
|
||||||
Returns [] on docker daemon errors or malformed output rather
|
Returns [] on docker daemon errors or malformed output rather
|
||||||
than raising — callers should treat the empty list as "no
|
than raising — callers should treat the empty list as "no
|
||||||
projects discoverable", not "no projects exist"."""
|
projects discoverable", not "no projects exist". `warn_on_error`
|
||||||
|
stays true for explicit operator commands like cleanup, but active
|
||||||
|
discovery paths set it false so dashboard refreshes don't spam
|
||||||
|
stderr while Docker Desktop is stopped."""
|
||||||
argv = ["docker", "compose", "ls", "--format", "json"]
|
argv = ["docker", "compose", "ls", "--format", "json"]
|
||||||
if include_stopped:
|
if include_stopped:
|
||||||
argv.insert(3, "--all")
|
argv.insert(3, "--all")
|
||||||
@@ -392,12 +322,14 @@ def list_compose_projects(*, include_stopped: bool = True) -> list[str]:
|
|||||||
# error from the caller's POV: no projects discoverable.
|
# error from the caller's POV: no projects discoverable.
|
||||||
return []
|
return []
|
||||||
if result.returncode != 0:
|
if result.returncode != 0:
|
||||||
warn(f"docker compose ls failed: {result.stderr.strip()}")
|
if warn_on_error:
|
||||||
|
warn(f"docker compose ls failed: {result.stderr.strip()}")
|
||||||
return []
|
return []
|
||||||
try:
|
try:
|
||||||
projects = json.loads(result.stdout or "[]")
|
projects = json.loads(result.stdout or "[]")
|
||||||
except json.JSONDecodeError as e:
|
except json.JSONDecodeError as e:
|
||||||
warn(f"docker compose ls returned malformed JSON: {e}")
|
if warn_on_error:
|
||||||
|
warn(f"docker compose ls returned malformed JSON: {e}")
|
||||||
return []
|
return []
|
||||||
names: list[str] = []
|
names: list[str] = []
|
||||||
for p in projects:
|
for p in projects:
|
||||||
@@ -409,14 +341,19 @@ def list_compose_projects(*, include_stopped: bool = True) -> list[str]:
|
|||||||
return sorted(set(names))
|
return sorted(set(names))
|
||||||
|
|
||||||
|
|
||||||
def list_active_slugs(*, include_stopped: bool = False) -> list[str]:
|
def list_active_slugs(
|
||||||
|
*, include_stopped: bool = False, warn_on_error: bool = True,
|
||||||
|
) -> list[str]:
|
||||||
"""Slugs (project name minus prefix) of currently-running
|
"""Slugs (project name minus prefix) of currently-running
|
||||||
bottles. Used by the dashboard's operator-edit verbs to choose
|
bottles. Used by the dashboard's operator-edit verbs to choose
|
||||||
a bottle to apply a config edit to."""
|
a bottle to apply a config edit to."""
|
||||||
return sorted(
|
return sorted(
|
||||||
slug for slug in (
|
slug for slug in (
|
||||||
slug_from_compose_project(p)
|
slug_from_compose_project(p)
|
||||||
for p in list_compose_projects(include_stopped=include_stopped)
|
for p in list_compose_projects(
|
||||||
|
include_stopped=include_stopped,
|
||||||
|
warn_on_error=warn_on_error,
|
||||||
|
)
|
||||||
) if slug
|
) if slug
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -19,17 +19,11 @@ from ...log import die
|
|||||||
# Listening port the egress daemon binds inside the bundle. The
|
# Listening port the egress daemon binds inside the bundle. The
|
||||||
# agent's HTTP_PROXY env var resolves to `http://egress:<port>`,
|
# agent's HTTP_PROXY env var resolves to `http://egress:<port>`,
|
||||||
# and the bundle's network aliases route `egress` to itself.
|
# and the bundle's network aliases route `egress` to itself.
|
||||||
EGRESS_PORT = int(os.environ.get("CLAUDE_BOTTLE_EGRESS_PORT", "9099"))
|
EGRESS_PORT = int(os.environ.get("BOT_BOTTLE_EGRESS_PORT", "9099"))
|
||||||
|
|
||||||
# In-container path for mitmproxy's CA. The format is a single PEM
|
# In-container path for mitmproxy's CA. The format is a single PEM
|
||||||
# file holding BOTH the cert and the private key, concatenated. The
|
# file holding BOTH the cert and the private key, concatenated.
|
||||||
# upstream-trust CA (pipelock's, so egress trusts the upstream
|
|
||||||
# leg) is a separate file because pipelock keeps a different CA on
|
|
||||||
# its end.
|
|
||||||
EGRESS_CA_IN_CONTAINER = "/home/mitmproxy/.mitmproxy/mitmproxy-ca.pem"
|
EGRESS_CA_IN_CONTAINER = "/home/mitmproxy/.mitmproxy/mitmproxy-ca.pem"
|
||||||
EGRESS_PIPELOCK_CA_IN_CONTAINER = (
|
|
||||||
"/home/mitmproxy/.mitmproxy/pipelock-ca.pem"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def egress_tls_init(stage_dir: Path) -> tuple[Path, Path]:
|
def egress_tls_init(stage_dir: Path) -> tuple[Path, Path]:
|
||||||
@@ -42,16 +36,8 @@ def egress_tls_init(stage_dir: Path) -> tuple[Path, Path]:
|
|||||||
trust store by `provision_ca` so the agent trusts the bumped
|
trust store by `provision_ca` so the agent trusts the bumped
|
||||||
CONNECT cert egress presents.
|
CONNECT cert egress presents.
|
||||||
|
|
||||||
Why openssl req (not the pipelock binary's `tls init`):
|
openssl req's `subjectKeyIdentifier=hash` extension uses
|
||||||
pipelock's CA generator stamps a non-standard `Subject Key
|
SHA-1(pubkey), matching mitmproxy's AKI computation on leaves.
|
||||||
Identifier` on the CA (random rather than SHA-1 of the pubkey).
|
|
||||||
mitmproxy computes the `Authority Key Identifier` on each leaf
|
|
||||||
it mints as SHA-1(issuer's pubkey). openssl's chain validator
|
|
||||||
uses the leaf's AKI to find the issuer cert by SKI; pipelock's
|
|
||||||
SKI doesn't match → openssl reports "unable to get local issuer
|
|
||||||
certificate" even though the CA is right there in the trust
|
|
||||||
store. openssl req's `subjectKeyIdentifier=hash` extension uses
|
|
||||||
SHA-1(pubkey), matching mitmproxy's computation.
|
|
||||||
|
|
||||||
Both files live under `<stage_dir>/egress-ca/` (mode 644 —
|
Both files live under `<stage_dir>/egress-ca/` (mode 644 —
|
||||||
`docker cp` preserves the mode into the container, where the
|
`docker cp` preserves the mode into the container, where the
|
||||||
@@ -88,8 +74,8 @@ def egress_tls_init(stage_dir: Path) -> tuple[Path, Path]:
|
|||||||
"x509_extensions = v3_ca\n"
|
"x509_extensions = v3_ca\n"
|
||||||
"\n"
|
"\n"
|
||||||
"[req_dn]\n"
|
"[req_dn]\n"
|
||||||
"O = claude-bottle\n"
|
"O = bot-bottle\n"
|
||||||
"CN = claude-bottle egress CA\n"
|
"CN = bot-bottle egress CA\n"
|
||||||
"\n"
|
"\n"
|
||||||
"[v3_ca]\n"
|
"[v3_ca]\n"
|
||||||
"basicConstraints = critical, CA:TRUE\n"
|
"basicConstraints = critical, CA:TRUE\n"
|
||||||
@@ -115,7 +101,7 @@ def egress_tls_init(stage_dir: Path) -> tuple[Path, Path]:
|
|||||||
# where mitmproxy runs as uid 1000 — so the host file has to be
|
# where mitmproxy runs as uid 1000 — so the host file has to be
|
||||||
# world-readable for the container's user to read it through the
|
# world-readable for the container's user to read it through the
|
||||||
# mount. Owner-only mode on the parent dir (state/<slug>/, under
|
# mount. Owner-only mode on the parent dir (state/<slug>/, under
|
||||||
# ~/.claude-bottle which inherits ~'s 0o700) is what actually
|
# ~/.bot-bottle which inherits ~'s 0o700) is what actually
|
||||||
# restricts who can reach this file on the host.
|
# restricts who can reach this file on the host.
|
||||||
mitm = work / "mitmproxy-ca.pem"
|
mitm = work / "mitmproxy-ca.pem"
|
||||||
mitm.write_bytes(cert_path.read_bytes() + key_path.read_bytes())
|
mitm.write_bytes(cert_path.read_bytes() + key_path.read_bytes())
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
"""Host-side helper for egress sidecar inspection (issue #198).
|
||||||
|
|
||||||
|
`_merge_single_route`, `add_route`, and `apply_routes_change` were
|
||||||
|
removed when the egress-block MCP tool was dropped. The remaining
|
||||||
|
helpers support runtime inspection and validation of the routes file
|
||||||
|
without modifying it at runtime.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ...egress import EGRESS_ROUTES_IN_CONTAINER
|
||||||
|
from ...egress_addon_core import load_routes
|
||||||
|
from .sidecar_bundle import sidecar_bundle_container_name
|
||||||
|
|
||||||
|
|
||||||
|
class EgressApplyError(RuntimeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_current_routes(slug: str) -> str:
|
||||||
|
container = sidecar_bundle_container_name(slug)
|
||||||
|
r = subprocess.run(
|
||||||
|
["docker", "exec", container, "cat", EGRESS_ROUTES_IN_CONTAINER],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
raise EgressApplyError(
|
||||||
|
f"could not read routes.yaml from {container}: "
|
||||||
|
f"{(r.stderr or '').strip() or 'container not running?'}"
|
||||||
|
)
|
||||||
|
return r.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def validate_routes_content(content: str) -> None:
|
||||||
|
try:
|
||||||
|
load_routes(content)
|
||||||
|
except ValueError as e:
|
||||||
|
raise EgressApplyError(
|
||||||
|
f"proposed routes.yaml is not valid: {e}"
|
||||||
|
) from e
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"EgressApplyError",
|
||||||
|
"fetch_current_routes",
|
||||||
|
"validate_routes_content",
|
||||||
|
]
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
"""Active-agent enumeration for the docker backend.
|
||||||
|
|
||||||
|
Mirrors `backend/smolmachines/enumerate.py`: returns
|
||||||
|
`ActiveAgent` records the CLI `list active` command and the
|
||||||
|
dashboard agents pane consume. Empty when docker isn't reachable
|
||||||
|
— gated by `has_backend('docker')` at the cross-backend caller
|
||||||
|
so this module trusts that docker is available when called.
|
||||||
|
|
||||||
|
The parser (`_parse_services_by_project`) is exposed for direct
|
||||||
|
unit testing; the docker `docker ps` invocation is in
|
||||||
|
`_query_services_by_project`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from .. import ActiveAgent
|
||||||
|
from ...bottle_state import read_metadata
|
||||||
|
from .compose import compose_project_name, list_active_slugs
|
||||||
|
|
||||||
|
|
||||||
|
def enumerate_active() -> list[ActiveAgent]:
|
||||||
|
"""All currently-running docker-backed agents. Caller is
|
||||||
|
responsible for gating on `has_backend('docker')` if it
|
||||||
|
matters; if docker is missing the `docker ps` call below
|
||||||
|
returns an empty list silently."""
|
||||||
|
slugs = list_active_slugs(include_stopped=False, warn_on_error=False)
|
||||||
|
if not slugs:
|
||||||
|
return []
|
||||||
|
services_by_project = _query_services_by_project()
|
||||||
|
out: list[ActiveAgent] = []
|
||||||
|
for slug in slugs:
|
||||||
|
project = compose_project_name(slug)
|
||||||
|
services = services_by_project.get(project, set())
|
||||||
|
metadata = read_metadata(slug)
|
||||||
|
out.append(ActiveAgent(
|
||||||
|
backend_name="docker",
|
||||||
|
slug=slug,
|
||||||
|
agent_name=metadata.agent_name if metadata else "?",
|
||||||
|
started_at=metadata.started_at if metadata else "",
|
||||||
|
services=tuple(sorted(services)),
|
||||||
|
label=metadata.label if metadata else "",
|
||||||
|
color=metadata.color if metadata else "",
|
||||||
|
))
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_services_by_project(stdout: str) -> dict[str, set[str]]:
|
||||||
|
"""Parse `docker ps` output formatted as
|
||||||
|
`<project-label>\\t<service-label>` (one line per container)
|
||||||
|
into a `{project: {service, ...}}` mapping. Pure function for
|
||||||
|
testing — the docker invocation is in `_query_services_by_project`."""
|
||||||
|
out: dict[str, set[str]] = {}
|
||||||
|
for line in stdout.splitlines():
|
||||||
|
project, _, service = line.partition("\t")
|
||||||
|
if not project or not service:
|
||||||
|
continue
|
||||||
|
out.setdefault(project, set()).add(service)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _query_services_by_project() -> dict[str, set[str]]:
|
||||||
|
"""One `docker ps` call → `{project: {service, ...}}`. Used
|
||||||
|
by the CLI's `list active` and the dashboard's agents pane —
|
||||||
|
one subprocess per refresh tick, not one per bottle."""
|
||||||
|
try:
|
||||||
|
r = subprocess.run(
|
||||||
|
[
|
||||||
|
"docker", "ps",
|
||||||
|
"--filter", "label=com.docker.compose.project",
|
||||||
|
"--format",
|
||||||
|
'{{.Label "com.docker.compose.project"}}'
|
||||||
|
"\t"
|
||||||
|
'{{.Label "com.docker.compose.service"}}',
|
||||||
|
],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return {}
|
||||||
|
if r.returncode != 0:
|
||||||
|
return {}
|
||||||
|
return _parse_services_by_project(r.stdout or "")
|
||||||
@@ -4,26 +4,20 @@ PRD 0018 chunk 3: each instance is one `docker compose` project.
|
|||||||
|
|
||||||
The flow is:
|
The flow is:
|
||||||
|
|
||||||
1. Build the agent's base + derived image (compose builds the
|
1. Build the agent image from the provider Dockerfile (compose
|
||||||
sidecar images via the `build:` directive on first up).
|
builds the sidecar images via the `build:` directive on first up).
|
||||||
2. Pre-create the per-bottle networks. We do this outside compose
|
2. Mint the per-bottle egress CA (chunk 2 writes it under
|
||||||
so we can inspect the assigned internal CIDR and embed it in
|
state/<slug>/egress/).
|
||||||
pipelock's yaml (compose's `external: true` lets the compose
|
3. Populate the inner plans with launch-time fields so the
|
||||||
file reference these pre-existing networks).
|
renderer can read network names, CA paths.
|
||||||
3. Mint the per-bottle CAs (chunk 2 writes them under
|
|
||||||
state/<slug>/{pipelock,egress}/).
|
|
||||||
4. Re-render pipelock yaml with the now-known internal CIDR so
|
|
||||||
the SSRF allowlist exempts the bottle's own subnet.
|
|
||||||
5. Populate the inner plans with launch-time fields so the
|
|
||||||
renderer can read network names, CA paths, pipelock URL.
|
|
||||||
6. Render the compose spec, write it to
|
6. Render the compose spec, write it to
|
||||||
state/<slug>/docker-compose.yml, write metadata.json.
|
state/<slug>/docker-compose.yml, write metadata.json.
|
||||||
7. `docker compose up -d` (token + OAuth values flow into the
|
7. `docker compose up -d` (token + OAuth values flow into the
|
||||||
compose subprocess env so `environment: [NAME]` bare-name
|
compose subprocess env so `environment: [NAME]` bare-name
|
||||||
entries inherit without rendering values into the file).
|
entries inherit without rendering values into the file).
|
||||||
8. Provision (CA install, prompt copy, skills, git, supervise
|
8. Provision (CA install, prompt copy, skills, workspace, git,
|
||||||
config) — unchanged, uses `docker exec`.
|
supervise config) — unchanged, uses `docker exec` / `docker cp`.
|
||||||
9. Yield a DockerBottle handle. `exec_claude` runs claude via
|
9. Yield a DockerBottle handle. `exec_agent` runs claude via
|
||||||
`docker exec -it` exactly like the pre-compose world.
|
`docker exec -it` exactly like the pre-compose world.
|
||||||
|
|
||||||
Teardown (ExitStack callbacks fire in reverse):
|
Teardown (ExitStack callbacks fire in reverse):
|
||||||
@@ -43,15 +37,16 @@ from pathlib import Path
|
|||||||
from typing import Callable, Generator
|
from typing import Callable, Generator
|
||||||
|
|
||||||
from ...egress import egress_resolve_token_values
|
from ...egress import egress_resolve_token_values
|
||||||
from ...log import info
|
from ...git_gate import revoke_git_gate_provisioned_keys
|
||||||
|
from ...log import info, warn
|
||||||
from . import network as network_mod
|
from . import network as network_mod
|
||||||
from . import util as docker_mod
|
from . import util as docker_mod
|
||||||
from .bottle import DockerBottle
|
from .bottle import DockerBottle
|
||||||
from .bottle_plan import DockerBottlePlan
|
from .bottle_plan import DockerBottlePlan
|
||||||
from .bottle_state import (
|
from ...bottle_state import (
|
||||||
bottle_state_dir,
|
bottle_state_dir,
|
||||||
egress_state_dir,
|
egress_state_dir,
|
||||||
pipelock_state_dir,
|
git_gate_state_dir,
|
||||||
)
|
)
|
||||||
from .compose import (
|
from .compose import (
|
||||||
bottle_plan_to_compose,
|
bottle_plan_to_compose,
|
||||||
@@ -64,10 +59,6 @@ from .compose import (
|
|||||||
write_compose_file,
|
write_compose_file,
|
||||||
)
|
)
|
||||||
from .egress import egress_tls_init
|
from .egress import egress_tls_init
|
||||||
from .pipelock import (
|
|
||||||
BUNDLE_LOCAL_PIPELOCK_URL,
|
|
||||||
pipelock_tls_init,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Where the repo root lives, for `docker build` context. Computed once.
|
# Where the repo root lives, for `docker build` context. Computed once.
|
||||||
@@ -78,19 +69,26 @@ _REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
|||||||
def launch(
|
def launch(
|
||||||
plan: DockerBottlePlan,
|
plan: DockerBottlePlan,
|
||||||
*,
|
*,
|
||||||
provision: Callable[[DockerBottlePlan, str], str | None],
|
provision: Callable[[DockerBottlePlan, "DockerBottle"], str | None],
|
||||||
) -> Generator[DockerBottle, None, None]:
|
) -> Generator[DockerBottle, None, None]:
|
||||||
"""Build, launch, and provision a Docker bottle via compose.
|
"""Build, launch, and provision a Docker bottle via compose.
|
||||||
Teardown on exit."""
|
Teardown on exit."""
|
||||||
stack = ExitStack()
|
stack = ExitStack()
|
||||||
|
|
||||||
|
_bottle_for_revoke = plan.spec.manifest.bottle_for(plan.spec.agent_name)
|
||||||
|
_git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
||||||
|
|
||||||
def teardown() -> None:
|
def teardown() -> None:
|
||||||
try:
|
try:
|
||||||
stack.close()
|
stack.close()
|
||||||
except BaseException:
|
except BaseException as exc: # noqa: W0718 — teardown must not fail
|
||||||
# Teardown must not raise; swallow so the caller's
|
warn(
|
||||||
# __exit__ path can still propagate the original error.
|
f"teardown failed for container {plan.container_name}"
|
||||||
pass
|
f" (compose-down): {exc!r}"
|
||||||
|
)
|
||||||
|
revoke_git_gate_provisioned_keys(
|
||||||
|
_bottle_for_revoke, _git_gate_dir_for_revoke
|
||||||
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Step 1: agent image build. Sidecar images get built lazily by
|
# Step 1: agent image build. Sidecar images get built lazily by
|
||||||
@@ -99,40 +97,14 @@ def launch(
|
|||||||
plan.image, _REPO_DIR,
|
plan.image, _REPO_DIR,
|
||||||
dockerfile=plan.dockerfile_path,
|
dockerfile=plan.dockerfile_path,
|
||||||
)
|
)
|
||||||
if plan.derived_image:
|
|
||||||
docker_mod.build_image_with_cwd(
|
|
||||||
plan.derived_image, plan.image, plan.spec.user_cwd
|
|
||||||
)
|
|
||||||
|
|
||||||
# Networks: compose-managed. The names are derived
|
|
||||||
# deterministically from the slug so the renderer can put
|
|
||||||
# them on the services and `compose up` creates them with
|
|
||||||
# those names. The empirical spike confirmed pipelock's
|
|
||||||
# SSRF guard only checks proxied-request destinations, not
|
|
||||||
# source IPs — so the bottle's own internal CIDR doesn't
|
|
||||||
# need to be in `ssrf.ip_allowlist`. Pre-create + CIDR
|
|
||||||
# introspection are gone; compose owns the network
|
|
||||||
# lifecycle.
|
|
||||||
internal_network = network_mod.network_name_for_slug(plan.slug)
|
internal_network = network_mod.network_name_for_slug(plan.slug)
|
||||||
egress_network = network_mod.network_egress_name_for_slug(plan.slug)
|
egress_network = network_mod.network_egress_name_for_slug(plan.slug)
|
||||||
|
|
||||||
# Mint per-bottle CAs into state/<slug>/{pipelock,egress}/.
|
|
||||||
ca_cert_host, ca_key_host = pipelock_tls_init(pipelock_state_dir(plan.slug))
|
|
||||||
egress_ca_host, egress_ca_cert_only = egress_tls_init(
|
egress_ca_host, egress_ca_cert_only = egress_tls_init(
|
||||||
egress_state_dir(plan.slug),
|
egress_state_dir(plan.slug),
|
||||||
)
|
)
|
||||||
|
|
||||||
# Populate launch-time fields on every inner plan so the
|
|
||||||
# renderer reads concrete network names, CA paths, and
|
|
||||||
# pipelock URL.
|
|
||||||
proxy_plan = dataclasses.replace(
|
|
||||||
plan.proxy_plan,
|
|
||||||
internal_network=internal_network,
|
|
||||||
internal_network_cidr="",
|
|
||||||
egress_network=egress_network,
|
|
||||||
ca_cert_host_path=ca_cert_host,
|
|
||||||
ca_key_host_path=ca_key_host,
|
|
||||||
)
|
|
||||||
git_gate_plan = plan.git_gate_plan
|
git_gate_plan = plan.git_gate_plan
|
||||||
if git_gate_plan.upstreams:
|
if git_gate_plan.upstreams:
|
||||||
git_gate_plan = dataclasses.replace(
|
git_gate_plan = dataclasses.replace(
|
||||||
@@ -140,17 +112,13 @@ def launch(
|
|||||||
internal_network=internal_network,
|
internal_network=internal_network,
|
||||||
egress_network=egress_network,
|
egress_network=egress_network,
|
||||||
)
|
)
|
||||||
egress_plan = plan.egress_plan
|
egress_plan = dataclasses.replace(
|
||||||
if egress_plan.routes:
|
plan.egress_plan,
|
||||||
egress_plan = dataclasses.replace(
|
internal_network=internal_network,
|
||||||
egress_plan,
|
egress_network=egress_network,
|
||||||
internal_network=internal_network,
|
mitmproxy_ca_host_path=egress_ca_host,
|
||||||
egress_network=egress_network,
|
mitmproxy_ca_cert_only_host_path=egress_ca_cert_only,
|
||||||
mitmproxy_ca_host_path=egress_ca_host,
|
)
|
||||||
mitmproxy_ca_cert_only_host_path=egress_ca_cert_only,
|
|
||||||
pipelock_ca_host_path=ca_cert_host,
|
|
||||||
pipelock_proxy_url=BUNDLE_LOCAL_PIPELOCK_URL,
|
|
||||||
)
|
|
||||||
supervise_plan = plan.supervise_plan
|
supervise_plan = plan.supervise_plan
|
||||||
if supervise_plan is not None:
|
if supervise_plan is not None:
|
||||||
supervise_plan = dataclasses.replace(
|
supervise_plan = dataclasses.replace(
|
||||||
@@ -159,7 +127,6 @@ def launch(
|
|||||||
)
|
)
|
||||||
plan = dataclasses.replace(
|
plan = dataclasses.replace(
|
||||||
plan,
|
plan,
|
||||||
proxy_plan=proxy_plan,
|
|
||||||
git_gate_plan=git_gate_plan,
|
git_gate_plan=git_gate_plan,
|
||||||
egress_plan=egress_plan,
|
egress_plan=egress_plan,
|
||||||
supervise_plan=supervise_plan,
|
supervise_plan=supervise_plan,
|
||||||
@@ -176,11 +143,10 @@ def launch(
|
|||||||
# Step 7: compose up. Token values + the OAuth placeholder
|
# Step 7: compose up. Token values + the OAuth placeholder
|
||||||
# flow through subprocess env; the compose file holds only
|
# flow through subprocess env; the compose file holds only
|
||||||
# bare names for the secret-carrying entries.
|
# bare names for the secret-carrying entries.
|
||||||
token_values: dict[str, str] = {}
|
effective_env = {**dict(os.environ), **plan.agent_provision.provisioned_env}
|
||||||
if plan.egress_plan.routes:
|
token_values = egress_resolve_token_values(
|
||||||
token_values = egress_resolve_token_values(
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
plan.egress_plan.token_env_map, dict(os.environ),
|
)
|
||||||
)
|
|
||||||
compose_env: dict[str, str] = {
|
compose_env: dict[str, str] = {
|
||||||
**os.environ,
|
**os.environ,
|
||||||
**plan.forwarded_env,
|
**plan.forwarded_env,
|
||||||
@@ -200,13 +166,25 @@ def launch(
|
|||||||
compose_dump_logs, project, compose_file, compose_log_path(state_dir),
|
compose_dump_logs, project, compose_file, compose_log_path(state_dir),
|
||||||
)
|
)
|
||||||
|
|
||||||
# Step 8: provision. Unchanged — uses `docker exec` against
|
# Step 8: provision. Create the bottle first so provisioners
|
||||||
# the agent container by its known name.
|
# can use bottle.exec / bottle.cp_in; set the prompt path
|
||||||
prompt_path = provision(plan, plan.container_name)
|
# returned by provision_prompt after the fact.
|
||||||
|
bottle = DockerBottle(
|
||||||
|
plan.container_name,
|
||||||
|
teardown,
|
||||||
|
None,
|
||||||
|
agent_command=plan.agent_command,
|
||||||
|
agent_prompt_mode=plan.agent_prompt_mode,
|
||||||
|
agent_provider_template=plan.agent_provider_template,
|
||||||
|
terminal_title=plan.spec.label or plan.spec.agent_name,
|
||||||
|
terminal_color=plan.spec.color,
|
||||||
|
agent_workdir=plan.workspace_plan.workdir,
|
||||||
|
)
|
||||||
|
bottle.prompt_path = provision(plan, bottle)
|
||||||
|
|
||||||
# Step 9: yield. exec_claude continues to use `docker exec -it`
|
# Step 9: yield. exec_agent continues to use `docker exec -it`
|
||||||
# — the agent runs `sleep infinity` per the renderer's
|
# — the agent runs `sleep infinity` per the renderer's
|
||||||
# service spec.
|
# service spec.
|
||||||
yield DockerBottle(plan.container_name, teardown, prompt_path)
|
yield bottle
|
||||||
finally:
|
finally:
|
||||||
teardown()
|
teardown()
|
||||||
@@ -1,14 +1,13 @@
|
|||||||
"""Docker network plumbing for the per-agent egress topology.
|
"""Docker network plumbing for the per-agent egress topology.
|
||||||
|
|
||||||
The agent container sits on a Docker `--internal` network (no default
|
The agent container sits on a Docker `--internal` network (no default
|
||||||
gateway). Pipelock straddles that network and a per-agent user-defined
|
gateway). Egress straddles that network and a per-agent user-defined
|
||||||
bridge for upstream egress. We deliberately do NOT use Docker's legacy
|
bridge for upstream traffic. We deliberately do NOT use Docker's legacy
|
||||||
`bridge` network because only user-defined bridges run Docker's
|
`bridge` network because only user-defined bridges run Docker's
|
||||||
embedded DNS resolver, which pipelock needs to resolve api.anthropic.com
|
embedded DNS resolver, which egress needs to resolve upstream hostnames.
|
||||||
and similar upstream hostnames.
|
|
||||||
|
|
||||||
Naming: claude-bottle-net-<slug> (internal),
|
Naming: bot-bottle-net-<slug> (internal),
|
||||||
claude-bottle-egress-<slug> (egress). Numeric suffix on conflict
|
bot-bottle-egress-<slug> (egress). Numeric suffix on conflict
|
||||||
(-2, -3, ..., capped at 100).
|
(-2, -3, ..., capped at 100).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -20,11 +19,11 @@ from ...log import die, info, warn
|
|||||||
|
|
||||||
|
|
||||||
def network_name_for_slug(slug: str) -> str:
|
def network_name_for_slug(slug: str) -> str:
|
||||||
return f"claude-bottle-net-{slug}"
|
return f"bot-bottle-net-{slug}"
|
||||||
|
|
||||||
|
|
||||||
def network_egress_name_for_slug(slug: str) -> str:
|
def network_egress_name_for_slug(slug: str) -> str:
|
||||||
return f"claude-bottle-egress-{slug}"
|
return f"bot-bottle-egress-{slug}"
|
||||||
|
|
||||||
|
|
||||||
def network_exists(name: str) -> bool:
|
def network_exists(name: str) -> bool:
|
||||||
@@ -77,20 +76,12 @@ def network_create_internal(slug: str) -> str:
|
|||||||
|
|
||||||
def network_create_egress(slug: str) -> str:
|
def network_create_egress(slug: str) -> str:
|
||||||
"""Create a per-agent user-defined bridge (NOT the legacy `bridge`)
|
"""Create a per-agent user-defined bridge (NOT the legacy `bridge`)
|
||||||
so the pipelock sidecar has working DNS for upstream hostnames."""
|
so the egress sidecar has working DNS for upstream hostnames."""
|
||||||
return _network_create_with_prefix(network_egress_name_for_slug(slug), internal=False)
|
return _network_create_with_prefix(network_egress_name_for_slug(slug), internal=False)
|
||||||
|
|
||||||
|
|
||||||
def network_inspect_cidr(name: str) -> str:
|
def network_inspect_cidr(name: str) -> str:
|
||||||
"""Return the IPv4 CIDR Docker assigned to a user-defined network.
|
"""Return the IPv4 CIDR Docker assigned to a user-defined network."""
|
||||||
|
|
||||||
Used by pipelock's SSRF guard exception: the bottle's internal
|
|
||||||
network sits in RFC1918 space, so pipelock's `internal:` list
|
|
||||||
would block any agent request whose destination resolves there
|
|
||||||
— including the cred-proxy sidecar's address. Adding the
|
|
||||||
network's CIDR to pipelock's `ssrf.ip_allowlist` lets traffic
|
|
||||||
targeted at the bottle's own sidecars through while pipelock
|
|
||||||
still body-scans and api_allowlist-gates as usual."""
|
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["docker", "network", "inspect",
|
["docker", "network", "inspect",
|
||||||
"--format", "{{range .IPAM.Config}}{{.Subnet}}{{end}}", name],
|
"--format", "{{range .IPAM.Config}}{{.Subnet}}{{end}}", name],
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
"""Backend-infrastructure provisioners for the Docker backend.
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider provisioning steps (prompt, skills,
|
||||||
|
declarative provision-plan apply, supervise MCP registration) live on
|
||||||
|
the `AgentProvider` plugin under `bot_bottle/contrib/`. CA and git
|
||||||
|
provisioning also moved to the AgentProvider ABC (with Debian/node
|
||||||
|
defaults); user plugins override them for non-standard images.
|
||||||
|
|
||||||
|
No modules remain in this subpackage — the directory is kept so that
|
||||||
|
existing imports of `from .provision import ...` don't need updating
|
||||||
|
if new backend-specific provisioners are added later.
|
||||||
|
"""
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
"""Prepare step for the Docker bottle backend.
|
||||||
|
|
||||||
|
`resolve_plan` does all host-side resolution (image and container
|
||||||
|
names, prompt-file, proxy plan, runtime detection) and returns a
|
||||||
|
frozen DockerBottlePlan. No Docker resources are created; the only
|
||||||
|
side effects are scratch files under `stage_dir` and a probe of
|
||||||
|
`docker info`. Cross-backend host-side validation has already run
|
||||||
|
via the base class's `prepare` template before this is called.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from . import util as docker_mod
|
||||||
|
from .bottle_plan import DockerBottlePlan
|
||||||
|
from .. import BottleSpec
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
|
||||||
|
def preflight() -> None:
|
||||||
|
docker_mod.require_docker()
|
||||||
|
|
||||||
|
|
||||||
|
def build_guest_env(resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return dict(resolved_env.literals)
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_plan(
|
||||||
|
spec: BottleSpec,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> DockerBottlePlan:
|
||||||
|
"""Resolve Docker-specific names and write scratch files. Trusts
|
||||||
|
that the agent and its skills/git-gate keys are present —
|
||||||
|
validation already ran in the base class."""
|
||||||
|
|
||||||
|
# ==== docker specific setup ====
|
||||||
|
use_runsc = docker_mod.runsc_available()
|
||||||
|
|
||||||
|
return DockerBottlePlan(
|
||||||
|
spec=spec,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
slug=slug,
|
||||||
|
forwarded_env=dict(resolved_env.forwarded),
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
use_runsc=use_runsc,
|
||||||
|
agent_provision=agent_provision_plan,
|
||||||
|
)
|
||||||
+9
-10
@@ -2,10 +2,10 @@
|
|||||||
(PRD 0024).
|
(PRD 0024).
|
||||||
|
|
||||||
The bundle image (built by Dockerfile.sidecars, PRD 0024 chunk 1)
|
The bundle image (built by Dockerfile.sidecars, PRD 0024 chunk 1)
|
||||||
runs pipelock + egress + git-gate + supervise as one container
|
runs egress + git-gate + supervise as one container per bottle
|
||||||
per bottle under a small Python init supervisor. As of chunk 5
|
under a small Python init supervisor. As of chunk 5 the bundle
|
||||||
the bundle is the only shape — the legacy four-sidecar topology
|
is the only shape — the legacy four-sidecar topology and its
|
||||||
and its `CLAUDE_BOTTLE_SIDECAR_BUNDLE` feature flag are gone."""
|
`BOT_BOTTLE_SIDECAR_BUNDLE` feature flag are gone."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -14,18 +14,17 @@ import os
|
|||||||
|
|
||||||
# Bundle image. Defaults to a built-locally tag (built from the
|
# Bundle image. Defaults to a built-locally tag (built from the
|
||||||
# repo's Dockerfile.sidecars via compose `build:`). Operators
|
# repo's Dockerfile.sidecars via compose `build:`). Operators
|
||||||
# pinning to a published digest can override via env, matching
|
# pinning to a published digest can override via env.
|
||||||
# the existing `CLAUDE_BOTTLE_PIPELOCK_IMAGE` shape.
|
|
||||||
SIDECAR_BUNDLE_IMAGE = os.environ.get(
|
SIDECAR_BUNDLE_IMAGE = os.environ.get(
|
||||||
"CLAUDE_BOTTLE_SIDECAR_IMAGE",
|
"BOT_BOTTLE_SIDECAR_IMAGE",
|
||||||
"claude-bottle-sidecars:latest",
|
"bot-bottle-sidecars:latest",
|
||||||
)
|
)
|
||||||
|
|
||||||
SIDECAR_BUNDLE_DOCKERFILE = "Dockerfile.sidecars"
|
SIDECAR_BUNDLE_DOCKERFILE = "Dockerfile.sidecars"
|
||||||
|
|
||||||
|
|
||||||
def sidecar_bundle_container_name(slug: str) -> str:
|
def sidecar_bundle_container_name(slug: str) -> str:
|
||||||
"""`claude-bottle-sidecars-<slug>`. Same prefix scheme as the
|
"""`bot-bottle-sidecars-<slug>`. Same prefix scheme as the
|
||||||
per-sidecar containers it replaces, so the dashboard's
|
per-sidecar containers it replaces, so the dashboard's
|
||||||
discovery-by-prefix logic keeps working."""
|
discovery-by-prefix logic keeps working."""
|
||||||
return f"claude-bottle-sidecars-{slug}"
|
return f"bot-bottle-sidecars-{slug}"
|
||||||
@@ -10,6 +10,7 @@ import subprocess
|
|||||||
from typing import Iterable, Iterator
|
from typing import Iterable, Iterator
|
||||||
|
|
||||||
from ...log import die, info
|
from ...log import die, info
|
||||||
|
# from ...workspace import WorkspacePlan
|
||||||
|
|
||||||
|
|
||||||
# Cap on the suffix the container-name conflict logic will try before
|
# Cap on the suffix the container-name conflict logic will try before
|
||||||
@@ -116,35 +117,39 @@ def build_image(ref: str, context: str, *, dockerfile: str = "") -> None:
|
|||||||
subprocess.run(args, check=True)
|
subprocess.run(args, check=True)
|
||||||
|
|
||||||
|
|
||||||
_TRUST_DIALOG_NODE_SCRIPT = (
|
# def build_image_with_cwd(
|
||||||
'const fs=require("fs"),p=process.env.HOME+"/.claude.json",'
|
# derived: str,
|
||||||
'c=JSON.parse(fs.readFileSync(p,"utf8"));'
|
# base: str,
|
||||||
'c.projects=c.projects||{};'
|
# workspace: "WorkspacePlan",
|
||||||
'c.projects[process.env.HOME+"/workspace"]={hasTrustDialogAccepted:true};'
|
# ) -> None:
|
||||||
'fs.writeFileSync(p,JSON.stringify(c,null,2));'
|
# """Build a thin derived image that copies the workspace into
|
||||||
)
|
# the plan's guest path and sets the plan's workdir."""
|
||||||
|
# import os
|
||||||
|
#
|
||||||
def build_image_with_cwd(derived: str, base: str, cwd: str) -> None:
|
# cwd = str(workspace.host_path)
|
||||||
"""Build a thin derived image that copies <cwd> into
|
# if not os.path.isdir(cwd):
|
||||||
/home/node/workspace and adds a trust-dialog entry for it."""
|
# die(f"cwd not found at {cwd}")
|
||||||
import os
|
# info(f"building image {derived} from {base} with {cwd} -> {workspace.guest_path}")
|
||||||
|
# with tempfile.TemporaryDirectory(prefix="bot-bottle-cwd.") as tmp:
|
||||||
if not os.path.isdir(cwd):
|
# context_dir = os.path.join(tmp, "context")
|
||||||
die(f"cwd not found at {cwd}")
|
# staged_workspace = os.path.join(context_dir, "workspace")
|
||||||
info(f"building image {derived} from {base} with {cwd} -> /home/node/workspace")
|
# shutil.copytree(
|
||||||
dockerfile = (
|
# cwd,
|
||||||
f"FROM {base}\n"
|
# staged_workspace,
|
||||||
f"COPY --chown=node:node . /home/node/workspace\n"
|
# symlinks=True,
|
||||||
f"RUN node -e '{_TRUST_DIALOG_NODE_SCRIPT}'\n"
|
# ignore=shutil.ignore_patterns(".git"),
|
||||||
f"WORKDIR /home/node/workspace\n"
|
# )
|
||||||
)
|
# dockerfile = (
|
||||||
subprocess.run(
|
# f"FROM {base}\n"
|
||||||
["docker", "build", "-t", derived, "-f", "-", cwd],
|
# f"COPY --chown=node:node workspace/. {workspace.guest_path}\n"
|
||||||
input=dockerfile,
|
# f"WORKDIR {workspace.workdir}\n"
|
||||||
text=True,
|
# )
|
||||||
check=True,
|
# subprocess.run(
|
||||||
)
|
# ["docker", "build", "-t", derived, "-f", "-", context_dir],
|
||||||
|
# input=dockerfile,
|
||||||
|
# text=True,
|
||||||
|
# check=True,
|
||||||
|
# )
|
||||||
|
|
||||||
|
|
||||||
def image_id(ref: str) -> str:
|
def image_id(ref: str) -> str:
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
"""macOS Apple Container backend.
|
||||||
|
|
||||||
|
Selectable via `BOT_BOTTLE_BACKEND=macos-container`. This package owns
|
||||||
|
the Apple `container` CLI integration; launch remains gated until the
|
||||||
|
sidecar network enforcement shape is implemented.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from .backend import MacosContainerBottleBackend
|
||||||
|
|
||||||
|
__all__ = ["MacosContainerBottleBackend"]
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
"""MacosContainerBottleBackend — Apple Container implementation."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Generator, Sequence
|
||||||
|
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from .. import ActiveAgent, BottleBackend, BottleSpec
|
||||||
|
from . import cleanup as _cleanup
|
||||||
|
from . import enumerate as _enumerate
|
||||||
|
from . import launch as _launch
|
||||||
|
from . import resolve_plan as _resolve_plan
|
||||||
|
from . import util as _container
|
||||||
|
from .bottle import MacosContainerBottle
|
||||||
|
from .bottle_cleanup_plan import MacosContainerBottleCleanupPlan
|
||||||
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
class MacosContainerBottleBackend(
|
||||||
|
BottleBackend["MacosContainerBottlePlan", "MacosContainerBottleCleanupPlan"]
|
||||||
|
):
|
||||||
|
"""Apple Container backend. Selected by
|
||||||
|
`BOT_BOTTLE_BACKEND=macos-container` or
|
||||||
|
`--backend=macos-container`."""
|
||||||
|
|
||||||
|
name = "macos-container"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def is_available(cls) -> bool:
|
||||||
|
return _container.is_available()
|
||||||
|
|
||||||
|
def _preflight(self) -> None:
|
||||||
|
_resolve_plan.preflight()
|
||||||
|
|
||||||
|
def _build_guest_env(self, resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return _resolve_plan.build_guest_env(resolved_env)
|
||||||
|
|
||||||
|
def _resolve_plan(
|
||||||
|
self,
|
||||||
|
spec: BottleSpec,
|
||||||
|
*,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
return _resolve_plan.resolve_plan(
|
||||||
|
spec,
|
||||||
|
slug=slug,
|
||||||
|
resolved_env=resolved_env,
|
||||||
|
agent_provision_plan=agent_provision_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(
|
||||||
|
self, plan: MacosContainerBottlePlan
|
||||||
|
) -> Generator[MacosContainerBottle, None, None]:
|
||||||
|
with _launch.launch(plan, provision=self.provision) as bottle:
|
||||||
|
yield bottle
|
||||||
|
|
||||||
|
def prepare_cleanup(self) -> MacosContainerBottleCleanupPlan:
|
||||||
|
return _cleanup.prepare_cleanup()
|
||||||
|
|
||||||
|
def cleanup(self, plan: MacosContainerBottleCleanupPlan) -> None:
|
||||||
|
_cleanup.cleanup(plan)
|
||||||
|
|
||||||
|
def enumerate_active(self) -> Sequence[ActiveAgent]:
|
||||||
|
return _enumerate.enumerate_active()
|
||||||
|
|
||||||
|
def supervise_mcp_url(self, plan: MacosContainerBottlePlan) -> str:
|
||||||
|
return plan.agent_supervise_url
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
"""Bottle handle for Apple's `container` CLI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
from typing import Callable, cast
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode, prompt_args
|
||||||
|
from .. import Bottle, ExecResult
|
||||||
|
from ..terminal import exec_shell_script
|
||||||
|
|
||||||
|
|
||||||
|
class MacosContainerBottle(Bottle):
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
container: str,
|
||||||
|
teardown: Callable[[], None],
|
||||||
|
prompt_path_in_container: str | None,
|
||||||
|
*,
|
||||||
|
agent_command: str = "claude",
|
||||||
|
agent_prompt_mode: PromptMode = "append_file",
|
||||||
|
agent_provider_template: str = "claude",
|
||||||
|
terminal_title: str = "",
|
||||||
|
terminal_color: str = "",
|
||||||
|
agent_workdir: str = "/home/node",
|
||||||
|
):
|
||||||
|
self.name = container
|
||||||
|
self._teardown = teardown
|
||||||
|
self.prompt_path = prompt_path_in_container
|
||||||
|
self._agent_prompt_mode = agent_prompt_mode
|
||||||
|
self.agent_command = agent_command
|
||||||
|
self.terminal_title = terminal_title
|
||||||
|
self.terminal_color = terminal_color
|
||||||
|
self.agent_provider_template = agent_provider_template
|
||||||
|
self.agent_workdir = agent_workdir
|
||||||
|
self._closed = False
|
||||||
|
|
||||||
|
def agent_argv(self, argv: list[str], *, tty: bool = True) -> list[str]:
|
||||||
|
full_argv = list(argv)
|
||||||
|
full_argv.extend(
|
||||||
|
prompt_args(
|
||||||
|
cast(PromptMode, self._agent_prompt_mode),
|
||||||
|
self.prompt_path,
|
||||||
|
argv=full_argv,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
cmd = ["container", "exec"]
|
||||||
|
if tty:
|
||||||
|
cmd.extend(["--interactive", "--tty"])
|
||||||
|
if self.agent_workdir and self.agent_workdir != "/home/node":
|
||||||
|
cmd.extend(["--workdir", self.agent_workdir])
|
||||||
|
cmd.extend([self.name, self.agent_command, *full_argv])
|
||||||
|
return cmd
|
||||||
|
|
||||||
|
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int:
|
||||||
|
agent_argv = self.agent_argv(argv, tty=tty)
|
||||||
|
script = (
|
||||||
|
exec_shell_script(agent_argv, self.terminal_title, self.terminal_color)
|
||||||
|
if tty else None
|
||||||
|
)
|
||||||
|
if script is None:
|
||||||
|
return subprocess.run(agent_argv, check=False).returncode
|
||||||
|
return subprocess.run(["sh", "-lc", script], check=False).returncode
|
||||||
|
|
||||||
|
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
|
result = subprocess.run(
|
||||||
|
["container", "exec", "--user", user, "--interactive",
|
||||||
|
self.name, "sh", "-s"],
|
||||||
|
input=script,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
return ExecResult(
|
||||||
|
returncode=result.returncode,
|
||||||
|
stdout=result.stdout,
|
||||||
|
stderr=result.stderr,
|
||||||
|
)
|
||||||
|
|
||||||
|
def cp_in(self, host_path: str, container_path: str) -> None:
|
||||||
|
subprocess.run(
|
||||||
|
["container", "cp", host_path, f"{self.name}:{container_path}"],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
if self._closed:
|
||||||
|
return
|
||||||
|
self._closed = True
|
||||||
|
self._teardown()
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
"""Cleanup plan for the macOS Apple Container backend."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from ...log import info
|
||||||
|
from .. import BottleCleanupPlan
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class MacosContainerBottleCleanupPlan(BottleCleanupPlan):
|
||||||
|
containers: tuple[str, ...] = ()
|
||||||
|
networks: tuple[str, ...] = ()
|
||||||
|
|
||||||
|
def print(self) -> None:
|
||||||
|
if not self.containers and not self.networks:
|
||||||
|
info("macos-container cleanup: nothing to remove")
|
||||||
|
return
|
||||||
|
for name in self.containers:
|
||||||
|
info(f"macos-container container: {name}")
|
||||||
|
for name in self.networks:
|
||||||
|
info(f"macos-container network: {name}")
|
||||||
|
|
||||||
|
@property
|
||||||
|
def empty(self) -> bool:
|
||||||
|
return not self.containers and not self.networks
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
"""Plan type for the macOS Apple Container backend."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode
|
||||||
|
from .. import BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class MacosContainerBottlePlan(BottlePlan):
|
||||||
|
slug: str
|
||||||
|
forwarded_env: dict[str, str] = field(repr=False)
|
||||||
|
agent_proxy_url: str = ""
|
||||||
|
agent_git_gate_url: str = ""
|
||||||
|
agent_supervise_url: str = ""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def container_name(self) -> str:
|
||||||
|
return self.agent_provision.instance_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def image(self) -> str:
|
||||||
|
return self.agent_provision.image
|
||||||
|
|
||||||
|
@property
|
||||||
|
def dockerfile_path(self) -> str:
|
||||||
|
return self.agent_provision.dockerfile
|
||||||
|
|
||||||
|
@property
|
||||||
|
def prompt_file(self) -> Path:
|
||||||
|
return self.agent_provision.prompt_file
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_command(self) -> str:
|
||||||
|
return self.agent_provision.command
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_prompt_mode(self) -> PromptMode:
|
||||||
|
return self.agent_provision.prompt_mode
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_provider_template(self) -> str:
|
||||||
|
return self.agent_provision.template
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_host(self) -> str:
|
||||||
|
if self.agent_git_gate_url.startswith("http://"):
|
||||||
|
return self.agent_git_gate_url.removeprefix("http://").rstrip("/")
|
||||||
|
return super().git_gate_insteadof_host
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_scheme(self) -> str:
|
||||||
|
if self.agent_git_gate_url.startswith("http://"):
|
||||||
|
return "http"
|
||||||
|
return super().git_gate_insteadof_scheme
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
"""Cleanup for the macOS Apple Container backend."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ...log import info, warn
|
||||||
|
from . import util as container_mod
|
||||||
|
from .bottle_cleanup_plan import MacosContainerBottleCleanupPlan
|
||||||
|
|
||||||
|
_PREFIX = "bot-bottle-"
|
||||||
|
_BUNDLE_PREFIX = "bot-bottle-sidecars-"
|
||||||
|
|
||||||
|
|
||||||
|
def _list_prefixed_containers() -> list[str]:
|
||||||
|
result = subprocess.run(
|
||||||
|
["container", "list", "--all", "--quiet"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
warn(f"container list failed: {result.stderr.strip()}")
|
||||||
|
return []
|
||||||
|
return sorted(
|
||||||
|
name for name in (line.strip() for line in result.stdout.splitlines())
|
||||||
|
if name.startswith(_PREFIX) or name.startswith(_BUNDLE_PREFIX)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _list_prefixed_networks() -> list[str]:
|
||||||
|
result = subprocess.run(
|
||||||
|
["container", "network", "list", "--quiet"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return []
|
||||||
|
return sorted(
|
||||||
|
name for name in (line.strip() for line in result.stdout.splitlines())
|
||||||
|
if name.startswith(_PREFIX)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_cleanup() -> MacosContainerBottleCleanupPlan:
|
||||||
|
container_mod.require_container()
|
||||||
|
return MacosContainerBottleCleanupPlan(
|
||||||
|
containers=tuple(_list_prefixed_containers()),
|
||||||
|
networks=tuple(_list_prefixed_networks()),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def cleanup(plan: MacosContainerBottleCleanupPlan) -> None:
|
||||||
|
for name in plan.containers:
|
||||||
|
info(f"container delete --force {name}")
|
||||||
|
subprocess.run(
|
||||||
|
["container", "delete", "--force", name],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
for name in plan.networks:
|
||||||
|
info(f"container network delete {name}")
|
||||||
|
subprocess.run(
|
||||||
|
["container", "network", "delete", name],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
"""Active-agent enumeration for the macOS Apple Container backend."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ...bottle_state import read_metadata
|
||||||
|
from .. import ActiveAgent
|
||||||
|
|
||||||
|
_PREFIX = "bot-bottle-"
|
||||||
|
_SIDECAR_PREFIX = "bot-bottle-sidecars-"
|
||||||
|
|
||||||
|
|
||||||
|
def enumerate_active() -> list[ActiveAgent]:
|
||||||
|
result = subprocess.run(
|
||||||
|
["container", "list", "--quiet"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return []
|
||||||
|
out: list[ActiveAgent] = []
|
||||||
|
for name in sorted(line.strip() for line in result.stdout.splitlines()):
|
||||||
|
if not name.startswith(_PREFIX):
|
||||||
|
continue
|
||||||
|
if name.startswith(_SIDECAR_PREFIX):
|
||||||
|
continue
|
||||||
|
slug = name[len(_PREFIX):]
|
||||||
|
metadata = read_metadata(slug)
|
||||||
|
out.append(ActiveAgent(
|
||||||
|
backend_name="macos-container",
|
||||||
|
slug=slug,
|
||||||
|
agent_name=metadata.agent_name if metadata else "?",
|
||||||
|
started_at=metadata.started_at if metadata else "",
|
||||||
|
services=(),
|
||||||
|
label=metadata.label if metadata else "",
|
||||||
|
color=metadata.color if metadata else "",
|
||||||
|
))
|
||||||
|
return out
|
||||||
@@ -0,0 +1,426 @@
|
|||||||
|
"""Launch flow for the macOS Apple Container backend.
|
||||||
|
|
||||||
|
This backend keeps the explicit proxy-env enforcement model for v1:
|
||||||
|
the agent container is attached only to a host-only Apple Container
|
||||||
|
network, while the sidecar bundle is attached to a NAT network first
|
||||||
|
and the host-only network second. The sidecar's host-only IP is
|
||||||
|
discovered from `container inspect` and stamped into the agent's
|
||||||
|
HTTP_PROXY / HTTPS_PROXY env vars.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import dataclasses
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
from contextlib import ExitStack, contextmanager
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Callable, Generator
|
||||||
|
|
||||||
|
from ...bottle_state import egress_state_dir, git_gate_state_dir
|
||||||
|
from ...egress import EGRESS_ROUTES_IN_CONTAINER, egress_resolve_token_values
|
||||||
|
from ...git_gate import revoke_git_gate_provisioned_keys
|
||||||
|
from ...log import die, info, warn
|
||||||
|
from ...supervise import QUEUE_DIR_IN_CONTAINER, SUPERVISE_PORT
|
||||||
|
from ...util import expand_tilde
|
||||||
|
from ..docker.egress import EGRESS_CA_IN_CONTAINER, EGRESS_PORT
|
||||||
|
from ..docker.git_gate import (
|
||||||
|
GIT_GATE_ACCESS_HOOK_IN_CONTAINER,
|
||||||
|
GIT_GATE_CREDS_DIR_IN_CONTAINER,
|
||||||
|
GIT_GATE_ENTRYPOINT_IN_CONTAINER,
|
||||||
|
GIT_GATE_HOOK_IN_CONTAINER,
|
||||||
|
)
|
||||||
|
from ..docker.sidecar_bundle import (
|
||||||
|
SIDECAR_BUNDLE_DOCKERFILE,
|
||||||
|
SIDECAR_BUNDLE_IMAGE,
|
||||||
|
)
|
||||||
|
from ..docker.egress import egress_tls_init
|
||||||
|
from ..util import AGENT_CA_BUNDLE, AGENT_CA_PATH
|
||||||
|
from . import util as container_mod
|
||||||
|
from .bottle import MacosContainerBottle
|
||||||
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
||||||
|
_AGENT_SLEEP_SECONDS = "2147483647"
|
||||||
|
_GIT_HTTP_PORT = 9420
|
||||||
|
_GIT_GATE_READY_FILE = "/run/git-gate/ready"
|
||||||
|
|
||||||
|
|
||||||
|
def internal_network_name(slug: str) -> str:
|
||||||
|
return f"bot-bottle-net-{slug}"
|
||||||
|
|
||||||
|
|
||||||
|
def egress_network_name(slug: str) -> str:
|
||||||
|
return f"bot-bottle-egress-{slug}"
|
||||||
|
|
||||||
|
|
||||||
|
def sidecar_container_name(slug: str) -> str:
|
||||||
|
return f"bot-bottle-sidecars-{slug}"
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
*,
|
||||||
|
provision: Callable[[MacosContainerBottlePlan, "MacosContainerBottle"], str | None],
|
||||||
|
) -> Generator[MacosContainerBottle, None, None]:
|
||||||
|
"""Build, run, provision, and yield an Apple Container bottle."""
|
||||||
|
stack = ExitStack()
|
||||||
|
bottle_for_revoke = plan.spec.manifest.bottle_for(plan.spec.agent_name)
|
||||||
|
git_gate_dir_for_revoke = git_gate_state_dir(plan.slug)
|
||||||
|
|
||||||
|
def teardown() -> None:
|
||||||
|
teardown_exc: BaseException | None = None
|
||||||
|
try:
|
||||||
|
stack.close()
|
||||||
|
except BaseException as exc: # noqa: W0718 - teardown must continue
|
||||||
|
teardown_exc = exc
|
||||||
|
warn(f"macos-container teardown failed: {exc!r}")
|
||||||
|
revoke_git_gate_provisioned_keys(bottle_for_revoke, git_gate_dir_for_revoke)
|
||||||
|
if teardown_exc is not None:
|
||||||
|
raise teardown_exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
plan = _mint_certs(plan)
|
||||||
|
_build_images(plan)
|
||||||
|
|
||||||
|
internal_network = internal_network_name(plan.slug)
|
||||||
|
egress_network = egress_network_name(plan.slug)
|
||||||
|
_create_networks(internal_network, egress_network, stack)
|
||||||
|
|
||||||
|
sidecar_name = sidecar_container_name(plan.slug)
|
||||||
|
container_mod.force_remove_container(sidecar_name)
|
||||||
|
_start_sidecar_bundle(plan, sidecar_name, internal_network, egress_network)
|
||||||
|
stack.callback(container_mod.force_remove_container, sidecar_name)
|
||||||
|
_stage_git_gate(plan, sidecar_name)
|
||||||
|
|
||||||
|
sidecar_ip = container_mod.container_ipv4_on_network(
|
||||||
|
sidecar_name, internal_network,
|
||||||
|
)
|
||||||
|
plan = _stamp_agent_urls(plan, sidecar_ip)
|
||||||
|
|
||||||
|
container_mod.force_remove_container(plan.container_name)
|
||||||
|
_start_agent(plan, internal_network, sidecar_ip)
|
||||||
|
stack.callback(container_mod.force_remove_container, plan.container_name)
|
||||||
|
|
||||||
|
bottle = MacosContainerBottle(
|
||||||
|
plan.container_name,
|
||||||
|
teardown,
|
||||||
|
None,
|
||||||
|
agent_command=plan.agent_command,
|
||||||
|
agent_prompt_mode=plan.agent_prompt_mode,
|
||||||
|
agent_provider_template=plan.agent_provider_template,
|
||||||
|
terminal_title=plan.spec.label or plan.spec.agent_name,
|
||||||
|
terminal_color=plan.spec.color,
|
||||||
|
agent_workdir=plan.workspace_plan.workdir,
|
||||||
|
)
|
||||||
|
bottle.prompt_path = provision(plan, bottle)
|
||||||
|
|
||||||
|
yield bottle
|
||||||
|
finally:
|
||||||
|
teardown()
|
||||||
|
|
||||||
|
|
||||||
|
def _mint_certs(plan: MacosContainerBottlePlan) -> MacosContainerBottlePlan:
|
||||||
|
egress_ca_host, egress_ca_cert_only = egress_tls_init(
|
||||||
|
egress_state_dir(plan.slug),
|
||||||
|
)
|
||||||
|
egress_plan = dataclasses.replace(
|
||||||
|
plan.egress_plan,
|
||||||
|
mitmproxy_ca_host_path=egress_ca_host,
|
||||||
|
mitmproxy_ca_cert_only_host_path=egress_ca_cert_only,
|
||||||
|
)
|
||||||
|
return dataclasses.replace(plan, egress_plan=egress_plan)
|
||||||
|
|
||||||
|
|
||||||
|
def _build_images(plan: MacosContainerBottlePlan) -> None:
|
||||||
|
container_mod.build_image(
|
||||||
|
SIDECAR_BUNDLE_IMAGE,
|
||||||
|
_REPO_DIR,
|
||||||
|
dockerfile=SIDECAR_BUNDLE_DOCKERFILE,
|
||||||
|
)
|
||||||
|
container_mod.build_image(
|
||||||
|
plan.image,
|
||||||
|
_REPO_DIR,
|
||||||
|
dockerfile=plan.dockerfile_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _create_networks(
|
||||||
|
internal_network: str,
|
||||||
|
egress_network: str,
|
||||||
|
stack: ExitStack,
|
||||||
|
) -> None:
|
||||||
|
container_mod.create_network(internal_network, internal=True)
|
||||||
|
stack.callback(container_mod.remove_network, internal_network)
|
||||||
|
container_mod.create_network(egress_network)
|
||||||
|
stack.callback(container_mod.remove_network, egress_network)
|
||||||
|
|
||||||
|
|
||||||
|
def _start_sidecar_bundle(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
sidecar_name: str,
|
||||||
|
internal_network: str,
|
||||||
|
egress_network: str,
|
||||||
|
) -> None:
|
||||||
|
argv = _sidecar_run_argv(plan, sidecar_name, internal_network, egress_network)
|
||||||
|
effective_env = {**dict(os.environ), **plan.agent_provision.provisioned_env}
|
||||||
|
token_values = egress_resolve_token_values(
|
||||||
|
plan.egress_plan.token_env_map, effective_env,
|
||||||
|
)
|
||||||
|
env = {**os.environ, **token_values}
|
||||||
|
info(f"container run sidecar bundle {sidecar_name}")
|
||||||
|
result = subprocess.run(
|
||||||
|
argv, capture_output=True, text=True, env=env, check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container run for sidecar bundle {sidecar_name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _start_agent(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
internal_network: str,
|
||||||
|
sidecar_ip: str,
|
||||||
|
) -> None:
|
||||||
|
argv = _agent_run_argv(plan, internal_network, sidecar_ip)
|
||||||
|
env = {
|
||||||
|
**os.environ,
|
||||||
|
**plan.forwarded_env,
|
||||||
|
}
|
||||||
|
info(f"container run agent {plan.container_name}")
|
||||||
|
result = subprocess.run(
|
||||||
|
argv, capture_output=True, text=True, env=env, check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container run for agent {plan.container_name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _stamp_agent_urls(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
sidecar_ip: str,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
proxy_url = f"http://{sidecar_ip}:{EGRESS_PORT}"
|
||||||
|
supervise_url = ""
|
||||||
|
if plan.supervise_plan is not None:
|
||||||
|
supervise_url = f"http://{sidecar_ip}:{SUPERVISE_PORT}/"
|
||||||
|
git_gate_url = ""
|
||||||
|
if plan.git_gate_plan.upstreams:
|
||||||
|
git_gate_url = f"http://{sidecar_ip}:{_GIT_HTTP_PORT}"
|
||||||
|
return dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
agent_proxy_url=proxy_url,
|
||||||
|
agent_git_gate_url=git_gate_url,
|
||||||
|
agent_supervise_url=supervise_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _stage_git_gate(plan: MacosContainerBottlePlan, sidecar_name: str) -> None:
|
||||||
|
gp = plan.git_gate_plan
|
||||||
|
if not gp.upstreams:
|
||||||
|
return
|
||||||
|
|
||||||
|
container_mod.exec_container(
|
||||||
|
sidecar_name,
|
||||||
|
[
|
||||||
|
"mkdir",
|
||||||
|
"-p",
|
||||||
|
str(Path(GIT_GATE_HOOK_IN_CONTAINER).parent),
|
||||||
|
GIT_GATE_CREDS_DIR_IN_CONTAINER,
|
||||||
|
"/git",
|
||||||
|
str(Path(_GIT_GATE_READY_FILE).parent),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
for host_path, container_path in _git_gate_files(plan):
|
||||||
|
container_mod.copy_into_container(
|
||||||
|
sidecar_name, host_path, container_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
container_mod.exec_container(
|
||||||
|
sidecar_name,
|
||||||
|
[
|
||||||
|
"sh",
|
||||||
|
"-c",
|
||||||
|
"chmod 755 "
|
||||||
|
f"{GIT_GATE_ENTRYPOINT_IN_CONTAINER} "
|
||||||
|
f"{GIT_GATE_HOOK_IN_CONTAINER} "
|
||||||
|
f"{GIT_GATE_ACCESS_HOOK_IN_CONTAINER} && "
|
||||||
|
f"chmod 600 {GIT_GATE_CREDS_DIR_IN_CONTAINER}/* && "
|
||||||
|
f"touch {_GIT_GATE_READY_FILE}",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _git_gate_files(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
) -> tuple[tuple[str, str], ...]:
|
||||||
|
gp = plan.git_gate_plan
|
||||||
|
files: list[tuple[str, str]] = [
|
||||||
|
(str(gp.entrypoint_script), GIT_GATE_ENTRYPOINT_IN_CONTAINER),
|
||||||
|
(str(gp.hook_script), GIT_GATE_HOOK_IN_CONTAINER),
|
||||||
|
(str(gp.access_hook_script), GIT_GATE_ACCESS_HOOK_IN_CONTAINER),
|
||||||
|
]
|
||||||
|
for upstream in gp.upstreams:
|
||||||
|
files.append((
|
||||||
|
expand_tilde(upstream.identity_file),
|
||||||
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{upstream.name}-key",
|
||||||
|
))
|
||||||
|
if upstream.known_hosts_file:
|
||||||
|
files.append((
|
||||||
|
str(upstream.known_hosts_file),
|
||||||
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{upstream.name}-known_hosts",
|
||||||
|
))
|
||||||
|
return tuple(files)
|
||||||
|
|
||||||
|
|
||||||
|
def _sidecar_run_argv(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
sidecar_name: str,
|
||||||
|
internal_network: str,
|
||||||
|
egress_network: str,
|
||||||
|
) -> list[str]:
|
||||||
|
argv = [
|
||||||
|
"container", "run",
|
||||||
|
"--name", sidecar_name,
|
||||||
|
"--detach",
|
||||||
|
"--rm",
|
||||||
|
"--network", egress_network,
|
||||||
|
"--network", internal_network,
|
||||||
|
"--dns", _sidecar_dns(),
|
||||||
|
"--env", f"BOT_BOTTLE_SIDECAR_DAEMONS={','.join(_sidecar_daemons(plan))}",
|
||||||
|
]
|
||||||
|
for entry in _sidecar_env_entries(plan):
|
||||||
|
argv += ["--env", entry]
|
||||||
|
for host_path, container_path, read_only in _sidecar_mounts(plan):
|
||||||
|
argv += ["--mount", _mount_spec(host_path, container_path, read_only)]
|
||||||
|
argv.append(SIDECAR_BUNDLE_IMAGE)
|
||||||
|
return argv
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_run_argv(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
internal_network: str,
|
||||||
|
sidecar_ip: str,
|
||||||
|
) -> list[str]:
|
||||||
|
argv = [
|
||||||
|
"container", "run",
|
||||||
|
"--name", plan.container_name,
|
||||||
|
"--detach",
|
||||||
|
"--rm",
|
||||||
|
"--network", internal_network,
|
||||||
|
]
|
||||||
|
for entry in _agent_env_entries(plan, sidecar_ip):
|
||||||
|
argv += ["--env", entry]
|
||||||
|
argv += [plan.image, "sleep", _AGENT_SLEEP_SECONDS]
|
||||||
|
return argv
|
||||||
|
|
||||||
|
|
||||||
|
def _sidecar_dns() -> str:
|
||||||
|
return container_mod.dns_server()
|
||||||
|
|
||||||
|
|
||||||
|
def _sidecar_daemons(plan: MacosContainerBottlePlan) -> tuple[str, ...]:
|
||||||
|
daemons = ["egress"]
|
||||||
|
if plan.git_gate_plan.upstreams:
|
||||||
|
daemons += ["git-gate", "git-http"]
|
||||||
|
if plan.supervise_plan is not None:
|
||||||
|
daemons.append("supervise")
|
||||||
|
return tuple(daemons)
|
||||||
|
|
||||||
|
|
||||||
|
def _sidecar_env_entries(plan: MacosContainerBottlePlan) -> tuple[str, ...]:
|
||||||
|
env: list[str] = []
|
||||||
|
if plan.egress_plan.routes:
|
||||||
|
env.extend(sorted(plan.egress_plan.token_env_map.keys()))
|
||||||
|
if plan.git_gate_plan.upstreams:
|
||||||
|
env.append(f"BOT_BOTTLE_GIT_GATE_READY_FILE={_GIT_GATE_READY_FILE}")
|
||||||
|
if plan.supervise_plan is not None:
|
||||||
|
env += [
|
||||||
|
f"SUPERVISE_BOTTLE_SLUG={plan.slug}",
|
||||||
|
f"SUPERVISE_QUEUE_DIR={QUEUE_DIR_IN_CONTAINER}",
|
||||||
|
f"SUPERVISE_PORT={SUPERVISE_PORT}",
|
||||||
|
]
|
||||||
|
return tuple(env)
|
||||||
|
|
||||||
|
|
||||||
|
def _sidecar_mounts(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
) -> tuple[tuple[str, str, bool], ...]:
|
||||||
|
mounts: list[tuple[str, str, bool]] = []
|
||||||
|
|
||||||
|
ep = plan.egress_plan
|
||||||
|
mounts.append((
|
||||||
|
str(ep.mitmproxy_ca_host_path.parent),
|
||||||
|
str(Path(EGRESS_CA_IN_CONTAINER).parent),
|
||||||
|
False,
|
||||||
|
))
|
||||||
|
if ep.routes:
|
||||||
|
mounts.append((
|
||||||
|
str(_stage_routes_dir(plan)),
|
||||||
|
str(Path(EGRESS_ROUTES_IN_CONTAINER).parent),
|
||||||
|
True,
|
||||||
|
))
|
||||||
|
|
||||||
|
sp = plan.supervise_plan
|
||||||
|
if sp is not None:
|
||||||
|
mounts.append((str(sp.queue_dir), QUEUE_DIR_IN_CONTAINER, False))
|
||||||
|
|
||||||
|
return tuple(mounts)
|
||||||
|
|
||||||
|
|
||||||
|
def _stage_routes_dir(plan: MacosContainerBottlePlan) -> Path:
|
||||||
|
routes_dir = plan.stage_dir / "macos-container-egress"
|
||||||
|
routes_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
shutil.copyfile(
|
||||||
|
plan.egress_plan.routes_path,
|
||||||
|
routes_dir / Path(EGRESS_ROUTES_IN_CONTAINER).name,
|
||||||
|
)
|
||||||
|
return routes_dir
|
||||||
|
|
||||||
|
|
||||||
|
def _mount_spec(host_path: str, container_path: str, read_only: bool) -> str:
|
||||||
|
spec = f"type=bind,source={host_path},target={container_path}"
|
||||||
|
if read_only:
|
||||||
|
spec += ",readonly"
|
||||||
|
return spec
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_env_entries(
|
||||||
|
plan: MacosContainerBottlePlan,
|
||||||
|
sidecar_ip: str,
|
||||||
|
) -> tuple[str, ...]:
|
||||||
|
proxy_url = f"http://{sidecar_ip}:{EGRESS_PORT}"
|
||||||
|
no_proxy = _agent_no_proxy(plan, sidecar_ip)
|
||||||
|
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"NODE_EXTRA_CA_CERTS={AGENT_CA_PATH}",
|
||||||
|
f"SSL_CERT_FILE={AGENT_CA_BUNDLE}",
|
||||||
|
f"REQUESTS_CA_BUNDLE={AGENT_CA_BUNDLE}",
|
||||||
|
]
|
||||||
|
if plan.agent_git_gate_url:
|
||||||
|
env.append(f"GIT_GATE_URL={plan.agent_git_gate_url}")
|
||||||
|
if plan.agent_supervise_url:
|
||||||
|
env.append(f"MCP_SUPERVISE_URL={plan.agent_supervise_url}")
|
||||||
|
for name, value in sorted(plan.agent_provision.guest_env.items()):
|
||||||
|
env.append(f"{name}={value}")
|
||||||
|
for name in sorted(plan.forwarded_env.keys()):
|
||||||
|
env.append(name)
|
||||||
|
return tuple(env)
|
||||||
|
|
||||||
|
|
||||||
|
def _agent_no_proxy(plan: MacosContainerBottlePlan, sidecar_ip: str) -> str:
|
||||||
|
hosts = ["localhost", "127.0.0.1", sidecar_ip]
|
||||||
|
return ",".join(hosts)
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
"""Prepare step for the macOS Apple Container backend."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from .. import BottleSpec
|
||||||
|
from . import util as container_mod
|
||||||
|
from .bottle_plan import MacosContainerBottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
def preflight() -> None:
|
||||||
|
container_mod.require_container()
|
||||||
|
|
||||||
|
|
||||||
|
def build_guest_env(resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return dict(resolved_env.literals)
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_plan(
|
||||||
|
spec: BottleSpec,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> MacosContainerBottlePlan:
|
||||||
|
return MacosContainerBottlePlan(
|
||||||
|
spec=spec,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
slug=slug,
|
||||||
|
forwarded_env=dict(resolved_env.forwarded),
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
agent_provision=agent_provision_plan,
|
||||||
|
)
|
||||||
@@ -0,0 +1,388 @@
|
|||||||
|
"""Host-side primitives for Apple's `container` CLI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import ipaddress
|
||||||
|
import platform
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import time
|
||||||
|
from typing import Iterable
|
||||||
|
|
||||||
|
from ...log import die, info
|
||||||
|
|
||||||
|
|
||||||
|
_CONTAINER = "container"
|
||||||
|
_DEFAULT_DNS = "1.1.1.1"
|
||||||
|
|
||||||
|
|
||||||
|
def is_macos() -> bool:
|
||||||
|
return platform.system() == "Darwin"
|
||||||
|
|
||||||
|
|
||||||
|
def is_available() -> bool:
|
||||||
|
return is_macos() and shutil.which(_CONTAINER) is not None
|
||||||
|
|
||||||
|
|
||||||
|
def require_container() -> None:
|
||||||
|
"""Fail with an install pointer if Apple Container is unavailable."""
|
||||||
|
if not is_macos():
|
||||||
|
info("BOT_BOTTLE_BACKEND=macos-container requires macOS.")
|
||||||
|
die("macos-container backend is only supported on macOS")
|
||||||
|
if shutil.which(_CONTAINER) is None:
|
||||||
|
info("Apple Container is required but was not found on PATH.")
|
||||||
|
info("Install: https://github.com/apple/container/releases")
|
||||||
|
die("container not found")
|
||||||
|
_require_container_service()
|
||||||
|
|
||||||
|
|
||||||
|
def _require_container_service() -> None:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "system", "status"],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
info("Apple Container system service is not running.")
|
||||||
|
info("Start it with: container system start")
|
||||||
|
die("container system service not running")
|
||||||
|
|
||||||
|
|
||||||
|
def dns_server() -> str:
|
||||||
|
override = os.environ.get("BOT_BOTTLE_MACOS_CONTAINER_DNS", "").strip()
|
||||||
|
if override:
|
||||||
|
return override
|
||||||
|
return _host_ipv4_dns() or _DEFAULT_DNS
|
||||||
|
|
||||||
|
|
||||||
|
def build_image(ref: str, context: str, *, dockerfile: str = "") -> None:
|
||||||
|
"""Build an OCI image with Apple's BuildKit-backed `container build`."""
|
||||||
|
info(
|
||||||
|
f"building image {ref} from {context} with Apple Container "
|
||||||
|
"(layer cache keeps repeat builds fast)"
|
||||||
|
)
|
||||||
|
_ensure_builder_dns()
|
||||||
|
args = [_CONTAINER, "build", "-t", ref, "--dns", dns_server()]
|
||||||
|
if dockerfile:
|
||||||
|
args.extend(["-f", dockerfile])
|
||||||
|
args.append(context)
|
||||||
|
subprocess.run(args, check=True)
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_builder_dns() -> None:
|
||||||
|
dns = dns_server()
|
||||||
|
status = _builder_status()
|
||||||
|
override = os.environ.get("BOT_BOTTLE_MACOS_CONTAINER_DNS", "").strip()
|
||||||
|
if _builder_running(status) and _builder_resolves_build_hosts():
|
||||||
|
if override and not _builder_has_dns(status, dns):
|
||||||
|
_restart_builder_with_dns(dns)
|
||||||
|
return
|
||||||
|
_restart_builder_with_dns(dns)
|
||||||
|
|
||||||
|
|
||||||
|
def _restart_builder_with_dns(dns: str) -> None:
|
||||||
|
subprocess.run(
|
||||||
|
[_CONTAINER, "builder", "stop"],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
subprocess.run(
|
||||||
|
[_CONTAINER, "builder", "start", "--dns", dns],
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _host_ipv4_dns() -> str:
|
||||||
|
if not is_macos():
|
||||||
|
return ""
|
||||||
|
result = subprocess.run(
|
||||||
|
["scutil", "--dns"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return ""
|
||||||
|
blocks: list[list[str]] = []
|
||||||
|
current: list[str] = []
|
||||||
|
for line in result.stdout.splitlines():
|
||||||
|
if line.startswith("resolver #") and current:
|
||||||
|
blocks.append(current)
|
||||||
|
current = []
|
||||||
|
current.append(line)
|
||||||
|
if current:
|
||||||
|
blocks.append(current)
|
||||||
|
for direct_only in (True, False):
|
||||||
|
for block in blocks:
|
||||||
|
text = "\n".join(block)
|
||||||
|
if direct_only and "Directly Reachable Address" not in text:
|
||||||
|
continue
|
||||||
|
for line in block:
|
||||||
|
if "nameserver[" not in line or ":" not in line:
|
||||||
|
continue
|
||||||
|
candidate = line.split(":", 1)[1].strip()
|
||||||
|
if _usable_ipv4(candidate):
|
||||||
|
return candidate
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def _usable_ipv4(value: str) -> bool:
|
||||||
|
try:
|
||||||
|
address = ipaddress.ip_address(value)
|
||||||
|
except ValueError:
|
||||||
|
return False
|
||||||
|
return (
|
||||||
|
address.version == 4
|
||||||
|
and not address.is_loopback
|
||||||
|
and not address.is_link_local
|
||||||
|
and not address.is_multicast
|
||||||
|
and not address.is_unspecified
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _builder_status() -> list[dict[str, object]]:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "builder", "status", "--format", "json"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return []
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "[]")
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return []
|
||||||
|
if isinstance(data, list):
|
||||||
|
return [entry for entry in data if isinstance(entry, dict)]
|
||||||
|
if isinstance(data, dict):
|
||||||
|
return [data]
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def _builder_running(status: list[dict[str, object]]) -> bool:
|
||||||
|
for entry in status:
|
||||||
|
entry_status = entry.get("status")
|
||||||
|
if isinstance(entry_status, dict) and entry_status.get("state") == "running":
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _builder_dns_nameservers(status: list[dict[str, object]]) -> list[str]:
|
||||||
|
out: list[str] = []
|
||||||
|
for entry in status:
|
||||||
|
config = entry.get("configuration")
|
||||||
|
config_dns = config.get("dns") if isinstance(config, dict) else None
|
||||||
|
nameservers = (
|
||||||
|
config_dns.get("nameservers")
|
||||||
|
if isinstance(config_dns, dict)
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
if not isinstance(nameservers, list):
|
||||||
|
continue
|
||||||
|
out.extend(name for name in nameservers if isinstance(name, str))
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _builder_has_dns(status: list[dict[str, object]], dns: str) -> bool:
|
||||||
|
return dns in _builder_dns_nameservers(status)
|
||||||
|
|
||||||
|
|
||||||
|
def _builder_resolves_build_hosts() -> bool:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "exec", "buildkit", "getent", "hosts", "deb.debian.org"],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
return result.returncode == 0
|
||||||
|
|
||||||
|
|
||||||
|
def image_exists(ref: str) -> bool:
|
||||||
|
return _silent_run([_CONTAINER, "image", "inspect", ref]) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def container_exists(name: str) -> bool:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "list", "--all", "--quiet"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return False
|
||||||
|
return name in {line.strip() for line in result.stdout.splitlines()}
|
||||||
|
|
||||||
|
|
||||||
|
def force_remove_container(name: str) -> None:
|
||||||
|
if container_exists(name):
|
||||||
|
subprocess.run(
|
||||||
|
[_CONTAINER, "delete", "--force", name],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def copy_into_container(name: str, host_path: str, container_path: str) -> None:
|
||||||
|
cmd = [_CONTAINER, "cp", host_path, f"{name}:{container_path}"]
|
||||||
|
result = _run_container_op(cmd)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container cp into {name}:{container_path} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def exec_container(name: str, argv: list[str]) -> None:
|
||||||
|
result = _run_container_op([_CONTAINER, "exec", name, *argv])
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container exec in {name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _run_container_op(cmd: list[str]) -> subprocess.CompletedProcess[str]:
|
||||||
|
result = subprocess.run(
|
||||||
|
cmd,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
for _ in range(19):
|
||||||
|
if result.returncode == 0:
|
||||||
|
return result
|
||||||
|
time.sleep(0.1)
|
||||||
|
result = subprocess.run(
|
||||||
|
cmd,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def create_network(name: str, *, internal: bool = False) -> None:
|
||||||
|
args = [
|
||||||
|
_CONTAINER, "network", "create",
|
||||||
|
"--label", "bot-bottle.backend=macos-container",
|
||||||
|
]
|
||||||
|
if internal:
|
||||||
|
args.append("--internal")
|
||||||
|
args.append(name)
|
||||||
|
result = subprocess.run(
|
||||||
|
args, capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
return
|
||||||
|
if "already exists" in (result.stderr or "").lower():
|
||||||
|
return
|
||||||
|
die(
|
||||||
|
f"container network create {name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def remove_network(name: str) -> None:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "network", "delete", name],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
|
def inspect_container(name: str) -> dict[str, object]:
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "inspect", name],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container inspect {name} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "[]")
|
||||||
|
except json.JSONDecodeError as exc:
|
||||||
|
die(f"container inspect {name} returned malformed JSON: {exc}")
|
||||||
|
if isinstance(data, list) and data and isinstance(data[0], dict):
|
||||||
|
return data[0]
|
||||||
|
if isinstance(data, dict):
|
||||||
|
return data
|
||||||
|
die(f"container inspect {name} returned an unexpected shape")
|
||||||
|
raise AssertionError("unreachable")
|
||||||
|
|
||||||
|
|
||||||
|
def container_ipv4_on_network(name: str, network: str) -> str:
|
||||||
|
data = inspect_container(name)
|
||||||
|
status = data.get("status")
|
||||||
|
networks = status.get("networks") if isinstance(status, dict) else None
|
||||||
|
if not isinstance(networks, list):
|
||||||
|
die(f"container inspect {name} did not include status.networks")
|
||||||
|
for entry in networks:
|
||||||
|
if not isinstance(entry, dict):
|
||||||
|
continue
|
||||||
|
if entry.get("network") != network:
|
||||||
|
continue
|
||||||
|
raw = entry.get("ipv4Address")
|
||||||
|
if not isinstance(raw, str) or not raw:
|
||||||
|
die(f"container {name} has no IPv4 address on {network}")
|
||||||
|
return raw.split("/", 1)[0]
|
||||||
|
die(f"container {name} is not attached to network {network}")
|
||||||
|
raise AssertionError("unreachable")
|
||||||
|
|
||||||
|
|
||||||
|
def image_id(ref: str) -> str:
|
||||||
|
"""Return the image digest/ID from `container image inspect`.
|
||||||
|
|
||||||
|
The command returns JSON on current Apple Container releases. Keep
|
||||||
|
parsing narrow and fatal so callers do not cache on an empty key.
|
||||||
|
"""
|
||||||
|
import json
|
||||||
|
|
||||||
|
result = subprocess.run(
|
||||||
|
[_CONTAINER, "image", "inspect", ref],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
die(
|
||||||
|
f"container image inspect for {ref!r} failed: "
|
||||||
|
f"{(result.stderr or '').strip() or '<no stderr>'}"
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
data = json.loads(result.stdout or "{}")
|
||||||
|
except json.JSONDecodeError as exc:
|
||||||
|
die(f"container image inspect for {ref!r} returned malformed JSON: {exc}")
|
||||||
|
if isinstance(data, list) and data:
|
||||||
|
data = data[0]
|
||||||
|
if isinstance(data, dict):
|
||||||
|
value = data.get("id") or data.get("digest") or data.get("ID")
|
||||||
|
if value:
|
||||||
|
return str(value)
|
||||||
|
die(f"container image inspect for {ref!r} did not include an image id")
|
||||||
|
raise AssertionError("unreachable")
|
||||||
|
|
||||||
|
|
||||||
|
def save(ref: str, output: str) -> None:
|
||||||
|
subprocess.run([_CONTAINER, "image", "save", ref, "-o", output], check=True)
|
||||||
|
|
||||||
|
|
||||||
|
def _silent_run(cmd: Iterable[str]) -> int:
|
||||||
|
return subprocess.run(
|
||||||
|
list(cmd),
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
).returncode
|
||||||
@@ -26,3 +26,16 @@ def print_multi(label: str, values: Sequence[str]) -> None:
|
|||||||
indent = " " * (len(label) + 2)
|
indent = " " * (len(label) + 2)
|
||||||
for v in values[1:]:
|
for v in values[1:]:
|
||||||
info(f"{indent}{v}")
|
info(f"{indent}{v}")
|
||||||
|
|
||||||
|
|
||||||
|
def visible_agent_env_names(
|
||||||
|
env_names: Sequence[str], *, hidden_env_names: frozenset[str],
|
||||||
|
) -> list[str]:
|
||||||
|
"""Env names worth showing in launch summaries.
|
||||||
|
|
||||||
|
Provider-injected placeholder env vars are implementation details:
|
||||||
|
they are non-secret dummy values that satisfy provider CLIs while
|
||||||
|
egress injects the real Authorization header. The plan's
|
||||||
|
`hidden_env_names` carries exactly which names to suppress.
|
||||||
|
"""
|
||||||
|
return sorted({name for name in env_names if name and name not in hidden_env_names})
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
"""Shared helpers used by both backends' resolve_plan steps.
|
||||||
|
|
||||||
|
Each helper owns one well-defined step of the per-bottle plan
|
||||||
|
resolution so docker and smolmachines don't repeat the same logic.
|
||||||
|
Backend-specific steps (container names, env-file, per-bottle
|
||||||
|
Dockerfile overrides, subnet allocation) stay in the backend's own
|
||||||
|
resolve_plan.py.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import replace
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ..agent_provider import AgentProvisionPlan
|
||||||
|
from ..bottle_state import (
|
||||||
|
BottleMetadata,
|
||||||
|
agent_state_dir,
|
||||||
|
bottle_identity,
|
||||||
|
egress_state_dir,
|
||||||
|
git_gate_state_dir,
|
||||||
|
supervise_state_dir,
|
||||||
|
write_metadata,
|
||||||
|
)
|
||||||
|
from ..egress import Egress, EgressPlan
|
||||||
|
from ..git_gate import GitGate, GitGatePlan
|
||||||
|
from ..manifest import ManifestBottle
|
||||||
|
from ..supervise import Supervise, SupervisePlan
|
||||||
|
from . import BottleSpec
|
||||||
|
|
||||||
|
|
||||||
|
def mint_slug(spec: BottleSpec) -> str:
|
||||||
|
"""Return the bottle identity: the recorded identity for a resume,
|
||||||
|
or a freshly minted one for a new start."""
|
||||||
|
return spec.identity or bottle_identity(spec.agent_name)
|
||||||
|
|
||||||
|
|
||||||
|
def write_launch_metadata(
|
||||||
|
slug: str, spec: BottleSpec, *, compose_project: str, backend: str,
|
||||||
|
) -> None:
|
||||||
|
"""Persist launch metadata so `cli.py resume <identity>` can
|
||||||
|
reconstruct the spec. Idempotent — re-writes on resume with a
|
||||||
|
refreshed started_at."""
|
||||||
|
write_metadata(BottleMetadata(
|
||||||
|
identity=slug,
|
||||||
|
agent_name=spec.agent_name,
|
||||||
|
cwd=spec.user_cwd if spec.copy_cwd else "",
|
||||||
|
copy_cwd=spec.copy_cwd,
|
||||||
|
started_at=datetime.now(timezone.utc).isoformat(),
|
||||||
|
compose_project=compose_project,
|
||||||
|
backend=backend,
|
||||||
|
label=spec.label,
|
||||||
|
color=spec.color,
|
||||||
|
))
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_agent_state_dir(slug: str, spec: BottleSpec) -> tuple[Path, Path]:
|
||||||
|
"""Create the agent state subdir, write the prompt file.
|
||||||
|
Returns (agent_dir, prompt_file)."""
|
||||||
|
manifest = spec.manifest
|
||||||
|
agent = manifest.agents[spec.agent_name]
|
||||||
|
agent_dir = agent_state_dir(slug)
|
||||||
|
agent_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
prompt_file = agent_dir / "prompt.txt"
|
||||||
|
prompt_file.write_text(agent.prompt or "")
|
||||||
|
prompt_file.chmod(0o600)
|
||||||
|
return agent_dir, prompt_file
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_git_gate(bottle: ManifestBottle, slug: str) -> GitGatePlan:
|
||||||
|
git_gate_dir = git_gate_state_dir(slug)
|
||||||
|
git_gate_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
return GitGate().prepare(bottle, slug, git_gate_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_egress(
|
||||||
|
bottle: ManifestBottle, slug: str, provision: AgentProvisionPlan,
|
||||||
|
) -> EgressPlan:
|
||||||
|
egress_dir = egress_state_dir(slug)
|
||||||
|
egress_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
return Egress().prepare(bottle, slug, egress_dir, provision.egress_routes)
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_supervise(bottle: ManifestBottle, slug: str) -> SupervisePlan | None:
|
||||||
|
"""Prepare the supervise sidecar state dir. Returns None when
|
||||||
|
bottle.supervise is falsy."""
|
||||||
|
if not bottle.supervise:
|
||||||
|
return None
|
||||||
|
supervise_dir = supervise_state_dir(slug)
|
||||||
|
supervise_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
return Supervise().prepare(slug, supervise_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def merge_provision_env_vars(provision: AgentProvisionPlan) -> AgentProvisionPlan:
|
||||||
|
"""Fold provision.env_vars into guest_env (setdefault semantics)
|
||||||
|
and return a new plan with the merged guest_env."""
|
||||||
|
merged = dict(provision.guest_env)
|
||||||
|
for key, val in provision.env_vars.items():
|
||||||
|
merged.setdefault(key, val)
|
||||||
|
return replace(provision, guest_env=merged)
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_manifest_dockerfile(path_value: str, spec: BottleSpec) -> str:
|
||||||
|
"""Resolve a manifest-supplied dockerfile path relative to user_cwd."""
|
||||||
|
path = Path(os.path.expanduser(path_value))
|
||||||
|
if not path.is_absolute():
|
||||||
|
path = Path(spec.user_cwd) / path
|
||||||
|
return str(path)
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"merge_provision_env_vars",
|
||||||
|
"mint_slug",
|
||||||
|
"prepare_agent_state_dir",
|
||||||
|
"prepare_egress",
|
||||||
|
"prepare_git_gate",
|
||||||
|
"prepare_supervise",
|
||||||
|
"resolve_manifest_dockerfile",
|
||||||
|
"write_launch_metadata",
|
||||||
|
]
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
"""smolmachines bottle backend (PRD 0023).
|
"""smolmachines bottle backend (PRD 0023).
|
||||||
|
|
||||||
Selectable via `CLAUDE_BOTTLE_BACKEND=smolmachines`. Runs each
|
Selectable via `BOT_BOTTLE_BACKEND=smolmachines`. Runs each
|
||||||
bottle inside a per-agent microVM (libkrun / Hypervisor.framework
|
bottle inside a per-agent microVM (libkrun / Hypervisor.framework
|
||||||
on macOS) with a userspace gvproxy gateway as the egress
|
on macOS) with a userspace gvproxy gateway as the egress
|
||||||
primitive. The sidecar bundle (PRD 0024) runs as a host-side
|
primitive. The sidecar bundle (PRD 0024) runs as a host-side
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
"""SmolmachinesBottleBackend — the smolmachines implementation of
|
||||||
|
BottleBackend (PRD 0023).
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider provisioning steps (prompt, skills,
|
||||||
|
the declarative provision-plan apply, supervise MCP registration)
|
||||||
|
live on the `AgentProvider` plugin under `bot_bottle/contrib/`. The
|
||||||
|
smolmachines backend only owns the steps that are about backend
|
||||||
|
infrastructure: CA install (no-op for now), workspace, git copy-in."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Generator, Sequence
|
||||||
|
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from .. import ActiveAgent, BottleBackend, BottleSpec
|
||||||
|
from . import cleanup as _cleanup
|
||||||
|
from . import enumerate as _enumerate
|
||||||
|
from . import launch as _launch
|
||||||
|
from . import resolve_plan as _resolve_plan
|
||||||
|
from . import smolvm as _smolvm
|
||||||
|
from .bottle import SmolmachinesBottle
|
||||||
|
from .bottle_cleanup_plan import SmolmachinesBottleCleanupPlan
|
||||||
|
from .bottle_plan import SmolmachinesBottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
class SmolmachinesBottleBackend(
|
||||||
|
BottleBackend["SmolmachinesBottlePlan", "SmolmachinesBottleCleanupPlan"]
|
||||||
|
):
|
||||||
|
"""smolmachines backend. Selected by
|
||||||
|
`BOT_BOTTLE_BACKEND=smolmachines`."""
|
||||||
|
|
||||||
|
name = "smolmachines"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def is_available(cls) -> bool:
|
||||||
|
"""`smolvm` on PATH. The backend additionally needs macOS
|
||||||
|
for libkrun + TSI, but `enumerate_active` / `cleanup` are
|
||||||
|
host-shell ops that gracefully no-op on Linux too — the
|
||||||
|
runtime check happens at `prepare`."""
|
||||||
|
return _smolvm.is_available()
|
||||||
|
|
||||||
|
def _preflight(self) -> None:
|
||||||
|
_resolve_plan.preflight()
|
||||||
|
|
||||||
|
def _build_guest_env(self, resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
return _resolve_plan.build_guest_env(resolved_env)
|
||||||
|
|
||||||
|
def _resolve_plan(
|
||||||
|
self,
|
||||||
|
spec: BottleSpec,
|
||||||
|
*,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> SmolmachinesBottlePlan:
|
||||||
|
return _resolve_plan.resolve_plan(
|
||||||
|
spec,
|
||||||
|
slug=slug,
|
||||||
|
resolved_env=resolved_env,
|
||||||
|
agent_provision_plan=agent_provision_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(
|
||||||
|
self, plan: SmolmachinesBottlePlan
|
||||||
|
) -> Generator[SmolmachinesBottle, None, None]:
|
||||||
|
with _launch.launch(plan, provision=self.provision) as bottle:
|
||||||
|
yield bottle
|
||||||
|
|
||||||
|
def supervise_mcp_url(self, plan: SmolmachinesBottlePlan) -> str:
|
||||||
|
"""The smolmachines guest reaches the supervise sidecar via a
|
||||||
|
host-published random port the launch step pinned earlier
|
||||||
|
(`http://<loopback_ip>:<random_port>/`). `agent_supervise_url`
|
||||||
|
on the plan is "" when the bottle has no sidecar."""
|
||||||
|
return plan.agent_supervise_url
|
||||||
|
|
||||||
|
def prepare_cleanup(self) -> SmolmachinesBottleCleanupPlan:
|
||||||
|
return _cleanup.prepare_cleanup()
|
||||||
|
|
||||||
|
def cleanup(self, plan: SmolmachinesBottleCleanupPlan) -> None:
|
||||||
|
_cleanup.cleanup(plan)
|
||||||
|
|
||||||
|
def enumerate_active(self) -> Sequence[ActiveAgent]:
|
||||||
|
return _enumerate.enumerate_active()
|
||||||
@@ -0,0 +1,198 @@
|
|||||||
|
"""SmolmachinesBottle — running-instance handle (PRD 0023 chunk 2d).
|
||||||
|
|
||||||
|
Routes `exec_agent` / `exec` / `cp_in` through `smolvm machine
|
||||||
|
exec` / `smolvm machine cp`. The handle is yielded by `launch`
|
||||||
|
and torn down via the surrounding ExitStack on context exit;
|
||||||
|
`close` is a no-op idempotent alias so the BottleBackend ABC's
|
||||||
|
context-manager contract is satisfied.
|
||||||
|
|
||||||
|
User context: `smolvm machine exec` runs commands as root in the
|
||||||
|
VM, but the agent image's USER is `node` and agent CLIs may refuse
|
||||||
|
to run as root in bypass modes. Both
|
||||||
|
`exec_agent` and `exec` switch to the requested user (default
|
||||||
|
`node`) via `runuser -u <user> --` and set `HOME` / `USER`
|
||||||
|
through `smolvm -e` — avoiding `runuser -l`'s login-shell wiring
|
||||||
|
(PAM session setup, /etc/profile sourcing) which can hang on a
|
||||||
|
minimal Debian VM with no PAM session config."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
import shlex
|
||||||
|
from typing import Mapping, cast
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode, prompt_args
|
||||||
|
from .. import Bottle, ExecResult
|
||||||
|
from ..terminal import exec_shell_script
|
||||||
|
from . import pty_resize as _pty_resize
|
||||||
|
from . import smolvm as _smolvm
|
||||||
|
|
||||||
|
|
||||||
|
# Absolute path to the pty_resize wrapper. Invoke as
|
||||||
|
# `python <path>` rather than `python -m <dotted-path>` so the
|
||||||
|
# wrapper runs regardless of cwd / sys.path — it has no
|
||||||
|
# bot_bottle.* imports, so it's self-contained.
|
||||||
|
_PTY_RESIZE_SCRIPT = _pty_resize.__file__
|
||||||
|
|
||||||
|
|
||||||
|
# Per-user env the agent image's USER (node) expects. Some providers
|
||||||
|
# write session state under the user's home directory;
|
||||||
|
# bare `runuser -u` inherits root's HOME=/root, which claude
|
||||||
|
# can't write to. Set HOME / USER explicitly through smolvm -e
|
||||||
|
# so the child process sees them.
|
||||||
|
_HOME_FOR = {
|
||||||
|
"node": "/home/node",
|
||||||
|
"root": "/root",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _env_assignments_for(user: str, env: Mapping[str, str]) -> list[str]:
|
||||||
|
home = _HOME_FOR.get(user, f"/home/{user}")
|
||||||
|
out = [f"HOME={home}", f"USER={user}"]
|
||||||
|
for k, v in env.items():
|
||||||
|
out.append(f"{k}={v}")
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
class SmolmachinesBottle(Bottle):
|
||||||
|
"""Handle returned by `SmolmachinesBottleBackend.launch`. The
|
||||||
|
underlying VM lifecycle (create / start / stop / delete) lives
|
||||||
|
on the launch ExitStack — this class only routes runtime
|
||||||
|
operations to the right `smolvm machine ...` subcommand."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
machine_name: str,
|
||||||
|
*,
|
||||||
|
prompt_path: str | None = None,
|
||||||
|
guest_env: Mapping[str, str] | None = None,
|
||||||
|
agent_command: str = "claude",
|
||||||
|
agent_prompt_mode: PromptMode = "append_file",
|
||||||
|
agent_provider_template: str = "claude",
|
||||||
|
terminal_title: str = "",
|
||||||
|
terminal_color: str = "",
|
||||||
|
agent_workdir: str = "/home/node",
|
||||||
|
) -> None:
|
||||||
|
self.name = machine_name
|
||||||
|
# In-VM path to the agent's prompt file. None when the
|
||||||
|
# agent declared no prompt (file still exists; we just
|
||||||
|
# don't pass --append-system-prompt-file).
|
||||||
|
self.prompt_path = prompt_path
|
||||||
|
# Env vars the agent process needs (HTTPS_PROXY,
|
||||||
|
# CLAUDE_CODE_OAUTH_TOKEN, manifest-declared bottle env, …).
|
||||||
|
# Forwarded on every `smolvm machine exec` via `-e K=V`
|
||||||
|
# because exec doesn't inherit from machine_create's env.
|
||||||
|
self._guest_env = dict(guest_env or {})
|
||||||
|
self._agent_prompt_mode = agent_prompt_mode
|
||||||
|
self.agent_command = agent_command
|
||||||
|
self.terminal_title = terminal_title
|
||||||
|
self.terminal_color = terminal_color
|
||||||
|
self.agent_provider_template = agent_provider_template
|
||||||
|
self.agent_workdir = agent_workdir
|
||||||
|
|
||||||
|
def agent_argv(
|
||||||
|
self, argv: list[str], *, tty: bool = True,
|
||||||
|
) -> list[str]:
|
||||||
|
flags = ["smolvm", "machine", "exec", "--name", self.name]
|
||||||
|
if tty:
|
||||||
|
flags += ["-i", "-t"]
|
||||||
|
agent_tail = ["env", *_env_assignments_for("node", self._guest_env)]
|
||||||
|
if self.agent_workdir and self.agent_workdir != _HOME_FOR["node"]:
|
||||||
|
agent_tail += [
|
||||||
|
"sh", "-lc",
|
||||||
|
f"cd {shlex.quote(self.agent_workdir)} && exec \"$@\"",
|
||||||
|
"bot-bottle-agent",
|
||||||
|
]
|
||||||
|
agent_tail.append(self.agent_command)
|
||||||
|
provider_prompt_args = prompt_args(
|
||||||
|
cast(PromptMode, self._agent_prompt_mode), self.prompt_path, argv=argv,
|
||||||
|
)
|
||||||
|
if cast(PromptMode, self._agent_prompt_mode) == "read_prompt_file":
|
||||||
|
agent_tail += argv
|
||||||
|
agent_tail += provider_prompt_args
|
||||||
|
else:
|
||||||
|
agent_tail += provider_prompt_args
|
||||||
|
agent_tail += argv
|
||||||
|
flags += ["--", "runuser", "-u", "node", "--", *agent_tail]
|
||||||
|
if not tty:
|
||||||
|
# No PTY allocated — no SIGWINCH to forward, no resize
|
||||||
|
# bridge needed. Skip the wrapper so non-interactive
|
||||||
|
# exec paths (e.g., provisioning shell-outs that
|
||||||
|
# happen to go through this method) stay light.
|
||||||
|
return flags
|
||||||
|
return [
|
||||||
|
sys.executable, _PTY_RESIZE_SCRIPT,
|
||||||
|
self.name, "--", *flags,
|
||||||
|
]
|
||||||
|
|
||||||
|
def exec_agent(self, argv: list[str], *, tty: bool = True) -> int:
|
||||||
|
"""Run the selected agent interactively inside the VM as the `node`
|
||||||
|
user. Inherits the operator's terminal (stdin / stdout /
|
||||||
|
stderr) so the session feels native. Blocks until the agent
|
||||||
|
exits; returns the in-VM exit code.
|
||||||
|
|
||||||
|
We bypass the captured-output `machine_exec` helper here
|
||||||
|
because that one wraps stdout/stderr in pipes — fine for
|
||||||
|
scripted exec, wrong for an interactive shell. Drop down
|
||||||
|
to `subprocess.run` with the TTY inherited.
|
||||||
|
|
||||||
|
UID switches via `runuser -u node --` (not `-l`) so we
|
||||||
|
avoid login-shell wiring. HOME / USER come from `smolvm
|
||||||
|
-e` instead, which sets them on the process env."""
|
||||||
|
agent_argv = self.agent_argv(argv, tty=tty)
|
||||||
|
script = exec_shell_script(agent_argv, self.terminal_title, self.terminal_color) if tty else None
|
||||||
|
if script is None:
|
||||||
|
return subprocess.run(agent_argv, check=False).returncode
|
||||||
|
return subprocess.run(["sh", "-lc", script], check=False).returncode
|
||||||
|
|
||||||
|
# smolvm/libkrun can SIGKILL an otherwise-normal exec during
|
||||||
|
# early-VM provisioning. Retry once after a short settle so
|
||||||
|
# callers (provision_ca, etc.) don't have to handle it themselves.
|
||||||
|
_SIGKILL_EXIT = 128 + 9
|
||||||
|
|
||||||
|
def exec(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
|
"""Run a POSIX shell script as `user` (default `node`) and
|
||||||
|
capture the result. Matches the docker backend's `exec`,
|
||||||
|
which defaults to the image's USER (also node) — so test
|
||||||
|
helpers / provision shell-outs run with the same identity
|
||||||
|
on both backends. Pass `user="root"` for tests that need
|
||||||
|
root.
|
||||||
|
|
||||||
|
`runuser -u <user> -- env ... /bin/sh -c <script>` switches UID
|
||||||
|
without invoking a login shell, then sets HOME / USER and the
|
||||||
|
bottle env in the child process.
|
||||||
|
|
||||||
|
Retries once on SIGKILL (exit 137) — libkrun occasionally
|
||||||
|
kills short-lived execs during VM bring-up."""
|
||||||
|
r = self._exec_raw(script, user=user)
|
||||||
|
if r.returncode == self._SIGKILL_EXIT:
|
||||||
|
time.sleep(1.0)
|
||||||
|
r = self._exec_raw(script, user=user)
|
||||||
|
return r
|
||||||
|
|
||||||
|
def _exec_raw(self, script: str, *, user: str = "node") -> ExecResult:
|
||||||
|
argv = [
|
||||||
|
"--", "runuser", "-u", user, "--",
|
||||||
|
"env", *_env_assignments_for(user, self._guest_env),
|
||||||
|
"/bin/sh", "-c", script,
|
||||||
|
]
|
||||||
|
r = subprocess.run(
|
||||||
|
["smolvm", "machine", "exec", "--name", self.name] + argv,
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
return ExecResult(
|
||||||
|
returncode=r.returncode,
|
||||||
|
stdout=r.stdout or "",
|
||||||
|
stderr=r.stderr or "",
|
||||||
|
)
|
||||||
|
|
||||||
|
def cp_in(self, host_path: str, container_path: str) -> None:
|
||||||
|
"""Copy a host path into the guest at `container_path`."""
|
||||||
|
_smolvm.machine_cp(host_path, f"{self.name}:{container_path}")
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
# Real teardown lives on the launch ExitStack; this is just
|
||||||
|
# the idempotent alias the BottleBackend ABC expects.
|
||||||
|
pass
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
"""SmolmachinesBottleCleanupPlan — concrete BottleCleanupPlan (issue #77).
|
||||||
|
|
||||||
|
Tracks the resources `SmolmachinesBottleBackend.cleanup` will
|
||||||
|
remove:
|
||||||
|
|
||||||
|
- machines: smolvm machines whose name starts with
|
||||||
|
`bot-bottle-` (running or stopped). Stopped +
|
||||||
|
deleted via `smolvm machine stop` + `machine delete -f`.
|
||||||
|
- bundles: docker containers `bot-bottle-sidecars-<slug>`
|
||||||
|
left over from a smolmachines bottle (the bundle's
|
||||||
|
port-forwards stay published on lo0 aliases until
|
||||||
|
the container is gone). Removed via `docker rm -f`.
|
||||||
|
- networks: docker networks `bot-bottle-bundle-<slug>`
|
||||||
|
attached to the bundles. Removed via
|
||||||
|
`docker network rm`.
|
||||||
|
|
||||||
|
Smolmachines state dirs live under the same `~/.bot-bottle/state/`
|
||||||
|
path the docker backend uses; the docker backend's
|
||||||
|
`prepare_cleanup` already enumerates orphan state dirs and is the
|
||||||
|
single source of truth for that bucket (consults
|
||||||
|
`enumerate_active_bottles()` so it doesn't reap a live
|
||||||
|
smolmachines bottle's dir)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from ...log import info
|
||||||
|
from .. import BottleCleanupPlan
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SmolmachinesBottleCleanupPlan(BottleCleanupPlan):
|
||||||
|
"""Resources SmolmachinesBottleBackend.cleanup will remove.
|
||||||
|
Produced by `prepare_cleanup`; sorted so the y/N output is
|
||||||
|
stable."""
|
||||||
|
|
||||||
|
machines: tuple[str, ...] = ()
|
||||||
|
bundles: tuple[str, ...] = ()
|
||||||
|
networks: tuple[str, ...] = ()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def empty(self) -> bool:
|
||||||
|
return not self.machines and not self.bundles and not self.networks
|
||||||
|
|
||||||
|
def print(self) -> None:
|
||||||
|
print(file=sys.stderr)
|
||||||
|
for name in self.machines:
|
||||||
|
info(f"smolvm machine: {name}")
|
||||||
|
for name in self.bundles:
|
||||||
|
info(f"bundle container:{name}")
|
||||||
|
for name in self.networks:
|
||||||
|
info(f"bundle network: {name}")
|
||||||
|
print(file=sys.stderr)
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
"""SmolmachinesBottlePlan — concrete BottlePlan for the smolmachines
|
||||||
|
backend (PRD 0023).
|
||||||
|
|
||||||
|
Slug + bundle docker subnet / gateway / pinned IP + smolvm
|
||||||
|
machine name + agent `.smolmachine` artifact + per-bottle guest
|
||||||
|
env. Provisioning fields (CA cert path, prompt path, etc.) land
|
||||||
|
in chunk 4."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...agent_provider import PromptMode
|
||||||
|
from .. import BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SmolmachinesBottlePlan(BottlePlan):
|
||||||
|
"""Resolved fields the launch step needs to bring up the bottle.
|
||||||
|
|
||||||
|
Inherits `spec`, `stage_dir`, `git_gate_plan`, `egress_plan`,
|
||||||
|
`supervise_plan`, and `agent_provision` from BottlePlan."""
|
||||||
|
|
||||||
|
slug: str
|
||||||
|
# Per-bottle docker subnet for the sidecar bundle container.
|
||||||
|
# The bundle runs at `bundle_ip` (always `.2`); the gateway is
|
||||||
|
# at `.1`. smolvm's TSI allowlist is set to `bundle_ip/32`.
|
||||||
|
bundle_subnet: str
|
||||||
|
bundle_gateway: str
|
||||||
|
bundle_ip: str
|
||||||
|
# In-guest env vars (HTTPS_PROXY etc) — IP-literal URLs since
|
||||||
|
# the guest has no DNS resolver inside the TSI allowlist.
|
||||||
|
# Passed to `smolvm machine create` as `-e K=V` flags.
|
||||||
|
# Smolfile-rendering is gone (smolvm 0.8.0's
|
||||||
|
# `--smolfile` is mutually exclusive with `--from`, and
|
||||||
|
# `--from` is the path that avoids the registry-pull race).
|
||||||
|
guest_env: dict[str, str]
|
||||||
|
# Inner Plans for the sidecar bundle daemons. The same shape the
|
||||||
|
# docker backend uses — same `.prepare()` calls produced
|
||||||
|
# them — but our launch step doesn't populate the
|
||||||
|
# docker-specific network fields (internal_network,
|
||||||
|
# egress_network) because the smolmachines bundle isn't on
|
||||||
|
# docker's `--internal` + egress bridge topology; it's on a
|
||||||
|
# per-bottle bridge with a pinned IP. The unused fields stay
|
||||||
|
# at their dataclass defaults.
|
||||||
|
# Agent-side endpoints. On Docker Desktop the docker bridge
|
||||||
|
# IPs aren't reachable from the smolvm guest (TSI uses macOS
|
||||||
|
# networking; docker container IPs live in the daemon's VM),
|
||||||
|
# so the agent dials the bundle via host loopback +
|
||||||
|
# docker-published random ports. Empty at prepare time;
|
||||||
|
# launch populates these after bundle bringup via
|
||||||
|
# `dataclasses.replace`. Format: a `host:port` for git-gate
|
||||||
|
# (insteadOf URL prefix) + full URLs for proxy / supervise.
|
||||||
|
agent_proxy_url: str = ""
|
||||||
|
agent_git_gate_host: str = ""
|
||||||
|
agent_supervise_url: str = ""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def machine_name(self) -> str:
|
||||||
|
"""smolvm machine name. `machine_create` boots from a packed
|
||||||
|
`.smolmachine` artifact (pre-baked at prepare time via
|
||||||
|
`smolvm pack create`); using `--from` instead of `--image`
|
||||||
|
avoids the registry-pull race we hit when machine_start tried
|
||||||
|
to fetch on-demand and the libkrun agent's network attempt
|
||||||
|
got refused by macOS."""
|
||||||
|
return self.agent_provision.instance_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_image(self) -> str:
|
||||||
|
"""Agent image ref (docker tag). `launch` runs the
|
||||||
|
build → save → registry push → smolvm pack pipeline against
|
||||||
|
this and feeds the resulting `.smolmachine` artifact to
|
||||||
|
`machine_create --from`. The pipeline runs at launch time
|
||||||
|
(not prepare time) so the docker build output doesn't garble
|
||||||
|
the dashboard's preflight modal."""
|
||||||
|
return self.agent_provision.image
|
||||||
|
|
||||||
|
@property
|
||||||
|
def prompt_file(self) -> Path:
|
||||||
|
"""Path to the agent's prompt file on the host. Always written
|
||||||
|
(mode 0o600) so the in-VM path always exists; the file is
|
||||||
|
empty when the agent has no prompt — claude-code reads it
|
||||||
|
via --append-system-prompt-file only when non-empty."""
|
||||||
|
return self.agent_provision.prompt_file
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_host(self) -> str:
|
||||||
|
return self.agent_git_gate_host
|
||||||
|
|
||||||
|
@property
|
||||||
|
def git_gate_insteadof_scheme(self) -> str:
|
||||||
|
return "http"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_command(self) -> str:
|
||||||
|
return self.agent_provision.command
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_prompt_mode(self) -> PromptMode:
|
||||||
|
return self.agent_provision.prompt_mode
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_provider_template(self) -> str:
|
||||||
|
return self.agent_provision.template
|
||||||
|
|
||||||
|
@property
|
||||||
|
def agent_dockerfile_path(self) -> str:
|
||||||
|
return self.agent_provision.dockerfile
|
||||||
@@ -0,0 +1,159 @@
|
|||||||
|
"""Cleanup + active-listing for the smolmachines backend (issue #77).
|
||||||
|
|
||||||
|
`prepare_cleanup` enumerates leftover smolmachines resources:
|
||||||
|
|
||||||
|
- smolvm machines (`smolvm machine ls --json`) whose name starts
|
||||||
|
with `bot-bottle-`.
|
||||||
|
- bundle docker containers (`bot-bottle-sidecars-<slug>`).
|
||||||
|
- bundle docker networks (`bot-bottle-bundle-<slug>`).
|
||||||
|
|
||||||
|
State dirs live under `~/.bot-bottle/state/<identity>/` —
|
||||||
|
shared layout with the docker backend, which has the single
|
||||||
|
orphan-state-dir enumerator (it already consults
|
||||||
|
`enumerate_active_agents()` so a live smolmachines bottle's dir
|
||||||
|
is preserved).
|
||||||
|
|
||||||
|
`cleanup` removes everything in the plan: stop + delete each VM,
|
||||||
|
force-rm each container, rm each network. Each step is
|
||||||
|
best-effort — a failure on one resource doesn't block the others."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ...log import info, warn
|
||||||
|
from . import sidecar_bundle as _bundle
|
||||||
|
from . import smolvm as _smolvm
|
||||||
|
from .bottle_cleanup_plan import SmolmachinesBottleCleanupPlan
|
||||||
|
|
||||||
|
|
||||||
|
# Both names start with the same prefix the launcher uses.
|
||||||
|
_VM_PREFIX = "bot-bottle-"
|
||||||
|
_BUNDLE_PREFIX = _bundle.bundle_container_name("") # `bot-bottle-sidecars-`
|
||||||
|
_NETWORK_PREFIX = _bundle.bundle_network_name("") # `bot-bottle-bundle-`
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_cleanup() -> SmolmachinesBottleCleanupPlan:
|
||||||
|
"""Enumerate every smolmachines-owned resource on the host.
|
||||||
|
No side effects. Returns an empty plan when smolvm isn't on
|
||||||
|
PATH (no machines to reap) — `cleanup` is a no-op in that
|
||||||
|
case too."""
|
||||||
|
machines = _list_bot_bottle_machines()
|
||||||
|
bundles = _list_bundle_containers()
|
||||||
|
networks = _list_bundle_networks()
|
||||||
|
return SmolmachinesBottleCleanupPlan(
|
||||||
|
machines=tuple(sorted(machines)),
|
||||||
|
bundles=tuple(sorted(bundles)),
|
||||||
|
networks=tuple(sorted(networks)),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def cleanup(plan: SmolmachinesBottleCleanupPlan) -> None:
|
||||||
|
"""Remove everything in the plan. Order matters: stop VMs
|
||||||
|
first (they hold ports on lo0 aliases via libkrun), then the
|
||||||
|
bundle containers (which hold the host port-forwards), then
|
||||||
|
the networks (which docker won't reap until the containers
|
||||||
|
are gone)."""
|
||||||
|
for name in plan.machines:
|
||||||
|
info(f"stopping smolvm machine {name}")
|
||||||
|
subprocess.run(
|
||||||
|
["smolvm", "machine", "stop", "--name", name],
|
||||||
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
info(f"deleting smolvm machine {name}")
|
||||||
|
r = subprocess.run(
|
||||||
|
["smolvm", "machine", "delete", "-f", name],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
warn(
|
||||||
|
f"smolvm machine delete -f {name} failed: "
|
||||||
|
f"{(r.stderr or '').strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
|
for name in plan.bundles:
|
||||||
|
info(f"removing bundle container {name}")
|
||||||
|
subprocess.run(
|
||||||
|
["docker", "rm", "-f", name],
|
||||||
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
for name in plan.networks:
|
||||||
|
info(f"removing bundle network {name}")
|
||||||
|
r = subprocess.run(
|
||||||
|
["docker", "network", "rm", name],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0 and "no such network" not in (r.stderr or "").lower():
|
||||||
|
warn(
|
||||||
|
f"docker network rm {name} failed: "
|
||||||
|
f"{(r.stderr or '').strip()}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _list_bot_bottle_machines() -> list[str]:
|
||||||
|
"""All smolvm machines named `bot-bottle-*`, regardless of
|
||||||
|
state (running / stopped / created). Empty when smolvm isn't
|
||||||
|
installed."""
|
||||||
|
if not _smolvm.is_available():
|
||||||
|
return []
|
||||||
|
r = subprocess.run(
|
||||||
|
["smolvm", "machine", "ls", "--json"],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
return []
|
||||||
|
try:
|
||||||
|
machines = json.loads(r.stdout or "[]")
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
m["name"] for m in machines
|
||||||
|
if isinstance(m, dict)
|
||||||
|
and m.get("name", "").startswith(_VM_PREFIX)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _list_bundle_containers() -> list[str]:
|
||||||
|
"""All docker containers named `bot-bottle-sidecars-*`,
|
||||||
|
running or stopped. Empty when docker isn't installed."""
|
||||||
|
# Late import: `backend/__init__` imports this module
|
||||||
|
# transitively via the smolmachines backend.
|
||||||
|
from .. import has_backend
|
||||||
|
if not has_backend("docker"):
|
||||||
|
return []
|
||||||
|
r = subprocess.run(
|
||||||
|
["docker", "ps", "-a",
|
||||||
|
"--filter", f"name=^{_BUNDLE_PREFIX}",
|
||||||
|
"--format", "{{.Names}}"],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
line for line in (r.stdout or "").splitlines()
|
||||||
|
if line and line.startswith(_BUNDLE_PREFIX)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _list_bundle_networks() -> list[str]:
|
||||||
|
"""All docker networks named `bot-bottle-bundle-*`. Empty
|
||||||
|
when docker isn't installed."""
|
||||||
|
from .. import has_backend
|
||||||
|
if not has_backend("docker"):
|
||||||
|
return []
|
||||||
|
r = subprocess.run(
|
||||||
|
["docker", "network", "ls",
|
||||||
|
"--filter", f"name={_NETWORK_PREFIX}",
|
||||||
|
"--format", "{{.Name}}"],
|
||||||
|
capture_output=True, text=True, check=False,
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
line for line in (r.stdout or "").splitlines()
|
||||||
|
if line and line.startswith(_NETWORK_PREFIX)
|
||||||
|
]
|
||||||
+38
-23
@@ -1,40 +1,44 @@
|
|||||||
"""Active-bottle enumeration for the smolmachines backend (PRD
|
"""Active-agent enumeration for the smolmachines backend (PRD
|
||||||
0023 chunk 4 follow-up + issue #77).
|
0023 chunk 4 follow-up + issue #77).
|
||||||
|
|
||||||
Returns a list of `ActiveBottle` records — same shape the docker
|
Returns a list of `ActiveAgent` records — same shape the docker
|
||||||
backend produces — so CLI `list active` and the dashboard agents
|
backend produces — so CLI `list active` and the dashboard agents
|
||||||
pane render both backends through one code path.
|
pane render both backends through one code path.
|
||||||
|
|
||||||
A smolmachines bottle is "active" when its smolvm guest is
|
A smolmachines agent is "active" when its smolvm guest is
|
||||||
running. We cross-reference against the per-bottle sidecar
|
running. We cross-reference against the per-bottle sidecar
|
||||||
bundle container to populate the `services` field (which daemons
|
bundle container to populate the `services` field (which daemons
|
||||||
are up in the bundle); without a bundle we still surface the VM
|
are up in the bundle); without a bundle we still surface the VM
|
||||||
so the operator can see + clean it up."""
|
so the operator can see + clean it up.
|
||||||
|
|
||||||
|
The cross-backend caller gates on `has_backend("smolmachines")`
|
||||||
|
and `has_backend("docker")`, so this module assumes both are
|
||||||
|
available when called. Both subprocess calls below still
|
||||||
|
tolerate "command not on PATH" defensively, but the gate is the
|
||||||
|
intended access pattern."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import shutil
|
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from .. import ActiveBottle
|
from .. import ActiveAgent
|
||||||
from ..docker.bottle_state import read_metadata
|
from ...bottle_state import read_metadata
|
||||||
from . import sidecar_bundle as _bundle
|
from . import sidecar_bundle as _bundle
|
||||||
from . import smolvm as _smolvm
|
|
||||||
|
|
||||||
|
|
||||||
# Smolvm VM names produced by prepare are `claude-bottle-<slug>`,
|
# Smolvm VM names produced by prepare are `bot-bottle-<slug>`,
|
||||||
# matching the bundle container name pattern. We use the prefix
|
# matching the bundle container name pattern. We use the prefix
|
||||||
# both as a filter and to strip back to the slug.
|
# both as a filter and to strip back to the slug.
|
||||||
_VM_NAME_PREFIX = "claude-bottle-"
|
_VM_NAME_PREFIX = "bot-bottle-"
|
||||||
|
|
||||||
|
|
||||||
def enumerate_active() -> list[ActiveBottle]:
|
def enumerate_active() -> list[ActiveAgent]:
|
||||||
"""All currently-running smolmachines-backed bottles. Empty
|
"""All currently-running smolmachines-backed agents. Empty
|
||||||
list when smolvm isn't on PATH or no matching VMs are
|
list when no matching VMs are running. Caller is responsible
|
||||||
running."""
|
for gating on `has_backend('smolmachines')` if needed; if
|
||||||
if not _smolvm.is_available():
|
smolvm is missing the `smolvm machine ls` call below returns
|
||||||
return []
|
nothing silently."""
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["smolvm", "machine", "ls", "--json"],
|
["smolvm", "machine", "ls", "--json"],
|
||||||
capture_output=True, text=True, check=False,
|
capture_output=True, text=True, check=False,
|
||||||
@@ -46,7 +50,7 @@ def enumerate_active() -> list[ActiveBottle]:
|
|||||||
except json.JSONDecodeError:
|
except json.JSONDecodeError:
|
||||||
return []
|
return []
|
||||||
services_by_slug = _query_bundle_services()
|
services_by_slug = _query_bundle_services()
|
||||||
out: list[ActiveBottle] = []
|
out: list[ActiveAgent] = []
|
||||||
for m in machines:
|
for m in machines:
|
||||||
name = m.get("name") or ""
|
name = m.get("name") or ""
|
||||||
state = m.get("state") or ""
|
state = m.get("state") or ""
|
||||||
@@ -54,23 +58,34 @@ def enumerate_active() -> list[ActiveBottle]:
|
|||||||
continue
|
continue
|
||||||
slug = name[len(_VM_NAME_PREFIX):]
|
slug = name[len(_VM_NAME_PREFIX):]
|
||||||
metadata = read_metadata(slug)
|
metadata = read_metadata(slug)
|
||||||
out.append(ActiveBottle(
|
out.append(ActiveAgent(
|
||||||
backend_name="smolmachines",
|
backend_name="smolmachines",
|
||||||
slug=slug,
|
slug=slug,
|
||||||
agent_name=metadata.agent_name if metadata else "?",
|
agent_name=metadata.agent_name if metadata else "?",
|
||||||
started_at=metadata.started_at if metadata else "",
|
started_at=metadata.started_at if metadata else "",
|
||||||
services=services_by_slug.get(slug, ()),
|
services=services_by_slug.get(slug, ()),
|
||||||
|
label=metadata.label if metadata else "",
|
||||||
|
color=metadata.color if metadata else "",
|
||||||
))
|
))
|
||||||
return out
|
return out
|
||||||
|
|
||||||
|
|
||||||
def _query_bundle_services() -> dict[str, tuple[str, ...]]:
|
def _query_bundle_services() -> dict[str, tuple[str, ...]]:
|
||||||
"""`{slug: ('egress', 'pipelock', ...)}` from each running
|
"""`{slug: ('egress', ...)}` from each running bundle container's
|
||||||
bundle container's `CLAUDE_BOTTLE_SIDECAR_DAEMONS` env var.
|
`BOT_BOTTLE_SIDECAR_DAEMONS` env var.
|
||||||
Smolmachines bundles all run the PRD-0024 image with the
|
Smolmachines bundles all run the PRD-0024 image with the
|
||||||
same daemon set declared via env, so one inspect per bundle
|
same daemon set declared via env, so one inspect per bundle
|
||||||
gets us the picture without exec'ing into the container."""
|
gets us the picture without exec'ing into the container.
|
||||||
if shutil.which("docker") is None:
|
|
||||||
|
Returns an empty mapping when the docker backend isn't
|
||||||
|
available — the bundle services field on each ActiveAgent
|
||||||
|
just shows up empty, matching the docker backend's "starting"
|
||||||
|
state."""
|
||||||
|
# Late import: `has_backend` lives on the backend package's
|
||||||
|
# __init__, which imports this module transitively. Pulling
|
||||||
|
# the name in at call time sidesteps the cycle.
|
||||||
|
from .. import has_backend
|
||||||
|
if not has_backend("docker"):
|
||||||
return {}
|
return {}
|
||||||
ps = subprocess.run(
|
ps = subprocess.run(
|
||||||
["docker", "ps",
|
["docker", "ps",
|
||||||
@@ -100,7 +115,7 @@ def _query_bundle_services() -> dict[str, tuple[str, ...]]:
|
|||||||
continue
|
continue
|
||||||
for entry in env_list:
|
for entry in env_list:
|
||||||
key, _, value = entry.partition("=")
|
key, _, value = entry.partition("=")
|
||||||
if key == "CLAUDE_BOTTLE_SIDECAR_DAEMONS":
|
if key == "BOT_BOTTLE_SIDECAR_DAEMONS":
|
||||||
out[slug] = tuple(sorted(
|
out[slug] = tuple(sorted(
|
||||||
d for d in value.split(",") if d
|
d for d in value.split(",") if d
|
||||||
))
|
))
|
||||||
@@ -0,0 +1,432 @@
|
|||||||
|
"""End-to-end launch flow for the smolmachines backend
|
||||||
|
(PRD 0023 chunks 2d + 4b).
|
||||||
|
|
||||||
|
Brings up the per-bottle docker bridge + sidecar bundle (with
|
||||||
|
real daemons + their config files), creates + starts the smolvm
|
||||||
|
guest pointed at the bundle's pinned IP via TSI's
|
||||||
|
`--allow-cidr <bundle-ip>/32` allowlist, yields a
|
||||||
|
`SmolmachinesBottle` handle, tears everything down on context
|
||||||
|
exit.
|
||||||
|
|
||||||
|
The bundle's daemons consume the inner Plans the docker backend
|
||||||
|
already produces: egress reads routes + CAs from the EgressPlan.
|
||||||
|
Git-gate + supervise plumb through the same plans the docker
|
||||||
|
backend uses, minus the docker-network fields that don't apply here."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import dataclasses
|
||||||
|
import os
|
||||||
|
from contextlib import ExitStack, contextmanager
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Callable, Generator
|
||||||
|
|
||||||
|
from ...egress import (
|
||||||
|
EGRESS_ROUTES_IN_CONTAINER,
|
||||||
|
egress_resolve_token_values,
|
||||||
|
)
|
||||||
|
from ...supervise import QUEUE_DIR_IN_CONTAINER, SUPERVISE_PORT
|
||||||
|
from ...util import expand_tilde
|
||||||
|
from ..docker import util as docker_mod
|
||||||
|
from ..docker.egress import (
|
||||||
|
EGRESS_CA_IN_CONTAINER,
|
||||||
|
EGRESS_PORT as _EGRESS_PORT,
|
||||||
|
egress_tls_init,
|
||||||
|
)
|
||||||
|
from ..docker.git_gate import (
|
||||||
|
GIT_GATE_ACCESS_HOOK_IN_CONTAINER,
|
||||||
|
GIT_GATE_CREDS_DIR_IN_CONTAINER,
|
||||||
|
GIT_GATE_ENTRYPOINT_IN_CONTAINER,
|
||||||
|
GIT_GATE_HOOK_IN_CONTAINER,
|
||||||
|
)
|
||||||
|
from ...git_gate import revoke_git_gate_provisioned_keys
|
||||||
|
from ...log import warn
|
||||||
|
from ...bottle_state import egress_state_dir, git_gate_state_dir
|
||||||
|
from . import loopback_alias as _loopback
|
||||||
|
from . import sidecar_bundle as _bundle
|
||||||
|
from . import smolvm as _smolvm
|
||||||
|
from .bottle import SmolmachinesBottle
|
||||||
|
from .bottle_plan import SmolmachinesBottlePlan
|
||||||
|
from .local_registry import crane_push_tarball, ephemeral_registry
|
||||||
|
|
||||||
|
|
||||||
|
# Repo root, used as the `docker build` context for the agent image.
|
||||||
|
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
||||||
|
|
||||||
|
|
||||||
|
# Per-host cache for `smolvm pack create` outputs. Keyed by the
|
||||||
|
# docker image ID so a Dockerfile change automatically invalidates
|
||||||
|
# the cache. `pack create` is idempotent on the smolvm side but
|
||||||
|
# takes several seconds even on a no-op rebuild.
|
||||||
|
_SMOLMACHINE_CACHE_DIR = Path.home() / ".cache" / "bot-bottle" / "smolmachines"
|
||||||
|
|
||||||
|
|
||||||
|
# Container-internal listening ports for each bundle daemon. The
|
||||||
|
# bundle publishes each one on a random host loopback port (see
|
||||||
|
# `_bundle.start_bundle`), and `_bundle.bundle_host_port` looks
|
||||||
|
# them up post-start.
|
||||||
|
_GIT_HTTP_PORT = 9420
|
||||||
|
_SUPERVISE_PORT = SUPERVISE_PORT
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def launch(
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
*,
|
||||||
|
provision: Callable[[SmolmachinesBottlePlan, "SmolmachinesBottle"], str | None],
|
||||||
|
) -> Generator[SmolmachinesBottle, None, None]:
|
||||||
|
"""Build + run the bottle and yield a handle; tear everything
|
||||||
|
down on exit. Errors during bringup unwind any partial state
|
||||||
|
via the ExitStack."""
|
||||||
|
stack = ExitStack()
|
||||||
|
try:
|
||||||
|
loopback_ip, network = _allocate_resources(plan, stack)
|
||||||
|
plan = _mint_certs(plan)
|
||||||
|
plan = _start_bundle(plan, network, loopback_ip, stack)
|
||||||
|
plan = _discover_urls(plan, loopback_ip)
|
||||||
|
|
||||||
|
# Build the agent image and pack it into a `.smolmachine`
|
||||||
|
# artifact (or hit the per-Dockerfile-digest cache). Runs
|
||||||
|
# here, not in prepare, so the docker-build output doesn't
|
||||||
|
# garble the dashboard's preflight modal.
|
||||||
|
agent_from_path = _ensure_smolmachine(
|
||||||
|
plan.agent_image,
|
||||||
|
dockerfile=plan.agent_dockerfile_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
_launch_vm(plan, agent_from_path, loopback_ip, stack)
|
||||||
|
_init_vm(plan)
|
||||||
|
|
||||||
|
bottle = SmolmachinesBottle(
|
||||||
|
plan.machine_name,
|
||||||
|
prompt_path=None,
|
||||||
|
guest_env=plan.guest_env,
|
||||||
|
agent_command=plan.agent_command,
|
||||||
|
agent_prompt_mode=plan.agent_prompt_mode,
|
||||||
|
agent_provider_template=plan.agent_provider_template,
|
||||||
|
terminal_title=plan.spec.label or plan.spec.agent_name,
|
||||||
|
terminal_color=plan.spec.color,
|
||||||
|
agent_workdir=plan.workspace_plan.workdir,
|
||||||
|
)
|
||||||
|
bottle.prompt_path = provision(plan, bottle)
|
||||||
|
|
||||||
|
yield bottle
|
||||||
|
finally:
|
||||||
|
_teardown_smolmachines(stack, plan)
|
||||||
|
|
||||||
|
|
||||||
|
def _teardown_smolmachines(
|
||||||
|
stack: ExitStack,
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
) -> None:
|
||||||
|
"""Unwind the ExitStack, then revoke any provisioned deploy keys.
|
||||||
|
|
||||||
|
ExitStack errors are caught and logged (non-fatal) so that key
|
||||||
|
revocation always runs. Revocation errors propagate — a stranded
|
||||||
|
deploy key is a security concern the operator must address."""
|
||||||
|
teardown_exc: BaseException | None = None
|
||||||
|
try:
|
||||||
|
stack.close()
|
||||||
|
except BaseException as exc: # noqa: W0718 — teardown must not fail
|
||||||
|
teardown_exc = exc
|
||||||
|
warn(f"smolmachines teardown failed: {exc!r}")
|
||||||
|
bottle = plan.spec.manifest.bottle_for(plan.spec.agent_name)
|
||||||
|
revoke_git_gate_provisioned_keys(bottle, git_gate_state_dir(plan.slug))
|
||||||
|
if teardown_exc is not None:
|
||||||
|
raise teardown_exc
|
||||||
|
|
||||||
|
|
||||||
|
def _allocate_resources(
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
stack: ExitStack,
|
||||||
|
) -> tuple[str, str]:
|
||||||
|
"""Reserve a loopback alias and create the per-bottle docker bridge.
|
||||||
|
|
||||||
|
macOS only routes 127.0.0.1 by default; the per-bottle alias
|
||||||
|
scopes TSI's allowlist to this bottle's published ports so the
|
||||||
|
agent can't reach other bottles' or host services' ports on
|
||||||
|
loopback. No-op on Linux."""
|
||||||
|
_loopback.ensure_pool()
|
||||||
|
loopback_ip = _loopback.allocate(plan.slug)
|
||||||
|
network = _bundle.bundle_network_name(plan.slug)
|
||||||
|
_bundle.create_bundle_network(network, plan.bundle_subnet, plan.bundle_gateway)
|
||||||
|
stack.callback(_bundle.remove_bundle_network, network)
|
||||||
|
return loopback_ip, network
|
||||||
|
|
||||||
|
|
||||||
|
def _mint_certs(plan: SmolmachinesBottlePlan) -> SmolmachinesBottlePlan:
|
||||||
|
"""Mint the egress MITM CA and return the plan with CA paths filled."""
|
||||||
|
egress_ca_host, egress_ca_cert_only = egress_tls_init(
|
||||||
|
egress_state_dir(plan.slug),
|
||||||
|
)
|
||||||
|
egress_plan = dataclasses.replace(
|
||||||
|
plan.egress_plan,
|
||||||
|
mitmproxy_ca_host_path=egress_ca_host,
|
||||||
|
mitmproxy_ca_cert_only_host_path=egress_ca_cert_only,
|
||||||
|
)
|
||||||
|
return dataclasses.replace(plan, egress_plan=egress_plan)
|
||||||
|
|
||||||
|
|
||||||
|
def _start_bundle(
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
network: str,
|
||||||
|
loopback_ip: str,
|
||||||
|
stack: ExitStack,
|
||||||
|
) -> SmolmachinesBottlePlan:
|
||||||
|
"""Build the BundleLaunchSpec, resolve token env, start the
|
||||||
|
sidecar bundle container, and register teardown."""
|
||||||
|
bundle_spec = _bundle_launch_spec(plan, network, loopback_ip)
|
||||||
|
token_env = _resolve_token_env(plan, dict(os.environ))
|
||||||
|
_bundle.ensure_bundle_image(bundle_spec.image)
|
||||||
|
_bundle.start_bundle(bundle_spec, env={**os.environ, **token_env})
|
||||||
|
stack.callback(_bundle.stop_bundle, plan.slug)
|
||||||
|
return plan
|
||||||
|
|
||||||
|
|
||||||
|
def _discover_urls(
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
loopback_ip: str,
|
||||||
|
) -> SmolmachinesBottlePlan:
|
||||||
|
"""Discover host-side ports for published container ports and
|
||||||
|
return the plan with URLs + guest_env stamped in.
|
||||||
|
|
||||||
|
Docker container IPs (192.168.x.x in the daemon's bridge)
|
||||||
|
aren't reachable from the smolvm guest on macOS — TSI uses
|
||||||
|
macOS networking, and macOS sees the daemon's bridge via the
|
||||||
|
published-port loopback forward only.
|
||||||
|
|
||||||
|
NO_PROXY includes the per-bottle loopback alias so the
|
||||||
|
supervise + git-gate URLs bypass HTTPS_PROXY."""
|
||||||
|
agent_facing_host_port = _bundle.bundle_host_port(
|
||||||
|
plan.slug, _EGRESS_PORT, host_ip=loopback_ip,
|
||||||
|
)
|
||||||
|
agent_proxy_url = f"http://{loopback_ip}:{agent_facing_host_port}"
|
||||||
|
|
||||||
|
agent_git_gate_host = ""
|
||||||
|
if plan.git_gate_plan.upstreams:
|
||||||
|
git_gate_host_port = _bundle.bundle_host_port(
|
||||||
|
plan.slug, _GIT_HTTP_PORT, host_ip=loopback_ip,
|
||||||
|
)
|
||||||
|
agent_git_gate_host = f"{loopback_ip}:{git_gate_host_port}"
|
||||||
|
|
||||||
|
agent_supervise_url = ""
|
||||||
|
if plan.supervise_plan is not None:
|
||||||
|
supervise_host_port = _bundle.bundle_host_port(
|
||||||
|
plan.slug, _SUPERVISE_PORT, host_ip=loopback_ip,
|
||||||
|
)
|
||||||
|
agent_supervise_url = f"http://{loopback_ip}:{supervise_host_port}/"
|
||||||
|
|
||||||
|
existing_no_proxy = plan.guest_env.get("NO_PROXY", "localhost,127.0.0.1")
|
||||||
|
guest_env = {
|
||||||
|
**plan.guest_env,
|
||||||
|
"HTTPS_PROXY": agent_proxy_url,
|
||||||
|
"HTTP_PROXY": agent_proxy_url,
|
||||||
|
"NO_PROXY": f"{existing_no_proxy},{loopback_ip}",
|
||||||
|
}
|
||||||
|
if agent_git_gate_host:
|
||||||
|
guest_env["GIT_GATE_URL"] = f"http://{agent_git_gate_host}"
|
||||||
|
if agent_supervise_url:
|
||||||
|
guest_env["MCP_SUPERVISE_URL"] = agent_supervise_url
|
||||||
|
|
||||||
|
return dataclasses.replace(
|
||||||
|
plan,
|
||||||
|
guest_env=guest_env,
|
||||||
|
agent_proxy_url=agent_proxy_url,
|
||||||
|
agent_git_gate_host=agent_git_gate_host,
|
||||||
|
agent_supervise_url=agent_supervise_url,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _launch_vm(
|
||||||
|
plan: SmolmachinesBottlePlan,
|
||||||
|
agent_from_path: Path,
|
||||||
|
loopback_ip: str,
|
||||||
|
stack: ExitStack,
|
||||||
|
) -> None:
|
||||||
|
"""Create, patch, and start the smolvm VM; register teardown.
|
||||||
|
|
||||||
|
--allow-cidr is the per-bottle loopback alias so the guest can
|
||||||
|
only reach this bottle's bundle ports. force_allowlist patches
|
||||||
|
smolvm 0.8.0's silent-drop of --allow-cidr when combined with
|
||||||
|
--from. Smolfile isn't usable here — smolvm 0.8.0 makes --from
|
||||||
|
and --smolfile mutually exclusive."""
|
||||||
|
_smolvm.machine_create(
|
||||||
|
plan.machine_name,
|
||||||
|
from_path=agent_from_path,
|
||||||
|
allow_cidrs=[f"{loopback_ip}/32"],
|
||||||
|
env=plan.guest_env,
|
||||||
|
)
|
||||||
|
stack.callback(_smolvm.machine_delete, plan.machine_name)
|
||||||
|
# Workaround smolvm 0.8.0: `--allow-cidr` is silently dropped
|
||||||
|
# when combined with `--from`. Patch the persisted state DB
|
||||||
|
# before start so the booted VM's TSI actually enforces.
|
||||||
|
_loopback.force_allowlist(plan.machine_name, [f"{loopback_ip}/32"])
|
||||||
|
_smolvm.machine_start(plan.machine_name)
|
||||||
|
stack.callback(_smolvm.machine_stop, plan.machine_name)
|
||||||
|
|
||||||
|
|
||||||
|
def _init_vm(plan: SmolmachinesBottlePlan) -> None:
|
||||||
|
"""Repair filesystem ownership and wait for exec channel readiness.
|
||||||
|
|
||||||
|
Ownership repair: smolvm's pack process remaps files to the host
|
||||||
|
invoker's uid (501 on macOS). /home/node must be node:node so
|
||||||
|
Claude Code can write ~/.claude.json; /tmp + /var/tmp need root
|
||||||
|
mode 1777 so non-root processes can create per-uid scratch dirs.
|
||||||
|
All folded into one sh -c to avoid back-to-back exec calls
|
||||||
|
immediately after machine_start (libkrun exec-channel race).
|
||||||
|
|
||||||
|
wait_exec_ready polls until the exec channel is ready for the
|
||||||
|
subsequent provision calls, replacing the empirical sleep."""
|
||||||
|
_smolvm.machine_exec(plan.machine_name, [
|
||||||
|
"sh", "-c",
|
||||||
|
"chown -R node:node /home/node && "
|
||||||
|
"chown root:root /tmp /var/tmp && "
|
||||||
|
"chmod 1777 /tmp /var/tmp",
|
||||||
|
])
|
||||||
|
_smolvm.wait_exec_ready(plan.machine_name)
|
||||||
|
|
||||||
|
|
||||||
|
def _bundle_launch_spec(
|
||||||
|
plan: SmolmachinesBottlePlan, network: str, loopback_ip: str,
|
||||||
|
) -> _bundle.BundleLaunchSpec:
|
||||||
|
"""Build a BundleLaunchSpec from the resolved inner Plans.
|
||||||
|
|
||||||
|
Daemons in the CSV:
|
||||||
|
- egress is always present.
|
||||||
|
- git-gate + git-http are conditional on plan.git_gate_plan.upstreams.
|
||||||
|
- supervise is conditional on plan.supervise_plan.
|
||||||
|
|
||||||
|
Env + volumes are the union of the sidecar daemons' needs, with
|
||||||
|
daemon-private values only (HTTPS_PROXY is scoped to the
|
||||||
|
egress process by egress_entrypoint.sh — see PRD 0024's bundle
|
||||||
|
bind-address PR)."""
|
||||||
|
daemons: list[str] = ["egress"]
|
||||||
|
env: list[str] = []
|
||||||
|
volumes: list[tuple[str, str, bool]] = []
|
||||||
|
|
||||||
|
# --- egress -----------------------------------------------
|
||||||
|
ep = plan.egress_plan
|
||||||
|
volumes.append((str(ep.mitmproxy_ca_host_path), EGRESS_CA_IN_CONTAINER, True))
|
||||||
|
if ep.routes:
|
||||||
|
volumes.append((str(ep.routes_path), EGRESS_ROUTES_IN_CONTAINER, True))
|
||||||
|
# Bare-name entries for upstream-token slots. Their values
|
||||||
|
# come from the docker-run subprocess env (inherited from
|
||||||
|
# the operator's shell), never landing on argv.
|
||||||
|
for token_env in sorted(ep.token_env_map.keys()):
|
||||||
|
env.append(token_env)
|
||||||
|
|
||||||
|
# --- git-gate ---------------------------------------------
|
||||||
|
gp = plan.git_gate_plan
|
||||||
|
if gp.upstreams:
|
||||||
|
daemons += ["git-gate", "git-http"]
|
||||||
|
volumes += [
|
||||||
|
(str(gp.entrypoint_script), GIT_GATE_ENTRYPOINT_IN_CONTAINER, True),
|
||||||
|
(str(gp.hook_script), GIT_GATE_HOOK_IN_CONTAINER, True),
|
||||||
|
(str(gp.access_hook_script), GIT_GATE_ACCESS_HOOK_IN_CONTAINER, True),
|
||||||
|
]
|
||||||
|
for u in gp.upstreams:
|
||||||
|
keypath = expand_tilde(u.identity_file)
|
||||||
|
volumes.append((
|
||||||
|
keypath,
|
||||||
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{u.name}-key",
|
||||||
|
True,
|
||||||
|
))
|
||||||
|
if u.known_hosts_file:
|
||||||
|
volumes.append((
|
||||||
|
str(u.known_hosts_file),
|
||||||
|
f"{GIT_GATE_CREDS_DIR_IN_CONTAINER}/{u.name}-known_hosts",
|
||||||
|
True,
|
||||||
|
))
|
||||||
|
|
||||||
|
# --- supervise --------------------------------------------
|
||||||
|
sp = plan.supervise_plan
|
||||||
|
if sp is not None:
|
||||||
|
daemons.append("supervise")
|
||||||
|
env += [
|
||||||
|
f"SUPERVISE_BOTTLE_SLUG={plan.slug}",
|
||||||
|
f"SUPERVISE_QUEUE_DIR={QUEUE_DIR_IN_CONTAINER}",
|
||||||
|
f"SUPERVISE_PORT={SUPERVISE_PORT}",
|
||||||
|
]
|
||||||
|
volumes.append((str(sp.queue_dir), QUEUE_DIR_IN_CONTAINER, False))
|
||||||
|
|
||||||
|
# Container ports the agent reaches from the smolvm guest —
|
||||||
|
# published on host loopback so the guest can dial via TSI +
|
||||||
|
# macOS networking. Egress is always the agent's HTTP/HTTPS proxy.
|
||||||
|
ports_to_publish: list[int] = [_EGRESS_PORT]
|
||||||
|
if gp.upstreams:
|
||||||
|
ports_to_publish.append(_GIT_HTTP_PORT)
|
||||||
|
if sp is not None:
|
||||||
|
ports_to_publish.append(_SUPERVISE_PORT)
|
||||||
|
|
||||||
|
return _bundle.BundleLaunchSpec(
|
||||||
|
slug=plan.slug,
|
||||||
|
network_name=network,
|
||||||
|
subnet=plan.bundle_subnet,
|
||||||
|
gateway=plan.bundle_gateway,
|
||||||
|
bundle_ip=plan.bundle_ip,
|
||||||
|
daemons_csv=",".join(daemons),
|
||||||
|
environment=tuple(env),
|
||||||
|
volumes=tuple(volumes),
|
||||||
|
ports_to_publish=tuple(ports_to_publish),
|
||||||
|
publish_host_ip=loopback_ip,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_token_env(
|
||||||
|
plan: SmolmachinesBottlePlan, host_env: dict[str, str],
|
||||||
|
) -> dict[str, str]:
|
||||||
|
"""Resolve the egress token env-var values from the host's
|
||||||
|
environ so they reach the bundle's process env via docker's
|
||||||
|
`-e NAME` inheritance. Empty when no routes declare auth."""
|
||||||
|
effective_env = {**host_env, **plan.agent_provision.provisioned_env}
|
||||||
|
return egress_resolve_token_values(plan.egress_plan.token_env_map, effective_env)
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_smolmachine(image_ref: str, *, dockerfile: str = "") -> Path:
|
||||||
|
"""Build the agent docker image and convert it into a
|
||||||
|
`.smolmachine` artifact, caching the result under
|
||||||
|
`~/.cache/bot-bottle/smolmachines/` keyed by the docker image
|
||||||
|
ID (so a Dockerfile change automatically invalidates the cache).
|
||||||
|
|
||||||
|
Returns the `.smolmachine.smolmachine` sidecar path — that's
|
||||||
|
the file `machine create --from` consumes (pack create produces
|
||||||
|
a launcher binary at `.smolmachine` plus the sidecar alongside
|
||||||
|
it; the sidecar is the actual artifact).
|
||||||
|
|
||||||
|
Conversion path: `docker build` (the existing layer cache
|
||||||
|
makes no-change rebuilds cheap) → `docker save` to a tarball
|
||||||
|
→ spin up an ephemeral registry on a private docker network →
|
||||||
|
`crane push --insecure` from a one-shot container on the same
|
||||||
|
network → `smolvm pack create --image localhost:<host port>/...`
|
||||||
|
→ tear down the registry + network. The crane push detour
|
||||||
|
sidesteps the Docker-Desktop daemon's HTTPS preference for
|
||||||
|
non-loopback registries — see the `local_registry` module
|
||||||
|
docstring for the gory details.
|
||||||
|
|
||||||
|
Each pack-create costs several seconds even on a hot cache,
|
||||||
|
so we skip the whole pipeline when the cached sidecar is
|
||||||
|
already on disk for this image ID."""
|
||||||
|
_SMOLMACHINE_CACHE_DIR.mkdir(parents=True, exist_ok=True)
|
||||||
|
docker_mod.build_image(image_ref, _REPO_DIR, dockerfile=dockerfile)
|
||||||
|
# `sha256:abcd...` -> `abcd...` first 16 chars: short enough to
|
||||||
|
# keep filenames manageable, long enough to make collisions
|
||||||
|
# astronomically unlikely.
|
||||||
|
digest = docker_mod.image_id(image_ref).split(":", 1)[-1][:16]
|
||||||
|
binary = _SMOLMACHINE_CACHE_DIR / f"{digest}.smolmachine"
|
||||||
|
sidecar = _SMOLMACHINE_CACHE_DIR / f"{digest}.smolmachine.smolmachine"
|
||||||
|
if sidecar.is_file():
|
||||||
|
return sidecar
|
||||||
|
tarball = _SMOLMACHINE_CACHE_DIR / f"{digest}.image.tar"
|
||||||
|
docker_mod.save(image_ref, str(tarball))
|
||||||
|
try:
|
||||||
|
with ephemeral_registry() as handle:
|
||||||
|
push_ref = f"{handle.push_endpoint}/bot-bottle:{digest}"
|
||||||
|
pack_ref = f"{handle.pull_endpoint}/bot-bottle:{digest}"
|
||||||
|
crane_push_tarball(handle, str(tarball), push_ref)
|
||||||
|
_smolvm.pack_create(pack_ref, binary)
|
||||||
|
finally:
|
||||||
|
# Tarball is ~500MB-1GB for the agent image; reclaim once
|
||||||
|
# the smolmachine artifact exists. The artifact itself is
|
||||||
|
# the long-lived cache entry.
|
||||||
|
tarball.unlink(missing_ok=True)
|
||||||
|
return sidecar
|
||||||
+11
-9
@@ -42,15 +42,15 @@ import time
|
|||||||
import uuid
|
import uuid
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from typing import Iterator
|
from typing import Generator
|
||||||
|
|
||||||
from ...log import die
|
from ...log import die
|
||||||
|
|
||||||
|
|
||||||
# registry:2.8.3, pinned by digest. Same env-override pattern as the
|
# registry:2.8.3, pinned by digest. Same env-override pattern as the
|
||||||
# pipelock image pin in claude_bottle/backend/docker/pipelock.py.
|
# sidecar image pin in bot_bottle/backend/docker/sidecar_bundle.py.
|
||||||
REGISTRY_IMAGE = os.environ.get(
|
REGISTRY_IMAGE = os.environ.get(
|
||||||
"CLAUDE_BOTTLE_REGISTRY_IMAGE",
|
"BOT_BOTTLE_REGISTRY_IMAGE",
|
||||||
"registry@sha256:a3d8aaa63ed8681a604f1dea0aa03f100d5895b6a58ace528858a7b332415373",
|
"registry@sha256:a3d8aaa63ed8681a604f1dea0aa03f100d5895b6a58ace528858a7b332415373",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -60,8 +60,11 @@ REGISTRY_IMAGE = os.environ.get(
|
|||||||
# against a localhost-equivalent registry, so the trust surface is
|
# against a localhost-equivalent registry, so the trust surface is
|
||||||
# narrow.
|
# narrow.
|
||||||
CRANE_IMAGE = os.environ.get(
|
CRANE_IMAGE = os.environ.get(
|
||||||
"CLAUDE_BOTTLE_CRANE_IMAGE",
|
"BOT_BOTTLE_CRANE_IMAGE",
|
||||||
"gcr.io/go-containerregistry/crane@sha256:0ae17ecb34315aa7cbff28f6eddee3b7adae0b2f90101260d990804db1eb0084",
|
(
|
||||||
|
"gcr.io/go-containerregistry/crane@sha256:"
|
||||||
|
"0ae17ecb34315aa7cbff28f6eddee3b7adae0b2f90101260d990804db1eb0084"
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -95,7 +98,7 @@ class RegistryHandle:
|
|||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def ephemeral_registry() -> Iterator[RegistryHandle]:
|
def ephemeral_registry() -> Generator[RegistryHandle, None, None]:
|
||||||
"""Bring up a per-session docker network + a `registry:2.8.3`
|
"""Bring up a per-session docker network + a `registry:2.8.3`
|
||||||
container on it (published on a random host port), yield a
|
container on it (published on a random host port), yield a
|
||||||
`RegistryHandle`, force-remove both on exit.
|
`RegistryHandle`, force-remove both on exit.
|
||||||
@@ -104,8 +107,8 @@ def ephemeral_registry() -> Iterator[RegistryHandle]:
|
|||||||
on its own; the `finally` block force-removes on abnormal exit
|
on its own; the `finally` block force-removes on abnormal exit
|
||||||
(the calling process crashes between yield and close)."""
|
(the calling process crashes between yield and close)."""
|
||||||
session_id = uuid.uuid4().hex[:12]
|
session_id = uuid.uuid4().hex[:12]
|
||||||
network = f"claude-bottle-registry-net-{session_id}"
|
network = f"bot-bottle-registry-net-{session_id}"
|
||||||
registry_name = f"claude-bottle-registry-{session_id}"
|
registry_name = f"bot-bottle-registry-{session_id}"
|
||||||
|
|
||||||
subprocess.run(
|
subprocess.run(
|
||||||
["docker", "network", "create", network],
|
["docker", "network", "create", network],
|
||||||
@@ -205,7 +208,6 @@ def _host_port(name: str) -> int:
|
|||||||
return int(port_str)
|
return int(port_str)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
die(f"unexpected `docker port` output: {line!r}")
|
die(f"unexpected `docker port` output: {line!r}")
|
||||||
return -1 # unreachable; die() never returns
|
|
||||||
|
|
||||||
|
|
||||||
def _wait_ready(port: int) -> None:
|
def _wait_ready(port: int) -> None:
|
||||||
+25
-7
@@ -45,8 +45,8 @@ alias gets handed to a new bottle."""
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import fcntl
|
||||||
import json
|
import json
|
||||||
import os
|
|
||||||
import platform
|
import platform
|
||||||
import re
|
import re
|
||||||
import sqlite3
|
import sqlite3
|
||||||
@@ -83,6 +83,14 @@ _POOL_START = 16
|
|||||||
_POOL_END = 31 # inclusive
|
_POOL_END = 31 # inclusive
|
||||||
|
|
||||||
|
|
||||||
|
# File lock that serialises concurrent allocate() calls so two
|
||||||
|
# simultaneous launches can't read the same docker state and claim
|
||||||
|
# the same alias. Narrowed to the allocate() call itself; docker run
|
||||||
|
# runs after the lock is released. Once the container is running it
|
||||||
|
# appears in docker state and future allocate() calls will see it.
|
||||||
|
_ALLOC_LOCK_PATH = Path.home() / ".cache" / "bot-bottle" / "smolmachines.lock"
|
||||||
|
|
||||||
|
|
||||||
# Loopback aliases pool: 127.0.0.<start>..127.0.0.<end>.
|
# Loopback aliases pool: 127.0.0.<start>..127.0.0.<end>.
|
||||||
def _pool_addresses() -> list[str]:
|
def _pool_addresses() -> list[str]:
|
||||||
return [f"127.0.0.{i}" for i in range(_POOL_START, _POOL_END + 1)]
|
return [f"127.0.0.{i}" for i in range(_POOL_START, _POOL_END + 1)]
|
||||||
@@ -110,7 +118,7 @@ def ensure_pool() -> None:
|
|||||||
)
|
)
|
||||||
for ip in missing:
|
for ip in missing:
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["sudo", "-p", "claude-bottle (loopback alias): ",
|
["sudo", "-p", "bot-bottle (loopback alias): ",
|
||||||
"ifconfig", "lo0", "alias", f"{ip}/32", "up"],
|
"ifconfig", "lo0", "alias", f"{ip}/32", "up"],
|
||||||
check=False,
|
check=False,
|
||||||
)
|
)
|
||||||
@@ -168,20 +176,31 @@ def force_allowlist(machine_name: str, allowed_cidrs: list[str]) -> None:
|
|||||||
con.close()
|
con.close()
|
||||||
|
|
||||||
|
|
||||||
def allocate(slug: str) -> str:
|
def allocate(_slug: str) -> str:
|
||||||
"""Pick the lowest-numbered alias from the pool not already
|
"""Pick the lowest-numbered alias from the pool not already
|
||||||
in use by a running smolmachines bundle. Bails when the pool
|
in use by a running smolmachines bundle. Bails when the pool
|
||||||
is exhausted — the caller should report the limit to the
|
is exhausted — the caller should report the limit to the
|
||||||
operator. `slug` is logged for traceability; not otherwise
|
operator. `_slug` is logged for traceability; not otherwise
|
||||||
used (no on-disk reservation, allocation is purely
|
used (no on-disk reservation, allocation is purely
|
||||||
docker-state-driven).
|
docker-state-driven).
|
||||||
|
|
||||||
On non-macOS the whole `127.0.0.0/8` is loopback by default;
|
On non-macOS the whole `127.0.0.0/8` is loopback by default;
|
||||||
`127.0.0.1` is fine to share and we skip the alias dance.
|
`127.0.0.1` is fine to share and we skip the alias dance.
|
||||||
This still returns a deterministic address so launch.py's
|
This still returns a deterministic address so launch.py's
|
||||||
callers don't have to branch on platform."""
|
callers don't have to branch on platform.
|
||||||
|
|
||||||
|
An exclusive file lock serialises concurrent calls so two
|
||||||
|
simultaneous launches don't read the same docker state and
|
||||||
|
claim the same alias."""
|
||||||
if not _is_macos():
|
if not _is_macos():
|
||||||
return "127.0.0.1"
|
return "127.0.0.1"
|
||||||
|
_ALLOC_LOCK_PATH.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
with open(_ALLOC_LOCK_PATH, "w", encoding="utf-8") as lf:
|
||||||
|
fcntl.flock(lf, fcntl.LOCK_EX)
|
||||||
|
return _allocate_locked()
|
||||||
|
|
||||||
|
|
||||||
|
def _allocate_locked() -> str:
|
||||||
in_use = _aliases_in_use()
|
in_use = _aliases_in_use()
|
||||||
for ip in _pool_addresses():
|
for ip in _pool_addresses():
|
||||||
if ip not in in_use:
|
if ip not in in_use:
|
||||||
@@ -192,7 +211,6 @@ def allocate(slug: str) -> str:
|
|||||||
f"Stop a running bottle (`smolvm machine ls --json`) or "
|
f"Stop a running bottle (`smolvm machine ls --json`) or "
|
||||||
f"raise _POOL_END in loopback_alias.py."
|
f"raise _POOL_END in loopback_alias.py."
|
||||||
)
|
)
|
||||||
return "" # unreachable; die() never returns
|
|
||||||
|
|
||||||
|
|
||||||
def _alias_present(ip: str) -> bool:
|
def _alias_present(ip: str) -> bool:
|
||||||
@@ -215,7 +233,7 @@ def _aliases_in_use() -> set[str]:
|
|||||||
`HostIp` out of its port bindings."""
|
`HostIp` out of its port bindings."""
|
||||||
result = subprocess.run(
|
result = subprocess.run(
|
||||||
["docker", "ps", "--format", "{{.Names}}",
|
["docker", "ps", "--format", "{{.Names}}",
|
||||||
"--filter", "name=claude-bottle-sidecars-"],
|
"--filter", "name=bot-bottle-sidecars-"],
|
||||||
capture_output=True, text=True, check=False,
|
capture_output=True, text=True, check=False,
|
||||||
)
|
)
|
||||||
if result.returncode != 0:
|
if result.returncode != 0:
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
"""Backend-infrastructure provisioners for the smolmachines backend.
|
||||||
|
|
||||||
|
Per PRD 0050 the per-provider provisioning steps (prompt, skills,
|
||||||
|
declarative provision-plan apply, supervise MCP registration) live on
|
||||||
|
the `AgentProvider` plugin under `bot_bottle/contrib/`. CA and git
|
||||||
|
provisioning also moved to the AgentProvider ABC (with Debian/node
|
||||||
|
defaults); user plugins override them for non-standard images.
|
||||||
|
|
||||||
|
No modules remain in this subpackage. Workspace copying now runs
|
||||||
|
through `BottleBackend.provision_workspace` against the running
|
||||||
|
bottle for every backend.
|
||||||
|
"""
|
||||||
@@ -0,0 +1,151 @@
|
|||||||
|
"""Host-side SIGWINCH → in-VM PTY resize bridge (issue #82).
|
||||||
|
|
||||||
|
smolvm 0.8.0 `machine exec -t` allocates an in-VM PTY but never
|
||||||
|
forwards the host terminal's window size (TIOCSWINSZ) to it. The
|
||||||
|
PTY's initial size is `0 0`, and any host-side resize during the
|
||||||
|
session goes unnoticed — the in-VM claude TUI keeps rendering for
|
||||||
|
whatever (typically tiny) box it last saw, ignoring the operator's
|
||||||
|
tmux pane resize. `docker exec -it` does this forwarding
|
||||||
|
automatically; smolvm doesn't.
|
||||||
|
|
||||||
|
This module wraps `smolvm machine exec` with a thin parent
|
||||||
|
process that:
|
||||||
|
|
||||||
|
1. Spawns the original argv as a child (it gets the inherited
|
||||||
|
TTY, so claude's stdin/stdout/stderr work unchanged).
|
||||||
|
2. On startup + every host SIGWINCH, reads the host terminal
|
||||||
|
size via TIOCGWINSZ on stdin (or stderr if stdin isn't a
|
||||||
|
TTY — tmux respawn-pane gives us a TTY on stdout/stderr)
|
||||||
|
and pushes it into the VM with a side-channel
|
||||||
|
`smolvm machine exec -- sh -c 'for f in /dev/pts/*; do
|
||||||
|
stty -F $f cols X rows Y; done'`. The kernel delivers
|
||||||
|
SIGWINCH to the foreground process group on the slave end
|
||||||
|
automatically, so claude picks up the new size without
|
||||||
|
extra signalling.
|
||||||
|
3. Waits on the child and exits with its returncode.
|
||||||
|
|
||||||
|
The dashboard's tmux pane respawn calls `bottle.agent_argv`
|
||||||
|
which now prepends `[sys.executable, -m, ..., <machine>, --, ...]`
|
||||||
|
to the smolvm argv. Foreground handoff (curses endwin →
|
||||||
|
subprocess.run) goes through the same path so behavior is
|
||||||
|
identical.
|
||||||
|
|
||||||
|
Removable once smolvm grows native SIGWINCH forwarding (upstream
|
||||||
|
follow-up tracked separately)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import fcntl
|
||||||
|
import signal
|
||||||
|
import struct
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import termios
|
||||||
|
import threading
|
||||||
|
from types import FrameType
|
||||||
|
|
||||||
|
|
||||||
|
# How long to wait after the main exec starts before pushing the
|
||||||
|
# initial size. Concurrent `smolvm machine exec` invocations race
|
||||||
|
# libkrun's per-exec OCI config write during the main exec's
|
||||||
|
# bringup window; the side-channel firing immediately corrupts
|
||||||
|
# `config.json` and the main exec dies with SIGKILL (rc=137) or
|
||||||
|
# libkrun's "parse error: trailing garbage" depending on
|
||||||
|
# scheduling. Two seconds is well past the bringup window on a
|
||||||
|
# warm VM, well under the operator's "this is unresponsive"
|
||||||
|
# threshold, and short enough that claude's initial render
|
||||||
|
# almost always fires after the size has been set.
|
||||||
|
_STARTUP_SYNC_DELAY_SEC = 2.0
|
||||||
|
|
||||||
|
|
||||||
|
def _read_winsize() -> tuple[int, int] | None:
|
||||||
|
"""Return `(rows, cols)` from whichever of stdin / stdout /
|
||||||
|
stderr is a TTY, or None if none are. Different invocation
|
||||||
|
surfaces give us different TTYs:
|
||||||
|
|
||||||
|
- foreground handoff (curses endwin → subprocess.run): all
|
||||||
|
three are the operator's terminal.
|
||||||
|
- tmux respawn-pane: tmux sets all three to the pane's PTY.
|
||||||
|
- non-TTY (someone piped stdin in tests): none are; the
|
||||||
|
sync just no-ops, which is the right behavior."""
|
||||||
|
for stream in (sys.stdin, sys.stdout, sys.stderr):
|
||||||
|
try:
|
||||||
|
fd = stream.fileno()
|
||||||
|
data = fcntl.ioctl(fd, termios.TIOCGWINSZ, b"\x00" * 8)
|
||||||
|
except OSError:
|
||||||
|
continue
|
||||||
|
rows, cols, _, _ = struct.unpack("hhhh", data)
|
||||||
|
if rows > 0 and cols > 0:
|
||||||
|
return rows, cols
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _push_size(machine: str, rows: int, cols: int) -> None:
|
||||||
|
"""Side-channel `smolvm machine exec` that sets the size of
|
||||||
|
every PTY in the VM. The shell `for` loop covers the case of
|
||||||
|
multiple concurrent interactive sessions (rare but cheap to
|
||||||
|
handle); `stty -F` returns silently on PTYs that don't apply.
|
||||||
|
|
||||||
|
Best-effort: swallow failures. A failed resize doesn't break
|
||||||
|
the session — it just leaves the in-VM PTY at its old size.
|
||||||
|
|
||||||
|
`stdin=DEVNULL` is load-bearing: under tmux, inheriting the
|
||||||
|
pane PTY here means two concurrent smolvm processes (this one
|
||||||
|
and the agent session the wrapper is shepherding) share the
|
||||||
|
PTY's foreground-process-group / input plumbing, and smolvm
|
||||||
|
bails with an internal config-parse error or SIGKILL within
|
||||||
|
~100ms of the side-channel firing. Outside tmux the same
|
||||||
|
pattern survived, presumably because iTerm's PTY plumbing is
|
||||||
|
more forgiving than tmux's, but the DEVNULL is the right
|
||||||
|
default either way — the side-channel never needs stdin."""
|
||||||
|
subprocess.run(
|
||||||
|
["smolvm", "machine", "exec", "--name", machine, "--",
|
||||||
|
"sh", "-c",
|
||||||
|
f"for f in /dev/pts/*; do "
|
||||||
|
f"stty -F \"$f\" cols {cols} rows {rows} 2>/dev/null; "
|
||||||
|
f"done"],
|
||||||
|
stdin=subprocess.DEVNULL,
|
||||||
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str]) -> int:
|
||||||
|
"""Entry point. `argv` shape: `<machine> -- <smolvm-argv...>`.
|
||||||
|
|
||||||
|
We don't use argparse — the `--` separator is the contract and
|
||||||
|
everything past it is forwarded verbatim. Keeps the wrapper
|
||||||
|
transparent for callers building argv programmatically."""
|
||||||
|
if len(argv) < 3 or argv[1] != "--":
|
||||||
|
sys.stderr.write(
|
||||||
|
"usage: python -m bot_bottle.backend.smolmachines.pty_resize "
|
||||||
|
"<machine> -- <smolvm-argv...>\n"
|
||||||
|
)
|
||||||
|
return 2
|
||||||
|
machine = argv[0]
|
||||||
|
inner = argv[2:]
|
||||||
|
|
||||||
|
def sync(_signum: int | None = None, _frame: FrameType | None = None) -> None:
|
||||||
|
size = _read_winsize()
|
||||||
|
if size is None:
|
||||||
|
return
|
||||||
|
_push_size(machine, *size)
|
||||||
|
|
||||||
|
signal.signal(signal.SIGWINCH, sync) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
proc = subprocess.Popen(inner)
|
||||||
|
# Initial sync is deferred — see _STARTUP_SYNC_DELAY_SEC.
|
||||||
|
# daemon=True so the timer doesn't block exit when the child
|
||||||
|
# finishes before the delay elapses.
|
||||||
|
timer = threading.Timer(_STARTUP_SYNC_DELAY_SEC, sync)
|
||||||
|
timer.daemon = True
|
||||||
|
timer.start()
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
return proc.wait()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
proc.send_signal(signal.SIGINT)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
sys.exit(main(sys.argv[1:]))
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
"""smolmachines `_resolve_plan` (PRD 0023 chunks 2d + 4c).
|
||||||
|
|
||||||
|
Resolves the per-bottle docker subnet + bundle IP and assembles
|
||||||
|
the guest env. The agent's docker image build → smolmachine
|
||||||
|
pack pipeline runs in `launch.launch`, not here, so the
|
||||||
|
dashboard's preflight modal isn't garbled by docker-build output
|
||||||
|
before the operator has confirmed.
|
||||||
|
|
||||||
|
No VM bringup — that's `launch.launch`'s job."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from .. import BottleSpec
|
||||||
|
from ...env import ResolvedEnv
|
||||||
|
from ...agent_provider import AgentProvisionPlan
|
||||||
|
from ...egress import EgressPlan
|
||||||
|
from ...supervise import SupervisePlan
|
||||||
|
from ...git_gate import GitGatePlan
|
||||||
|
from .bottle_plan import SmolmachinesBottlePlan
|
||||||
|
from .util import smolmachines_bundle_subnet, smolmachines_preflight
|
||||||
|
|
||||||
|
def preflight() -> None:
|
||||||
|
smolmachines_preflight()
|
||||||
|
|
||||||
|
|
||||||
|
def build_guest_env(resolved_env: ResolvedEnv) -> dict[str, str]:
|
||||||
|
# Agent's env: resolve through resolve_env() so ?prompt entries
|
||||||
|
# are prompted and ${HOST_VAR} entries are interpolated — matching
|
||||||
|
# the Docker backend's contract. Forwarded (secret/interpolated)
|
||||||
|
# values still reach the guest as -e K=V smolvm flags because
|
||||||
|
# smolvm 0.8.0 has no env-file or stdin injection path; this is
|
||||||
|
# the known argv-exposure gap documented in PRD 0038.
|
||||||
|
# HTTPS_PROXY / GIT_GATE_URL / MCP_SUPERVISE_URL are populated
|
||||||
|
# in launch.py after bundle bringup.
|
||||||
|
return {
|
||||||
|
**resolved_env.literals,
|
||||||
|
**resolved_env.forwarded,
|
||||||
|
"NO_PROXY": "localhost,127.0.0.1",
|
||||||
|
"NODE_EXTRA_CA_CERTS": "/etc/ssl/certs/ca-certificates.crt",
|
||||||
|
"SSL_CERT_FILE": "/etc/ssl/certs/ca-certificates.crt",
|
||||||
|
"REQUESTS_CA_BUNDLE": "/etc/ssl/certs/ca-certificates.crt",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_plan(
|
||||||
|
spec: BottleSpec,
|
||||||
|
slug: str,
|
||||||
|
resolved_env: ResolvedEnv,
|
||||||
|
agent_provision_plan: AgentProvisionPlan,
|
||||||
|
egress_plan: EgressPlan,
|
||||||
|
supervise_plan: SupervisePlan | None,
|
||||||
|
git_gate_plan: GitGatePlan,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> SmolmachinesBottlePlan:
|
||||||
|
"""Materialize the smolmachines plan. The bundle's docker
|
||||||
|
subnet + pinned IP are derived from the slug; the agent's
|
||||||
|
`.smolmachine` artifact is built (or cache-hit) here so
|
||||||
|
launch's `machine create --from` boots without a registry
|
||||||
|
pull. Per-bottle guest env + the TSI allow_cidrs land on the
|
||||||
|
plan for launch to pass straight through to
|
||||||
|
`machine create` flags."""
|
||||||
|
|
||||||
|
# ==== smolmachines specific setup ====
|
||||||
|
subnet, gateway, bundle_ip = smolmachines_bundle_subnet(slug)
|
||||||
|
|
||||||
|
return SmolmachinesBottlePlan(
|
||||||
|
spec=spec,
|
||||||
|
stage_dir=stage_dir,
|
||||||
|
slug=slug,
|
||||||
|
bundle_subnet=subnet,
|
||||||
|
bundle_gateway=gateway,
|
||||||
|
bundle_ip=bundle_ip,
|
||||||
|
guest_env=agent_provision_plan.guest_env,
|
||||||
|
git_gate_plan=git_gate_plan,
|
||||||
|
egress_plan=egress_plan,
|
||||||
|
supervise_plan=supervise_plan,
|
||||||
|
agent_provision=agent_provision_plan,
|
||||||
|
)
|
||||||
+33
-12
@@ -11,7 +11,7 @@ Two docker resources per bottle live here:
|
|||||||
— a race we can sidestep with `--ip`.
|
— a race we can sidestep with `--ip`.
|
||||||
|
|
||||||
- **The bundle container itself**, running the PRD 0024 bundle
|
- **The bundle container itself**, running the PRD 0024 bundle
|
||||||
image (`claude-bottle-sidecars:latest` by default). Same
|
image (`bot-bottle-sidecars:latest` by default). Same
|
||||||
image, same daemons, same daemon-private env / bind-mounts
|
image, same daemons, same daemon-private env / bind-mounts
|
||||||
as the docker backend.
|
as the docker backend.
|
||||||
|
|
||||||
@@ -19,7 +19,7 @@ This module ships the lifecycle primitives only — create
|
|||||||
network, start bundle, stop bundle, remove network — wrapped
|
network, start bundle, stop bundle, remove network — wrapped
|
||||||
around `subprocess.run(["docker", ...])`. Wiring them into the
|
around `subprocess.run(["docker", ...])`. Wiring them into the
|
||||||
launch flow + populating the `BundleLaunchSpec` from the inner
|
launch flow + populating the `BundleLaunchSpec` from the inner
|
||||||
Plans (PipelockProxyPlan, EgressPlan, …) lands in chunk 2d."""
|
Plans (EgressPlan, …) lands in chunk 2d."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -29,22 +29,29 @@ from pathlib import Path
|
|||||||
from typing import Sequence
|
from typing import Sequence
|
||||||
|
|
||||||
from ...log import die, warn
|
from ...log import die, warn
|
||||||
from ..docker.sidecar_bundle import SIDECAR_BUNDLE_IMAGE
|
from ..docker import util as docker_mod
|
||||||
|
from ..docker.sidecar_bundle import (
|
||||||
|
SIDECAR_BUNDLE_DOCKERFILE,
|
||||||
|
SIDECAR_BUNDLE_IMAGE,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_REPO_DIR = str(Path(__file__).resolve().parent.parent.parent.parent)
|
||||||
|
|
||||||
|
|
||||||
def bundle_network_name(slug: str) -> str:
|
def bundle_network_name(slug: str) -> str:
|
||||||
"""`claude-bottle-bundle-<slug>` — distinct from the docker
|
"""`bot-bottle-bundle-<slug>` — distinct from the docker
|
||||||
backend's `claude-bottle-net-<slug>` so a smolmachines bottle
|
backend's `bot-bottle-net-<slug>` so a smolmachines bottle
|
||||||
and a docker bottle for the same agent don't collide on
|
and a docker bottle for the same agent don't collide on
|
||||||
network name."""
|
network name."""
|
||||||
return f"claude-bottle-bundle-{slug}"
|
return f"bot-bottle-bundle-{slug}"
|
||||||
|
|
||||||
|
|
||||||
def bundle_container_name(slug: str) -> str:
|
def bundle_container_name(slug: str) -> str:
|
||||||
"""`claude-bottle-sidecars-<slug>` — same name shape the docker
|
"""`bot-bottle-sidecars-<slug>` — same name shape the docker
|
||||||
backend uses for the bundle (PRD 0024 chunk 5). The dashboard's
|
backend uses for the bundle (PRD 0024 chunk 5). The dashboard's
|
||||||
prefix-based discovery covers both backends with one filter."""
|
prefix-based discovery covers both backends with one filter."""
|
||||||
return f"claude-bottle-sidecars-{slug}"
|
return f"bot-bottle-sidecars-{slug}"
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -59,10 +66,10 @@ class BundleLaunchSpec:
|
|||||||
gateway: str
|
gateway: str
|
||||||
bundle_ip: str
|
bundle_ip: str
|
||||||
image: str = SIDECAR_BUNDLE_IMAGE
|
image: str = SIDECAR_BUNDLE_IMAGE
|
||||||
# Daemon subset CSV for CLAUDE_BOTTLE_SIDECAR_DAEMONS. The
|
# Daemon subset CSV for BOT_BOTTLE_SIDECAR_DAEMONS. The
|
||||||
# supervisor inside the bundle reads it to skip
|
# supervisor inside the bundle reads it to skip
|
||||||
# bottle-irrelevant daemons (e.g. supervise=False bottles).
|
# bottle-irrelevant daemons (e.g. supervise=False bottles).
|
||||||
daemons_csv: str = "egress,pipelock"
|
daemons_csv: str = "egress"
|
||||||
# Plain "KEY=VALUE" strings + "KEY" bare names (the bare-name
|
# Plain "KEY=VALUE" strings + "KEY" bare names (the bare-name
|
||||||
# form inherits the value from the docker-run subprocess env,
|
# form inherits the value from the docker-run subprocess env,
|
||||||
# matching the docker backend's compose-up secret-forwarding
|
# matching the docker backend's compose-up secret-forwarding
|
||||||
@@ -85,6 +92,21 @@ class BundleLaunchSpec:
|
|||||||
publish_host_ip: str = "127.0.0.1"
|
publish_host_ip: str = "127.0.0.1"
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_bundle_image(image: str = SIDECAR_BUNDLE_IMAGE) -> None:
|
||||||
|
"""Build the sidecar bundle image before `docker run`.
|
||||||
|
|
||||||
|
The Docker backend gets this for free from compose's `build:`
|
||||||
|
stanza. smolmachines starts the bundle with plain `docker run`,
|
||||||
|
so without an explicit build a first launch tries to pull the
|
||||||
|
local-only `bot-bottle-sidecars:latest` tag from a registry.
|
||||||
|
"""
|
||||||
|
docker_mod.build_image(
|
||||||
|
image,
|
||||||
|
_REPO_DIR,
|
||||||
|
dockerfile=SIDECAR_BUNDLE_DOCKERFILE,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def create_bundle_network(network_name: str, subnet: str, gateway: str) -> None:
|
def create_bundle_network(network_name: str, subnet: str, gateway: str) -> None:
|
||||||
"""`docker network create` with an explicit subnet + gateway
|
"""`docker network create` with an explicit subnet + gateway
|
||||||
so the bundle's `--ip` lands on the address the Smolfile's
|
so the bundle's `--ip` lands on the address the Smolfile's
|
||||||
@@ -141,7 +163,7 @@ def start_bundle(spec: BundleLaunchSpec, *,
|
|||||||
"--rm",
|
"--rm",
|
||||||
"--network", spec.network_name,
|
"--network", spec.network_name,
|
||||||
"--ip", spec.bundle_ip,
|
"--ip", spec.bundle_ip,
|
||||||
"-e", f"CLAUDE_BOTTLE_SIDECAR_DAEMONS={spec.daemons_csv}",
|
"-e", f"BOT_BOTTLE_SIDECAR_DAEMONS={spec.daemons_csv}",
|
||||||
]
|
]
|
||||||
for entry in spec.environment:
|
for entry in spec.environment:
|
||||||
argv += ["-e", entry]
|
argv += ["-e", entry]
|
||||||
@@ -201,7 +223,6 @@ def bundle_host_port(
|
|||||||
f"no port mapping on {host_ip} for {container} "
|
f"no port mapping on {host_ip} for {container} "
|
||||||
f"{container_port}/tcp; got: {(result.stdout or '').strip()!r}"
|
f"{container_port}/tcp; got: {(result.stdout or '').strip()!r}"
|
||||||
)
|
)
|
||||||
return -1 # unreachable; die() never returns
|
|
||||||
|
|
||||||
|
|
||||||
def stop_bundle(slug: str) -> None:
|
def stop_bundle(slug: str) -> None:
|
||||||
+32
-2
@@ -27,11 +27,13 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
|
import time
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Mapping, Sequence
|
from typing import Mapping, Sequence
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
_SMOLVM = "smolvm"
|
_SMOLVM = "smolvm"
|
||||||
|
|
||||||
|
|
||||||
@@ -50,7 +52,7 @@ class SmolvmError(RuntimeError):
|
|||||||
pack failed, etc.). Carries the captured stderr for the
|
pack failed, etc.). Carries the captured stderr for the
|
||||||
operator-facing log line."""
|
operator-facing log line."""
|
||||||
|
|
||||||
def __init__(self, argv: Sequence[str], result: subprocess.CompletedProcess):
|
def __init__(self, argv: Sequence[str], result: subprocess.CompletedProcess[str]):
|
||||||
self.argv = list(argv)
|
self.argv = list(argv)
|
||||||
self.returncode = result.returncode
|
self.returncode = result.returncode
|
||||||
self.stdout = result.stdout
|
self.stdout = result.stdout
|
||||||
@@ -63,7 +65,7 @@ class SmolvmError(RuntimeError):
|
|||||||
|
|
||||||
|
|
||||||
def _smolvm(*args: str, env: Mapping[str, str] | None = None,
|
def _smolvm(*args: str, env: Mapping[str, str] | None = None,
|
||||||
check: bool = True) -> subprocess.CompletedProcess:
|
check: bool = True) -> subprocess.CompletedProcess[str]:
|
||||||
"""One subprocess call into the smolvm CLI. `check=True`
|
"""One subprocess call into the smolvm CLI. `check=True`
|
||||||
raises SmolvmError on non-zero; `check=False` returns the
|
raises SmolvmError on non-zero; `check=False` returns the
|
||||||
CompletedProcess for the caller to inspect."""
|
CompletedProcess for the caller to inspect."""
|
||||||
@@ -197,6 +199,34 @@ def machine_exec(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def wait_exec_ready(name: str, *, timeout: float = 5.0) -> None:
|
||||||
|
"""Poll `machine exec true` until exit 0 or `timeout` elapses.
|
||||||
|
|
||||||
|
Replaces `time.sleep(1.5)` after `machine_start`: libkrun's exec
|
||||||
|
channel needs a brief warm-up before back-to-back exec calls are
|
||||||
|
safe. Polling exits as soon as the channel is ready and fails
|
||||||
|
loudly if the VM never responds."""
|
||||||
|
deadline = time.monotonic() + timeout
|
||||||
|
delay = 0.1
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
r = machine_exec(name, ["true"])
|
||||||
|
if r.returncode == 0:
|
||||||
|
return
|
||||||
|
remaining = deadline - time.monotonic()
|
||||||
|
if remaining <= 0:
|
||||||
|
break
|
||||||
|
time.sleep(min(delay, remaining))
|
||||||
|
delay = min(delay * 2, 0.5)
|
||||||
|
argv = ["smolvm", "machine", "exec", "--name", name, "--", "true"]
|
||||||
|
raise SmolvmError(
|
||||||
|
argv,
|
||||||
|
subprocess.CompletedProcess(
|
||||||
|
args=argv, returncode=-1, stdout="",
|
||||||
|
stderr=f"exec channel not ready after {timeout:.0f}s — VM may have failed to boot.",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def machine_cp(src: str, dst: str) -> None:
|
def machine_cp(src: str, dst: str) -> None:
|
||||||
"""`smolvm machine cp SRC DST`. Path syntax: `machine:path` to
|
"""`smolvm machine cp SRC DST`. Path syntax: `machine:path` to
|
||||||
reference a path inside the VM, bare path for the host. Both
|
reference a path inside the VM, bare path for the host. Both
|
||||||
+4
-2
@@ -19,9 +19,11 @@ def smolmachines_preflight() -> None:
|
|||||||
if shutil.which("smolvm") is not None:
|
if shutil.which("smolvm") is not None:
|
||||||
return
|
return
|
||||||
die(
|
die(
|
||||||
"CLAUDE_BOTTLE_BACKEND=smolmachines requires `smolvm` on "
|
"BOT_BOTTLE_BACKEND=smolmachines requires `smolvm` on "
|
||||||
"PATH. Install with: "
|
"PATH. Install with: "
|
||||||
"curl -sSL https://smolmachines.com/install.sh | sh"
|
"curl -sSL https://smolmachines.com/install.sh | sh. "
|
||||||
|
"To use the legacy Docker backend instead, set "
|
||||||
|
"BOT_BOTTLE_BACKEND=docker or pass --backend=docker."
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
"""Terminal escape-sequence helpers shared across all bottle backends."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import shlex
|
||||||
|
|
||||||
|
|
||||||
|
# color name → (normal_idx, normal_hex, bright_idx, bright_hex, dark_bg_hex)
|
||||||
|
# OSC 4 sets indexed palette entries (affects syntax-highlighted code and any
|
||||||
|
# TUI content that uses indexed colors). dark_bg_hex is used for OSC 11
|
||||||
|
# (default background) — a very dark tint that's visible even when the TUI
|
||||||
|
# uses true/24-bit colors for its own chrome, which would otherwise bypass
|
||||||
|
# the palette entirely.
|
||||||
|
_COLORS: dict[str, tuple[int, str, int, str, str]] = {
|
||||||
|
"black": (0, "#2d2d2d", 8, "#5c5c5c", "#0a0a0a"),
|
||||||
|
"red": (1, "#c0392b", 9, "#e74c3c", "#1a0707"),
|
||||||
|
"green": (2, "#27ae60", 10, "#2ecc71", "#071a09"),
|
||||||
|
"yellow": (3, "#d4ac0d", 11, "#f1c40f", "#1a1507"),
|
||||||
|
"blue": (4, "#2471a3", 12, "#3498db", "#07071a"),
|
||||||
|
"magenta": (5, "#7d3c98", 13, "#9b59b6", "#12071a"),
|
||||||
|
"cyan": (6, "#148f77", 14, "#1abc9c", "#071a1a"),
|
||||||
|
"white": (7, "#bdc3c7", 15, "#ecf0f1", "#111111"),
|
||||||
|
"bright-black": (8, "#5c5c5c", 0, "#2d2d2d", "#111111"),
|
||||||
|
"bright-red": (9, "#e74c3c", 1, "#c0392b", "#200808"),
|
||||||
|
"bright-green": (10, "#2ecc71", 2, "#27ae60", "#082008"),
|
||||||
|
"bright-yellow": (11, "#f1c40f", 3, "#d4ac0d", "#201808"),
|
||||||
|
"bright-blue": (12, "#3498db", 4, "#2471a3", "#080820"),
|
||||||
|
"bright-magenta": (13, "#9b59b6", 5, "#7d3c98", "#160820"),
|
||||||
|
"bright-cyan": (14, "#1abc9c", 6, "#148f77", "#082020"),
|
||||||
|
"bright-white": (15, "#ecf0f1", 7, "#bdc3c7", "#151515"),
|
||||||
|
}
|
||||||
|
|
||||||
|
# OSC 104 resets all indexed palette entries; OSC 111 resets default background.
|
||||||
|
_RESET_PRINTF = "printf '\\033]104\\007\\033]111\\007'"
|
||||||
|
|
||||||
|
|
||||||
|
def palette_printf(color: str) -> str:
|
||||||
|
"""Shell `printf` command that emits OSC 4 + OSC 11 to tint the terminal
|
||||||
|
for *color*: sets the normal/bright palette entries AND the default
|
||||||
|
background to a dark shade of that color. Returns '' if unknown."""
|
||||||
|
entry = _COLORS.get(color)
|
||||||
|
if not entry:
|
||||||
|
return ""
|
||||||
|
n_idx, n_hex, b_idx, b_hex, bg_hex = entry
|
||||||
|
seq = (
|
||||||
|
f"\\033]4;{n_idx};{n_hex}\\007"
|
||||||
|
f"\\033]4;{b_idx};{b_hex}\\007"
|
||||||
|
f"\\033]11;{bg_hex}\\007"
|
||||||
|
)
|
||||||
|
return f"printf '{seq}'"
|
||||||
|
|
||||||
|
|
||||||
|
def exec_shell_script(
|
||||||
|
agent_argv: list[str],
|
||||||
|
terminal_title: str = "",
|
||||||
|
terminal_color: str = "",
|
||||||
|
) -> str | None:
|
||||||
|
"""Build a shell script string that optionally sets the terminal
|
||||||
|
title and/or palette before running *agent_argv*, and resets the
|
||||||
|
palette + background on exit. Returns None when no decoration is
|
||||||
|
needed — callers should run *agent_argv* directly in that case."""
|
||||||
|
title_cmd = (
|
||||||
|
f"printf '\\033]0;%s\\007' {shlex.quote(terminal_title)}"
|
||||||
|
if terminal_title else ""
|
||||||
|
)
|
||||||
|
pal_cmd = palette_printf(terminal_color)
|
||||||
|
|
||||||
|
if not title_cmd and not pal_cmd:
|
||||||
|
return None
|
||||||
|
|
||||||
|
parts: list[str] = []
|
||||||
|
if title_cmd:
|
||||||
|
parts.append(title_cmd)
|
||||||
|
if pal_cmd:
|
||||||
|
parts.append(pal_cmd)
|
||||||
|
parts.append(shlex.join(agent_argv))
|
||||||
|
parts.append(_RESET_PRINTF)
|
||||||
|
else:
|
||||||
|
# No palette change — exec so the agent replaces the shell.
|
||||||
|
parts.append(f"exec {shlex.join(agent_argv)}")
|
||||||
|
|
||||||
|
return "; ".join(parts)
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
"""Cross-backend utility helpers — host-side primitives shared by
|
||||||
|
every backend implementation. Backend-specific helpers live one level
|
||||||
|
deeper (e.g. bot_bottle/backend/docker/util.py)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import hashlib
|
||||||
|
import os
|
||||||
|
import ssl
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from ..log import die, info
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ..egress import EgressPlan
|
||||||
|
|
||||||
|
|
||||||
|
# Debian-family CA layout, shared by every backend (all guest images
|
||||||
|
# are Debian-family). AGENT_CA_PATH is the source path that
|
||||||
|
# `update-ca-certificates` reads; AGENT_CA_BUNDLE is the bundle it
|
||||||
|
# rebuilds, which curl, Python `ssl`, and OpenSSL-based tools all read
|
||||||
|
# by default.
|
||||||
|
AGENT_CA_PATH = "/usr/local/share/ca-certificates/bot-bottle-mitm-ca.crt"
|
||||||
|
AGENT_CA_BUNDLE = "/etc/ssl/certs/ca-certificates.crt"
|
||||||
|
|
||||||
|
|
||||||
|
def host_skill_dir(name: str) -> str:
|
||||||
|
"""Return the host-side path for a named skill:
|
||||||
|
`$HOME/.claude/skills/<name>`. Dies if HOME is unset."""
|
||||||
|
home = os.environ.get("HOME")
|
||||||
|
if not home:
|
||||||
|
die("HOME not set")
|
||||||
|
return f"{home}/.claude/skills/{name}"
|
||||||
|
|
||||||
|
|
||||||
|
def select_ca_cert(egress_plan: EgressPlan) -> tuple[Path, str]:
|
||||||
|
"""Return the egress MITM CA cert path and label for provision_ca.
|
||||||
|
|
||||||
|
Launch always mints the CA and re-binds the host path into the
|
||||||
|
egress_plan before provision runs, so an empty/missing path here
|
||||||
|
means launch's bringup is broken — fatal."""
|
||||||
|
cert = egress_plan.mitmproxy_ca_cert_only_host_path
|
||||||
|
if cert == Path() or not cert.is_file():
|
||||||
|
die(
|
||||||
|
f"egress CA cert missing at {cert or '(empty)'}; "
|
||||||
|
f"launch must have called egress_tls_init and "
|
||||||
|
f"re-bound the plan before provision"
|
||||||
|
)
|
||||||
|
return cert, "egress"
|
||||||
|
|
||||||
|
|
||||||
|
def log_ca_fingerprint(cert_host_path: Path, label: str) -> None:
|
||||||
|
"""Compute the cert's SHA-256 fingerprint over its DER bytes
|
||||||
|
(stdlib `ssl` + `hashlib`) and log it once to stderr — the
|
||||||
|
standard fingerprint form. Only ever touches the public cert;
|
||||||
|
the private key stays on the host under the stage dir until
|
||||||
|
teardown."""
|
||||||
|
der = ssl.PEM_cert_to_DER_cert(cert_host_path.read_text())
|
||||||
|
fingerprint = hashlib.sha256(der).hexdigest()
|
||||||
|
info(f"{label} ca fingerprint: sha256:{fingerprint[:32]}...")
|
||||||
@@ -6,15 +6,15 @@ helper saves before teardown, and the launch metadata that lets
|
|||||||
`cli.py resume <identity>` reconstruct a bottle's spec. State
|
`cli.py resume <identity>` reconstruct a bottle's spec. State
|
||||||
lives at:
|
lives at:
|
||||||
|
|
||||||
~/.claude-bottle/state/<identity>/
|
~/.bot-bottle/state/<identity>/
|
||||||
metadata.json — agent_name + cwd + started_at (for resume)
|
metadata.json — agent_name + cwd + started_at (for resume)
|
||||||
Dockerfile — per-bottle override (absent → use repo's)
|
Dockerfile — per-bottle override (absent → use repo's)
|
||||||
transcript/ — last snapshotted agent state (best-effort)
|
transcript/ — last snapshotted agent state (best-effort)
|
||||||
|
|
||||||
When the per-bottle Dockerfile is present, the launch step builds
|
When the per-bottle Dockerfile is present, the launch step builds
|
||||||
the agent image with a per-bottle tag (claude-bottle-rebuilt-<id>)
|
the agent image with a per-bottle tag (bot-bottle-rebuilt-<id>)
|
||||||
from this file rather than the repo's. The build context is still
|
from this file rather than the repo's. The build context is still
|
||||||
the repo root so the Dockerfile can COPY claude_bottle source files
|
the repo root so the Dockerfile can COPY bot_bottle source files
|
||||||
the same way the original does.
|
the same way the original does.
|
||||||
|
|
||||||
Identity model:
|
Identity model:
|
||||||
@@ -35,12 +35,12 @@ import secrets
|
|||||||
import string
|
import string
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from typing import cast
|
||||||
|
|
||||||
from ... import supervise as _supervise
|
from . import supervise as _supervise
|
||||||
from . import util as docker_mod
|
|
||||||
|
|
||||||
|
|
||||||
# Directory layout: ~/.claude-bottle/state/<identity>/...
|
# Directory layout: ~/.bot-bottle/state/<identity>/...
|
||||||
_STATE_SUBDIR = "state"
|
_STATE_SUBDIR = "state"
|
||||||
_PER_BOTTLE_DOCKERFILE_NAME = "Dockerfile"
|
_PER_BOTTLE_DOCKERFILE_NAME = "Dockerfile"
|
||||||
_TRANSCRIPT_SUBDIR = "transcript"
|
_TRANSCRIPT_SUBDIR = "transcript"
|
||||||
@@ -48,7 +48,6 @@ _TRANSCRIPT_SUBDIR = "transcript"
|
|||||||
# live here so chunk 3's `docker compose up` can find them at stable
|
# live here so chunk 3's `docker compose up` can find them at stable
|
||||||
# paths. Each sidecar's `prepare()` writes config + CAs into its own
|
# paths. Each sidecar's `prepare()` writes config + CAs into its own
|
||||||
# subdir; the launch step is unchanged today (still `docker cp`).
|
# subdir; the launch step is unchanged today (still `docker cp`).
|
||||||
_PIPELOCK_SUBDIR = "pipelock"
|
|
||||||
_EGRESS_SUBDIR = "egress"
|
_EGRESS_SUBDIR = "egress"
|
||||||
_GIT_GATE_SUBDIR = "git-gate"
|
_GIT_GATE_SUBDIR = "git-gate"
|
||||||
_SUPERVISE_SUBDIR = "supervise"
|
_SUPERVISE_SUBDIR = "supervise"
|
||||||
@@ -56,8 +55,8 @@ _AGENT_SUBDIR = "agent"
|
|||||||
_METADATA_NAME = "metadata.json"
|
_METADATA_NAME = "metadata.json"
|
||||||
# Live-config dir bind-mounted into the supervise sidecar (read-only).
|
# Live-config dir bind-mounted into the supervise sidecar (read-only).
|
||||||
# Host's apply paths keep these files fresh so supervise's
|
# Host's apply paths keep these files fresh so supervise's
|
||||||
# `list-pipelock-allowlist` / `list-egress-routes` MCP tools
|
# `list-egress-routes` MCP tool returns the current state —
|
||||||
# return the current state — not a snapshot from launch time.
|
# not a snapshot from launch time.
|
||||||
_LIVE_CONFIG_SUBDIR = "live-config"
|
_LIVE_CONFIG_SUBDIR = "live-config"
|
||||||
LIVE_CONFIG_ROUTES_NAME = "routes.yaml"
|
LIVE_CONFIG_ROUTES_NAME = "routes.yaml"
|
||||||
LIVE_CONFIG_ALLOWLIST_NAME = "allowlist"
|
LIVE_CONFIG_ALLOWLIST_NAME = "allowlist"
|
||||||
@@ -82,6 +81,7 @@ def bottle_identity(agent_name: str) -> str:
|
|||||||
To continue an existing bottle's state, use the recorded
|
To continue an existing bottle's state, use the recorded
|
||||||
identity from BottleMetadata via `cli.py resume <identity>`,
|
identity from BottleMetadata via `cli.py resume <identity>`,
|
||||||
not this function."""
|
not this function."""
|
||||||
|
from .backend.docker import util as docker_mod
|
||||||
slug = docker_mod.slugify(agent_name)
|
slug = docker_mod.slugify(agent_name)
|
||||||
suffix = "".join(secrets.choice(_SUFFIX_ALPHABET) for _ in range(_RANDOM_SUFFIX_LEN))
|
suffix = "".join(secrets.choice(_SUFFIX_ALPHABET) for _ in range(_RANDOM_SUFFIX_LEN))
|
||||||
return f"{slug}-{suffix}"
|
return f"{slug}-{suffix}"
|
||||||
@@ -91,7 +91,7 @@ def bottle_identity(agent_name: str) -> str:
|
|||||||
class BottleMetadata:
|
class BottleMetadata:
|
||||||
"""Persistent record of how a bottle was launched, written at
|
"""Persistent record of how a bottle was launched, written at
|
||||||
start time and read by `cli.py resume`. Lives at
|
start time and read by `cli.py resume`. Lives at
|
||||||
~/.claude-bottle/state/<identity>/metadata.json."""
|
~/.bot-bottle/state/<identity>/metadata.json."""
|
||||||
|
|
||||||
identity: str
|
identity: str
|
||||||
agent_name: str
|
agent_name: str
|
||||||
@@ -105,6 +105,12 @@ class BottleMetadata:
|
|||||||
# written before chunk 3 (resume / inspect should fall back to
|
# written before chunk 3 (resume / inspect should fall back to
|
||||||
# deriving from identity in that case).
|
# deriving from identity in that case).
|
||||||
compose_project: str = ""
|
compose_project: str = ""
|
||||||
|
# PRD 0040: backend name ("docker" or "smolmachines"). Empty string
|
||||||
|
# for state dirs written before PRD 0040; callers default to "docker"
|
||||||
|
# for backward compatibility.
|
||||||
|
backend: str = ""
|
||||||
|
label: str = ""
|
||||||
|
color: str = ""
|
||||||
|
|
||||||
|
|
||||||
def metadata_path(identity: str) -> Path:
|
def metadata_path(identity: str) -> Path:
|
||||||
@@ -112,7 +118,7 @@ def metadata_path(identity: str) -> Path:
|
|||||||
|
|
||||||
|
|
||||||
def write_metadata(metadata: BottleMetadata) -> Path:
|
def write_metadata(metadata: BottleMetadata) -> Path:
|
||||||
"""Persist `metadata` to ~/.claude-bottle/state/<identity>/metadata.json.
|
"""Persist `metadata` to ~/.bot-bottle/state/<identity>/metadata.json.
|
||||||
Mode 0o644 — no secrets, just (agent_name, cwd, timestamp)."""
|
Mode 0o644 — no secrets, just (agent_name, cwd, timestamp)."""
|
||||||
path = metadata_path(metadata.identity)
|
path = metadata_path(metadata.identity)
|
||||||
path.parent.mkdir(parents=True, exist_ok=True)
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
@@ -131,20 +137,24 @@ def read_metadata(identity: str) -> BottleMetadata | None:
|
|||||||
raw = json.loads(path.read_text())
|
raw = json.loads(path.read_text())
|
||||||
if not isinstance(raw, dict):
|
if not isinstance(raw, dict):
|
||||||
return None
|
return None
|
||||||
|
raw_typed = cast(dict[str, object], raw)
|
||||||
return BottleMetadata(
|
return BottleMetadata(
|
||||||
identity=str(raw.get("identity", identity)),
|
identity=str(raw_typed.get("identity", identity)),
|
||||||
agent_name=str(raw.get("agent_name", "")),
|
agent_name=str(raw_typed.get("agent_name", "")),
|
||||||
cwd=str(raw.get("cwd", "")),
|
cwd=str(raw_typed.get("cwd", "")),
|
||||||
copy_cwd=bool(raw.get("copy_cwd", False)),
|
copy_cwd=bool(raw_typed.get("copy_cwd", False)),
|
||||||
started_at=str(raw.get("started_at", "")),
|
started_at=str(raw_typed.get("started_at", "")),
|
||||||
compose_project=str(raw.get("compose_project", "")),
|
compose_project=str(raw_typed.get("compose_project", "")),
|
||||||
|
backend=str(raw_typed.get("backend", "")),
|
||||||
|
label=str(raw_typed.get("label", "")),
|
||||||
|
color=str(raw_typed.get("color", "")),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def bottle_state_dir(identity: str) -> Path:
|
def bottle_state_dir(identity: str) -> Path:
|
||||||
"""Per-bottle state directory on the host. Created lazily by the
|
"""Per-bottle state directory on the host. Created lazily by the
|
||||||
write helpers; readers tolerate its absence."""
|
write helpers; readers tolerate its absence."""
|
||||||
return _supervise.claude_bottle_root() / _STATE_SUBDIR / identity
|
return _supervise.bot_bottle_root() / _STATE_SUBDIR / identity
|
||||||
|
|
||||||
|
|
||||||
def per_bottle_dockerfile_path(identity: str) -> Path:
|
def per_bottle_dockerfile_path(identity: str) -> Path:
|
||||||
@@ -171,9 +181,9 @@ def write_per_bottle_dockerfile(identity: str, content: str) -> Path:
|
|||||||
|
|
||||||
def per_bottle_image_tag(identity: str) -> str:
|
def per_bottle_image_tag(identity: str) -> str:
|
||||||
"""Image tag for a rebuilt bottle. Distinct from the base
|
"""Image tag for a rebuilt bottle. Distinct from the base
|
||||||
claude-bottle:latest so per-bottle rebuilds don't collide in
|
bot-bottle-claude:latest so per-bottle rebuilds don't collide in
|
||||||
the docker image cache."""
|
the docker image cache."""
|
||||||
return f"claude-bottle-rebuilt-{identity}:latest"
|
return f"bot-bottle-rebuilt-{identity}:latest"
|
||||||
|
|
||||||
|
|
||||||
def live_config_dir(identity: str) -> Path:
|
def live_config_dir(identity: str) -> Path:
|
||||||
@@ -227,12 +237,6 @@ def transcript_snapshot_dir(identity: str) -> Path:
|
|||||||
# nothing requested preservation.
|
# nothing requested preservation.
|
||||||
|
|
||||||
|
|
||||||
def pipelock_state_dir(identity: str) -> Path:
|
|
||||||
"""State subdir for the pipelock sidecar: pipelock.yaml + the
|
|
||||||
per-bottle CA cert/key. Bind-mount source from chunk 3 onward."""
|
|
||||||
return bottle_state_dir(identity) / _PIPELOCK_SUBDIR
|
|
||||||
|
|
||||||
|
|
||||||
def egress_state_dir(identity: str) -> Path:
|
def egress_state_dir(identity: str) -> Path:
|
||||||
"""State subdir for the egress sidecar: routes.yaml + the
|
"""State subdir for the egress sidecar: routes.yaml + the
|
||||||
per-bottle mitmproxy CA. Bind-mount source from chunk 3 onward."""
|
per-bottle mitmproxy CA. Bind-mount source from chunk 3 onward."""
|
||||||
@@ -248,9 +252,9 @@ def git_gate_state_dir(identity: str) -> Path:
|
|||||||
|
|
||||||
def supervise_state_dir(identity: str) -> Path:
|
def supervise_state_dir(identity: str) -> Path:
|
||||||
"""State subdir for the supervise sidecar's current-config dir
|
"""State subdir for the supervise sidecar's current-config dir
|
||||||
(bind-mounted into the agent at /etc/claude-bottle/current-config).
|
(bind-mounted into the agent at /etc/bot-bottle/current-config).
|
||||||
The queue dir is intentionally NOT under here — it lives at
|
The queue dir is intentionally NOT under here — it lives at
|
||||||
~/.claude-bottle/queue/<slug>/ alongside the audit logs, so it
|
~/.bot-bottle/queue/<slug>/ alongside the audit logs, so it
|
||||||
survives state-dir cleanup."""
|
survives state-dir cleanup."""
|
||||||
return bottle_state_dir(identity) / _SUPERVISE_SUBDIR
|
return bottle_state_dir(identity) / _SUPERVISE_SUBDIR
|
||||||
|
|
||||||
@@ -318,7 +322,6 @@ __all__ = [
|
|||||||
"per_bottle_dockerfile",
|
"per_bottle_dockerfile",
|
||||||
"per_bottle_dockerfile_path",
|
"per_bottle_dockerfile_path",
|
||||||
"per_bottle_image_tag",
|
"per_bottle_image_tag",
|
||||||
"pipelock_state_dir",
|
|
||||||
"preserve_marker_path",
|
"preserve_marker_path",
|
||||||
"read_metadata",
|
"read_metadata",
|
||||||
"supervise_state_dir",
|
"supervise_state_dir",
|
||||||
@@ -1,48 +1,58 @@
|
|||||||
"""Main CLI dispatcher.
|
"""Main CLI dispatcher.
|
||||||
|
|
||||||
Commands: cleanup, dashboard, edit, info, init, list, resume, start
|
Commands: cleanup, edit, info, init, list, resume, start, supervise
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from ..log import Die, die
|
from ..log import Die, die, error
|
||||||
|
from ..manifest import ManifestError
|
||||||
from ._common import PROG
|
from ._common import PROG
|
||||||
from . import list as _list_mod
|
from . import list as _list_mod
|
||||||
from .cleanup import cmd_cleanup
|
from .cleanup import cmd_cleanup
|
||||||
from .dashboard import cmd_dashboard
|
|
||||||
from .edit import cmd_edit
|
from .edit import cmd_edit
|
||||||
from .info import cmd_info
|
from .info import cmd_info
|
||||||
from .init import cmd_init
|
from .init import cmd_init
|
||||||
from .resume import cmd_resume
|
from .resume import cmd_resume
|
||||||
from .start import cmd_start
|
from .start import cmd_start
|
||||||
|
from .supervise import cmd_supervise
|
||||||
|
|
||||||
cmd_list = _list_mod.cmd_list
|
cmd_list = _list_mod.cmd_list
|
||||||
|
|
||||||
COMMANDS = {
|
COMMANDS = {
|
||||||
"cleanup": cmd_cleanup,
|
"cleanup": cmd_cleanup,
|
||||||
"dashboard": cmd_dashboard,
|
|
||||||
"edit": cmd_edit,
|
"edit": cmd_edit,
|
||||||
"info": cmd_info,
|
"info": cmd_info,
|
||||||
"init": cmd_init,
|
"init": cmd_init,
|
||||||
"list": cmd_list,
|
"list": cmd_list,
|
||||||
"resume": cmd_resume,
|
"resume": cmd_resume,
|
||||||
"start": cmd_start,
|
"start": cmd_start,
|
||||||
|
"supervise": cmd_supervise,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def usage() -> None:
|
def usage() -> None:
|
||||||
sys.stderr.write(f"usage: {PROG} <command> [args...]\n\n")
|
sys.stderr.write(f"usage: {PROG} <command> [args...]\n\n")
|
||||||
sys.stderr.write("Commands:\n")
|
sys.stderr.write("Commands:\n")
|
||||||
sys.stderr.write(" cleanup stop and remove all active claude-bottle containers\n")
|
sys.stderr.write(" cleanup stop and remove all active bot-bottle containers\n")
|
||||||
sys.stderr.write(" dashboard view + approve/modify/reject pending supervise proposals (PRD 0013)\n")
|
|
||||||
sys.stderr.write(" edit open an agent in vim for editing\n")
|
sys.stderr.write(" edit open an agent in vim for editing\n")
|
||||||
sys.stderr.write(" info print env, skills, and prompt details for a named agent\n")
|
sys.stderr.write(" info print env, skills, and prompt details for a named agent\n")
|
||||||
sys.stderr.write(" init interactively create a new agent and add it to claude-bottle.json\n")
|
sys.stderr.write(" init interactively create a new agent and add it to bot-bottle.json\n")
|
||||||
sys.stderr.write(" list list available agents or active containers\n")
|
sys.stderr.write(" list list available agents or active containers\n")
|
||||||
sys.stderr.write(" resume re-launch a bottle by its identity (continues state from PRD 0016)\n")
|
sys.stderr.write(
|
||||||
sys.stderr.write(" start boot a container for a named agent and attach an interactive session\n\n")
|
" resume re-launch a bottle by its identity "
|
||||||
|
"(continues state from PRD 0016)\n"
|
||||||
|
)
|
||||||
|
sys.stderr.write(
|
||||||
|
" start boot a container for a named agent and "
|
||||||
|
"attach an interactive session\n"
|
||||||
|
)
|
||||||
|
sys.stderr.write(
|
||||||
|
" supervise view + approve/modify/reject pending supervise "
|
||||||
|
"proposals (PRD 0013)\n\n"
|
||||||
|
)
|
||||||
sys.stderr.write(f"Run '{PROG} <command> --help' for command-specific usage.\n")
|
sys.stderr.write(f"Run '{PROG} <command> --help' for command-specific usage.\n")
|
||||||
|
|
||||||
|
|
||||||
@@ -63,6 +73,11 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
die(f"unknown command: {command}")
|
die(f"unknown command: {command}")
|
||||||
try:
|
try:
|
||||||
return handler(rest) or 0
|
return handler(rest) or 0
|
||||||
|
except ManifestError as e:
|
||||||
|
# Manifest/config problems surface as a catchable exception;
|
||||||
|
# print the reason and exit non-zero (same UX die() used to give).
|
||||||
|
error(str(e))
|
||||||
|
return 1
|
||||||
except Die as e:
|
except Die as e:
|
||||||
return e.code if isinstance(e.code, int) else 1
|
return e.code if isinstance(e.code, int) else 1
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
@@ -14,7 +14,7 @@ REPO_DIR = str(Path(__file__).resolve().parent.parent.parent)
|
|||||||
def read_tty_line() -> str:
|
def read_tty_line() -> str:
|
||||||
"""Mirror `IFS= read -r REPLY </dev/tty`. Falls back to stdin."""
|
"""Mirror `IFS= read -r REPLY </dev/tty`. Falls back to stdin."""
|
||||||
try:
|
try:
|
||||||
with open("/dev/tty", "r") as tty:
|
with open("/dev/tty", "r", encoding="utf-8") as tty:
|
||||||
return tty.readline().rstrip("\n")
|
return tty.readline().rstrip("\n")
|
||||||
except OSError:
|
except OSError:
|
||||||
return sys.stdin.readline().rstrip("\n")
|
return sys.stdin.readline().rstrip("\n")
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
"""cleanup: stop and remove all orphaned bot-bottle resources.
|
||||||
|
|
||||||
|
Walks every registered backend (docker + smolmachines) so a single
|
||||||
|
`./cli.py cleanup` reaps both backends' leftovers — orphaned
|
||||||
|
smolvm machines won't survive a docker-only cleanup pass (issue
|
||||||
|
addressed alongside #77).
|
||||||
|
|
||||||
|
Each backend's `prepare_cleanup` enumerates its own resources;
|
||||||
|
docker's `_list_orphan_state_dirs` consults
|
||||||
|
`enumerate_active_agents()` for the union of live identities so
|
||||||
|
state dirs of running smolmachines bottles aren't reaped. State
|
||||||
|
dirs are shared layout, so docker is the single owner of that
|
||||||
|
bucket.
|
||||||
|
|
||||||
|
State dirs with `.preserve` are intentionally never touched — they
|
||||||
|
hold capability-block rebuilds or crash snapshots the operator may
|
||||||
|
want to `resume`. Manual `rm -rf ~/.bot-bottle/state/<identity>`
|
||||||
|
is the path for those.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from ..backend import get_bottle_backend, known_backend_names
|
||||||
|
from ..log import info
|
||||||
|
from ._common import read_tty_line
|
||||||
|
|
||||||
|
|
||||||
|
def cmd_cleanup(_argv: list[str]) -> int:
|
||||||
|
# Order: stable backend iteration so the y/N output is
|
||||||
|
# deterministic across runs.
|
||||||
|
plans = [
|
||||||
|
(name, get_bottle_backend(name)) for name in known_backend_names()
|
||||||
|
]
|
||||||
|
prepared = [(name, b, b.prepare_cleanup()) for name, b in plans]
|
||||||
|
|
||||||
|
if all(p.empty for _, _, p in prepared):
|
||||||
|
info("no bot-bottle resources to clean up")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
for name, _, plan in prepared:
|
||||||
|
if plan.empty:
|
||||||
|
continue
|
||||||
|
info(f"--- {name} backend ---")
|
||||||
|
plan.print()
|
||||||
|
|
||||||
|
if not _prompt_yes("remove all of the above?"):
|
||||||
|
info("cleanup: skipped")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
for name, backend, plan in prepared:
|
||||||
|
if plan.empty:
|
||||||
|
continue
|
||||||
|
backend.cleanup(plan)
|
||||||
|
info("cleanup: done")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _prompt_yes(message: str) -> bool:
|
||||||
|
sys.stderr.write(f"bot-bottle: {message} [y/N] ")
|
||||||
|
sys.stderr.flush()
|
||||||
|
reply = read_tty_line()
|
||||||
|
return reply in ("y", "Y", "yes", "YES")
|
||||||
@@ -18,9 +18,9 @@ def cmd_edit(argv: list[str]) -> int:
|
|||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
if args.scope == "user":
|
if args.scope == "user":
|
||||||
target_file = Path(os.environ["HOME"]) / "claude-bottle.json"
|
target_file = Path(os.environ["HOME"]) / "bot-bottle.json"
|
||||||
else:
|
else:
|
||||||
target_file = Path(USER_CWD) / "claude-bottle.json"
|
target_file = Path(USER_CWD) / "bot-bottle.json"
|
||||||
|
|
||||||
if not target_file.is_file():
|
if not target_file.is_file():
|
||||||
die(f"{target_file} does not exist")
|
die(f"{target_file} does not exist")
|
||||||
@@ -11,7 +11,7 @@ from ._common import PROG, USER_CWD
|
|||||||
|
|
||||||
def cmd_info(argv: list[str]) -> int:
|
def cmd_info(argv: list[str]) -> int:
|
||||||
parser = argparse.ArgumentParser(prog=f"{PROG} info", add_help=True)
|
parser = argparse.ArgumentParser(prog=f"{PROG} info", add_help=True)
|
||||||
parser.add_argument("name", help="agent name defined in claude-bottle.json")
|
parser.add_argument("name", help="agent name defined in bot-bottle.json")
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
manifest = Manifest.resolve(USER_CWD)
|
manifest = Manifest.resolve(USER_CWD)
|
||||||
@@ -31,6 +31,9 @@ def cmd_info(argv: list[str]) -> int:
|
|||||||
f"first line: {prompt_first_line or '(empty)'}"
|
f"first line: {prompt_first_line or '(empty)'}"
|
||||||
)
|
)
|
||||||
info(f"bottle : {agent.bottle}")
|
info(f"bottle : {agent.bottle}")
|
||||||
|
identity = manifest.git_identity_summary(args.name)
|
||||||
|
if identity:
|
||||||
|
info(f" git identity : {identity}")
|
||||||
if bottle.git:
|
if bottle.git:
|
||||||
for e in bottle.git:
|
for e in bottle.git:
|
||||||
info(
|
info(
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
"""init: interactively create a new agent and add it to claude-bottle.json."""
|
"""init: interactively create a new agent and add it to bot-bottle.json."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
@@ -20,12 +20,12 @@ def cmd_init(argv: list[str]) -> int:
|
|||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
if args.scope == "user":
|
if args.scope == "user":
|
||||||
target_file = Path(os.environ["HOME"]) / "claude-bottle.json"
|
target_file = Path(os.environ["HOME"]) / "bot-bottle.json"
|
||||||
else:
|
else:
|
||||||
target_file = Path(USER_CWD) / "claude-bottle.json"
|
target_file = Path(USER_CWD) / "bot-bottle.json"
|
||||||
|
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
info(f"claude-bottle init — adding a new agent to {target_file}")
|
info(f"bot-bottle init — adding a new agent to {target_file}")
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
|
|
||||||
# Agent name
|
# Agent name
|
||||||
@@ -51,7 +51,8 @@ def cmd_init(argv: list[str]) -> int:
|
|||||||
die(f"{target_file} exists but is not valid JSON; fix or remove it first")
|
die(f"{target_file} exists but is not valid JSON; fix or remove it first")
|
||||||
if agent_name in (existing.get("agents") or {}):
|
if agent_name in (existing.get("agents") or {}):
|
||||||
sys.stderr.write(
|
sys.stderr.write(
|
||||||
f'claude-bottle: agent "{agent_name}" already exists in {target_file}. Overwrite? [y/N] '
|
f'bot-bottle: agent "{agent_name}" already exists in '
|
||||||
|
f'{target_file}. Overwrite? [y/N] '
|
||||||
)
|
)
|
||||||
sys.stderr.flush()
|
sys.stderr.flush()
|
||||||
ow = read_tty_line()
|
ow = read_tty_line()
|
||||||
@@ -71,7 +72,10 @@ def cmd_init(argv: list[str]) -> int:
|
|||||||
|
|
||||||
# Prompt
|
# Prompt
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
info("System prompt — enter text, then a lone '.' on its own line to finish (just '.' to leave empty):")
|
info(
|
||||||
|
"System prompt — enter text, then a lone '.' on its own line to "
|
||||||
|
"finish (just '.' to leave empty):"
|
||||||
|
)
|
||||||
prompt_lines: list[str] = []
|
prompt_lines: list[str] = []
|
||||||
while True:
|
while True:
|
||||||
line = read_tty_line()
|
line = read_tty_line()
|
||||||
@@ -99,7 +103,10 @@ def cmd_init(argv: list[str]) -> int:
|
|||||||
|
|
||||||
if bottle_name in (existing.get("bottles") or {}):
|
if bottle_name in (existing.get("bottles") or {}):
|
||||||
bottle_exists_already = True
|
bottle_exists_already = True
|
||||||
info(f"Bottle '{bottle_name}' already exists in {target_file}; agent will reference it.")
|
info(
|
||||||
|
f"Bottle '{bottle_name}' already exists in {target_file}; "
|
||||||
|
f"agent will reference it."
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
info(f"Creating new bottle '{bottle_name}'.")
|
info(f"Creating new bottle '{bottle_name}'.")
|
||||||
bottle_env = _prompt_for_env_vars()
|
bottle_env = _prompt_for_env_vars()
|
||||||
@@ -131,8 +138,14 @@ def cmd_init(argv: list[str]) -> int:
|
|||||||
|
|
||||||
def _prompt_for_env_vars() -> dict[str, str]:
|
def _prompt_for_env_vars() -> dict[str, str]:
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
info("Env vars — enter each var name then its mode. Press Enter with no name to finish.")
|
info(
|
||||||
info(" Modes: secret (prompt at runtime) | interpolated (read from host env) | literal (hardcoded value)")
|
"Env vars — enter each var name then its mode. Press Enter with "
|
||||||
|
"no name to finish."
|
||||||
|
)
|
||||||
|
info(
|
||||||
|
" Modes: secret (prompt at runtime) | interpolated (read from "
|
||||||
|
"host env) | literal (hardcoded value)"
|
||||||
|
)
|
||||||
out: dict[str, str] = {}
|
out: dict[str, str] = {}
|
||||||
while True:
|
while True:
|
||||||
print(file=sys.stderr)
|
print(file=sys.stderr)
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
"""list: list available agents or active bottles."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from ..backend import enumerate_active_agents
|
||||||
|
from ..manifest import Manifest
|
||||||
|
from ._common import PROG, USER_CWD
|
||||||
|
|
||||||
|
_ANSI_COLOR_CODES: dict[str, str] = {
|
||||||
|
"black": "\033[30m",
|
||||||
|
"red": "\033[31m",
|
||||||
|
"green": "\033[32m",
|
||||||
|
"yellow": "\033[33m",
|
||||||
|
"blue": "\033[34m",
|
||||||
|
"magenta": "\033[35m",
|
||||||
|
"cyan": "\033[36m",
|
||||||
|
"white": "\033[37m",
|
||||||
|
"bright-black": "\033[90m",
|
||||||
|
"bright-red": "\033[91m",
|
||||||
|
"bright-green": "\033[92m",
|
||||||
|
"bright-yellow": "\033[93m",
|
||||||
|
"bright-blue": "\033[94m",
|
||||||
|
"bright-magenta": "\033[95m",
|
||||||
|
"bright-cyan": "\033[96m",
|
||||||
|
"bright-white": "\033[97m",
|
||||||
|
}
|
||||||
|
_ANSI_RESET = "\033[0m"
|
||||||
|
|
||||||
|
|
||||||
|
def _ansi_label(text: str, color: str) -> str:
|
||||||
|
if not color:
|
||||||
|
return text
|
||||||
|
if not sys.stdout.isatty():
|
||||||
|
return text
|
||||||
|
term = os.environ.get("TERM", "")
|
||||||
|
if term in ("dumb", ""):
|
||||||
|
return text
|
||||||
|
code = _ANSI_COLOR_CODES.get(color)
|
||||||
|
if not code:
|
||||||
|
return text
|
||||||
|
return f"{code}{text}{_ANSI_RESET}"
|
||||||
|
|
||||||
|
|
||||||
|
def cmd_list(argv: list[str]) -> int:
|
||||||
|
parser = argparse.ArgumentParser(prog=f"{PROG} list", add_help=True)
|
||||||
|
parser.add_argument("scope", choices=["available", "active"])
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
if args.scope == "available":
|
||||||
|
manifest = Manifest.resolve(USER_CWD)
|
||||||
|
for name in manifest.agents.keys():
|
||||||
|
print(name)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
# `active` enumerates every backend (docker + smolmachines)
|
||||||
|
# so smolmachines bottles aren't hidden behind the env var.
|
||||||
|
active = enumerate_active_agents()
|
||||||
|
if not active:
|
||||||
|
print("no active bot-bottle bottles", file=sys.stderr)
|
||||||
|
return 0
|
||||||
|
# One line per bottle: `<backend>\t<slug>\t<label>\t<services>`.
|
||||||
|
# Tab-separated keeps the format stable for shell pipelines.
|
||||||
|
for b in active:
|
||||||
|
services = ",".join(b.services) if b.services else "-"
|
||||||
|
display_name = b.label if b.label else b.agent_name
|
||||||
|
colored_name = _ansi_label(display_name, b.color)
|
||||||
|
print(f"{b.backend_name}\t{b.slug}\t{colored_name}\t{services}")
|
||||||
|
return 0
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
"""resume: re-launch a bottle by its identity.
|
"""resume: re-launch a bottle by its identity.
|
||||||
|
|
||||||
Reads ~/.claude-bottle/state/<identity>/metadata.json to recover the
|
Reads ~/.bot-bottle/state/<identity>/metadata.json to recover the
|
||||||
(agent_name, cwd, copy_cwd) the bottle was originally started with,
|
(agent_name, cwd, copy_cwd) the bottle was originally started with,
|
||||||
then runs the same launch core as `start` — but pinned to the
|
then runs the same launch core as `start` — but pinned to the
|
||||||
recorded identity so the new bottle picks up any per-bottle Dockerfile
|
recorded identity so the new bottle picks up any per-bottle Dockerfile
|
||||||
@@ -18,7 +18,7 @@ from __future__ import annotations
|
|||||||
import argparse
|
import argparse
|
||||||
|
|
||||||
from ..backend import BottleSpec
|
from ..backend import BottleSpec
|
||||||
from ..backend.docker.bottle_state import read_metadata
|
from ..bottle_state import read_metadata
|
||||||
from ..log import die
|
from ..log import die
|
||||||
from ..manifest import Manifest
|
from ..manifest import Manifest
|
||||||
from ._common import PROG, USER_CWD
|
from ._common import PROG, USER_CWD
|
||||||
@@ -39,7 +39,7 @@ def cmd_resume(argv: list[str]) -> int:
|
|||||||
if metadata is None:
|
if metadata is None:
|
||||||
die(
|
die(
|
||||||
f"no state recorded for identity {args.identity!r}; "
|
f"no state recorded for identity {args.identity!r}; "
|
||||||
f"check ~/.claude-bottle/state/ or run `cli.py start` to create a new bottle"
|
f"check ~/.bot-bottle/state/ or run `cli.py start` to create a new bottle"
|
||||||
)
|
)
|
||||||
|
|
||||||
manifest = Manifest.resolve(USER_CWD)
|
manifest = Manifest.resolve(USER_CWD)
|
||||||
@@ -52,8 +52,10 @@ def cmd_resume(argv: list[str]) -> int:
|
|||||||
user_cwd=metadata.cwd or USER_CWD,
|
user_cwd=metadata.cwd or USER_CWD,
|
||||||
identity=metadata.identity,
|
identity=metadata.identity,
|
||||||
)
|
)
|
||||||
|
backend_name = metadata.backend or None
|
||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
dry_run=args.dry_run,
|
dry_run=args.dry_run,
|
||||||
remote_control=args.remote_control,
|
remote_control=args.remote_control,
|
||||||
|
backend_name=backend_name,
|
||||||
)
|
)
|
||||||
@@ -2,10 +2,8 @@
|
|||||||
interactive claude-code session. The container is torn down when the
|
interactive claude-code session. The container is torn down when the
|
||||||
session ends.
|
session ends.
|
||||||
|
|
||||||
The launch core is shared with `cli.py resume <identity>` and (PRD
|
The launch core is shared with `cli.py resume <identity>` through
|
||||||
0020 chunk 1+) the dashboard's in-process start flow: see the
|
the private orchestrator `_launch_bottle`.
|
||||||
public helpers `prepare_with_preflight`, `attach_claude`, and the
|
|
||||||
private orchestrator `_launch_bottle`.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -18,6 +16,7 @@ import tempfile
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Callable
|
from typing import Callable
|
||||||
|
|
||||||
|
from ..agent_provider import runtime_for
|
||||||
from ..backend import (
|
from ..backend import (
|
||||||
Bottle,
|
Bottle,
|
||||||
BottleSpec,
|
BottleSpec,
|
||||||
@@ -25,52 +24,74 @@ from ..backend import (
|
|||||||
known_backend_names,
|
known_backend_names,
|
||||||
)
|
)
|
||||||
from ..backend.docker.bottle_plan import DockerBottlePlan
|
from ..backend.docker.bottle_plan import DockerBottlePlan
|
||||||
from ..backend.docker.bottle_state import (
|
from ..bottle_state import (
|
||||||
cleanup_state,
|
cleanup_state,
|
||||||
is_preserved,
|
is_preserved,
|
||||||
mark_preserved,
|
mark_preserved,
|
||||||
)
|
)
|
||||||
from ..backend.docker.capability_apply import snapshot_transcript
|
# from ..backend.docker.capability_apply import snapshot_transcript
|
||||||
from ..log import info
|
from ..log import info
|
||||||
from ..manifest import Manifest
|
from ..manifest import Manifest
|
||||||
from ._common import PROG, USER_CWD, read_tty_line
|
from ._common import PROG, USER_CWD, read_tty_line
|
||||||
|
from . import tui
|
||||||
|
|
||||||
|
|
||||||
def cmd_start(argv: list[str]) -> int:
|
def cmd_start(argv: list[str]) -> int:
|
||||||
parser = argparse.ArgumentParser(prog=f"{PROG} start", add_help=True)
|
parser = argparse.ArgumentParser(prog=f"{PROG} start", add_help=True)
|
||||||
parser.add_argument("--dry-run", action="store_true")
|
parser.add_argument("--dry-run", action="store_true")
|
||||||
parser.add_argument("--cwd", action="store_true", help="copy host cwd into a derived image")
|
parser.add_argument("--cwd", action="store_true", help="copy host cwd into the running bottle")
|
||||||
parser.add_argument("--remote-control", action="store_true")
|
parser.add_argument("--remote-control", action="store_true")
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--backend",
|
"--backend",
|
||||||
choices=known_backend_names(),
|
choices=known_backend_names(),
|
||||||
default=None,
|
default=None,
|
||||||
help=(
|
help=(
|
||||||
"backend to launch the bottle on (default: $CLAUDE_BOTTLE_BACKEND "
|
"backend to launch the bottle on (default: $BOT_BOTTLE_BACKEND "
|
||||||
"or 'docker'). Overrides the env var when set."
|
"or host auto-selection). Overrides the env var when set."
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
parser.add_argument("name", help="agent name defined in claude-bottle.json")
|
parser.add_argument(
|
||||||
|
"name",
|
||||||
|
nargs="?",
|
||||||
|
default=None,
|
||||||
|
help="agent name defined in bot-bottle.json (omit to pick interactively)",
|
||||||
|
)
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
dry_run = args.dry_run or os.environ.get("CLAUDE_BOTTLE_DRY_RUN") == "1"
|
dry_run = args.dry_run or os.environ.get("BOT_BOTTLE_DRY_RUN") == "1"
|
||||||
|
|
||||||
manifest = Manifest.resolve(USER_CWD)
|
manifest = Manifest.resolve(USER_CWD)
|
||||||
|
|
||||||
|
agent_name: str | None = args.name
|
||||||
|
if agent_name is None:
|
||||||
|
agent_name = tui.filter_select(
|
||||||
|
sorted(manifest.agents.keys()),
|
||||||
|
title="Select agent",
|
||||||
|
)
|
||||||
|
if agent_name is None:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
backend_name: str | None = args.backend
|
||||||
|
|
||||||
|
label, color = tui.name_color_modal(default_label=agent_name)
|
||||||
|
|
||||||
spec = BottleSpec(
|
spec = BottleSpec(
|
||||||
manifest=manifest,
|
manifest=manifest,
|
||||||
agent_name=args.name,
|
agent_name=agent_name,
|
||||||
copy_cwd=args.cwd,
|
copy_cwd=args.cwd,
|
||||||
user_cwd=USER_CWD,
|
user_cwd=USER_CWD,
|
||||||
|
label=label,
|
||||||
|
color=color,
|
||||||
)
|
)
|
||||||
return _launch_bottle(
|
return _launch_bottle(
|
||||||
spec,
|
spec,
|
||||||
dry_run=dry_run,
|
dry_run=dry_run,
|
||||||
remote_control=args.remote_control,
|
remote_control=args.remote_control,
|
||||||
backend_name=args.backend,
|
backend_name=backend_name,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
# --- Public helpers shared with the dashboard (PRD 0020) -----------------
|
# --- Launch helpers ------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
def prepare_with_preflight(
|
def prepare_with_preflight(
|
||||||
@@ -83,14 +104,11 @@ def prepare_with_preflight(
|
|||||||
backend_name: str | None = None,
|
backend_name: str | None = None,
|
||||||
) -> tuple[DockerBottlePlan | None, str]:
|
) -> tuple[DockerBottlePlan | None, str]:
|
||||||
"""Run `backend.prepare`, render the preflight summary via the
|
"""Run `backend.prepare`, render the preflight summary via the
|
||||||
injected callable, prompt y/N via the injected callable. The CLI
|
injected callable, prompt y/N via the injected callable.
|
||||||
binds these to stderr/stdin; the dashboard binds them to a
|
|
||||||
curses modal.
|
|
||||||
|
|
||||||
`backend_name` selects which backend prepares the plan
|
`backend_name` selects which backend prepares the plan
|
||||||
(`None` → `$CLAUDE_BOTTLE_BACKEND` → `docker`). Dashboard
|
(`None` → `$BOT_BOTTLE_BACKEND` → host auto-selection). The CLI
|
||||||
passes the value from its new-agent backend-picker modal; the
|
passes whatever `--backend` resolved to.
|
||||||
CLI passes whatever `--backend` resolved to.
|
|
||||||
|
|
||||||
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`
|
||||||
@@ -112,54 +130,51 @@ def prepare_with_preflight(
|
|||||||
return plan, identity
|
return plan, identity
|
||||||
|
|
||||||
|
|
||||||
def attach_claude(
|
def attach_agent(
|
||||||
bottle: Bottle, *, remote_control: bool = False, resume: bool = False,
|
bottle: Bottle, *, remote_control: bool = False, resume: bool = False,
|
||||||
|
agent_provider_template: str = "claude",
|
||||||
|
startup_args: tuple[str, ...] = (),
|
||||||
) -> int:
|
) -> int:
|
||||||
"""Run claude inside `bottle` as an interactive session. Blocks
|
"""Run the selected provider CLI inside `bottle` as an
|
||||||
until the session ends; returns the claude process's exit code.
|
interactive session. Blocks until the session ends; returns the
|
||||||
|
agent process's exit code.
|
||||||
|
|
||||||
`resume=True` adds `--continue` so claude picks up its most
|
`resume=True` adds `--continue` so claude picks up its most
|
||||||
recent session non-interactively (no session-picker prompt) —
|
recent session non-interactively (no session-picker prompt).
|
||||||
the right shape for the dashboard's Enter re-attach (PRD 0020
|
First-attach paths (`./cli.py start`) leave it False.
|
||||||
chunk 3), where a bottle typically has exactly one session.
|
|
||||||
First-attach paths (`./cli.py start`, the dashboard's new-agent
|
|
||||||
flow) leave it False.
|
|
||||||
|
|
||||||
Used as the inner step of `./cli.py start` (one-shot) and by the
|
Used as the inner step of `./cli.py start`."""
|
||||||
dashboard, which calls it from inside a `curses.endwin → … →
|
runtime = runtime_for(agent_provider_template)
|
||||||
stdscr.refresh()` handoff so the curses surface gets out of the
|
|
||||||
terminal's way while claude has it."""
|
|
||||||
info(
|
info(
|
||||||
"attaching interactive claude session "
|
f"attaching interactive {agent_provider_template} session "
|
||||||
"(Ctrl-D or 'exit' to leave; container will be removed)"
|
"(Ctrl-D or 'exit' to leave; container will be removed)"
|
||||||
)
|
)
|
||||||
claude_args = ["--dangerously-skip-permissions"]
|
agent_args = list(runtime.bypass_args)
|
||||||
if remote_control:
|
if remote_control:
|
||||||
claude_args.append("--remote-control")
|
agent_args.extend(runtime.remote_control_args)
|
||||||
|
agent_args.extend(startup_args)
|
||||||
if resume:
|
if resume:
|
||||||
# `--continue` jumps straight to the most recent session
|
agent_args.extend(runtime.resume_args)
|
||||||
# without showing the picker `--resume` would surface.
|
return bottle.exec_agent(agent_args, tty=True)
|
||||||
claude_args.append("--continue")
|
|
||||||
return bottle.exec_claude(claude_args, tty=True)
|
|
||||||
|
|
||||||
|
|
||||||
def capture_session_state(identity: str, exit_code: int) -> None:
|
def capture_claude_session_state(identity: str, exit_code: int) -> None:
|
||||||
"""Inside the launch context, while the container is still
|
"""Inside the launch context, while the container is still
|
||||||
alive: snapshot the transcript and mark for preservation if
|
alive: snapshot the transcript and mark for preservation if
|
||||||
claude crashed. Public for the dashboard's death-handling path
|
claude crashed."""
|
||||||
(PRD 0020 open question 3)."""
|
# FIXME: this captures Claude-specific session state. A follow-up
|
||||||
|
# spike should explore freezing provider-neutral container state
|
||||||
|
# instead of relying on each agent's transcript layout.
|
||||||
if not identity:
|
if not identity:
|
||||||
return
|
return
|
||||||
snapshot_transcript(identity)
|
# snapshot_transcript(identity)
|
||||||
if exit_code != 0:
|
if exit_code != 0:
|
||||||
mark_preserved(identity)
|
mark_preserved(identity)
|
||||||
|
|
||||||
|
|
||||||
def settle_state(identity: str) -> None:
|
def settle_state(identity: str) -> None:
|
||||||
"""Post-teardown housekeeping: print the resume hint if the
|
"""Post-teardown housekeeping: print the resume hint if the
|
||||||
state was preserved, otherwise reap the per-bottle state dir.
|
state was preserved, otherwise reap the per-bottle state dir."""
|
||||||
Public so the dashboard's explicit-stop path calls the same
|
|
||||||
settlement the CLI uses on context exit."""
|
|
||||||
if not identity:
|
if not identity:
|
||||||
return
|
return
|
||||||
if is_preserved(identity):
|
if is_preserved(identity):
|
||||||
@@ -179,7 +194,7 @@ def _identity_from_plan(plan: object) -> str:
|
|||||||
def _text_prompt_yes() -> bool:
|
def _text_prompt_yes() -> bool:
|
||||||
"""Default `prompt_yes` for CLI use: reads y/N from the
|
"""Default `prompt_yes` for CLI use: reads y/N from the
|
||||||
controlling tty via stderr prompt + tty-line read."""
|
controlling tty via stderr prompt + tty-line read."""
|
||||||
sys.stderr.write("claude-bottle: launch this agent? [y/N] ")
|
sys.stderr.write("bot-bottle: launch this agent? [y/N] ")
|
||||||
sys.stderr.flush()
|
sys.stderr.flush()
|
||||||
reply = read_tty_line()
|
reply = read_tty_line()
|
||||||
return reply in ("y", "Y", "yes", "YES")
|
return reply in ("y", "Y", "yes", "YES")
|
||||||
@@ -201,7 +216,7 @@ def _launch_bottle(
|
|||||||
"""Shared launch core for `start` and `resume`. Builds the plan,
|
"""Shared launch core for `start` and `resume`. Builds the plan,
|
||||||
prints / dry-runs / prompts as appropriate, brings the bottle up,
|
prints / dry-runs / prompts as appropriate, brings the bottle up,
|
||||||
attaches claude, and prints the resume hint on session end."""
|
attaches claude, and prints the resume hint on session end."""
|
||||||
stage_dir = Path(tempfile.mkdtemp(prefix="claude-bottle-stage."))
|
stage_dir = Path(tempfile.mkdtemp(prefix="bot-bottle-stage."))
|
||||||
identity = ""
|
identity = ""
|
||||||
try:
|
try:
|
||||||
plan, identity = prepare_with_preflight(
|
plan, identity = prepare_with_preflight(
|
||||||
@@ -217,7 +232,13 @@ def _launch_bottle(
|
|||||||
|
|
||||||
backend = get_bottle_backend(backend_name)
|
backend = get_bottle_backend(backend_name)
|
||||||
with backend.launch(plan) as bottle:
|
with backend.launch(plan) as bottle:
|
||||||
exit_code = attach_claude(bottle, remote_control=remote_control)
|
agent_provider_template = getattr(plan, "agent_provider_template", "claude")
|
||||||
|
exit_code = attach_agent(
|
||||||
|
bottle,
|
||||||
|
remote_control=remote_control,
|
||||||
|
agent_provider_template=agent_provider_template,
|
||||||
|
startup_args=plan.agent_provision.startup_args,
|
||||||
|
)
|
||||||
info(
|
info(
|
||||||
f"session ended (exit {exit_code}); "
|
f"session ended (exit {exit_code}); "
|
||||||
f"container {bottle.name} will be removed"
|
f"container {bottle.name} will be removed"
|
||||||
@@ -230,7 +251,8 @@ def _launch_bottle(
|
|||||||
# way. snapshot_transcript is best-effort so the
|
# way. snapshot_transcript is best-effort so the
|
||||||
# capability-block path's prior snapshot isn't clobbered
|
# capability-block path's prior snapshot isn't clobbered
|
||||||
# when the container is already gone.
|
# when the container is already gone.
|
||||||
capture_session_state(identity, exit_code)
|
if agent_provider_template == "claude":
|
||||||
|
capture_claude_session_state(identity, exit_code)
|
||||||
return 0
|
return 0
|
||||||
finally:
|
finally:
|
||||||
# PRD 0018 chunk 2: prepare now writes the bottle's bind-mount
|
# PRD 0018 chunk 2: prepare now writes the bottle's bind-mount
|
||||||
@@ -0,0 +1,519 @@
|
|||||||
|
"""supervise: list pending supervise proposals across all bottles and
|
||||||
|
act on them (approve / modify / reject).
|
||||||
|
|
||||||
|
Curses-based TUI; modify-then-approve shells out to $EDITOR. The
|
||||||
|
approval handler wires to PRD 0016 (capability-block), which rebuilds
|
||||||
|
the bottle Dockerfile. The egress-block tool was removed in issue #198.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import curses
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import traceback
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from .. import supervise as _supervise
|
||||||
|
# from ..bottle_state import read_metadata
|
||||||
|
# from ..backend.docker.capability_apply import (
|
||||||
|
# CapabilityApplyError,
|
||||||
|
# apply_capability_change,
|
||||||
|
# )
|
||||||
|
from ..log import Die, error, info
|
||||||
|
|
||||||
|
|
||||||
|
class CapabilityApplyError(RuntimeError):
|
||||||
|
"""Placeholder while capability_apply is disabled."""
|
||||||
|
|
||||||
|
from ..supervise import (
|
||||||
|
COMPONENT_FOR_TOOL,
|
||||||
|
AuditEntry,
|
||||||
|
Proposal,
|
||||||
|
Response,
|
||||||
|
STATUS_APPROVED,
|
||||||
|
STATUS_MODIFIED,
|
||||||
|
STATUS_REJECTED,
|
||||||
|
TOOL_CAPABILITY_BLOCK,
|
||||||
|
archive_proposal,
|
||||||
|
list_pending_proposals,
|
||||||
|
render_diff,
|
||||||
|
write_audit_entry,
|
||||||
|
write_response,
|
||||||
|
)
|
||||||
|
from ._common import PROG
|
||||||
|
|
||||||
|
|
||||||
|
_REFRESH_INTERVAL_MS = 1000
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class QueuedProposal:
|
||||||
|
"""A pending proposal plus the queue dir it was found in."""
|
||||||
|
|
||||||
|
proposal: Proposal
|
||||||
|
queue_dir: Path
|
||||||
|
|
||||||
|
|
||||||
|
# Errors any remediation engine may raise. Caught by the TUI key
|
||||||
|
# handlers and surfaced in the status line so a failed apply keeps
|
||||||
|
# the proposal pending rather than crashing curses.
|
||||||
|
ApplyError = (CapabilityApplyError,)
|
||||||
|
|
||||||
|
|
||||||
|
def discover_pending() -> list[QueuedProposal]:
|
||||||
|
"""Walk ~/.bot-bottle/queue/* and collect pending proposals."""
|
||||||
|
queue_root = _supervise.bot_bottle_root() / "queue"
|
||||||
|
if not queue_root.is_dir():
|
||||||
|
return []
|
||||||
|
out: list[QueuedProposal] = []
|
||||||
|
for slug_dir in sorted(queue_root.iterdir()):
|
||||||
|
if not slug_dir.is_dir():
|
||||||
|
continue
|
||||||
|
for proposal in list_pending_proposals(slug_dir):
|
||||||
|
out.append(QueuedProposal(proposal=proposal, queue_dir=slug_dir))
|
||||||
|
out.sort(key=lambda q: q.proposal.arrival_timestamp)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _approval_status(qp: QueuedProposal, verb: str) -> str:
|
||||||
|
"""Status-line text after a successful approval."""
|
||||||
|
base = f"{verb} {qp.proposal.tool} for [{qp.proposal.bottle_slug}]"
|
||||||
|
return f"{base}; resume: ./cli.py resume {qp.proposal.bottle_slug}"
|
||||||
|
|
||||||
|
|
||||||
|
def _detail_lines(
|
||||||
|
qp: QueuedProposal,
|
||||||
|
*,
|
||||||
|
green_attr: int = 0,
|
||||||
|
) -> list[tuple[str, int]]:
|
||||||
|
"""Return the detail-view body as (text, curses-attr) tuples."""
|
||||||
|
p = qp.proposal
|
||||||
|
out: list[tuple[str, int]] = [
|
||||||
|
(f"bottle: {p.bottle_slug}", 0),
|
||||||
|
(f"tool: {p.tool}", 0),
|
||||||
|
(f"id: {p.id}", 0),
|
||||||
|
(f"arrived: {p.arrival_timestamp}", 0),
|
||||||
|
(f"queue: {qp.queue_dir}", 0),
|
||||||
|
("", 0),
|
||||||
|
("justification:", 0),
|
||||||
|
]
|
||||||
|
out.extend((" " + line, 0) for line in p.justification.splitlines() or [""])
|
||||||
|
out.extend([
|
||||||
|
("", 0),
|
||||||
|
("proposed file:", 0),
|
||||||
|
])
|
||||||
|
out.extend((line, 0) for line in p.proposed_file.splitlines() or [""])
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _suffix_for_tool(tool: str) -> str:
|
||||||
|
if tool == TOOL_CAPABILITY_BLOCK:
|
||||||
|
return ".dockerfile"
|
||||||
|
return ".txt"
|
||||||
|
|
||||||
|
|
||||||
|
# --- Operator actions ------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def approve(
|
||||||
|
qp: QueuedProposal,
|
||||||
|
*,
|
||||||
|
notes: str = "",
|
||||||
|
final_file: str | None = None,
|
||||||
|
) -> None:
|
||||||
|
"""Apply the proposal, write the waiting response, and audit it."""
|
||||||
|
status = STATUS_MODIFIED if final_file is not None else STATUS_APPROVED
|
||||||
|
|
||||||
|
diff_before, diff_after = "", ""
|
||||||
|
# if qp.proposal.tool == TOOL_CAPABILITY_BLOCK:
|
||||||
|
# _meta = read_metadata(qp.proposal.bottle_slug)
|
||||||
|
# if _meta is not None and not _meta.compose_project:
|
||||||
|
# raise CapabilityApplyError(
|
||||||
|
# "capability-block remediation is not supported for smolmachines "
|
||||||
|
# "bottles. Reject this proposal or handle the capability change "
|
||||||
|
# "manually, then restart the bottle."
|
||||||
|
# )
|
||||||
|
# diff_before, diff_after = apply_capability_change(
|
||||||
|
# qp.proposal.bottle_slug, file_to_apply,
|
||||||
|
# )
|
||||||
|
|
||||||
|
response = Response(
|
||||||
|
proposal_id=qp.proposal.id,
|
||||||
|
status=status,
|
||||||
|
notes=notes,
|
||||||
|
final_file=final_file,
|
||||||
|
)
|
||||||
|
write_response(qp.queue_dir, response)
|
||||||
|
_write_audit(
|
||||||
|
qp, action=status, notes=notes,
|
||||||
|
diff_before=diff_before, diff_after=diff_after,
|
||||||
|
)
|
||||||
|
if qp.proposal.tool == TOOL_CAPABILITY_BLOCK:
|
||||||
|
archive_proposal(qp.queue_dir, qp.proposal.id)
|
||||||
|
|
||||||
|
|
||||||
|
def reject(qp: QueuedProposal, *, reason: str) -> None:
|
||||||
|
"""Write a rejection response and an audit entry."""
|
||||||
|
response = Response(
|
||||||
|
proposal_id=qp.proposal.id,
|
||||||
|
status=STATUS_REJECTED,
|
||||||
|
notes=reason,
|
||||||
|
final_file=None,
|
||||||
|
)
|
||||||
|
write_response(qp.queue_dir, response)
|
||||||
|
_write_audit(qp, action=STATUS_REJECTED, notes=reason, diff_before="", diff_after="")
|
||||||
|
|
||||||
|
|
||||||
|
def _write_audit(
|
||||||
|
qp: QueuedProposal,
|
||||||
|
*,
|
||||||
|
action: str,
|
||||||
|
notes: str,
|
||||||
|
diff_before: str,
|
||||||
|
diff_after: str,
|
||||||
|
) -> None:
|
||||||
|
"""Audit log for egress tool."""
|
||||||
|
component = COMPONENT_FOR_TOOL.get(qp.proposal.tool)
|
||||||
|
if component is None:
|
||||||
|
return
|
||||||
|
write_audit_entry(AuditEntry(
|
||||||
|
timestamp=datetime.now(timezone.utc).isoformat(),
|
||||||
|
bottle_slug=qp.proposal.bottle_slug,
|
||||||
|
component=component,
|
||||||
|
operator_action=action,
|
||||||
|
operator_notes=notes,
|
||||||
|
justification=qp.proposal.justification,
|
||||||
|
diff=render_diff(diff_before, diff_after, label=component),
|
||||||
|
))
|
||||||
|
|
||||||
|
|
||||||
|
# --- $EDITOR integration --------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def edit_in_editor(content: str, *, suffix: str = ".tmp") -> str | None:
|
||||||
|
"""Open `content` in $EDITOR and return edited content, if changed."""
|
||||||
|
editor = os.environ.get("EDITOR", "vim")
|
||||||
|
with tempfile.NamedTemporaryFile(
|
||||||
|
mode="w", suffix=suffix, delete=False, prefix="supervise-modify.",
|
||||||
|
) as f:
|
||||||
|
f.write(content)
|
||||||
|
path = f.name
|
||||||
|
try:
|
||||||
|
subprocess.run([editor, path], check=False)
|
||||||
|
with open(path, encoding="utf-8") as f:
|
||||||
|
edited = f.read()
|
||||||
|
return edited if edited != content else None
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
os.unlink(path)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
# --- TUI -------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def cmd_supervise(argv: list[str]) -> int:
|
||||||
|
parser = argparse.ArgumentParser(prog=f"{PROG} supervise", add_help=True)
|
||||||
|
parser.add_argument(
|
||||||
|
"--once", action="store_true",
|
||||||
|
help="list pending proposals once and exit (no TUI)",
|
||||||
|
)
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
if args.once:
|
||||||
|
return _list_once()
|
||||||
|
try:
|
||||||
|
curses.wrapper(_main_loop)
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
return 130
|
||||||
|
except Die as e:
|
||||||
|
if e.message:
|
||||||
|
error(e.message)
|
||||||
|
else:
|
||||||
|
error("supervise exited on a fatal error (no detail captured).")
|
||||||
|
return e.code if isinstance(e.code, int) else 1
|
||||||
|
except Exception as e: # noqa: W0718 — catch supervise crash for logging
|
||||||
|
log_path = _write_crash_log(e)
|
||||||
|
error(f"supervise crashed: {type(e).__name__}: {e}")
|
||||||
|
error(f"full traceback written to {log_path}")
|
||||||
|
return 1
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _write_crash_log(exc: BaseException) -> Path:
|
||||||
|
"""Persist `exc`'s traceback to a stable file under ~/.bot-bottle/."""
|
||||||
|
stamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
|
||||||
|
body = "".join(
|
||||||
|
traceback.format_exception(type(exc), exc, exc.__traceback__)
|
||||||
|
)
|
||||||
|
entry = f"=== supervise crash {stamp} ===\n{body}\n"
|
||||||
|
try:
|
||||||
|
log_dir = _supervise.bot_bottle_root() / "logs"
|
||||||
|
log_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
path = log_dir / "supervise-crash.log"
|
||||||
|
with path.open("a", encoding="utf-8") as fh:
|
||||||
|
fh.write(entry)
|
||||||
|
return path
|
||||||
|
except OSError:
|
||||||
|
fd, tmp = tempfile.mkstemp(
|
||||||
|
prefix="bot-bottle-supervise-crash-", suffix=".log",
|
||||||
|
)
|
||||||
|
with os.fdopen(fd, "w", encoding="utf-8") as fh:
|
||||||
|
fh.write(entry)
|
||||||
|
return Path(tmp)
|
||||||
|
|
||||||
|
|
||||||
|
def _list_once() -> int:
|
||||||
|
pending = discover_pending()
|
||||||
|
if not pending:
|
||||||
|
info("no pending proposals")
|
||||||
|
return 0
|
||||||
|
for qp in pending:
|
||||||
|
sys.stdout.write(
|
||||||
|
f"{qp.proposal.arrival_timestamp} "
|
||||||
|
f"[{qp.proposal.bottle_slug}] "
|
||||||
|
f"{qp.proposal.tool} "
|
||||||
|
f"{qp.proposal.id}\n"
|
||||||
|
)
|
||||||
|
sys.stdout.write(f" {qp.proposal.justification}\n")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _try_init_green() -> int:
|
||||||
|
"""Initialise a green color pair and return its attr, or 0."""
|
||||||
|
try:
|
||||||
|
curses.start_color()
|
||||||
|
curses.use_default_colors()
|
||||||
|
curses.init_pair(1, curses.COLOR_GREEN, -1)
|
||||||
|
return curses.color_pair(1)
|
||||||
|
except curses.error:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _main_loop(stdscr: "curses._CursesWindow") -> None: # type: ignore
|
||||||
|
curses.curs_set(0)
|
||||||
|
stdscr.timeout(_REFRESH_INTERVAL_MS)
|
||||||
|
green_attr = _try_init_green()
|
||||||
|
selected = 0
|
||||||
|
status_line = ""
|
||||||
|
seen_ids: set[str] = set()
|
||||||
|
|
||||||
|
while True:
|
||||||
|
pending = discover_pending()
|
||||||
|
if selected >= len(pending):
|
||||||
|
selected = max(0, len(pending) - 1)
|
||||||
|
|
||||||
|
live_ids = {qp.proposal.id for qp in pending}
|
||||||
|
newly_arrived = live_ids - seen_ids
|
||||||
|
if seen_ids and newly_arrived:
|
||||||
|
try:
|
||||||
|
curses.beep()
|
||||||
|
except curses.error:
|
||||||
|
pass
|
||||||
|
for i, qp in enumerate(pending):
|
||||||
|
if qp.proposal.id in newly_arrived:
|
||||||
|
selected = i
|
||||||
|
break
|
||||||
|
seen_ids = live_ids
|
||||||
|
|
||||||
|
_render(
|
||||||
|
stdscr, pending, selected, status_line,
|
||||||
|
green_attr=green_attr,
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
key = stdscr.getch()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
return
|
||||||
|
|
||||||
|
if key == -1:
|
||||||
|
continue
|
||||||
|
|
||||||
|
status_line = ""
|
||||||
|
|
||||||
|
if key in (ord("q"), 27):
|
||||||
|
return
|
||||||
|
|
||||||
|
if not pending:
|
||||||
|
continue
|
||||||
|
qp = pending[selected]
|
||||||
|
|
||||||
|
if key in (curses.KEY_DOWN, ord("j")):
|
||||||
|
selected = min(selected + 1, len(pending) - 1)
|
||||||
|
elif key in (curses.KEY_UP, ord("k")):
|
||||||
|
selected = max(selected - 1, 0)
|
||||||
|
elif key in (curses.KEY_ENTER, 10, 13):
|
||||||
|
_detail_view(stdscr, qp, green_attr=green_attr)
|
||||||
|
elif key == ord("a"):
|
||||||
|
try:
|
||||||
|
approve(qp)
|
||||||
|
status_line = _approval_status(qp, "approved")
|
||||||
|
except ApplyError as e:
|
||||||
|
status_line = f"apply failed: {e}"
|
||||||
|
elif key == ord("m"):
|
||||||
|
edited = _modify(stdscr, qp)
|
||||||
|
if edited is None:
|
||||||
|
status_line = "modify aborted (no change)"
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
approve(qp, final_file=edited, notes="operator modified before approving")
|
||||||
|
status_line = _approval_status(qp, "modified+approved")
|
||||||
|
except ApplyError as e:
|
||||||
|
status_line = f"apply failed: {e}"
|
||||||
|
elif key == ord("r"):
|
||||||
|
reason = _prompt(stdscr, "reject reason: ")
|
||||||
|
if reason:
|
||||||
|
reject(qp, reason=reason)
|
||||||
|
status_line = f"rejected {qp.proposal.tool} for [{qp.proposal.bottle_slug}]"
|
||||||
|
else:
|
||||||
|
status_line = "reject aborted (empty reason)"
|
||||||
|
|
||||||
|
|
||||||
|
def _render(
|
||||||
|
stdscr: "curses._CursesWindow", # type: ignore
|
||||||
|
pending: list[QueuedProposal],
|
||||||
|
selected: int,
|
||||||
|
status_line: str,
|
||||||
|
*,
|
||||||
|
green_attr: int = 0, # noqa: F841 — unused, but required by interface
|
||||||
|
) -> None:
|
||||||
|
stdscr.erase()
|
||||||
|
h, w = stdscr.getmaxyx()
|
||||||
|
header = f"bot-bottle supervise ({len(pending)} pending)"
|
||||||
|
stdscr.addnstr(0, 0, header, w - 1, curses.A_BOLD)
|
||||||
|
stdscr.hline(1, 0, curses.ACS_HLINE, w)
|
||||||
|
|
||||||
|
row = 2
|
||||||
|
if not pending:
|
||||||
|
stdscr.addnstr(
|
||||||
|
row, 2,
|
||||||
|
"no pending proposals; agents will queue here when they call a "
|
||||||
|
"supervise tool",
|
||||||
|
w - 4,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
for i, qp in enumerate(pending):
|
||||||
|
if row >= h - 3:
|
||||||
|
break
|
||||||
|
p = qp.proposal
|
||||||
|
ts_short = (
|
||||||
|
p.arrival_timestamp.split("T", 1)[1][:8]
|
||||||
|
if "T" in p.arrival_timestamp else p.arrival_timestamp
|
||||||
|
)
|
||||||
|
cursor = "> " if i == selected else " "
|
||||||
|
line = (
|
||||||
|
f"{cursor}{ts_short} "
|
||||||
|
f"[{p.bottle_slug}] {p.tool:<18} {p.id[:8]}"
|
||||||
|
)
|
||||||
|
attr = curses.A_REVERSE if i == selected else curses.A_NORMAL
|
||||||
|
stdscr.addnstr(row, 0, line, w - 1, attr)
|
||||||
|
row += 1
|
||||||
|
if row >= h - 3:
|
||||||
|
break
|
||||||
|
if p.justification:
|
||||||
|
stdscr.addnstr(row, 4, p.justification[: max(0, w - 5)], w - 5)
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
footer = "[j/k] move [Enter] view [a] approve [m] modify [r] reject [q] quit"
|
||||||
|
stdscr.hline(h - 2, 0, curses.ACS_HLINE, w)
|
||||||
|
stdscr.addnstr(h - 1, 0, footer, w - 1, curses.A_DIM)
|
||||||
|
if status_line:
|
||||||
|
stdscr.addnstr(h - 3, 0, status_line, w - 1, curses.A_BOLD)
|
||||||
|
stdscr.refresh()
|
||||||
|
|
||||||
|
|
||||||
|
def _detail_view(
|
||||||
|
stdscr: "curses._CursesWindow", # type: ignore
|
||||||
|
qp: QueuedProposal,
|
||||||
|
*,
|
||||||
|
green_attr: int = 0,
|
||||||
|
) -> None:
|
||||||
|
"""Render the full proposal. Scrollable. Press q to return."""
|
||||||
|
lines = _detail_lines(qp, green_attr=green_attr)
|
||||||
|
offset = 0
|
||||||
|
while True:
|
||||||
|
stdscr.erase()
|
||||||
|
h, w = stdscr.getmaxyx()
|
||||||
|
for i, (text, attr) in enumerate(lines[offset:offset + h - 1]):
|
||||||
|
stdscr.addnstr(i, 0, text, w - 1, attr)
|
||||||
|
stdscr.addnstr(
|
||||||
|
h - 1, 0,
|
||||||
|
"[j/k] scroll [g/G] top/bottom [a] approve [m] modify [r] reject [q] back",
|
||||||
|
w - 1, curses.A_DIM,
|
||||||
|
)
|
||||||
|
stdscr.refresh()
|
||||||
|
key = stdscr.getch()
|
||||||
|
if key in (ord("q"), 27):
|
||||||
|
return
|
||||||
|
if key in (curses.KEY_DOWN, ord("j")):
|
||||||
|
offset = min(offset + 1, max(0, len(lines) - 1))
|
||||||
|
elif key in (curses.KEY_UP, ord("k")):
|
||||||
|
offset = max(offset - 1, 0)
|
||||||
|
elif key == ord("g"):
|
||||||
|
offset = 0
|
||||||
|
elif key == ord("G"):
|
||||||
|
offset = max(0, len(lines) - 1)
|
||||||
|
elif key == ord("a"):
|
||||||
|
try:
|
||||||
|
approve(qp)
|
||||||
|
except ApplyError:
|
||||||
|
pass
|
||||||
|
return
|
||||||
|
elif key == ord("m"):
|
||||||
|
edited = _modify(stdscr, qp)
|
||||||
|
if edited is not None:
|
||||||
|
try:
|
||||||
|
approve(qp, final_file=edited, notes="operator modified before approving")
|
||||||
|
except ApplyError:
|
||||||
|
pass
|
||||||
|
return
|
||||||
|
elif key == ord("r"):
|
||||||
|
reason = _prompt(stdscr, "reject reason: ")
|
||||||
|
if reason:
|
||||||
|
reject(qp, reason=reason)
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
|
def _modify(stdscr: "curses._CursesWindow", qp: QueuedProposal) -> str | None: # type: ignore
|
||||||
|
"""Suspend curses, open $EDITOR on the proposed file, return edited content."""
|
||||||
|
suffix = _suffix_for_tool(qp.proposal.tool)
|
||||||
|
curses.endwin()
|
||||||
|
try:
|
||||||
|
edited = edit_in_editor(qp.proposal.proposed_file, suffix=suffix)
|
||||||
|
finally:
|
||||||
|
stdscr.refresh()
|
||||||
|
return edited
|
||||||
|
|
||||||
|
|
||||||
|
def _prompt(stdscr: "curses._CursesWindow", label: str) -> str: # type: ignore
|
||||||
|
"""One-line input at the bottom of the screen."""
|
||||||
|
curses.curs_set(1)
|
||||||
|
h, _ = stdscr.getmaxyx()
|
||||||
|
stdscr.move(h - 2, 0)
|
||||||
|
stdscr.clrtoeol()
|
||||||
|
stdscr.addstr(h - 2, 0, label)
|
||||||
|
stdscr.refresh()
|
||||||
|
curses.echo()
|
||||||
|
try:
|
||||||
|
raw = stdscr.getstr(h - 2, len(label), 200)
|
||||||
|
finally:
|
||||||
|
curses.noecho()
|
||||||
|
curses.curs_set(0)
|
||||||
|
return raw.decode("utf-8", errors="replace").strip()
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"QueuedProposal",
|
||||||
|
"approve",
|
||||||
|
"cmd_supervise",
|
||||||
|
"discover_pending",
|
||||||
|
"edit_in_editor",
|
||||||
|
"reject",
|
||||||
|
]
|
||||||
@@ -0,0 +1,437 @@
|
|||||||
|
"""tui.py — minimal curses filter-select picker for CLI prompts.
|
||||||
|
|
||||||
|
Exposed surface:
|
||||||
|
|
||||||
|
filter_select(items, *, title="", tty_path="/dev/tty") -> str | None
|
||||||
|
name_color_modal(default_label, *, tty_path="/dev/tty") -> (str, str)
|
||||||
|
|
||||||
|
Opens /dev/tty directly so the picker works even when stdout/stdin are
|
||||||
|
redirected. Returns the selected item or None on cancel.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import curses
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from typing import Any, Optional
|
||||||
|
|
||||||
|
|
||||||
|
def filter_select(
|
||||||
|
items: list[str],
|
||||||
|
*,
|
||||||
|
title: str = "",
|
||||||
|
tty_path: str = "/dev/tty",
|
||||||
|
) -> Optional[str]:
|
||||||
|
"""Render a filter-select picker over *items*.
|
||||||
|
|
||||||
|
Returns the selected item string, or ``None`` if the user cancelled
|
||||||
|
(Esc / ``q`` / Ctrl-C / Ctrl-D) or if the terminal is too small.
|
||||||
|
|
||||||
|
The picker opens *tty_path* directly so it works even when
|
||||||
|
stdout/stdin are redirected.
|
||||||
|
"""
|
||||||
|
if not items:
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
tty_fd = open(tty_path, "r+b", buffering=0)
|
||||||
|
except OSError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Use os.dup() to duplicate the fd so the original file object
|
||||||
|
# and FileIO in _run_picker each manage independent copies,
|
||||||
|
# preventing double-close errors.
|
||||||
|
fd_dup = os.dup(tty_fd.fileno())
|
||||||
|
return _run_picker(items, title=title, tty_fd=fd_dup)
|
||||||
|
finally:
|
||||||
|
tty_fd.close()
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Internal implementation
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
_KEY_ESC = 27
|
||||||
|
_KEY_CTRL_C = 3
|
||||||
|
_KEY_CTRL_D = 4
|
||||||
|
_KEY_BACKSPACE_WIN = 8
|
||||||
|
_KEY_ENTER_ALT = 10
|
||||||
|
|
||||||
|
_CANCEL_KEYS = frozenset([_KEY_ESC, _KEY_CTRL_C, _KEY_CTRL_D, ord("q")])
|
||||||
|
|
||||||
|
|
||||||
|
def _run_picker(items: list[str], *, title: str, tty_fd: int) -> Optional[str]:
|
||||||
|
"""Drive a curses session on *tty_fd* and return the picked item."""
|
||||||
|
# newterm lets us run curses on an arbitrary fd rather than the
|
||||||
|
# process's controlling tty / stdout — crucial when stdout is piped.
|
||||||
|
os.environ.setdefault("TERM", "xterm-256color")
|
||||||
|
|
||||||
|
# Save / restore the real stdin/stdout so curses newterm can use tty_fd.
|
||||||
|
orig_stdin = sys.__stdin__
|
||||||
|
orig_stdout = sys.__stdout__
|
||||||
|
|
||||||
|
try:
|
||||||
|
import io
|
||||||
|
tty_text = io.TextIOWrapper(io.FileIO(tty_fd, mode='r+'), write_through=True)
|
||||||
|
sys.__stdin__ = tty_text # type: ignore[assignment]
|
||||||
|
sys.__stdout__ = tty_text # type: ignore[assignment]
|
||||||
|
|
||||||
|
# curses.wrapper calls initscr which honours sys.__stdin__ / __stdout__
|
||||||
|
# on some builds; use newterm where available.
|
||||||
|
screen = curses.initscr()
|
||||||
|
curses.noecho()
|
||||||
|
curses.cbreak()
|
||||||
|
screen.keypad(True)
|
||||||
|
|
||||||
|
try:
|
||||||
|
result = _picker_loop(screen, items, title=title)
|
||||||
|
finally:
|
||||||
|
screen.keypad(False)
|
||||||
|
curses.nocbreak()
|
||||||
|
curses.echo()
|
||||||
|
curses.endwin()
|
||||||
|
except Exception: # noqa: W0718 — curses can raise many error types
|
||||||
|
return None
|
||||||
|
finally:
|
||||||
|
sys.__stdin__ = orig_stdin # type: ignore[assignment]
|
||||||
|
sys.__stdout__ = orig_stdout # type: ignore[assignment]
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _picker_loop(screen: Any, items: list[str], *, title: str) -> Optional[str]:
|
||||||
|
query = ""
|
||||||
|
cursor = 0
|
||||||
|
|
||||||
|
while True:
|
||||||
|
filtered = _filter_items(items, query)
|
||||||
|
|
||||||
|
# Clamp cursor into the visible list.
|
||||||
|
if not filtered:
|
||||||
|
cursor = 0
|
||||||
|
elif cursor >= len(filtered):
|
||||||
|
cursor = len(filtered) - 1
|
||||||
|
|
||||||
|
try:
|
||||||
|
_render(screen, filtered, cursor, query=query, title=title)
|
||||||
|
except curses.error:
|
||||||
|
# Terminal too small or write error — bail out.
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
key = screen.getch()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if key in _CANCEL_KEYS:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if key in (curses.KEY_ENTER, _KEY_ENTER_ALT, ord("\r")):
|
||||||
|
return filtered[cursor] if filtered else None
|
||||||
|
|
||||||
|
if key in (curses.KEY_UP, ord("k")):
|
||||||
|
if cursor > 0:
|
||||||
|
cursor -= 1
|
||||||
|
|
||||||
|
elif key in (curses.KEY_DOWN, ord("j")):
|
||||||
|
if cursor < len(filtered) - 1:
|
||||||
|
cursor += 1
|
||||||
|
|
||||||
|
elif key in (curses.KEY_BACKSPACE, _KEY_BACKSPACE_WIN, 127):
|
||||||
|
query = query[:-1]
|
||||||
|
# After narrowing the filter, keep cursor in range.
|
||||||
|
new_filtered = _filter_items(items, query)
|
||||||
|
if cursor >= len(new_filtered):
|
||||||
|
cursor = max(0, len(new_filtered) - 1)
|
||||||
|
|
||||||
|
elif 32 <= key <= 126:
|
||||||
|
# Printable ASCII — append to query and reset cursor so the
|
||||||
|
# top of the newly-filtered list is selected.
|
||||||
|
query += chr(key)
|
||||||
|
cursor = 0
|
||||||
|
|
||||||
|
|
||||||
|
def _filter_items(items: list[str], query: str) -> list[str]:
|
||||||
|
if not query:
|
||||||
|
return list(items)
|
||||||
|
q = query.lower()
|
||||||
|
return [i for i in items if q in i.lower()]
|
||||||
|
|
||||||
|
|
||||||
|
def _render(screen: Any, filtered: list[str], cursor: int, *, query: str, title: str) -> None:
|
||||||
|
screen.erase()
|
||||||
|
rows, cols = screen.getmaxyx()
|
||||||
|
min_rows = 5
|
||||||
|
|
||||||
|
if rows < min_rows:
|
||||||
|
raise curses.error("terminal too small")
|
||||||
|
|
||||||
|
row = 0
|
||||||
|
|
||||||
|
if title and row < rows - 1:
|
||||||
|
_addstr_safe(screen, row, 0, title[:cols - 1], curses.A_BOLD)
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
filter_label = f"Filter: {query}"
|
||||||
|
if row < rows - 1:
|
||||||
|
_addstr_safe(screen, row, 0, filter_label[:cols - 1])
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
sep = "─" * min(cols - 1, 40)
|
||||||
|
if row < rows - 1:
|
||||||
|
_addstr_safe(screen, row, 0, sep)
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
list_start = row
|
||||||
|
# Reserve two rows for separator + help line at bottom.
|
||||||
|
list_rows = rows - list_start - 2
|
||||||
|
if list_rows < 1:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Scroll window: keep cursor visible.
|
||||||
|
scroll = max(0, cursor - list_rows + 1)
|
||||||
|
visible = filtered[scroll: scroll + list_rows]
|
||||||
|
|
||||||
|
for idx, item in enumerate(visible):
|
||||||
|
abs_idx = scroll + idx
|
||||||
|
attr = curses.A_REVERSE if abs_idx == cursor else curses.A_NORMAL
|
||||||
|
prefix = "> " if abs_idx == cursor else " "
|
||||||
|
line = (prefix + item)[:cols - 1]
|
||||||
|
if row < rows - 1:
|
||||||
|
_addstr_safe(screen, row, 0, line, attr)
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
if row < rows - 1:
|
||||||
|
_addstr_safe(screen, row, 0, sep)
|
||||||
|
row += 1
|
||||||
|
|
||||||
|
help_line = "[↑↓/jk] move [Enter] select [Esc/q] cancel"
|
||||||
|
if row < rows:
|
||||||
|
_addstr_safe(screen, min(rows - 1, row), 0, help_line[:cols - 1])
|
||||||
|
|
||||||
|
screen.refresh()
|
||||||
|
|
||||||
|
|
||||||
|
def _addstr_safe(screen: Any, row: int, col: int, text: str, attr: int = curses.A_NORMAL) -> None:
|
||||||
|
try:
|
||||||
|
screen.addstr(row, col, text, attr)
|
||||||
|
except curses.error:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# name_color_modal — two-step label + color picker
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
_ANSI_COLORS = [
|
||||||
|
"red", "green", "blue", "yellow", "magenta", "cyan", "white", "black",
|
||||||
|
"bright-red", "bright-green", "bright-blue", "bright-yellow",
|
||||||
|
"bright-magenta", "bright-cyan", "bright-white", "bright-black",
|
||||||
|
]
|
||||||
|
|
||||||
|
_CURSES_COLOR_MAP: dict[str, int] = {
|
||||||
|
"black": curses.COLOR_BLACK,
|
||||||
|
"red": curses.COLOR_RED,
|
||||||
|
"green": curses.COLOR_GREEN,
|
||||||
|
"yellow": curses.COLOR_YELLOW,
|
||||||
|
"blue": curses.COLOR_BLUE,
|
||||||
|
"magenta": curses.COLOR_MAGENTA,
|
||||||
|
"cyan": curses.COLOR_CYAN,
|
||||||
|
"white": curses.COLOR_WHITE,
|
||||||
|
}
|
||||||
|
|
||||||
|
_COLOR_NONE = "(none)"
|
||||||
|
|
||||||
|
|
||||||
|
def name_color_modal(
|
||||||
|
default_label: str,
|
||||||
|
*,
|
||||||
|
tty_path: str = "/dev/tty",
|
||||||
|
) -> tuple[str, str]:
|
||||||
|
"""Present a two-step curses modal: first edit the agent label,
|
||||||
|
then optionally pick a color.
|
||||||
|
|
||||||
|
Returns ``(label, color)`` where ``color`` is one of the 16 ANSI
|
||||||
|
color name strings or ``""`` for no color. Falls back to
|
||||||
|
``(default_label, "")`` on any error (terminal too small, not a tty).
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
tty_fd = open(tty_path, "r+b", buffering=0) # pylint: disable=consider-using-with
|
||||||
|
except OSError:
|
||||||
|
return default_label, ""
|
||||||
|
|
||||||
|
try:
|
||||||
|
fd_dup = os.dup(tty_fd.fileno())
|
||||||
|
return _run_name_color(default_label, tty_fd=fd_dup)
|
||||||
|
except Exception: # noqa: BLE001 # pylint: disable=broad-exception-caught
|
||||||
|
return default_label, ""
|
||||||
|
finally:
|
||||||
|
tty_fd.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _run_name_color(default_label: str, *, tty_fd: int) -> tuple[str, str]:
|
||||||
|
import io
|
||||||
|
orig_stdin = sys.__stdin__
|
||||||
|
orig_stdout = sys.__stdout__
|
||||||
|
try:
|
||||||
|
tty_text = io.TextIOWrapper(io.FileIO(tty_fd, mode="r+"), write_through=True)
|
||||||
|
sys.__stdin__ = tty_text # type: ignore[assignment]
|
||||||
|
sys.__stdout__ = tty_text # type: ignore[assignment]
|
||||||
|
os.environ.setdefault("TERM", "xterm-256color")
|
||||||
|
|
||||||
|
screen = curses.initscr()
|
||||||
|
curses.noecho()
|
||||||
|
curses.cbreak()
|
||||||
|
screen.keypad(True)
|
||||||
|
try:
|
||||||
|
label = _label_step(screen, default_label)
|
||||||
|
color = _color_step(screen, label)
|
||||||
|
finally:
|
||||||
|
screen.keypad(False)
|
||||||
|
curses.nocbreak()
|
||||||
|
curses.echo()
|
||||||
|
curses.endwin()
|
||||||
|
finally:
|
||||||
|
sys.__stdin__ = orig_stdin # type: ignore[assignment]
|
||||||
|
sys.__stdout__ = orig_stdout # type: ignore[assignment]
|
||||||
|
return label, color
|
||||||
|
|
||||||
|
|
||||||
|
def _label_step(screen: Any, default_label: str) -> str:
|
||||||
|
"""Step 1: edit the label. First printable key replaces the
|
||||||
|
pre-fill; subsequent keys append. Enter confirms."""
|
||||||
|
text = default_label
|
||||||
|
replaced = False # True once the user has typed their first char
|
||||||
|
|
||||||
|
while True:
|
||||||
|
_render_label(screen, text)
|
||||||
|
try:
|
||||||
|
key = screen.getch()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
return default_label
|
||||||
|
|
||||||
|
if key in (curses.KEY_ENTER, _KEY_ENTER_ALT, ord("\r")):
|
||||||
|
return text.strip() or default_label
|
||||||
|
|
||||||
|
if key in (curses.KEY_BACKSPACE, _KEY_BACKSPACE_WIN, 127):
|
||||||
|
if replaced:
|
||||||
|
text = text[:-1]
|
||||||
|
else:
|
||||||
|
text = ""
|
||||||
|
replaced = True
|
||||||
|
|
||||||
|
elif 32 <= key <= 126:
|
||||||
|
if not replaced:
|
||||||
|
text = chr(key)
|
||||||
|
replaced = True
|
||||||
|
else:
|
||||||
|
text += chr(key)
|
||||||
|
|
||||||
|
|
||||||
|
def _render_label(screen: Any, text: str) -> None:
|
||||||
|
screen.erase()
|
||||||
|
rows, cols = screen.getmaxyx()
|
||||||
|
sep = "─" * min(cols - 1, 40)
|
||||||
|
_addstr_safe(screen, 0, 0, "Name agent", curses.A_BOLD)
|
||||||
|
_addstr_safe(screen, 1, 0, sep)
|
||||||
|
_addstr_safe(screen, 2, 0, text[:cols - 1], curses.A_REVERSE)
|
||||||
|
_addstr_safe(screen, 3, 0, sep)
|
||||||
|
if rows > 5:
|
||||||
|
_addstr_safe(screen, 5, 0, "[any key] edit [Enter] confirm", curses.A_DIM)
|
||||||
|
screen.refresh()
|
||||||
|
|
||||||
|
|
||||||
|
def _color_step(screen: Any, confirmed_label: str) -> str:
|
||||||
|
"""Step 2: pick a color from the list, or skip."""
|
||||||
|
items = [_COLOR_NONE] + _ANSI_COLORS
|
||||||
|
cursor = 0
|
||||||
|
|
||||||
|
# Initialise color pairs once; index 0 = none, 1..16 = palette.
|
||||||
|
color_attrs = _init_color_pairs()
|
||||||
|
|
||||||
|
while True:
|
||||||
|
_render_color(screen, items, cursor, confirmed_label, color_attrs)
|
||||||
|
try:
|
||||||
|
key = screen.getch()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
if key in (ord("q"), _KEY_ESC):
|
||||||
|
return ""
|
||||||
|
|
||||||
|
if key in (curses.KEY_ENTER, _KEY_ENTER_ALT, ord("\r")):
|
||||||
|
chosen = items[cursor]
|
||||||
|
return "" if chosen == _COLOR_NONE else chosen
|
||||||
|
|
||||||
|
if key in (curses.KEY_UP, ord("k")) and cursor > 0:
|
||||||
|
cursor -= 1
|
||||||
|
elif key in (curses.KEY_DOWN, ord("j")) and cursor < len(items) - 1:
|
||||||
|
cursor += 1
|
||||||
|
|
||||||
|
|
||||||
|
def _init_color_pairs() -> dict[str, int]:
|
||||||
|
"""Return {color_name: curses_attr} for the palette items."""
|
||||||
|
attrs: dict[str, int] = {_COLOR_NONE: curses.A_NORMAL}
|
||||||
|
try:
|
||||||
|
curses.start_color()
|
||||||
|
curses.use_default_colors()
|
||||||
|
pair_idx = 2 # pair 1 reserved for other uses
|
||||||
|
for name in _ANSI_COLORS:
|
||||||
|
base = name.replace("bright-", "")
|
||||||
|
fg = _CURSES_COLOR_MAP.get(base, curses.COLOR_WHITE)
|
||||||
|
try:
|
||||||
|
curses.init_pair(pair_idx, fg, -1)
|
||||||
|
attr = curses.color_pair(pair_idx)
|
||||||
|
if name.startswith("bright-"):
|
||||||
|
attr |= curses.A_BOLD
|
||||||
|
attrs[name] = attr
|
||||||
|
pair_idx += 1
|
||||||
|
except curses.error:
|
||||||
|
attrs[name] = curses.A_NORMAL
|
||||||
|
except curses.error:
|
||||||
|
for name in _ANSI_COLORS:
|
||||||
|
attrs[name] = curses.A_NORMAL
|
||||||
|
return attrs
|
||||||
|
|
||||||
|
|
||||||
|
def _render_color(
|
||||||
|
screen: Any,
|
||||||
|
items: list[str],
|
||||||
|
cursor: int,
|
||||||
|
confirmed_label: str,
|
||||||
|
color_attrs: dict[str, int],
|
||||||
|
) -> None:
|
||||||
|
screen.erase()
|
||||||
|
rows, cols = screen.getmaxyx()
|
||||||
|
sep = "─" * min(cols - 1, 40)
|
||||||
|
_addstr_safe(screen, 0, 0, "Name agent", curses.A_BOLD)
|
||||||
|
_addstr_safe(screen, 1, 0, sep)
|
||||||
|
_addstr_safe(screen, 2, 0, confirmed_label[:cols - 1])
|
||||||
|
_addstr_safe(screen, 3, 0, sep)
|
||||||
|
_addstr_safe(screen, 4, 0, "Color (optional)", curses.A_BOLD)
|
||||||
|
|
||||||
|
list_start = 5
|
||||||
|
list_rows = rows - list_start - 2
|
||||||
|
scroll = max(0, cursor - list_rows + 1)
|
||||||
|
visible = items[scroll: scroll + list_rows]
|
||||||
|
|
||||||
|
for idx, name in enumerate(visible):
|
||||||
|
abs_idx = scroll + idx
|
||||||
|
row = list_start + idx
|
||||||
|
if row >= rows - 2:
|
||||||
|
break
|
||||||
|
prefix = "> " if abs_idx == cursor else " "
|
||||||
|
attr = color_attrs.get(name, curses.A_NORMAL)
|
||||||
|
if abs_idx == cursor:
|
||||||
|
attr |= curses.A_REVERSE
|
||||||
|
_addstr_safe(screen, row, 0, (prefix + name)[:cols - 1], attr)
|
||||||
|
|
||||||
|
_addstr_safe(screen, rows - 2, 0, sep)
|
||||||
|
_addstr_safe(
|
||||||
|
screen, rows - 1, 0,
|
||||||
|
"[↑↓/jk] move [Enter] select [Esc/q] skip",
|
||||||
|
curses.A_DIM,
|
||||||
|
)
|
||||||
|
screen.refresh()
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# claude-bottle container image.
|
# bot-bottle container image.
|
||||||
#
|
#
|
||||||
# Goal: a small, cache-friendly base that ships claude-code (the
|
# Goal: a small, cache-friendly base that ships claude-code (the
|
||||||
# `@anthropic-ai/claude-code` npm package, CLI name `claude`) ready to run
|
# `@anthropic-ai/claude-code` npm package, CLI name `claude`) ready to run
|
||||||
@@ -16,21 +16,27 @@ FROM node:22-slim
|
|||||||
# features (status checks, commits, PR creation) — without git in the
|
# features (status checks, commits, PR creation) — without git in the
|
||||||
# image, those features fail in surprising ways once the user does any
|
# image, those features fail in surprising ways once the user does any
|
||||||
# real work. ca-certificates is already in the slim base; listed for
|
# real work. ca-certificates is already in the slim base; listed for
|
||||||
# clarity in case the base ever drops it. socat is the privileged
|
# clarity in case the base ever drops it. curl is here so any
|
||||||
# forwarder for the in-container ssh-agent (see claude_bottle/ssh.py): the agent
|
# HTTPS_PROXY-aware tool (curl itself, plus anything that shells out
|
||||||
# runs as root and rejects non-root connections, so socat sits between
|
# to it) works against egress's bumped TLS without the agent needing
|
||||||
# node and the agent socket. curl is here so any HTTPS_PROXY-aware
|
# local DNS.
|
||||||
# tool (curl itself, plus anything that shells out to it) works
|
|
||||||
# against pipelock's bumped TLS without the agent needing local DNS.
|
|
||||||
RUN apt-get update \
|
RUN apt-get update \
|
||||||
&& apt-get install -y --no-install-recommends git ca-certificates openssh-client socat curl dnsutils \
|
&& apt-get install -y --no-install-recommends git ca-certificates curl \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# App-specific deps. Python isn't required by claude-code itself
|
||||||
|
# (claude-code is a Node CLI), but is convenient for the agent to
|
||||||
|
# shell out to for ad-hoc scripts. Kept on its own layer so it can
|
||||||
|
# be moved to a downstream image if the base ever needs to shrink.
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends python3 python3-pip python3-venv \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
# Install claude-code globally. Pinned to the version verified in the v1
|
# Install claude-code globally. Pinned to the version verified in the v1
|
||||||
# build (`claude --version` returns 2.1.126). Bump deliberately when
|
# build (`claude --version` returns 2.1.126). Bump deliberately when
|
||||||
# rolling forward; an unpinned install would mean rebuilds silently pick
|
# rolling forward; an unpinned install would mean rebuilds silently pick
|
||||||
# up new behavior.
|
# up new behavior.
|
||||||
RUN npm install -g --no-fund --no-audit @anthropic-ai/claude-code@2.1.126 \
|
RUN npm install -g --no-fund --no-audit @anthropic-ai/claude-code@2.1.172 \
|
||||||
&& npm cache clean --force
|
&& npm cache clean --force
|
||||||
|
|
||||||
# Run as a non-root user. The node image already provides a `node` user
|
# Run as a non-root user. The node image already provides a `node` user
|
||||||
@@ -40,7 +46,7 @@ USER node
|
|||||||
WORKDIR /home/node
|
WORKDIR /home/node
|
||||||
|
|
||||||
# Pre-create the skills directory so PRD 0002's host->container skill
|
# Pre-create the skills directory so PRD 0002's host->container skill
|
||||||
# copier (claude_bottle/skills.py) drops files into a path owned by the
|
# copier (bot_bottle/skills.py) drops files into a path owned by the
|
||||||
# `node` user. `skills_copy_into` also `mkdir -p`s defensively, but
|
# `node` user. `skills_copy_into` also `mkdir -p`s defensively, but
|
||||||
# baking it into the image avoids a permission-confusion footgun if a
|
# baking it into the image avoids a permission-confusion footgun if a
|
||||||
# future change to the launcher copies in as a different user.
|
# future change to the launcher copies in as a different user.
|
||||||
@@ -60,7 +66,7 @@ RUN cat > "$HOME/.claude.json" <<JSON
|
|||||||
JSON
|
JSON
|
||||||
|
|
||||||
# Default to an interactive claude session. In the v1 launcher,
|
# Default to an interactive claude session. In the v1 launcher,
|
||||||
# `claude_bottle/cli/start.py` runs the container detached and uses `docker exec`
|
# `bot_bottle/cli/start.py` runs the container detached and uses `docker exec`
|
||||||
# to attach a TTY, but this CMD makes `docker run -it claude-bottle` also
|
# to attach a TTY, but this CMD makes `docker run -it bot-bottle-claude` also
|
||||||
# do something useful for ad-hoc debugging.
|
# do something useful for ad-hoc debugging.
|
||||||
CMD ["claude"]
|
CMD ["claude"]
|
||||||
@@ -0,0 +1,339 @@
|
|||||||
|
"""Claude agent provider plugin (PRD 0050, contrib).
|
||||||
|
|
||||||
|
The Claude-specific behavior previously inlined under
|
||||||
|
`agent_provider.agent_provision_plan` (claude.json trust marker,
|
||||||
|
api.anthropic.com egress route, OAuth-token placeholder), plus
|
||||||
|
the `claude mcp add` invocation that registers the supervise
|
||||||
|
sidecar in claude-code's user config (PRD 0013)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from ...agent_provider import (
|
||||||
|
AgentProvider,
|
||||||
|
AgentProviderRuntime,
|
||||||
|
AgentProvisionDir,
|
||||||
|
AgentProvisionFile,
|
||||||
|
AgentProvisionPlan,
|
||||||
|
)
|
||||||
|
from ...backend.docker import util as docker_mod
|
||||||
|
from ...egress import EgressRoute
|
||||||
|
from ...log import die, info, warn
|
||||||
|
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ...backend import Bottle, BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
_SUPERVISE_MCP_NAME = "supervise"
|
||||||
|
|
||||||
|
|
||||||
|
def _skills_dir(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.claude/skills"
|
||||||
|
|
||||||
|
|
||||||
|
def _prompt_path(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.bot-bottle-prompt.txt"
|
||||||
|
|
||||||
|
|
||||||
|
_STATUS_LINE_COLORS = {
|
||||||
|
"black": "\033[30m",
|
||||||
|
"red": "\033[31m",
|
||||||
|
"green": "\033[32m",
|
||||||
|
"yellow": "\033[33m",
|
||||||
|
"blue": "\033[34m",
|
||||||
|
"magenta": "\033[35m",
|
||||||
|
"cyan": "\033[36m",
|
||||||
|
"white": "\033[37m",
|
||||||
|
"bright-black": "\033[90m",
|
||||||
|
"bright-red": "\033[91m",
|
||||||
|
"bright-green": "\033[92m",
|
||||||
|
"bright-yellow": "\033[93m",
|
||||||
|
"bright-blue": "\033[94m",
|
||||||
|
"bright-magenta": "\033[95m",
|
||||||
|
"bright-cyan": "\033[96m",
|
||||||
|
"bright-white": "\033[97m",
|
||||||
|
}
|
||||||
|
|
||||||
|
_CLAUDE_THEME_COLORS = {
|
||||||
|
"black": "black",
|
||||||
|
"red": "red",
|
||||||
|
"green": "green",
|
||||||
|
"yellow": "yellow",
|
||||||
|
"blue": "blue",
|
||||||
|
"magenta": "magenta",
|
||||||
|
"cyan": "cyan",
|
||||||
|
"white": "white",
|
||||||
|
"bright-black": "blackBright",
|
||||||
|
"bright-red": "redBright",
|
||||||
|
"bright-green": "greenBright",
|
||||||
|
"bright-yellow": "yellowBright",
|
||||||
|
"bright-blue": "blueBright",
|
||||||
|
"bright-magenta": "magentaBright",
|
||||||
|
"bright-cyan": "cyanBright",
|
||||||
|
"bright-white": "whiteBright",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _status_line_script(label: str, color: str) -> str:
|
||||||
|
if not label:
|
||||||
|
return "#!/bin/sh\nprintf '\\n'\n"
|
||||||
|
label_q = shlex.quote(label)
|
||||||
|
if color and color in _STATUS_LINE_COLORS:
|
||||||
|
return (
|
||||||
|
"#!/bin/sh\n"
|
||||||
|
f"printf '%b%s%b\\n' '{_STATUS_LINE_COLORS[color]}' {label_q} '\\033[0m'\n"
|
||||||
|
)
|
||||||
|
return f"#!/bin/sh\nprintf '%s\\n' {label_q}\n"
|
||||||
|
|
||||||
|
|
||||||
|
def _custom_theme_payload(color: str) -> dict[str, object] | None:
|
||||||
|
theme_color = _CLAUDE_THEME_COLORS.get(color)
|
||||||
|
if not theme_color:
|
||||||
|
return None
|
||||||
|
return {
|
||||||
|
"name": f"Bot-bottle {color}",
|
||||||
|
"base": "dark",
|
||||||
|
"overrides": {
|
||||||
|
"claude": f"ansi:{theme_color}",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
_RUNTIME = AgentProviderRuntime(
|
||||||
|
template="claude",
|
||||||
|
command="claude",
|
||||||
|
image="bot-bottle-claude:latest",
|
||||||
|
prompt_mode="append_file",
|
||||||
|
bypass_args=("--dangerously-skip-permissions",),
|
||||||
|
resume_args=("--continue",),
|
||||||
|
remote_control_args=("--remote-control",),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ClaudeAgentProvider(AgentProvider):
|
||||||
|
@property
|
||||||
|
def runtime(self) -> AgentProviderRuntime:
|
||||||
|
return _RUNTIME
|
||||||
|
|
||||||
|
def provision_plan(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
dockerfile: str,
|
||||||
|
state_dir: Path,
|
||||||
|
instance_name: str,
|
||||||
|
prompt_file: Path,
|
||||||
|
guest_env: dict[str, str] | None = None,
|
||||||
|
auth_token: str = "",
|
||||||
|
forward_host_credentials: bool = False,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
trusted_project_path: str = "",
|
||||||
|
label: str = "",
|
||||||
|
color: str = "",
|
||||||
|
provider_settings: dict[str, object] | None = None,
|
||||||
|
) -> AgentProvisionPlan:
|
||||||
|
del forward_host_credentials, host_env, provider_settings
|
||||||
|
resolved_guest_env = dict(guest_env or {})
|
||||||
|
guest_home = self.guest_home
|
||||||
|
trusted_path = trusted_project_path or guest_home
|
||||||
|
|
||||||
|
env_vars: dict[str, str] = {
|
||||||
|
"CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
|
||||||
|
"DISABLE_ERROR_REPORTING": "1",
|
||||||
|
}
|
||||||
|
dirs = (
|
||||||
|
AgentProvisionDir(f"{guest_home}/.claude"),
|
||||||
|
AgentProvisionDir(f"{guest_home}/.claude/themes"),
|
||||||
|
)
|
||||||
|
claude_config = state_dir / "claude.json"
|
||||||
|
claude_projects = {guest_home: {"hasTrustDialogAccepted": True}}
|
||||||
|
claude_projects[trusted_path] = {"hasTrustDialogAccepted": True}
|
||||||
|
payload: dict[str, object] = {
|
||||||
|
"hasCompletedOnboarding": True,
|
||||||
|
"theme": "dark",
|
||||||
|
"bypassPermissionsModeAccepted": True,
|
||||||
|
"projects": claude_projects,
|
||||||
|
}
|
||||||
|
claude_config.write_text(json.dumps(payload, indent=2) + "\n")
|
||||||
|
claude_config.chmod(0o600)
|
||||||
|
files = [
|
||||||
|
AgentProvisionFile(claude_config, f"{guest_home}/.claude.json"),
|
||||||
|
]
|
||||||
|
|
||||||
|
claude_settings = state_dir / "claude-settings.json"
|
||||||
|
claude_settings_payload: dict[str, object] = {}
|
||||||
|
if label or color:
|
||||||
|
statusline_script = state_dir / "claude-statusline.sh"
|
||||||
|
statusline_script.write_text(_status_line_script(label, color))
|
||||||
|
statusline_script.chmod(0o755)
|
||||||
|
files.append(AgentProvisionFile(
|
||||||
|
statusline_script,
|
||||||
|
f"{guest_home}/.claude/statusline.sh",
|
||||||
|
mode="755",
|
||||||
|
))
|
||||||
|
claude_settings_payload["statusLine"] = {
|
||||||
|
"type": "command",
|
||||||
|
"command": "~/.claude/statusline.sh",
|
||||||
|
}
|
||||||
|
theme_payload = _custom_theme_payload(color)
|
||||||
|
if theme_payload is not None:
|
||||||
|
theme_name = f"bot-bottle-{docker_mod.slugify(label or color)}"
|
||||||
|
theme_file = state_dir / f"{theme_name}.json"
|
||||||
|
theme_file.write_text(json.dumps(theme_payload, indent=2) + "\n")
|
||||||
|
theme_file.chmod(0o644)
|
||||||
|
files.append(AgentProvisionFile(
|
||||||
|
theme_file,
|
||||||
|
f"{guest_home}/.claude/themes/{theme_name}.json",
|
||||||
|
))
|
||||||
|
claude_settings_payload["theme"] = f"custom:{theme_name}"
|
||||||
|
if claude_settings_payload:
|
||||||
|
claude_settings.write_text(json.dumps(claude_settings_payload, indent=2) + "\n")
|
||||||
|
claude_settings.chmod(0o600)
|
||||||
|
files.append(AgentProvisionFile(
|
||||||
|
claude_settings,
|
||||||
|
f"{guest_home}/.claude/settings.json",
|
||||||
|
))
|
||||||
|
egress_routes = (EgressRoute(
|
||||||
|
host="api.anthropic.com",
|
||||||
|
auth_scheme="Bearer" if auth_token else "",
|
||||||
|
token_ref=auth_token,
|
||||||
|
),)
|
||||||
|
hidden_env_names: frozenset[str] = frozenset()
|
||||||
|
if auth_token:
|
||||||
|
env_vars["CLAUDE_CODE_OAUTH_TOKEN"] = "egress-placeholder"
|
||||||
|
hidden_env_names = frozenset({"CLAUDE_CODE_OAUTH_TOKEN"})
|
||||||
|
|
||||||
|
has_prompt = prompt_file.exists() and bool(prompt_file.read_text())
|
||||||
|
return AgentProvisionPlan(
|
||||||
|
template=_RUNTIME.template,
|
||||||
|
command=_RUNTIME.command,
|
||||||
|
prompt_mode=_RUNTIME.prompt_mode,
|
||||||
|
image=_RUNTIME.image,
|
||||||
|
dockerfile=dockerfile,
|
||||||
|
guest_home=guest_home,
|
||||||
|
instance_name=instance_name,
|
||||||
|
prompt_file=prompt_file,
|
||||||
|
env_vars=env_vars,
|
||||||
|
guest_env=resolved_guest_env,
|
||||||
|
has_prompt=has_prompt,
|
||||||
|
dirs=dirs,
|
||||||
|
files=tuple(files),
|
||||||
|
egress_routes=egress_routes,
|
||||||
|
hidden_env_names=hidden_env_names,
|
||||||
|
)
|
||||||
|
|
||||||
|
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Copy each named skill tree from `~/.claude/skills/<name>/`
|
||||||
|
on the host into the guest's claude-code skills dir. No-op
|
||||||
|
when the agent has no skills."""
|
||||||
|
from ...backend.util import host_skill_dir
|
||||||
|
|
||||||
|
agent = plan.spec.manifest.agents[plan.spec.agent_name]
|
||||||
|
if not agent.skills:
|
||||||
|
return
|
||||||
|
skills_dir = _skills_dir(plan.guest_home)
|
||||||
|
bottle.exec(f"mkdir -p {skills_dir}", user="root")
|
||||||
|
for name in agent.skills:
|
||||||
|
src = host_skill_dir(name)
|
||||||
|
if not os.path.isdir(src):
|
||||||
|
die(
|
||||||
|
f"skill {name!r} disappeared from host between "
|
||||||
|
f"validation and copy at {src}."
|
||||||
|
)
|
||||||
|
dst = f"{skills_dir}/{name}"
|
||||||
|
info(f"copying skill {name} into {bottle.name}:{dst}")
|
||||||
|
bottle.exec(f"rm -rf {dst} && mkdir -p {dst}", user="root")
|
||||||
|
bottle.cp_in(f"{src}/.", f"{dst}/")
|
||||||
|
bottle.exec(f"chown -R node:node {dst}", user="root")
|
||||||
|
|
||||||
|
def provision_prompt(self, plan: "BottlePlan", bottle: "Bottle") -> str | None:
|
||||||
|
"""Copy the prompt file into the guest, fix ownership/mode.
|
||||||
|
Returns the in-guest path iff the agent has a non-empty
|
||||||
|
prompt (drives `--append-system-prompt-file`); the file is
|
||||||
|
copied either way so the path always exists."""
|
||||||
|
prompt_path = _prompt_path(plan.guest_home)
|
||||||
|
bottle.cp_in(str(plan.prompt_file), prompt_path) # type: ignore
|
||||||
|
bottle.exec(
|
||||||
|
f"chown node:node {prompt_path} && chmod 600 {prompt_path}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
agent = plan.spec.manifest.agents[plan.spec.agent_name]
|
||||||
|
return prompt_path if plan.agent_provision.has_prompt or agent.prompt else None
|
||||||
|
|
||||||
|
def provision(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Apply the claude-side declarative provision steps from
|
||||||
|
`plan.agent_provision` — today that's the `claude.json`
|
||||||
|
trust-marker file. Hot-replace this with a richer flow as
|
||||||
|
claude-code's harness shape evolves."""
|
||||||
|
provision = plan.agent_provision
|
||||||
|
for d in provision.dirs:
|
||||||
|
path = shlex.quote(d.guest_path)
|
||||||
|
_exec(bottle, f"mkdir -p {path}", f"could not create {d.guest_path}")
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(d.owner)} {path}",
|
||||||
|
f"could not chown {d.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(d.mode)} {path}",
|
||||||
|
f"could not chmod {d.guest_path}",
|
||||||
|
)
|
||||||
|
for command in provision.pre_copy:
|
||||||
|
_exec(bottle, shlex.join(command.argv), command.error)
|
||||||
|
for f in provision.files:
|
||||||
|
bottle.cp_in(str(f.host_path), f.guest_path)
|
||||||
|
path = shlex.quote(f.guest_path)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(f.owner)} {path}",
|
||||||
|
f"could not chown {f.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(f.mode)} {path}",
|
||||||
|
f"could not chmod {f.guest_path}",
|
||||||
|
)
|
||||||
|
for command in provision.verify:
|
||||||
|
_exec(bottle, shlex.join(command.argv), command.error)
|
||||||
|
|
||||||
|
def provision_supervise_mcp(
|
||||||
|
self,
|
||||||
|
plan: "BottlePlan",
|
||||||
|
bottle: "Bottle",
|
||||||
|
supervise_url: str,
|
||||||
|
) -> None:
|
||||||
|
"""Run `claude mcp add` inside the agent guest to register the
|
||||||
|
supervise sidecar in claude-code's user config (~/.claude.json).
|
||||||
|
|
||||||
|
Failure is logged but not fatal — the bottle still works without
|
||||||
|
the entry; the operator can register it manually."""
|
||||||
|
if plan.supervise_plan is None:
|
||||||
|
return
|
||||||
|
info(f"registering supervise MCP server in agent claude config → {supervise_url}")
|
||||||
|
r = bottle.exec(
|
||||||
|
f"claude mcp add --scope user --transport http "
|
||||||
|
f"{_SUPERVISE_MCP_NAME} {supervise_url}",
|
||||||
|
user="node",
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
warn(
|
||||||
|
f"`claude mcp add supervise` failed (exit {r.returncode}): "
|
||||||
|
f"{(r.stderr or r.stdout or '').strip()}. Inside the bottle, "
|
||||||
|
f"register manually with: "
|
||||||
|
f"claude mcp add --scope user --transport http supervise {supervise_url}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _exec(bottle: "Bottle", script: str, error: str) -> None:
|
||||||
|
result = bottle.exec(script, user="root")
|
||||||
|
if result.returncode != 0:
|
||||||
|
detail = (result.stderr or result.stdout).strip()
|
||||||
|
if detail:
|
||||||
|
detail = f": {detail}"
|
||||||
|
die(f"agent provider provisioning: {error}{detail}")
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# bot-bottle Codex provider image.
|
||||||
|
#
|
||||||
|
# Mirrors the default Claude image shape: Node LTS, git/network tooling,
|
||||||
|
# non-root node user, and the provider CLI installed globally.
|
||||||
|
|
||||||
|
FROM node:22-slim
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends git ca-certificates curl \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# App-specific deps. Python isn't required by codex itself
|
||||||
|
# (codex is a Node CLI), but is convenient for the agent to shell
|
||||||
|
# out to for ad-hoc scripts. Kept on its own layer so it can be
|
||||||
|
# moved to a downstream image if the base ever needs to shrink.
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends python3 python3-pip python3-venv \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
RUN npm install -g --no-fund --no-audit @openai/codex@0.136.0 \
|
||||||
|
&& npm cache clean --force
|
||||||
|
|
||||||
|
USER node
|
||||||
|
WORKDIR /home/node
|
||||||
|
|
||||||
|
RUN mkdir -p /home/node/.codex
|
||||||
|
|
||||||
|
CMD ["codex"]
|
||||||
@@ -0,0 +1,283 @@
|
|||||||
|
"""Codex agent provider plugin (PRD 0050, contrib).
|
||||||
|
|
||||||
|
The Codex-specific behavior previously inlined under
|
||||||
|
`agent_provider.agent_provision_plan` (config.toml trust marker,
|
||||||
|
chatgpt.com / api.openai.com egress routes, optional host-credential
|
||||||
|
forwarding with dummy-auth.json + verify), plus the `codex mcp add`
|
||||||
|
invocation that registers the supervise sidecar in Codex's
|
||||||
|
~/.codex/config.toml (PRD 0050)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from ...agent_provider import (
|
||||||
|
CODEX_HOST_CREDENTIAL_HOSTS,
|
||||||
|
AgentProvider,
|
||||||
|
AgentProviderRuntime,
|
||||||
|
AgentProvisionDir,
|
||||||
|
AgentProvisionCommand,
|
||||||
|
AgentProvisionFile,
|
||||||
|
AgentProvisionPlan,
|
||||||
|
)
|
||||||
|
from .codex_auth import codex_host_access_token, write_codex_dummy_auth_file
|
||||||
|
from ...egress import CODEX_HOST_CREDENTIAL_TOKEN_REF, EgressRoute
|
||||||
|
from ...log import die, info, warn
|
||||||
|
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ...backend import Bottle, BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
_SUPERVISE_MCP_NAME = "supervise"
|
||||||
|
|
||||||
|
|
||||||
|
def _skills_dir(guest_home: str) -> str:
|
||||||
|
# Codex agents still read skills from the claude-code convention
|
||||||
|
# (~/.claude/skills/) — the bot-bottle-codex image follows the
|
||||||
|
# same layout. If Codex grows native skill discovery later,
|
||||||
|
# change here.
|
||||||
|
return f"{guest_home}/.claude/skills"
|
||||||
|
|
||||||
|
|
||||||
|
def _prompt_path(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.bot-bottle-prompt.txt"
|
||||||
|
|
||||||
|
|
||||||
|
_RUNTIME = AgentProviderRuntime(
|
||||||
|
template="codex",
|
||||||
|
command="codex",
|
||||||
|
image="bot-bottle-codex:latest",
|
||||||
|
prompt_mode="read_prompt_file",
|
||||||
|
bypass_args=("--dangerously-bypass-approvals-and-sandbox",),
|
||||||
|
resume_args=("resume", "--last"),
|
||||||
|
remote_control_args=(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CodexAgentProvider(AgentProvider):
|
||||||
|
@property
|
||||||
|
def runtime(self) -> AgentProviderRuntime:
|
||||||
|
return _RUNTIME
|
||||||
|
|
||||||
|
def provision_plan(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
dockerfile: str,
|
||||||
|
state_dir: Path,
|
||||||
|
instance_name: str,
|
||||||
|
prompt_file: Path,
|
||||||
|
guest_env: dict[str, str] | None = None,
|
||||||
|
auth_token: str = "",
|
||||||
|
forward_host_credentials: bool = False,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
trusted_project_path: str = "",
|
||||||
|
label: str = "",
|
||||||
|
color: str = "",
|
||||||
|
provider_settings: dict[str, object] | None = None,
|
||||||
|
) -> AgentProvisionPlan:
|
||||||
|
del auth_token, label, color, provider_settings
|
||||||
|
resolved_guest_env = dict(guest_env or {})
|
||||||
|
guest_home = self.guest_home
|
||||||
|
trusted_path = trusted_project_path or guest_home
|
||||||
|
|
||||||
|
env_vars: dict[str, str] = {
|
||||||
|
"CODEX_CA_CERTIFICATE": "/etc/ssl/certs/ca-certificates.crt",
|
||||||
|
}
|
||||||
|
auth_dir = resolved_guest_env.get("CODEX_HOME", f"{guest_home}/.codex")
|
||||||
|
if forward_host_credentials:
|
||||||
|
env_vars["CODEX_HOME"] = auth_dir
|
||||||
|
|
||||||
|
dirs = [AgentProvisionDir(auth_dir)]
|
||||||
|
files: list[AgentProvisionFile] = []
|
||||||
|
pre_copy: list[AgentProvisionCommand] = []
|
||||||
|
verify: list[AgentProvisionCommand] = []
|
||||||
|
provisioned_env: dict[str, str] = {}
|
||||||
|
|
||||||
|
config_path = f"{auth_dir}/config.toml"
|
||||||
|
config_file = state_dir / "codex-config.toml"
|
||||||
|
toml_path = trusted_path.replace("\\", "\\\\").replace('"', '\\"')
|
||||||
|
config_file.write_text(
|
||||||
|
f'[projects."{toml_path}"]\n'
|
||||||
|
'trust_level = "trusted"\n'
|
||||||
|
"\n"
|
||||||
|
"[tui]\n"
|
||||||
|
'status_line = ["model-with-reasoning"]\n'
|
||||||
|
'terminal_title = ["spinner", "project"]\n'
|
||||||
|
'theme = "ansi"\n'
|
||||||
|
)
|
||||||
|
config_file.chmod(0o600)
|
||||||
|
files.append(AgentProvisionFile(config_file, config_path))
|
||||||
|
|
||||||
|
egress_routes: list[EgressRoute] = []
|
||||||
|
for host in CODEX_HOST_CREDENTIAL_HOSTS:
|
||||||
|
egress_routes.append(EgressRoute(
|
||||||
|
host=host,
|
||||||
|
auth_scheme="Bearer" if forward_host_credentials else "",
|
||||||
|
token_ref=CODEX_HOST_CREDENTIAL_TOKEN_REF if forward_host_credentials else "",
|
||||||
|
))
|
||||||
|
|
||||||
|
if forward_host_credentials:
|
||||||
|
_host_env = host_env or dict(os.environ)
|
||||||
|
provisioned_env[CODEX_HOST_CREDENTIAL_TOKEN_REF] = (
|
||||||
|
codex_host_access_token(_host_env)
|
||||||
|
)
|
||||||
|
auth_file = state_dir / "codex-auth.json"
|
||||||
|
write_codex_dummy_auth_file(auth_file, _host_env)
|
||||||
|
files.append(AgentProvisionFile(auth_file, f"{auth_dir}/auth.json"))
|
||||||
|
pre_copy.append(AgentProvisionCommand((
|
||||||
|
"find", auth_dir,
|
||||||
|
"-maxdepth", "1",
|
||||||
|
"-type", "f",
|
||||||
|
"(",
|
||||||
|
"-name", "*.sqlite",
|
||||||
|
"-o", "-name", "*.sqlite-*",
|
||||||
|
"-o", "-name", "*.codex-repair-*.bak",
|
||||||
|
")",
|
||||||
|
"-delete",
|
||||||
|
), "codex host credentials: could not reset runtime db files"))
|
||||||
|
verify.append(AgentProvisionCommand((
|
||||||
|
"runuser", "-u", "node", "--",
|
||||||
|
"env",
|
||||||
|
f"HOME={guest_home}",
|
||||||
|
f"CODEX_HOME={auth_dir}",
|
||||||
|
"codex", "login", "status",
|
||||||
|
), (
|
||||||
|
"codex host credentials: dummy auth was copied into the "
|
||||||
|
"guest, but Codex did not accept it"
|
||||||
|
)))
|
||||||
|
|
||||||
|
has_prompt = prompt_file.exists() and bool(prompt_file.read_text())
|
||||||
|
return AgentProvisionPlan(
|
||||||
|
template=_RUNTIME.template,
|
||||||
|
command=_RUNTIME.command,
|
||||||
|
prompt_mode=_RUNTIME.prompt_mode,
|
||||||
|
image=_RUNTIME.image,
|
||||||
|
dockerfile=dockerfile,
|
||||||
|
guest_home=guest_home,
|
||||||
|
instance_name=instance_name,
|
||||||
|
prompt_file=prompt_file,
|
||||||
|
env_vars=env_vars,
|
||||||
|
guest_env=resolved_guest_env,
|
||||||
|
has_prompt=has_prompt,
|
||||||
|
dirs=tuple(dirs),
|
||||||
|
files=tuple(files),
|
||||||
|
pre_copy=tuple(pre_copy),
|
||||||
|
verify=tuple(verify),
|
||||||
|
egress_routes=tuple(egress_routes),
|
||||||
|
provisioned_env=provisioned_env,
|
||||||
|
)
|
||||||
|
|
||||||
|
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Copy each named skill tree from `~/.claude/skills/<name>/`
|
||||||
|
on the host into the guest. No-op when the agent has no
|
||||||
|
skills."""
|
||||||
|
from ...backend.util import host_skill_dir
|
||||||
|
|
||||||
|
agent = plan.spec.manifest.agents[plan.spec.agent_name]
|
||||||
|
if not agent.skills:
|
||||||
|
return
|
||||||
|
skills_dir = _skills_dir(plan.guest_home)
|
||||||
|
bottle.exec(f"mkdir -p {skills_dir}", user="root")
|
||||||
|
for name in agent.skills:
|
||||||
|
src = host_skill_dir(name)
|
||||||
|
if not os.path.isdir(src):
|
||||||
|
die(
|
||||||
|
f"skill {name!r} disappeared from host between "
|
||||||
|
f"validation and copy at {src}."
|
||||||
|
)
|
||||||
|
dst = f"{skills_dir}/{name}"
|
||||||
|
info(f"copying skill {name} into {bottle.name}:{dst}")
|
||||||
|
bottle.exec(f"rm -rf {dst} && mkdir -p {dst}", user="root")
|
||||||
|
bottle.cp_in(f"{src}/.", f"{dst}/")
|
||||||
|
bottle.exec(f"chown -R node:node {dst}", user="root")
|
||||||
|
|
||||||
|
def provision_prompt(self, plan: "BottlePlan", bottle: "Bottle") -> str | None:
|
||||||
|
"""Copy the prompt file into the guest, fix ownership/mode.
|
||||||
|
Codex reads it via the agent's `Read and follow the
|
||||||
|
instructions in <path>.` bootstrap (see `prompt_args`); the
|
||||||
|
file is copied either way so the path always exists."""
|
||||||
|
prompt_path = _prompt_path(plan.guest_home)
|
||||||
|
bottle.cp_in(str(plan.prompt_file), prompt_path) # type: ignore
|
||||||
|
bottle.exec(
|
||||||
|
f"chown node:node {prompt_path} && chmod 600 {prompt_path}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
agent = plan.spec.manifest.agents[plan.spec.agent_name]
|
||||||
|
return prompt_path if plan.agent_provision.has_prompt or agent.prompt else None
|
||||||
|
|
||||||
|
def provision(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
"""Apply the codex-side declarative provision steps from
|
||||||
|
`plan.agent_provision`: the `~/.codex/` dir + config.toml
|
||||||
|
trust marker, plus the dummy-auth.json drop + `codex login
|
||||||
|
status` verify when host-credential forwarding is on."""
|
||||||
|
provision = plan.agent_provision
|
||||||
|
for d in provision.dirs:
|
||||||
|
path = shlex.quote(d.guest_path)
|
||||||
|
_exec(bottle, f"mkdir -p {path}", f"could not create {d.guest_path}")
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(d.owner)} {path}",
|
||||||
|
f"could not chown {d.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(d.mode)} {path}",
|
||||||
|
f"could not chmod {d.guest_path}",
|
||||||
|
)
|
||||||
|
for command in provision.pre_copy:
|
||||||
|
_exec(bottle, shlex.join(command.argv), command.error)
|
||||||
|
for f in provision.files:
|
||||||
|
bottle.cp_in(str(f.host_path), f.guest_path)
|
||||||
|
path = shlex.quote(f.guest_path)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(f.owner)} {path}",
|
||||||
|
f"could not chown {f.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(f.mode)} {path}",
|
||||||
|
f"could not chmod {f.guest_path}",
|
||||||
|
)
|
||||||
|
for command in provision.verify:
|
||||||
|
_exec(bottle, shlex.join(command.argv), command.error)
|
||||||
|
|
||||||
|
def provision_supervise_mcp(
|
||||||
|
self,
|
||||||
|
plan: "BottlePlan",
|
||||||
|
bottle: "Bottle",
|
||||||
|
supervise_url: str,
|
||||||
|
) -> None:
|
||||||
|
"""Run `codex mcp add` inside the agent guest to register the
|
||||||
|
supervise sidecar in Codex's user config (~/.codex/config.toml).
|
||||||
|
|
||||||
|
Mirrors the Claude provider's `claude mcp add` flow — failure
|
||||||
|
is logged but not fatal."""
|
||||||
|
if plan.supervise_plan is None:
|
||||||
|
return
|
||||||
|
info(f"registering supervise MCP server in agent codex config → {supervise_url}")
|
||||||
|
r = bottle.exec(
|
||||||
|
f"codex mcp add --transport http "
|
||||||
|
f"{_SUPERVISE_MCP_NAME} {supervise_url}",
|
||||||
|
user="node",
|
||||||
|
)
|
||||||
|
if r.returncode != 0:
|
||||||
|
warn(
|
||||||
|
f"`codex mcp add supervise` failed (exit {r.returncode}): "
|
||||||
|
f"{(r.stderr or r.stdout or '').strip()}. Inside the bottle, "
|
||||||
|
f"register manually with: "
|
||||||
|
f"codex mcp add --transport http supervise {supervise_url}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _exec(bottle: "Bottle", script: str, error: str) -> None:
|
||||||
|
result = bottle.exec(script, user="root")
|
||||||
|
if result.returncode != 0:
|
||||||
|
detail = (result.stderr or result.stdout).strip()
|
||||||
|
if detail:
|
||||||
|
detail = f": {detail}"
|
||||||
|
die(f"agent provider provisioning: {error}{detail}")
|
||||||
@@ -0,0 +1,328 @@
|
|||||||
|
"""Host Codex auth helpers.
|
||||||
|
|
||||||
|
Reads the host's Codex ChatGPT/device-login auth state and returns only
|
||||||
|
the short-lived access token needed by egress. This module deliberately
|
||||||
|
does not expose refresh tokens or raw auth payloads.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
from copy import deepcopy
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import cast
|
||||||
|
|
||||||
|
from ...log import die
|
||||||
|
from ...util import expand_tilde
|
||||||
|
|
||||||
|
|
||||||
|
def codex_auth_path(host_env: dict[str, str] | None = None) -> Path:
|
||||||
|
env = os.environ if host_env is None else host_env
|
||||||
|
home = env.get("CODEX_HOME")
|
||||||
|
if home:
|
||||||
|
return Path(expand_tilde(home)) / "auth.json"
|
||||||
|
return Path.home() / ".codex" / "auth.json"
|
||||||
|
|
||||||
|
|
||||||
|
def codex_host_access_token(
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
*,
|
||||||
|
now: datetime | None = None,
|
||||||
|
) -> str:
|
||||||
|
path = codex_auth_path(host_env)
|
||||||
|
if not path.is_file():
|
||||||
|
die(
|
||||||
|
f"codex host credentials: auth file missing at {path}. "
|
||||||
|
"Run `codex login --device-auth` on the host or disable "
|
||||||
|
"agent_provider.forward_host_credentials."
|
||||||
|
)
|
||||||
|
raw = _read_auth_object(path)
|
||||||
|
|
||||||
|
auth_mode = raw.get("auth_mode")
|
||||||
|
if not isinstance(auth_mode, str) or auth_mode == "api_key":
|
||||||
|
die(
|
||||||
|
"codex host credentials: host Codex auth is not user/device "
|
||||||
|
"auth. Run `codex login --device-auth` on the host."
|
||||||
|
)
|
||||||
|
|
||||||
|
tokens = raw.get("tokens")
|
||||||
|
if not isinstance(tokens, dict):
|
||||||
|
die(f"codex host credentials: {path} is missing tokens")
|
||||||
|
tokens_typed = cast(dict[str, object], tokens)
|
||||||
|
access = tokens_typed.get("access_token")
|
||||||
|
if not isinstance(access, str) or not access:
|
||||||
|
die(
|
||||||
|
f"codex host credentials: {path} is missing tokens.access_token. "
|
||||||
|
"Run `codex login --device-auth` on the host."
|
||||||
|
)
|
||||||
|
|
||||||
|
exp = _jwt_exp(access)
|
||||||
|
if exp is None:
|
||||||
|
die("codex host credentials: tokens.access_token is not a JWT with exp")
|
||||||
|
check_now = now or datetime.now(timezone.utc)
|
||||||
|
if exp <= check_now:
|
||||||
|
die(
|
||||||
|
"codex host credentials: host Codex access token is expired. "
|
||||||
|
"Run `codex login --device-auth` on the host and restart the bottle."
|
||||||
|
)
|
||||||
|
return access
|
||||||
|
|
||||||
|
|
||||||
|
def codex_dummy_auth_json(
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
*,
|
||||||
|
now: datetime | None = None,
|
||||||
|
) -> str:
|
||||||
|
"""Return a non-secret `auth.json` that keeps Codex in the host's
|
||||||
|
auth branch while egress owns the real bearer token.
|
||||||
|
|
||||||
|
The dummy access/id tokens carry the *host* token's real `exp` so
|
||||||
|
Codex's proactive refresh lifecycle (it refreshes when its local
|
||||||
|
access token is at/past expiry) tracks the real token instead of
|
||||||
|
firing after an artificial TTL. Codex cannot refresh inside the
|
||||||
|
bottle — the refresh token is a placeholder and the OpenAI token
|
||||||
|
endpoint is off-route — so a shorter dummy exp would drop Codex to
|
||||||
|
the sign-in screen the moment it lapsed, even while egress still
|
||||||
|
holds a valid bearer."""
|
||||||
|
path = codex_auth_path(host_env)
|
||||||
|
access = codex_host_access_token(host_env, now=now)
|
||||||
|
raw = _read_auth_object(path)
|
||||||
|
host_exp = _jwt_exp(access)
|
||||||
|
exp_ts = int(host_exp.timestamp()) if host_exp is not None else None
|
||||||
|
dummy = _redact_codex_auth(deepcopy(raw), now=now, exp_ts=exp_ts)
|
||||||
|
return json.dumps(dummy, indent=2, sort_keys=True) + "\n"
|
||||||
|
|
||||||
|
|
||||||
|
def write_codex_dummy_auth_file(
|
||||||
|
path: Path,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
*,
|
||||||
|
now: datetime | None = None,
|
||||||
|
) -> None:
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
path.write_text(codex_dummy_auth_json(host_env, now=now))
|
||||||
|
path.chmod(0o600)
|
||||||
|
|
||||||
|
|
||||||
|
def _read_auth_object(path: Path) -> dict[str, object]:
|
||||||
|
try:
|
||||||
|
raw = json.loads(path.read_text())
|
||||||
|
except (OSError, json.JSONDecodeError) as e:
|
||||||
|
die(f"codex host credentials: could not read valid JSON at {path}: {e}")
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
die(f"codex host credentials: {path} must contain a JSON object")
|
||||||
|
return cast(dict[str, object], raw)
|
||||||
|
|
||||||
|
|
||||||
|
def _dummy_exp(now: datetime | None, exp_ts: int | None) -> int:
|
||||||
|
if exp_ts is not None:
|
||||||
|
return exp_ts
|
||||||
|
check_now = now or datetime.now(timezone.utc)
|
||||||
|
return int(check_now.timestamp()) + 3600
|
||||||
|
|
||||||
|
|
||||||
|
def _dummy_timestamp(now: datetime | None = None) -> str:
|
||||||
|
check_now = now or datetime.now(timezone.utc)
|
||||||
|
if check_now.tzinfo is None:
|
||||||
|
check_now = check_now.replace(tzinfo=timezone.utc)
|
||||||
|
check_now = check_now.astimezone(timezone.utc)
|
||||||
|
return check_now.isoformat(timespec="milliseconds").replace("+00:00", "Z")
|
||||||
|
|
||||||
|
|
||||||
|
def _dummy_jwt(now: datetime | None = None, *, exp_ts: int | None = None) -> str:
|
||||||
|
return _encode_dummy_jwt({
|
||||||
|
"exp": _dummy_exp(now, exp_ts),
|
||||||
|
"sub": "bot-bottle-placeholder",
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
def _dummy_jwt_from_host(
|
||||||
|
value: object, *, now: datetime | None = None, exp_ts: int | None = None,
|
||||||
|
) -> str:
|
||||||
|
if not isinstance(value, str):
|
||||||
|
return _dummy_jwt(now, exp_ts=exp_ts)
|
||||||
|
parts = value.split(".")
|
||||||
|
if len(parts) < 2:
|
||||||
|
return _dummy_jwt(now, exp_ts=exp_ts)
|
||||||
|
try:
|
||||||
|
payload = json.loads(_b64url_decode(parts[1]))
|
||||||
|
except (ValueError, json.JSONDecodeError):
|
||||||
|
return _dummy_jwt(now, exp_ts=exp_ts)
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
return _dummy_jwt(now, exp_ts=exp_ts)
|
||||||
|
return _encode_dummy_jwt(_redact_jwt_payload(cast(dict[str, object], payload), now=now, exp_ts=exp_ts))
|
||||||
|
|
||||||
|
|
||||||
|
def _encode_dummy_jwt(payload: dict[str, object]) -> str:
|
||||||
|
def enc(obj: dict[str, object]) -> str:
|
||||||
|
raw = json.dumps(obj, separators=(",", ":")).encode()
|
||||||
|
return base64.urlsafe_b64encode(raw).decode().rstrip("=")
|
||||||
|
|
||||||
|
return f"{enc({'alg': 'none', 'typ': 'JWT'})}.{enc(payload)}.placeholder"
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_jwt_payload(
|
||||||
|
payload: dict[str, object],
|
||||||
|
*,
|
||||||
|
now: datetime | None = None,
|
||||||
|
exp_ts: int | None = None,
|
||||||
|
) -> dict[str, object]:
|
||||||
|
out = _redact_claims(payload)
|
||||||
|
if not isinstance(out, dict):
|
||||||
|
out = {}
|
||||||
|
out_typed: dict[str, object] = cast(dict[str, object], out)
|
||||||
|
out_typed["exp"] = _dummy_exp(now, exp_ts)
|
||||||
|
out_typed.setdefault("sub", "bot-bottle-placeholder")
|
||||||
|
return out_typed
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_claims(value: object) -> object:
|
||||||
|
if isinstance(value, dict):
|
||||||
|
out: dict[str, object] = {}
|
||||||
|
for key, inner in cast(dict[str, object], value).items():
|
||||||
|
lower = key.lower()
|
||||||
|
if key == "https://api.openai.com/profile":
|
||||||
|
out[key] = _redact_profile_claim(inner)
|
||||||
|
elif key == "https://api.openai.com/auth":
|
||||||
|
out[key] = _redact_auth_claim(inner)
|
||||||
|
elif lower == "email":
|
||||||
|
out[key] = "bot-bottle@example.invalid"
|
||||||
|
elif lower == "email_verified":
|
||||||
|
out[key] = True
|
||||||
|
elif lower in {"exp", "iat", "nbf", "auth_time", "pwd_auth_time"}:
|
||||||
|
out[key] = inner if isinstance(inner, (int, float)) else 0
|
||||||
|
elif lower in {"aud", "scp", "amr"}:
|
||||||
|
out[key] = inner if isinstance(inner, list) else []
|
||||||
|
elif isinstance(inner, bool):
|
||||||
|
out[key] = inner
|
||||||
|
elif isinstance(inner, dict):
|
||||||
|
out[key] = {}
|
||||||
|
elif isinstance(inner, list):
|
||||||
|
out[key] = []
|
||||||
|
else:
|
||||||
|
out[key] = "bot-bottle-placeholder"
|
||||||
|
return out
|
||||||
|
if isinstance(value, list):
|
||||||
|
return []
|
||||||
|
return "bot-bottle-placeholder"
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_profile_claim(value: object) -> dict[str, object]:
|
||||||
|
profile = cast(dict[str, object], value) if isinstance(value, dict) else {}
|
||||||
|
return {
|
||||||
|
"email": "bot-bottle@example.invalid",
|
||||||
|
"email_verified": bool(profile.get("email_verified", True)),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_auth_claim(value: object) -> dict[str, object]:
|
||||||
|
auth = cast(dict[str, object], value) if isinstance(value, dict) else {}
|
||||||
|
out: dict[str, object] = {}
|
||||||
|
for key, inner in auth.items():
|
||||||
|
lower = key.lower()
|
||||||
|
if lower == "chatgpt_plan_type" and isinstance(inner, str) and inner:
|
||||||
|
out[key] = inner
|
||||||
|
elif lower == "chatgpt_account_id" and isinstance(inner, str) and inner:
|
||||||
|
# Current Codex uses the selected account id when building
|
||||||
|
# ChatGPT requests. Keep that non-secret identifier aligned
|
||||||
|
# with the host while egress owns the real bearer token.
|
||||||
|
out[key] = inner
|
||||||
|
elif lower == "localhost" and isinstance(inner, bool):
|
||||||
|
out[key] = inner
|
||||||
|
elif isinstance(inner, bool):
|
||||||
|
out[key] = inner
|
||||||
|
elif isinstance(inner, list):
|
||||||
|
out[key] = []
|
||||||
|
elif isinstance(inner, dict):
|
||||||
|
out[key] = {}
|
||||||
|
else:
|
||||||
|
out[key] = "bot-bottle-placeholder"
|
||||||
|
out.setdefault("chatgpt_plan_type", "unknown")
|
||||||
|
out.setdefault("user_id", "bot-bottle-placeholder")
|
||||||
|
out.setdefault("chatgpt_user_id", "bot-bottle-placeholder")
|
||||||
|
out.setdefault("chatgpt_account_id", "bot-bottle-placeholder")
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_codex_auth(
|
||||||
|
value: object, *, now: datetime | None = None, exp_ts: int | None = None,
|
||||||
|
) -> object:
|
||||||
|
auth = cast(dict[str, object], value) if isinstance(value, dict) else {}
|
||||||
|
out: dict[str, object] = {}
|
||||||
|
for key, inner in auth.items():
|
||||||
|
lower = key.lower()
|
||||||
|
if lower == "auth_mode" and isinstance(inner, str) and inner:
|
||||||
|
out[key] = inner
|
||||||
|
elif lower == "openai_api_key":
|
||||||
|
out[key] = None
|
||||||
|
elif lower == "last_refresh":
|
||||||
|
# Codex parses this as a timestamp on startup. Keep the
|
||||||
|
# schema valid without copying host-side session metadata.
|
||||||
|
out[key] = _dummy_timestamp(now)
|
||||||
|
elif lower == "tokens":
|
||||||
|
out[key] = _redact_token_block(inner, now=now, exp_ts=exp_ts)
|
||||||
|
else:
|
||||||
|
out[key] = _redact_unknown_auth_value(inner)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_token_block(
|
||||||
|
value: object, *, now: datetime | None = None, exp_ts: int | None = None,
|
||||||
|
) -> dict[str, object]:
|
||||||
|
tokens = cast(dict[str, object], value) if isinstance(value, dict) else {}
|
||||||
|
out: dict[str, object] = {}
|
||||||
|
for key, inner in tokens.items():
|
||||||
|
lower = key.lower()
|
||||||
|
if lower in {"access_token", "id_token"}:
|
||||||
|
out[key] = _dummy_jwt_from_host(inner, now=now, exp_ts=exp_ts)
|
||||||
|
elif lower == "account_id" and isinstance(inner, str) and inner:
|
||||||
|
# Current Codex uses this non-secret selected account id
|
||||||
|
# while egress owns the real bearer token.
|
||||||
|
out[key] = inner
|
||||||
|
else:
|
||||||
|
out[key] = _redact_unknown_auth_value(inner)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_unknown_auth_value(value: object) -> object:
|
||||||
|
if isinstance(value, bool):
|
||||||
|
return value
|
||||||
|
if isinstance(value, dict):
|
||||||
|
return {}
|
||||||
|
if isinstance(value, list):
|
||||||
|
return []
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
return "bot-bottle-placeholder"
|
||||||
|
|
||||||
|
|
||||||
|
def _jwt_exp(token: str) -> datetime | None:
|
||||||
|
parts = token.split(".")
|
||||||
|
if len(parts) < 2:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
payload = json.loads(_b64url_decode(parts[1]))
|
||||||
|
except (ValueError, json.JSONDecodeError):
|
||||||
|
return None
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
return None
|
||||||
|
exp = cast(dict[str, object], payload).get("exp")
|
||||||
|
if not isinstance(exp, (int, float)):
|
||||||
|
return None
|
||||||
|
return datetime.fromtimestamp(exp, timezone.utc)
|
||||||
|
|
||||||
|
|
||||||
|
def _b64url_decode(value: str) -> str:
|
||||||
|
padded = value + ("=" * (-len(value) % 4))
|
||||||
|
return base64.urlsafe_b64decode(padded.encode("ascii")).decode("utf-8")
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"codex_auth_path",
|
||||||
|
"codex_dummy_auth_json",
|
||||||
|
"codex_host_access_token",
|
||||||
|
"write_codex_dummy_auth_file",
|
||||||
|
]
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
"""Gitea deploy-key provisioner (PRD 0048, contrib).
|
||||||
|
|
||||||
|
Generates ed25519 keypairs via `ssh-keygen` and registers / deletes
|
||||||
|
them using the Gitea deploy-key HTTP API. No new Python dependencies —
|
||||||
|
only stdlib `urllib.request` and `subprocess`.
|
||||||
|
|
||||||
|
Required token permissions (Gitea "Applications" → "Generate Token"):
|
||||||
|
- Repository: Read & Write
|
||||||
|
Grants POST /api/v1/repos/{owner}/{repo}/keys (create deploy key)
|
||||||
|
and DELETE /api/v1/repos/{owner}/{repo}/keys/{id} (revoke deploy key).
|
||||||
|
No other scopes are needed."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import subprocess
|
||||||
|
import tempfile
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ...deploy_key_provisioner import DeployKeyProvisioner
|
||||||
|
|
||||||
|
|
||||||
|
class GiteaDeployKeyProvisioner(DeployKeyProvisioner):
|
||||||
|
"""Manages deploy keys on a Gitea instance."""
|
||||||
|
|
||||||
|
def __init__(self, *, token: str, api_url: str) -> None:
|
||||||
|
self._token = token
|
||||||
|
self._api_url = api_url.rstrip("/")
|
||||||
|
|
||||||
|
def create(self, owner_repo: str, title: str) -> tuple[str, bytes]:
|
||||||
|
"""Generate an ed25519 keypair, register the public half as a
|
||||||
|
repo deploy key, and return `(key_id, private_key_bytes)`.
|
||||||
|
|
||||||
|
The key is registered with `read_only=False` because git-gate
|
||||||
|
needs push access to forward gitleaks-scanned refs upstream."""
|
||||||
|
with tempfile.TemporaryDirectory() as tmpdir:
|
||||||
|
key_path = Path(tmpdir) / "key"
|
||||||
|
subprocess.run(
|
||||||
|
[
|
||||||
|
"ssh-keygen", "-t", "ed25519",
|
||||||
|
"-f", str(key_path),
|
||||||
|
"-N", "",
|
||||||
|
],
|
||||||
|
check=True,
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
)
|
||||||
|
private_key = key_path.read_bytes()
|
||||||
|
public_key = key_path.with_suffix(".pub").read_text().strip()
|
||||||
|
|
||||||
|
owner, repo = _split_owner_repo(owner_repo)
|
||||||
|
url = f"{self._api_url}/api/v1/repos/{owner}/{repo}/keys"
|
||||||
|
payload = json.dumps({
|
||||||
|
"key": public_key,
|
||||||
|
"read_only": False,
|
||||||
|
"title": title,
|
||||||
|
}).encode()
|
||||||
|
req = urllib.request.Request(
|
||||||
|
url,
|
||||||
|
data=payload,
|
||||||
|
headers={
|
||||||
|
"Authorization": f"token {self._token}",
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
method="POST",
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req) as resp:
|
||||||
|
body = json.loads(resp.read())
|
||||||
|
except urllib.error.HTTPError as exc:
|
||||||
|
_body = _read_error_body(exc)
|
||||||
|
raise RuntimeError(
|
||||||
|
f"failed to create deploy key for {owner_repo}: "
|
||||||
|
f"HTTP {exc.code} — {_body}"
|
||||||
|
) from exc
|
||||||
|
except urllib.error.URLError as exc:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"failed to create deploy key for {owner_repo}: {exc.reason}"
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
return str(body["id"]), private_key
|
||||||
|
|
||||||
|
def delete(self, owner_repo: str, key_id: str) -> None:
|
||||||
|
"""Delete the deploy key. HTTP 404 (already gone) is success.
|
||||||
|
All other errors raise RuntimeError so teardown halts."""
|
||||||
|
owner, repo = _split_owner_repo(owner_repo)
|
||||||
|
url = f"{self._api_url}/api/v1/repos/{owner}/{repo}/keys/{key_id}"
|
||||||
|
req = urllib.request.Request(
|
||||||
|
url,
|
||||||
|
headers={"Authorization": f"token {self._token}"},
|
||||||
|
method="DELETE",
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req):
|
||||||
|
pass
|
||||||
|
except urllib.error.HTTPError as exc:
|
||||||
|
if exc.code == 404:
|
||||||
|
return
|
||||||
|
_body = _read_error_body(exc)
|
||||||
|
raise RuntimeError(
|
||||||
|
f"failed to delete deploy key {key_id} for {owner_repo}: "
|
||||||
|
f"HTTP {exc.code} — {_body}"
|
||||||
|
) from exc
|
||||||
|
except urllib.error.URLError as exc:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"failed to delete deploy key {key_id} for {owner_repo}: "
|
||||||
|
f"{exc.reason}"
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
|
||||||
|
def _split_owner_repo(owner_repo: str) -> tuple[str, str]:
|
||||||
|
"""Split `'owner/repo'` into `('owner', 'repo')`."""
|
||||||
|
parts = owner_repo.split("/", 1)
|
||||||
|
if len(parts) != 2 or not all(parts):
|
||||||
|
raise ValueError(
|
||||||
|
f"expected 'owner/repo' format, got {owner_repo!r}"
|
||||||
|
)
|
||||||
|
return parts[0], parts[1]
|
||||||
|
|
||||||
|
|
||||||
|
def _read_error_body(exc: urllib.error.HTTPError) -> str:
|
||||||
|
try:
|
||||||
|
return exc.read().decode("utf-8", errors="replace")
|
||||||
|
except Exception: # noqa: broad-exception-caught — safely fallback to empty error message
|
||||||
|
return ""
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
# bot-bottle Pi provider image.
|
||||||
|
#
|
||||||
|
# Node LTS, git/network tooling, and the Pi coding-agent CLI installed globally.
|
||||||
|
|
||||||
|
FROM node:22-slim
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends \
|
||||||
|
git \
|
||||||
|
ca-certificates \
|
||||||
|
curl \
|
||||||
|
fd-find \
|
||||||
|
ripgrep \
|
||||||
|
&& ln -s /usr/bin/fdfind /usr/local/bin/fd \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends python3 python3-pip python3-venv \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
RUN npm install -g --ignore-scripts --no-fund --no-audit @earendil-works/pi-coding-agent \
|
||||||
|
&& npm cache clean --force
|
||||||
|
|
||||||
|
RUN mkdir -p /home/node/.pi/agent \
|
||||||
|
/home/node/.pi/context-mode/sessions \
|
||||||
|
/tmp/pi-subagents-uid-1000 \
|
||||||
|
&& chown -R node:node /home/node/.pi /tmp \
|
||||||
|
&& chmod -R u+rwX /tmp \
|
||||||
|
&& chown root:root /tmp /var/tmp \
|
||||||
|
&& chmod 1777 /tmp /var/tmp
|
||||||
|
|
||||||
|
USER node
|
||||||
|
WORKDIR /home/node
|
||||||
|
|
||||||
|
RUN pi install npm:@harms-haus/pi-cwd \
|
||||||
|
&& pi install npm:pi-web-access \
|
||||||
|
&& pi install npm:context-mode \
|
||||||
|
&& pi install npm:pi-subagents \
|
||||||
|
&& pi install npm:pi-mcp-adapter
|
||||||
|
|
||||||
|
CMD ["pi"]
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Pi agent provider package."""
|
||||||
@@ -0,0 +1,319 @@
|
|||||||
|
"""Pi agent provider plugin (PRD 0058, contrib).
|
||||||
|
|
||||||
|
Pi uses ~/.pi/agent/models.json for custom provider/model settings.
|
||||||
|
This provider writes an Ollama-compatible default configuration and
|
||||||
|
lets bottles override the model endpoint and model ids via
|
||||||
|
agent_provider.settings.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
|
from ...agent_provider import (
|
||||||
|
AgentProvider,
|
||||||
|
AgentProviderRuntime,
|
||||||
|
AgentProvisionDir,
|
||||||
|
AgentProvisionFile,
|
||||||
|
AgentProvisionPlan,
|
||||||
|
)
|
||||||
|
from ...egress import EgressRoute
|
||||||
|
from ...log import die, info
|
||||||
|
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ...backend import Bottle, BottlePlan
|
||||||
|
|
||||||
|
|
||||||
|
_DEFAULT_BASE_URL = "http://ollama:11434/v1"
|
||||||
|
_DEFAULT_MODEL = "qwen2.5-coder:7b"
|
||||||
|
_DEFAULT_PROVIDER_NAME = "ollama"
|
||||||
|
_DEFAULT_CONTEXT_WINDOW = 4096
|
||||||
|
_DEFAULT_MAX_TOKENS = 1024
|
||||||
|
|
||||||
|
|
||||||
|
def _skills_dir(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.pi/agent/skills"
|
||||||
|
|
||||||
|
|
||||||
|
def _prompt_path(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.bot-bottle-prompt.txt"
|
||||||
|
|
||||||
|
|
||||||
|
def _append_system_path(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.pi/agent/APPEND_SYSTEM.md"
|
||||||
|
|
||||||
|
|
||||||
|
def _models_path(guest_home: str) -> str:
|
||||||
|
return f"{guest_home}/.pi/agent/models.json"
|
||||||
|
|
||||||
|
|
||||||
|
def _runtime_state_repair_script(guest_home: str) -> str:
|
||||||
|
home = shlex.quote(guest_home)
|
||||||
|
pi_home = shlex.quote(f"{guest_home}/.pi")
|
||||||
|
context_sessions = shlex.quote(f"{guest_home}/.pi/context-mode/sessions")
|
||||||
|
return (
|
||||||
|
f"mkdir -p {context_sessions} /tmp/pi-subagents-uid-1000 && "
|
||||||
|
f"chown node:node {home} && "
|
||||||
|
f"chown -R node:node {pi_home} /tmp && "
|
||||||
|
"chmod -R u+rwX /tmp && "
|
||||||
|
f"chmod 755 {home} && "
|
||||||
|
"chown root:root /tmp /var/tmp && "
|
||||||
|
"chmod 1777 /tmp /var/tmp"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _settings_value(
|
||||||
|
settings: dict[str, object],
|
||||||
|
key: str,
|
||||||
|
default: object,
|
||||||
|
) -> object:
|
||||||
|
value = settings.get(key)
|
||||||
|
return default if value is None else value
|
||||||
|
|
||||||
|
|
||||||
|
def _settings_int(
|
||||||
|
settings: dict[str, object],
|
||||||
|
key: str,
|
||||||
|
default: int,
|
||||||
|
) -> int:
|
||||||
|
value = _settings_value(settings, key, default)
|
||||||
|
if isinstance(value, bool):
|
||||||
|
return default
|
||||||
|
if isinstance(value, (int, str)):
|
||||||
|
return int(value)
|
||||||
|
return default
|
||||||
|
|
||||||
|
|
||||||
|
def _pi_models_json(
|
||||||
|
settings: dict[str, object],
|
||||||
|
) -> tuple[dict[str, object], str, str, list[str], str]:
|
||||||
|
provider_name = str(
|
||||||
|
_settings_value(settings, "provider", _DEFAULT_PROVIDER_NAME)
|
||||||
|
)
|
||||||
|
base_url = str(_settings_value(settings, "base_url", _DEFAULT_BASE_URL))
|
||||||
|
api = str(_settings_value(settings, "api", "openai-completions"))
|
||||||
|
api_key = settings.get("api_key")
|
||||||
|
api_key_env = str(settings.get("api_key_env", ""))
|
||||||
|
models_raw = _settings_value(settings, "models", [_DEFAULT_MODEL])
|
||||||
|
models = [str(model) for model in models_raw] # type: ignore[union-attr]
|
||||||
|
supports_developer_role = bool(
|
||||||
|
_settings_value(settings, "supports_developer_role", False)
|
||||||
|
)
|
||||||
|
supports_reasoning_effort = bool(
|
||||||
|
_settings_value(settings, "supports_reasoning_effort", False)
|
||||||
|
)
|
||||||
|
max_tokens_field = str(
|
||||||
|
_settings_value(settings, "max_tokens_field", "max_tokens")
|
||||||
|
)
|
||||||
|
context_window = _settings_int(
|
||||||
|
settings, "context_window", _DEFAULT_CONTEXT_WINDOW,
|
||||||
|
)
|
||||||
|
max_tokens = _settings_int(settings, "max_tokens", _DEFAULT_MAX_TOKENS)
|
||||||
|
input_context_window = max(1, context_window - max_tokens)
|
||||||
|
provider: dict[str, object] = {
|
||||||
|
"baseUrl": base_url,
|
||||||
|
"api": api,
|
||||||
|
"compat": {
|
||||||
|
"supportsDeveloperRole": supports_developer_role,
|
||||||
|
"supportsReasoningEffort": supports_reasoning_effort,
|
||||||
|
"maxTokensField": max_tokens_field,
|
||||||
|
},
|
||||||
|
"models": [
|
||||||
|
{
|
||||||
|
"id": model,
|
||||||
|
"name": model,
|
||||||
|
"contextWindow": input_context_window,
|
||||||
|
"maxTokens": max_tokens,
|
||||||
|
}
|
||||||
|
for model in models
|
||||||
|
],
|
||||||
|
}
|
||||||
|
if api_key is not None:
|
||||||
|
provider["apiKey"] = str(api_key)
|
||||||
|
elif api_key_env:
|
||||||
|
provider["apiKey"] = "egress-placeholder"
|
||||||
|
elif provider_name == _DEFAULT_PROVIDER_NAME:
|
||||||
|
provider["apiKey"] = "ollama"
|
||||||
|
payload: dict[str, object] = {
|
||||||
|
"providers": {
|
||||||
|
provider_name: provider,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return payload, base_url, api_key_env, models, provider_name
|
||||||
|
|
||||||
|
|
||||||
|
def _route_host(base_url: str) -> str:
|
||||||
|
parsed = urlparse(base_url)
|
||||||
|
if not parsed.scheme or not parsed.hostname:
|
||||||
|
die(
|
||||||
|
"agent provider provisioning: pi settings base_url must be an "
|
||||||
|
f"absolute URL (was {base_url!r})"
|
||||||
|
)
|
||||||
|
return parsed.hostname
|
||||||
|
|
||||||
|
|
||||||
|
_RUNTIME = AgentProviderRuntime(
|
||||||
|
template="pi",
|
||||||
|
command="pi",
|
||||||
|
image="bot-bottle-pi:latest",
|
||||||
|
prompt_mode="append_system_prompt",
|
||||||
|
bypass_args=(),
|
||||||
|
resume_args=(),
|
||||||
|
remote_control_args=(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class PiAgentProvider(AgentProvider):
|
||||||
|
@property
|
||||||
|
def runtime(self) -> AgentProviderRuntime:
|
||||||
|
return _RUNTIME
|
||||||
|
|
||||||
|
def provision_plan(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
dockerfile: str,
|
||||||
|
state_dir: Path,
|
||||||
|
instance_name: str,
|
||||||
|
prompt_file: Path,
|
||||||
|
guest_env: dict[str, str] | None = None,
|
||||||
|
auth_token: str = "",
|
||||||
|
forward_host_credentials: bool = False,
|
||||||
|
host_env: dict[str, str] | None = None,
|
||||||
|
trusted_project_path: str = "",
|
||||||
|
label: str = "",
|
||||||
|
color: str = "",
|
||||||
|
provider_settings: dict[str, object] | None = None,
|
||||||
|
) -> AgentProvisionPlan:
|
||||||
|
del auth_token, forward_host_credentials, host_env, trusted_project_path
|
||||||
|
del label, color
|
||||||
|
resolved_guest_env = dict(guest_env or {})
|
||||||
|
guest_home = self.guest_home
|
||||||
|
settings = dict(provider_settings or {})
|
||||||
|
|
||||||
|
models_payload, base_url, api_key_env, models, provider_name = (
|
||||||
|
_pi_models_json(settings)
|
||||||
|
)
|
||||||
|
models_file = state_dir / "pi-models.json"
|
||||||
|
models_file.write_text(json.dumps(models_payload, indent=2) + "\n")
|
||||||
|
models_file.chmod(0o600)
|
||||||
|
|
||||||
|
has_prompt = prompt_file.exists() and bool(prompt_file.read_text())
|
||||||
|
auth_scheme = "Bearer" if api_key_env else ""
|
||||||
|
return AgentProvisionPlan(
|
||||||
|
template=_RUNTIME.template,
|
||||||
|
command=_RUNTIME.command,
|
||||||
|
prompt_mode=_RUNTIME.prompt_mode,
|
||||||
|
image=_RUNTIME.image,
|
||||||
|
dockerfile=dockerfile,
|
||||||
|
guest_home=guest_home,
|
||||||
|
instance_name=instance_name,
|
||||||
|
prompt_file=prompt_file,
|
||||||
|
guest_env=resolved_guest_env,
|
||||||
|
has_prompt=has_prompt,
|
||||||
|
startup_args=(
|
||||||
|
"--models",
|
||||||
|
",".join(f"{provider_name}/{model}" for model in models),
|
||||||
|
),
|
||||||
|
dirs=(AgentProvisionDir(f"{guest_home}/.pi/agent"),),
|
||||||
|
files=(AgentProvisionFile(models_file, _models_path(guest_home)),),
|
||||||
|
egress_routes=(EgressRoute(
|
||||||
|
host=_route_host(base_url),
|
||||||
|
auth_scheme=auth_scheme,
|
||||||
|
token_ref=api_key_env,
|
||||||
|
),),
|
||||||
|
)
|
||||||
|
|
||||||
|
def provision_skills(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
from ...backend.util import host_skill_dir
|
||||||
|
|
||||||
|
agent = plan.spec.manifest.agents[plan.spec.agent_name]
|
||||||
|
if not agent.skills:
|
||||||
|
return
|
||||||
|
skills_dir = _skills_dir(plan.guest_home)
|
||||||
|
bottle.exec(f"mkdir -p {skills_dir}", user="root")
|
||||||
|
for name in agent.skills:
|
||||||
|
src = host_skill_dir(name)
|
||||||
|
if not os.path.isdir(src):
|
||||||
|
die(
|
||||||
|
f"skill {name!r} disappeared from host between "
|
||||||
|
f"validation and copy at {src}."
|
||||||
|
)
|
||||||
|
dst = f"{skills_dir}/{name}"
|
||||||
|
info(f"copying skill {name} into {bottle.name}:{dst}")
|
||||||
|
bottle.exec(f"rm -rf {dst} && mkdir -p {dst}", user="root")
|
||||||
|
bottle.cp_in(f"{src}/.", f"{dst}/")
|
||||||
|
bottle.exec(f"chown -R node:node {dst}", user="root")
|
||||||
|
|
||||||
|
def provision_prompt(self, plan: "BottlePlan", bottle: "Bottle") -> str | None:
|
||||||
|
prompt_path = _prompt_path(plan.guest_home)
|
||||||
|
append_system_path = _append_system_path(plan.guest_home)
|
||||||
|
bottle.cp_in(str(plan.prompt_file), prompt_path) # type: ignore
|
||||||
|
bottle.exec(
|
||||||
|
f"mkdir -p {shlex.quote(plan.guest_home)}/.pi/agent && "
|
||||||
|
f"cp {shlex.quote(prompt_path)} {shlex.quote(append_system_path)} && "
|
||||||
|
f"chown node:node {shlex.quote(prompt_path)} "
|
||||||
|
f"{shlex.quote(append_system_path)} && "
|
||||||
|
f"chmod 600 {shlex.quote(prompt_path)} "
|
||||||
|
f"{shlex.quote(append_system_path)}",
|
||||||
|
user="root",
|
||||||
|
)
|
||||||
|
# Pi's `--append-system-prompt` takes literal text, not a file path.
|
||||||
|
# Use its documented APPEND_SYSTEM.md discovery path instead.
|
||||||
|
return None
|
||||||
|
|
||||||
|
def provision(self, plan: "BottlePlan", bottle: "Bottle") -> None:
|
||||||
|
provision = plan.agent_provision
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
_runtime_state_repair_script(plan.guest_home),
|
||||||
|
"could not prepare pi runtime state",
|
||||||
|
)
|
||||||
|
for d in provision.dirs:
|
||||||
|
path = shlex.quote(d.guest_path)
|
||||||
|
_exec(bottle, f"mkdir -p {path}", f"could not create {d.guest_path}")
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(d.owner)} {path}",
|
||||||
|
f"could not chown {d.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(d.mode)} {path}",
|
||||||
|
f"could not chmod {d.guest_path}",
|
||||||
|
)
|
||||||
|
for f in provision.files:
|
||||||
|
bottle.cp_in(str(f.host_path), f.guest_path)
|
||||||
|
path = shlex.quote(f.guest_path)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chown {shlex.quote(f.owner)} {path}",
|
||||||
|
f"could not chown {f.guest_path}",
|
||||||
|
)
|
||||||
|
_exec(
|
||||||
|
bottle,
|
||||||
|
f"chmod {shlex.quote(f.mode)} {path}",
|
||||||
|
f"could not chmod {f.guest_path}",
|
||||||
|
)
|
||||||
|
|
||||||
|
def provision_supervise_mcp(
|
||||||
|
self,
|
||||||
|
plan: "BottlePlan",
|
||||||
|
bottle: "Bottle",
|
||||||
|
supervise_url: str,
|
||||||
|
) -> None:
|
||||||
|
del plan, bottle, supervise_url
|
||||||
|
|
||||||
|
|
||||||
|
def _exec(bottle: "Bottle", script: str, error: str) -> None:
|
||||||
|
result = bottle.exec(script, user="root")
|
||||||
|
if result.returncode != 0:
|
||||||
|
detail = (result.stderr or result.stdout).strip()
|
||||||
|
if detail:
|
||||||
|
detail = f": {detail}"
|
||||||
|
die(f"agent provider provisioning: {error}{detail}")
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
"""Deploy-key provisioner interface and factory (PRD 0048).
|
||||||
|
|
||||||
|
The core defines the abstract contract; concrete implementations live
|
||||||
|
in `bot_bottle/contrib/<provider>/deploy_key_provisioner.py`. The
|
||||||
|
factory `get_provisioner` imports contrib modules lazily so that a
|
||||||
|
missing optional dependency in one provider doesn't break unrelated
|
||||||
|
features."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
|
||||||
|
|
||||||
|
class DeployKeyProvisioner(ABC):
|
||||||
|
"""Manages a single deploy-key lifecycle on a remote forge."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def create(self, owner_repo: str, title: str) -> tuple[str, bytes]:
|
||||||
|
"""Generate a keypair and register the public half as a
|
||||||
|
deploy key on the forge.
|
||||||
|
|
||||||
|
`owner_repo` is the `<owner>/<repo>` path (no `.git` suffix).
|
||||||
|
`title` is the human-readable label shown in the forge UI.
|
||||||
|
|
||||||
|
Returns `(key_id, private_key_bytes)` where `key_id` is opaque
|
||||||
|
to the caller and is only ever passed back to `delete`."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def delete(self, owner_repo: str, key_id: str) -> None:
|
||||||
|
"""Delete the registered deploy key.
|
||||||
|
|
||||||
|
Must not raise if the key is already absent (HTTP 404 is
|
||||||
|
success). Must raise for all other failures so teardown halts."""
|
||||||
|
|
||||||
|
|
||||||
|
def get_provisioner(
|
||||||
|
provider: str, token: str, api_url: str
|
||||||
|
) -> DeployKeyProvisioner:
|
||||||
|
"""Instantiate the contrib provisioner for `provider`.
|
||||||
|
|
||||||
|
Raises `ManifestError` for unknown providers so the error surfaces
|
||||||
|
at parse time rather than at runtime."""
|
||||||
|
if provider == "gitea":
|
||||||
|
from bot_bottle.contrib.gitea.deploy_key_provisioner import (
|
||||||
|
GiteaDeployKeyProvisioner,
|
||||||
|
)
|
||||||
|
return GiteaDeployKeyProvisioner(token=token, api_url=api_url)
|
||||||
|
from .manifest_util import ManifestError
|
||||||
|
raise ManifestError(
|
||||||
|
f"unknown provisioned_key provider: {provider!r}; "
|
||||||
|
f"available: gitea"
|
||||||
|
)
|
||||||
@@ -0,0 +1,291 @@
|
|||||||
|
"""DLP detectors for the egress proxy (PRD 0053).
|
||||||
|
|
||||||
|
Pure Python, no mitmproxy dependency. Each detector is a module-level
|
||||||
|
function returning `ScanResult | None`.
|
||||||
|
|
||||||
|
Ships flat into the sidecar bundle image alongside
|
||||||
|
`egress_addon_core.py` — both this file and the package source use
|
||||||
|
the same try/except import shim pattern.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import gzip
|
||||||
|
import re
|
||||||
|
import typing
|
||||||
|
import unicodedata
|
||||||
|
from urllib.parse import quote as url_quote
|
||||||
|
|
||||||
|
try:
|
||||||
|
from egress_addon_core import ScanResult # type: ignore[import-not-found]
|
||||||
|
except ImportError: # pragma: no cover - host-side path
|
||||||
|
from .egress_addon_core import ScanResult
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Snippet helpers
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
SNIPPET_CONTEXT = 40 # chars of surrounding text to include on each side
|
||||||
|
REDACT = "********" # fixed-width replacement for the matched sensitive value
|
||||||
|
|
||||||
|
|
||||||
|
def _snippet(text: str, start: int, end: int) -> str:
|
||||||
|
"""Return context around a match with the matched span replaced by REDACT."""
|
||||||
|
before = text[max(0, start - SNIPPET_CONTEXT):start].replace("\n", " ").replace("\r", " ")
|
||||||
|
after = text[end:end + SNIPPET_CONTEXT].replace("\n", " ").replace("\r", " ")
|
||||||
|
return f"{before}{REDACT}{after}"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Unicode normalization (defeats confusable-char and combining-mark evasion)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _normalize_text(text: str) -> str:
|
||||||
|
# NFKD separates base characters from combining marks and resolves
|
||||||
|
# compatibility equivalents (fullwidth ASCII, ligatures, etc.)
|
||||||
|
decomposed = unicodedata.normalize("NFKD", text)
|
||||||
|
return "".join(
|
||||||
|
ch for ch in decomposed
|
||||||
|
# Strip combining marks inserted between chars to break patterns
|
||||||
|
if unicodedata.category(ch) != "Mn"
|
||||||
|
# Strip control chars; keep common whitespace (\n \r \t)
|
||||||
|
and (unicodedata.category(ch) != "Cc" or ch in "\n\r\t")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Token patterns detector
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
TOKEN_PATTERNS: tuple[tuple[str, re.Pattern[str]], ...] = (
|
||||||
|
("AWS access key", re.compile(r"AKIA[0-9A-Z]{16}")),
|
||||||
|
("GitHub token (classic)", re.compile(r"ghp_[A-Za-z0-9_]{36}")),
|
||||||
|
("GitHub fine-grained token", re.compile(r"github_pat_[A-Za-z0-9_]{82}")),
|
||||||
|
("Anthropic API key", re.compile(r"sk-ant-[A-Za-z0-9\-_]{93}")),
|
||||||
|
("OpenAI API key", re.compile(r"sk-[A-Za-z0-9]{48}")),
|
||||||
|
("OpenAI project API key", re.compile(r"sk-proj-[A-Za-z0-9_\-]{48,}")),
|
||||||
|
("Stripe live key", re.compile(r"sk_live_[A-Za-z0-9]{24}")),
|
||||||
|
("Generic Bearer JWT", re.compile(r"Bearer\s+[A-Za-z0-9._\-]{50,}")),
|
||||||
|
("HuggingFace token", re.compile(r"hf_[A-Za-z0-9]{34,}")),
|
||||||
|
("Databricks token", re.compile(r"dapi[A-Za-z0-9]{32}")),
|
||||||
|
("Slack token", re.compile(r"xox[baprs]-[A-Za-z0-9]+-[A-Za-z0-9]+-[A-Za-z0-9]{24,}")),
|
||||||
|
("npm token", re.compile(r"npm_[A-Za-z0-9]{36}")),
|
||||||
|
("SendGrid API key", re.compile(r"SG\.[A-Za-z0-9_\-]{22}\.[A-Za-z0-9_\-]{43}")),
|
||||||
|
("PyPI token", re.compile(r"pypi-[A-Za-z0-9_\-]{80,}")),
|
||||||
|
("HashiCorp Vault token", re.compile(r"hvs\.[A-Za-z0-9_\-]{24,}")),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def scan_token_patterns(text: str, *, location: str = "body") -> ScanResult | None:
|
||||||
|
normalized = _normalize_text(text)
|
||||||
|
for name, pattern in TOKEN_PATTERNS:
|
||||||
|
m = pattern.search(normalized)
|
||||||
|
if m is not None:
|
||||||
|
return ScanResult(
|
||||||
|
severity="block",
|
||||||
|
reason=f"{name} found in {location}",
|
||||||
|
location=location,
|
||||||
|
context=_snippet(text, m.start(), m.end()),
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def redact_tokens(
|
||||||
|
text: str,
|
||||||
|
*,
|
||||||
|
env: typing.Mapping[str, str] | None = None,
|
||||||
|
) -> str:
|
||||||
|
"""Replace token pattern matches and (if env given) provisioned secrets with REDACT."""
|
||||||
|
for _, pattern in TOKEN_PATTERNS:
|
||||||
|
text = pattern.sub(REDACT, text)
|
||||||
|
if env is not None:
|
||||||
|
for key, value in env.items():
|
||||||
|
if key.startswith("EGRESS_TOKEN_") and value:
|
||||||
|
for variant in _encoded_variants(value):
|
||||||
|
text = text.replace(variant, REDACT)
|
||||||
|
return text
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Known secrets detector (Phase 1b)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _encoded_variants(secret: str) -> list[str]:
|
||||||
|
"""Return the secret plus common encoded variants for exfil detection."""
|
||||||
|
seen: set[str] = {secret}
|
||||||
|
variants: list[str] = [secret]
|
||||||
|
|
||||||
|
def _add(v: str) -> None:
|
||||||
|
if v not in seen:
|
||||||
|
seen.add(v)
|
||||||
|
variants.append(v)
|
||||||
|
|
||||||
|
secret_bytes = secret.encode("utf-8")
|
||||||
|
|
||||||
|
# Standard base64 — with and without padding
|
||||||
|
b64 = base64.b64encode(secret_bytes).decode("ascii")
|
||||||
|
_add(b64)
|
||||||
|
_add(b64.rstrip("="))
|
||||||
|
|
||||||
|
# URL-safe base64 (JWT/OAuth use -_ alphabet) — with and without padding
|
||||||
|
b64url = base64.urlsafe_b64encode(secret_bytes).decode("ascii")
|
||||||
|
_add(b64url)
|
||||||
|
_add(b64url.rstrip("="))
|
||||||
|
|
||||||
|
# URL percent-encoding
|
||||||
|
_add(url_quote(secret, safe=""))
|
||||||
|
|
||||||
|
# Hex — lowercase and uppercase
|
||||||
|
_add(secret_bytes.hex())
|
||||||
|
_add(secret_bytes.hex().upper())
|
||||||
|
|
||||||
|
# Base32 (TOTP seeds, some DNS-exfil channels)
|
||||||
|
_add(base64.b32encode(secret_bytes).decode("ascii"))
|
||||||
|
|
||||||
|
# gzip + base64 (deterministic: mtime=0); recognisable by H4sI prefix
|
||||||
|
_add(base64.b64encode(gzip.compress(secret_bytes, mtime=0)).decode("ascii"))
|
||||||
|
|
||||||
|
return variants
|
||||||
|
|
||||||
|
|
||||||
|
def scan_known_secrets(
|
||||||
|
text: str,
|
||||||
|
*,
|
||||||
|
location: str = "body",
|
||||||
|
env: typing.Mapping[str, str] | None = None,
|
||||||
|
) -> ScanResult | None:
|
||||||
|
if env is None:
|
||||||
|
return None
|
||||||
|
for key, value in env.items():
|
||||||
|
if not key.startswith("EGRESS_TOKEN_") or not value:
|
||||||
|
continue
|
||||||
|
for variant in _encoded_variants(value):
|
||||||
|
pos = text.find(variant)
|
||||||
|
if pos >= 0:
|
||||||
|
return ScanResult(
|
||||||
|
severity="block",
|
||||||
|
reason=f"provisioned secret from {key} found in {location}",
|
||||||
|
location=location,
|
||||||
|
context=_snippet(text, pos, pos + len(variant)),
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Naive prompt injection detector (Phase 2)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
DISCLOSURE_PHRASES: tuple[re.Pattern[str], ...] = (
|
||||||
|
re.compile(r"(?i)system\s+prompt"),
|
||||||
|
re.compile(r"(?i)my\s+instructions\s+are"),
|
||||||
|
re.compile(r"(?i)original\s+instructions"),
|
||||||
|
re.compile(r"(?i)secret\s+instructions"),
|
||||||
|
re.compile(r"(?i)hidden\s+rules"),
|
||||||
|
)
|
||||||
|
|
||||||
|
JAILBREAK_PHRASES: tuple[re.Pattern[str], ...] = (
|
||||||
|
re.compile(r"(?i)ignore\s+previous"),
|
||||||
|
re.compile(r"(?i)forget\s+everything"),
|
||||||
|
re.compile(r"(?i)disregard\s+(?:all\s+)?(?:previous|prior)"),
|
||||||
|
re.compile(r"(?i)pretend\s+you\s+are"),
|
||||||
|
re.compile(r"(?i)act\s+as\s+(?:if|though)"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
PROXIMITY_CHARS = 500
|
||||||
|
|
||||||
|
|
||||||
|
def _closest_pair(
|
||||||
|
a_matches: list[re.Match[str]],
|
||||||
|
b_matches: list[re.Match[str]],
|
||||||
|
) -> tuple[re.Match[str], re.Match[str]] | None:
|
||||||
|
"""Return the pair (a, b) with the smallest character gap, or None."""
|
||||||
|
best: tuple[re.Match[str], re.Match[str]] | None = None
|
||||||
|
best_gap: int | None = None
|
||||||
|
for a in a_matches:
|
||||||
|
for b in b_matches:
|
||||||
|
gap = max(0, max(a.start(), b.start()) - min(a.end(), b.end()))
|
||||||
|
if best_gap is None or gap < best_gap:
|
||||||
|
best_gap = gap
|
||||||
|
best = (a, b)
|
||||||
|
return best
|
||||||
|
|
||||||
|
|
||||||
|
def scan_naive_injection(text: str) -> ScanResult | None:
|
||||||
|
location = "response body"
|
||||||
|
disclosure_hits = [m for p in DISCLOSURE_PHRASES for m in p.finditer(text)]
|
||||||
|
jailbreak_hits = [m for p in JAILBREAK_PHRASES for m in p.finditer(text)]
|
||||||
|
|
||||||
|
if disclosure_hits and jailbreak_hits:
|
||||||
|
pair = _closest_pair(disclosure_hits, jailbreak_hits)
|
||||||
|
if pair is not None:
|
||||||
|
dist = max(0, max(pair[0].start(), pair[1].start()) - min(pair[0].end(), pair[1].end()))
|
||||||
|
if dist <= PROXIMITY_CHARS:
|
||||||
|
first = pair[0] if pair[0].start() <= pair[1].start() else pair[1]
|
||||||
|
return ScanResult(
|
||||||
|
severity="block",
|
||||||
|
reason=(
|
||||||
|
f"disclosure and jailbreak phrases within "
|
||||||
|
f"{dist} chars in {location}"
|
||||||
|
),
|
||||||
|
location=location,
|
||||||
|
context=_snippet(text, first.start(), first.end()),
|
||||||
|
)
|
||||||
|
|
||||||
|
if disclosure_hits:
|
||||||
|
m = disclosure_hits[0]
|
||||||
|
return ScanResult(
|
||||||
|
severity="warn",
|
||||||
|
reason=f"prompt disclosure phrase detected in {location}",
|
||||||
|
location=location,
|
||||||
|
context=_snippet(text, m.start(), m.end()),
|
||||||
|
)
|
||||||
|
|
||||||
|
if jailbreak_hits:
|
||||||
|
m = jailbreak_hits[0]
|
||||||
|
return ScanResult(
|
||||||
|
severity="warn",
|
||||||
|
reason=f"jailbreak phrase detected in {location}",
|
||||||
|
location=location,
|
||||||
|
context=_snippet(text, m.start(), m.end()),
|
||||||
|
)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# CRLF injection detector
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# URL-encoded CRLF is never legitimate in a request URL or header value.
|
||||||
|
_CRLF_ENCODED_RE = re.compile(r"%0[dD]%0[aA]", re.ASCII)
|
||||||
|
# Literal CRLF followed by a header-name pattern indicates header injection.
|
||||||
|
_CRLF_HEADER_INJECT_RE = re.compile(r"\r\n[A-Za-z][A-Za-z0-9\-]+\s*:", re.ASCII)
|
||||||
|
|
||||||
|
|
||||||
|
def scan_crlf_injection(text: str) -> ScanResult | None:
|
||||||
|
if _CRLF_ENCODED_RE.search(text):
|
||||||
|
return ScanResult(
|
||||||
|
severity="block",
|
||||||
|
reason="URL-encoded CRLF (%0d%0a) in outbound request",
|
||||||
|
)
|
||||||
|
if _CRLF_HEADER_INJECT_RE.search(text):
|
||||||
|
return ScanResult(
|
||||||
|
severity="block",
|
||||||
|
reason="CRLF header injection pattern in outbound request",
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"REDACT",
|
||||||
|
"SNIPPET_CONTEXT",
|
||||||
|
"TOKEN_PATTERNS",
|
||||||
|
"redact_tokens",
|
||||||
|
"scan_crlf_injection",
|
||||||
|
"scan_known_secrets",
|
||||||
|
"scan_naive_injection",
|
||||||
|
"scan_token_patterns",
|
||||||
|
]
|
||||||
@@ -0,0 +1,321 @@
|
|||||||
|
"""Per-bottle egress proxy (PRD 0017, PRD 0053).
|
||||||
|
|
||||||
|
This module defines the abstract proxy (`Egress`), its plan
|
||||||
|
dataclass (`EgressPlan`), and the resolved per-route shape
|
||||||
|
(`EgressRoute`). The sidecar's start/stop lifecycle is backend-
|
||||||
|
specific and lives on concrete subclasses (see
|
||||||
|
`bot_bottle/backend/docker/egress.py`).
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import dataclasses
|
||||||
|
from abc import ABC
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from .egress_addon_core import (
|
||||||
|
HeaderMatch as CoreHeaderMatch,
|
||||||
|
MatchEntry as CoreMatchEntry,
|
||||||
|
PathMatch as CorePathMatch,
|
||||||
|
Route,
|
||||||
|
)
|
||||||
|
from .log import die
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from .manifest import ManifestBottle
|
||||||
|
|
||||||
|
CODEX_HOST_CREDENTIAL_TOKEN_REF = "BOT_BOTTLE_CODEX_HOST_ACCESS_TOKEN"
|
||||||
|
|
||||||
|
EGRESS_HOSTNAME = "egress"
|
||||||
|
|
||||||
|
EGRESS_ROUTES_IN_CONTAINER = "/etc/egress/routes.yaml"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class EgressRoute(Route):
|
||||||
|
"""Host-side extension of the addon's `Route`.
|
||||||
|
|
||||||
|
Inherits `host`, `matches`, `auth_scheme`, and `token_env`
|
||||||
|
from `egress_addon_core.Route` — those are the fields that cross the
|
||||||
|
YAML wire into the sidecar. The fields below are host-only and
|
||||||
|
are never serialised to the addon.
|
||||||
|
|
||||||
|
`token_ref` is the host env var the CLI reads at launch and forwards
|
||||||
|
into the container's environ under `token_env`.
|
||||||
|
|
||||||
|
`roles` carries the manifest route's role tuple (reserved for
|
||||||
|
future use; always empty today)."""
|
||||||
|
|
||||||
|
token_ref: str = ""
|
||||||
|
roles: tuple[str, ...] = ()
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class EgressPlan:
|
||||||
|
slug: str
|
||||||
|
routes_path: Path
|
||||||
|
routes: tuple[EgressRoute, ...]
|
||||||
|
token_env_map: dict[str, str]
|
||||||
|
internal_network: str = ""
|
||||||
|
egress_network: str = ""
|
||||||
|
mitmproxy_ca_host_path: Path = Path()
|
||||||
|
mitmproxy_ca_cert_only_host_path: Path = Path()
|
||||||
|
log: int = 0
|
||||||
|
|
||||||
|
|
||||||
|
def egress_manifest_routes(
|
||||||
|
bottle: ManifestBottle,
|
||||||
|
) -> tuple[EgressRoute, ...]:
|
||||||
|
out: list[EgressRoute] = []
|
||||||
|
for r in bottle.egress.routes:
|
||||||
|
core_matches: list[CoreMatchEntry] = []
|
||||||
|
for m in r.Matches:
|
||||||
|
core_paths = tuple(
|
||||||
|
CorePathMatch(type=p.Type, value=p.Value)
|
||||||
|
for p in m.Paths
|
||||||
|
)
|
||||||
|
core_headers = tuple(
|
||||||
|
CoreHeaderMatch(name=h.Name, value=h.Value, type=h.Type)
|
||||||
|
for h in m.Headers
|
||||||
|
)
|
||||||
|
core_matches.append(CoreMatchEntry(
|
||||||
|
paths=core_paths,
|
||||||
|
methods=m.Methods,
|
||||||
|
headers=core_headers,
|
||||||
|
))
|
||||||
|
out.append(EgressRoute(
|
||||||
|
host=r.Host,
|
||||||
|
matches=tuple(core_matches),
|
||||||
|
auth_scheme=r.AuthScheme,
|
||||||
|
token_ref=r.TokenRef,
|
||||||
|
roles=r.Role,
|
||||||
|
git_fetch=r.GitFetch,
|
||||||
|
outbound_detectors=r.OutboundDetectors,
|
||||||
|
inbound_detectors=r.InboundDetectors,
|
||||||
|
))
|
||||||
|
return tuple(out)
|
||||||
|
|
||||||
|
|
||||||
|
def egress_routes_for_bottle(
|
||||||
|
bottle: ManifestBottle,
|
||||||
|
provider_routes: tuple[EgressRoute, ...] = (),
|
||||||
|
) -> tuple[EgressRoute, ...]:
|
||||||
|
manifest = egress_manifest_routes(bottle)
|
||||||
|
provisioned_hosts = {pr.host.lower() for pr in provider_routes}
|
||||||
|
merged = list(provider_routes) + [
|
||||||
|
r for r in manifest if r.host.lower() not in provisioned_hosts
|
||||||
|
]
|
||||||
|
return _assign_token_slots(merged)
|
||||||
|
|
||||||
|
|
||||||
|
def _assign_token_slots(
|
||||||
|
routes: list[EgressRoute],
|
||||||
|
) -> tuple[EgressRoute, ...]:
|
||||||
|
slot_for_ref: dict[str, str] = {}
|
||||||
|
out: list[EgressRoute] = []
|
||||||
|
for r in routes:
|
||||||
|
if r.auth_scheme and r.token_ref:
|
||||||
|
slot = slot_for_ref.get(r.token_ref)
|
||||||
|
if slot is None:
|
||||||
|
slot = f"EGRESS_TOKEN_{len(slot_for_ref)}"
|
||||||
|
slot_for_ref[r.token_ref] = slot
|
||||||
|
out.append(dataclasses.replace(r, token_env=slot))
|
||||||
|
else:
|
||||||
|
out.append(r)
|
||||||
|
return tuple(out)
|
||||||
|
|
||||||
|
|
||||||
|
def egress_token_env_map(
|
||||||
|
routes: tuple[EgressRoute, ...],
|
||||||
|
) -> dict[str, str]:
|
||||||
|
out: dict[str, str] = {}
|
||||||
|
for r in routes:
|
||||||
|
if not (r.auth_scheme and r.token_ref and r.token_env):
|
||||||
|
continue
|
||||||
|
existing = out.get(r.token_env)
|
||||||
|
if existing is not None and existing != r.token_ref:
|
||||||
|
die(
|
||||||
|
f"egress plan conflict: {r.token_env} maps to both "
|
||||||
|
f"{existing!r} and {r.token_ref!r}. Two routes sharing a "
|
||||||
|
f"token slot must reference the same host env var."
|
||||||
|
)
|
||||||
|
out[r.token_env] = r.token_ref
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def _route_to_yaml_fields(r: Route) -> dict[str, object]:
|
||||||
|
fields: dict[str, object] = {"host": r.host}
|
||||||
|
if r.auth_scheme and r.token_env:
|
||||||
|
fields["auth_scheme"] = r.auth_scheme
|
||||||
|
fields["token_env"] = r.token_env
|
||||||
|
if r.matches:
|
||||||
|
matches_data: list[dict[str, object]] = []
|
||||||
|
for entry in r.matches:
|
||||||
|
entry_data: dict[str, object] = {}
|
||||||
|
if entry.paths:
|
||||||
|
paths_data: list[dict[str, str]] = []
|
||||||
|
for pm in entry.paths:
|
||||||
|
pd: dict[str, str] = {"value": pm.value}
|
||||||
|
if pm.type != "prefix":
|
||||||
|
pd["type"] = pm.type
|
||||||
|
paths_data.append(pd)
|
||||||
|
entry_data["paths"] = paths_data
|
||||||
|
if entry.methods:
|
||||||
|
entry_data["methods"] = list(entry.methods)
|
||||||
|
if entry.headers:
|
||||||
|
headers_data: list[dict[str, str]] = []
|
||||||
|
for hm in entry.headers:
|
||||||
|
hd: dict[str, str] = {"name": hm.name, "value": hm.value}
|
||||||
|
if hm.type != "exact":
|
||||||
|
hd["type"] = hm.type
|
||||||
|
headers_data.append(hd)
|
||||||
|
entry_data["headers"] = headers_data
|
||||||
|
matches_data.append(entry_data)
|
||||||
|
fields["matches"] = matches_data
|
||||||
|
if r.git_fetch:
|
||||||
|
fields["git"] = {"fetch": True}
|
||||||
|
if r.outbound_detectors is not None or r.inbound_detectors is not None:
|
||||||
|
dlp: dict[str, object] = {}
|
||||||
|
if r.outbound_detectors is not None:
|
||||||
|
dlp["outbound_detectors"] = (
|
||||||
|
False if not r.outbound_detectors
|
||||||
|
else list(r.outbound_detectors)
|
||||||
|
)
|
||||||
|
if r.inbound_detectors is not None:
|
||||||
|
dlp["inbound_detectors"] = (
|
||||||
|
False if not r.inbound_detectors
|
||||||
|
else list(r.inbound_detectors)
|
||||||
|
)
|
||||||
|
fields["dlp"] = dlp
|
||||||
|
return fields
|
||||||
|
|
||||||
|
|
||||||
|
def _render_match_entry(entry: dict[str, object]) -> list[str]:
|
||||||
|
lines: list[str] = []
|
||||||
|
first_key = True
|
||||||
|
if "paths" in entry:
|
||||||
|
lines.append(" - paths:")
|
||||||
|
first_key = False
|
||||||
|
for pd in entry["paths"]: # type: ignore[union-attr]
|
||||||
|
pd_dict: dict[str, str] = pd # type: ignore[assignment]
|
||||||
|
if "type" in pd_dict:
|
||||||
|
lines.append(f' - type: "{pd_dict["type"]}"')
|
||||||
|
lines.append(f' value: "{pd_dict["value"]}"')
|
||||||
|
else:
|
||||||
|
lines.append(f' - value: "{pd_dict["value"]}"')
|
||||||
|
if "methods" in entry:
|
||||||
|
methods_str = ", ".join(f'"{m}"' for m in entry["methods"]) # type: ignore[union-attr]
|
||||||
|
prefix = " - " if first_key else " "
|
||||||
|
lines.append(f'{prefix}methods: [{methods_str}]')
|
||||||
|
first_key = False
|
||||||
|
if "headers" in entry:
|
||||||
|
prefix = " - " if first_key else " "
|
||||||
|
lines.append(f"{prefix}headers:")
|
||||||
|
first_key = False
|
||||||
|
for hd in entry["headers"]: # type: ignore[union-attr]
|
||||||
|
hd_dict: dict[str, str] = hd # type: ignore[assignment]
|
||||||
|
lines.append(f' - name: "{hd_dict["name"]}"')
|
||||||
|
lines.append(f' value: "{hd_dict["value"]}"')
|
||||||
|
if first_key:
|
||||||
|
lines.append(" - {}")
|
||||||
|
return lines
|
||||||
|
|
||||||
|
|
||||||
|
def egress_render_routes(
|
||||||
|
routes: tuple[EgressRoute, ...],
|
||||||
|
*,
|
||||||
|
log: int = 0,
|
||||||
|
) -> str:
|
||||||
|
lines: list[str] = []
|
||||||
|
if log:
|
||||||
|
lines.append(f"log: {log}")
|
||||||
|
lines.append("routes:")
|
||||||
|
if not routes:
|
||||||
|
lines[-1] = "routes: []"
|
||||||
|
return "\n".join(lines) + "\n"
|
||||||
|
for r in routes:
|
||||||
|
f = _route_to_yaml_fields(r)
|
||||||
|
lines.append(f' - host: "{f["host"]}"')
|
||||||
|
if "auth_scheme" in f:
|
||||||
|
lines.append(f' auth_scheme: "{f["auth_scheme"]}"')
|
||||||
|
lines.append(f' token_env: "{f["token_env"]}"')
|
||||||
|
if "matches" in f:
|
||||||
|
lines.append(" matches:")
|
||||||
|
for entry in f["matches"]: # type: ignore[union-attr]
|
||||||
|
lines.extend(_render_match_entry(entry)) # type: ignore[arg-type]
|
||||||
|
if "git" in f:
|
||||||
|
git_dict: dict[str, object] = f["git"] # type: ignore
|
||||||
|
lines.append(" git:")
|
||||||
|
if git_dict.get("fetch") is True:
|
||||||
|
lines.append(" fetch: true")
|
||||||
|
if "dlp" in f:
|
||||||
|
dlp_dict: dict[str, object] = f["dlp"] # type: ignore
|
||||||
|
lines.append(" dlp:")
|
||||||
|
for dk, dv in dlp_dict.items():
|
||||||
|
if dv is False:
|
||||||
|
lines.append(f" {dk}: false")
|
||||||
|
elif isinstance(dv, list):
|
||||||
|
items_str = ", ".join(f'"{x}"' for x in dv)
|
||||||
|
lines.append(f" {dk}: [{items_str}]")
|
||||||
|
return "\n".join(lines) + "\n"
|
||||||
|
|
||||||
|
|
||||||
|
def egress_resolve_token_values(
|
||||||
|
token_env_map: dict[str, str],
|
||||||
|
host_env: dict[str, str],
|
||||||
|
) -> dict[str, str]:
|
||||||
|
out: dict[str, str] = {}
|
||||||
|
for token_env, token_ref in token_env_map.items():
|
||||||
|
value = host_env.get(token_ref)
|
||||||
|
if value is None:
|
||||||
|
die(
|
||||||
|
f"egress: host env var '{token_ref}' is unset. Set it "
|
||||||
|
f"before launching, or remove the corresponding auth block "
|
||||||
|
f"from bottle.egress.routes."
|
||||||
|
)
|
||||||
|
if not value:
|
||||||
|
die(
|
||||||
|
f"egress: host env var '{token_ref}' is empty. The "
|
||||||
|
f"egress will not inject an empty token; set it to "
|
||||||
|
f"the real value or remove the route's auth block."
|
||||||
|
)
|
||||||
|
out[token_env] = value
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
class Egress(ABC):
|
||||||
|
def prepare(
|
||||||
|
self,
|
||||||
|
bottle: ManifestBottle,
|
||||||
|
slug: str,
|
||||||
|
stage_dir: Path,
|
||||||
|
provider_routes: tuple[EgressRoute, ...] = (),
|
||||||
|
) -> EgressPlan:
|
||||||
|
routes = egress_routes_for_bottle(bottle, provider_routes)
|
||||||
|
log = bottle.egress.Log
|
||||||
|
routes_path = stage_dir / "egress_routes.yaml"
|
||||||
|
routes_path.write_text(egress_render_routes(routes, log=log))
|
||||||
|
routes_path.chmod(0o600)
|
||||||
|
return EgressPlan(
|
||||||
|
slug=slug,
|
||||||
|
routes_path=routes_path,
|
||||||
|
routes=routes,
|
||||||
|
token_env_map=egress_token_env_map(routes),
|
||||||
|
log=log,
|
||||||
|
)
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"CODEX_HOST_CREDENTIAL_TOKEN_REF",
|
||||||
|
"EGRESS_HOSTNAME",
|
||||||
|
"EGRESS_ROUTES_IN_CONTAINER",
|
||||||
|
"Egress",
|
||||||
|
"EgressPlan",
|
||||||
|
"EgressRoute",
|
||||||
|
"egress_manifest_routes",
|
||||||
|
"egress_render_routes",
|
||||||
|
"egress_resolve_token_values",
|
||||||
|
"egress_routes_for_bottle",
|
||||||
|
"egress_token_env_map",
|
||||||
|
]
|
||||||
@@ -0,0 +1,289 @@
|
|||||||
|
"""mitmproxy addon entrypoint for the egress sidecar (PRD 0017, PRD 0053).
|
||||||
|
|
||||||
|
Loaded by `mitmdump -s /app/egress_addon.py` inside the
|
||||||
|
egress container."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import dataclasses
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from mitmproxy import http # type: ignore[import-not-found] # pylint: disable=import-error
|
||||||
|
|
||||||
|
from egress_addon_core import ( # type: ignore[import-not-found] # pylint: disable=import-error
|
||||||
|
LOG_BLOCKS,
|
||||||
|
LOG_FULL,
|
||||||
|
Config,
|
||||||
|
build_inbound_scan_text,
|
||||||
|
build_outbound_scan_text,
|
||||||
|
decide,
|
||||||
|
decide_git_fetch,
|
||||||
|
is_git_fetch_request,
|
||||||
|
is_git_push_request,
|
||||||
|
load_config,
|
||||||
|
match_route,
|
||||||
|
outbound_scan_headers,
|
||||||
|
scan_inbound,
|
||||||
|
scan_outbound,
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
from dlp_detectors import redact_tokens # type: ignore[import-not-found]
|
||||||
|
except ImportError: # pragma: no cover - host-side path
|
||||||
|
from bot_bottle.dlp_detectors import redact_tokens # type: ignore[import-not-found]
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_ROUTES_PATH = "/etc/egress/routes.yaml"
|
||||||
|
|
||||||
|
INTROSPECT_HOST = "_egress.local"
|
||||||
|
|
||||||
|
|
||||||
|
class EgressAddon:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.routes_path = os.environ.get("EGRESS_ROUTES", DEFAULT_ROUTES_PATH)
|
||||||
|
self.config: Config = Config(routes=())
|
||||||
|
self._reload(initial=True)
|
||||||
|
self._install_sighup()
|
||||||
|
|
||||||
|
def _reload(self, *, initial: bool = False) -> None:
|
||||||
|
try:
|
||||||
|
text = Path(self.routes_path).read_text(encoding="utf-8")
|
||||||
|
new_config = load_config(text)
|
||||||
|
except (OSError, ValueError) as e:
|
||||||
|
tag = "boot" if initial else "SIGHUP"
|
||||||
|
sys.stderr.write(
|
||||||
|
f"egress: {tag} load failed: {e}\n"
|
||||||
|
)
|
||||||
|
if initial:
|
||||||
|
self.config = Config(routes=())
|
||||||
|
return
|
||||||
|
self.config = new_config
|
||||||
|
log_label = ("off", "blocks", "full")[self.config.log]
|
||||||
|
sys.stderr.write(
|
||||||
|
f"egress: loaded {len(self.config.routes)} route(s): "
|
||||||
|
f"{', '.join(r.host for r in self.config.routes)}"
|
||||||
|
f" [log={log_label}]\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _install_sighup(self) -> None:
|
||||||
|
if not hasattr(signal, "SIGHUP"):
|
||||||
|
return
|
||||||
|
|
||||||
|
def handler(signum: int, frame: object) -> None:
|
||||||
|
del signum, frame
|
||||||
|
self._reload()
|
||||||
|
|
||||||
|
signal.signal(signal.SIGHUP, handler)
|
||||||
|
|
||||||
|
def _serve_introspection(self, flow: http.HTTPFlow, path: str) -> None:
|
||||||
|
if path == "/allowlist":
|
||||||
|
payload = json.dumps(
|
||||||
|
{"routes": [dataclasses.asdict(r) for r in self.config.routes]},
|
||||||
|
indent=2,
|
||||||
|
).encode("utf-8")
|
||||||
|
flow.response = http.Response.make(
|
||||||
|
200, payload,
|
||||||
|
{"Content-Type": "application/json"},
|
||||||
|
)
|
||||||
|
return
|
||||||
|
flow.response = http.Response.make(
|
||||||
|
404,
|
||||||
|
f"egress introspection: no such endpoint {path!r}".encode(),
|
||||||
|
{"Content-Type": "text/plain; charset=utf-8"},
|
||||||
|
)
|
||||||
|
|
||||||
|
def _req_ctx(self, flow: http.HTTPFlow) -> dict[str, object]:
|
||||||
|
return {
|
||||||
|
"host": redact_tokens(flow.request.pretty_host, env=os.environ),
|
||||||
|
"method": flow.request.method,
|
||||||
|
"path": redact_tokens(flow.request.path, env=os.environ),
|
||||||
|
}
|
||||||
|
|
||||||
|
def _block(
|
||||||
|
self,
|
||||||
|
flow: http.HTTPFlow,
|
||||||
|
reason: str,
|
||||||
|
ctx: dict[str, object] | None = None,
|
||||||
|
) -> None:
|
||||||
|
if self.config.log >= LOG_BLOCKS:
|
||||||
|
entry: dict[str, object] = {"event": "egress_block", "reason": reason}
|
||||||
|
if ctx:
|
||||||
|
entry.update(ctx)
|
||||||
|
sys.stderr.write(json.dumps(entry) + "\n")
|
||||||
|
flow.response = http.Response.make(
|
||||||
|
403,
|
||||||
|
reason.encode("utf-8"),
|
||||||
|
{"Content-Type": "text/plain; charset=utf-8"},
|
||||||
|
)
|
||||||
|
|
||||||
|
def _log_request(self, flow: http.HTTPFlow) -> None:
|
||||||
|
sys.stderr.write(
|
||||||
|
json.dumps({
|
||||||
|
"event": "egress_request",
|
||||||
|
"host": redact_tokens(flow.request.pretty_host, env=os.environ),
|
||||||
|
"method": flow.request.method,
|
||||||
|
"path": redact_tokens(flow.request.path, env=os.environ),
|
||||||
|
"headers": dict(flow.request.headers),
|
||||||
|
"body": flow.request.get_text(strict=False) or "",
|
||||||
|
})
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _log_response(self, flow: http.HTTPFlow) -> None:
|
||||||
|
sys.stderr.write(
|
||||||
|
json.dumps({
|
||||||
|
"event": "egress_response",
|
||||||
|
"host": flow.request.pretty_host,
|
||||||
|
"status": flow.response.status_code,
|
||||||
|
"headers": dict(flow.response.headers),
|
||||||
|
"body": flow.response.get_text(strict=False) or "",
|
||||||
|
})
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def request(self, flow: http.HTTPFlow) -> None:
|
||||||
|
request_path, _, query = flow.request.path.partition("?")
|
||||||
|
|
||||||
|
if flow.request.pretty_host == INTROSPECT_HOST:
|
||||||
|
self._serve_introspection(flow, request_path)
|
||||||
|
return
|
||||||
|
|
||||||
|
# DLP outbound scan BEFORE stripping auth — catches tokens the
|
||||||
|
# agent tried to smuggle in any header, path, query param, or body.
|
||||||
|
# Hostname is included to catch DNS-tunnelling exfiltration attempts.
|
||||||
|
route = match_route(self.config.routes, flow.request.pretty_host)
|
||||||
|
if route is not None:
|
||||||
|
body = flow.request.get_text(strict=False) or ""
|
||||||
|
scan_text = build_outbound_scan_text(
|
||||||
|
flow.request.pretty_host,
|
||||||
|
request_path,
|
||||||
|
query,
|
||||||
|
outbound_scan_headers(route, dict(flow.request.headers)),
|
||||||
|
body,
|
||||||
|
)
|
||||||
|
dlp_result = scan_outbound(route, scan_text, os.environ)
|
||||||
|
if dlp_result is not None and dlp_result.severity == "block":
|
||||||
|
ctx = self._req_ctx(flow)
|
||||||
|
if dlp_result.context:
|
||||||
|
ctx = {**ctx, "context": dlp_result.context}
|
||||||
|
self._block(flow, f"egress DLP: {dlp_result.reason}", ctx=ctx)
|
||||||
|
return
|
||||||
|
|
||||||
|
if is_git_push_request(request_path, query):
|
||||||
|
self._block(
|
||||||
|
flow,
|
||||||
|
"egress: git push over HTTPS is not supported; "
|
||||||
|
"use the bottle.git SSH path (gitleaks-scanned by "
|
||||||
|
"git-gate's pre-receive hook).",
|
||||||
|
ctx=self._req_ctx(flow),
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
if is_git_fetch_request(request_path, query):
|
||||||
|
git_decision = decide_git_fetch(
|
||||||
|
self.config.routes, flow.request.pretty_host,
|
||||||
|
)
|
||||||
|
if git_decision.action == "block":
|
||||||
|
self._block(
|
||||||
|
flow,
|
||||||
|
git_decision.reason,
|
||||||
|
ctx=self._req_ctx(flow),
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
# Strip agent-set Authorization after DLP scan so smuggled tokens
|
||||||
|
# are caught above; the route may inject sidecar-owned auth below.
|
||||||
|
flow.request.headers.pop("authorization", None)
|
||||||
|
|
||||||
|
# Build headers mapping for match evaluation
|
||||||
|
req_headers = {k.lower(): v for k, v in flow.request.headers.items()}
|
||||||
|
|
||||||
|
decision = decide(
|
||||||
|
self.config.routes,
|
||||||
|
flow.request.pretty_host,
|
||||||
|
request_path,
|
||||||
|
os.environ,
|
||||||
|
request_method=flow.request.method,
|
||||||
|
request_headers=req_headers,
|
||||||
|
)
|
||||||
|
|
||||||
|
if decision.action == "block":
|
||||||
|
self._block(flow, decision.reason, ctx=self._req_ctx(flow))
|
||||||
|
return
|
||||||
|
|
||||||
|
if decision.inject_authorization is not None:
|
||||||
|
flow.request.headers["authorization"] = decision.inject_authorization
|
||||||
|
|
||||||
|
if self.config.log >= LOG_FULL:
|
||||||
|
self._log_request(flow)
|
||||||
|
|
||||||
|
def response(self, flow: http.HTTPFlow) -> None:
|
||||||
|
"""DLP inbound scan on response headers and body."""
|
||||||
|
route = match_route(self.config.routes, flow.request.pretty_host)
|
||||||
|
if route is None:
|
||||||
|
return
|
||||||
|
if flow.response is None:
|
||||||
|
return
|
||||||
|
if self.config.log >= LOG_FULL:
|
||||||
|
self._log_response(flow)
|
||||||
|
resp_headers = {k.lower(): v for k, v in flow.response.headers.items()}
|
||||||
|
body = flow.response.get_text(strict=False) or ""
|
||||||
|
scan_text = build_inbound_scan_text(resp_headers, body)
|
||||||
|
if not scan_text:
|
||||||
|
return
|
||||||
|
result = scan_inbound(route, scan_text)
|
||||||
|
if result is None:
|
||||||
|
return
|
||||||
|
resp_ctx: dict[str, object] = {
|
||||||
|
**self._req_ctx(flow),
|
||||||
|
"response_status": flow.response.status_code,
|
||||||
|
}
|
||||||
|
if result.context:
|
||||||
|
resp_ctx = {**resp_ctx, "context": result.context}
|
||||||
|
if result.severity == "block":
|
||||||
|
self._block(flow, f"egress DLP: {result.reason}", ctx=resp_ctx)
|
||||||
|
elif result.severity == "warn" and self.config.log >= LOG_BLOCKS:
|
||||||
|
sys.stderr.write(
|
||||||
|
json.dumps({
|
||||||
|
"event": "egress_warn",
|
||||||
|
"reason": f"egress DLP: {result.reason}",
|
||||||
|
**resp_ctx,
|
||||||
|
})
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def websocket_message(self, flow: http.HTTPFlow) -> None:
|
||||||
|
"""DLP scan on WebSocket frames.
|
||||||
|
|
||||||
|
Outbound frames (from_client) are scanned for credential leakage;
|
||||||
|
inbound frames are scanned for prompt injection. On a block the
|
||||||
|
entire connection is killed — there is no HTTP response surface to
|
||||||
|
write to after the upgrade.
|
||||||
|
"""
|
||||||
|
if flow.websocket is None: # type: ignore[union-attr]
|
||||||
|
return
|
||||||
|
route = match_route(self.config.routes, flow.request.pretty_host)
|
||||||
|
if route is None:
|
||||||
|
return
|
||||||
|
message = flow.websocket.messages[-1] # type: ignore[union-attr]
|
||||||
|
content = message.content.decode("utf-8", errors="replace")
|
||||||
|
if message.from_client:
|
||||||
|
result = scan_outbound(route, content, os.environ)
|
||||||
|
if result is not None and result.severity == "block":
|
||||||
|
sys.stderr.write(f"egress DLP: {result.reason}\n")
|
||||||
|
flow.kill() # type: ignore[union-attr]
|
||||||
|
else:
|
||||||
|
result = scan_inbound(route, content)
|
||||||
|
if result is not None:
|
||||||
|
if result.severity == "block":
|
||||||
|
sys.stderr.write(f"egress DLP: {result.reason}\n")
|
||||||
|
flow.kill() # type: ignore[union-attr]
|
||||||
|
elif result.severity == "warn":
|
||||||
|
sys.stderr.write(f"egress DLP warn: {result.reason}\n")
|
||||||
|
|
||||||
|
|
||||||
|
addons = [EgressAddon()]
|
||||||
@@ -0,0 +1,725 @@
|
|||||||
|
"""Pure logic for the egress mitmproxy addon (PRD 0017, PRD 0053).
|
||||||
|
|
||||||
|
Split out of `egress_addon.py` so the host's unit tests can
|
||||||
|
exercise the parse + decision functions without depending on the
|
||||||
|
`mitmproxy` package. The companion module wraps these with the
|
||||||
|
`mitmproxy.http.HTTPFlow` API and is loaded inside the sidecar
|
||||||
|
container.
|
||||||
|
|
||||||
|
Imports: stdlib + `yaml_subset` (which is itself stdlib-only and
|
||||||
|
ships flat into the sidecar bundle image alongside this file —
|
||||||
|
see `Dockerfile.sidecars`)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import re
|
||||||
|
import typing
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
try:
|
||||||
|
from yaml_subset import YamlSubsetError, parse_yaml_subset # type: ignore[import-not-found]
|
||||||
|
except ImportError: # pragma: no cover - host-side path
|
||||||
|
from .yaml_subset import YamlSubsetError, parse_yaml_subset
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Match types (Gateway API HTTPRoute vocabulary, PRD 0053)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
PATH_MATCH_TYPES = ("exact", "prefix", "regex")
|
||||||
|
HEADER_MATCH_TYPES = ("exact", "regex")
|
||||||
|
|
||||||
|
VALID_METHODS = frozenset({
|
||||||
|
"GET", "HEAD", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "TRACE",
|
||||||
|
"CONNECT",
|
||||||
|
})
|
||||||
|
|
||||||
|
OUTBOUND_DETECTOR_NAMES = frozenset({"token_patterns", "known_secrets"})
|
||||||
|
INBOUND_DETECTOR_NAMES = frozenset({"naive_injection_detection"})
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class PathMatch:
|
||||||
|
type: str # "exact" | "prefix" | "regex"
|
||||||
|
value: str
|
||||||
|
compiled: re.Pattern[str] | None = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class HeaderMatch:
|
||||||
|
name: str
|
||||||
|
value: str
|
||||||
|
type: str = "exact" # "exact" | "regex"
|
||||||
|
compiled: re.Pattern[str] | None = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class MatchEntry:
|
||||||
|
paths: tuple[PathMatch, ...] = ()
|
||||||
|
methods: tuple[str, ...] = ()
|
||||||
|
headers: tuple[HeaderMatch, ...] = ()
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Route:
|
||||||
|
host: str
|
||||||
|
matches: tuple[MatchEntry, ...] = ()
|
||||||
|
auth_scheme: str = ""
|
||||||
|
token_env: str = ""
|
||||||
|
git_fetch: bool = False
|
||||||
|
outbound_detectors: tuple[str, ...] | None = None
|
||||||
|
inbound_detectors: tuple[str, ...] | None = None
|
||||||
|
|
||||||
|
|
||||||
|
LOG_OFF = 0 # no logging
|
||||||
|
LOG_BLOCKS = 1 # log block/warn events with request context
|
||||||
|
LOG_FULL = 2 # log block/warn events + full request and response bodies
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Config:
|
||||||
|
routes: tuple[Route, ...]
|
||||||
|
log: int = LOG_OFF
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Decision:
|
||||||
|
action: str # "forward" or "block"
|
||||||
|
reason: str = ""
|
||||||
|
inject_authorization: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ScanResult:
|
||||||
|
severity: str # "block" or "warn"
|
||||||
|
reason: str
|
||||||
|
location: str = "" # where the match was found, e.g. "body", "authorization header"
|
||||||
|
context: str = "" # surrounding text with the match replaced by REDACT
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Parsing
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _parse_path_match(idx: int, j: int, raw: object) -> PathMatch:
|
||||||
|
label = f"route[{idx}] matches paths[{j}]"
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
raise ValueError(f"{label}: must be an object")
|
||||||
|
raw_dict: dict[str, object] = typing.cast(dict[str, object], raw)
|
||||||
|
ptype = raw_dict.get("type", "prefix")
|
||||||
|
if not isinstance(ptype, str) or ptype not in PATH_MATCH_TYPES:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: 'type' must be one of {', '.join(PATH_MATCH_TYPES)} "
|
||||||
|
f"(got {ptype!r})"
|
||||||
|
)
|
||||||
|
value = raw_dict.get("value")
|
||||||
|
if not isinstance(value, str) or not value:
|
||||||
|
raise ValueError(f"{label}: 'value' must be a non-empty string")
|
||||||
|
if ptype in ("exact", "prefix") and not value.startswith("/"):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: value {value!r} must start with '/' for "
|
||||||
|
f"type {ptype!r}"
|
||||||
|
)
|
||||||
|
compiled: re.Pattern[str] | None = None
|
||||||
|
if ptype == "regex":
|
||||||
|
try:
|
||||||
|
compiled = re.compile(value)
|
||||||
|
except re.error as e:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: regex {value!r} failed to compile: {e}"
|
||||||
|
) from e
|
||||||
|
for k in raw_dict:
|
||||||
|
if k not in ("type", "value"):
|
||||||
|
raise ValueError(f"{label}: unknown key {k!r}")
|
||||||
|
return PathMatch(type=ptype, value=value, compiled=compiled)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_header_match(idx: int, j: int, raw: object) -> HeaderMatch:
|
||||||
|
label = f"route[{idx}] matches headers[{j}]"
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
raise ValueError(f"{label}: must be an object")
|
||||||
|
raw_dict: dict[str, object] = typing.cast(dict[str, object], raw)
|
||||||
|
name = raw_dict.get("name")
|
||||||
|
if not isinstance(name, str) or not name:
|
||||||
|
raise ValueError(f"{label}: 'name' must be a non-empty string")
|
||||||
|
value = raw_dict.get("value")
|
||||||
|
if not isinstance(value, str):
|
||||||
|
raise ValueError(f"{label}: 'value' must be a string")
|
||||||
|
htype = raw_dict.get("type", "exact")
|
||||||
|
if not isinstance(htype, str) or htype not in HEADER_MATCH_TYPES:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: 'type' must be one of {', '.join(HEADER_MATCH_TYPES)} "
|
||||||
|
f"(got {htype!r})"
|
||||||
|
)
|
||||||
|
compiled: re.Pattern[str] | None = None
|
||||||
|
if htype == "regex":
|
||||||
|
try:
|
||||||
|
compiled = re.compile(value)
|
||||||
|
except re.error as e:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: regex {value!r} failed to compile: {e}"
|
||||||
|
) from e
|
||||||
|
for k in raw_dict:
|
||||||
|
if k not in ("name", "value", "type"):
|
||||||
|
raise ValueError(f"{label}: unknown key {k!r}")
|
||||||
|
return HeaderMatch(name=name, value=value, type=htype, compiled=compiled)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_match_entry(idx: int, k: int, raw: object) -> MatchEntry:
|
||||||
|
label = f"route[{idx}] matches[{k}]"
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
raise ValueError(f"{label}: must be an object")
|
||||||
|
raw_dict: dict[str, object] = typing.cast(dict[str, object], raw)
|
||||||
|
|
||||||
|
paths: tuple[PathMatch, ...] = ()
|
||||||
|
paths_raw = raw_dict.get("paths")
|
||||||
|
if paths_raw is not None:
|
||||||
|
if not isinstance(paths_raw, list):
|
||||||
|
raise ValueError(f"{label}: 'paths' must be a list")
|
||||||
|
paths_list = typing.cast(list[object], paths_raw)
|
||||||
|
paths = tuple(_parse_path_match(idx, j, p) for j, p in enumerate(paths_list))
|
||||||
|
|
||||||
|
methods: tuple[str, ...] = ()
|
||||||
|
methods_raw = raw_dict.get("methods")
|
||||||
|
if methods_raw is not None:
|
||||||
|
if not isinstance(methods_raw, list):
|
||||||
|
raise ValueError(f"{label}: 'methods' must be a list")
|
||||||
|
methods_list = typing.cast(list[object], methods_raw)
|
||||||
|
normalised: list[str] = []
|
||||||
|
for j, m in enumerate(methods_list):
|
||||||
|
if not isinstance(m, str):
|
||||||
|
raise ValueError(f"{label}: methods[{j}] must be a string")
|
||||||
|
upper = m.upper()
|
||||||
|
if upper not in VALID_METHODS:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: methods[{j}] {m!r} is not a valid HTTP method"
|
||||||
|
)
|
||||||
|
normalised.append(upper)
|
||||||
|
methods = tuple(normalised)
|
||||||
|
|
||||||
|
headers: tuple[HeaderMatch, ...] = ()
|
||||||
|
headers_raw = raw_dict.get("headers")
|
||||||
|
if headers_raw is not None:
|
||||||
|
if not isinstance(headers_raw, list):
|
||||||
|
raise ValueError(f"{label}: 'headers' must be a list")
|
||||||
|
headers_list = typing.cast(list[object], headers_raw)
|
||||||
|
headers = tuple(
|
||||||
|
_parse_header_match(idx, j, h) for j, h in enumerate(headers_list)
|
||||||
|
)
|
||||||
|
|
||||||
|
for key in raw_dict:
|
||||||
|
if key not in ("paths", "methods", "headers"):
|
||||||
|
raise ValueError(f"{label}: unknown key {key!r}")
|
||||||
|
|
||||||
|
return MatchEntry(paths=paths, methods=methods, headers=headers)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_detectors(
|
||||||
|
idx: int,
|
||||||
|
host: str,
|
||||||
|
raw_dict: dict[str, object],
|
||||||
|
) -> tuple[tuple[str, ...] | None, tuple[str, ...] | None]:
|
||||||
|
"""Parse the optional `dlp` block on a route, returning
|
||||||
|
(outbound_detectors, inbound_detectors)."""
|
||||||
|
dlp_raw = raw_dict.get("dlp")
|
||||||
|
if dlp_raw is None:
|
||||||
|
return None, None
|
||||||
|
label = f"route[{idx}] ({host})"
|
||||||
|
if not isinstance(dlp_raw, dict):
|
||||||
|
raise ValueError(f"{label}: 'dlp' must be an object")
|
||||||
|
dlp = typing.cast(dict[str, object], dlp_raw)
|
||||||
|
|
||||||
|
def _parse_detector_field(
|
||||||
|
field: str,
|
||||||
|
valid_names: frozenset[str],
|
||||||
|
) -> tuple[str, ...] | None:
|
||||||
|
val = dlp.get(field)
|
||||||
|
if val is None:
|
||||||
|
return None
|
||||||
|
if val is False:
|
||||||
|
return ()
|
||||||
|
if not isinstance(val, list):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: dlp.{field} must be false, a list, or omitted"
|
||||||
|
)
|
||||||
|
items = typing.cast(list[object], val)
|
||||||
|
names: list[str] = []
|
||||||
|
for j, item in enumerate(items):
|
||||||
|
if not isinstance(item, str):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: dlp.{field}[{j}] must be a string"
|
||||||
|
)
|
||||||
|
if item not in valid_names:
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: dlp.{field}[{j}] {item!r} is not a valid "
|
||||||
|
f"detector name; valid names: {', '.join(sorted(valid_names))}"
|
||||||
|
)
|
||||||
|
names.append(item)
|
||||||
|
return tuple(names)
|
||||||
|
|
||||||
|
outbound = _parse_detector_field("outbound_detectors", OUTBOUND_DETECTOR_NAMES)
|
||||||
|
inbound = _parse_detector_field("inbound_detectors", INBOUND_DETECTOR_NAMES)
|
||||||
|
|
||||||
|
for k in dlp:
|
||||||
|
if k not in ("outbound_detectors", "inbound_detectors"):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label}: dlp has unknown key {k!r}; accepted keys "
|
||||||
|
f"are 'outbound_detectors', 'inbound_detectors'"
|
||||||
|
)
|
||||||
|
return outbound, inbound
|
||||||
|
|
||||||
|
|
||||||
|
def parse_routes(payload: object) -> tuple[Route, ...]:
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
raise ValueError("routes payload: top-level must be an object")
|
||||||
|
payload_dict: dict[str, object] = typing.cast(dict[str, object], payload)
|
||||||
|
raw: object = payload_dict.get("routes")
|
||||||
|
if not isinstance(raw, list):
|
||||||
|
raise ValueError("routes payload: 'routes' must be a list")
|
||||||
|
raw_list: list[object] = typing.cast(list[object], raw)
|
||||||
|
out: list[Route] = []
|
||||||
|
for i, r in enumerate(raw_list):
|
||||||
|
out.append(_parse_one(i, r))
|
||||||
|
return tuple(out)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_one(idx: int, raw: object) -> Route:
|
||||||
|
label = f"route[{idx}]"
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
raise ValueError(f"{label}: must be an object (got {type(raw).__name__})")
|
||||||
|
raw_dict: dict[str, object] = typing.cast(dict[str, object], raw)
|
||||||
|
host: object = raw_dict.get("host")
|
||||||
|
if not isinstance(host, str) or not host:
|
||||||
|
raise ValueError(f"{label}: 'host' must be a non-empty string")
|
||||||
|
|
||||||
|
# matches
|
||||||
|
matches: tuple[MatchEntry, ...] = ()
|
||||||
|
matches_raw = raw_dict.get("matches")
|
||||||
|
if matches_raw is not None:
|
||||||
|
if not isinstance(matches_raw, list):
|
||||||
|
raise ValueError(f"{label} ({host}): 'matches' must be a list")
|
||||||
|
matches_list = typing.cast(list[object], matches_raw)
|
||||||
|
matches = tuple(
|
||||||
|
_parse_match_entry(idx, k, m) for k, m in enumerate(matches_list)
|
||||||
|
)
|
||||||
|
|
||||||
|
# auth (unchanged wire format)
|
||||||
|
auth_scheme: object = raw_dict.get("auth_scheme", "")
|
||||||
|
token_env: object = raw_dict.get("token_env", "")
|
||||||
|
if not isinstance(auth_scheme, str):
|
||||||
|
raise ValueError(f"{label} ({host}): 'auth_scheme' must be a string")
|
||||||
|
if not isinstance(token_env, str):
|
||||||
|
raise ValueError(f"{label} ({host}): 'token_env' must be a string")
|
||||||
|
if bool(auth_scheme) != bool(token_env):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label} ({host}): 'auth_scheme' and 'token_env' must be both "
|
||||||
|
f"set or both empty (got auth_scheme={auth_scheme!r}, "
|
||||||
|
f"token_env={token_env!r})"
|
||||||
|
)
|
||||||
|
|
||||||
|
# git-over-HTTPS policy
|
||||||
|
git_fetch = False
|
||||||
|
git_raw = raw_dict.get("git")
|
||||||
|
if git_raw is not None:
|
||||||
|
if not isinstance(git_raw, dict):
|
||||||
|
raise ValueError(f"{label} ({host}): 'git' must be an object")
|
||||||
|
git_dict: dict[str, object] = typing.cast(dict[str, object], git_raw)
|
||||||
|
fetch_raw = git_dict.get("fetch", False)
|
||||||
|
if fetch_raw is True or fetch_raw is False:
|
||||||
|
git_fetch = fetch_raw
|
||||||
|
else:
|
||||||
|
raise ValueError(f"{label} ({host}): 'git.fetch' must be a boolean")
|
||||||
|
for k in git_dict:
|
||||||
|
if k != "fetch":
|
||||||
|
raise ValueError(
|
||||||
|
f"{label} ({host}): git has unknown key {k!r}; "
|
||||||
|
"accepted key is 'fetch'"
|
||||||
|
)
|
||||||
|
|
||||||
|
# dlp detectors
|
||||||
|
outbound_detectors, inbound_detectors = _parse_detectors(
|
||||||
|
idx, host, raw_dict,
|
||||||
|
)
|
||||||
|
|
||||||
|
for k in raw_dict:
|
||||||
|
if k not in ("host", "matches", "auth_scheme", "token_env", "dlp", "git"):
|
||||||
|
raise ValueError(
|
||||||
|
f"{label} ({host}): unknown key {k!r}; accepted keys "
|
||||||
|
f"are 'host', 'matches', 'auth_scheme', 'token_env', 'dlp', 'git'"
|
||||||
|
)
|
||||||
|
|
||||||
|
return Route(
|
||||||
|
host=host,
|
||||||
|
matches=matches,
|
||||||
|
auth_scheme=auth_scheme,
|
||||||
|
token_env=token_env,
|
||||||
|
git_fetch=git_fetch,
|
||||||
|
outbound_detectors=outbound_detectors,
|
||||||
|
inbound_detectors=inbound_detectors,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def load_routes(text: str) -> tuple[Route, ...]:
|
||||||
|
"""Parse YAML text → routes."""
|
||||||
|
try:
|
||||||
|
payload = parse_yaml_subset(text)
|
||||||
|
except YamlSubsetError as e:
|
||||||
|
raise ValueError(f"routes payload: invalid YAML: {e}") from e
|
||||||
|
return parse_routes(payload)
|
||||||
|
|
||||||
|
|
||||||
|
def parse_config(payload: object) -> "Config":
|
||||||
|
"""Parse a full egress config payload (top-level log level + routes)."""
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
raise ValueError("routes payload: top-level must be an object")
|
||||||
|
payload_dict: dict[str, object] = typing.cast(dict[str, object], payload)
|
||||||
|
|
||||||
|
log_raw: object = payload_dict.get("log", LOG_OFF)
|
||||||
|
if log_raw is True or log_raw is False or not isinstance(log_raw, int) \
|
||||||
|
or log_raw not in (LOG_OFF, LOG_BLOCKS, LOG_FULL):
|
||||||
|
raise ValueError(
|
||||||
|
f"routes payload: 'log' must be {LOG_OFF}, {LOG_BLOCKS}, or {LOG_FULL}"
|
||||||
|
)
|
||||||
|
|
||||||
|
routes = parse_routes(payload)
|
||||||
|
return Config(routes=routes, log=log_raw)
|
||||||
|
|
||||||
|
|
||||||
|
def load_config(text: str) -> "Config":
|
||||||
|
"""Parse YAML text → Config (routes + log flag)."""
|
||||||
|
try:
|
||||||
|
payload = parse_yaml_subset(text)
|
||||||
|
except YamlSubsetError as e:
|
||||||
|
raise ValueError(f"routes payload: invalid YAML: {e}") from e
|
||||||
|
return parse_config(payload)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Match evaluation
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _path_matches(pm: PathMatch, request_path: str) -> bool:
|
||||||
|
if pm.type == "exact":
|
||||||
|
return request_path == pm.value
|
||||||
|
if pm.type == "prefix":
|
||||||
|
if request_path == pm.value:
|
||||||
|
return True
|
||||||
|
if not pm.value.endswith("/"):
|
||||||
|
return request_path.startswith(pm.value + "/")
|
||||||
|
return request_path.startswith(pm.value)
|
||||||
|
if pm.type == "regex" and pm.compiled is not None:
|
||||||
|
return pm.compiled.search(request_path) is not None
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _entry_matches(
|
||||||
|
entry: MatchEntry,
|
||||||
|
request_path: str,
|
||||||
|
request_method: str,
|
||||||
|
request_headers: typing.Mapping[str, str],
|
||||||
|
) -> bool:
|
||||||
|
"""All predicates within a MatchEntry are ANDed."""
|
||||||
|
if entry.paths:
|
||||||
|
if not any(_path_matches(pm, request_path) for pm in entry.paths):
|
||||||
|
return False
|
||||||
|
if entry.methods:
|
||||||
|
if request_method.upper() not in entry.methods:
|
||||||
|
return False
|
||||||
|
if entry.headers:
|
||||||
|
for hm in entry.headers:
|
||||||
|
header_val = request_headers.get(hm.name.lower())
|
||||||
|
if header_val is None:
|
||||||
|
return False
|
||||||
|
if hm.type == "exact":
|
||||||
|
if header_val != hm.value:
|
||||||
|
return False
|
||||||
|
elif hm.type == "regex" and hm.compiled is not None:
|
||||||
|
if not hm.compiled.search(header_val):
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def evaluate_matches(
|
||||||
|
route: Route,
|
||||||
|
request_path: str,
|
||||||
|
request_method: str = "GET",
|
||||||
|
request_headers: typing.Mapping[str, str] | None = None,
|
||||||
|
) -> bool:
|
||||||
|
"""Return True if the request matches this route's match entries.
|
||||||
|
Empty matches tuple means all requests match (bare-pass route)."""
|
||||||
|
if not route.matches:
|
||||||
|
return True
|
||||||
|
hdrs: typing.Mapping[str, str] = request_headers or {}
|
||||||
|
return any(
|
||||||
|
_entry_matches(entry, request_path, request_method, hdrs)
|
||||||
|
for entry in route.matches
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Git push detection (unchanged)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def is_git_push_request(path: str, query: str) -> bool:
|
||||||
|
if path.endswith("/git-receive-pack"):
|
||||||
|
return True
|
||||||
|
if path.endswith("/info/refs"):
|
||||||
|
for pair in query.split("&"):
|
||||||
|
k, _, v = pair.partition("=")
|
||||||
|
if k == "service" and v == "git-receive-pack":
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def is_git_fetch_request(path: str, query: str) -> bool:
|
||||||
|
if path.endswith("/git-upload-pack"):
|
||||||
|
return True
|
||||||
|
if path.endswith("/info/refs"):
|
||||||
|
for pair in query.split("&"):
|
||||||
|
k, _, v = pair.partition("=")
|
||||||
|
if k == "service" and v == "git-upload-pack":
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Route lookup + decision
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def match_route(
|
||||||
|
routes: typing.Sequence[Route],
|
||||||
|
request_host: str,
|
||||||
|
) -> Route | None:
|
||||||
|
target = request_host.lower()
|
||||||
|
for r in routes:
|
||||||
|
if r.host.lower() == target:
|
||||||
|
return r
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def decide(
|
||||||
|
routes: typing.Sequence[Route],
|
||||||
|
request_host: str,
|
||||||
|
request_path: str,
|
||||||
|
environ: typing.Mapping[str, str],
|
||||||
|
*,
|
||||||
|
request_method: str = "GET",
|
||||||
|
request_headers: typing.Mapping[str, str] | None = None,
|
||||||
|
) -> Decision:
|
||||||
|
route = match_route(routes, request_host)
|
||||||
|
if route is None:
|
||||||
|
return Decision(
|
||||||
|
action="block",
|
||||||
|
reason=(
|
||||||
|
f"egress: host {request_host!r} is not in the "
|
||||||
|
f"bottle's egress.routes allowlist. Declare a "
|
||||||
|
f"route for it or remove the request."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
if not evaluate_matches(route, request_path, request_method, request_headers):
|
||||||
|
return Decision(
|
||||||
|
action="block",
|
||||||
|
reason=(
|
||||||
|
f"egress: request {request_method} {request_path!r} "
|
||||||
|
f"does not match any entry in matches for "
|
||||||
|
f"{route.host!r}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
if route.auth_scheme and route.token_env:
|
||||||
|
token = environ.get(route.token_env, "")
|
||||||
|
if not token:
|
||||||
|
return Decision(
|
||||||
|
action="block",
|
||||||
|
reason=(
|
||||||
|
f"egress: route for {route.host!r} declared auth "
|
||||||
|
f"but env var {route.token_env!r} is unset"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
return Decision(
|
||||||
|
action="forward",
|
||||||
|
inject_authorization=f"{route.auth_scheme} {token}",
|
||||||
|
)
|
||||||
|
|
||||||
|
return Decision(action="forward")
|
||||||
|
|
||||||
|
|
||||||
|
def decide_git_fetch(
|
||||||
|
routes: typing.Sequence[Route],
|
||||||
|
request_host: str,
|
||||||
|
) -> Decision:
|
||||||
|
route = match_route(routes, request_host)
|
||||||
|
if route is not None and route.git_fetch:
|
||||||
|
return Decision(action="forward")
|
||||||
|
return Decision(
|
||||||
|
action="block",
|
||||||
|
reason=(
|
||||||
|
"egress: git fetch/clone over HTTPS is not allowed by default; "
|
||||||
|
"use git-gate for declared repos or set "
|
||||||
|
"egress.routes[].git.fetch=true for explicit read-only "
|
||||||
|
"HTTPS Git access."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# DLP scan dispatch (PRD 0053)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def build_outbound_scan_text(
|
||||||
|
host: str,
|
||||||
|
path: str,
|
||||||
|
query: str,
|
||||||
|
headers: typing.Mapping[str, str],
|
||||||
|
body: str,
|
||||||
|
) -> str:
|
||||||
|
"""Assemble all outbound request surfaces into one string for DLP scanning.
|
||||||
|
|
||||||
|
Covers hostname (DNS tunnelling), path, query params, all headers, body.
|
||||||
|
"""
|
||||||
|
parts: list[str] = [host, path]
|
||||||
|
if query:
|
||||||
|
parts.append(query)
|
||||||
|
for name, value in headers.items():
|
||||||
|
parts.append(f"{name}: {value}")
|
||||||
|
if body:
|
||||||
|
parts.append(body)
|
||||||
|
return "\n".join(parts)
|
||||||
|
|
||||||
|
|
||||||
|
def outbound_scan_headers(
|
||||||
|
route: Route,
|
||||||
|
headers: typing.Mapping[str, str],
|
||||||
|
) -> dict[str, str]:
|
||||||
|
"""Return request headers that should be included in outbound DLP.
|
||||||
|
|
||||||
|
Routes that inject sidecar-owned auth always strip the agent's
|
||||||
|
Authorization header before forwarding. Scanning that header first
|
||||||
|
creates false positives for provider clients that insist on sending
|
||||||
|
their own bearer-shaped placeholder, while still not changing what
|
||||||
|
reaches the upstream.
|
||||||
|
"""
|
||||||
|
out: dict[str, str] = {}
|
||||||
|
skip_auth = bool(route.auth_scheme and route.token_env)
|
||||||
|
for name, value in headers.items():
|
||||||
|
if skip_auth and name.lower() == "authorization":
|
||||||
|
continue
|
||||||
|
out[name] = value
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def build_inbound_scan_text(
|
||||||
|
headers: typing.Mapping[str, str],
|
||||||
|
body: str,
|
||||||
|
) -> str:
|
||||||
|
"""Assemble inbound response surfaces into one string for DLP scanning.
|
||||||
|
|
||||||
|
Covers all response headers plus body.
|
||||||
|
"""
|
||||||
|
parts: list[str] = []
|
||||||
|
for name, value in headers.items():
|
||||||
|
parts.append(f"{name}: {value}")
|
||||||
|
if body:
|
||||||
|
parts.append(body)
|
||||||
|
return "\n".join(parts)
|
||||||
|
|
||||||
|
|
||||||
|
def _detector_enabled(
|
||||||
|
configured: tuple[str, ...] | None,
|
||||||
|
name: str,
|
||||||
|
) -> bool:
|
||||||
|
"""Check if a named detector is enabled for a route direction.
|
||||||
|
None means all enabled; empty tuple means all disabled."""
|
||||||
|
if configured is None:
|
||||||
|
return True
|
||||||
|
return name in configured
|
||||||
|
|
||||||
|
|
||||||
|
def scan_outbound(
|
||||||
|
route: Route,
|
||||||
|
body: str | bytes,
|
||||||
|
environ: typing.Mapping[str, str],
|
||||||
|
) -> ScanResult | None:
|
||||||
|
# Lazy import to avoid circular deps and keep dlp_detectors optional
|
||||||
|
# at import time (the sidecar copies it flat alongside this file).
|
||||||
|
try:
|
||||||
|
from dlp_detectors import ( # type: ignore[import-not-found]
|
||||||
|
scan_crlf_injection,
|
||||||
|
scan_known_secrets,
|
||||||
|
scan_token_patterns,
|
||||||
|
)
|
||||||
|
except ImportError: # pragma: no cover - host-side path
|
||||||
|
from .dlp_detectors import ( # type: ignore[import-not-found]
|
||||||
|
scan_crlf_injection,
|
||||||
|
scan_known_secrets,
|
||||||
|
scan_token_patterns,
|
||||||
|
)
|
||||||
|
|
||||||
|
text = body if isinstance(body, str) else body.decode("utf-8", errors="replace")
|
||||||
|
|
||||||
|
# CRLF injection is never legitimate — runs unconditionally, not gated
|
||||||
|
# by outbound_detectors config.
|
||||||
|
result = scan_crlf_injection(text)
|
||||||
|
if result is not None:
|
||||||
|
return result
|
||||||
|
|
||||||
|
if _detector_enabled(route.outbound_detectors, "token_patterns"):
|
||||||
|
result = scan_token_patterns(text, location="body")
|
||||||
|
if result is not None:
|
||||||
|
return result
|
||||||
|
|
||||||
|
if _detector_enabled(route.outbound_detectors, "known_secrets"):
|
||||||
|
result = scan_known_secrets(text, location="body", env=environ)
|
||||||
|
if result is not None:
|
||||||
|
return result
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def scan_inbound(
|
||||||
|
route: Route,
|
||||||
|
body: str | bytes,
|
||||||
|
) -> ScanResult | None:
|
||||||
|
try:
|
||||||
|
from dlp_detectors import scan_naive_injection # type: ignore[import-not-found]
|
||||||
|
except ImportError: # pragma: no cover - host-side path
|
||||||
|
from .dlp_detectors import scan_naive_injection # type: ignore[import-not-found]
|
||||||
|
|
||||||
|
text = body if isinstance(body, str) else body.decode("utf-8", errors="replace")
|
||||||
|
|
||||||
|
if _detector_enabled(route.inbound_detectors, "naive_injection_detection"):
|
||||||
|
result = scan_naive_injection(text)
|
||||||
|
if result is not None:
|
||||||
|
return result
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"LOG_BLOCKS",
|
||||||
|
"LOG_FULL",
|
||||||
|
"LOG_OFF",
|
||||||
|
"Config",
|
||||||
|
"Decision",
|
||||||
|
"HeaderMatch",
|
||||||
|
"MatchEntry",
|
||||||
|
"PathMatch",
|
||||||
|
"Route",
|
||||||
|
"ScanResult",
|
||||||
|
"build_inbound_scan_text",
|
||||||
|
"build_outbound_scan_text",
|
||||||
|
"decide",
|
||||||
|
"decide_git_fetch",
|
||||||
|
"evaluate_matches",
|
||||||
|
"is_git_push_request",
|
||||||
|
"is_git_fetch_request",
|
||||||
|
"load_config",
|
||||||
|
"load_routes",
|
||||||
|
"match_route",
|
||||||
|
"outbound_scan_headers",
|
||||||
|
"parse_config",
|
||||||
|
"parse_routes",
|
||||||
|
"scan_inbound",
|
||||||
|
"scan_outbound",
|
||||||
|
]
|
||||||
@@ -2,19 +2,19 @@
|
|||||||
# Egress daemon entrypoint inside the sidecar bundle (PRD 0024).
|
# Egress daemon entrypoint inside the sidecar bundle (PRD 0024).
|
||||||
#
|
#
|
||||||
# Extracted verbatim from Dockerfile.egress's prior inline `sh -c`
|
# Extracted verbatim from Dockerfile.egress's prior inline `sh -c`
|
||||||
# ENTRYPOINT so the supervisor in claude_bottle/sidecar_init.py can
|
# ENTRYPOINT so the supervisor in bot_bottle/sidecar_init.py can
|
||||||
# call it as a normal child. Behavior is unchanged:
|
# call it as a normal child. Behavior is unchanged:
|
||||||
#
|
#
|
||||||
# * Upstream proxy: when EGRESS_UPSTREAM_PROXY is set, switch
|
# * Upstream proxy: when EGRESS_UPSTREAM_PROXY is set, switch
|
||||||
# to `--mode upstream:URL` to forward all post-MITM traffic
|
# to `--mode upstream:URL` to chain through an upstream proxy.
|
||||||
# through pipelock. mitmproxy does NOT honor HTTPS_PROXY on
|
# mitmproxy does NOT honor HTTPS_PROXY on its outbound side,
|
||||||
# its outbound side, so the upstream wiring has to be the
|
# so the upstream wiring has to be the mitmproxy mode flag,
|
||||||
# mitmproxy mode flag, not env.
|
# not env.
|
||||||
# * Upstream trust: when EGRESS_UPSTREAM_CA is set, build a
|
# * Upstream trust: when EGRESS_UPSTREAM_CA is set, build a
|
||||||
# combined trust bundle (system roots + pipelock CA) and point
|
# combined trust bundle (system roots + upstream CA) and point
|
||||||
# mitmproxy at it. The option REPLACES mitmproxy's default
|
# mitmproxy at it. The option REPLACES mitmproxy's default
|
||||||
# trust store, so passing pipelock's CA alone would break
|
# trust store, so passing the upstream CA alone would break
|
||||||
# pipelock-passthrough hosts (api.anthropic.com etc.).
|
# non-chained hosts.
|
||||||
# * `-s /app/egress_addon.py` loads the addon that reads
|
# * `-s /app/egress_addon.py` loads the addon that reads
|
||||||
# /etc/egress/routes.yaml.
|
# /etc/egress/routes.yaml.
|
||||||
|
|
||||||
@@ -38,11 +38,7 @@ fi
|
|||||||
|
|
||||||
# Bind address. Docker backend wants `0.0.0.0` (agent dials egress
|
# Bind address. Docker backend wants `0.0.0.0` (agent dials egress
|
||||||
# directly via the docker network alias). Smolmachines backend
|
# directly via the docker network alias). Smolmachines backend
|
||||||
# wants `127.0.0.1` because the agent dials pipelock — not egress
|
# uses EGRESS_LISTEN_HOST when a non-default binding is needed.
|
||||||
# — and egress is pipelock's localhost-only upstream inside the
|
|
||||||
# bundle. TSI's IP-only allowlist would otherwise let the agent
|
|
||||||
# reach `<bundle-ip>:9099` and bypass pipelock's DLP; binding
|
|
||||||
# 127.0.0.1 inside the bundle closes that gap (PRD 0023 chunk 3).
|
|
||||||
LISTEN_HOST_FLAG=""
|
LISTEN_HOST_FLAG=""
|
||||||
if [ -n "$EGRESS_LISTEN_HOST" ]; then
|
if [ -n "$EGRESS_LISTEN_HOST" ]; then
|
||||||
LISTEN_HOST_FLAG="--listen-host $EGRESS_LISTEN_HOST"
|
LISTEN_HOST_FLAG="--listen-host $EGRESS_LISTEN_HOST"
|
||||||
@@ -56,13 +52,10 @@ if [ -n "$EGRESS_UPSTREAM_CA" ] && [ -f "$EGRESS_UPSTREAM_CA" ]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# Scope the proxy env to this process tree only. In the bundle
|
# Scope the proxy env to this process tree only. In the bundle
|
||||||
# image (PRD 0024) the four daemons share one container — setting
|
# image (PRD 0024) multiple daemons share one container — setting
|
||||||
# HTTPS_PROXY at the container level would route git-gate's git
|
# HTTPS_PROXY at the container level would route git-gate's git
|
||||||
# pushes through pipelock, which is wrong (pipelock doesn't proxy
|
# pushes through an upstream proxy unintentionally. Setting them
|
||||||
# SSH and would block public git repos). Setting them here means
|
# here means only mitmdump's subprocess inherits them.
|
||||||
# only mitmdump's subprocess inherits them. In the legacy
|
|
||||||
# four-sidecar setup these env vars are also set in compose; here
|
|
||||||
# they're additionally defensive.
|
|
||||||
if [ -n "$EGRESS_UPSTREAM_PROXY" ]; then
|
if [ -n "$EGRESS_UPSTREAM_PROXY" ]; then
|
||||||
export HTTPS_PROXY="$EGRESS_UPSTREAM_PROXY"
|
export HTTPS_PROXY="$EGRESS_UPSTREAM_PROXY"
|
||||||
export HTTP_PROXY="$EGRESS_UPSTREAM_PROXY"
|
export HTTP_PROXY="$EGRESS_UPSTREAM_PROXY"
|
||||||
@@ -89,7 +89,7 @@ def _read_secret_silent(name: str, prompt_body: str) -> str:
|
|||||||
if not (sys.stdin.isatty() or sys.stderr.isatty()):
|
if not (sys.stdin.isatty() or sys.stderr.isatty()):
|
||||||
# Fall back to /dev/tty so this still works when stdin is a pipe.
|
# Fall back to /dev/tty so this still works when stdin is a pipe.
|
||||||
try:
|
try:
|
||||||
tty = open("/dev/tty", "r+")
|
tty = open("/dev/tty", "r+", encoding="utf-8")
|
||||||
except OSError:
|
except OSError:
|
||||||
die(
|
die(
|
||||||
f"cannot prompt for secret '{name}': no tty available. "
|
f"cannot prompt for secret '{name}': no tty available. "
|
||||||
@@ -98,7 +98,7 @@ def _read_secret_silent(name: str, prompt_body: str) -> str:
|
|||||||
prompt = (
|
prompt = (
|
||||||
f"{prompt_body} (input hidden): "
|
f"{prompt_body} (input hidden): "
|
||||||
if prompt_body
|
if prompt_body
|
||||||
else f"claude-bottle: secret value for {name} (input hidden): "
|
else f"bot-bottle: secret value for {name} (input hidden): "
|
||||||
)
|
)
|
||||||
value = getpass.getpass(prompt, stream=tty)
|
value = getpass.getpass(prompt, stream=tty)
|
||||||
tty.close()
|
tty.close()
|
||||||
@@ -106,7 +106,7 @@ def _read_secret_silent(name: str, prompt_body: str) -> str:
|
|||||||
prompt = (
|
prompt = (
|
||||||
f"{prompt_body} (input hidden): "
|
f"{prompt_body} (input hidden): "
|
||||||
if prompt_body
|
if prompt_body
|
||||||
else f"claude-bottle: secret value for {name} (input hidden): "
|
else f"bot-bottle: secret value for {name} (input hidden): "
|
||||||
)
|
)
|
||||||
value = getpass.getpass(prompt)
|
value = getpass.getpass(prompt)
|
||||||
if not value:
|
if not value:
|
||||||
@@ -15,9 +15,9 @@ a bare repo on the gate; `git daemon` serves the bare repos over
|
|||||||
|
|
||||||
The agent never sees the upstream credential under either path.
|
The agent never sees the upstream credential under either path.
|
||||||
|
|
||||||
Why a third sidecar (not folded into pipelock or ssh-gate): the
|
Why a separate sidecar (not folded into egress or ssh-gate): the
|
||||||
gate is the only one of the three that holds upstream push
|
gate is the only one of the three that holds upstream push
|
||||||
credentials. Mixing it with pipelock would put push creds in the
|
credentials. Mixing it with egress would put push creds in the
|
||||||
same blast radius as internet-facing TLS interception; mixing it
|
same blast radius as internet-facing TLS interception; mixing it
|
||||||
with ssh-gate would force ssh-gate above L4 and into git-protocol
|
with ssh-gate would force ssh-gate above L4 and into git-protocol
|
||||||
land. See `docs/prds/0008-git-gate.md`.
|
land. See `docs/prds/0008-git-gate.md`.
|
||||||
@@ -25,26 +25,28 @@ land. See `docs/prds/0008-git-gate.md`.
|
|||||||
This module defines the abstract gate (`GitGate`) and its plan
|
This module defines the abstract gate (`GitGate`) and its plan
|
||||||
dataclass (`GitGatePlan`). The sidecar's start/stop lifecycle is
|
dataclass (`GitGatePlan`). The sidecar's start/stop lifecycle is
|
||||||
backend-specific and lives on concrete subclasses (see
|
backend-specific and lives on concrete subclasses (see
|
||||||
`claude_bottle/backend/docker/git_gate.py`)."""
|
`bot_bottle/backend/docker/git_gate.py`)."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from abc import ABC, abstractmethod
|
import dataclasses
|
||||||
from dataclasses import dataclass, field
|
import os
|
||||||
|
import shlex
|
||||||
|
from abc import ABC
|
||||||
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Mapping
|
|
||||||
|
|
||||||
from .log import die
|
from .log import info
|
||||||
from .manifest import Bottle, GitEntry
|
from .manifest import ManifestBottle, ManifestGitEntry
|
||||||
|
|
||||||
|
|
||||||
# Short network alias for git-gate inside the sidecar bundle. The
|
# Short network alias for git-gate inside the sidecar bundle. The
|
||||||
# agent's `.gitconfig` insteadOf rewrites resolve through this name.
|
# agent's `.gitconfig` insteadOf rewrites resolve through this name.
|
||||||
GIT_GATE_HOSTNAME = "git-gate"
|
GIT_GATE_HOSTNAME = "git-gate"
|
||||||
|
# Bound half-open git client sessions. If an agent/tool runner is
|
||||||
|
# interrupted during push, git daemon should reap the receive-pack
|
||||||
def _empty_str_map() -> dict[str, str]:
|
# child instead of keeping the gate wedged indefinitely.
|
||||||
return {}
|
GIT_GATE_DAEMON_TIMEOUT_SECS = 15
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -60,10 +62,7 @@ class GitGateUpstream:
|
|||||||
KnownHostKey string from the manifest; the gate's start step
|
KnownHostKey string from the manifest; the gate's start step
|
||||||
materialises it into a known_hosts file if non-empty.
|
materialises it into a known_hosts file if non-empty.
|
||||||
|
|
||||||
`extra_hosts` is a `{hostname: ip}` map the backend injects into
|
the gate credential paths inside the running sidecar."""
|
||||||
the gate container's `/etc/hosts` via `--add-host` so the gate
|
|
||||||
can resolve upstream hostnames that aren't reachable via the
|
|
||||||
container's default DNS (e.g. Tailscale-only hosts)."""
|
|
||||||
|
|
||||||
name: str
|
name: str
|
||||||
upstream_url: str
|
upstream_url: str
|
||||||
@@ -71,7 +70,7 @@ class GitGateUpstream:
|
|||||||
upstream_port: str
|
upstream_port: str
|
||||||
identity_file: str
|
identity_file: str
|
||||||
known_host_key: str
|
known_host_key: str
|
||||||
extra_hosts: Mapping[str, str] = field(default_factory=_empty_str_map)
|
known_hosts_file: Path = Path()
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -97,9 +96,9 @@ class GitGatePlan:
|
|||||||
egress_network: str = ""
|
egress_network: str = ""
|
||||||
|
|
||||||
|
|
||||||
def git_gate_upstreams_for_bottle(bottle: Bottle) -> tuple[GitGateUpstream, ...]:
|
def git_gate_upstreams_for_bottle(bottle: ManifestBottle) -> tuple[GitGateUpstream, ...]:
|
||||||
"""Lift each `bottle.git` entry into a GitGateUpstream. Unique-Name
|
"""Lift each `bottle.git` entry into a GitGateUpstream. Unique-Name
|
||||||
validation already ran in `manifest.Bottle.from_dict`."""
|
validation already ran in `manifest.ManifestBottle.from_dict`."""
|
||||||
return tuple(
|
return tuple(
|
||||||
GitGateUpstream(
|
GitGateUpstream(
|
||||||
name=e.Name,
|
name=e.Name,
|
||||||
@@ -108,46 +107,19 @@ def git_gate_upstreams_for_bottle(bottle: Bottle) -> tuple[GitGateUpstream, ...]
|
|||||||
upstream_port=e.UpstreamPort,
|
upstream_port=e.UpstreamPort,
|
||||||
identity_file=e.IdentityFile,
|
identity_file=e.IdentityFile,
|
||||||
known_host_key=e.KnownHostKey,
|
known_host_key=e.KnownHostKey,
|
||||||
extra_hosts=dict(e.ExtraHosts),
|
|
||||||
)
|
)
|
||||||
for e in bottle.git
|
for e in bottle.git
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def git_gate_aggregate_extra_hosts(
|
|
||||||
upstreams: tuple[GitGateUpstream, ...],
|
|
||||||
) -> dict[str, str]:
|
|
||||||
"""Merge every upstream's `extra_hosts` into a single
|
|
||||||
`{hostname: ip}` map for `--add-host` on the gate container. Two
|
|
||||||
entries naming the same hostname with different IPs is a manifest
|
|
||||||
bug — the gate has one /etc/hosts — so die loudly with the
|
|
||||||
conflicting names rather than silently picking one."""
|
|
||||||
merged: dict[str, str] = {}
|
|
||||||
source: dict[str, str] = {}
|
|
||||||
for u in upstreams:
|
|
||||||
for host, ip in u.extra_hosts.items():
|
|
||||||
existing = merged.get(host)
|
|
||||||
if existing is None:
|
|
||||||
merged[host] = ip
|
|
||||||
source[host] = u.name
|
|
||||||
elif existing != ip:
|
|
||||||
die(
|
|
||||||
f"git-gate ExtraHosts conflict: '{host}' maps to "
|
|
||||||
f"'{existing}' in upstream '{source[host]}' and to "
|
|
||||||
f"'{ip}' in upstream '{u.name}'. The gate has one "
|
|
||||||
f"/etc/hosts; pick one IP."
|
|
||||||
)
|
|
||||||
return merged
|
|
||||||
|
|
||||||
|
|
||||||
def git_gate_render_gitconfig(
|
def git_gate_render_gitconfig(
|
||||||
entries: tuple[GitEntry, ...], gate_host: str
|
entries: tuple[ManifestGitEntry, ...], gate_host: str, *, scheme: str = "git",
|
||||||
) -> str:
|
) -> str:
|
||||||
"""Render the agent's ~/.gitconfig content for git-gate
|
"""Render the agent's ~/.gitconfig content for git-gate
|
||||||
`insteadOf` rewrites. Pure host-side, no docker / smolvm;
|
`insteadOf` rewrites. Pure host-side, no docker / smolvm;
|
||||||
exposed for tests + reuse across backends.
|
exposed for tests + reuse across backends.
|
||||||
|
|
||||||
`gate_host` is the part of the URL between `git://` and the
|
`gate_host` is the part of the URL between `<scheme>://` and the
|
||||||
repo path — backends differ here:
|
repo path — backends differ here:
|
||||||
- docker: `git-gate` (the short network alias)
|
- docker: `git-gate` (the short network alias)
|
||||||
- smolmachines: `<bundle_ip>:<port>` (no DNS in the
|
- smolmachines: `<bundle_ip>:<port>` (no DNS in the
|
||||||
@@ -158,14 +130,25 @@ def git_gate_render_gitconfig(
|
|||||||
if not entries:
|
if not entries:
|
||||||
return ""
|
return ""
|
||||||
out = [
|
out = [
|
||||||
"# claude-bottle git-gate (PRD 0008): every git operation against\n",
|
"# bot-bottle git-gate (PRD 0008): every git operation against\n",
|
||||||
"# a declared upstream routes through the gate, which mirrors\n",
|
"# a declared upstream routes through the gate, which mirrors\n",
|
||||||
"# the upstream bidirectionally (gitleaks-scanned push;\n",
|
"# the upstream bidirectionally (gitleaks-scanned push;\n",
|
||||||
"# fetch-from-upstream-before-every-upload-pack via access-hook).\n",
|
"# fetch-from-upstream-before-every-upload-pack via access-hook).\n",
|
||||||
]
|
]
|
||||||
for entry in entries:
|
for entry in entries:
|
||||||
out.append(f'[url "git://{gate_host}/{entry.Name}.git"]\n')
|
out.append(f'[url "{scheme}://{gate_host}/{entry.Name}.git"]\n')
|
||||||
out.append(f"\tinsteadOf = {entry.Upstream}\n")
|
out.append(f"\tinsteadOf = {entry.Upstream}\n")
|
||||||
|
if entry.RemoteKey and entry.RemoteKey != entry.UpstreamHost:
|
||||||
|
port = (
|
||||||
|
f":{entry.UpstreamPort}"
|
||||||
|
if entry.UpstreamPort and entry.UpstreamPort != "22"
|
||||||
|
else ""
|
||||||
|
)
|
||||||
|
alias = (
|
||||||
|
f"ssh://{entry.UpstreamUser}@{entry.RemoteKey}{port}/"
|
||||||
|
f"{entry.UpstreamPath}"
|
||||||
|
)
|
||||||
|
out.append(f"\tinsteadOf = {alias}\n")
|
||||||
return "".join(out)
|
return "".join(out)
|
||||||
|
|
||||||
|
|
||||||
@@ -221,20 +204,21 @@ def git_gate_render_entrypoint(upstreams: tuple[GitGateUpstream, ...]) -> str:
|
|||||||
" git -C \"$repo\" config git-gate.identityFile \"$keyfile\"",
|
" git -C \"$repo\" config git-gate.identityFile \"$keyfile\"",
|
||||||
" git -C \"$repo\" config git-gate.knownHosts \"$hostsfile\"",
|
" git -C \"$repo\" config git-gate.knownHosts \"$hostsfile\"",
|
||||||
" git -C \"$repo\" config receive.denyCurrentBranch ignore",
|
" git -C \"$repo\" config receive.denyCurrentBranch ignore",
|
||||||
|
" git -C \"$repo\" config receive.advertisePushOptions true",
|
||||||
|
" git -C \"$repo\" config http.receivepack true",
|
||||||
" install -m 755 /etc/git-gate/pre-receive \"$repo/hooks/pre-receive\"",
|
" install -m 755 /etc/git-gate/pre-receive \"$repo/hooks/pre-receive\"",
|
||||||
"}",
|
"}",
|
||||||
"",
|
"",
|
||||||
"mkdir -p /git",
|
"mkdir -p /git",
|
||||||
]
|
]
|
||||||
for u in upstreams:
|
for u in upstreams:
|
||||||
# Single-quote args so URL/path content (containing : and /)
|
lines.append(f"init_repo {shlex.quote(u.name)} {shlex.quote(u.upstream_url)}")
|
||||||
# passes through ash unmangled. Names came through the manifest
|
|
||||||
# validator so they don't contain a single quote.
|
|
||||||
lines.append(f"init_repo '{u.name}' '{u.upstream_url}'")
|
|
||||||
lines.extend([
|
lines.extend([
|
||||||
"",
|
"",
|
||||||
"exec git daemon \\",
|
"exec git daemon \\",
|
||||||
" --reuseaddr \\",
|
" --reuseaddr \\",
|
||||||
|
f" --timeout={GIT_GATE_DAEMON_TIMEOUT_SECS} \\",
|
||||||
|
f" --init-timeout={GIT_GATE_DAEMON_TIMEOUT_SECS} \\",
|
||||||
" --base-path=/git \\",
|
" --base-path=/git \\",
|
||||||
" --export-all \\",
|
" --export-all \\",
|
||||||
" --enable=receive-pack \\",
|
" --enable=receive-pack \\",
|
||||||
@@ -268,7 +252,14 @@ while IFS=' ' read -r old new ref; do
|
|||||||
[ -z "$ref" ] && continue
|
[ -z "$ref" ] && continue
|
||||||
[ "$new" = "$zero" ] && continue
|
[ "$new" = "$zero" ] && continue
|
||||||
if [ "$old" = "$zero" ]; then
|
if [ "$old" = "$zero" ]; then
|
||||||
log_opts="$new"
|
# New ref: scan only the commits this push introduces — those
|
||||||
|
# reachable from $new but not from any ref the gate already has.
|
||||||
|
# Everything already on the gate arrived via upstream mirror-fetch
|
||||||
|
# or a previously gitleaks-scanned push, so it's already-upstream
|
||||||
|
# or already-scanned; re-scanning it (the old `$new` full-ancestry
|
||||||
|
# range) only resurfaces historical findings and blocks every new
|
||||||
|
# branch. See PRD 0028 / issue #106.
|
||||||
|
log_opts="$new --not --all"
|
||||||
else
|
else
|
||||||
log_opts="$old..$new"
|
log_opts="$old..$new"
|
||||||
fi
|
fi
|
||||||
@@ -288,17 +279,34 @@ if [ ! -f "$hostsfile" ]; then
|
|||||||
echo "git-gate: add KnownHostKey to the bottle.git entry and restart the bottle" >&2
|
echo "git-gate: add KnownHostKey to the bottle.git entry and restart the bottle" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
ssh_cmd="ssh -i $keyfile -o UserKnownHostsFile=$hostsfile -o StrictHostKeyChecking=yes -o IdentitiesOnly=yes"
|
ssh_cmd="ssh -i $keyfile -o UserKnownHostsFile=$hostsfile -o StrictHostKeyChecking=yes -o IdentitiesOnly=yes -o BatchMode=yes -o ConnectTimeout=10"
|
||||||
|
|
||||||
|
push_option_count=${GIT_PUSH_OPTION_COUNT:-0}
|
||||||
|
case "$push_option_count" in
|
||||||
|
''|*[!0-9]*)
|
||||||
|
echo "git-gate: invalid GIT_PUSH_OPTION_COUNT=$push_option_count" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
set --
|
||||||
|
i=0
|
||||||
|
while [ "$i" -lt "$push_option_count" ]; do
|
||||||
|
opt=$(printenv "GIT_PUSH_OPTION_$i" || :)
|
||||||
|
set -- "$@" --push-option="$opt"
|
||||||
|
i=$((i + 1))
|
||||||
|
done
|
||||||
|
|
||||||
while IFS=' ' read -r old new ref; do
|
while IFS=' ' read -r old new ref; do
|
||||||
[ -z "$ref" ] && continue
|
[ -z "$ref" ] && continue
|
||||||
if [ "$new" = "$zero" ]; then
|
if [ "$new" = "$zero" ]; then
|
||||||
refspec=":$ref"
|
refspec=":$ref"
|
||||||
|
elif [ "$old" != "$zero" ] && ! git merge-base --is-ancestor "$old" "$new" 2>/dev/null; then
|
||||||
|
refspec="+$new:$ref"
|
||||||
else
|
else
|
||||||
refspec="$new:$ref"
|
refspec="$new:$ref"
|
||||||
fi
|
fi
|
||||||
echo "git-gate: forwarding $ref to origin" >&2
|
echo "git-gate: forwarding $ref to origin" >&2
|
||||||
if ! GIT_SSH_COMMAND="$ssh_cmd" git push origin "$refspec" 1>&2; then
|
if ! GIT_SSH_COMMAND="$ssh_cmd" git push "$@" origin "$refspec" 1>&2; then
|
||||||
echo "git-gate: upstream push failed for $ref" >&2
|
echo "git-gate: upstream push failed for $ref" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
@@ -343,7 +351,7 @@ if [ -z "$keyfile" ] || [ ! -f "$hostsfile" ]; then
|
|||||||
echo "git-gate: missing credentials for $repo_dir; refusing fetch" >&2
|
echo "git-gate: missing credentials for $repo_dir; refusing fetch" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
ssh_cmd="ssh -i $keyfile -o UserKnownHostsFile=$hostsfile -o StrictHostKeyChecking=yes -o IdentitiesOnly=yes"
|
ssh_cmd="ssh -i $keyfile -o UserKnownHostsFile=$hostsfile -o StrictHostKeyChecking=yes -o IdentitiesOnly=yes -o BatchMode=yes -o ConnectTimeout=10"
|
||||||
|
|
||||||
echo "git-gate: refreshing $repo_dir from upstream" >&2
|
echo "git-gate: refreshing $repo_dir from upstream" >&2
|
||||||
if ! GIT_SSH_COMMAND="$ssh_cmd" git -C "$repo_dir" fetch origin --prune >&2; then
|
if ! GIT_SSH_COMMAND="$ssh_cmd" git -C "$repo_dir" fetch origin --prune >&2; then
|
||||||
@@ -370,21 +378,112 @@ exit 0
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def _provision_dynamic_key(
|
||||||
|
entry: ManifestGitEntry,
|
||||||
|
slug: str,
|
||||||
|
stage_dir: Path,
|
||||||
|
) -> str:
|
||||||
|
"""Generate a fresh ed25519 keypair, register the public half with
|
||||||
|
the forge, and persist the private key + key ID under `stage_dir`.
|
||||||
|
|
||||||
|
Returns the host-side path to the private key file so the caller
|
||||||
|
can inject it into the GitGateUpstream as `identity_file`."""
|
||||||
|
from .deploy_key_provisioner import get_provisioner
|
||||||
|
pk = entry.Key
|
||||||
|
token = os.environ.get(pk.forge_token_env)
|
||||||
|
if token is None:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"git-gate.repos[{entry.Name!r}] key.forge_token_env"
|
||||||
|
f" = {pk.forge_token_env!r}: env var is not set"
|
||||||
|
)
|
||||||
|
api_url = pk.api_url or f"https://{entry.UpstreamHost}"
|
||||||
|
provisioner = get_provisioner(pk.provider, token, api_url)
|
||||||
|
|
||||||
|
owner_repo = entry.UpstreamPath
|
||||||
|
if owner_repo.endswith(".git"):
|
||||||
|
owner_repo = owner_repo[:-4]
|
||||||
|
title = f"bot-bottle:{slug}:{entry.Name}"
|
||||||
|
|
||||||
|
info(f"provisioning deploy key for git-gate.repos[{entry.Name!r}]")
|
||||||
|
key_id, private_key_bytes = provisioner.create(owner_repo, title)
|
||||||
|
|
||||||
|
key_file = stage_dir / f"{entry.Name}-key"
|
||||||
|
key_file.write_bytes(private_key_bytes)
|
||||||
|
key_file.chmod(0o600)
|
||||||
|
|
||||||
|
id_file = stage_dir / f"{entry.Name}-deploy-key-id"
|
||||||
|
id_file.write_text(key_id)
|
||||||
|
id_file.chmod(0o600)
|
||||||
|
|
||||||
|
info(f"provisioned deploy key {key_id} for git-gate.repos[{entry.Name!r}]")
|
||||||
|
return str(key_file)
|
||||||
|
|
||||||
|
|
||||||
|
def revoke_git_gate_provisioned_keys(bottle: ManifestBottle, stage_dir: Path) -> None:
|
||||||
|
"""Revoke all deploy keys provisioned for `bottle` during prepare.
|
||||||
|
|
||||||
|
Called at teardown after containers stop. Raises if any revocation
|
||||||
|
fails — a stranded key is a security concern that the operator must
|
||||||
|
address manually."""
|
||||||
|
from .deploy_key_provisioner import get_provisioner
|
||||||
|
for entry in bottle.git:
|
||||||
|
if entry.Key.provider != "gitea":
|
||||||
|
continue
|
||||||
|
pk = entry.Key
|
||||||
|
id_file = stage_dir / f"{entry.Name}-deploy-key-id"
|
||||||
|
if not id_file.exists():
|
||||||
|
continue
|
||||||
|
key_id = id_file.read_text().strip()
|
||||||
|
token = os.environ.get(pk.forge_token_env)
|
||||||
|
if token is None:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"git-gate.repos[{entry.Name!r}] key.forge_token_env"
|
||||||
|
f" = {pk.forge_token_env!r}: env var is not set;"
|
||||||
|
f" cannot revoke deploy key {key_id}"
|
||||||
|
)
|
||||||
|
api_url = pk.api_url or f"https://{entry.UpstreamHost}"
|
||||||
|
provisioner = get_provisioner(pk.provider, token, api_url)
|
||||||
|
owner_repo = entry.UpstreamPath
|
||||||
|
if owner_repo.endswith(".git"):
|
||||||
|
owner_repo = owner_repo[:-4]
|
||||||
|
info(f"revoking deploy key {key_id} for git-gate.repos[{entry.Name!r}]")
|
||||||
|
provisioner.delete(owner_repo, key_id)
|
||||||
|
info(f"revoked deploy key {key_id} for git-gate.repos[{entry.Name!r}]")
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_identity_file(entry: ManifestGitEntry, slug: str, stage_dir: Path) -> str:
|
||||||
|
"""Return the host-side SSH identity file path for this entry.
|
||||||
|
For gitea entries, provisions a fresh deploy key first."""
|
||||||
|
if entry.Key.provider == "gitea":
|
||||||
|
return _provision_dynamic_key(entry, slug, stage_dir)
|
||||||
|
return entry.IdentityFile
|
||||||
|
|
||||||
|
|
||||||
class GitGate(ABC):
|
class GitGate(ABC):
|
||||||
"""The per-agent git-gate. Encapsulates the host-side prepare
|
"""The per-agent git-gate. Encapsulates the host-side prepare
|
||||||
(upstream lift + entrypoint/hook render); the sidecar's
|
(upstream lift + entrypoint/hook render); the sidecar's
|
||||||
start/stop lifecycle is backend-specific and lives on concrete
|
start/stop lifecycle is backend-specific and lives on concrete
|
||||||
subclasses."""
|
subclasses."""
|
||||||
|
|
||||||
def prepare(self, bottle: Bottle, slug: str, stage_dir: Path) -> GitGatePlan:
|
def prepare(self, bottle: ManifestBottle, slug: str, stage_dir: Path) -> GitGatePlan:
|
||||||
"""Compute the upstream table from `bottle.git` and write the
|
"""Compute the upstream table from `bottle.git` and write the
|
||||||
entrypoint, pre-receive hook, and access-hook scripts (mode
|
entrypoint, pre-receive hook, and access-hook scripts (mode
|
||||||
600) under `stage_dir`. Pure host-side, no docker subprocess.
|
600) under `stage_dir`. Pure host-side, no docker subprocess.
|
||||||
|
|
||||||
|
For `gitea` key entries, also generates and registers
|
||||||
|
a fresh deploy key via the forge API and writes the private key
|
||||||
|
+ key ID to `stage_dir`.
|
||||||
|
|
||||||
Returned plan is incomplete: the launch step must fill
|
Returned plan is incomplete: the launch step must fill
|
||||||
`internal_network` / `egress_network` via `dataclasses.replace`
|
`internal_network` / `egress_network` via `dataclasses.replace`
|
||||||
before passing the plan to `.start`."""
|
before passing the plan to `.start`."""
|
||||||
upstreams = git_gate_upstreams_for_bottle(bottle)
|
upstreams_list = list(git_gate_upstreams_for_bottle(bottle))
|
||||||
|
for i, entry in enumerate(bottle.git):
|
||||||
|
upstreams_list[i] = dataclasses.replace(
|
||||||
|
upstreams_list[i],
|
||||||
|
identity_file=_resolve_identity_file(entry, slug, stage_dir),
|
||||||
|
)
|
||||||
|
upstreams = tuple(upstreams_list)
|
||||||
entrypoint = stage_dir / "git_gate_entrypoint.sh"
|
entrypoint = stage_dir / "git_gate_entrypoint.sh"
|
||||||
entrypoint.write_text(git_gate_render_entrypoint(upstreams))
|
entrypoint.write_text(git_gate_render_entrypoint(upstreams))
|
||||||
entrypoint.chmod(0o600)
|
entrypoint.chmod(0o600)
|
||||||
@@ -397,11 +496,32 @@ class GitGate(ABC):
|
|||||||
# not via `sh`, so the script needs the x bit. docker cp
|
# not via `sh`, so the script needs the x bit. docker cp
|
||||||
# preserves source mode into the container.
|
# preserves source mode into the container.
|
||||||
access_hook.chmod(0o700)
|
access_hook.chmod(0o700)
|
||||||
|
upstreams_with_files: list[GitGateUpstream] = []
|
||||||
|
for u in upstreams:
|
||||||
|
known_hosts_file = Path()
|
||||||
|
if u.known_host_key:
|
||||||
|
known_hosts_file = stage_dir / f"{u.name}-known_hosts"
|
||||||
|
known_hosts_file.write_text(
|
||||||
|
git_gate_known_hosts_line(
|
||||||
|
u.upstream_host, u.upstream_port, u.known_host_key,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
known_hosts_file.chmod(0o600)
|
||||||
|
upstreams_with_files.append(
|
||||||
|
GitGateUpstream(
|
||||||
|
name=u.name,
|
||||||
|
upstream_url=u.upstream_url,
|
||||||
|
upstream_host=u.upstream_host,
|
||||||
|
upstream_port=u.upstream_port,
|
||||||
|
identity_file=u.identity_file,
|
||||||
|
known_host_key=u.known_host_key,
|
||||||
|
known_hosts_file=known_hosts_file,
|
||||||
|
)
|
||||||
|
)
|
||||||
return GitGatePlan(
|
return GitGatePlan(
|
||||||
slug=slug,
|
slug=slug,
|
||||||
entrypoint_script=entrypoint,
|
entrypoint_script=entrypoint,
|
||||||
hook_script=hook,
|
hook_script=hook,
|
||||||
access_hook_script=access_hook,
|
access_hook_script=access_hook,
|
||||||
upstreams=upstreams,
|
upstreams=tuple(upstreams_with_files),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
"""Tiny smart-HTTP wrapper for git-gate repos.
|
||||||
|
|
||||||
|
Used by the smolmachines backend where `git://` push traffic over the
|
||||||
|
host-published Docker port can hang before receive-pack reaches hooks.
|
||||||
|
The wrapper serves the same `/git/*.git` bare repos through
|
||||||
|
`git http-backend`, so pre-receive and upstream forwarding remain the
|
||||||
|
git-gate enforcement point.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
||||||
|
from pathlib import Path
|
||||||
|
from urllib.parse import urlsplit
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_PORT = 9420
|
||||||
|
|
||||||
|
# Bound memory use while still allowing ordinary git push packfiles.
|
||||||
|
MAX_BODY_BYTES = 100 * 1024 * 1024
|
||||||
|
|
||||||
|
|
||||||
|
class GitHttpHandler(BaseHTTPRequestHandler):
|
||||||
|
server_version = "bot-bottle-git-http/1"
|
||||||
|
|
||||||
|
def do_GET(self) -> None:
|
||||||
|
self._run_backend()
|
||||||
|
|
||||||
|
def do_POST(self) -> None:
|
||||||
|
self._run_backend()
|
||||||
|
|
||||||
|
def _run_backend(self) -> None:
|
||||||
|
parsed = urlsplit(self.path)
|
||||||
|
if self._is_upload_pack(parsed.path, parsed.query):
|
||||||
|
repo_dir = self._repo_dir(parsed.path)
|
||||||
|
if repo_dir is None:
|
||||||
|
self.send_error(404)
|
||||||
|
return
|
||||||
|
hook_path = os.environ.get(
|
||||||
|
"GIT_GATE_ACCESS_HOOK", "/etc/git-gate/access-hook",
|
||||||
|
)
|
||||||
|
peer = self.client_address[0]
|
||||||
|
hook = subprocess.run(
|
||||||
|
[hook_path, "upload-pack", str(repo_dir), peer, peer],
|
||||||
|
capture_output=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if hook.returncode != 0:
|
||||||
|
detail = (hook.stderr or hook.stdout).decode(
|
||||||
|
"utf-8", errors="replace",
|
||||||
|
).rstrip()
|
||||||
|
if detail:
|
||||||
|
for line in detail.splitlines():
|
||||||
|
self.log_message("access-hook denied %s: %s",
|
||||||
|
parsed.path, line)
|
||||||
|
else:
|
||||||
|
self.log_message(
|
||||||
|
"access-hook denied %s: exit=%d (no output)",
|
||||||
|
parsed.path, hook.returncode,
|
||||||
|
)
|
||||||
|
self.send_response(403)
|
||||||
|
self.send_header("Content-Type", "text/plain; charset=utf-8")
|
||||||
|
self.end_headers()
|
||||||
|
self.wfile.write(hook.stderr or hook.stdout)
|
||||||
|
return
|
||||||
|
env = os.environ.copy()
|
||||||
|
env.update({
|
||||||
|
"GIT_PROJECT_ROOT": os.environ.get("GIT_PROJECT_ROOT", "/git"),
|
||||||
|
"GIT_HTTP_EXPORT_ALL": "1",
|
||||||
|
"REQUEST_METHOD": self.command,
|
||||||
|
"PATH_INFO": parsed.path,
|
||||||
|
"QUERY_STRING": parsed.query,
|
||||||
|
"CONTENT_TYPE": self.headers.get("content-type", ""),
|
||||||
|
"CONTENT_LENGTH": self.headers.get("content-length", "0"),
|
||||||
|
"REMOTE_ADDR": self.client_address[0],
|
||||||
|
"REMOTE_PORT": str(self.client_address[1]),
|
||||||
|
"REMOTE_USER": "",
|
||||||
|
"SERVER_NAME": self.server.server_name, # type: ignore
|
||||||
|
"SERVER_PORT": str(self.server.server_port), # type: ignore
|
||||||
|
"SERVER_PROTOCOL": self.request_version,
|
||||||
|
})
|
||||||
|
for header, variable in (
|
||||||
|
("accept", "HTTP_ACCEPT"),
|
||||||
|
("content-encoding", "HTTP_CONTENT_ENCODING"),
|
||||||
|
("git-protocol", "HTTP_GIT_PROTOCOL"),
|
||||||
|
("user-agent", "HTTP_USER_AGENT"),
|
||||||
|
):
|
||||||
|
value = self.headers.get(header)
|
||||||
|
if value:
|
||||||
|
env[variable] = value
|
||||||
|
raw_length = self.headers.get("content-length", "0") or "0"
|
||||||
|
try:
|
||||||
|
length = int(raw_length)
|
||||||
|
except ValueError:
|
||||||
|
self.send_error(400, "Bad Content-Length")
|
||||||
|
return
|
||||||
|
if length < 0:
|
||||||
|
self.send_error(400, "Negative Content-Length")
|
||||||
|
return
|
||||||
|
if length > MAX_BODY_BYTES:
|
||||||
|
self.send_error(413, "Request body too large")
|
||||||
|
return
|
||||||
|
body = self.rfile.read(length) if length else b""
|
||||||
|
proc = subprocess.run(
|
||||||
|
["git", "http-backend"],
|
||||||
|
input=body,
|
||||||
|
env=env,
|
||||||
|
capture_output=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
self._write_cgi_response(proc.stdout)
|
||||||
|
|
||||||
|
def _repo_dir(self, path: str) -> Path | None:
|
||||||
|
root = Path(os.environ.get("GIT_PROJECT_ROOT", "/git")).resolve()
|
||||||
|
relative = path.lstrip("/").split(".git", 1)[0] + ".git"
|
||||||
|
candidate = (root / relative).resolve()
|
||||||
|
if root not in (candidate, *candidate.parents):
|
||||||
|
return None
|
||||||
|
if not candidate.is_dir():
|
||||||
|
return None
|
||||||
|
return candidate
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _is_upload_pack(path: str, query: str) -> bool:
|
||||||
|
if path.endswith("/git-upload-pack"):
|
||||||
|
return True
|
||||||
|
if path.endswith("/info/refs"):
|
||||||
|
return any(
|
||||||
|
pair == "service=git-upload-pack"
|
||||||
|
for pair in query.split("&")
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _write_cgi_response(self, raw: bytes) -> None:
|
||||||
|
head, sep, body = raw.partition(b"\r\n\r\n")
|
||||||
|
line_sep = b"\r\n"
|
||||||
|
if not sep:
|
||||||
|
head, sep, body = raw.partition(b"\n\n")
|
||||||
|
line_sep = b"\n"
|
||||||
|
status = 200
|
||||||
|
headers: list[tuple[str, str]] = []
|
||||||
|
for line in head.split(line_sep):
|
||||||
|
if not line:
|
||||||
|
continue
|
||||||
|
key, _, value = line.decode("latin1").partition(":")
|
||||||
|
value = value.strip()
|
||||||
|
if key.lower() == "status":
|
||||||
|
status = int(value.split()[0])
|
||||||
|
else:
|
||||||
|
headers.append((key, value))
|
||||||
|
self.send_response(status)
|
||||||
|
for key, value in headers:
|
||||||
|
self.send_header(key, value)
|
||||||
|
self.end_headers()
|
||||||
|
self.wfile.write(body)
|
||||||
|
|
||||||
|
def log_message(self, format: str, *args: object) -> None: # type: ignore # noqa: A002
|
||||||
|
sys.stdout.write(format % args + "\n")
|
||||||
|
sys.stdout.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
port = int(os.environ.get("GIT_HTTP_PORT", str(DEFAULT_PORT)))
|
||||||
|
server = ThreadingHTTPServer(("0.0.0.0", port), GitHttpHandler)
|
||||||
|
sys.stdout.write(f"git-http listening on 0.0.0.0:{port}\n")
|
||||||
|
sys.stdout.flush()
|
||||||
|
server.serve_forever()
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
"""Tiny logging wrappers. All output goes to stderr."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import sys
|
||||||
|
from typing import NoReturn
|
||||||
|
|
||||||
|
|
||||||
|
def info(msg: str) -> None:
|
||||||
|
print(f"bot-bottle: {msg}", file=sys.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
def warn(msg: str) -> None:
|
||||||
|
print(f"bot-bottle: warning: {msg}", file=sys.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
def error(msg: str) -> None:
|
||||||
|
print(f"bot-bottle: error: {msg}", file=sys.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
class Die(SystemExit):
|
||||||
|
"""Raised by die() so callers (and tests) can distinguish a deliberate
|
||||||
|
fatal exit from an unrelated SystemExit.
|
||||||
|
|
||||||
|
Carries the human-facing message so a caller that suppressed stderr
|
||||||
|
— e.g. the curses dashboard, whose alternate screen is wiped when the
|
||||||
|
terminal is restored — can re-surface the reason after the fact."""
|
||||||
|
|
||||||
|
def __init__(self, code: int = 1, message: str = "") -> None:
|
||||||
|
super().__init__(code)
|
||||||
|
self.message = message
|
||||||
|
|
||||||
|
|
||||||
|
def die(msg: str) -> NoReturn:
|
||||||
|
error(msg)
|
||||||
|
raise Die(1, msg)
|
||||||
@@ -0,0 +1,385 @@
|
|||||||
|
"""Manifest dataclasses (PRD 0011 layout).
|
||||||
|
|
||||||
|
Reads the per-file manifest tree:
|
||||||
|
|
||||||
|
$HOME/.bot-bottle/bottles/<name>.md — one bottle per file
|
||||||
|
$HOME/.bot-bottle/agents/<name>.md — home-resident agents
|
||||||
|
$CWD/.bot-bottle/agents/<name>.md — cwd-supplied agents
|
||||||
|
|
||||||
|
Each file is Markdown with YAML frontmatter. The frontmatter holds
|
||||||
|
the structured config (see schema below); for agents the body is
|
||||||
|
the system prompt, for bottles the body is human documentation
|
||||||
|
(ignored by the parser).
|
||||||
|
|
||||||
|
Bottle schema (frontmatter):
|
||||||
|
extends: <bottle-name> # optional (PRD 0025)
|
||||||
|
env: { <NAME>: <env-entry>, ... }
|
||||||
|
git-gate: # optional (PRD 0047)
|
||||||
|
user: { name: <str>, email: <str> } # optional
|
||||||
|
repos: { <name>: <git-gate-entry>, ... } # optional
|
||||||
|
egress: { routes: [ <egress-route>, ... ] }
|
||||||
|
# route keys: host, matches, auth, role, dlp
|
||||||
|
supervise: <bool> # optional
|
||||||
|
|
||||||
|
Agent schema (frontmatter):
|
||||||
|
bottle: <bottle-name> # required
|
||||||
|
skills: [ <skill-name>, ... ] # optional
|
||||||
|
git-gate:
|
||||||
|
user: { name: <str>, email: <str> } # optional; overlays bottle
|
||||||
|
# Claude Code subagent passthrough fields — accepted, ignored:
|
||||||
|
name, description, model, color, memory
|
||||||
|
|
||||||
|
The agent file's Markdown body is the system prompt (stripped).
|
||||||
|
Unknown top-level frontmatter keys raise ManifestError with a hint.
|
||||||
|
|
||||||
|
Bottles can ONLY live under $HOME. A bottles/ dir under $CWD is a
|
||||||
|
warn at load time and contributes nothing. The trust boundary is
|
||||||
|
expressed as filesystem layout rather than resolver logic.
|
||||||
|
|
||||||
|
Validation runs once at load. Manifest.from_json_obj is preserved
|
||||||
|
as a programmatic entry point (used by tests) that takes a dict
|
||||||
|
with the same field names — useful for building manifests without
|
||||||
|
on-disk files.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass, field, replace
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Mapping
|
||||||
|
|
||||||
|
from .manifest_util import ManifestError, as_json_object
|
||||||
|
from .manifest_agent import ManifestAgent, ManifestAgentProvider
|
||||||
|
from .manifest_egress import (
|
||||||
|
EGRESS_AUTH_SCHEMES,
|
||||||
|
ManifestEgressConfig,
|
||||||
|
ManifestEgressRoute,
|
||||||
|
)
|
||||||
|
from .manifest_git import ManifestGitEntry, ManifestGitUser, ManifestKeyConfig, parse_git_gate_config
|
||||||
|
from .manifest_schema import BOTTLE_KEYS
|
||||||
|
|
||||||
|
# Re-export everything that callers currently import from this module.
|
||||||
|
__all__ = [
|
||||||
|
"ManifestError",
|
||||||
|
"ManifestGitEntry",
|
||||||
|
"ManifestGitUser",
|
||||||
|
"ManifestKeyConfig",
|
||||||
|
"ManifestAgentProvider",
|
||||||
|
"EGRESS_AUTH_SCHEMES",
|
||||||
|
"ManifestEgressRoute",
|
||||||
|
"ManifestEgressConfig",
|
||||||
|
"ManifestAgent",
|
||||||
|
"ManifestBottle",
|
||||||
|
"Manifest",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _empty_str_dict() -> dict[str, str]:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def _section_dict(value: object, label: str) -> dict[str, object]:
|
||||||
|
"""Like as_json_object but treats absent/null as an empty section."""
|
||||||
|
if value is None:
|
||||||
|
return {}
|
||||||
|
return as_json_object(value, label)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ManifestBottle:
|
||||||
|
env: Mapping[str, str] = field(default_factory=_empty_str_dict)
|
||||||
|
agent_provider: ManifestAgentProvider = field(default_factory=ManifestAgentProvider)
|
||||||
|
git: tuple[ManifestGitEntry, ...] = ()
|
||||||
|
# Per-bottle git identity (issue #86). Empty default — bottles
|
||||||
|
# that don't set `git-gate.user:` in the manifest skip the
|
||||||
|
# `git config --global` step entirely. A bottle can declare a user
|
||||||
|
# identity without any git-gate.repos upstreams, and vice versa.
|
||||||
|
git_user: ManifestGitUser = field(default_factory=ManifestGitUser)
|
||||||
|
egress: ManifestEgressConfig = field(default_factory=ManifestEgressConfig)
|
||||||
|
# Opt-in per-bottle stuck-recovery sidecar (PRD 0013). When true,
|
||||||
|
# the launch step brings up a supervise sidecar that exposes MCP
|
||||||
|
# tools to the agent (egress-block, capability-block) plus mounts
|
||||||
|
# the current-config dir read-only into the agent at
|
||||||
|
# /etc/bot-bottle/current-config. False (the default) skips the
|
||||||
|
# sidecar and mount.
|
||||||
|
supervise: bool = False
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_dict(cls, name: str, raw: object) -> "ManifestBottle":
|
||||||
|
d = as_json_object(raw, f"bottle '{name}'")
|
||||||
|
|
||||||
|
if "runtime" in d:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' has a 'runtime' field, which is no longer "
|
||||||
|
f"supported. gVisor (runsc) is now auto-detected by the "
|
||||||
|
f"backend; remove the 'runtime' field from the bottle "
|
||||||
|
f"definition."
|
||||||
|
)
|
||||||
|
|
||||||
|
if "ssh" in d:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' has an 'ssh' field, which has been removed "
|
||||||
|
f"(PRD 0009). Declare upstreams under 'git-gate.repos' with "
|
||||||
|
f"url + identity + host_key; the git-gate sidecar (PRD 0008) "
|
||||||
|
f"holds the credential and gitleaks-scans pushes."
|
||||||
|
)
|
||||||
|
|
||||||
|
if "git" in d:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' uses 'git' which has been replaced by "
|
||||||
|
f"'git-gate' (PRD 0047). Move git.user → git-gate.user "
|
||||||
|
f"and git.remotes → git-gate.repos (fields: url, identity, host_key)."
|
||||||
|
)
|
||||||
|
|
||||||
|
if "git_user" in d:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' has a 'git_user' field, which has been "
|
||||||
|
f"removed. Move it under 'git-gate.user'."
|
||||||
|
)
|
||||||
|
|
||||||
|
unknown = set(d.keys()) - BOTTLE_KEYS
|
||||||
|
if unknown:
|
||||||
|
allowed = ", ".join(sorted(BOTTLE_KEYS))
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' has unknown key(s) {sorted(unknown)}; "
|
||||||
|
f"allowed keys are {allowed}."
|
||||||
|
)
|
||||||
|
|
||||||
|
env: dict[str, str] = {}
|
||||||
|
env_raw = d.get("env")
|
||||||
|
if env_raw is not None:
|
||||||
|
env_dict = as_json_object(env_raw, f"bottle '{name}' env")
|
||||||
|
for var, value in env_dict.items():
|
||||||
|
if not isinstance(value, str):
|
||||||
|
raise ManifestError(
|
||||||
|
f"env entry {var} in bottle '{name}' must be a JSON string "
|
||||||
|
f"(was {type(value).__name__}). Use \"?<message>\" for prompt-at-runtime."
|
||||||
|
)
|
||||||
|
env[var] = value
|
||||||
|
|
||||||
|
git: tuple[ManifestGitEntry, ...] = ()
|
||||||
|
git_user = ManifestGitUser()
|
||||||
|
git_raw = d.get("git-gate")
|
||||||
|
if git_raw is not None:
|
||||||
|
git, git_user = parse_git_gate_config(name, git_raw)
|
||||||
|
|
||||||
|
agent_provider = (
|
||||||
|
ManifestAgentProvider.from_dict(name, d["agent_provider"])
|
||||||
|
if "agent_provider" in d
|
||||||
|
else ManifestAgentProvider()
|
||||||
|
)
|
||||||
|
|
||||||
|
egress = (
|
||||||
|
ManifestEgressConfig.from_dict(name, d["egress"])
|
||||||
|
if "egress" in d
|
||||||
|
else ManifestEgressConfig()
|
||||||
|
)
|
||||||
|
|
||||||
|
supervise_raw = d.get("supervise", False)
|
||||||
|
if not isinstance(supervise_raw, bool):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' supervise must be a boolean "
|
||||||
|
f"(was {type(supervise_raw).__name__})"
|
||||||
|
)
|
||||||
|
|
||||||
|
return cls(
|
||||||
|
env=env, agent_provider=agent_provider, git=git,
|
||||||
|
git_user=git_user, egress=egress, supervise=supervise_raw,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Manifest:
|
||||||
|
bottles: Mapping[str, ManifestBottle]
|
||||||
|
agents: Mapping[str, ManifestAgent]
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def resolve(cls, cwd: str, *, missing_ok: bool = False) -> "Manifest":
|
||||||
|
"""Walk the per-file manifest tree and build a Manifest.
|
||||||
|
|
||||||
|
Layout (PRD 0011):
|
||||||
|
$HOME/.bot-bottle/bottles/<name>.md — bottles (home-only)
|
||||||
|
$HOME/.bot-bottle/agents/<name>.md — home agents
|
||||||
|
$CWD/.bot-bottle/agents/<name>.md — cwd agents
|
||||||
|
|
||||||
|
Cwd agents merge into the home agents on the same name
|
||||||
|
(cwd wins). A bottles/ subdir under $CWD is logged as a
|
||||||
|
warning and ignored — the filesystem layout IS the trust
|
||||||
|
boundary.
|
||||||
|
|
||||||
|
If `missing_ok` is true, a missing `$HOME/.bot-bottle/`
|
||||||
|
returns an empty manifest instead of dying. This is for
|
||||||
|
passive UI surfaces like the dashboard, which can still
|
||||||
|
monitor already-running agents without launch config.
|
||||||
|
|
||||||
|
If `bot-bottle.json` exists alongside a missing
|
||||||
|
`.bot-bottle/` directory at either side, dies with a
|
||||||
|
clear pointer at the README's manifest section — the
|
||||||
|
manifest format changed in PRD 0011 and we don't silently
|
||||||
|
fall back."""
|
||||||
|
home_dir = Path(os.environ["HOME"])
|
||||||
|
cwd_dir = Path(cwd)
|
||||||
|
home_md = home_dir / ".bot-bottle"
|
||||||
|
cwd_md = cwd_dir / ".bot-bottle"
|
||||||
|
|
||||||
|
from .manifest_loader import check_stale_json
|
||||||
|
|
||||||
|
check_stale_json(home_dir, home_md, "$HOME")
|
||||||
|
if cwd_dir.resolve() != home_dir.resolve():
|
||||||
|
check_stale_json(cwd_dir, cwd_md, "$CWD")
|
||||||
|
|
||||||
|
if not home_md.is_dir():
|
||||||
|
if missing_ok:
|
||||||
|
return cls.from_json_obj({"bottles": {}, "agents": {}})
|
||||||
|
raise ManifestError(
|
||||||
|
f"no manifest found: {home_md} does not exist. "
|
||||||
|
f"See README.md for the per-file Markdown layout "
|
||||||
|
f"(PRD 0011)."
|
||||||
|
)
|
||||||
|
|
||||||
|
# When CWD == HOME (running from $HOME directly), pass the
|
||||||
|
# same dir for both — _load_md_dirs will dedupe.
|
||||||
|
cwd_md_arg = cwd_md if cwd_md.is_dir() and cwd_dir.resolve() != home_dir.resolve() else None
|
||||||
|
return cls.from_md_dirs(home_md, cwd_md_arg)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_md_dirs(
|
||||||
|
cls,
|
||||||
|
home_dir: Path,
|
||||||
|
cwd_dir: Path | None,
|
||||||
|
) -> "Manifest":
|
||||||
|
"""Programmatic entry point. Loads bottles from
|
||||||
|
`<home_dir>/bottles/`, home agents from `<home_dir>/agents/`,
|
||||||
|
and (if `cwd_dir` is passed) cwd agents from
|
||||||
|
`<cwd_dir>/agents/`. Cwd agents override home agents on
|
||||||
|
name collision. A `bottles/` subdir under `cwd_dir` is
|
||||||
|
logged as a warning and ignored.
|
||||||
|
|
||||||
|
Used by tests to build a Manifest from fixture directories
|
||||||
|
without touching `os.environ`."""
|
||||||
|
bottles_dir = home_dir / "bottles"
|
||||||
|
from .manifest_loader import load_agents_from_dir, load_bottles_from_dir
|
||||||
|
|
||||||
|
bottles = load_bottles_from_dir(bottles_dir)
|
||||||
|
|
||||||
|
bottle_names = set(bottles.keys())
|
||||||
|
agents_dir = home_dir / "agents"
|
||||||
|
agents = load_agents_from_dir(agents_dir, bottle_names, source="$HOME")
|
||||||
|
|
||||||
|
if cwd_dir is not None:
|
||||||
|
stale_bottles = cwd_dir / "bottles"
|
||||||
|
if stale_bottles.is_dir():
|
||||||
|
files = sorted(stale_bottles.glob("*.md"))
|
||||||
|
if files:
|
||||||
|
names = ", ".join(p.name for p in files)
|
||||||
|
from .log import warn
|
||||||
|
warn(
|
||||||
|
f"ignoring bottle file(s) under "
|
||||||
|
f"{stale_bottles}: {names}. Bottles can only "
|
||||||
|
f"live under $HOME/.bot-bottle/bottles/ "
|
||||||
|
f"(PRD 0011). Move them or delete."
|
||||||
|
)
|
||||||
|
cwd_agents_dir = cwd_dir / "agents"
|
||||||
|
cwd_agents = load_agents_from_dir(
|
||||||
|
cwd_agents_dir, bottle_names, source="$CWD"
|
||||||
|
)
|
||||||
|
agents = {**agents, **cwd_agents}
|
||||||
|
|
||||||
|
return cls(bottles=bottles, agents=agents)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_json_obj(cls, obj: object) -> "Manifest":
|
||||||
|
"""Validate and build a Manifest from a raw JSON-like dict."""
|
||||||
|
d = as_json_object(obj, "manifest")
|
||||||
|
raw_bottles_obj = _section_dict(d.get("bottles"), "manifest 'bottles'")
|
||||||
|
raw_agents = _section_dict(d.get("agents"), "manifest 'agents'")
|
||||||
|
|
||||||
|
# Coerce each bottle's raw to dict[str, object] so the
|
||||||
|
# PRD 0025 resolver can apply extends-merge rules
|
||||||
|
# consistently with the md-loader path.
|
||||||
|
raw_bottles: dict[str, dict[str, object]] = {}
|
||||||
|
for n, b in raw_bottles_obj.items():
|
||||||
|
raw_bottles[n] = as_json_object(b, f"bottle '{n}'")
|
||||||
|
from .manifest_extends import resolve_bottles
|
||||||
|
|
||||||
|
bottles = resolve_bottles(raw_bottles)
|
||||||
|
|
||||||
|
bottle_names = set(bottles.keys())
|
||||||
|
agents: dict[str, ManifestAgent] = {
|
||||||
|
n: ManifestAgent.from_dict(n, a, bottle_names) for n, a in raw_agents.items()
|
||||||
|
}
|
||||||
|
return cls(bottles=bottles, agents=agents)
|
||||||
|
|
||||||
|
def has_agent(self, name: str) -> bool:
|
||||||
|
return name in self.agents
|
||||||
|
|
||||||
|
def require_agent(self, name: str) -> None:
|
||||||
|
if self.has_agent(name):
|
||||||
|
return
|
||||||
|
available = ", ".join(self.agents.keys())
|
||||||
|
if available:
|
||||||
|
msg = f"agent '{name}' not defined in bot-bottle.json. Available: {available}"
|
||||||
|
raise ManifestError(msg)
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' not defined in bot-bottle.json (manifest is empty)."
|
||||||
|
)
|
||||||
|
|
||||||
|
def has_bottle(self, name: str) -> bool:
|
||||||
|
return name in self.bottles
|
||||||
|
|
||||||
|
def require_bottle(self, name: str) -> None:
|
||||||
|
if self.has_bottle(name):
|
||||||
|
return
|
||||||
|
available = ", ".join(self.bottles.keys())
|
||||||
|
if available:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{name}' not defined in bot-bottle.json. "
|
||||||
|
f"Available bottles: {available}"
|
||||||
|
)
|
||||||
|
raise ManifestError(f"bottle '{name}' not defined in bot-bottle.json (no bottles defined).")
|
||||||
|
|
||||||
|
def _effective_git_user(self, agent_name: str) -> ManifestGitUser:
|
||||||
|
"""Merge the agent's git.user over the referenced bottle's,
|
||||||
|
per-field, agent-wins-on-non-empty (issue #94). Same overlay
|
||||||
|
the `extends:` resolver applies between bottles
|
||||||
|
(`_merge_bottles`)."""
|
||||||
|
agent = self.agents[agent_name]
|
||||||
|
base = self.bottles[agent.bottle].git_user
|
||||||
|
over = agent.git_user
|
||||||
|
if over.is_empty():
|
||||||
|
return base
|
||||||
|
return ManifestGitUser(
|
||||||
|
name=over.name or base.name,
|
||||||
|
email=over.email or base.email,
|
||||||
|
)
|
||||||
|
|
||||||
|
def bottle_for(self, agent_name: str) -> ManifestBottle:
|
||||||
|
"""Resolve the Bottle the named agent references, with the
|
||||||
|
agent's git.user overlaid on top. The validator guarantees both
|
||||||
|
lookups succeed for a manifest built via from_json_obj.
|
||||||
|
|
||||||
|
The overlay lives here, the single point both backends call to
|
||||||
|
resolve an agent's bottle, so the docker / smolmachines git
|
||||||
|
provisioners pick up the merged identity unchanged."""
|
||||||
|
bottle = self.bottles[self.agents[agent_name].bottle]
|
||||||
|
merged = self._effective_git_user(agent_name)
|
||||||
|
if merged == bottle.git_user:
|
||||||
|
return bottle
|
||||||
|
return replace(bottle, git_user=merged)
|
||||||
|
|
||||||
|
def git_identity_summary(self, agent_name: str) -> str | None:
|
||||||
|
"""One-line effective git identity with per-field provenance
|
||||||
|
for launch summaries, e.g.
|
||||||
|
`name=claude (agent), email=eric@dideric.is (bottle)`.
|
||||||
|
Returns None when neither agent nor bottle sets an identity."""
|
||||||
|
over = self.agents[agent_name].git_user
|
||||||
|
merged = self._effective_git_user(agent_name)
|
||||||
|
if merged.is_empty():
|
||||||
|
return None
|
||||||
|
parts: list[str] = []
|
||||||
|
if merged.name:
|
||||||
|
parts.append(f"name={merged.name} ({'agent' if over.name else 'bottle'})")
|
||||||
|
if merged.email:
|
||||||
|
parts.append(f"email={merged.email} ({'agent' if over.email else 'bottle'})")
|
||||||
|
return ", ".join(parts)
|
||||||
@@ -0,0 +1,276 @@
|
|||||||
|
"""Agent configuration manifest dataclasses."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from typing import cast
|
||||||
|
|
||||||
|
from .agent_provider import PROVIDER_TEMPLATES
|
||||||
|
from .manifest_util import ManifestError, as_json_object
|
||||||
|
from .manifest_git import ManifestGitUser
|
||||||
|
from .manifest_schema import AGENT_MODEL_KEYS
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ManifestAgentProvider:
|
||||||
|
"""Provider/template for the agent process inside a bottle.
|
||||||
|
|
||||||
|
`template` selects a built-in launch/runtime contract. `dockerfile`
|
||||||
|
optionally points at a custom agent-image Dockerfile while leaving
|
||||||
|
bot-bottle's sidecar infrastructure intact.
|
||||||
|
|
||||||
|
`auth_token` names the host env var that holds the provider's OAuth
|
||||||
|
token (Claude only). The provisioner injects a provider-owned egress
|
||||||
|
route for api.anthropic.com that re-injects this token as the Bearer
|
||||||
|
header, and sets a placeholder CLAUDE_CODE_OAUTH_TOKEN in the agent
|
||||||
|
so the Claude Code CLI starts.
|
||||||
|
|
||||||
|
`forward_host_credentials` forwards the host Codex auth token into
|
||||||
|
the egress sidecar (Codex only).
|
||||||
|
"""
|
||||||
|
|
||||||
|
template: str = "claude"
|
||||||
|
dockerfile: str = ""
|
||||||
|
auth_token: str = ""
|
||||||
|
forward_host_credentials: bool = False
|
||||||
|
settings: dict[str, object] = field(default_factory=dict)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_dict(cls, bottle_name: str, raw: object) -> "ManifestAgentProvider":
|
||||||
|
d = as_json_object(raw, f"bottle '{bottle_name}' agent_provider")
|
||||||
|
for k in d:
|
||||||
|
if k not in {
|
||||||
|
"template",
|
||||||
|
"dockerfile",
|
||||||
|
"auth_token",
|
||||||
|
"forward_host_credentials",
|
||||||
|
"settings",
|
||||||
|
}:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider has unknown key {k!r}; "
|
||||||
|
"allowed: template, dockerfile, auth_token, "
|
||||||
|
"forward_host_credentials, settings"
|
||||||
|
)
|
||||||
|
template = d.get("template", "claude")
|
||||||
|
if not isinstance(template, str) or not template:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.template must be a "
|
||||||
|
f"non-empty string"
|
||||||
|
)
|
||||||
|
dockerfile = d.get("dockerfile", "")
|
||||||
|
if not isinstance(dockerfile, str):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.dockerfile must be a "
|
||||||
|
f"string (was {type(dockerfile).__name__})"
|
||||||
|
)
|
||||||
|
auth_token = d.get("auth_token", "")
|
||||||
|
if not isinstance(auth_token, str):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.auth_token must be a "
|
||||||
|
f"string (was {type(auth_token).__name__})"
|
||||||
|
)
|
||||||
|
if auth_token and template not in PROVIDER_TEMPLATES:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.auth_token is only "
|
||||||
|
f"supported for built-in templates "
|
||||||
|
f"({', '.join(sorted(PROVIDER_TEMPLATES))})"
|
||||||
|
)
|
||||||
|
if auth_token and template != "claude":
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.auth_token is only "
|
||||||
|
f"supported for template 'claude'"
|
||||||
|
)
|
||||||
|
forward_host_credentials = d.get("forward_host_credentials", False)
|
||||||
|
if not isinstance(forward_host_credentials, bool):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
||||||
|
f"must be a boolean (was {type(forward_host_credentials).__name__})"
|
||||||
|
)
|
||||||
|
if forward_host_credentials and template not in PROVIDER_TEMPLATES:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
||||||
|
f"is only supported for built-in templates "
|
||||||
|
f"({', '.join(sorted(PROVIDER_TEMPLATES))})"
|
||||||
|
)
|
||||||
|
if forward_host_credentials and template != "codex":
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.forward_host_credentials "
|
||||||
|
"is currently only supported for template 'codex'"
|
||||||
|
)
|
||||||
|
settings = _parse_provider_settings(bottle_name, template, d.get("settings"))
|
||||||
|
return cls(
|
||||||
|
template=template,
|
||||||
|
dockerfile=dockerfile,
|
||||||
|
auth_token=auth_token,
|
||||||
|
forward_host_credentials=forward_host_credentials,
|
||||||
|
settings=settings,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ManifestAgent:
|
||||||
|
bottle: str
|
||||||
|
skills: tuple[str, ...] = ()
|
||||||
|
prompt: str = ""
|
||||||
|
# Per-agent git identity (issue #94). Overlays the referenced
|
||||||
|
# bottle's git-gate.user per-field at `Manifest.bottle_for`. Only
|
||||||
|
# `user` is allowed at the agent level; `repos` stays bottle-only
|
||||||
|
# because it carries credentials and host trust.
|
||||||
|
git_user: ManifestGitUser = ManifestGitUser()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_dict(cls, name: str, raw: object, bottle_names: set[str]) -> "ManifestAgent":
|
||||||
|
d = as_json_object(raw, f"agent '{name}'")
|
||||||
|
unknown = set(d.keys()) - AGENT_MODEL_KEYS
|
||||||
|
if unknown:
|
||||||
|
allowed = ", ".join(sorted(AGENT_MODEL_KEYS))
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' has unknown key(s) {sorted(unknown)}; "
|
||||||
|
f"allowed keys are {allowed}."
|
||||||
|
)
|
||||||
|
|
||||||
|
bottle = d.get("bottle")
|
||||||
|
if not isinstance(bottle, str) or not bottle:
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' must declare a 'bottle' field naming a "
|
||||||
|
f"defined bottle"
|
||||||
|
)
|
||||||
|
if bottle not in bottle_names:
|
||||||
|
available = ", ".join(sorted(bottle_names)) or "(none defined)"
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' references bottle '{bottle}', which is not defined. "
|
||||||
|
f"Available: {available}"
|
||||||
|
)
|
||||||
|
|
||||||
|
skills: tuple[str, ...] = ()
|
||||||
|
skills_raw = d.get("skills")
|
||||||
|
if skills_raw is not None:
|
||||||
|
if not isinstance(skills_raw, list):
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' skills must be an array "
|
||||||
|
f"(was {type(skills_raw).__name__})"
|
||||||
|
)
|
||||||
|
collected: list[str] = []
|
||||||
|
skills_list = cast(list[object], skills_raw)
|
||||||
|
for i, skill in enumerate(skills_list):
|
||||||
|
if not isinstance(skill, str):
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' skills[{i}] must be a string "
|
||||||
|
f"(was {type(skill).__name__})"
|
||||||
|
)
|
||||||
|
collected.append(skill)
|
||||||
|
skills = tuple(collected)
|
||||||
|
|
||||||
|
prompt_raw = d.get("prompt")
|
||||||
|
if prompt_raw is None:
|
||||||
|
prompt = ""
|
||||||
|
elif isinstance(prompt_raw, str):
|
||||||
|
prompt = prompt_raw
|
||||||
|
else:
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' prompt must be a string "
|
||||||
|
f"(was {type(prompt_raw).__name__})"
|
||||||
|
)
|
||||||
|
|
||||||
|
# git-gate: agents may declare only `git-gate.user` (name/email).
|
||||||
|
# `git-gate.repos` is bottle-only — it carries credentials and host trust.
|
||||||
|
git_user = ManifestGitUser()
|
||||||
|
git_raw = d.get("git-gate")
|
||||||
|
if git_raw is not None:
|
||||||
|
gd = as_json_object(git_raw, f"agent '{name}' git-gate")
|
||||||
|
for k in gd:
|
||||||
|
if k != "user":
|
||||||
|
raise ManifestError(
|
||||||
|
f"agent '{name}' git-gate.{k} is not allowed at the "
|
||||||
|
f"agent level; only git-gate.user (name/email) may be "
|
||||||
|
f"set on an agent. git-gate.repos is bottle-only "
|
||||||
|
f"(it carries credentials and host trust)."
|
||||||
|
)
|
||||||
|
if "user" in gd:
|
||||||
|
git_user = ManifestGitUser.from_dict(name, gd["user"])
|
||||||
|
|
||||||
|
return cls(bottle=bottle, skills=skills, prompt=prompt, git_user=git_user)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_provider_settings(
|
||||||
|
bottle_name: str,
|
||||||
|
template: str,
|
||||||
|
raw: object,
|
||||||
|
) -> dict[str, object]:
|
||||||
|
if raw is None:
|
||||||
|
return {}
|
||||||
|
if template != "pi":
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings is only "
|
||||||
|
"supported for template 'pi'"
|
||||||
|
)
|
||||||
|
settings = as_json_object(raw, f"bottle '{bottle_name}' agent_provider.settings")
|
||||||
|
allowed = {
|
||||||
|
"provider",
|
||||||
|
"base_url",
|
||||||
|
"api",
|
||||||
|
"api_key",
|
||||||
|
"api_key_env",
|
||||||
|
"models",
|
||||||
|
"context_window",
|
||||||
|
"max_tokens_field",
|
||||||
|
"max_tokens",
|
||||||
|
"supports_developer_role",
|
||||||
|
"supports_reasoning_effort",
|
||||||
|
}
|
||||||
|
for key in settings:
|
||||||
|
if key not in allowed:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings has unknown "
|
||||||
|
f"key {key!r}; allowed: {', '.join(sorted(allowed))}"
|
||||||
|
)
|
||||||
|
for key in ("provider", "base_url", "api", "api_key", "api_key_env"):
|
||||||
|
value = settings.get(key)
|
||||||
|
if value is not None and (not isinstance(value, str) or not value):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.{key} must "
|
||||||
|
"be a non-empty string"
|
||||||
|
)
|
||||||
|
max_tokens_field = settings.get("max_tokens_field")
|
||||||
|
if max_tokens_field is not None and max_tokens_field not in (
|
||||||
|
"max_tokens", "max_completion_tokens",
|
||||||
|
):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.max_tokens_field "
|
||||||
|
"must be 'max_tokens' or 'max_completion_tokens'"
|
||||||
|
)
|
||||||
|
if settings.get("api_key") is not None and settings.get("api_key_env") is not None:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings may set either "
|
||||||
|
"api_key or api_key_env, not both"
|
||||||
|
)
|
||||||
|
models = settings.get("models")
|
||||||
|
if models is not None:
|
||||||
|
if not isinstance(models, list) or not models:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.models must "
|
||||||
|
"be a non-empty array of strings"
|
||||||
|
)
|
||||||
|
for i, model in enumerate(models):
|
||||||
|
if not isinstance(model, str) or not model:
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.models[{i}] "
|
||||||
|
"must be a non-empty string"
|
||||||
|
)
|
||||||
|
for key in ("supports_developer_role", "supports_reasoning_effort"):
|
||||||
|
value = settings.get(key)
|
||||||
|
if value is not None and not isinstance(value, bool):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.{key} must "
|
||||||
|
f"be a boolean (was {type(value).__name__})"
|
||||||
|
)
|
||||||
|
for key in ("context_window", "max_tokens"):
|
||||||
|
value = settings.get(key)
|
||||||
|
if value is not None and (
|
||||||
|
not isinstance(value, int) or isinstance(value, bool) or value <= 0
|
||||||
|
):
|
||||||
|
raise ManifestError(
|
||||||
|
f"bottle '{bottle_name}' agent_provider.settings.{key} must "
|
||||||
|
f"be a positive integer (was {type(value).__name__})"
|
||||||
|
)
|
||||||
|
return dict(settings)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user