TEST-INFRA: [test-architecture] Review and document Robot Framework best practices #7849

Open
opened 2026-04-12 05:31:10 +00:00 by HAL9000 · 3 comments
Owner

Metadata

  • Branch: test/review-robot-framework-best-practices
  • Commit Message: test(robot): review and document Robot Framework best practices
  • Milestone: (none — backlog)
  • Parent Epic: #5407

Background and Context

The robot/ directory contains Robot Framework integration tests that have grown organically over time. Without a deliberate review against established best practices, the test suite may accumulate structural debt: poorly organized suites, duplicated keywords, missing resource files, and no consistent tagging strategy. This makes the suite harder to maintain, extend, and filter during CI runs.

Expected Behavior

The Robot Framework test suite in robot/ follows established best practices, is well-organized into logical suites, shares keywords and variables via resource files, uses data-driven patterns where appropriate, and is consistently tagged for filtering.

Acceptance Criteria

  • All Robot Framework test files in robot/ are reviewed against the official RF best practices guide
  • Test cases are organized into logical suites with clear naming conventions
  • Shared keywords and variables are extracted into resource files (.resource)
  • Data-driven tests are implemented using Test Template / FOR loops where repetition exists
  • All test cases carry meaningful tags enabling filtering by feature, severity, or milestone
  • A best-practices document (or inline comments) is produced summarising the conventions adopted
  • nox passes with coverage ≥ 97%

Supporting Information

  • Sibling issue: #7845 (BDD/Gherkin best practices review — same [test-architecture] category)
  • Parent Epic: #5407 (Testing Infrastructure Improvements)
  • Duplicate check: search queries "Robot Framework", "pabot" — 0 existing issues cover this topic

Subtasks

  • Audit all .robot and .resource files in robot/ against RF best practices
  • Reorganize test cases into logical suites where needed
  • Extract shared keywords and variables into dedicated .resource files
  • Identify and convert repetitive tests to data-driven format (Test Template)
  • Add/normalize tags across all test cases
  • Write or update a robot/README.md documenting the adopted conventions
  • Run nox (all default sessions), fix any errors
  • 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 Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly (test(robot): review and document Robot Framework best practices), 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 (test/review-robot-framework-best-practices).
  • 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.2.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**: `test/review-robot-framework-best-practices` - **Commit Message**: `test(robot): review and document Robot Framework best practices` - **Milestone**: *(none — backlog)* - **Parent Epic**: #5407 ## Background and Context The `robot/` directory contains Robot Framework integration tests that have grown organically over time. Without a deliberate review against established best practices, the test suite may accumulate structural debt: poorly organized suites, duplicated keywords, missing resource files, and no consistent tagging strategy. This makes the suite harder to maintain, extend, and filter during CI runs. ## Expected Behavior The Robot Framework test suite in `robot/` follows established best practices, is well-organized into logical suites, shares keywords and variables via resource files, uses data-driven patterns where appropriate, and is consistently tagged for filtering. ## Acceptance Criteria - [ ] All Robot Framework test files in `robot/` are reviewed against the official RF best practices guide - [ ] Test cases are organized into logical suites with clear naming conventions - [ ] Shared keywords and variables are extracted into resource files (`.resource`) - [ ] Data-driven tests are implemented using `Test Template` / `FOR` loops where repetition exists - [ ] All test cases carry meaningful tags enabling filtering by feature, severity, or milestone - [ ] A best-practices document (or inline comments) is produced summarising the conventions adopted - [ ] `nox` passes with coverage ≥ 97% ## Supporting Information - Sibling issue: #7845 (BDD/Gherkin best practices review — same `[test-architecture]` category) - Parent Epic: #5407 (Testing Infrastructure Improvements) - Duplicate check: search queries "Robot Framework", "pabot" — 0 existing issues cover this topic ## Subtasks - [ ] Audit all `.robot` and `.resource` files in `robot/` against RF best practices - [ ] Reorganize test cases into logical suites where needed - [ ] Extract shared keywords and variables into dedicated `.resource` files - [ ] Identify and convert repetitive tests to data-driven format (`Test Template`) - [ ] Add/normalize tags across all test cases - [ ] Write or update a `robot/README.md` documenting the adopted conventions - [ ] Run `nox` (all default sessions), fix any errors - [ ] 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 Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly (`test(robot): review and document Robot Framework best practices`), 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 (`test/review-robot-framework-best-practices`). - 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.2.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
Author
Owner

Verified — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low.


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

✅ **Verified** — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
Author
Owner

Verified — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low.


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

✅ **Verified** — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
Author
Owner

Verified — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low.


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

✅ **Verified** — Test infrastructure task: Robot Framework best practices documentation. MoSCoW: Could-have. Priority: Low. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
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#7849
No description provided.