Skip to content

Commit caf5d4d

Browse files
committed
Include reporting feature description in README
1 parent 5396ebc commit caf5d4d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,17 @@ class TemplateTest {
153153
}
154154
```
155155

156+
### Reporting
157+
As of version 6.3.0, Selenium-Jupiter provides built-in reporting capabilities through [ExtentReports]. This feature is enabled out of the box. All the tests executed with Selenium-Jupiter in the same suite will be reported (passed, skipped, failed) in a single HTML report per test suite execution. In addition, all the video recordings, both using `@DockerBrowser` and `@Watch`, will be gathered by Selenium-Jupiter and added to the resulting report (internally, the videos are encoded as Base64 in the HTML report), for example:
158+
159+
![Test report with embedded recording](https://bonigarcia.dev/selenium-jupiter/img/selenium-jupiter-report-example-1.png)
160+
161+
Finally, when a test fails, Selenium-Jupiter will gather two troubleshooting resources from the browser. First, it will try to take a screenshot of the browser (if it is still available). Second, it will try to gather the browser console logs, if possible. The screenshot(s) and the log(s) are automatically added for failed tests, for example:
162+
163+
![Test report with gathered screenshots and browser console logs](https://bonigarcia.dev/selenium-jupiter/img/selenium-jupiter-report-example-2.png)
164+
165+
You can find a complete HTML report example in this [link].
166+
156167
## Support
157168
Selenium-Jupiter is part of [OpenCollective], an online funding platform for open and transparent communities. You can support the project by contributing as a backer (i.e., a personal [donation] or [recurring contribution]) or as a [sponsor] (i.e., a recurring contribution by a company).
158169

@@ -186,3 +197,5 @@ Selenium-Jupiter (Copyright © 2017-2024) is a project created and maintaine
186197
[sponsor]: https://opencollective.com/selenium-jupiter/contribute/sponsor-8133/checkout
187198
[Boni Garcia]: https://bonigarcia.dev/
188199
[Apache 2.0 License]: https://www.apache.org/licenses/LICENSE-2.0
200+
[ExtentReports]: https://extentreports.com/
201+
[link]: https://bonigarcia.dev/selenium-jupiter/reports/selenium-jupiter-20250902-150317.html

0 commit comments

Comments
 (0)