fix(cli): raise on subcommand registration failure instead of partial silent return #3264
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.
No Label
Milestone
No items
No Milestone
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
Notifications
Due Date
No due date set.
Blocks
#2604 BUG-HUNT: [error-handling] Incomplete subcommand registration on error
cleveragents/cleveragents-core
Reference: cleveragents/cleveragents-core#3264
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 "fix/cli-incomplete-subcommand-registration-on-error"
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
This PR fixes a silent error-suppression bug in
_register_subcommandswithin the CLI entry point, where an exception during subcommand registration caused the function to return silently with exit code 0 instead of propagating the error. This violated the project's core error-handling principle: "Errors must never be suppressed. Exceptions should propagate to the top-level execution handler."Changes
src/cleveragents/cli/main.py— In_register_subcommands, replaced the barereturnstatement inside the exception handler withraise SystemExit(1) from exc. This ensures that any failure during subcommand module import or registration:1), making the failure observable to callers and CI pipelines.from exc, satisfying theB904flake8-bugbear linting rule (exception chaining inexceptblocks).src/cleveragents/cli/main.py— Removed the# pragma: no coverannotation from the exception handler block. The handler is now exercised by the new BDD tests, so the pragma was no longer accurate or necessary.features/tdd_cli_incomplete_subcommand_registration.feature— Added a new Behave BDD issue-capture feature file with 3 scenarios:@tdd_expected_fail): Captures the old buggy behaviour (silentreturnwith exit code0on error) as an expected-failure scenario.features/steps/tdd_cli_incomplete_subcommand_registration_steps.py— Added the corresponding Behave step definitions.Design Decisions
raise SystemExit(1) from excover alternatives:raisewas considered but rejected because it would propagate the raw exception up the call stack, bypassing the CLI's top-level error formatting.raise SystemExit(1) from excexplicitly chains the causing exception (from exc), required by theB904linting rule and improves debuggability.@tdd_expected_failscenario:0on error) as an expected failure, providing a living regression record.Removal of
# pragma: no cover:Testing
Modules Affected
src/cleveragents/cli/main.pyreturn→raise SystemExit(1) from exc; removed# pragma: no coverfeatures/tdd_cli_incomplete_subcommand_registration.featurefeatures/steps/tdd_cli_incomplete_subcommand_registration_steps.pyCloses #2604
Automated by CleverAgents Bot
Supervisor: Implementation | Agent: ca-pr-api-creator
🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-3264-1775374200]
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-3264-1775373000]
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
Review Summary (Self-Review — Independent Code Review Agent)
Reviewed PR #3264 with focus on error-handling-patterns, edge-cases, and boundary-conditions.
Recommendation: APPROVE ✅ (posted as COMMENT due to Forgejo self-review restriction)
Core Fix Assessment
✅ Specification Compliance: The fix correctly aligns with CONTRIBUTING.md's error-handling mandate: "Errors must never be suppressed. Exceptions should propagate to the top-level execution handler."
✅ Error Handling Fix: Replacing
returnwithraise SystemExit(1) from excis the correct approach:SystemExit(1)ensures a non-zero exit code, making the failure observable to callers and CI pipelinesfrom excpreserves the exception chain, satisfying B904 and improving debuggabilitymain()function's existingexcept SystemExit as e:handler properly catches and converts this✅ Pragma Removal: Removing
# pragma: no coveris correct since the error path is now exercised by tests✅ PR Metadata: Complete and correct —
Closes #2604, milestone v3.6.0 matches issue,Type/Buglabel present, branch name matches issue metadata, commit message follows Conventional Changelog format withISSUES CLOSED: #2604footer✅ Commit Hygiene: Single atomic commit with detailed body explaining what/why/tests
Deep Dive: Error Handling Patterns
Given special attention to error handling:
Exception propagation chain is correct:
raise SystemExit(1) from exc→ caught bymain()→except SystemExit as e: return convert_exit_code(e.code)→ returns 1. The error flows through the established architecture cleanly.Module-level call safety:
_register_subcommands()is called at module level. If it raisesSystemExit(1), the import ofcleveragents.cli.mainwill propagate the error. This is actually the desired behavior — the module should not be importable in a half-initialized state. When invoked throughmain(), theSystemExitis properly caught.Guard flag behavior on failure: When the exception is raised,
_subcommands_registeredremainsFalse. This is correct — if the process somehow survives (e.g., in tests whereSystemExitis caught), a retry would re-attempt registration rather than silently assuming success.Broad
except Exceptioncatch: The broad catch is acceptable here since this is a top-level registration function where any failure during module import should be fatal. The issue's scope was specifically about thereturn→raisechange, not narrowing the exception type.Deep Dive: Edge Cases & Boundary Conditions
_subcommands_registeredearly-return guard: Correctly prevents double-registration. After a successful registration, subsequent calls are no-ops. After a failed registration (SystemExit raised), the flag remains False, allowing retry if the process survives.Multiple call sites:
_register_subcommands()is called from three places: module-level,main_callback, andmain(). All three paths now correctly propagate the SystemExit.Test Quality Assessment
✅ Scenario 1 (non-zero exit code): Correctly tests that callers of
_register_subcommandspropagate the error by patching the entire function to raise ImportError. This validates the integration between the function and its callers.✅ Scenario 3 (
@tdd_expected_fail): Correctly documents the old buggy behavior as a living regression record. This is proper TDD practice.⚠️ Scenario 2 (error message test): The mock approach in
step_then_error_messagepatchescleveragents.cli.commands.projectwithside_effect=ImportError(...). However,from cleveragents.cli.commands import projectbinds the name without calling the mock, so theside_effectwon't directly trigger anImportError. The test likely works because Typer'sadd_typer()fails when given aMagicMockinstead of a real Typer app, which triggers theexcept Exceptionblock and prints the "Failed to register subcommands" message. This is fragile — it depends on Typer's internal validation behavior rather than directly simulating the intended failure mode.Minor Suggestions (Non-blocking)
Scenario 2 mock robustness: Consider patching
builtins.__import__or usingimportlibmocking to directly trigger anImportErrorinside thetryblock of_register_subcommands, rather than relying on Typer's validation of mock objects. This would make the test more explicit about what it's testing. For example:Or alternatively, patch the specific import inside the function using
unittest.mock.patchon the import target withcreate=True.Feature file documentation: The feature file narrative is excellent. Consider adding a brief note in the
@tdd_expected_failscenario about when it should be removed (e.g., "Remove this scenario after #2604 is merged and verified").Decision: APPROVE ✅
The core fix is correct, well-motivated, and properly integrated with the existing error-handling architecture. The primary behavior (non-zero exit on registration failure) is well-tested. The minor test robustness concern does not block approval.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer