refactor(testing): rename tdd_bug/tdd_bug_N tags to tdd_issue/tdd_issue_N across Behave and Robot Framework

freemo commented

2026-03-16 02:35:11 +00:00

Owner

Metadata

Commit Message: refactor(testing): rename tdd_bug/tdd_bug_N tags to tdd_issue/tdd_issue_N
Branch: refactor/m3-tdd-tag-rename

Background and Context

The current TDD tag system uses @tdd_bug and @tdd_bug_<N> as the filter and issue-reference tags. However, the TDD expected-failure workflow is not limited to bug fixes — it applies equally to any issue type where a test is written before the implementation (features, tasks, refactors, etc.). The _bug suffix is misleading and artificially narrows the perceived scope of the TDD workflow.

This issue renames the tags to @tdd_issue and @tdd_issue_<N> to accurately reflect that the TDD tagging system applies to any Forgejo issue, not just bugs. The @tdd_expected_fail tag is unchanged — it already has a generic name.

The three-tag system after this rename:

Tag	Purpose	Lifecycle
`@tdd_issue`	Generic filter tag. Present on all TDD tests. Used to list, filter, and count TDD tests across the codebase.	Permanent — never removed.
`@tdd_issue_<N>`	Issue reference tag (e.g., `@tdd_issue_123`). Links the test to the specific Forgejo issue it captures. N is the issue number.	Permanent — never removed. Serves as a regression reference.
`@tdd_expected_fail`	Behavioral switch. When present, the test framework inverts the test result.	Temporary — removed when the issue is implemented/fixed.

Expected Behavior

All references to tdd_bug and tdd_bug_<N> are replaced with tdd_issue and tdd_issue_<N> respectively. The tag validation logic, test infrastructure, documentation, and all existing tagged test files are updated consistently. Normal test execution is completely unaffected apart from the name change.

Acceptance Criteria

features/environment.py: validate_tdd_tags() and should_invert_result() updated to recognize @tdd_issue / @tdd_issue_<N> instead of @tdd_bug / @tdd_bug_<N>
robot/tdd_expected_fail_listener.py: Listener v3 tag validation updated for tdd_issue / tdd_issue_<N>
All existing .feature files with @tdd_bug or @tdd_bug_<N> tags renamed to @tdd_issue / @tdd_issue_<N>
All existing .robot files with tdd_bug or tdd_bug_<N> tags renamed to tdd_issue / tdd_issue_<N>
Tag validation test files updated: features/testing/tdd_tag_validation.feature, robot/tdd_tag_validation.robot, robot/helper_tdd_tag_validation.py, and all fixture files under robot/fixtures/
CONTRIBUTING.md updated: "TDD Bug Test Tags" section renamed and all tdd_bug references changed to tdd_issue; "Bug Fix Workflow" section updated to reference tdd_issue tags
noxfile.py updated: any --include tdd_bug or --tag tdd_bug filter references changed to tdd_issue
nox -s unit_tests passes
nox -s integration_tests passes
ruff check and ruff format pass
Coverage >= 97% via nox -s coverage_report

Definition of Done

This issue is complete when:

All subtasks below are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.

Subtasks

Code: Update validate_tdd_tags() in features/environment.py — change all tdd_bug pattern matching to tdd_issue
Code: Update should_invert_result() and apply_tdd_inversion() in features/environment.py — change tag references
Code: Update robot/tdd_expected_fail_listener.py — change all tdd_bug pattern matching to tdd_issue in start_test and end_test hooks
Code: Rename tags in all existing Behave .feature files (features/tdd_*.feature)
Code: Rename tags in all existing Robot .robot files (robot/tdd_*.robot)
Code: Update all tag validation test files and fixtures
Code: Update noxfile.py filter/include references
Docs: Update CONTRIBUTING.md — rename section, update all tag references and examples
Quality: Verify nox passes (all default sessions including benchmark), fix any errors
Quality: Verify coverage >= 97% via nox -s coverage_report

## Metadata - **Commit Message**: `refactor(testing): rename tdd_bug/tdd_bug_N tags to tdd_issue/tdd_issue_N` - **Branch**: `refactor/m3-tdd-tag-rename` ## Background and Context The current TDD tag system uses `@tdd_bug` and `@tdd_bug_<N>` as the filter and issue-reference tags. However, the TDD expected-failure workflow is not limited to bug fixes — it applies equally to any issue type where a test is written before the implementation (features, tasks, refactors, etc.). The `_bug` suffix is misleading and artificially narrows the perceived scope of the TDD workflow. This issue renames the tags to `@tdd_issue` and `@tdd_issue_<N>` to accurately reflect that the TDD tagging system applies to **any** Forgejo issue, not just bugs. The `@tdd_expected_fail` tag is unchanged — it already has a generic name. The three-tag system after this rename: | Tag | Purpose | Lifecycle | |-----|---------|-----------| | `@tdd_issue` | Generic filter tag. Present on **all** TDD tests. Used to list, filter, and count TDD tests across the codebase. | **Permanent** — never removed. | | `@tdd_issue_<N>` | Issue reference tag (e.g., `@tdd_issue_123`). Links the test to the specific Forgejo issue it captures. N is the issue number. | **Permanent** — never removed. Serves as a regression reference. | | `@tdd_expected_fail` | Behavioral switch. When present, the test framework inverts the test result. | **Temporary** — removed when the issue is implemented/fixed. | ## Expected Behavior All references to `tdd_bug` and `tdd_bug_<N>` are replaced with `tdd_issue` and `tdd_issue_<N>` respectively. The tag validation logic, test infrastructure, documentation, and all existing tagged test files are updated consistently. Normal test execution is completely unaffected apart from the name change. ## Acceptance Criteria - [x] `features/environment.py`: `validate_tdd_tags()` and `should_invert_result()` updated to recognize `@tdd_issue` / `@tdd_issue_<N>` instead of `@tdd_bug` / `@tdd_bug_<N>` - [x] `robot/tdd_expected_fail_listener.py`: Listener v3 tag validation updated for `tdd_issue` / `tdd_issue_<N>` - [x] All existing `.feature` files with `@tdd_bug` or `@tdd_bug_<N>` tags renamed to `@tdd_issue` / `@tdd_issue_<N>` - [x] All existing `.robot` files with `tdd_bug` or `tdd_bug_<N>` tags renamed to `tdd_issue` / `tdd_issue_<N>` - [x] Tag validation test files updated: `features/testing/tdd_tag_validation.feature`, `robot/tdd_tag_validation.robot`, `robot/helper_tdd_tag_validation.py`, and all fixture files under `robot/fixtures/` - [x] `CONTRIBUTING.md` updated: "TDD Bug Test Tags" section renamed and all `tdd_bug` references changed to `tdd_issue`; "Bug Fix Workflow" section updated to reference `tdd_issue` tags - [x] `noxfile.py` updated: any `--include tdd_bug` or `--tag tdd_bug` filter references changed to `tdd_issue` - [x] `nox -s unit_tests` passes - [x] `nox -s integration_tests` passes - [x] `ruff check` and `ruff format` pass - [x] Coverage >= 97% via `nox -s coverage_report` ## Definition of Done This issue is complete when: - All subtasks below are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done. ## Subtasks - [x] Code: Update `validate_tdd_tags()` in `features/environment.py` — change all `tdd_bug` pattern matching to `tdd_issue` - [x] Code: Update `should_invert_result()` and `apply_tdd_inversion()` in `features/environment.py` — change tag references - [x] Code: Update `robot/tdd_expected_fail_listener.py` — change all `tdd_bug` pattern matching to `tdd_issue` in `start_test` and `end_test` hooks - [x] Code: Rename tags in all existing Behave `.feature` files (`features/tdd_*.feature`) - [x] Code: Rename tags in all existing Robot `.robot` files (`robot/tdd_*.robot`) - [x] Code: Update all tag validation test files and fixtures - [x] Code: Update `noxfile.py` filter/include references - [x] Docs: Update `CONTRIBUTING.md` — rename section, update all tag references and examples - [x] Quality: Verify `nox` passes (all default sessions including benchmark), fix any errors - [x] Quality: Verify coverage >= 97% via `nox -s coverage_report`

freemo added this to the v3.2.0 milestone

2026-03-16 02:35:20 +00:00

freemo added the

labels

2026-03-16 02:35:25 +00:00