Add a link to Test Report documentation when no test reports are uploaded
Problem to solve
If I don't already export/upload test reports in a junit format as part of my pipeline I see an empty test report tab on the pipeline page.
As a developer who has tests in their pipeline, I want to get started quickly with the Test summary and test report features, so that I can quickly diagnose test failures in the Gitlab UI.
Intended users
- Sasha (Software Developer) - who sees 0 reported on the test tab but knows tests are output from their pipeline.
- Devon (DevOps Engineer) - who gets reports about this 0 showing up but isn't sure how to get the team's test reports into the gitlab UI.
User experience goal
The user should be able to get to the JUnit report documentation from an empty test tab with 1 click.
Proposal
Add a link to the JUnit report documentation to the message about 0 tests.
Something like "There are no tests to show. Learn about how to upload test reports to see how tests are changing and the full report of tests run in a pipeline. Read the JUnit Report Documentation."
Technical proposal
- Add the documentation link to the empty state section of the test reports component. We'll have to conditionally show this link if there is no test report, but show the current message if we just have an empty report.
- Add a data attribute for saying whether the pipeline has a test report in the HAML file
- We should probably also not fetch the test report summary if we already know the pipeline doesn't have a test report. We can do that by not running
fetchSummary
in the test reports component. - We'll need to update the test reports component spec file to test this scenario.
Further details
This is a simplified version of the messaging on the DAG pipeline that is being used to drive awareness of that feature.
Permissions and Security
Documentation
Availability & Testing
What does success look like, and how can we measure that?
Acceptance Criteria
- If no reports are uploaded the messaging appears.
- If an empty report is uploaded do what is done today.
- If a report is uploaded with data to parse do what is done today.
Success Measures
- We will review page views of the JUnit docs page 90 days after release of this feature and expect a 10% increase in page views.
What is the type of buyer?
This is for the Individual Developer who can setup their own pipeline OR can influence the decision to output test data in the JUnit format.
Is this a cross-stage feature?
No.