fix(cli/session): redirect Rich panels to stderr for JSON stdout export #10755

Open
HAL9000 wants to merge 15 commits from fix/issue-10503-session-export-json-stdout into master
21 changed files with 2357 additions and 46 deletions
+224 -18
View File
@@ -7,7 +7,6 @@ Changed `wf10_batch.robot` to be less likely to create files, and
## [Unreleased]
- **docs(spec): fix checkpoint config key path and trigger name defaults** (#5009 / PR #5163): Corrects the Configuration Reference table entry `sandbox.checkpoint.auto-create-on``core.checkpoints.auto-create-on`, matching the implementation in `config_service.py`. Aligns the default trigger-name values (`before_tool_execute`, `after_tool_execute`) with the implementation in `tool/runner.py`, resolving specimplementation discrepancies identified in issue #5009.
- **docs: module guides for Sandbox & Checkpoint, Correction Attempts, and Invariant Reconciliation** (#4848): Added three comprehensive module guides covering purpose, core classes, lifecycle diagrams, exception hierarchies, CLI usage, and ADR links for `SandboxManager`, `CorrectionAttemptManager`, and `InvariantReconciliationActor`. Includes security callouts for `NoSandbox` bypass (permanent writes, no rollback), `guidance` prompt-injection risk, `archived_artifacts_path` provenance, and `non_overridable` global invariant access control.
- **feat(context): PriorityContextStrategy** (#9997 / PR #10772): Implements a priority-based context strategy that ranks context fragments by configurable priority scores — default role-based rules (system > tool > user > assistant), exponential recency decay (7-day half-life), and explicit priority tag boost. Supports custom scoring function injection and custom PriorityRule list injection. Registered in the ACMS pipeline under key `priority_context`. `PriorityRule` uses Pydantic `BaseModel` for architecture conformance. Includes 18 BDD scenarios covering all acceptance criteria.
- **docs(timeline): verify timeline status for 2026-04-16 Cycle 2** (#8519): Updated `docs/timeline.md` with Days 104-106 Cycle 2 milestone snapshot. No changes detected since Cycle 1. All M3-M7 milestones remain overdue. Timeline verification performed by AUTO-TIME-3 supervisor agent. Refs #8519.
- **fix(cli/plan): plan correct JSON output envelope fix and BDD test coverage** (#8584 / PR #8662): Restructured `agents plan correct --format json` output to nest correction fields under `data.correction` (e.g., `data.correction.mode`) and populate the spec-required CLI envelope with `command="plan correct"`, `status`, `exit_code`, `timing`, and `messages` fields. Added three BDD scenarios in `features/tdd_plan_correct_json_output.feature` validating the envelope structure for both revert and append modes.
@@ -403,6 +402,27 @@ ensuring data is stored with proper parameter values.
- **`auto_debug` node functions return partial state updates instead of mutating state** (#10494, #10496): The `_analyze_error()`, `_generate_fix()`, `_validate_fix()`, and `_finalize()` methods in `src/cleveragents/agents/graphs/auto_debug.py` now return new `dict[str, Any]` objects containing only the keys they update rather than mutating the input state in-place or returning full state objects. This respects the LangGraph node contract (all `StateGraph` node functions are passed the current state and must return a partial dict representing only their incremental updates). Callers rely on LangGraph's built-in state delta-merge logic to combine these partial updates across successive nodes.
- **Actor v3 YAML Schema Validation in CLI** (#5869): The `agents actor add --config`
command now validates v3 YAML files using `ActorConfigSchema`, ensuring proper
schema compliance including cycle detection for GRAPH actors, required field
validation, and enum validation. v3 YAML is detected by the presence of ANY
`type` field (any value — invalid type values are then rejected by schema
validation) or a `version` field whose string value starts with `"3"` (e.g.
`"3"`, `"3.0"`, `"3.0.0"`). Configs with `type: null` are not treated as v3.
Invalid v3 actors are rejected with clear error messages before registration.
- **Alembic Files Missing from Wheel Distribution** (#4180): Alembic configuration
(`alembic.ini`) and migration files are now part of the Python package structure
at `src/cleveragents/infrastructure/database/migrations/`. Previously, when
`agents init` was run in Docker containers or any wheel-based installation,
`FileNotFoundError` was raised because alembic files were stored at the
repository root and excluded from the wheel distribution. Now alembic files
follow standard Python packaging conventions and are automatically included.
`MigrationRunner._find_alembic_ini()` has been updated to search the new package
location as the primary anchor point. This fix enables `agents init` to work
correctly in all deployment modes: Docker containers, local pip installs
(wheel or editable), and development environments.
### Changed
- Fixed stale `AUTO-BUG-POOL` tracking prefix references in automation-tracking.md documentation and agent-system-specification.md spec document, replaced with correct `AUTO-BUG-SUP` prefix used by the bug-hunt-pool-supervisor agent (#7875).
@@ -926,6 +946,15 @@ uko-oo:Class` triple emission in `PythonAnalyzer._extract_class()` so that
covering all decision types, context capture, error handling, and tree
structure validation.
- **CheckpointManager rollback_to always returned False** (#7488): Fixed a data
integrity bug in `CheckpointManager.create_checkpoint()` where `sandbox_path`
was computed from `sandbox.context.sandbox_path` but never stored in the
checkpoint metadata. As a result, `rollback_to()` always found
`checkpoint.metadata.get("sandbox_path")` returning `None` and silently
skipped the rollback, returning `False`. The fix adds `sandbox_path` to the
metadata dict before constructing the `SandboxCheckpoint`, enabling
`rollback_to()` to correctly restore the sandbox filesystem state.
- **TDD Issue-Capture Test Activation** (#7025): Replaced 234 bare `@skip` tags
across 82 Behave feature files with the correct `@tdd_expected_fail @tdd_issue
@tdd_issue_<N>` tag system. Scenarios whose referenced bugs were already fixed
@@ -972,10 +1001,10 @@ uko-oo:Class` triple emission in `PythonAnalyzer._extract_class()` so that
`new-issue-creator`, and `issue-state-updater` now delegate all label operations to this
subagent.
- **PR-Issue Label Synchronization**: PRs now inherit `Priority/`, `MoSCoW/`, `Points/`,
- **PRIssue Label Synchronization**: PRs now inherit `Priority/`, `MoSCoW/`, `Points/`,
and `State/` labels from their associated issues at creation time
(`pr-api-creator`). The `backlog-groomer` adds a continuous Pass 19 for ongoing
PR-issue label synchronization. The `issue-state-updater` syncs PR state labels whenever
PRissue label synchronization. The `issue-state-updater` syncs PR state labels whenever
issue states change.
- **Automation Tracking Announcements**: Extended `automation-tracking-manager` with
@@ -989,14 +1018,14 @@ uko-oo:Class` triple emission in `PythonAnalyzer._extract_class()` so that
the `*-pool-supervisor` naming pattern. New agents added: `pr-editor` (safe PR editing
with description preservation), `pr-manager` (unified PR interface), and
`pr-merge-pool-supervisor` (automated PR merging supervisor). Renamed:
`pr-api-creator` to `pr-creator`, `pr-checker` to `pr-ci-test-fixer`,
`pr-status-checker` to `pr-status-analyzer`, `pr-self-reviewer` to `pr-reviewer`,
`pr-fix-orchestrator` to `pr-fix-pool-supervisor`.
`pr-api-creator` `pr-creator`, `pr-checker` `pr-ci-test-fixer`,
`pr-status-checker` `pr-status-analyzer`, `pr-self-reviewer` `pr-reviewer`,
`pr-fix-orchestrator` `pr-fix-pool-supervisor`.
- **Automated PR Merging** (`pr-merge-pool-supervisor`): New supervisor continuously
monitors for merge-ready PRs and merges them automatically when all criteria are met
(approvals, CI passing, no conflicts). Supports both formal reviews and comment-based
approvals (LGTM, ready to merge, etc.).
approvals (LGTM, ✅, "ready to merge", etc.).
- **Implementation Worker Workflow Completion**: `implementation-worker` now implements
work claiming protocols with conflict detection, comprehensive review feedback handling
@@ -1078,7 +1107,7 @@ Documentation Report (Cycle N)` issues every 10 cycles (~3.3 hours). The manager
- **PR Review Policy**: Reduced PR review requirement from 2 approvals to 1. Self-approval
is now permitted including for automated bot PRs. Approval can be a formal review OR an
approval comment (LGTM, Approved, ready to merge).
approval comment (LGTM, Approved, ✅, "ready to merge").
- **Label Delegation Enforcement**: `automation-tracking-manager` now enforces delegation
to `forgejo-label-manager` for all label operations, preventing "invalid label ID" errors
@@ -1151,6 +1180,14 @@ iteration` and data corruption under concurrent plan execution. All public
are also protected. The DI container registration as `providers.Singleton`
is now correct and safe.
- **Path Traversal Sandbox Escape via Prefix Collision** (#7558): Fixed
`validate_path()` in `file_tools.py` using `str.startswith()` for sandbox
containment, which allowed sibling directories with a matching name prefix
(e.g. `/tmp/sandbox-escape/` bypassing `/tmp/sandbox/`) to escape the
sandbox. Replaced with `Path.relative_to()` which performs a proper path
prefix check using OS path separators. Added regression test tagged
`@tdd_issue_7558`.
- **TOCTOU Race Condition in Git Worktree Sandbox** (#7507): Fixed Time-Of-Check-To-Time-Of-Use race condition in `GitWorktreeSandbox.create()` by replacing unsafe mkdtemp+rmdir pattern with persistent parent directory approach. Parent directory is now held throughout operation lifetime and properly cleaned up in all error paths (timeout, CalledProcessError, OSError) and in the cleanup() method, eliminating race window where another process could claim the worktree path. Comprehensive BDD coverage added for all error-path cleanup branches.
- **Validation Gate Empty-Run Guard** (#7508): Fixed `ApplyValidationSummary.all_required_passed`
@@ -1199,11 +1236,6 @@ iteration` and data corruption under concurrent plan execution. All public
e2e test files and removed `tdd_expected_fail` from 4 context assembly e2e tests where
bugs were already fixed.
- **PluginLoader entry point prefix validation** (#7476): Parse entry point targets before
import, enforce the module allowlist ahead of loading, and add Behave plus Robot Framework
regression coverage to ensure disallowed prefixes never execute untrusted module-level code
in either unit or integration flows.
- **`issue-state-updater` Bash Script Errors**: Removed problematic bash script examples
that tried to invoke `task forgejo-label-manager` as a bash command (the Task tool cannot
be invoked from bash). Replaced with clear step-by-step operational instructions and
@@ -1273,9 +1305,18 @@ iteration` and data corruption under concurrent plan execution. All public
envelope structure and updates the CLI synopsis in `docs/specification.md`
to document the option.
- Fixed CheckpointManager not wired into PlanExecutor — checkpoints were
never created during plan execution because `_get_plan_executor()` in
the CLI constructed PlanExecutor without a CheckpointManager (defaulted
to None, silently skipping all checkpoint hooks). `_get_plan_executor()`
now resolves the container singleton so CLI `plan execute` and `plan
rollback` share the same registry, and `_try_create_checkpoint()` raises
`PlanError` if checkpoint metadata cannot be persisted. Writable sandboxable
resources and write-capable tools now default to `checkpointable=True`, and
new Behave scenarios cover DI wiring, rollback, and capability defaults. (#1253)
---
## [3.8.0] -- 2026-04-05
## [3.8.0] 2026-04-05
### Added
@@ -1286,13 +1327,178 @@ iteration` and data corruption under concurrent plan execution. All public
`INVARIANT_VIOLATED` events. Post-correction reconciliation runs
via `CORRECTION_APPLIED` event subscription (best-effort). Added
`InvariantService` Singleton provider in the DI container.
- **TUI -- Shell danger detection**: The TUI shell mode (`!` prefix) now detects
- **TUI Shell danger detection**: The TUI shell mode (`!` prefix) now detects
dangerous command patterns before execution. A configurable pattern registry
classifies commands by danger level (warning, critical) and surfaces a user
warning overlay before proceeding. Patterns cover destructive filesystem
operations, privilege escalation, network exfiltration, and more. (#1003)
- **TUI -- Permission Question Widget**: A new inline `PermissionQuestionWidget`
renders permission requests directly in the conversation stream for single-key
- **TUI Permission Question Widget**: A new inline `PermissionQuestionWidget`
renders permission requests directly in the conversation stream for single-file
operations. Users can allow/reject with single-key shortcuts (`a`/`A`/`r`/`R`),
navigate with arrow keys, confirm with `Enter`, or press `v` to open the full
navigate with arrow keys, confirm with `Enter`, or press `v` to open the full
permissions screen. (#1004)
- **TUI — Actor thought blocks**: Expandable reasoning trace widgets rendered
inline in the conversation stream with muted styling. Collapsed by default;
expand with `Space` or click. (#1005)
- **UKO provenance tracking**: Every typed triple now carries `sourceResource`,
`validFrom`, and `isCurrent` metadata. A revision chain enables temporal
queries and point-in-time ontology state reconstruction.
- **JSON-RPC 2.0 A2A wire format**: `A2aRequest`/`A2aResponse` fields renamed to
standard JSON-RPC 2.0 names (`method`, `id`, `result`, `error`). The
`A2aVersionNegotiator` handles backward compatibility.
- **Database resource handler**: Full CRUD and checkpoint/rollback support for
SQLite, PostgreSQL, MySQL, and DuckDB resources via the resource DAG.
- **Estimation lifecycle hook**: `actor.default.estimation` config key wires an
estimation actor into the Strategize-to-Estimate lifecycle hook.
- **Persona system**: YAML-backed personas bind actors, argument presets, and scope
references to named identities; persisted in `~/.config/cleveragents/personas/`.
- **Session management**: Create, list, export, and import conversation sessions;
full JSON export/import for portability; Markdown transcript export
(`--format md`) for human-readable sharing.
- **First-run experience**: `ActorSelectionOverlay` guides new users to pick an
actor on first TUI launch; creates a `"default"` persona automatically.
- **Server mode**: `agents server connect` configures a remote CleverAgents server;
Kubernetes Helm chart in `k8s/` for production deployment.
- **A2A integration**: Agent-to-Agent protocol facade wires CLI and TUI to live
application services (session, plan, registry, event).
- **Permissions screen**: TUI overlay for reviewing tool permission requests with
unified, side-by-side, and context diff views; session-scoped allow/reject decisions.
- **Inline permission questions**: `PermissionQuestionWidget` renders single-file
permission requests directly in the conversation stream with single-key shortcuts.
- **Invariant reconciliation**: `InvariantReconciliationActor` runs automatically at
every plan phase transition; failures block the transition and emit `INVARIANT_VIOLATED`.
- **UKO runtime**: Universal Knowledge Ontology query interface, inference engine, and
graph persistence for ACMS context strategies.
### Fixed
- `LangChainChatProvider.name` and `model_id` are now mutable properties with setters,
fixing an `AttributeError` when `PlanService` attempted to resolve provider names after
instantiation. (#1553)
---
## [3.7.0] — 2026-03-15
### Added
- **Interactive TUI** (`agents tui`) — full-screen Textual app with multi-session tabs,
persona switching, slash commands (67 commands across 14 groups), reference picker
(`@`), shell mode (`!`), context-sensitive F1 help, and `Ctrl+T` argument preset cycling.
- **Slash command system** — 67 commands across 14 groups accessible via `/` overlay.
- **Reference picker** — `@` key opens a file/resource reference picker that inserts
references into the input field.
- **TUI persona system** — YAML-backed personas bind actors, argument presets, and scope
references; persisted in `~/.config/cleveragents/personas/`.
- **TUI session export/import** — full JSON round-trip and Markdown transcript export
(`--format md`).
- **PersonaRegistry** — YAML-based persona management system with full CRUD operations,
atomic file operations with fcntl locking, and thread-safe implementation.
- **TUI Web Mode** (`--web`, `--web-port`) — HTTP server for browser-based TUI access
with HTML interface and WebSocket support placeholder for future enhancements.
- **Multi-Session Tabs** — Enhanced TUI with independent session management, session
creation/switching/closing/renaming via keyboard bindings (Ctrl+N for new, Ctrl+W for close),
and independent A2A binding support per session.
---
## [3.6.0] — 2026-02-28
### Added
- Advanced Context Management System (ACMS) with three-tier context strategy.
- UKO Runtime (Universal Knowledge Ontology) with graph persistence and inference engine.
- Implicit inference engine producing `uko:implicitSiblingOf`, `uko:implicitContains`,
and `uko:implicitDependsOn` triples with confidence 0.7.
---
## [3.5.0] — 2026-02-14
### Added
- Autonomy hardening: advisory locking, validation pipeline, definition-of-done gating.
- Resource DAG with dependency tracking and type hierarchy with multiple inheritance.
- Container resource types (`container.docker`, `container.podman`).
- LSP resource types (`lsp.*`).
---
## [3.4.0] — 2026-01-31
### Added
- ACMS v1 with context scaling strategies.
- Resource type inheritance system (ADR-042).
- Safety profile extraction (ADR-041).
---
## [3.3.0] — 2026-01-17
### Added
- Corrections and subplans support in plan lifecycle.
- Checkpoint and rollback for all resource writes.
- Decision tree versioning and history (ADR-034).
- Decision tree rollback and replay (ADR-035).
---
## [3.2.0] — 2026-01-03
### Added
- Decisions, validations, and invariants in plan lifecycle.
- Validation abstraction layer (ADR-013).
- Invariant system (ADR-016).
- Automation profiles (ADR-017).
- Semantic error prevention (ADR-018).
---
## [3.1.0] — 2025-12-20
### Added
- MCP (Model Context Protocol) adapter and client (ADR-029).
- LSP (Language Server Protocol) client integration (ADR-027).
- Agent Skills Standard (AgentSkills.io) support (ADR-028).
- Skill abstraction definition (ADR-030).
---
## [3.0.0] — 2025-12-06
### Added
- Initial public release of CleverAgents Core.
- Unified `agents` / `cleveragents` CLI entry points.
- Layered architecture: Entry Points → Application → Domain → Infrastructure → Integration → Core.
- Actor system with YAML-defined LangGraph node graphs.
- Tool system with four-stage lifecycle (activate → validate → execute → deactivate).
- Skill system with three-tier progressive disclosure.
- Resource system with DAG and type hierarchy.
- A2A (Agent-to-Agent) protocol facade.
- DI container (`cleveragents.application.container`).
- LangChain/LangGraph integration (ADR-022).
- Provider registry with fallback chain (OpenAI → Anthropic → Google → Azure → OpenRouter → Groq → Together → Cohere).
- Observability: structured logging, metrics, audit trail, token/cost tracking.
- BDD test suite (Behave + Robot Framework).
- Nox automation for lint, typecheck, tests, docs, benchmarks.
- MkDocs-powered documentation with CleverAgents branding.
+328
View File
@@ -0,0 +1,328 @@
# Installation and Setup Guide
This guide provides comprehensive instructions for installing and setting up CleverAgents in your development environment.
## Prerequisites
Before you begin, ensure you have the following installed on your system:
### System Requirements
- **Operating System**: Linux, macOS, or Windows (with WSL2)
- **Python**: Version 3.10 or higher
- **Git**: Version 2.30 or higher
- **Memory**: Minimum 4GB RAM (8GB recommended)
- **Disk Space**: At least 2GB free space
### Required Tools
- **pip**: Python package manager (usually comes with Python)
- **virtualenv** or **venv**: For creating isolated Python environments
- **Docker** (optional): For containerized deployments
- **Docker Compose** (optional): For multi-container setups
### Development Tools (Optional but Recommended)
- **Visual Studio Code** or your preferred IDE
- **Git GUI client** (e.g., GitKraken, SourceTree)
- **Make**: For running build commands
- **nox**: For test automation
## Step-by-Step Installation
### 1. Clone the Repository
```bash
git clone https://github.com/cleverthis/cleveragents-core.git
cd cleveragents-core
```
### 2. Create a Virtual Environment
Using Python's built-in venv:
```bash
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
Or using virtualenv:
```bash
virtualenv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
### 3. Upgrade pip and Install Build Tools
```bash
pip install --upgrade pip setuptools wheel
```
### 4. Install CleverAgents
#### Option A: Development Installation (Recommended for Contributors)
```bash
pip install -e ".[dev]"
```
This installs CleverAgents in editable mode with all development dependencies.
#### Option B: Standard Installation
```bash
pip install .
```
#### Option C: Installation with Optional Dependencies
```bash
# With all optional dependencies
pip install -e ".[all]"
# With specific extras
pip install -e ".[docs,test,dev]"
```
### 5. Verify Installation
```bash
cleveragents --version
cleveragents --help
```
## Configuration
### Environment Variables
Create a `.env` file in the project root:
```bash
# API Configuration
CLEVERAGENTS_API_HOST=localhost
CLEVERAGENTS_API_PORT=8000
# Logging
CLEVERAGENTS_LOG_LEVEL=INFO
# Database
CLEVERAGENTS_DB_URL=sqlite:///./cleveragents.db
# Optional: AI Provider Configuration
OPENAI_API_KEY=your_api_key_here
```
### Configuration File
Create a `config.yaml` in your project directory:
```yaml
cleveragents:
version: 1
logging:
level: INFO
format: json
database:
type: sqlite
path: ./cleveragents.db
api:
host: localhost
port: 8000
debug: false
```
## Verification Steps
### 1. Check Installation
```bash
python -c "import cleveragents; print(cleveragents.__version__)"
```
### 2. Run Basic Tests
```bash
pytest tests/ -v --tb=short
```
### 3. Start the Development Server
```bash
cleveragents server --host 0.0.0.0 --port 8000
```
### 4. Verify API Endpoint
```bash
curl http://localhost:8000/health
```
Expected response:
```json
{
"status": "healthy",
"version": "x.y.z"
}
```
## Common Issues and Troubleshooting
### Issue 1: Python Version Mismatch
**Error**: `Python 3.10 or higher is required`
**Solution**:
```bash
python3 --version
# If version is < 3.10, install a newer version
# macOS: brew install python@3.11
# Ubuntu: sudo apt-get install python3.11
```
### Issue 2: Virtual Environment Not Activated
**Error**: `command not found: cleveragents`
**Solution**:
```bash
# Ensure virtual environment is activated
source venv/bin/activate # Linux/macOS
# or
venv\Scripts\activate # Windows
```
### Issue 3: Permission Denied on Linux/macOS
**Error**: `Permission denied: './venv/bin/activate'`
**Solution**:
```bash
chmod +x venv/bin/activate
source venv/bin/activate
```
### Issue 4: Dependency Conflicts
**Error**: `ERROR: pip's dependency resolver does not currently take into account all the packages`
**Solution**:
```bash
# Clear pip cache and reinstall
pip cache purge
pip install --upgrade --force-reinstall -e ".[dev]"
```
### Issue 5: Database Connection Error
**Error**: `sqlite3.OperationalError: unable to open database file`
**Solution**:
```bash
# Ensure database directory exists
mkdir -p data
# Update CLEVERAGENTS_DB_URL in .env
CLEVERAGENTS_DB_URL=sqlite:///./data/cleveragents.db
```
### Issue 6: Port Already in Use
**Error**: `Address already in use: ('0.0.0.0', 8000)`
**Solution**:
```bash
# Use a different port
cleveragents server --port 8001
# Or kill the process using port 8000
lsof -i :8000 # Find process ID
kill -9 <PID> # Kill the process
```
## Next Steps
After successful installation and verification:
1. **Read the Documentation**: Start with the [Architecture Guide](../architecture.md)
2. **Explore Examples**: Check the `examples/` directory for sample projects
3. **Run Tests**: Execute the full test suite with `pytest`
4. **Set Up IDE**: Configure your IDE with Python linting and formatting tools
5. **Join the Community**: Visit our [GitHub Discussions](https://github.com/cleverthis/cleveragents-core/discussions)
## Development Workflow
### Running Tests
```bash
# Run all tests
pytest
# Run specific test file
pytest tests/test_core.py
# Run with coverage
pytest --cov=src tests/
# Run with verbose output
pytest -v
```
### Code Quality Checks
```bash
# Format code
black src/ tests/
# Lint code
ruff check src/ tests/
# Type checking
mypy src/
# All checks with nox
nox
```
### Building Documentation
```bash
# Install documentation dependencies
pip install -e ".[docs]"
# Build documentation
mkdocs build
# Serve documentation locally
mkdocs serve
```
## Uninstallation
To remove CleverAgents:
```bash
# Deactivate virtual environment
deactivate
# Remove virtual environment
rm -rf venv
# Or if using virtualenv
virtualenv --clear venv
```
## Getting Help
- **Documentation**: https://docs.cleverthis.com/cleveragents
- **GitHub Issues**: https://github.com/cleverthis/cleveragents-core/issues
- **GitHub Discussions**: https://github.com/cleverthis/cleveragents-core/discussions
- **Email Support**: support@cleverthis.com
## Additional Resources
- [Architecture Guide](../architecture.md)
- [Development Guide](../development/agent-system-specification.md)
- [API Reference](../api/index.md)
- [FAQ](../faq.md)
@@ -0,0 +1,164 @@
Feature: Budget enforcement in PlanExecutor
As a platform operator
I want PlanExecutor to halt execution when budget limits are exceeded
So that autonomous agents cannot overspend configured limits
# ------------------------------------------------------------------
# BudgetExceededError and PlanBudgetExceededError exceptions
# ------------------------------------------------------------------
Scenario: BudgetExceededError has correct attributes
When I create a BudgetExceededError with plan_id "plan-1" budget_type "daily" used 5.0 limit 3.0
Then the BudgetExceededError plan_id should be "plan-1"
And the BudgetExceededError budget_type should be "daily"
And the BudgetExceededError used should be 5.0
And the BudgetExceededError limit should be 3.0
And the BudgetExceededError message should contain "budget"
Scenario: PlanBudgetExceededError has correct attributes
When I create a PlanBudgetExceededError with plan_id "plan-2" used 10.0 limit 5.0
Then the PlanBudgetExceededError plan_id should be "plan-2"
And the PlanBudgetExceededError used should be 10.0
And the PlanBudgetExceededError limit should be 5.0
And the PlanBudgetExceededError message should contain "budget"
Scenario: BudgetExceededError is a subclass of PlanError
When I create a BudgetExceededError with plan_id "plan-3" budget_type "session" used 1.0 limit 0.5
Then the BudgetExceededError should be an instance of PlanError
Scenario: PlanBudgetExceededError is a subclass of PlanError
When I create a PlanBudgetExceededError with plan_id "plan-4" used 2.0 limit 1.0
Then the PlanBudgetExceededError should be an instance of PlanError
# ------------------------------------------------------------------
# PlanExecutor budget enforcement - no cost tracker (no-op)
# ------------------------------------------------------------------
Scenario: PlanExecutor without cost_tracker does not check budget
Given a budget enforcement PlanExecutor without cost_tracker
And a budget enforcement plan in Execute-Queued state
When I run budget enforcement execute
Then the budget enforcement execute should succeed without budget error
# ------------------------------------------------------------------
# PlanExecutor budget enforcement - plan budget exceeded
# ------------------------------------------------------------------
Scenario: PlanExecutor halts with PlanBudgetExceededError when plan budget exceeded
Given a budget enforcement PlanExecutor with plan budget 0.0001
And a budget enforcement plan in Execute-Queued state
And the cost_metadata has total_cost 0.001
When I run budget enforcement execute expecting budget error
Then a PlanBudgetExceededError should be raised
And the PlanBudgetExceededError plan_id should match the plan
Scenario: PlanExecutor saves plan state before halting on plan budget exceeded
Given a budget enforcement PlanExecutor with plan budget 0.0001
And a budget enforcement plan in Execute-Queued state
And the cost_metadata has total_cost 0.001
When I run budget enforcement execute expecting budget error
Then the lifecycle _commit_plan should have been called with budget_halt details
# ------------------------------------------------------------------
# PlanExecutor budget enforcement - daily budget exceeded
# ------------------------------------------------------------------
Scenario: PlanExecutor halts with BudgetExceededError when daily budget exceeded
Given a budget enforcement PlanExecutor with daily budget 0.0001
And a budget enforcement plan in Execute-Queued state
And the daily spend is 0.001
When I run budget enforcement execute expecting budget error
Then a BudgetExceededError should be raised
And the BudgetExceededError budget_type should be "daily"
Scenario: PlanExecutor saves plan state before halting on daily budget exceeded
Given a budget enforcement PlanExecutor with daily budget 0.0001
And a budget enforcement plan in Execute-Queued state
And the daily spend is 0.001
When I run budget enforcement execute expecting budget error
Then the lifecycle _commit_plan should have been called with budget_halt details
# ------------------------------------------------------------------
# PlanExecutor budget enforcement - within budget (no halt)
# ------------------------------------------------------------------
Scenario: PlanExecutor continues when plan budget is not exceeded
Given a budget enforcement PlanExecutor with plan budget 100.0
And a budget enforcement plan in Execute-Queued state
And the cost_metadata has total_cost 0.001
When I run budget enforcement execute
Then the budget enforcement execute should succeed without budget error
Scenario: PlanExecutor continues when daily budget is not exceeded
Given a budget enforcement PlanExecutor with daily budget 100.0
And a budget enforcement plan in Execute-Queued state
And the daily spend is 0.001
When I run budget enforcement execute
Then the budget enforcement execute should succeed without budget error
# ------------------------------------------------------------------
# AutomationProfile budget fields
# ------------------------------------------------------------------
Scenario: AutomationProfile has budget_per_plan field
When I create an AutomationProfile with budget_per_plan 10.0
Then the AutomationProfile budget_per_plan should be 10.0
Scenario: AutomationProfile has budget_per_session field
When I create an AutomationProfile with budget_per_session 50.0
Then the AutomationProfile budget_per_session should be 50.0
Scenario: AutomationProfile budget_per_plan defaults to None
When I create an AutomationProfile with default budget fields
Then the AutomationProfile budget_per_plan should be None
And the AutomationProfile budget_per_session should be None
Scenario: AutomationProfile rejects negative budget_per_plan
When I try to create an AutomationProfile with budget_per_plan -1.0
Then a budget enforcement validation error should be raised
Scenario: AutomationProfile rejects negative budget_per_session
When I try to create an AutomationProfile with budget_per_session -1.0
Then a budget enforcement validation error should be raised
# ------------------------------------------------------------------
# _check_budget method - direct unit tests
# ------------------------------------------------------------------
Scenario: _check_budget is a no-op when cost_tracker is None
Given a budget enforcement PlanExecutor without cost_tracker
When I call _check_budget directly with plan_id "test-plan"
Then no budget exception should be raised
Scenario: _check_budget raises PlanBudgetExceededError when plan budget exceeded
Given a budget enforcement PlanExecutor with plan budget 0.0001
And the cost_metadata has total_cost 0.001
When I call _check_budget directly with plan_id "test-plan"
Then a PlanBudgetExceededError should be raised
Scenario: _check_budget raises BudgetExceededError when daily budget exceeded
Given a budget enforcement PlanExecutor with daily budget 0.0001
And the daily spend is 0.001
When I call _check_budget directly with plan_id "test-plan"
Then a BudgetExceededError should be raised
Scenario: _check_budget creates CostMetadata when none provided
Given a budget enforcement PlanExecutor with plan budget 100.0 and no cost_metadata
When I call _check_budget directly with plan_id "test-plan"
Then no budget exception should be raised
# ------------------------------------------------------------------
# _save_plan_state_on_budget_halt - graceful halt
# ------------------------------------------------------------------
Scenario: _save_plan_state_on_budget_halt persists budget details to plan
Given a budget enforcement PlanExecutor without cost_tracker
When I call _save_plan_state_on_budget_halt with plan_id "halt-plan" budget_type "plan" used 5.0 limit 3.0
Then the lifecycle _commit_plan should have been called
And the plan error_details should contain budget_halt true
And the plan error_details should contain budget_type "plan"
Scenario: _save_plan_state_on_budget_halt is non-fatal on lifecycle error
Given a budget enforcement PlanExecutor with failing lifecycle
When I call _save_plan_state_on_budget_halt with plan_id "halt-plan" budget_type "daily" used 1.0 limit 0.5
Then no exception should be raised from _save_plan_state_on_budget_halt
@@ -0,0 +1,603 @@
"""Step definitions for budget_enforcement_plan_executor.feature.
Tests for budget enforcement in PlanExecutor including:
- BudgetExceededError and PlanBudgetExceededError exceptions
- PlanExecutor halting on plan budget exceeded
- PlanExecutor halting on daily budget exceeded
- Graceful halt with plan state save
- AutomationProfile budget fields
"""
from __future__ import annotations
from datetime import date
from typing import Any
from unittest.mock import MagicMock
from behave import given, then, when
from behave.runner import Context
from cleveragents.application.services.plan_executor import PlanExecutor
from cleveragents.core.exceptions import (
BudgetExceededError,
PlanBudgetExceededError,
PlanError,
)
from cleveragents.domain.models.core.automation_profile import AutomationProfile
from cleveragents.domain.models.core.cost_metadata import CostMetadata
from cleveragents.domain.models.core.plan import (
PlanPhase,
PlanTimestamps,
ProcessingState,
)
from cleveragents.providers.cost_tracker import CostTracker
# ---------------------------------------------------------------------------
# Constants
# ---------------------------------------------------------------------------
_BUDGET_PLAN_ID = "01KBUDGET0PLAN000000000001"
_BUDGET_ROOT_ID = "01KBUDGET0ROOT000000000001"
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def _make_budget_plan(
*,
phase: PlanPhase = PlanPhase.EXECUTE,
state: ProcessingState = ProcessingState.QUEUED,
definition_of_done: str = "Implement feature",
decision_root_id: str = _BUDGET_ROOT_ID,
) -> MagicMock:
"""Build a mock plan for budget enforcement tests."""
plan = MagicMock()
plan.phase = phase
plan.state = state
plan.definition_of_done = definition_of_done
plan.decision_root_id = decision_root_id
plan.invariants = []
plan.timestamps = PlanTimestamps()
plan.changeset_id = None
plan.sandbox_refs = []
plan.error_details = None
plan.read_only = False
plan.project_links = []
plan.subplan_statuses = []
plan.identity = MagicMock()
plan.identity.plan_id = _BUDGET_PLAN_ID
return plan
def _make_budget_lifecycle(plan: Any | None = None) -> MagicMock:
"""Build a mock lifecycle service for budget tests."""
lcs = MagicMock()
if plan is not None:
lcs.get_plan.return_value = plan
lcs.start_execute = MagicMock()
lcs.complete_execute = MagicMock()
lcs.fail_execute = MagicMock()
lcs._commit_plan = MagicMock()
return lcs
def _make_cost_tracker_with_plan_budget(budget: float) -> CostTracker:
"""Create a CostTracker with a specific plan budget."""
return CostTracker(budget_per_plan=budget)
def _make_cost_tracker_with_daily_budget(budget: float) -> CostTracker:
"""Create a CostTracker with a specific daily budget."""
return CostTracker(budget_per_day=budget)
# ---------------------------------------------------------------------------
# Exception creation steps
# ---------------------------------------------------------------------------
@when(
'I create a BudgetExceededError with plan_id "{pid}" budget_type "{btype}" used {used:f} limit {limit:f}'
)
def step_create_budget_exceeded_error(
context: Context, pid: str, btype: str, used: float, limit: float
) -> None:
"""Create a BudgetExceededError with given attributes."""
context.budget_exc = BudgetExceededError(
f"Budget exceeded: {used} >= {limit}",
plan_id=pid,
budget_type=btype,
used=used,
limit=limit,
)
@then('the BudgetExceededError plan_id should be "{expected}"')
def step_check_budget_exc_plan_id(context: Context, expected: str) -> None:
"""Verify BudgetExceededError plan_id."""
assert context.budget_exc.plan_id == expected, (
f"Expected plan_id={expected!r}, got {context.budget_exc.plan_id!r}"
)
@then('the BudgetExceededError budget_type should be "{expected}"')
def step_check_budget_exc_budget_type(context: Context, expected: str) -> None:
"""Verify BudgetExceededError budget_type."""
assert context.budget_exc.budget_type == expected, (
f"Expected budget_type={expected!r}, got {context.budget_exc.budget_type!r}"
)
@then("the BudgetExceededError used should be {expected:f}")
def step_check_budget_exc_used(context: Context, expected: float) -> None:
"""Verify BudgetExceededError used."""
assert context.budget_exc.used == expected, (
f"Expected used={expected}, got {context.budget_exc.used}"
)
@then("the BudgetExceededError limit should be {expected:f}")
def step_check_budget_exc_limit(context: Context, expected: float) -> None:
"""Verify BudgetExceededError limit."""
assert context.budget_exc.limit == expected, (
f"Expected limit={expected}, got {context.budget_exc.limit}"
)
@then('the BudgetExceededError message should contain "{text}"')
def step_check_budget_exc_message(context: Context, text: str) -> None:
"""Verify BudgetExceededError message contains text."""
assert text in str(context.budget_exc), (
f"Expected '{text}' in '{context.budget_exc}'"
)
@then("the BudgetExceededError should be an instance of PlanError")
def step_check_budget_exc_is_plan_error(context: Context) -> None:
"""Verify BudgetExceededError is a PlanError."""
assert isinstance(context.budget_exc, PlanError), (
f"Expected PlanError, got {type(context.budget_exc).__name__}"
)
@when(
'I create a PlanBudgetExceededError with plan_id "{pid}" used {used:f} limit {limit:f}'
)
def step_create_plan_budget_exceeded_error(
context: Context, pid: str, used: float, limit: float
) -> None:
"""Create a PlanBudgetExceededError with given attributes."""
context.plan_budget_exc = PlanBudgetExceededError(
f"Plan budget exceeded: {used} >= {limit}",
plan_id=pid,
used=used,
limit=limit,
)
@then('the PlanBudgetExceededError plan_id should be "{expected}"')
def step_check_plan_budget_exc_plan_id(context: Context, expected: str) -> None:
"""Verify PlanBudgetExceededError plan_id."""
assert context.plan_budget_exc.plan_id == expected, (
f"Expected plan_id={expected!r}, got {context.plan_budget_exc.plan_id!r}"
)
@then("the PlanBudgetExceededError used should be {expected:f}")
def step_check_plan_budget_exc_used(context: Context, expected: float) -> None:
"""Verify PlanBudgetExceededError used."""
assert context.plan_budget_exc.used == expected, (
f"Expected used={expected}, got {context.plan_budget_exc.used}"
)
@then("the PlanBudgetExceededError limit should be {expected:f}")
def step_check_plan_budget_exc_limit(context: Context, expected: float) -> None:
"""Verify PlanBudgetExceededError limit."""
assert context.plan_budget_exc.limit == expected, (
f"Expected limit={expected}, got {context.plan_budget_exc.limit}"
)
@then('the PlanBudgetExceededError message should contain "{text}"')
def step_check_plan_budget_exc_message(context: Context, text: str) -> None:
"""Verify PlanBudgetExceededError message contains text."""
assert text in str(context.plan_budget_exc), (
f"Expected '{text}' in '{context.plan_budget_exc}'"
)
@then("the PlanBudgetExceededError should be an instance of PlanError")
def step_check_plan_budget_exc_is_plan_error(context: Context) -> None:
"""Verify PlanBudgetExceededError is a PlanError."""
assert isinstance(context.plan_budget_exc, PlanError), (
f"Expected PlanError, got {type(context.plan_budget_exc).__name__}"
)
# ---------------------------------------------------------------------------
# PlanExecutor setup steps
# ---------------------------------------------------------------------------
@given("a budget enforcement PlanExecutor without cost_tracker")
def step_budget_executor_no_tracker(context: Context) -> None:
"""Create a PlanExecutor without a cost tracker."""
plan = _make_budget_plan()
context.budget_lifecycle = _make_budget_lifecycle(plan)
context.budget_plan = plan
context.budget_plan_id = _BUDGET_PLAN_ID
context.budget_executor = PlanExecutor(
lifecycle_service=context.budget_lifecycle,
cost_tracker=None,
)
@given("a budget enforcement plan in Execute-Queued state")
def step_budget_plan_execute_queued(context: Context) -> None:
"""Set up a plan in Execute-Queued state (already done in executor setup)."""
@given("a budget enforcement PlanExecutor with plan budget {budget:f}")
def step_budget_executor_with_plan_budget(context: Context, budget: float) -> None:
"""Create a PlanExecutor with a plan budget limit."""
plan = _make_budget_plan()
context.budget_lifecycle = _make_budget_lifecycle(plan)
context.budget_plan = plan
context.budget_plan_id = _BUDGET_PLAN_ID
context.budget_cost_tracker = _make_cost_tracker_with_plan_budget(budget)
context.budget_cost_metadata = CostMetadata()
context.budget_executor = PlanExecutor(
lifecycle_service=context.budget_lifecycle,
cost_tracker=context.budget_cost_tracker,
cost_metadata=context.budget_cost_metadata,
)
@given("a budget enforcement PlanExecutor with daily budget {budget:f}")
def step_budget_executor_with_daily_budget(context: Context, budget: float) -> None:
"""Create a PlanExecutor with a daily budget limit."""
plan = _make_budget_plan()
context.budget_lifecycle = _make_budget_lifecycle(plan)
context.budget_plan = plan
context.budget_plan_id = _BUDGET_PLAN_ID
context.budget_cost_tracker = _make_cost_tracker_with_daily_budget(budget)
context.budget_cost_metadata = CostMetadata()
context.budget_executor = PlanExecutor(
lifecycle_service=context.budget_lifecycle,
cost_tracker=context.budget_cost_tracker,
cost_metadata=context.budget_cost_metadata,
)
@given(
"a budget enforcement PlanExecutor with plan budget {budget:f} and no cost_metadata"
)
def step_budget_executor_plan_budget_no_metadata(
context: Context, budget: float
) -> None:
"""Create a PlanExecutor with plan budget but no cost_metadata."""
plan = _make_budget_plan()
context.budget_lifecycle = _make_budget_lifecycle(plan)
context.budget_plan = plan
context.budget_plan_id = _BUDGET_PLAN_ID
context.budget_cost_tracker = _make_cost_tracker_with_plan_budget(budget)
context.budget_executor = PlanExecutor(
lifecycle_service=context.budget_lifecycle,
cost_tracker=context.budget_cost_tracker,
cost_metadata=None,
)
@given("a budget enforcement PlanExecutor with failing lifecycle")
def step_budget_executor_failing_lifecycle(context: Context) -> None:
"""Create a PlanExecutor with a lifecycle that raises on get_plan."""
lcs = MagicMock()
lcs.get_plan.side_effect = RuntimeError("lifecycle failure")
lcs._commit_plan = MagicMock()
context.budget_lifecycle = lcs
context.budget_plan_id = _BUDGET_PLAN_ID
context.budget_executor = PlanExecutor(
lifecycle_service=lcs,
cost_tracker=None,
)
@given("the cost_metadata has total_cost {cost:f}")
def step_set_cost_metadata_total_cost(context: Context, cost: float) -> None:
"""Set the cost_metadata total_cost."""
context.budget_cost_metadata.total_cost = cost
@given("the daily spend is {spend:f}")
def step_set_daily_spend(context: Context, spend: float) -> None:
"""Set the daily spend by recording usage."""
today_key = date.today().isoformat()
with context.budget_cost_tracker._daily_costs_lock:
context.budget_cost_tracker._daily_costs[today_key] = spend
# ---------------------------------------------------------------------------
# Execute steps
# ---------------------------------------------------------------------------
@when("I run budget enforcement execute")
def step_run_budget_execute(context: Context) -> None:
"""Run the execute phase."""
try:
context.budget_exec_result = context.budget_executor.run_execute(
context.budget_plan_id
)
context.budget_raised = None
except Exception as exc:
context.budget_raised = exc
@when("I run budget enforcement execute expecting budget error")
def step_run_budget_execute_expect_error(context: Context) -> None:
"""Run the execute phase expecting a budget error."""
try:
context.budget_exec_result = context.budget_executor.run_execute(
context.budget_plan_id
)
context.budget_raised = None
except (BudgetExceededError, PlanBudgetExceededError) as exc:
context.budget_raised = exc
except Exception as exc:
context.budget_raised = exc
@then("the budget enforcement execute should succeed without budget error")
def step_budget_execute_success(context: Context) -> None:
"""Verify execute succeeded without budget error."""
if context.budget_raised is not None and isinstance(
context.budget_raised, (BudgetExceededError, PlanBudgetExceededError)
):
raise AssertionError(
f"Expected no budget error, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
@then("a PlanBudgetExceededError should be raised")
def step_check_plan_budget_error_raised(context: Context) -> None:
"""Verify PlanBudgetExceededError was raised."""
assert context.budget_raised is not None, (
"Expected PlanBudgetExceededError but none was raised"
)
assert isinstance(context.budget_raised, PlanBudgetExceededError), (
f"Expected PlanBudgetExceededError, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
@then("the PlanBudgetExceededError plan_id should match the plan")
def step_check_plan_budget_error_plan_id(context: Context) -> None:
"""Verify PlanBudgetExceededError has the correct plan_id."""
assert isinstance(context.budget_raised, PlanBudgetExceededError)
assert context.budget_raised.plan_id == context.budget_plan_id, (
f"Expected plan_id={context.budget_plan_id!r}, "
f"got {context.budget_raised.plan_id!r}"
)
@then("a BudgetExceededError should be raised")
def step_check_budget_error_raised(context: Context) -> None:
"""Verify BudgetExceededError was raised."""
assert context.budget_raised is not None, (
"Expected BudgetExceededError but none was raised"
)
assert isinstance(context.budget_raised, BudgetExceededError), (
f"Expected BudgetExceededError, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
@then("the lifecycle _commit_plan should have been called with budget_halt details")
def step_check_commit_plan_budget_halt(context: Context) -> None:
"""Verify _commit_plan was called with budget_halt in error_details."""
assert context.budget_lifecycle._commit_plan.called, (
"Expected _commit_plan to be called"
)
plan = context.budget_lifecycle.get_plan.return_value
if isinstance(plan.error_details, dict):
assert "budget_halt" in plan.error_details, (
f"Expected 'budget_halt' in error_details, got {plan.error_details}"
)
# ---------------------------------------------------------------------------
# _check_budget direct call steps
# ---------------------------------------------------------------------------
@when('I call _check_budget directly with plan_id "{plan_id}"')
def step_call_check_budget_directly(context: Context, plan_id: str) -> None:
"""Call _check_budget directly."""
try:
context.budget_executor._check_budget(plan_id)
context.budget_raised = None
except (BudgetExceededError, PlanBudgetExceededError) as exc:
context.budget_raised = exc
except Exception as exc:
context.budget_raised = exc
@then("no budget exception should be raised")
def step_no_budget_exception(context: Context) -> None:
"""Verify no budget exception was raised."""
if isinstance(
context.budget_raised, (BudgetExceededError, PlanBudgetExceededError)
):
raise AssertionError(
f"Expected no budget exception, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
# ---------------------------------------------------------------------------
# _save_plan_state_on_budget_halt steps
# ---------------------------------------------------------------------------
@when(
'I call _save_plan_state_on_budget_halt with plan_id "{plan_id}" budget_type "{btype}" used {used:f} limit {limit:f}'
)
def step_call_save_plan_state(
context: Context, plan_id: str, btype: str, used: float, limit: float
) -> None:
"""Call _save_plan_state_on_budget_halt directly."""
plan = _make_budget_plan()
context.budget_lifecycle.get_plan.return_value = plan
context.budget_plan = plan
try:
context.budget_executor._save_plan_state_on_budget_halt(
plan_id=plan_id,
budget_type=btype,
used=used,
limit=limit,
)
context.budget_raised = None
except Exception as exc:
context.budget_raised = exc
@then("the lifecycle _commit_plan should have been called")
def step_check_commit_plan_called(context: Context) -> None:
"""Verify _commit_plan was called."""
assert context.budget_lifecycle._commit_plan.called, (
"Expected _commit_plan to be called"
)
@then("the plan error_details should contain budget_halt true")
def step_check_error_details_budget_halt(context: Context) -> None:
"""Verify plan error_details has budget_halt."""
plan = context.budget_plan
assert isinstance(plan.error_details, dict), (
f"Expected dict error_details, got {type(plan.error_details)}"
)
assert plan.error_details.get("budget_halt") == "true", (
f"Expected budget_halt='true', got {plan.error_details.get('budget_halt')!r}"
)
@then('the plan error_details should contain budget_type "{expected}"')
def step_check_error_details_budget_type(context: Context, expected: str) -> None:
"""Verify plan error_details has correct budget_type."""
plan = context.budget_plan
assert isinstance(plan.error_details, dict)
assert plan.error_details.get("budget_type") == expected, (
f"Expected budget_type={expected!r}, got {plan.error_details.get('budget_type')!r}"
)
@then("no exception should be raised from _save_plan_state_on_budget_halt")
def step_no_exception_from_save(context: Context) -> None:
"""Verify no exception was raised from _save_plan_state_on_budget_halt."""
assert context.budget_raised is None, (
f"Expected no exception, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
# ---------------------------------------------------------------------------
# AutomationProfile budget fields steps
# ---------------------------------------------------------------------------
@when("I create an AutomationProfile with budget_per_plan {budget:f}")
def step_create_profile_with_plan_budget(context: Context, budget: float) -> None:
"""Create an AutomationProfile with budget_per_plan."""
context.budget_profile = AutomationProfile(
name="test-budget-profile",
budget_per_plan=budget,
)
@when("I create an AutomationProfile with budget_per_session {budget:f}")
def step_create_profile_with_session_budget(context: Context, budget: float) -> None:
"""Create an AutomationProfile with budget_per_session."""
context.budget_profile = AutomationProfile(
name="test-budget-profile",
budget_per_session=budget,
)
@when("I create an AutomationProfile with default budget fields")
def step_create_profile_with_default_budget(context: Context) -> None:
"""Create an AutomationProfile with default budget fields."""
context.budget_profile = AutomationProfile(name="test-default-profile")
@then("the AutomationProfile budget_per_plan should be {expected}")
def step_check_profile_plan_budget(context: Context, expected: str) -> None:
"""Verify AutomationProfile budget_per_plan."""
if expected == "None":
assert context.budget_profile.budget_per_plan is None, (
f"Expected None, got {context.budget_profile.budget_per_plan}"
)
else:
assert context.budget_profile.budget_per_plan == float(expected), (
f"Expected {expected}, got {context.budget_profile.budget_per_plan}"
)
@then("the AutomationProfile budget_per_session should be {expected}")
def step_check_profile_session_budget(context: Context, expected: str) -> None:
"""Verify AutomationProfile budget_per_session."""
if expected == "None":
assert context.budget_profile.budget_per_session is None, (
f"Expected None, got {context.budget_profile.budget_per_session}"
)
else:
assert context.budget_profile.budget_per_session == float(expected), (
f"Expected {expected}, got {context.budget_profile.budget_per_session}"
)
@when("I try to create an AutomationProfile with budget_per_plan {budget:f}")
def step_try_create_profile_negative_plan_budget(
context: Context, budget: float
) -> None:
"""Try to create an AutomationProfile with invalid budget_per_plan."""
try:
context.budget_profile = AutomationProfile(
name="test-profile",
budget_per_plan=budget,
)
context.budget_raised = None
except Exception as exc:
context.budget_raised = exc
@when("I try to create an AutomationProfile with budget_per_session {budget:f}")
def step_try_create_profile_negative_session_budget(
context: Context, budget: float
) -> None:
"""Try to create an AutomationProfile with invalid budget_per_session."""
try:
context.budget_profile = AutomationProfile(
name="test-profile",
budget_per_session=budget,
)
context.budget_raised = None
except Exception as exc:
context.budget_raised = exc
@then("a budget enforcement validation error should be raised")
def step_check_budget_validation_error(context: Context) -> None:
"""Verify a validation error was raised."""
assert context.budget_raised is not None, (
"Expected a validation error but none was raised"
)
assert "validation" in type(context.budget_raised).__name__.lower() or "value" in str(
context.budget_raised
).lower(), (
f"Expected validation error, got {type(context.budget_raised).__name__}: "
f"{context.budget_raised}"
)
-5
View File
@@ -755,11 +755,6 @@ def step_try_create_plan_empty_desc(context: Context) -> None:
context.pydantic_error = exc
@then("an Edge Case Pydantic validation error should be raised")
def step_check_pydantic_error(context: Context) -> None:
assert context.pydantic_error is not None, "Expected a Pydantic validation error"
@when("I try to create an edge case plan with invalid phase value")
def step_try_create_plan_invalid_phase(context: Context) -> None:
"""Attempt to create a plan with a non-existent phase value."""
@@ -0,0 +1,147 @@
"""Step definitions for TDD test: session export JSON stdout purity (issue #10503).
Verifies that `agents session export --format json` writes only valid JSON to
stdout, with Rich panels redirected to stderr.
"""
from __future__ import annotations
import json
import os
import tempfile
from datetime import datetime
from unittest.mock import MagicMock
from behave import given, then, when
from behave.runner import Context
from typer.testing import CliRunner
from ulid import ULID
from cleveragents.cli.commands import session as session_mod
from cleveragents.cli.commands.session import app as session_app
from cleveragents.domain.models.core.session import (
Session,
SessionTokenUsage,
)
def _make_session(session_id: str | None = None) -> Session:
return Session(
session_id=session_id or str(ULID()),
actor_name="openai/gpt-4",
namespace="local",
messages=[],
token_usage=SessionTokenUsage(
input_tokens=100,
output_tokens=50,
estimated_cost=0.005,
),
created_at=datetime.now(),
updated_at=datetime.now(),
)
@given("a session export JSON stdout test runner")
def step_setup_runner(context: Context) -> None:
context.runner = CliRunner()
context._cleanup_paths: list[str] = []
def cleanup() -> None:
session_mod._service = None
for path in context._cleanup_paths:
if os.path.exists(path):
os.unlink(path)
context.add_cleanup(cleanup)
@given("a mocked session service for JSON stdout export")
def step_mock_service(context: Context) -> None:
session = _make_session()
mock_service = MagicMock()
mock_service.export_session.return_value = session.as_export_dict()
mock_service.get.return_value = session
session_mod._service = mock_service
context.session_id = session.session_id
@when("I run session export to stdout with format json")
def step_export_stdout_json(context: Context) -> None:
context.result = context.runner.invoke(
session_app, ["export", context.session_id, "--format", "json"]
)
# In Click 8.2+, result.stdout is stdout only (stderr is separate)
context.stdout = context.result.stdout
@when("I run session export to stdout with format json using stderr-separated runner")
def step_export_stdout_json_stderr_sep(context: Context) -> None:
# In Click 8.2+, CliRunner always separates stdout and stderr
context.result = context.runner.invoke(
session_app, ["export", context.session_id, "--format", "json"]
)
context.stdout = context.result.stdout
context.stderr = context.result.stderr
@when("I run session export to a temp file with format json")
def step_export_to_file_json(context: Context) -> None:
fd, path = tempfile.mkstemp(suffix=".json")
os.close(fd)
os.unlink(path)
context._cleanup_paths.append(path)
context.result = context.runner.invoke(
session_app,
["export", context.session_id, "--format", "json", "--output", path],
)
@when("I run session export to stdout with format md")
def step_export_stdout_md(context: Context) -> None:
context.result = context.runner.invoke(
session_app, ["export", context.session_id, "--format", "md"]
)
@then("the stdout output is valid JSON")
def step_stdout_is_valid_json(context: Context) -> None:
stdout = getattr(context, "stdout", context.result.stdout)
try:
json.loads(stdout)
except json.JSONDecodeError as exc:
raise AssertionError(
f"stdout is not valid JSON:\n{stdout!r}"
) from exc
@then('the stdout output does not contain Rich panel text "{text}"')
def step_stdout_no_rich_panel(context: Context, text: str) -> None:
stdout = getattr(context, "stdout", context.result.stdout)
assert text not in stdout, (
f"stdout should NOT contain {text!r} but it does.\n"
f"stdout:\n{stdout!r}"
)
@then('the stderr output contains "{text}"')
def step_stderr_contains(context: Context, text: str) -> None:
stderr = getattr(context, "stderr", context.result.stderr)
assert text in stderr, (
f"stderr should contain {text!r} but it does not.\n"
f"stderr:\n{stderr!r}"
)
@then("the exit code is {code:d}")
def step_exit_code(context: Context, code: int) -> None:
assert context.result.exit_code == code, (
f"Expected exit code {code}, got {context.result.exit_code}.\n"
f"Output:\n{context.result.output}"
)
@then('the output contains "{text}"')
def step_output_contains(context: Context, text: str) -> None:
assert text in context.result.output, (
f"Expected {text!r} in output:\n{context.result.output}"
)
@@ -0,0 +1,287 @@
"""Step definitions for TUI multi-session tabs feature."""
from __future__ import annotations
from datetime import datetime
from behave import given, then, when
from cleveragents.tui.app import SessionView
from cleveragents.tui.persona.registry import PersonaRegistry
from cleveragents.tui.persona.state import PersonaState
class MockCommandRouter:
"""Mock command router for testing."""
def handle(self, raw: str, *, session_id: str) -> str:
"""Mock command handler."""
return f"Mock response for {raw} in session {session_id}"
@given("a TUI app is initialized with multi-session support")
def step_init_tui_app(context: object) -> None:
"""Initialize a TUI app with multi-session support."""
context.registry = PersonaRegistry() # type: ignore
context.persona_state = PersonaState(registry=context.registry) # type: ignore
context.router = MockCommandRouter() # type: ignore
# Note: We can't instantiate _TextualCleverAgentsTuiApp directly without Textual
# So we'll test the session management logic separately
@when("the TUI app is created")
def step_create_tui_app(context: object) -> None:
"""Create a TUI app instance."""
# Create a mock app with session management
context.app = type("MockApp", (), {})() # type: ignore
context.app._sessions = [ # type: ignore
SessionView(
session_id="default",
transcript=[],
name="Default",
created_at=datetime.utcnow().isoformat(),
)
]
context.app._active_session_index = 0 # type: ignore
@then("the app should have exactly {count:d} session")
def step_check_session_count(context: object, count: int) -> None:
"""Check the number of sessions."""
assert len(context.app._sessions) == count # type: ignore
@then("the active session should have session_id {session_id}")
def step_check_active_session_id(context: object, session_id: str) -> None:
"""Check the active session ID."""
active = context.app._sessions[context.app._active_session_index] # type: ignore
assert active.session_id == session_id
@then("the active session should have name {name}")
def step_check_active_session_name(context: object, name: str) -> None:
"""Check the active session name."""
active = context.app._sessions[context.app._active_session_index] # type: ignore
assert active.name == name
@when("I create a new session with name {name}")
def step_create_session(context: object, name: str) -> None:
"""Create a new session."""
import uuid
session_id = str(uuid.uuid4())[:8]
new_session = SessionView(
session_id=session_id,
transcript=[],
name=name,
created_at=datetime.utcnow().isoformat(),
)
context.app._sessions.append(new_session) # type: ignore
context.app._active_session_index = len(context.app._sessions) - 1 # type: ignore
@then("the new session should have an independent session_id")
def step_check_new_session_id(context: object) -> None:
"""Check that the new session has a unique ID."""
sessions = context.app._sessions # type: ignore
session_ids = [s.session_id for s in sessions]
assert len(session_ids) == len(set(session_ids)) # All unique
@given("the TUI app has {count:d} session")
def step_setup_sessions(context: object, count: int) -> None:
"""Set up the TUI app with a specific number of sessions."""
context.app = type("MockApp", (), {})() # type: ignore
context.app._sessions = [] # type: ignore
for i in range(count):
if i == 0:
session_id = "default"
name = "Default"
else:
import uuid
session_id = str(uuid.uuid4())[:8]
name = f"Session {i + 1}"
session = SessionView(
session_id=session_id,
transcript=[],
name=name,
created_at=datetime.utcnow().isoformat(),
)
context.app._sessions.append(session) # type: ignore
context.app._active_session_index = 0 # type: ignore
@given("the first session has session_id {session_id}")
def step_check_first_session_id(context: object, session_id: str) -> None:
"""Verify the first session has the expected ID."""
assert context.app._sessions[0].session_id == session_id # type: ignore
@given("the second session has session_id {session_id}")
def step_check_second_session_id(context: object, session_id: str) -> None:
"""Verify the second session has the expected ID."""
assert context.app._sessions[1].session_id == session_id # type: ignore
@when("I switch to session {session_id}")
def step_switch_session(context: object, session_id: str) -> None:
"""Switch to a specific session."""
for idx, session in enumerate(context.app._sessions): # type: ignore
if session.session_id == session_id:
context.app._active_session_index = idx # type: ignore
return
raise ValueError(f"Session {session_id} not found")
@when("I close the session with session_id {session_id}")
def step_close_session(context: object, session_id: str) -> None:
"""Close a session."""
if len(context.app._sessions) <= 1: # type: ignore
context.close_failed = True # type: ignore
return
for idx, session in enumerate(context.app._sessions): # type: ignore
if session.session_id == session_id:
context.app._sessions.pop(idx) # type: ignore
if context.app._active_session_index >= len(context.app._sessions): # type: ignore
context.app._active_session_index = len(context.app._sessions) - 1 # type: ignore
context.close_failed = False # type: ignore
return
raise ValueError(f"Session {session_id} not found")
@when("I try to close the session with session_id {session_id}")
def step_try_close_session(context: object, session_id: str) -> None:
"""Try to close a session (may fail)."""
context.close_failed = False # type: ignore
if len(context.app._sessions) <= 1: # type: ignore
context.close_failed = True # type: ignore
return
for idx, session in enumerate(context.app._sessions): # type: ignore
if session.session_id == session_id:
context.app._sessions.pop(idx) # type: ignore
if context.app._active_session_index >= len(context.app._sessions): # type: ignore
context.app._active_session_index = len(context.app._sessions) - 1 # type: ignore
return
@then("the close operation should fail")
def step_check_close_failed(context: object) -> None:
"""Check that the close operation failed."""
assert context.close_failed # type: ignore
@when("I rename the session to {new_name}")
def step_rename_session(context: object, new_name: str) -> None:
"""Rename the active session."""
active = context.app._sessions[context.app._active_session_index] # type: ignore
active.name = new_name
@given("the active session has name {name}")
def step_check_active_session_has_name(context: object, name: str) -> None:
"""Verify the active session has a specific name."""
active = context.app._sessions[context.app._active_session_index] # type: ignore
assert active.name == name
@given("the first session is active")
def step_first_session_active(context: object) -> None:
"""Make the first session active."""
context.app._active_session_index = 0 # type: ignore
@when("I set persona {persona_name} for the first session")
def step_set_persona_first(context: object, persona_name: str) -> None:
"""Set persona for the first session."""
session_id = context.app._sessions[0].session_id # type: ignore
context.persona_state.active_by_session[session_id] = persona_name # type: ignore
@when("I set persona {persona_name} for the second session")
def step_set_persona_second(context: object, persona_name: str) -> None:
"""Set persona for the second session."""
session_id = context.app._sessions[1].session_id # type: ignore
context.persona_state.active_by_session[session_id] = persona_name # type: ignore
@when("I switch back to the first session")
def step_switch_back_to_first(context: object) -> None:
"""Switch back to the first session."""
context.app._active_session_index = 0 # type: ignore
@then("the first session should have active persona {persona_name}")
def step_check_first_session_persona(context: object, persona_name: str) -> None:
"""Check the first session's active persona."""
session_id = context.app._sessions[0].session_id # type: ignore
assert context.persona_state.active_by_session.get(session_id) == persona_name # type: ignore
@then("the second session should have active persona {persona_name}")
def step_check_second_session_persona(context: object, persona_name: str) -> None:
"""Check the second session's active persona."""
session_id = context.app._sessions[1].session_id # type: ignore
assert context.persona_state.active_by_session.get(session_id) == persona_name # type: ignore
@when("I add message {message} to the first session")
def step_add_message_first(context: object, message: str) -> None:
"""Add a message to the first session."""
context.app._sessions[0].transcript.append(message) # type: ignore
@when("I add message {message} to the second session")
def step_add_message_second(context: object, message: str) -> None:
"""Add a message to the second session."""
context.app._sessions[1].transcript.append(message) # type: ignore
@then("the first session transcript should contain {message}")
def step_check_first_transcript_contains(context: object, message: str) -> None:
"""Check that the first session transcript contains a message."""
assert message in context.app._sessions[0].transcript # type: ignore
@then("the first session transcript should not contain {message}")
def step_check_first_transcript_not_contains(context: object, message: str) -> None:
"""Check that the first session transcript does not contain a message."""
assert message not in context.app._sessions[0].transcript # type: ignore
@then("the second session transcript should contain {message}")
def step_check_second_transcript_contains(context: object, message: str) -> None:
"""Check that the second session transcript contains a message."""
assert message in context.app._sessions[1].transcript # type: ignore
@then("the second session transcript should not contain {message}")
def step_check_second_transcript_not_contains(context: object, message: str) -> None:
"""Check that the second session transcript does not contain a message."""
assert message not in context.app._sessions[1].transcript # type: ignore
@when("I create a new session")
def step_create_new_session(context: object) -> None:
"""Create a new session."""
import uuid
session_id = str(uuid.uuid4())[:8]
new_session = SessionView(
session_id=session_id,
transcript=[],
name=f"Session {len(context.app._sessions) + 1}", # type: ignore
created_at=datetime.utcnow().isoformat(),
)
context.app._sessions.append(new_session) # type: ignore
context.app._active_session_index = len(context.app._sessions) - 1 # type: ignore
context.new_session = new_session # type: ignore
@then("the new session should have a created_at timestamp in ISO format")
def step_check_created_at_timestamp(context: object) -> None:
"""Check that the new session has a valid ISO format timestamp."""
timestamp = context.new_session.created_at # type: ignore
# Try to parse it as ISO format
datetime.fromisoformat(timestamp)
@@ -236,7 +236,7 @@ def step_verify_session_active_persona(context, session_id, expected):
assert context.state.active_by_session[session_id] == expected
@then('the mock registry set_last_persona should have been called with "{expected}"')
@then('the mock registry last persona should be set to "{expected}"')
def step_verify_last_persona_set(context, expected):
context.mock_registry.set_last_persona.assert_called_with(expected)
@@ -0,0 +1,35 @@
@tdd_issue @tdd_issue_10503 @mock_only
Feature: Session export JSON stdout purity
As a developer using the CLI
I want `agents session export --format json` to write only valid JSON to stdout
So that I can pipe the output to other tools without Rich panel contamination
Background:
Given a session export JSON stdout test runner
Scenario: Export to stdout with JSON format produces clean JSON on stdout
Given a mocked session service for JSON stdout export
When I run session export to stdout with format json
Then the stdout output is valid JSON
And the stdout output does not contain Rich panel text "Session Export"
And the stdout output does not contain Rich panel text "Contents"
And the stdout output does not contain Rich panel text "Integrity"
Scenario: Export to stdout with JSON format still shows Rich panels on stderr
Given a mocked session service for JSON stdout export
When I run session export to stdout with format json using stderr-separated runner
Then the stdout output is valid JSON
And the stderr output contains "Session Export"
And the stderr output contains "Export completed"
Scenario: Export to file with JSON format still shows Rich panels on stdout
Given a mocked session service for JSON stdout export
When I run session export to a temp file with format json
Then the exit code is 0
And the output contains "Session Export"
And the output contains "Export completed"
Scenario: Export to stdout with md format is unaffected
Given a mocked session service for JSON stdout export
When I run session export to stdout with format md
Then the exit code is 0
+72
View File
@@ -0,0 +1,72 @@
Feature: TUI Multi-Session Tabs with Independent A2A Bindings
The TUI supports multiple session tabs, each with independent A2A bindings,
persona selection, and conversation history.
Background:
Given a TUI app is initialized with multi-session support
Scenario: TUI starts with a default session
When the TUI app is created
Then the app should have exactly 1 session
And the active session should have session_id "default"
And the active session should have name "Default"
Scenario: Create a new session
Given the TUI app has 1 session
When I create a new session with name "Session 2"
Then the app should have exactly 2 sessions
And the active session should have name "Session 2"
And the new session should have an independent session_id
Scenario: Switch between sessions
Given the TUI app has 2 sessions
And the first session has session_id "default"
And the second session has session_id "sess-2"
When I switch to session "default"
Then the active session should have session_id "default"
When I switch to session "sess-2"
Then the active session should have session_id "sess-2"
Scenario: Close a session
Given the TUI app has 2 sessions
When I close the session with session_id "sess-2"
Then the app should have exactly 1 session
And the active session should have session_id "default"
Scenario: Cannot close the last session
Given the TUI app has 1 session
When I try to close the session with session_id "default"
Then the close operation should fail
And the app should still have exactly 1 session
Scenario: Rename a session
Given the TUI app has 1 session
And the active session has name "Default"
When I rename the session to "My Session"
Then the active session should have name "My Session"
Scenario: Each session has independent persona tracking
Given the TUI app has 2 sessions
And the first session is active
When I set persona "analyst" for the first session
And I switch to the second session
And I set persona "coder" for the second session
And I switch back to the first session
Then the first session should have active persona "analyst"
When I switch to the second session
Then the second session should have active persona "coder"
Scenario: Each session has independent transcript
Given the TUI app has 2 sessions
And the first session is active
When I add message "Hello from session 1" to the first session
And I switch to the second session
And I add message "Hello from session 2" to the second session
Then the first session transcript should contain "Hello from session 1"
And the first session transcript should not contain "Hello from session 2"
And the second session transcript should contain "Hello from session 2"
And the second session transcript should not contain "Hello from session 1"
Scenario: Session creation includes timestamp
When I create a new session
Then the new session should have a created_at timestamp in ISO format
+1 -1
View File
@@ -33,7 +33,7 @@ Feature: TUI Persona State Coverage
When I set persona "coder" for session "sess-6"
Then the returned persona name should be "coder"
And session "sess-6" should have active persona "coder"
And the mock registry set_last_persona should have been called with "coder"
And the mock registry last persona should be set to "coder"
Scenario: set_active_persona skips preset init when session already has one
Given the preset for session "sess-6b" is already set to "turbo"
+2
View File
@@ -5,6 +5,8 @@ site_url: https://docs.cleverthis.com/cleveragents
site_dir: build/site
nav:
- Specification: specification.md
- Guides:
- Installation and Setup: guides/installation-setup.md
- Architecture: architecture.md
- CLI Reference (v3.2.0/v3.3.0): cli.md
- Decision System: decisions.md
+10 -3
View File
@@ -305,10 +305,17 @@ class EventBusBridge:
data=dict(details) if details else {},
)
import contextlib
with contextlib.suppress(RuntimeError):
try:
self._event_queue.publish(a2a_event)
except RuntimeError as e:
# Only suppress the specific error when the queue is closed.
# Other RuntimeErrors should propagate.
if "Cannot publish to a closed event queue" not in str(e):
raise
logger.debug(
"a2a.event_bridge.queue_closed",
event_type=sse_type,
)
__all__ = [
@@ -53,8 +53,14 @@ from cleveragents.application.services.subplan_execution_service import (
SubplanExecutionResult,
SubplanExecutionService,
)
from cleveragents.core.exceptions import PlanError, ValidationError
from cleveragents.core.exceptions import (
BudgetExceededError,
PlanBudgetExceededError,
PlanError,
ValidationError,
)
from cleveragents.domain.models.core.change import ChangeSetStore
from cleveragents.domain.models.core.cost_metadata import CostMetadata
from cleveragents.domain.models.core.estimation import EstimationResult
from cleveragents.domain.models.core.plan import (
PlanInvariant,
@@ -73,6 +79,7 @@ from cleveragents.infrastructure.sandbox.checkpoint import (
CheckpointManager,
SandboxCheckpoint,
)
from cleveragents.providers.cost_tracker import BudgetStatus, CostTracker
from cleveragents.tool.builtins.changeset import ChangeSet, ChangeSetCapture
from cleveragents.tool.runner import ToolRunner
@@ -352,6 +359,8 @@ class PlanExecutor:
tier_service: ContextTierService | None = None,
project_repository: NamespacedProjectRepository | None = None,
resource_registry: ResourceRegistryService | None = None,
cost_tracker: CostTracker | None = None,
cost_metadata: CostMetadata | None = None,
) -> None:
"""Initialize the plan executor.
@@ -408,6 +417,8 @@ class PlanExecutor:
self._tier_service = tier_service
self._project_repository = project_repository
self._resource_registry = resource_registry
self._cost_tracker = cost_tracker
self._cost_metadata = cost_metadata
self._strategize_actor = strategize_actor or StrategizeStubActor()
self._execute_actor = execute_actor or ExecuteStubActor()
self._running_plan_ids: set[str] = set()
@@ -1109,6 +1120,97 @@ class PlanExecutor:
)
if not self._guardrail_service.check_wall_clock(plan_id):
raise PlanError(f"Guardrail wall-clock limit exceeded for plan {plan_id}")
self._check_budget(plan_id)
def _check_budget(self, plan_id: str) -> None:
"""Check budget limits before each execution step.
Checks both per-plan and session/daily budget limits using the
configured ``CostTracker``. If a budget is exceeded, saves the
plan state gracefully before raising the appropriate exception.
- Per-plan budget exceeded: raises :class:`PlanBudgetExceededError`
- Session/daily budget exceeded: raises :class:`BudgetExceededError`
Args:
plan_id: The plan identifier.
Raises:
PlanBudgetExceededError: When the per-plan budget is exceeded.
BudgetExceededError: When the session or daily budget is exceeded.
"""
if self._cost_tracker is None:
return
cost_metadata = self._cost_metadata
if cost_metadata is None:
cost_metadata = CostMetadata()
# Check per-plan budget
plan_result = self._cost_tracker.check_plan_budget(cost_metadata)
if plan_result.status == BudgetStatus.EXCEEDED:
self._save_plan_state_on_budget_halt(
plan_id,
budget_type="plan",
used=plan_result.used,
limit=plan_result.limit or 0.0,
)
raise PlanBudgetExceededError(
f"Plan budget exceeded for plan {plan_id}: "
f"${plan_result.used:.4f} >= ${plan_result.limit or 0.0:.4f}",
plan_id=plan_id,
used=plan_result.used,
limit=plan_result.limit or 0.0,
)
# Check session/daily budget
daily_result = self._cost_tracker.check_daily_budget()
if daily_result.status == BudgetStatus.EXCEEDED:
self._save_plan_state_on_budget_halt(
plan_id,
budget_type="daily",
used=daily_result.used,
limit=daily_result.limit or 0.0,
)
raise BudgetExceededError(
f"Daily budget exceeded for plan {plan_id}: "
f"${daily_result.used:.4f} >= ${daily_result.limit or 0.0:.4f}",
plan_id=plan_id,
budget_type="daily",
used=daily_result.used,
limit=daily_result.limit or 0.0,
)
def _save_plan_state_on_budget_halt(
self,
plan_id: str,
budget_type: str,
used: float,
limit: float,
) -> None:
"""Save plan state gracefully before halting due to budget exceeded."""
try:
plan = self._lifecycle.get_plan(plan_id)
plan.error_details = {
"budget_halt": "true",
"budget_type": budget_type,
"budget_used": str(used),
"budget_limit": str(limit),
}
self._lifecycle._commit_plan(plan)
self._logger.warning(
"Plan halted due to budget exceeded",
plan_id=plan_id,
budget_type=budget_type,
used=used,
limit=limit,
)
except Exception:
self._logger.debug(
"Failed to save plan state on budget halt (non-fatal)",
plan_id=plan_id,
exc_info=True,
)
def _run_execute_with_runtime(
self,
+17 -7
View File
@@ -931,6 +931,13 @@ def export_session(
)
)
else:
# When exporting JSON to stdout, redirect Rich panels to stderr so
# the JSON output remains machine-readable (issue #10503).
if output is None and fmt == "json":
panels_console = Console(stderr=True)
else:
panels_console = console
# Render Rich panels for both file and stdout export paths
_render_export_panels(
session_id=session_id,
@@ -938,6 +945,7 @@ def export_session(
content=content,
export_data=json_data,
fmt=fmt,
panels_console=panels_console,
)
except SessionNotFoundError as exc:
@@ -962,6 +970,7 @@ def _render_export_panels(
content: str,
export_data: dict[str, Any],
fmt: str,
panels_console: Console | None = None,
) -> None:
"""Render the three spec-required Rich panels for ``agents session export``.
@@ -972,6 +981,7 @@ def _render_export_panels(
- "Integrity" panel: checksum, encrypted flag
- `` OK Export completed`` success line
"""
_console = panels_console if panels_console is not None else console
# Compute file size from content
size_bytes = len(content.encode("utf-8"))
if size_bytes < 1024:
@@ -1005,8 +1015,8 @@ def _render_export_panels(
export_table.add_row("Messages:", str(message_count))
export_table.add_row("Size:", size_str)
export_table.add_row("Format:", format_display)
console.print(Panel(export_table, title="Session Export", border_style="blue"))
console.print()
_console.print(Panel(export_table, title="Session Export", border_style="blue"))
_console.print()
# Contents panel
contents_table = Table.grid(padding=(0, 1))
@@ -1017,8 +1027,8 @@ def _render_export_panels(
contents_table.add_row("Metadata Keys:", str(metadata_keys))
contents_table.add_row("Actor Config:", actor_config)
contents_table.add_row("Schema Version:", str(schema_version))
console.print(Panel(contents_table, title="Contents", border_style="blue"))
console.print()
_console.print(Panel(contents_table, title="Contents", border_style="blue"))
_console.print()
# Integrity panel
integrity_table = Table.grid(padding=(0, 1))
@@ -1026,10 +1036,10 @@ def _render_export_panels(
integrity_table.add_column(style="white", justify="left")
integrity_table.add_row("Checksum:", checksum_display)
integrity_table.add_row("Encrypted:", "no")
console.print(Panel(integrity_table, title="Integrity", border_style="blue"))
console.print()
_console.print(Panel(integrity_table, title="Integrity", border_style="blue"))
_console.print()
console.print("[green]✓ OK[/green] Export completed")
_console.print("[green]✓ OK[/green] Export completed")
@app.command("import")
+15 -1
View File
@@ -18,9 +18,23 @@ def tui_callback(
help="Run a one-shot headless startup check instead of full UI loop.",
),
] = False,
web: Annotated[
bool,
typer.Option(
"--web",
help="Launch TUI in web mode accessible via browser.",
),
] = False,
web_port: Annotated[
int,
typer.Option(
"--web-port",
help="Port for web server (default: 8000).",
),
] = 8000,
) -> None:
"""Launch the CleverAgents TUI."""
# Import lazily so non-TUI commands avoid Textual startup cost.
from cleveragents.tui.commands import run_tui
raise typer.Exit(run_tui(headless=headless))
raise typer.Exit(run_tui(headless=headless, web=web, web_port=web_port))
+73
View File
@@ -293,6 +293,78 @@ class PlanError(DomainError):
pass
class BudgetExceededError(PlanError):
"""Raised when a session or daily budget limit is exceeded during plan execution.
Halts plan execution gracefully after saving plan state.
Attributes:
plan_id: The plan that was halted.
budget_type: The type of budget that was exceeded ('daily' or 'session').
used: Amount spent so far (USD).
limit: The budget limit that was exceeded (USD).
"""
def __init__(
self,
message: str,
plan_id: str = "",
budget_type: str = "session",
used: float = 0.0,
limit: float = 0.0,
details: dict[str, Any] | None = None,
) -> None:
"""Initialize with budget context.
Args:
message: Human-readable error message.
plan_id: The plan identifier.
budget_type: Type of budget exceeded ('daily' or 'session').
used: Amount spent so far in USD.
limit: The budget limit in USD.
details: Optional additional context.
"""
super().__init__(message, details)
self.plan_id = plan_id
self.budget_type = budget_type
self.used = used
self.limit = limit
class PlanBudgetExceededError(PlanError):
"""Raised when a per-plan budget limit is exceeded during plan execution.
Halts plan execution gracefully after saving plan state.
Attributes:
plan_id: The plan that was halted.
used: Amount spent so far (USD).
limit: The per-plan budget limit (USD).
"""
def __init__(
self,
message: str,
plan_id: str = "",
used: float = 0.0,
limit: float = 0.0,
details: dict[str, Any] | None = None,
) -> None:
"""Initialize with plan budget context.
Args:
message: Human-readable error message.
plan_id: The plan identifier.
used: Amount spent so far in USD.
limit: The per-plan budget limit in USD.
details: Optional additional context.
"""
super().__init__(message, details)
self.plan_id = plan_id
self.used = used
self.limit = limit
class DecisionPhaseViolationError(BusinessRuleViolation):
"""Raised when a decision type is invalid for the plan's current phase.
@@ -492,6 +564,7 @@ __all__ = [
"ModelNotAvailableError",
"NetworkError",
"NotFoundError",
"PlanBudgetExceededError",
"PlanError",
"ProviderError",
"RateLimitError",
@@ -221,6 +221,24 @@ class AutomationProfile(BaseModel):
description="Optional enforcement hooks for runtime constraints",
)
# -- Budget limits (YAML-configurable) ---------------------------------
budget_per_plan: float | None = Field(
default=None,
ge=0.0,
description=(
"Maximum USD spend per plan execution. None means unlimited. "
"When set, PlanExecutor halts with PlanBudgetExceededError if exceeded."
),
)
budget_per_session: float | None = Field(
default=None,
ge=0.0,
description=(
"Maximum USD spend per session. None means unlimited. "
"When set, PlanExecutor halts with BudgetExceededError if exceeded."
),
)
# -- Name validation ---------------------------------------------------
@field_validator("name")
+114 -7
View File
@@ -1,11 +1,13 @@
"""Textual TUI application shell."""
"""Textual TUI application shell - Multi-session support."""
from __future__ import annotations
import importlib
import os
import re
import uuid
from dataclasses import dataclass, field
from datetime import datetime
from typing import TYPE_CHECKING, Any, ClassVar, Protocol
import structlog
@@ -187,10 +189,12 @@ def textual_available() -> bool:
@dataclass(slots=True)
class SessionView:
"""Minimal per-session TUI view model."""
"""Per-session TUI view model with independent A2A binding."""
session_id: str
transcript: list[str] = field(default_factory=list)
name: str = "" # User-friendly session name
created_at: str = "" # ISO format timestamp
def _strip_pending_reference_token(value: str) -> str:
@@ -277,6 +281,8 @@ if _TEXTUAL_AVAILABLE:
("f1", "help", "Help"),
("ctrl+t", "cycle_preset", "Cycle Preset"),
("escape", "escape", "Close Overlay"),
("ctrl+n", "new_session", "New Session"),
("ctrl+w", "close_session", "Close Session"),
]
def __init__(
@@ -291,7 +297,16 @@ if _TEXTUAL_AVAILABLE:
self._command_router = command_router
self._persona_state = persona_state
self._facade = facade
self._session = SessionView(session_id=session_id)
# Multi-session support: maintain a list of sessions starting
# with one created from the controller-supplied session_id.
default_session = SessionView(
session_id=session_id,
transcript=[],
name="Default",
created_at=datetime.utcnow().isoformat(),
)
self._sessions: list[SessionView] = [default_session]
self._active_session_index: int = 0
# Monotonically increasing counter — incremented on each dispatch.
# _on_llm_done checks it to discard callbacks from cancelled workers
# (exclusive=True cancels in-flight workers; their done_callback still
@@ -308,6 +323,81 @@ if _TEXTUAL_AVAILABLE:
else None
)
@property
def _session(self) -> SessionView:
"""Alias for the currently active SessionView.
Bridges single-session call sites that read
``self._session.transcript`` / ``self._session.session_id`` to
the multi-session model so both APIs work consistently.
"""
return self._get_active_session()
def _get_active_session(self) -> SessionView:
"""Get the currently active session."""
if 0 <= self._active_session_index < len(self._sessions):
return self._sessions[self._active_session_index]
# Fallback to first session if index is invalid
if self._sessions:
self._active_session_index = 0
return self._sessions[0]
# Create default session if none exist
default_session = SessionView(
session_id="default",
transcript=[],
name="Default",
created_at=datetime.utcnow().isoformat(),
)
self._sessions = [default_session]
self._active_session_index = 0
return default_session
def _create_session(self, name: str = "") -> SessionView:
"""Create a new session with independent A2A binding."""
session_id = str(uuid.uuid4())[:8]
session_name = name or f"Session {len(self._sessions) + 1}"
new_session = SessionView(
session_id=session_id,
transcript=[],
name=session_name,
created_at=datetime.utcnow().isoformat(),
)
self._sessions.append(new_session)
return new_session
def _switch_session(self, session_id: str) -> SessionView | None:
"""Switch to a session by ID."""
for idx, session in enumerate(self._sessions):
if session.session_id == session_id:
self._active_session_index = idx
return session
return None
def _close_session(self, session_id: str) -> bool:
"""Close a session by ID. Returns False if it's the last session."""
if len(self._sessions) <= 1:
return False
for idx, session in enumerate(self._sessions):
if session.session_id == session_id:
self._sessions.pop(idx)
# Adjust active index if needed
if self._active_session_index >= len(self._sessions):
self._active_session_index = len(self._sessions) - 1
return True
return False
def _rename_session(self, session_id: str, new_name: str) -> bool:
"""Rename a session by ID."""
for session in self._sessions:
if session.session_id == session_id:
session.name = new_name
return True
return False
def _list_sessions(self) -> list[SessionView]:
"""Get all sessions."""
return self._sessions
def compose(self) -> Any:
yield _Header(show_clock=True)
with _Vertical(id="main-column"):
@@ -364,7 +454,22 @@ if _TEXTUAL_AVAILABLE:
help_panel.toggle(context_name)
def action_cycle_preset(self) -> None:
self._persona_state.cycle_preset(self._session.session_id)
session = self._get_active_session()
self._persona_state.cycle_preset(session.session_id)
self._refresh_persona_bar()
def action_new_session(self) -> None:
"""Create a new session (Ctrl+N)."""
self._create_session()
self._active_session_index = len(self._sessions) - 1
self._refresh_persona_bar()
def action_close_session(self) -> None:
"""Close the current session (Ctrl+W)."""
session = self._get_active_session()
if not self._close_session(session.session_id):
# Cannot close the last session
return
self._refresh_persona_bar()
def action_escape(self) -> None:
@@ -401,8 +506,9 @@ if _TEXTUAL_AVAILABLE:
focus_method()
def _refresh_persona_bar(self) -> None:
persona = self._persona_state.active_persona(self._session.session_id)
preset = self._persona_state.current_preset(self._session.session_id)
session = self._get_active_session()
persona = self._persona_state.active_persona(session.session_id)
preset = self._persona_state.current_preset(session.session_id)
scope_count = len(persona.scoped_projects) + len(persona.scoped_plans)
scope_text = f"{scope_count} scope refs"
bar = self.query_one("#persona-bar", PersonaBar)
@@ -488,9 +594,10 @@ if _TEXTUAL_AVAILABLE:
self._allow_dangerous_shell = self._resolve_allow_dangerous_shell()
self._clear_shell_warning()
session = self._get_active_session()
mode_router = InputModeRouter(
command_handler=lambda raw: self._command_router.handle(
raw, session_id=self._session.session_id
raw, session_id=session.session_id
),
shell_confirm=self._confirm_dangerous_shell,
shell_safety=self._shell_safety,
+142 -2
View File
@@ -335,8 +335,144 @@ def _create_tui_session(persona_state: PersonaState | None = None) -> str:
return _FALLBACK_SESSION_ID
def run_tui(*, headless: bool = False) -> int:
"""Run the Textual TUI app or a headless startup check."""
def _get_tui_web_html(port: int) -> str:
"""Generate HTML for TUI web mode.
Parameters
----------
port:
Port number for the web server.
Returns
-------
HTML content as string.
"""
return """<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>CleverAgents TUI</title>
<style>
body {
margin: 0;
padding: 0;
font-family: monospace;
background-color: #1e1e1e;
color: #f8f8f2;
}
#tui-container {
width: 100%;
height: 100vh;
overflow: hidden;
}
.loading {
display: flex;
align-items: center;
justify-content: center;
height: 100vh;
font-size: 18px;
}
</style>
</head>
<body>
<div id="tui-container">
<div class="loading">Loading CleverAgents TUI...</div>
</div>
<script>
// WebSocket connection to TUI app
// Note: This is a placeholder. Full implementation would require
// a WebSocket server in the TUI app to handle real-time rendering.
console.log("TUI Web mode loaded. WebSocket support coming soon.");
</script>
</body>
</html>"""
def _run_tui_web(app: CleverAgentsTuiApp, *, port: int = 8000) -> int: # type: ignore[valid-type]
"""Run the TUI app in web mode via HTTP server.
Parameters
----------
app:
The Textual TUI app instance.
port:
Port for the web server.
Returns
-------
Exit code (0 for success, non-zero for failure).
"""
try:
# Import web server dependencies
import threading
import webbrowser
from http.server import BaseHTTPRequestHandler, HTTPServer
class TuiWebHandler(BaseHTTPRequestHandler):
"""HTTP request handler for TUI web mode."""
def do_GET(self) -> None:
"""Handle GET requests."""
if self.path == "/" or self.path == "/index.html":
self.send_response(200)
self.send_header("Content-type", "text/html")
self.end_headers()
html = _get_tui_web_html(port)
self.wfile.write(html.encode("utf-8"))
else:
self.send_response(404)
self.end_headers()
def log_message(self, format: str, *args: Any) -> None:
"""Suppress default logging."""
pass
# Create and start HTTP server
server = HTTPServer(("127.0.0.1", port), TuiWebHandler)
server_thread = threading.Thread(target=server.serve_forever, daemon=True)
server_thread.start()
# Print startup message
url = f"http://127.0.0.1:{port}"
print(f"TUI Web mode started at {url}")
print("Press Ctrl+C to stop")
# Try to open browser
with contextlib.suppress(Exception):
webbrowser.open(url)
# Run the app in headless mode (web driver will handle rendering)
try:
app.run(headless=True)
except KeyboardInterrupt:
pass
finally:
server.shutdown()
return 0
except Exception as exc:
print(f"Error starting web mode: {exc}")
return 1
def run_tui(*, headless: bool = False, web: bool = False, web_port: int = 8000) -> int:
"""Run the Textual TUI app, headless check, or web mode.
Parameters
----------
headless:
Run a one-shot headless startup check instead of full UI loop.
web:
Launch TUI in web mode accessible via browser.
web_port:
Port for web server (default: 8000).
Returns
-------
Exit code (0 for success, non-zero for failure).
"""
container = get_container()
registry = container.persona_registry()
state = container.persona_state(registry=registry)
@@ -363,5 +499,9 @@ def run_tui(*, headless: bool = False) -> int:
facade=facade,
session_id=session_id,
)
if web:
return _run_tui_web(app, port=web_port)
app.run()
return 0
Submodule
+1
Submodule work/repo added at 435e409df9