Skip to content

[Feature]: Update test.describe location in HTML reports #30698

Open
@loop-automation

Description

@loop-automation

🚀 Feature Request

Summary:
Improve the readability and context provision in HTML reports by modifying the display behavior of test.describe.

Current Behavior:
Currently, test.describe is appended before each test name in the file that uses test.describe. This implementation can become repetitive and somewhat limits the ability to provide extensive context due to character constraints.

Proposed Change:
Update the test.describe display so that it appears within the grey box of the test file name as a paragraph (p). This adjustment aims to enhance the readability of the HTML report and, more importantly, allows for a significantly higher character limit. This change would enable users to provide more detailed context for each test file, aiding better understanding and maintenance of test suites.

Rationale:
This enhancement would make the test.describe display less repetitive and more centralized, offering a cleaner and more informative layout in the HTML reports. Increasing the character limit for descriptions would allow for more comprehensive explanations, which is crucial for complex test suites or when tests are reviewed by multiple team members or stakeholders.

Expected Benefits:

Improved readability and aesthetics of HTML reports.
Enhanced ability to provide detailed context for test files.
Reduction in redundancy and clutter associated with multiple, repeated descriptions.

Screenshot 2024-05-07 at 3 03 08 PM

Similar behavior to test.info below:

Screenshot 2024-05-07 at 3 06 17 PM

Example

I would like to be able to use test.describe like below but currently the display limits the value of it.

test.describe("This file includes all tests for the Cyber security report section "Alerts", pages 6-9", () => {
})

Motivation

Expected Benefits:

Improved readability and aesthetics of HTML reports.
Enhanced ability to provide detailed context for test files.
Reduction in redundancy and clutter associated with multiple, repeated descriptions.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions