Skip to content

Commit 17de0cb

Browse files
Add UI Cov Test Gen Docs (#6195)
1 parent 643aeea commit 17de0cb

File tree

6 files changed

+29
-3
lines changed

6 files changed

+29
-3
lines changed

docs/ui-coverage/changelog.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ sidebar_position: 200
99

1010
# Changelog
1111

12+
## Week of 5/26/2025
13+
14+
- Launched AI-powered Test Generation in Cypress Cloud, to help you quickly add tests for the untested elements detected in UI Coverage reports, in a way that follows your existing practices and conventions. For more details, read [our blog post](https://www.cypress.io/blog/add-your-missing-tests-faster-with-test-generation-in-ui-coverage).
15+
1216
## Week of 4/1/2024
1317

1418
- **Shadow DOM and iFrame Support:** UI Coverage now supports Shadow DOM and iFrames for reporting on interactions. Both of these settings are off by default. Please contact your Cypress representative to opt in.

docs/ui-coverage/get-started/introduction.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_custom_props: { 'new_label': true }
1010

1111
# Identify testing gaps with UI Coverage
1212

13-
Easily track, monitor, and visualize the test coverage of your UI to prevent regressions by ensuring critical flows of your app are tested. Save CI resources by removing redundant tests and improve your team's productivity with a visual overview of UI coverage across every page and component.
13+
Easily track, monitor, and visualize the test coverage of your UI to prevent regressions by ensuring critical flows of your app are tested. Save CI resources by removing redundant tests and improve your team's productivity with a visual overview of UI coverage across every page and component and quickly close coverage with Test Generation.
1414

1515
<Btn
1616
label="Request trial ➜"
@@ -154,6 +154,7 @@ UI Coverage provides an interactive, visual map of test coverage for your applic
154154
- **DOM Snapshots**: Each tested and untested element is accompanied by a full-page, inspectable DOM snapshot, highlighting the exact location and context of element.
155155
- **Comprehensive Scoring**: A UI Coverage score is calculated by comparing tested elements to the total interactable elements in your application.
156156
- **Actionable Reports**: Sortable and filterable views provide insights into which areas are tested and which need improvement.
157+
- **Test Generation**: Quickly close coverage gaps with AI-powered test generation of untested elements and links surfaced in reports.
157158
- **Flexible configuration**: Customize and fine-tune UI Coverage to suit specific needs and scenarios like ignoring views or elements or grouping similar elements together.
158159
- **Configurable CI Integration**: The [Results API](/ui-coverage/results-api) allows you to programmatically control your CI pipeline's behavior based on UI Coverage scores.
159160

docs/ui-coverage/guides/address-coverage-gaps.mdx

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,27 @@ By prioritizing based on application context and business impact, you can addres
2424

2525
Once you've identified priority areas, create or update tests to cover these gaps.
2626

27+
### Generate Targeted Tests :sparkles:
28+
29+
UI Coverage provides AI-powered Test Generation from the Cypress Cloud, to help you quickly add tests for the untested elements detected in UI Coverage reports, in a way that follows your existing practices and conventions.
30+
31+
It works in just three steps:
32+
33+
1. Select an interactive element in your UI Coverage report, from any state of your application
34+
2. Click “Generate test code”
35+
3. Choose where to add the tests, from a list of specs that already render this element
36+
37+
<DocsImage
38+
src="/img/ui-coverage/guides/cypress-ui-coverage-generate-test.png"
39+
alt="Cypress Cloud screenshot cropped to show a generated test after clicking on the 'Generate Test' button for the '/commands/cookies' link."
40+
/>
41+
42+
Cypress will generate a new test that includes all the required setup steps to reach the element in your UI, and performs an appropriate interaction for the element type and surrounding context.
43+
44+
The generated code will use your existing patterns for navigating and interacting with your application, including custom commands you may have for locating elements or setting up state, and will recommend where followup assertions should be written after the actions are complete.
45+
46+
This test can be copied directly into your spec file at the suggested location, and from there you can continue writing the test locally.
47+
2748
### Write Targeted Tests
2849

2950
Focus on creating tests that interact with the specific untested elements or pages identified in the coverage reports. For example:
@@ -117,7 +138,7 @@ After updating your tests, record them again to Cypress Cloud and review the new
117138

118139
Use the [Results API](/ui-coverage/results-api) to integrate coverage checks into your CI/CD pipeline. Set thresholds for coverage scores to enforce quality standards. This ensures your application maintains high test coverage over time.
119140

120-
#Collaborate with Your Team
141+
### Collaborate with Your Team
121142

122143
Improving test coverage often requires collaboration. Share insights from the UI Coverage reports with your team to:
123144

docs/ui-coverage/guides/monitor-changes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The UI Coverage [Results API](/ui-coverage/results-api) allows you to programmat
1717

1818
## Deep dive on changes with Branch Review
1919

20-
[Branch Review for UI Coverage](/ui-coverage/core-concepts/compare-reports) allows you to compare any two runs in detail and review new untested elements and links, as well as all new interactive elements added to the application.
20+
[Branch Review for UI Coverage](/ui-coverage/guides/compare-reports) allows you to compare any two runs in detail and review new untested elements and links, as well as all new interactive elements added to the application.
2121

2222
## Spot trends overtime with cross-project analytics
2323

Loading

0 commit comments

Comments
 (0)