refactor(doctor): replace turnstone-bootstrap with turnstone-doctor (#718)

* refactor(doctor): replace turnstone-bootstrap with turnstone-doctor

turnstone-bootstrap was an LLM setup wizard for Day-0; run.sh now owns install.
Repurpose its LLM/conversation plumbing into turnstone-doctor — a diagnose-only
tool for a running cluster.

- Preflight detects the install kind (docker-compose/systemd/pip/source) from
  config.toml + TURNSTONE_* env, with secret redaction.
- Self-configuring brain resolves the cluster's own model from config/env/storage
  read-only (no migrations, no create_all), falling back to interactive
  selection; the attempt itself is the LLM-backend health check.
- Deterministic version check: installed version, cluster drift via the console's
  authoritative /health, and latest upstream stable/experimental (offline-safe).
- Read-only diagnostic tools (read_file, compose/systemd/journal, http_health,
  check_llm_backend, node_health, finish) behind one secret-scrubbing chokepoint;
  no generic shell, so read-only is structural.
- node_health reaches a node the right way for the detected install kind
  (exec-into-container for compose, direct HTTP otherwise), overridable per node
  for mixed clusters.
- mTLS-aware: forwards [database] SSL params and reports node-mesh mTLS instead of
  mislabelling healthy nodes "unreachable".

init_storage gains a backward-compatible create_tables override for read-only
opens. Entry point turnstone-bootstrap -> turnstone-doctor; README/QUICKSTART/
architecture/docker docs, the bundled compose header, run.sh, and the CI smoke
updated. CHANGELOG deferred.

* fix(doctor): address Copilot + CodeQL review findings on #718

Validated all seven review findings (none false positives) and fixed:

- check_llm_backend now applies the same scheme / metadata-host guard as
  http_health (extracted to _assert_safe_http_url), so a model-supplied
  base_url can't be steered at the cloud metadata endpoint or a file:// URL.
- node_health no longer double-appends the default port when the operator
  passes host:port (regression: 10.0.0.5:8081 -> http://10.0.0.5:8081:8080).
- node_health install_type enum uses "git-source" to match the label the
  rest of the module and the prompt/report show the model (a schema-strict
  provider would otherwise reject the value the model is told to use).
- _read_api_creds takes base_url + api_key as a unit from the first config
  source that defines either field, then env-fills, instead of splicing the
  two across different config files into a pair that exists in no real config.
- _mask_secrets masks assignment-shaped content inside comment lines, so a
  commented-out real secret can't leak through read_file / the report; prose
  comments (no KEY=value shape) still pass through untouched.
- drop the mixed import styles CodeQL flagged in doctor.py and test_doctor.py.

Adds 5 tests; ruff + mypy clean; full doctor suite passes (129).
This commit is contained in:
Patrick Buckley
2026-06-26 04:57:20 -07:00
committed by GitHub
parent 4baf6f81c3
commit c0be383f99
14 changed files with 3636 additions and 2004 deletions
+1 -1
View File
@@ -146,7 +146,7 @@ jobs:
/tmp/smoke/bin/turnstone-console --help
/tmp/smoke/bin/turnstone-admin --help
/tmp/smoke/bin/turnstone-channel --help
/tmp/smoke/bin/turnstone-bootstrap --help
/tmp/smoke/bin/turnstone-doctor --help
lock-check:
runs-on: ubuntu-latest
+81 -66
View File
@@ -1,92 +1,107 @@
# Bootstrap Wizard
# Quickstart
Interactive, AI-guided setup for Turnstone deployments. Instead of manually
editing `.env` files and reading deployment docs, the wizard walks you through
every decision conversationally and generates all the config files for you.
Install Turnstone, then diagnose it with `turnstone-doctor` if anything looks off.
## Quick Start
## Install
The one-line installer autodetects your distro (Ubuntu/Debian, Fedora/RHEL,
Arch, and WSL), installs git + Docker if missing, generates secrets, picks free
ports, and starts the stack:
```bash
turnstone-bootstrap
curl -fsSL https://raw.githubusercontent.com/turnstonelabs/turnstone/main/run.sh | bash
```
That's it — no flags, no arguments. The wizard prompts for everything.
Re-running is safe — it updates the checkout and keeps your existing `.env`.
When it finishes it prints the dashboard URL and how to create the first admin
user.
## How It Works
**Other ways to install**
1. **Pick a model** — Choose OpenAI, Anthropic, or a local/vLLM endpoint to
power the wizard. Local endpoints auto-detect available models.
2. **Answer questions** — The AI walks you through deployment mode, LLM
provider, database, authentication, ports, and optional features.
3. **Review generated files** — Each file is previewed before writing. You
confirm or reject every write.
4. **Start the stack** — The wizard prints the exact `docker compose` command
and a `setup.sh` script to create your first admin user, roles, and policies.
- **Already have Docker?** Clone the repo and `docker compose up` for the full
local cluster, or `docker compose -f turnstone/deploy/compose.yaml up` for the
released single-node stack. See [docs/docker.md](docs/docker.md).
- **Python package:** `pip install turnstone` (add `--pre` for the experimental
track), then run `turnstone-server` / `turnstone-console` directly. See the
[README](README.md#quickstart).
## What Gets Generated
## Diagnose: `turnstone-doctor`
| File | Purpose |
`turnstone-doctor` is an LLM-backed assistant that inspects a **running**
Turnstone install and helps you troubleshoot it. It is **read-only** — it
investigates and tells you the exact commands to fix things, but never changes
your system. (Installation is the installer's job, not the doctor's.)
```bash
# From a host that has the turnstone package installed:
turnstone-doctor
# For a Docker install from run.sh (no package on the host), run it with pipx:
pipx run --spec turnstone turnstone-doctor --dir ~/turnstone
```
### What it does
1. **Preflight** — detects how Turnstone is installed here (docker-compose,
systemd/bare-metal, pip, or a source checkout) by probing for `config.toml`
files, `TURNSTONE_*` environment variables, compose files, and systemd units.
2. **Self-configures its LLM** — it powers its own brain from your cluster's
*own* model configuration (env / `config.toml` / the database). Whether that
works is the first diagnostic: success means your LLM backend is healthy; if
it can't, that's surfaced as finding #1 and it falls back to asking you for a
provider and key so it can still help.
3. **Version check** — reports the installed version, version drift across your
cluster's nodes, and the latest upstream stable/experimental releases.
4. **Interactive diagnosis** — it reads logs, `/health`, `docker compose ps`,
`systemctl`, config, and ports to pin down problems like a node not joining
the console, an unreachable database, a down model backend, port conflicts,
or a JWT-secret mismatch — then hands you the precise remediation commands.
### Flags
| Flag | Purpose |
|------|---------|
| `.env` | All environment variables for `compose.yaml` |
| `setup.sh` | Post-start script: creates admin user, roles, tool policies, prompt templates via the API |
| `docker-compose.override.yaml` | Only if customizations beyond env vars are needed |
| `--dir PATH` | Install directory to inspect (default: current directory) |
| `--report` | Print the deterministic preflight report and exit — no LLM key needed |
| `--offline` | Skip the upstream GitHub version check |
## Requirements
`--report` is the fastest way to get a health snapshot (and to share one when
asking for help) — it never needs an API key:
- **Python 3.11+** with turnstone installed (`pip install turnstone`)
- **An LLM API key** — for the wizard itself (OpenAI, Anthropic, or a local
model). This can differ from the LLM your deployment will use.
- **Docker & Docker Compose** — needed to run the stack. The wizard detects
whether Docker is installed and gives platform-specific install instructions
if it's missing. You can still generate config files without Docker.
## Deployment Modes
- **Single-node production** — `docker compose up` against the bundled
`turnstone/deploy/compose.yaml`: 1 server + console + channel + PostgreSQL,
pulled from ghcr.io. Good for most deployments.
- **Local multi-node cluster** — clone the repo and run `docker compose up` at
the root for a 10-node fleet + console + Caddy + channel, built locally.
See [docs/docker.md](docs/docker.md) for both.
## Example Session
```bash
turnstone-doctor --report --dir ~/turnstone
```
```
$ turnstone-bootstrap
## Install profile
- Detected kind(s): docker-compose (primary: docker-compose)
- Docker daemon reachable: yes
- Compose files:
/home/you/turnstone/compose.yaml
- Database: backend=postgresql, url=postgresql+psycopg://turnstone:****@postgres:5432/turnstone
- Candidate health URLs: http://localhost:8080/health, http://localhost:8090/health
Turnstone Bootstrap Wizard v1.5.0
────────────────────────────────────────────────
## Versions
- Installed (this tool): 1.7.0a2
- Cluster nodes: 10 reporting; versions ['1.7.0a2']
- Version drift across nodes: no
- Upstream: stable 1.6.9, experimental 1.7.0a2
Which provider for this wizard?
[1] OpenAI
[2] Anthropic
[3] OpenAI-compatible (local/vLLM)
> 3
Base URL [http://localhost:8000/v1]:
API key (press Enter for 'none'):
Querying http://localhost:8000/v1 for available models...
Found model: Qwen/Qwen3-32B
Connected to Qwen/Qwen3-32B. Handing off to AI assistant...
> (AI walks you through the rest interactively)
## LLM backend (ok)
- resolved Qwen/Qwen3-32B via openai-compatible @ http://host.docker.internal:8000/v1
```
Secrets (JWT secret, database password, API keys) are always redacted in the
report and in anything the doctor reads.
## Tips
- **Re-run safely** — running the wizard again detects your existing `.env`
and offers to update it rather than overwriting.
- **Duplicate writes are skipped** — if the LLM tries to write the same file
twice with identical content, it's silently ignored.
- **Type `quit` to exit** at any time during the conversation.
- **Ctrl+C** is handled gracefully — press once to interrupt, twice to exit.
- **Type `quit`** to exit the conversation; **Ctrl+C** interrupts (twice to quit).
- **Point it at the right install** with `--dir` when you run it from elsewhere.
- **(Re)installing or adding nodes?** Use the installer (`run.sh`), not the doctor.
## See Also
- [Docker Deployment](docs/docker.md) — manual compose setup and profiles
- [Docker Deployment](docs/docker.md) — compose stacks, ports, and bare-metal nodes
- [Security](docs/security.md) — auth architecture and token types
- [Governance](docs/governance.md) — roles, policies, and templates
+2 -2
View File
@@ -94,7 +94,7 @@ LLM; add model backends from the console UI.
For production (released images from ghcr.io, real secrets required), use the
bundled stack: `docker compose -f turnstone/deploy/compose.yaml up`.
See [QUICKSTART.md](QUICKSTART.md) for the bootstrap wizard and [docs/docker.md](docs/docker.md) for Docker configuration.
See [QUICKSTART.md](QUICKSTART.md) for the install + troubleshooting walkthrough and [docs/docker.md](docs/docker.md) for Docker configuration.
### Programmatic (SDK)
@@ -125,7 +125,7 @@ Built-in tools for shell, files, search, web, memory, notifications, and autonom
| `turnstone-channel` | Channel gateway (Discord and Slack adapters) |
| `turnstone-admin` | User/token management CLI |
| `turnstone-eval` | Eval harness for prompt/tool optimization |
| `turnstone-bootstrap` | LLM-guided setup wizard |
| `turnstone-doctor` | LLM-backed cluster diagnostics |
### Diagrams
+1 -1
View File
@@ -22,7 +22,7 @@ plugs in.
| `turnstone-eval` | `turnstone.eval` | `NullUI` | Headless evaluation and prompt optimization |
| `turnstone-channel` | `turnstone.channels.cli` | ChannelAdapter | Channel gateway (Discord, Slack, etc.) |
| `turnstone-admin` | `turnstone.admin` | — | Offline user and API token management |
| `turnstone-bootstrap` | `turnstone.bootstrap` | — | LLM-guided setup wizard |
| `turnstone-doctor` | `turnstone.doctor` | — | LLM-backed cluster diagnostics |
---
+2 -2
View File
@@ -125,7 +125,7 @@ docker compose -f turnstone/deploy/compose.yaml up
It's the same shape as the dev stack — Caddy-fronted console, channel, and a
PostgreSQL all share one database so the console discovers the node — but it
pulls released images, runs a single server node, and has **no baked-in
secrets**. Set these in `.env` first (`turnstone-bootstrap` generates them):
secrets**. Set these in `.env` first (generate with `openssl rand -hex 32`):
```bash
TURNSTONE_JWT_SECRET=<python -c "import secrets; print(secrets.token_hex(32))">
@@ -260,7 +260,7 @@ interface, or anyone who can reach it can search through your instance.
Both stacks install all entry points into a single image (`turnstone`,
`turnstone-server`, `turnstone-console`, `turnstone-channel`, `turnstone-admin`,
`turnstone-eval`, `turnstone-bootstrap`):
`turnstone-eval`, `turnstone-doctor`):
```bash
docker compose build # build the dev image
+1 -1
View File
@@ -69,7 +69,7 @@ turnstone-server = "turnstone.server:main"
turnstone-console = "turnstone.console.server:main"
turnstone-admin = "turnstone.admin:main"
turnstone-channel = "turnstone.channels.cli:main"
turnstone-bootstrap = "turnstone.bootstrap:main"
turnstone-doctor = "turnstone.doctor:main"
[tool.hatch.build.targets.wheel]
include = [
+3
View File
@@ -380,6 +380,9 @@ ${GREEN}${BOLD}Turnstone is running${RESET} (${NODE_COUNT} node$([ "$NODE_COUNT"
${DIM}$DOCKER compose down${RESET} stop (add -v to wipe data)
Config $INSTALL_DIR/.env (generated secrets + ports)
Troubleshoot ${DIM}pipx run --spec turnstone turnstone-doctor --dir $INSTALL_DIR${RESET}
LLM-backed diagnostics for this install (read-only; needs Python)
EOF
}
-683
View File
@@ -1,683 +0,0 @@
"""Tests for the bootstrap wizard module."""
from __future__ import annotations
import os
import socket
from pathlib import Path
from unittest.mock import MagicMock, patch
from turnstone.bootstrap import (
SYSTEM_PROMPT,
TOOLS,
_BootstrapLLM,
_FinishError,
_mask_secrets,
_tool_check_docker,
_tool_check_port,
_tool_finish,
_tool_generate_secret,
_tool_read_file,
_tool_validate_api_key,
_tool_write_compose,
_tool_write_file,
execute_tool,
)
# ---------------------------------------------------------------------------
# Tool function tests
# ---------------------------------------------------------------------------
class TestReadFile:
def test_existing_file(self, tmp_path: Path) -> None:
f = tmp_path / "test.txt"
f.write_text("hello world")
result = _tool_read_file(tmp_path, {"path": "test.txt"})
assert result == "hello world"
def test_missing_file(self, tmp_path: Path) -> None:
result = _tool_read_file(tmp_path, {"path": "nope.txt"})
assert "Error: file not found" in result
def test_nested_path(self, tmp_path: Path) -> None:
sub = tmp_path / "sub"
sub.mkdir()
f = sub / "nested.txt"
f.write_text("nested content")
result = _tool_read_file(tmp_path, {"path": "sub/nested.txt"})
assert result == "nested content"
def test_path_traversal_blocked(self, tmp_path: Path) -> None:
result = _tool_read_file(tmp_path, {"path": "../../etc/passwd"})
assert "escapes project directory" in result
def test_absolute_path_blocked(self, tmp_path: Path) -> None:
result = _tool_read_file(tmp_path, {"path": "/etc/passwd"})
assert "escapes project directory" in result
class TestWriteFile:
def test_write_confirmed(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
result = _tool_write_file(tmp_path, {"path": "out.txt", "content": "data\n"})
assert "written successfully" in result
assert (tmp_path / "out.txt").read_text() == "data\n"
def test_write_declined(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="n"):
result = _tool_write_file(tmp_path, {"path": "out.txt", "content": "data\n"})
assert "declined" in result
assert not (tmp_path / "out.txt").exists()
def test_write_creates_parent_dirs(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
result = _tool_write_file(tmp_path, {"path": "a/b/c.txt", "content": "deep\n"})
assert "written successfully" in result
assert (tmp_path / "a" / "b" / "c.txt").read_text() == "deep\n"
def test_sh_files_are_executable(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
_tool_write_file(tmp_path, {"path": "setup.sh", "content": "#!/bin/bash\n"})
mode = (tmp_path / "setup.sh").stat().st_mode
assert mode & 0o110 # user + group executable, not world
def test_path_traversal_blocked(self, tmp_path: Path) -> None:
result = _tool_write_file(tmp_path, {"path": "../../escape.txt", "content": "bad\n"})
assert "escapes project directory" in result
def test_default_enter_confirms(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value=""):
result = _tool_write_file(tmp_path, {"path": "ok.txt", "content": "ok\n"})
assert "written successfully" in result
def test_duplicate_write_skipped(self, tmp_path: Path) -> None:
(tmp_path / "dup.txt").write_text("same\n")
result = _tool_write_file(tmp_path, {"path": "dup.txt", "content": "same\n"})
assert "already exists" in result
def test_different_content_still_prompts(self, tmp_path: Path) -> None:
(tmp_path / "changed.txt").write_text("old\n")
with patch("builtins.input", return_value="y"):
result = _tool_write_file(tmp_path, {"path": "changed.txt", "content": "new\n"})
assert "written successfully" in result
assert (tmp_path / "changed.txt").read_text() == "new\n"
class TestWriteCompose:
def test_writes_compose_file(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
result = _tool_write_compose(tmp_path, {})
assert "written successfully" in result
assert "ghcr.io" in result
content = (tmp_path / "compose.yaml").read_text()
assert "ghcr.io/turnstonelabs/turnstone" in content
assert "TURNSTONE_IMAGE_TAG" in content
# The compose mounts ./Caddyfile and ./searxng, so the wizard must write
# both alongside — guards the extra writes and the pyproject wheel-include.
caddyfile = (tmp_path / "Caddyfile").read_text()
assert "reverse_proxy console:8090" in caddyfile
searxng_cfg = (tmp_path / "searxng" / "settings.yml").read_text()
assert "json" in searxng_cfg # the bundled config enables the JSON API
def test_user_declines(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="n"):
result = _tool_write_compose(tmp_path, {})
assert "declined" in result
assert not (tmp_path / "compose.yaml").exists()
def test_identical_content_skipped(self, tmp_path: Path) -> None:
# Write it once
with patch("builtins.input", return_value="y"):
_tool_write_compose(tmp_path, {})
# Second call should skip
result = _tool_write_compose(tmp_path, {})
assert "identical content" in result
def test_no_build_blocks(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
_tool_write_compose(tmp_path, {})
content = (tmp_path / "compose.yaml").read_text()
assert "build:" not in content
assert "dockerfile:" not in content.lower()
def test_overwrites_different_content(self, tmp_path: Path) -> None:
(tmp_path / "compose.yaml").write_text("old content\n")
with patch("builtins.input", return_value="y"):
result = _tool_write_compose(tmp_path, {})
assert "written successfully" in result
content = (tmp_path / "compose.yaml").read_text()
assert "ghcr.io" in content
def test_no_local_image_references(self, tmp_path: Path) -> None:
with patch("builtins.input", return_value="y"):
_tool_write_compose(tmp_path, {})
content = (tmp_path / "compose.yaml").read_text()
assert "turnstone:local" not in content
class TestGenerateSecret:
def test_default_length(self) -> None:
secret = _tool_generate_secret({})
assert len(secret) == 64 # 32 bytes -> 64 hex chars
def test_custom_length(self) -> None:
secret = _tool_generate_secret({"length": 16})
assert len(secret) == 32
def test_uniqueness(self) -> None:
s1 = _tool_generate_secret({})
s2 = _tool_generate_secret({})
assert s1 != s2
def test_invalid_length_fallback(self) -> None:
secret = _tool_generate_secret({"length": -1})
assert len(secret) == 64 # falls back to 32 bytes
def test_excessive_length_capped(self) -> None:
secret = _tool_generate_secret({"length": 99999})
assert len(secret) == 64 # falls back to 32 bytes
class TestCheckPort:
def test_available_port(self) -> None:
# Pick a random high port that's likely free
result = _tool_check_port({"port": 59123})
assert "AVAILABLE" in result or "IN USE" in result
def test_in_use_port(self) -> None:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
sock.bind(("127.0.0.1", 0))
port = sock.getsockname()[1]
sock.listen(1)
result = _tool_check_port({"port": port})
assert "IN USE" in result
def test_invalid_port(self) -> None:
result = _tool_check_port({"port": -1})
assert "Error" in result
def test_port_zero(self) -> None:
result = _tool_check_port({"port": 0})
assert "Error" in result
class TestCheckDocker:
def test_docker_installed(self) -> None:
mock_docker = MagicMock()
mock_docker.returncode = 0
mock_docker.stdout = "24.0.7"
mock_compose = MagicMock()
mock_compose.returncode = 0
mock_compose.stdout = "2.24.5"
with patch("subprocess.run", side_effect=[mock_docker, mock_compose]):
result = _tool_check_docker({})
assert "Docker: installed" in result
assert "Docker Compose: installed" in result
def test_docker_not_installed(self) -> None:
with patch("subprocess.run", side_effect=FileNotFoundError):
result = _tool_check_docker({})
assert "NOT installed" in result or "NOT available" in result
def test_docker_daemon_not_running(self) -> None:
mock_docker = MagicMock()
mock_docker.returncode = 1
mock_docker.stderr = "Cannot connect to the Docker daemon"
mock_compose = MagicMock()
mock_compose.returncode = 1
with patch("subprocess.run", side_effect=[mock_docker, mock_compose]):
result = _tool_check_docker({})
assert "NOT running" in result
class TestValidateApiKey:
def test_openai_success(self) -> None:
mock_client = MagicMock()
mock_client.models.list.return_value = []
with patch("openai.OpenAI", return_value=mock_client):
result = _tool_validate_api_key({"provider": "openai", "api_key": "sk-test"})
assert "Success" in result
def test_openai_failure(self) -> None:
with patch("openai.OpenAI") as mock_cls:
mock_cls.return_value.models.list.side_effect = Exception("Invalid key")
result = _tool_validate_api_key({"provider": "openai", "api_key": "bad"})
assert "Failed" in result
def test_unknown_provider(self) -> None:
result = _tool_validate_api_key({"provider": "unknown", "api_key": "x"})
assert "unknown" in result
class TestExecuteTool:
def test_unknown_tool(self, tmp_path: Path) -> None:
result = execute_tool("nonexistent", {}, tmp_path)
assert "unknown tool" in result
def test_dispatches_correctly(self, tmp_path: Path) -> None:
f = tmp_path / "hello.txt"
f.write_text("hi")
result = execute_tool("read_file", {"path": "hello.txt"}, tmp_path)
assert result == "hi"
def test_finish_raises(self, tmp_path: Path) -> None:
import pytest
with pytest.raises(_FinishError, match="All done"):
execute_tool("finish", {"summary": "All done"}, tmp_path)
class TestFinishTool:
def test_raises_with_summary(self) -> None:
import pytest
with pytest.raises(_FinishError) as exc_info:
_tool_finish({"summary": "Configured production deployment."})
assert exc_info.value.summary == "Configured production deployment."
def test_default_summary(self) -> None:
import pytest
with pytest.raises(_FinishError) as exc_info:
_tool_finish({})
assert exc_info.value.summary == "Setup complete."
# ---------------------------------------------------------------------------
# Secret masking tests
# ---------------------------------------------------------------------------
class TestMaskSecrets:
def test_masks_api_key(self) -> None:
text = "OPENAI_API_KEY=sk-1234567890abcdef"
result = _mask_secrets(text)
assert "sk-1" in result
assert "cdef" in result
assert "1234567890abcde" not in result
def test_preserves_comments(self) -> None:
text = "# OPENAI_API_KEY=sk-1234567890abcdef"
result = _mask_secrets(text)
assert result == text
def test_preserves_short_values(self) -> None:
text = "TOKEN=short"
result = _mask_secrets(text)
assert result == text
def test_preserves_non_sensitive(self) -> None:
text = "MODEL=gpt-5.4"
result = _mask_secrets(text)
assert result == text
# ---------------------------------------------------------------------------
# Message conversion tests (Anthropic)
# ---------------------------------------------------------------------------
class TestAnthropicConversion:
"""Test the Anthropic message/tool conversion inside _BootstrapLLM."""
def _make_llm(self) -> _BootstrapLLM:
return _BootstrapLLM("anthropic", MagicMock(), "test-model")
def test_tool_format_conversion(self) -> None:
"""OpenAI tool format should convert to Anthropic format."""
llm = self._make_llm()
# The conversion happens inside _complete_anthropic; we test indirectly
# by checking the tools passed to the mock client
mock_response = MagicMock()
mock_response.content = [MagicMock(type="text", text="hello")]
mock_response.stop_reason = "end_turn"
llm.client.messages.create.return_value = mock_response
llm.complete(
[{"role": "system", "content": "sys"}, {"role": "user", "content": "hi"}],
TOOLS[:1], # Just read_file
)
call_kwargs = llm.client.messages.create.call_args[1]
api_tools = call_kwargs["tools"]
assert len(api_tools) == 1
assert api_tools[0]["name"] == "read_file"
assert "input_schema" in api_tools[0]
assert "description" in api_tools[0]
def test_system_message_extraction(self) -> None:
"""System message should be extracted to system parameter."""
llm = self._make_llm()
mock_response = MagicMock()
mock_response.content = [MagicMock(type="text", text="ok")]
mock_response.stop_reason = "end_turn"
llm.client.messages.create.return_value = mock_response
llm.complete(
[{"role": "system", "content": "test system"}, {"role": "user", "content": "hi"}],
[],
)
call_kwargs = llm.client.messages.create.call_args[1]
assert call_kwargs["system"] == "test system"
# System should NOT appear in messages
for msg in call_kwargs["messages"]:
assert msg["role"] != "system"
def test_tool_result_conversion(self) -> None:
"""OpenAI tool result messages should convert to Anthropic format."""
llm = self._make_llm()
mock_response = MagicMock()
mock_response.content = [MagicMock(type="text", text="got it")]
mock_response.stop_reason = "end_turn"
llm.client.messages.create.return_value = mock_response
messages = [
{"role": "system", "content": "sys"},
{"role": "user", "content": "hi"},
{
"role": "assistant",
"content": "",
"tool_calls": [
{
"id": "tc_1",
"type": "function",
"function": {"name": "check_docker", "arguments": "{}"},
}
],
},
{
"role": "tool",
"tool_call_id": "tc_1",
"content": "Docker: installed",
},
]
llm.complete(messages, TOOLS)
call_kwargs = llm.client.messages.create.call_args[1]
api_messages = call_kwargs["messages"]
# Find the tool_result message
tool_result_found = False
for msg in api_messages:
if msg["role"] == "user" and isinstance(msg.get("content"), list):
for block in msg["content"]:
if isinstance(block, dict) and block.get("type") == "tool_result":
assert block["tool_use_id"] == "tc_1"
assert block["content"] == "Docker: installed"
tool_result_found = True
assert tool_result_found
def test_tool_use_blocks_in_assistant(self) -> None:
"""Assistant messages with tool_calls should convert to content blocks."""
llm = self._make_llm()
mock_response = MagicMock()
mock_response.content = [MagicMock(type="text", text="ok")]
mock_response.stop_reason = "end_turn"
llm.client.messages.create.return_value = mock_response
messages = [
{"role": "system", "content": "sys"},
{"role": "user", "content": "hi"},
{
"role": "assistant",
"content": "Let me check",
"tool_calls": [
{
"id": "tc_1",
"type": "function",
"function": {"name": "check_docker", "arguments": "{}"},
}
],
},
{"role": "tool", "tool_call_id": "tc_1", "content": "ok"},
]
llm.complete(messages, TOOLS)
call_kwargs = llm.client.messages.create.call_args[1]
api_messages = call_kwargs["messages"]
# First message should be user "hi"
assert api_messages[0]["role"] == "user"
# Second should be assistant with content blocks
assistant_msg = api_messages[1]
assert assistant_msg["role"] == "assistant"
assert isinstance(assistant_msg["content"], list)
# Should have text block + tool_use block
types = [b["type"] for b in assistant_msg["content"]]
assert "text" in types
assert "tool_use" in types
class TestOpenAICompletion:
"""Test the OpenAI path of _BootstrapLLM."""
def test_text_response(self) -> None:
llm = _BootstrapLLM("openai", MagicMock(), "gpt-5.4")
mock_choice = MagicMock()
mock_choice.message.content = "Hello!"
mock_choice.message.tool_calls = None
mock_choice.finish_reason = "stop"
llm.client.chat.completions.create.return_value = MagicMock(choices=[mock_choice])
content, tool_calls, reason = llm.complete([{"role": "user", "content": "hi"}], TOOLS)
assert content == "Hello!"
assert tool_calls is None
assert reason == "stop"
def test_tool_call_response(self) -> None:
llm = _BootstrapLLM("openai", MagicMock(), "gpt-5.4")
mock_tc = MagicMock()
mock_tc.id = "call_123"
mock_tc.function.name = "check_docker"
mock_tc.function.arguments = "{}"
mock_choice = MagicMock()
mock_choice.message.content = ""
mock_choice.message.tool_calls = [mock_tc]
mock_choice.finish_reason = "tool_calls"
llm.client.chat.completions.create.return_value = MagicMock(choices=[mock_choice])
content, tool_calls, reason = llm.complete(
[{"role": "user", "content": "check docker"}], TOOLS
)
assert tool_calls is not None
assert len(tool_calls) == 1
assert tool_calls[0]["function"]["name"] == "check_docker"
assert tool_calls[0]["id"] == "call_123"
def test_no_content(self) -> None:
llm = _BootstrapLLM("openai", MagicMock(), "gpt-5.4")
mock_choice = MagicMock()
mock_choice.message.content = None
mock_choice.message.tool_calls = None
mock_choice.finish_reason = "stop"
llm.client.chat.completions.create.return_value = MagicMock(choices=[mock_choice])
content, tool_calls, reason = llm.complete([{"role": "user", "content": "hi"}], [])
assert content == ""
assert tool_calls is None
# ---------------------------------------------------------------------------
# Conversation loop tests
# ---------------------------------------------------------------------------
class TestConversationLoop:
def test_quit_exits(self) -> None:
"""User typing 'quit' should exit the loop."""
llm = MagicMock(spec=_BootstrapLLM)
llm.complete.return_value = ("What would you like?", None, "stop")
with patch("builtins.input", return_value="quit"):
from turnstone.bootstrap import _run_conversation
_run_conversation(llm, Path("/tmp"))
def test_tool_calls_executed(self, tmp_path: Path) -> None:
"""Tool calls should be executed and results fed back."""
llm = MagicMock(spec=_BootstrapLLM)
# First call: LLM returns a tool call
llm.complete.side_effect = [
(
"",
[
{
"id": "tc_1",
"type": "function",
"function": {"name": "generate_secret", "arguments": "{}"},
}
],
"tool_calls",
),
# Second call: LLM responds with text after seeing tool result
("Here's your secret!", None, "stop"),
]
with patch("builtins.input", return_value="quit"):
from turnstone.bootstrap import _run_conversation
_run_conversation(llm, tmp_path)
# Verify two calls were made
assert llm.complete.call_count == 2
# Verify tool result was fed back in second call's messages
second_call_messages = llm.complete.call_args_list[1][0][0]
tool_results = [m for m in second_call_messages if m.get("role") == "tool"]
assert len(tool_results) == 1
assert tool_results[0]["tool_call_id"] == "tc_1"
# Result should be a 64-char hex string
assert len(tool_results[0]["content"]) == 64
def test_empty_input_skipped(self) -> None:
"""Empty user input should be skipped."""
llm = MagicMock(spec=_BootstrapLLM)
llm.complete.return_value = ("Ask me something.", None, "stop")
call_count = 0
def mock_input(prompt: str = "") -> str:
nonlocal call_count
call_count += 1
if call_count <= 2:
return "" # Empty inputs
return "quit"
with patch("builtins.input", side_effect=mock_input):
from turnstone.bootstrap import _run_conversation
_run_conversation(llm, Path("/tmp"))
def test_finish_tool_exits_loop(self, tmp_path: Path) -> None:
"""LLM calling finish tool should exit the conversation cleanly."""
llm = MagicMock(spec=_BootstrapLLM)
llm.complete.return_value = (
"",
[
{
"id": "tc_fin",
"type": "function",
"function": {
"name": "finish",
"arguments": '{"summary": "All configured."}',
},
}
],
"tool_calls",
)
from turnstone.bootstrap import _run_conversation
# Should return without needing user input
_run_conversation(llm, tmp_path)
assert llm.complete.call_count == 1
# ---------------------------------------------------------------------------
# Interactive startup tests
# ---------------------------------------------------------------------------
class TestProviderDefaults:
def test_openai_default_model(self) -> None:
from turnstone.bootstrap import _DEFAULT_MODELS
assert _DEFAULT_MODELS["openai"] == "gpt-5.4"
def test_anthropic_default_model(self) -> None:
from turnstone.bootstrap import _DEFAULT_MODELS
assert _DEFAULT_MODELS["anthropic"] == "claude-sonnet-4-6"
class TestSelectProvider:
def test_openai_selection(self) -> None:
"""Selecting '1' should set up OpenAI."""
mock_client = MagicMock()
with (
patch("builtins.input", side_effect=["1", ""]),
patch("getpass.getpass", return_value="sk-test"),
patch("openai.OpenAI", return_value=mock_client),
):
from turnstone.bootstrap import _select_provider
provider, client, model = _select_provider()
assert provider == "openai"
assert model == "gpt-5.4"
def test_local_selection(self) -> None:
"""Selecting '3' should set up local/vLLM."""
mock_client = MagicMock()
# Ensure OPENAI_API_KEY is not in env so we hit the getpass path
env = {k: v for k, v in os.environ.items() if k != "OPENAI_API_KEY"}
with (
patch.dict("os.environ", env, clear=True),
patch("builtins.input", side_effect=["3", "http://localhost:8000/v1", "my-model"]),
patch("getpass.getpass", return_value="none"),
patch("openai.OpenAI", return_value=mock_client),
):
from turnstone.bootstrap import _select_provider
provider, client, model = _select_provider()
assert provider == "openai"
assert model == "my-model"
# ---------------------------------------------------------------------------
# System prompt and tools sanity checks
# ---------------------------------------------------------------------------
class TestConstants:
def test_system_prompt_not_empty(self) -> None:
assert len(SYSTEM_PROMPT) > 500
def test_system_prompt_mentions_turnstone(self) -> None:
assert "Turnstone" in SYSTEM_PROMPT
def test_all_tools_have_required_fields(self) -> None:
for tool in TOOLS:
assert tool["type"] == "function"
func = tool["function"]
assert "name" in func
assert "description" in func
assert "parameters" in func
assert func["parameters"]["type"] == "object"
def test_tool_count(self) -> None:
assert len(TOOLS) == 8
def test_all_tools_have_implementations(self) -> None:
from turnstone.bootstrap import TOOL_FUNCTIONS
for tool in TOOLS:
name = tool["function"]["name"]
assert name in TOOL_FUNCTIONS, f"Missing implementation for tool: {name}"
+1333
View File
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+11 -3
View File
@@ -30,6 +30,7 @@ def init_storage(
url: str = "",
pool_size: int = 2,
run_migrations: bool = True,
create_tables: bool | None = None,
sslmode: str = "",
sslrootcert: str = "",
sslcert: str = "",
@@ -44,6 +45,11 @@ def init_storage(
url: PostgreSQL connection URL (e.g. postgresql+psycopg://user:pass@host/db)
pool_size: Connection pool size (PostgreSQL only)
run_migrations: Whether to run Alembic migrations on init
create_tables: Whether to emit ``CREATE TABLE`` DDL (``create_all``) on
init. ``None`` (default) keeps the historical behaviour create
tables only when migrations are NOT run. Pass ``False`` for a
strictly read-only open that must never touch the schema (e.g.
``turnstone-doctor`` inspecting a live DB); pass ``True`` to force it.
listen_url: Optional dedicated PostgreSQL URL for the dispatcher's
``LISTEN`` connection. Required only when ``url`` points at a
``pgbouncer`` running in transaction pooling mode (LISTEN
@@ -54,9 +60,11 @@ def init_storage(
"""
global _storage
# When Alembic migrations will run, skip create_all() to avoid
# bypassing migration-managed DDL. Tests pass run_migrations=False
# and rely on create_all() instead.
# When Alembic migrations will run, skip create_all() to avoid bypassing
# migration-managed DDL. Tests pass run_migrations=False and rely on
# create_all() instead. An explicit create_tables overrides this — a
# diagnose-only caller passes create_tables=False to never emit DDL.
if create_tables is None:
create_tables = not run_migrations
if backend == "sqlite":
+3 -2
View File
@@ -1,5 +1,6 @@
"""Bundled deployment templates (compose files, overlays).
These files are included in the wheel so that ``turnstone-bootstrap`` can
extract them for users who install via pip/pipx and don't have a git clone.
These files ship in the wheel so a pip/pipx install can run the released
single-node stack (``docker compose -f turnstone/deploy/compose.yaml up``)
without a git clone.
"""
+2 -2
View File
@@ -4,7 +4,7 @@
# Same shape as the dev stack at the repo root (Caddy-fronted console, shared
# Postgres, channel gateway) but it pulls released images from ghcr.io instead
# of building, runs a single server node, and requires real secrets. Bundled
# with the turnstone wheel and written by turnstone-bootstrap.
# with the turnstone wheel.
#
# docker compose -f turnstone/deploy/compose.yaml up
#
@@ -16,7 +16,7 @@
# dashboard's SSE streams).
#
# No baked-in secrets: set TURNSTONE_JWT_SECRET and POSTGRES_PASSWORD in .env
# (turnstone-bootstrap generates them). Pin images with TURNSTONE_IMAGE_TAG
# (set them yourself, e.g. `openssl rand -hex 32`). Pin images with TURNSTONE_IMAGE_TAG
# (default: latest).
#
# Join a bare-metal host: Postgres is published on 127.0.0.1:5432, so a
+2195
View File
File diff suppressed because it is too large Load Diff