https://github.com/email2vimalraj/testngextentsreport
TestNG Extents Report
https://github.com/email2vimalraj/testngextentsreport
extent-report extentreports java test-runner testng testng-suite
Last synced: 6 months ago
JSON representation
TestNG Extents Report
- Host: GitHub
- URL: https://github.com/email2vimalraj/testngextentsreport
- Owner: email2vimalraj
- Created: 2016-10-12T04:05:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T14:34:16.000Z (over 2 years ago)
- Last Synced: 2025-03-28T00:07:15.558Z (7 months ago)
- Topics: extent-report, extentreports, java, test-runner, testng, testng-suite
- Language: Java
- Homepage: http://vimalselvam.com
- Size: 28.3 KB
- Stars: 38
- Watchers: 5
- Forks: 29
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
Awesome Lists containing this project
README
# TestNG Extents Report
The TestNG Extents report is a listener plugin which you can add it as a listener to your testng suite to generate a nice Extent report.
This listener uses the [ExtentReports v3.0.0](http://extentreports.relevantcodes.com/), a library developed by Anshoo Arora for reporting.
## Build Status
[](https://travis-ci.org/email2vimalraj/TestNGExtentsReport)
## Why another library?
You don't have to spend time in re-inventing on how to define what. Just add this as a listener or [service loader](http://testng.org/doc/documentation-main.html#listeners-service-loader). You will get the nice looking report generated at the end of your test execution.
Also, you will get the **emailable report** out-of-the box.
## Pre-requisite
- JDK 8+
- Extent Report v3.0.2+
## Usage
For maven, add the following as dependency:
```
com.vimalselvam
testng-extentsreport
1.3.1
```
Either in your **testng.xml**, add the listener:
```
```
or add as a [service loader](http://testng.org/doc/documentation-main.html#listeners-service-loader) (recommended).
By default, the report will be generated at TestNG's output directory. i.e., `test-output/report.html` and the emailable report at `test-output/emailable-report.html`.
In case you want to generate the report in a different location, make sure you pass the JVM argument called `reportPath` with the absolute directory path.
*For example*: I run my maven test as: `mvn clean test -DreportPath=output`. This will generate both the reports in the `${project directory}/output`.
### Adding custom reporter config
You can customize the report using a XML file. The XML file should follow as given here: [ExtentReports Configuration](http://extentreports.relevantcodes.com/java/#configuration).
The XML file should be referred as parameter in your suite xml. The parameter name should be `report.config`.
For instance, the parameter in the suite xml should be as follows:
```xml
```
The value should be the config XML file path.
### Adding System Information
In case you want to add system information, you will have to implement an interface `com.vimalselvam.testng.SystemInfo`. This interface contains a method with return type as `Map`.
Construct your system information with the map and return that map. After you have implemented, the custom implementation should be referred in your TestNG Suite xml as a parameter at the suite level.
For instance add the following parameter at your suite level in the TestNG suite xml:
```xml
```
The parameter name should be `system.info` and the value should be your fully qualified custom implementation class name.
For example my custom implementation look like this:
```java
package test;
import com.vimalselvam.testng.SystemInfo;
import org.testng.collections.Maps;
import java.util.Map;
/**
* This is a small utility class to prepare the system information
*/
public class MySystemInfo implements SystemInfo {
@Override
public Map getSystemInfo() {
Map systemInfo = Maps.newHashMap();
systemInfo.put("Test Env", "QA");
systemInfo.put("Browser", "firefox");
return systemInfo;
}
}
```
### Instance of the Listener
At any point in time, you can get the instance of the listener as `ExtentTestNgFormatter.getInstance()`
### Adding Screenshot
To add the screenshot, you have two options.
* If the screenshot can be added from the test method, then
```java
ExtentTestNgFormatter.getInstance().addScreenCaptureFromPath(filePath);
```
* If the screenshot can be added from the configuration method, then for example:
```java
@AfterMethod
public void afterMethod(ITestResult iTestResult) throws IOException {
// The ITestResult is a mandatory parameter
ExtentTestNgFormatter.getInstance().addScreenCaptureFromPath(iTestResult, filePath);
}
```
### Adding info log
If any case, you want to attach the `info` log on your test method, you simply call TestNg's `Reporter.log` method which will be added to your test log. For example:
```java
@Test
public void testMethod() {
Reporter.log("Custom log");
}
```
### Adding test runner output
To add the test runner output, simply call from anywhere:
```java
ExtentTestNgFormatter.getInstance().setTestRunnerOutput("My output");
```
### Adding new node
Sometimes you may have to add new node under your test. This situation arises when you have iteration in the test method and considering each iteration as a separate node in the report.
This could be solved by using `addNewNodeToTest()` method.
Refer [DemoTestClass](src/test/java/test/DemoTestClass.java) on how to add new nodes and in case of failure, how to fail the added node.
## Cucumber?
Refer my another library which generates the same report for the cucumber based BDD tests: [CucumberExtentReporter](https://github.com/email2vimalraj/CucumberExtentReporter)