TEST-INFRA: [test-architecture] Generic shared step files should be more purpose-driven #5912

Open
opened 2026-04-09 11:43:52 +00:00 by HAL9000 · 1 comment
Owner

Metadata

  • Branch: refactor/test-arch-purpose-driven-shared-step-files
  • Commit Message: refactor(tests): rename generic shared step files to be more purpose-driven
  • Milestone: (none — backlog, see note below)
  • Parent Epic: #5407

Background and context

The CONTRIBUTING.md file states that 'Shared steps used across multiple features belong in clearly named, reusable files; prefer updating an existing shared file when it already fits the purpose before creating another one.'

Current behavior

There are several shared step files in features/steps/ that have very generic names, such as service_steps.py and domain_models_steps.py. This makes it difficult to understand the purpose of these files and to find the step definitions that are needed.

Duplicate Check

  • Search queries: 'shared steps', 'purpose-driven'
  • Results: 0
  • None of the existing issues cover this specific finding.

Expected behavior

Shared step files should have names that clearly describe their purpose. For example, instead of service_steps.py, a better name might be user_authentication_steps.py if the file contains steps related to user authentication.

Subtasks

  • Identify all shared step files with generic names.
  • Rename these files to be more purpose-driven.
  • Update the import statements in the feature files to reflect the new file names.

Definition of Done

This issue is complete when:

  • All subtasks above 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.
  • All nox stages pass.
  • Coverage >= 97%.

Backlog note: This issue was discovered during autonomous operation
on milestone v3.8.0. It does not block milestone completion and has been
placed in the backlog for human review and future milestone assignment.


Automated by CleverAgents Bot
Supervisor: Test Infrastructure | Agent: new-issue-creator

## Metadata - **Branch**: `refactor/test-arch-purpose-driven-shared-step-files` - **Commit Message**: `refactor(tests): rename generic shared step files to be more purpose-driven` - **Milestone**: *(none — backlog, see note below)* - **Parent Epic**: #5407 ## Background and context The `CONTRIBUTING.md` file states that 'Shared steps used across multiple features belong in clearly named, reusable files; prefer updating an existing shared file when it already fits the purpose before creating another one.' ## Current behavior There are several shared step files in `features/steps/` that have very generic names, such as `service_steps.py` and `domain_models_steps.py`. This makes it difficult to understand the purpose of these files and to find the step definitions that are needed. ### Duplicate Check - Search queries: 'shared steps', 'purpose-driven' - Results: 0 - None of the existing issues cover this specific finding. ## Expected behavior Shared step files should have names that clearly describe their purpose. For example, instead of `service_steps.py`, a better name might be `user_authentication_steps.py` if the file contains steps related to user authentication. ## Subtasks - [ ] Identify all shared step files with generic names. - [ ] Rename these files to be more purpose-driven. - [ ] Update the `import` statements in the feature files to reflect the new file names. ## Definition of Done This issue is complete when: - All subtasks above 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. - All nox stages pass. - Coverage >= 97%. > **Backlog note:** This issue was discovered during autonomous operation > on milestone v3.8.0. It does not block milestone completion and has been > placed in the backlog for human review and future milestone assignment. --- **Automated by CleverAgents Bot** Supervisor: Test Infrastructure | Agent: new-issue-creator
HAL9000 added this to the v3.8.0 milestone 2026-04-09 12:21:11 +00:00
Author
Owner

Label compliance fix applied:

  • Added missing labels and/or milestone to bring issue into compliance with CONTRIBUTING.md

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: backlog-groomer

Label compliance fix applied: - Added missing labels and/or milestone to bring issue into compliance with CONTRIBUTING.md --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: backlog-groomer
HAL9000 removed this from the v3.8.0 milestone 2026-04-09 13:59:28 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
cleveragents/cleveragents-core#5912
No description provided.