• Selenium Video Tutorials

Selenium - Reporting Tools

While we are running any automation tests using Selenium or any other tool, we will be required to view and analyze the results of the execution to conclude the number of tests which got executed, passed, failed, failure data, and so on in the form of reports.

Sometimes, the screenshots where the tests have undergone a failure are also captured in the reports. The test reports are also required to be shared with the project stakeholders on a periodic basis.

Reporting Tools Supported by Selenium

  • Allure Report

  • JUnit Report

  • TestNG Report

Allure Report

Allure can be used to create a detailed automation test report. It is an open source framework which can be integrated with Selenium tests and used for reporting purposes.

Prerequisites to Create Allure Report

  • Install Java(version above 8) in the system and check if it is present with the command: java -version. The java version installed will be visible if installation has been completed successfully.

  • Install maven in the system and check if it is present with the command: mvn -version. The maven version installed will be visible if installation has been completed successfully.

  • Install any IDE like Eclipse, IntelliJ, and so on.

Steps to Create Allure Report

Step 1 − We will need to create a maven project and add the proper dependencies to the pom.xml file for the below items −

Step 2 − Download the Allure in the system. For Mac, and Linux, run the command: brew install allure. This will work provided Homebrew is available in the system. For Windows, run the command: scoop install allure. This will work provided Scoop is available in the system. Check if Allure is present with the command: allure –version. The Allure version installed will be visible if installation has been completed successfully..

Step 3 − Create a TestNG test class and run it through the testng.xml.

Step 4 − Refresh the project and a new folder called the allure-results should get generated in the project structure.

Step 5 − Run the command: allure serve from the project folder location.

A sample Allure report is shown in the below image.

Selenium Reporting Tools 1

JUnit Report

Junit can be used to create a detailed automation test report. It is an open source framework which can be integrated with Selenium tests and used for reporting purposes.

Prerequisites to Create JUnit Report

  • Install Java(version above 8) in the system and check if it is present with the command: java -version. The java version installed will be visible if installation has been completed successfully.

  • Install maven in the system and check if it is present with the command: mvn -version. The maven version installed will be visible if installation has been completed successfully.

  • Install any IDE like Eclipse, IntelliJ, and so on.

Steps to Create JUnit Report

Step 1 − Create a maven project and add the proper dependencies to the pom.xml file for the below items −

Step 2 − Create a JUnit test class.

Step 3 − Run the test from the command line with the command: mvn clean test suite.

Step 4 − Refresh the project and a new folder called the site should get generated within the target folder in the project structure.

Step 5 − Right-click on the surefire-report.html and select the option to open in a browser.

A sample JUnit report is shown in the below image.

Selenium Reporting Tools 2

TestNG Report

A TestNG report is a html report generated automatically once a test case is built and run with the help of the TestNG. It is a unit testing framework which can be integrated with Selenium tests and used for reporting purposes.

In addition to this, the TestNG has a default reporting class called the Reporter which helps to log. This is useful in detecting the root cause of failure to debug the failed test.

Prerequisites to Create A TestNG Report

  • Install Java(version above 8) in the system and check if it is present with the command: java -version. The java version installed will be visible if installation has been completed successfully.

  • Install maven in the system and check if it is present with the command: mvn -version. The maven version installed will be visible if installation has been completed successfully.

  • Install any IDE like Eclipse, IntelliJ, and so on.

  • Add the TestNG dependencies from the link below: https://mvnrepository.com/artifact/org.testng/testng.

  • Add the Selenium Java dependencies from the below link : selenium-java

  • Save the pom.xml with all the dependencies and update the maven project

What are the Different Ways to Generate TestNG Reports?

The difference ways to generate a TestNG report are listed below −

  • emailable-report.html

  • index.html report

  • Reporter class report

emailable-report.html

The steps to create an emailable-report.html are listed below −

Step 1 − Create a TestNG test class and run it through the testng.xml.

Step 2 − Refresh the project and a new folder called the test-output should get generated in the project structure.

Step 3 − Right-click on the emailable-report.html and select the option to open in a browser.

A sample TestNG emailable-report.html is shown in the below image.

Selenium Reporting Tools 3

index.html report

The steps to create an index.html report are listed below −

Step 1 − Create a TestNG test class and run it through the testng.xml.

Step 2 − Refresh the project and a new folder called the test-output should get generated in the project structure.

Step 3 − Right-click on the index.html and select the option to open in a browser.

A sample TestNG index.html is shown in the below image.

Selenium Reporting Tools 4

Report Generated From Reporter Class

TestNG gives the Reporter class for logging purposes. It has four different ways to handle the information for logging −

  • Reporter.log( String str);

  • Reporter.log( String str, Boolean logToOut);

  • Reporter.log( String str, int l);

  • Reporter.log( String str, int l, Boolean logToOut);

The steps to generate log messages in report with Reporter class are listed below −

Step 1 − Create a TestNG test class with below log messages to be available in the reports and and run it through the testng.xml −

  • Moving to Registration Page.

  • Verified Login Page header.

  • Verified Register Page header.

Step 2 − Refresh the project and a new folder called the test-output should get generated in the project structure.

Step 3 − Right-click on the emailable-report.html and index.html to select the option to open in a browser.

A sample TestNG index.html and emailable-report.html along with log messages are shown in the below images.

index.html report

Selenium Reporting Tools 5

emailable-report.html

Selenium Reporting Tools 6

This concludes our comprehensive take on the tutorial on Selenium - Reporting Tools. We’ve started with describing different reporting tools supported by Selenium, such as Allure, JUnit, and TestNG reporting tools, prerequisites and steps to create TestNG, Allure, and JUnit reports along with Selenium. This equips you with in-depth knowledge of the reporting tools. It is wise to keep practicing what you’ve learned and exploring others relevant to Selenium to deepen your understanding and expand your horizons.

Advertisements