feat(tool): add tool-level execution environment preferences #970
Merged
brent.edwards
merged 2 commits from 2026-03-20 23:51:47 +00:00
feature/m5-tool-env-prefs into master
Dismiss Review
Are you sure you want to dismiss this review?
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
No Assignees
brent.edwards
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: cleveragents/cleveragents-core#970
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "feature/m5-tool-env-prefs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Add tool-level execution environment preferences with four modes:
required,preferred,specific, andnone.Changes
New model (
domain/models/core/execution_environment_preference.py):EnvironmentPreferenceModeenum: REQUIRED, PREFERRED, SPECIFIC, NONEExecutionEnvironmentPreferencefrozen Pydantic model withmodeandtarget_resourcefieldstarget_resourcerequired iff mode is SPECIFICToolSpec & Tool model updates:
execution_environment: ExecutionEnvironmentPreferencefield to bothToolSpec(runtime) andTool(domain)Tool.from_config()parsesexecution_environmentfrom YAML config dictsToolRunner integration (
tool/runner.py):_env_resolver.resolve(), checksspec.execution_environment.mode:ContainerUnavailableErrorif resolved env is not CONTAINERtool_envwithtarget_resourceTests
Quality Gates
nox -s lintnox -s typechecknox -s unit_testsnox -s integration_testsCloses #879
6c6d7ec3ddto3bfd07758cPM Day 36 Triage: MERGE CONFLICT. @brent.edwards rebase onto master needed. This closes #879 and is an M6 feature targeting v3.5.0. Reviewer: @CoreRasurae — please review once rebased and conflicts are resolved.
PM Status — Day 37 — Rebase Required
This PR has merge conflicts and cannot be merged in its current state. 42% of all open PRs (21 of 50) have conflicts — this is a project-wide issue that must be resolved.
@brent.edwards — Please rebase this PR onto
masterby Day 39 EOD (2026-03-19). If you cannot rebase by then, please post a comment explaining the blocker.PM rebase request — Day 37
Code Review — PR #970
Reviewed against the full review protocol (Phases 0–9). Typecheck, lint, and all 27 Behave scenarios pass on the current branch. The core design (domain model + ToolRunner integration) is solid. However, there are blocking issues that need resolution before merge.
Critical (must fix)
F1: Scope creep — 7 unrelated files modified
The PR modifies
robot/architecture.robot,robot/cli_core.robot,robot/core_cli_commands.robot,robot/database_integration.robot,robot/scientific_paper_basic.robot,robot/scientific_paper_e2e_test.robot, andsrc/cleveragents/infrastructure/database/unit_of_work.py. These are Robot assertion tightening and a UoW lifecycle fix — neither related to tool env preferences. Please revert these and submit as separate PRs.F2: PR labels — Remove
MoSCoW/Should haveandPoints/5from the PR. These belong on the issue only.F3: Issue #879 subtasks — All 8 subtasks and 6 acceptance criteria are still unchecked.
F4: Merge conflicts — Branch is 52 commits behind master (
mergeable: false). Thedomain/models/core/__init__.pydiff removesSandboxDiffEntry,DiffView,SandboxRef,SandboxStrategyProtocolwhich were likely added on master after this branch diverged — these will conflict on rebase.Major (must fix)
F5:
SPECIFICmode doesn't route to the named target (runner.py:167-169)When
pref.mode == SPECIFIC, the code setseffective_tool_env = "container"but never passespref.target_resourceto the resolver or container executor. SPECIFIC currently behaves identically to REQUIRED — the named target is silently ignored. This is the primary value proposition of SPECIFIC mode.F6:
PREFERREDsemantics need documentation (runner.py:173-178)PREFERRED only upgrades to container when
effective_tool_env is None. If the caller passestool_env="host", the tool's preference is silently ignored. This may be intentional (caller override takes precedence) but contradicts the issue description ("try container, fall back to host"). Either document the current behavior or adjust the logic.F7: Missing
__all__(execution_environment_preference.py)Module needs:
F8:
providers/__init__.pydocstring — Unrelated to this feature. Move to a separate commit.Minor (non-blocking)
F9: Behave step (line 449) and Robot helper (line 239) use bare
MagicMock()forcontainer_executor. Should becreate_autospec(ContainerToolExecutor).F10: Verify
vulture_whitelist.pyadditions are limited to the new symbols.F11: No
structlogmessages in the preference routing block (runner.py:163-209). These routing decisions (REQUIRED fail, PREFERRED fallback, SPECIFIC override) should be logged for debugging.F12: The 4 ToolRunner Behave scenarios could share a
Backgroundto reduce setup duplication.Summary
The domain model is clean and well-validated. F5 (SPECIFIC not routing to target) is the most important functional bug — the rest are process and hygiene.
Code Review — PR #970 (Round 2)
Follow-up to the initial review. These are additional findings discovered during deeper scenario tracing, Pydantic round-trip testing, and boundary analysis. All confirmed empirically against the branch.
Major
F13: Whitespace-only
target_resourcepasses validation (execution_environment_preference.py:52,66)Confirmed:
The validator uses
not self.target_resourcewhich isFalsefor whitespace strings. The model'sConfigDicthasfrozen=Truebut nostr_strip_whitespace=True. A whitespace-only target is meaningless and will silently cause routing failures.Fix: add
str_strip_whitespace=Trueto the ConfigDict.F14: Rebase will silently drop
SandboxStrategyProtocoland 3 related symbols (related to F4)The PR's
__init__.pyis missing thesandbox_strategyimports (DiffView,SandboxDiffEntry,SandboxRef,SandboxStrategyProtocol) that were added to master in commit2688c857after this branch diverged. On rebase, the PR's__init__.pypatch will either conflict or silently remove these symbols. The author must manually verify all sandbox_strategy exports survive.F15: SPECIFIC mode failure gives generic error, no target name (
runner.py:203-208)Confirmed: when SPECIFIC mode targeting
local/api-devfails, the error is:No mention of the target
local/api-dev. Add a SPECIFIC-mode handler before theelsebranch:Minor
F16:
as_cli_dictuses string comparison instead of enum (tool.py:533)All other comparisons in this PR use enum members (e.g.,
pref.mode == EnvironmentPreferenceMode.SPECIFIC). Should beee.mode != EnvironmentPreferenceMode.NONEfor consistency.F17: No test for SPECIFIC mode failure path
The feature tests REQUIRED failure and PREFERRED fallback, but no scenario covers SPECIFIC mode when the container is unavailable.
F18: No boundary test for whitespace-only
target_resourceOnce F13 is fixed, add a scenario verifying rejection.
F19: No test for
from_configwith invalidexecution_environmenttypeexecution_environment: "required"(string instead of dict) raises a rawValidationError. Should have a scenario verifying the error.F20:
from_configtreatsexecution_environment: nullas default silentlyMay be intentional, but should be documented.
F21:
str_strip_whitespaceinconsistency betweenTooland nestedExecutionEnvironmentPreferenceConfirmed:
Tool.description = " padded "gets stripped to"padded", butpref.target_resource = " padded "stays as-is. Fix overlaps with F13.Round 2 Summary
check comments
Response to @hamza.khyari's Review (Rounds 1+2) — PR #970
Thank you for the comprehensive review, Hamza. The SPECIFIC mode routing bug (F5) is a great catch — that's the primary value prop of the feature.
Critical
F1 (Scope creep — 7 unrelated files): Agreed. Will revert the Robot assertion tightening and UoW lifecycle fix to separate PRs. The commit should contain only the tool env preference feature files.
F2 (PR labels): Will remove
MoSCoW/Should haveandPoints/5.F3 (Issue subtasks): Will check off completed items on #879.
F4 (Merge conflicts / rebase): Will rebase onto current master. Will manually verify all
sandbox_strategyexports survive, per your note aboutSandboxStrategyProtocoletc.Major (Round 1)
F5 (SPECIFIC mode doesn't route to named target): Confirmed bug. Will pass
pref.target_resourcethrough toresolve_and_validate()and the container executor, so SPECIFIC mode actually uses the named container resource.F6 (PREFERRED semantics): Will document: "caller override takes precedence over tool preference — PREFERRED only upgrades when no caller override is set."
F7 (Missing
__all__): Will add.F8 (Unrelated docstring change): Will move to separate commit.
Major (Round 2)
F13 (Whitespace-only
target_resource): Will addstr_strip_whitespace=Trueto the model ConfigDict.F14 (Rebase symbol loss): Will carefully merge
sandbox_strategyimports during rebase.F15 (SPECIFIC error message generic): Will add a SPECIFIC-mode handler with the target resource name in the error message.
Minor
F9: Will use
create_autospec(ContainerToolExecutor).F10: Will verify vulture whitelist.
F11: Will add
structlogmessages for routing decisions.F12: Will add a
Backgroundfor shared setup.F16: Will use enum comparison instead of string.
F17-F21: Will add boundary test scenarios for SPECIFIC failure, whitespace target, invalid config type, null config, and strip inconsistency.
Working on all fixes now. The rebase (F4) will be done first to establish a clean base for the other changes.
3bfd07758cto1400f1a5b91400f1a5b9toddd1c4b7bcddd1c4b7bcto7c7e4d5cecReview Fixes Applied — Commit
7c7e4d5cBranch rebased onto
origin/master(ad98d41d). Scope creep (F1) and merge conflicts (F4) automatically resolved by rebase. All actionable findings addressed.__all__)create_autospec)MagicMock()withcreate_autospec(ContainerToolExecutor)in both test filesstr_strip_whitespace=Truein ConfigDicttarget_resourceEnvironmentPreferenceMode.NONEQuality Gates
nox -s lint— PASSnox -s typecheck— PASS (0 errors)Code Review — PR #970
Tool-level execution environment preferences. Proper labels, milestone, and issue linkage (#879). Approved.
7c7e4d5cecto514d36a531New commits pushed, approval review dismissed automatically according to repository settings
Rebased onto
origin/master(79b0a2c5). CHANGELOG conflict resolved (kept master, re-added PR entry).nox -s lintPASS,nox -s typecheckPASS (0 errors). Commit514d36a5.