test: add TDD bug-capture test for #968 — plan explain plan_id handling #1052

Merged

hurui200320 merged 1 commit from tdd/m3-plan-explain-plan-id into master 2026-03-19 07:21:12 +00:00

Conversation 1 Commits 1 Files changed 5 +456

hurui200320 commented 2026-03-18 09:20:58 +00:00

Member

Copy link

Summary

Add TDD bug-capture tests for bug #968: the plan explain CLI command fails with rc=1 when given a plan_id because explain_decision_cmd treats its argument as a decision_id and svc.get_decision(plan_id) raises DecisionNotFoundError.

These tests capture the exact failure condition described in #968 and are tagged with @tdd_expected_fail, @tdd_bug, and @tdd_bug_968. The @tdd_expected_fail tag inverts the test result so that CI passes while the bug is unfixed. Once bug #968 is fixed, the @tdd_expected_fail tag will be removed and the tests will serve as permanent regression tests.

Closes #978

Changes

Behave Tests (features/tdd_plan_explain_plan_id.feature)

• Scenario 1: Plan explain succeeds when given a plan_id with decisions — Mocks DecisionService so get_decision(plan_id) raises DecisionNotFoundError (the bug) and list_decisions(plan_id) returns decisions. Invokes plan explain <plan_id> via CliRunner and asserts rc=0 with decision details visible. Verifies list_decisions was called with the correct plan_id.
• Scenario 2: Plan explain with plan_id shows root decision question — Same setup, asserts the root decision question appears in the output.

Both scenarios currently fail (rc=1, proving the bug exists), but the @tdd_expected_fail tag makes CI pass.

Robot Tests (robot/tdd_plan_explain_plan_id.robot)

• TDD Plan Explain Succeeds With Plan ID — Integration test using a helper script that records decisions via DecisionService, invokes plan explain <plan_id> via subprocess, and asserts rc=0.
• TDD Plan Explain With Plan ID Shows Root Question — Same setup, asserts the root decision question appears in the output.

Both tests carry tdd_expected_fail, tdd_bug, and tdd_bug_968 tags.

Step Definitions (features/steps/tdd_plan_explain_plan_id_steps.py)

Step implementations for the Behave feature, following the established patterns from plan_explain_cli_coverage_steps.py. Includes list_decisions.assert_called_once_with(plan_id) verification to ensure the fix exercises the fallback lookup path.

Helper Script (robot/helper_tdd_plan_explain_plan_id.py)

Python helper for Robot tests, following the established pattern from helper_tdd_checkpoint_real_rollback.py. Uses a shared _run_plan_explain() helper to avoid subprocess invocation duplication, sets NO_COLOR=1 in subprocess environment to prevent ANSI escape codes.

CHANGELOG

Added entry under ## Unreleased describing the TDD bug-capture tests for bug #968.

Review Fixes Applied (Iteration 1)

1. Imports moved to module level (Major) — Three imports in _setup_plan_with_decisions() moved to module level with # noqa: E402, consistent with all other robot/helper_tdd_*.py files.
2. Mock accurately models real behavior (Minor) — svc.get_decision.return_value = None changed to svc.get_decision.side_effect = DecisionNotFoundError(...) to match the real DecisionService.get_decision() which raises DecisionNotFoundError, not returns None.
3. Strengthened assertion (Minor) — assert "decision_id" in output or "question" in output changed to AND for a more precise assertion that verifies both fields are present.
4. Removed # type: ignore[arg-type] (Minor) — Changed kwargs: dict[str, object] to kwargs: dict and removed the # type: ignore[arg-type] directive, per CONTRIBUTING.md type safety rules.
5. Handled subprocess.TimeoutExpired (Minor) — Both subprocess.run() calls wrapped in try/except subprocess.TimeoutExpired with descriptive _fail() messages.
6. Resolved timeout race condition (Minor) — Inner subprocess.run timeout reduced from 60s to 45s so the helper catches timeout before Robot's 60s outer timeout kills it.
7. Defensive setup check (Nit, addressed) — Added list_decisions() verification after record_decision() to distinguish setup failures from the actual bug.

Review Fixes Applied (Iteration 2)

1. Added CHANGELOG.md entry (Major) — Added entry under ## Unreleased describing the TDD bug-capture tests for bug #968, per CONTRIBUTING.md §"Pull Request Process".
2. Fixed Gherkin step text and feature comments (Minor) — Renamed step from "returns None" to "raises DecisionNotFoundError" in feature file and step decorator. Updated feature comment from "returns None" to "raises DecisionNotFoundError". Step text now accurately describes the mock behavior.
3. Fixed Robot helper output assertion logic (Minor) — Changed if "decision" not in combined.lower() and "question" not in combined.lower() to or so both keywords must be present, matching the Behave test's AND-based validation.
4. Added NO_COLOR=1 to subprocess environment (Minor) — Added _make_subprocess_env() helper that copies os.environ and sets NO_COLOR=1, following the established pattern from robot/helper_e2e_common.py.
5. Extracted shared subprocess helper (Nit, addressed) — Deduplicated subprocess invocation blocks into _run_plan_explain(plan_id) function, reducing code duplication across the two test subcommands.
6. Added list_decisions mock verification (Nit, addressed) — Added svc.list_decisions.assert_called_once_with(plan_id) in the Behave step that checks decision details, making the test contract clearer.
7. Rebased on current master (Nit, addressed) — Branch rebased on origin/master per CONTRIBUTING.md §"Branch Hygiene".

Quality Gates

• ✅ nox -e lint — All checks passed
• ✅ nox -e typecheck — 0 errors
• ✅ nox -e unit_tests — 391 features, 11175 scenarios, 0 failed
• ✅ nox -e integration_tests — All tests passed (including Tdd Plan Explain Plan Id)
• ✅ nox -e e2e_tests — 16 tests, 0 failed
• ✅ nox -e coverage_report — 97% coverage (≥97% threshold met)

## Summary Add TDD bug-capture tests for bug #968: the `plan explain` CLI command fails with rc=1 when given a plan_id because `explain_decision_cmd` treats its argument as a decision_id and `svc.get_decision(plan_id)` raises `DecisionNotFoundError`. These tests capture the exact failure condition described in #968 and are tagged with `@tdd_expected_fail`, `@tdd_bug`, and `@tdd_bug_968`. The `@tdd_expected_fail` tag inverts the test result so that CI passes while the bug is unfixed. Once bug #968 is fixed, the `@tdd_expected_fail` tag will be removed and the tests will serve as permanent regression tests. Closes #978 ## Changes ### Behave Tests (`features/tdd_plan_explain_plan_id.feature`) - **Scenario 1: Plan explain succeeds when given a plan_id with decisions** — Mocks `DecisionService` so `get_decision(plan_id)` raises `DecisionNotFoundError` (the bug) and `list_decisions(plan_id)` returns decisions. Invokes `plan explain <plan_id>` via CliRunner and asserts rc=0 with decision details visible. Verifies `list_decisions` was called with the correct `plan_id`. - **Scenario 2: Plan explain with plan_id shows root decision question** — Same setup, asserts the root decision question appears in the output. Both scenarios currently fail (rc=1, proving the bug exists), but the `@tdd_expected_fail` tag makes CI pass. ### Robot Tests (`robot/tdd_plan_explain_plan_id.robot`) - **TDD Plan Explain Succeeds With Plan ID** — Integration test using a helper script that records decisions via `DecisionService`, invokes `plan explain <plan_id>` via subprocess, and asserts rc=0. - **TDD Plan Explain With Plan ID Shows Root Question** — Same setup, asserts the root decision question appears in the output. Both tests carry `tdd_expected_fail`, `tdd_bug`, and `tdd_bug_968` tags. ### Step Definitions (`features/steps/tdd_plan_explain_plan_id_steps.py`) Step implementations for the Behave feature, following the established patterns from `plan_explain_cli_coverage_steps.py`. Includes `list_decisions.assert_called_once_with(plan_id)` verification to ensure the fix exercises the fallback lookup path. ### Helper Script (`robot/helper_tdd_plan_explain_plan_id.py`) Python helper for Robot tests, following the established pattern from `helper_tdd_checkpoint_real_rollback.py`. Uses a shared `_run_plan_explain()` helper to avoid subprocess invocation duplication, sets `NO_COLOR=1` in subprocess environment to prevent ANSI escape codes. ### CHANGELOG Added entry under `## Unreleased` describing the TDD bug-capture tests for bug #968. ## Review Fixes Applied (Iteration 1) 1. **Imports moved to module level** (Major) — Three imports in `_setup_plan_with_decisions()` moved to module level with `# noqa: E402`, consistent with all other `robot/helper_tdd_*.py` files. 2. **Mock accurately models real behavior** (Minor) — `svc.get_decision.return_value = None` changed to `svc.get_decision.side_effect = DecisionNotFoundError(...)` to match the real `DecisionService.get_decision()` which raises `DecisionNotFoundError`, not returns `None`. 3. **Strengthened assertion** (Minor) — `assert "decision_id" in output or "question" in output` changed to AND for a more precise assertion that verifies both fields are present. 4. **Removed `# type: ignore[arg-type]`** (Minor) — Changed `kwargs: dict[str, object]` to `kwargs: dict` and removed the `# type: ignore[arg-type]` directive, per CONTRIBUTING.md type safety rules. 5. **Handled `subprocess.TimeoutExpired`** (Minor) — Both `subprocess.run()` calls wrapped in `try/except subprocess.TimeoutExpired` with descriptive `_fail()` messages. 6. **Resolved timeout race condition** (Minor) — Inner `subprocess.run` timeout reduced from 60s to 45s so the helper catches timeout before Robot's 60s outer timeout kills it. 7. **Defensive setup check** (Nit, addressed) — Added `list_decisions()` verification after `record_decision()` to distinguish setup failures from the actual bug. ## Review Fixes Applied (Iteration 2) 1. **Added CHANGELOG.md entry** (Major) — Added entry under `## Unreleased` describing the TDD bug-capture tests for bug #968, per CONTRIBUTING.md §"Pull Request Process". 2. **Fixed Gherkin step text and feature comments** (Minor) — Renamed step from "returns None" to "raises DecisionNotFoundError" in feature file and step decorator. Updated feature comment from "returns None" to "raises DecisionNotFoundError". Step text now accurately describes the mock behavior. 3. **Fixed Robot helper output assertion logic** (Minor) — Changed `if "decision" not in combined.lower() and "question" not in combined.lower()` to `or` so both keywords must be present, matching the Behave test's AND-based validation. 4. **Added `NO_COLOR=1` to subprocess environment** (Minor) — Added `_make_subprocess_env()` helper that copies `os.environ` and sets `NO_COLOR=1`, following the established pattern from `robot/helper_e2e_common.py`. 5. **Extracted shared subprocess helper** (Nit, addressed) — Deduplicated subprocess invocation blocks into `_run_plan_explain(plan_id)` function, reducing code duplication across the two test subcommands. 6. **Added `list_decisions` mock verification** (Nit, addressed) — Added `svc.list_decisions.assert_called_once_with(plan_id)` in the Behave step that checks decision details, making the test contract clearer. 7. **Rebased on current master** (Nit, addressed) — Branch rebased on `origin/master` per CONTRIBUTING.md §"Branch Hygiene". ## Quality Gates - ✅ `nox -e lint` — All checks passed - ✅ `nox -e typecheck` — 0 errors - ✅ `nox -e unit_tests` — 391 features, 11175 scenarios, 0 failed - ✅ `nox -e integration_tests` — All tests passed (including Tdd Plan Explain Plan Id) - ✅ `nox -e e2e_tests` — 16 tests, 0 failed - ✅ `nox -e coverage_report` — 97% coverage (≥97% threshold met)

hurui200320 added this to the v3.2.0 milestone 2026-03-18 09:21:06 +00:00

hurui200320 added the

Type

Testing

label 2026-03-18 09:21:06 +00:00

hurui200320 added a new dependency 2026-03-18 09:23:47 +00:00

#978 TDD: Write failing test for #968 — plan explain expects decision_id but test passes plan_id

hurui200320 force-pushed tdd/m3-plan-explain-plan-id from ea584830cb to e17f8b4f48 2026-03-18 11:41:09 +00:00 Compare

hurui200320 force-pushed tdd/m3-plan-explain-plan-id from e17f8b4f48 to 211618e1b3 2026-03-18 12:13:20 +00:00 Compare

freemo approved these changes 2026-03-19 04:55:16 +00:00

Dismissed

freemo left a comment

Copy link

Code Review — PR #1052 test: TDD bug-capture test for #968 — plan explain plan_id handling

Clean TDD test with correct tag triplet (@tdd_expected_fail @tdd_bug @tdd_bug_968). Good coverage of both CliRunner and subprocess invocation paths. The mock accurately models real behavior — get_decision raises DecisionNotFoundError (not returns None), matching the actual DecisionService. The list_decisions.assert_called_once_with(plan_id) verification ensures the fallback lookup path is exercised.

Approved. No issues found.

## Code Review — PR #1052 `test: TDD bug-capture test for #968 — plan explain plan_id handling` Clean TDD test with correct tag triplet (`@tdd_expected_fail @tdd_bug @tdd_bug_968`). Good coverage of both CliRunner and subprocess invocation paths. The mock accurately models real behavior — `get_decision` raises `DecisionNotFoundError` (not returns None), matching the actual `DecisionService`. The `list_decisions.assert_called_once_with(plan_id)` verification ensures the fallback lookup path is exercised. **Approved.** No issues found.

freemo requested reviews from brent.edwards, freemo 2026-03-19 05:16:18 +00:00

hurui200320 force-pushed tdd/m3-plan-explain-plan-id from 211618e1b3 to 058d486593 2026-03-19 07:13:27 +00:00 Compare

hurui200320 dismissed freemo's review 2026-03-19 07:13:27 +00:00

Reason:

New commits pushed, approval review dismissed automatically according to repository settings

hurui200320 scheduled this pull request to auto merge when all checks succeed 2026-03-19 07:18:37 +00:00

hurui200320 merged commit c741329f70 into master 2026-03-19 07:21:12 +00:00

hurui200320 deleted branch tdd/m3-plan-explain-plan-id 2026-03-19 07:21:12 +00:00

hurui200320 referenced this pull request from a commit 2026-03-19 07:21:14 +00:00

test: add TDD bug-capture test for #968 — plan explain plan_id handling (#1052)

CoreRasurae referenced this pull request 2026-03-19 21:55:35 +00:00

refactor(cli): align actor run signature with spec positional args #1072

CoreRasurae referenced this pull request 2026-03-19 22:01:27 +00:00

feat(tool): add move_file, create_directory, and get_file_info built-in tools #1070

HAL9000 referenced this pull request 2026-04-17 08:55:07 +00:00

[AUTO-UAT-POOL] Status: Monitoring Update (Cycle 4) #10227

Sign in to join this conversation.

Reviewers

No reviewers

brent.edwards

freemo

Labels

Clear labels   

auto/needs-reevaluation

Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.

  

controller-managed

Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.

  

auto/blocked-by-deps

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.

  

auto/ci-timeout

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.

  

auto/claimed-implementer

Currently being processed by an implementer worker.

  

auto/claimed-merge

Currently being processed by the merge driver.

  

auto/claimed-reviewer

Currently being processed by a reviewer worker.

  

auto/driver-down

Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  

auto/invariant-violation

Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  

auto/last-attempt-tier-0

In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-1

In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-2

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.

  

auto/last-attempt-tier-min

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.

  

Automation Tracking

Tracking issues used by the AI Automation system for agents to communicate and report.

  

auto/needs-conflict-resolution

Rebase conflict needs LLM conflict-resolver.

  

auto/needs-implementer

Failing CI needs implementer attention.

  

auto/postmortem

Documenting a driver incident or rollback.

  

auto/ready-to-merge

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.

  

auto/restart-throttled

Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  

auto/revert

Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  

auto/sentinel

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.

  

auto/stale-inactivity

No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  

auto/unstable

Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  

Blocked

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.

  

Needs Feedback

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

  

Signed-off: Owner

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.

  

Signed-off: Scrum Master

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.

  

Signed-off: Tech Lead

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.

  

Spike

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 labels

auto/needs-reevaluation

controller-managed

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

Bounty

$100

Bounty

$1000

Bounty

$10000

Bounty

$20

Bounty

$2000

Bounty

$250

Bounty

$50

Bounty

$500

Bounty

$5000

Bounty

$750

MoSCoW

Could have

MoSCoW

Must have

MoSCoW

Should have

Needs Feedback

Points

1

Points

13

Points

2

Points

21

Points

3

Points

34

Points

5

Points

55

Points

8

Points

88

Priority

Backlog

Priority

CI Blocker

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Signed-off: Owner

Signed-off: Scrum Master

Signed-off: Tech Lead

Spike

State

Completed

State

Duplicate

State

In Progress

State

In Review

State

Paused

State

Unverified

State

Verified

State

Wont Do

Type

Automation

Type

Bug

Type

Discussion

Type

Documentation

Type

Epic

Type

Feature

Type

Legendary

Type

Refactor

Type

Support

Type

Task

Type

Testing

Milestone

Clear milestone

No items

No milestone

v3.2.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks

#978 TDD: Write failing test for #968 — plan explain expects decision_id but test passes plan_id

cleveragents/cleveragents-core

Reference

cleveragents/cleveragents-core!1052

No description provided.