Generate test reports

When running your API tests, you may want to preserve a trace of their results. That's why Restlet provides a few ways to generate printable test reports - in HTML or PDF.

From the Google Chrome Extension

When you have run a project/service/scenario in Restlet Client, you just need to open it and click on the button Print.

Print button

If you don't want to print it, you can just export it in PDF format by changing the printer.

Save as pdf

The generated report will look like this:

Extension report

From the Command Line Interface

You can generate HTML reports directly from the command line using surefire with the following commands:

# Runs the API tests
mvn clean test

# Creates a nicely formatted Surefire Test Report in HTML format
# without running the tests as they have been run already
mvn surefire-report:report-only

# The Site Plugin is used to generate a site for the project. The generated
# site also includes the project's reports that were configured in the POM
mvn site -DgenerateReports=false

The generated output displays a summary of all the test results at the top followed by a detailed view.

Surefire summary

Surefire details

From Continuous Integration platforms

Our CLI tool generates test reports in XML, in the standard JUnit / Surefire format. This means any CI tool (Bamboo, TeamCity, etc.) or quality reporting tool (SonarQube, Allure, etc.) that is compatible with this standard format can produce reports for your Restlet Client API tests.

Here is what test reports will look like in Jenkins, but other CI platforms should have similar capabilities.

Detailed view on a particular build:

Jenkins detailed

History of test results:

Jenkins overview

History of test execution duration:

Jenkins overview