Version 5 of ExtentReports Java now available

The version 5.0 release of ExtentReports is here! This is a major release which has undergone a complete rewrite of the internal API - originally written to target JDK5. The update also spans the plugin system and Klov, which has also been written from the ground up replacing AngularJS with Angular 9/Ivy. 

How to update to version 5

If you are using version 4, upgrading to 5.0 should be pretty straight-forward. Be mindful of the breaking changes here. Note: HTML and Logger reporters are no longer available. SparkReporter has been the default reporter since 4.1.5 and has been updated with a ton of additional features for the latest version.

If you are upgrading from version 3 or lower, you will have to go through the usage instructions as there were significant API changes in version 4.

Notable changes

It won’t be possible to list all the changes and improvements here, so I will list only the note-worthy. To view the complete details of changes, visit this link or view the list of closed issues.

Custom logs

Along with the default log methods, you can use custom markup to create your own logging structure. It is now possible to create tables with custom headers, pass objects directly to be converted into markup etc. Note also that the default Status, Timestamp and Details columns aren’t used.

public class MyCustomLog {
  private List<Object> names = Arrays.asList("Anshoo", "Extent", "Klov");
  private Object[] favStack = new Object[]{"Java", "C#", "Angular"};
  @MarkupIgnore
  private List<Object> ignored = Arrays.asList("Anshoo/Ignore", "Extent/Ignore", "Klov/Ignore");
  private Map<Object, Object> items = new HashMap<Object, Object>() {
    {
      put("Item1", "Value1");
      put("Item2", "Value2");
      put("Item3", "Value3");
    }
  };
}
extent.createTest("GeneratedLog")
  .generateLog(Status.FAIL, MarkupHelper.toTable(new MyCustomLog(), "table-sm"));

Filters to create separate reports targeting 1 or more Status

It is now possible to create separate reports for each status (or a group of them). With this feature, you can create a report for errors only, and other with everything included. 

// will only contain failures
ExtentSparkReporter sparkFail = new ExtentSparkReporter("fail.html")
  .with()
    .statusFilter().as(new Status[] {Status.FAIL})
  .<ExtentSparkReporter>build();
// will contain all tests
ExtentSparkReporter sparkAll = new ExtentSparkReporter("all.html");

extent.attachReporter(sparkFail, sparkAll);

Choose your views, and order them too

Choose the views you want included in your report, and also customize their order of appearance. For instance, if you want the Dashboard view to be the primary view, followed by Tests without including Tags or Exceptions etc, you can:

ExtentSparkReporter spark = new ExtentSparkReporter("spark.html")
  .with()
    .viewOrder().as(new ViewName[] { ViewName.DASHBOARD, ViewName.TEST })
  .<ExtentSparkReporter>build();

Merge multiple builds into one

This much-awaited feature is now available. It uses a JSON representation of the run session to create the internal entities and combine results from multiple build sessions into one. The method createDomainFromJsonArchive is responsible for using the JSON extract to recreate entities.

ExtentSparkReporter spark = new ExtentSparkReporter("spark.html");
JsonFormatter json = new JsonFormatter("extent.json");
ExtentReports extent = new ExtentReports();
extent.createDomainFromJsonArchive("extent.json");
extent.attachReporter(json, spark);

Improved Markup system

The markup system has been completely overhauled to provide improved flexibility to display test components in a meaningful way. More info here.

Klov

The brand new version of Klov, also written from the ground-up is now available. You can view demo for the Community version here. This upgrade also fixes all the issues in the earlier Klov versions (0.1 and 0.2 series).

Usage with ExtentReports remains the same, although the standard distribution no longer comes prepackaged with the KlovReporter - which is now a standalone dependency. More details here.

Thank you to the community

ExtentReports project started 5 years ago and with your support, contributions and willingness to make it part your work, you have given it an opportunity to grow tremendously. Thank you.

I would also like to personally thank Virender Singh, VimalRaj Selvam and Mounish for helping with the project with their tremendous contributions to the API and plugins.

If you have feedback on this release, please file an issue here.