TEST-INFRA: [test-architecture] Establish a clear naming convention for helper files #1965

Open
opened 2026-04-03 00:25:06 +00:00 by freemo · 2 comments
Owner

Metadata

  • Branch: chore/test-arch-helper-file-naming-convention
  • Commit Message: chore(tests): establish and apply naming convention for robot/ helper files
  • Milestone: v3.2.0
  • Parent Epic: #739

Background and Context

There are a number of helper files in the robot/ directory, but there is no clear naming convention for them. This can make it difficult to understand the purpose of each helper file and increases cognitive overhead when navigating the test suite.

Consistent naming conventions are a key part of maintainable test architecture. Without a clear convention, contributors may create new helper files with inconsistent names, making the directory harder to navigate over time.

Expected Behavior

All helper files in the robot/ directory should follow a clear, documented naming convention (e.g., helper_<feature_name>.py). The convention should be documented so that contributors know how to name new helper files when they are created.

Acceptance Criteria

  • A naming convention for helper files in robot/ has been established and documented (e.g., helper_<feature_name>.py)
  • All existing helper files in the robot/ directory have been renamed to follow the new convention
  • All Robot Framework tests that reference the renamed helper files have been updated accordingly
  • The Robot Framework test suite runs successfully after the renaming (nox -s integration_tests or equivalent)
  • Coverage remains >= 97%

Supporting Information

  • Related test-architecture issues: #1902, #1903, #1872, #1864
  • CONTRIBUTING.md File Organization guidelines apply to test helper files as well as production code

Subtasks

  • Audit all helper files in the robot/ directory and document their current names
  • Establish a clear naming convention (e.g., helper_<feature_name>.py) and document it in CONTRIBUTING.md
  • Rename all existing helper files in robot/ to follow the new naming convention
  • Update all Robot Framework test files that import or reference the renamed helper files
  • Run the Robot Framework test suite to confirm no regressions (nox -s integration_tests or equivalent)
  • Run full nox suite and confirm all sessions pass
  • Verify coverage >= 97% via nox -s coverage_report

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A clear naming convention for helper files has been established and documented in CONTRIBUTING.md.
  • All existing helper files in the robot/ directory have been renamed to follow the new naming convention.
  • All Robot Framework tests that reference the renamed helper files have been updated.
  • The Robot Framework test suite runs successfully after the helper files have been renamed.
  • All nox stages pass.
  • Coverage >= 97%.
  • 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.

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

## Metadata - **Branch**: `chore/test-arch-helper-file-naming-convention` - **Commit Message**: `chore(tests): establish and apply naming convention for robot/ helper files` - **Milestone**: v3.2.0 - **Parent Epic**: #739 ## Background and Context There are a number of helper files in the `robot/` directory, but there is no clear naming convention for them. This can make it difficult to understand the purpose of each helper file and increases cognitive overhead when navigating the test suite. Consistent naming conventions are a key part of maintainable test architecture. Without a clear convention, contributors may create new helper files with inconsistent names, making the directory harder to navigate over time. ## Expected Behavior All helper files in the `robot/` directory should follow a clear, documented naming convention (e.g., `helper_<feature_name>.py`). The convention should be documented so that contributors know how to name new helper files when they are created. ## Acceptance Criteria - [ ] A naming convention for helper files in `robot/` has been established and documented (e.g., `helper_<feature_name>.py`) - [ ] All existing helper files in the `robot/` directory have been renamed to follow the new convention - [ ] All Robot Framework tests that reference the renamed helper files have been updated accordingly - [ ] The Robot Framework test suite runs successfully after the renaming (`nox -s integration_tests` or equivalent) - [ ] Coverage remains >= 97% ## Supporting Information - Related test-architecture issues: #1902, #1903, #1872, #1864 - `CONTRIBUTING.md` File Organization guidelines apply to test helper files as well as production code ## Subtasks - [ ] Audit all helper files in the `robot/` directory and document their current names - [ ] Establish a clear naming convention (e.g., `helper_<feature_name>.py`) and document it in `CONTRIBUTING.md` - [ ] Rename all existing helper files in `robot/` to follow the new naming convention - [ ] Update all Robot Framework test files that import or reference the renamed helper files - [ ] Run the Robot Framework test suite to confirm no regressions (`nox -s integration_tests` or equivalent) - [ ] Run full `nox` suite and confirm all sessions pass - [ ] Verify coverage >= 97% via `nox -s coverage_report` ## Definition of Done This issue is complete when: - [ ] All subtasks above are completed and checked off. - [ ] A clear naming convention for helper files has been established and documented in `CONTRIBUTING.md`. - [ ] All existing helper files in the `robot/` directory have been renamed to follow the new naming convention. - [ ] All Robot Framework tests that reference the renamed helper files have been updated. - [ ] The Robot Framework test suite runs successfully after the helper files have been renamed. - [ ] All nox stages pass. - [ ] Coverage >= 97%. - [ ] 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. --- **Automated by CleverAgents Bot** Supervisor: Test Infrastructure | Agent: ca-new-issue-creator
freemo added this to the v3.2.0 milestone 2026-04-03 00:25:18 +00:00
Author
Owner

Issue triaged by project owner:

  • State: Verified
  • MoSCoW: MoSCoW/Could Have — CI/test infrastructure improvement.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: ca-project-owner

Issue triaged by project owner: - **State**: Verified - **MoSCoW**: MoSCoW/Could Have — CI/test infrastructure improvement. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: ca-project-owner
freemo removed this from the v3.2.0 milestone 2026-04-06 22:31:01 +00:00
Author
Owner

This issue has been moved to the backlog as part of an aggressive grooming of the v3.2.0 milestone. It has been deemed non-critical for the minimal viability of the milestone and will be addressed in a future release.

This issue has been moved to the backlog as part of an aggressive grooming of the v3.2.0 milestone. It has been deemed non-critical for the minimal viability of the milestone and will be addressed in a future release.
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#1965
No description provided.