Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
grasshopper7 authored Sep 17, 2021
1 parent feea70c commit c2ecc21
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions extentreports-cucumber7-adapter/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This deals with generating **Extent reports for Cucumber-JVM version 7** using the ExtentReports Cucumber **Adapter Plugin**. For more details refer to this [article](http://ghchirp.tech/2098/). A sample usage of this adapter can be found [here](https://github.com/grasshopper7/cuke7-extent-adapter-report).
This deals with generating **Extent reports for Cucumber-JVM version 7** using the ExtentReports Cucumber **Adapter Plugin**. For more details refer to this [article](http://ghchirp.tech/3196/). A sample usage of this adapter can be found [here](https://github.com/grasshopper7/cuke7-extent-adapter-report).

To **build** from source use ```install -Dmaven.test.failure.ignore=true``` or ```install -Dmaven.test.skip=true```. This ignores intentional test failures from stopping the build.

**Dependency** - To work with the latest [ExtentReports version 5](https://github.com/extent-framework/extentreports-java/wiki), which includes support for latest **Spark, PDF *(New Feature, check 'Extent PDF Reporter' section below)*, Klov and Json** reporters, add the below dependency. The HTML and Logger reporters, among others, have been deprecated. For more details refer to the **POM Dependencies** section of the [article](http://ghchirp.tech/2098/).
**Dependency** - To work with the latest [ExtentReports version 5](https://github.com/extent-framework/extentreports-java/wiki), which includes support for latest **Spark, PDF *(New Feature, check 'Extent PDF Reporter' section below)*, Klov and Json** reporters, add the below dependency. The HTML and Logger reporters, among others, have been deprecated. For more details refer to the **POM Dependencies** section of the [article](http://ghchirp.tech/3196/).

```
<dependency>
Expand All @@ -12,7 +12,7 @@ To **build** from source use ```install -Dmaven.test.failure.ignore=true``` or `
</dependency>
```

**Report Attachments** - To add attachments, like screen images, two settings need to be added to the extent.properties. First property, named **screenshot.dir**, is the directory where the attachments are stored. Second is **screenshot.rel.path**, which is the relative path from the report file to the screenshot directory. For more details refer to the **Report Attachments** section of the [article](http://ghchirp.tech/2098/).
**Report Attachments** - To add attachments, like screen images, two settings need to be added to the extent.properties. First property, named **screenshot.dir**, is the directory where the attachments are stored. Second is **screenshot.rel.path**, which is the relative path from the report file to the screenshot directory. For more details refer to the **Report Attachments** section of the [article](http://ghchirp.tech/3196/).

```
extent.reporter.spark.out=test-output/SparkReport/Spark.html
Expand All @@ -34,7 +34,7 @@ extent.reporter.pdf.out=test output/PdfReport/ExtentPdf.pdf
```
The default color settings can be modified by using a YAML config file, named pdf-config.yaml in the project src/test/resource folder. The detailed documentation for this feature is available in this [article](http://ghchirp.tech/2224/).

**Customized Report Folder Name** *(NEW FEATURE)* - To enable report folder name with date and\or time details, two settings need to be added to the extent.properties. These are **basefolder.name** and **basefolder.datetimepattern**. These will be merged to create the base folder name, inside which the reports will be generated. The basefolder.datetimepattern value should be a **valid date time formatter pattern**. For more details refer to the **Customized Report Folder Name** section of the [article](http://ghchirp.tech/2098/).
**Customized Report Folder Name** *(NEW FEATURE)* - To enable report folder name with date and\or time details, two settings need to be added to the extent.properties. These are **basefolder.name** and **basefolder.datetimepattern**. These will be merged to create the base folder name, inside which the reports will be generated. The basefolder.datetimepattern value should be a **valid date time formatter pattern**. For more details refer to the **Customized Report Folder Name** section of the [article](http://ghchirp.tech/3196/).

```
extent.reporter.spark.out=test-output/SparkReport/
Expand All @@ -55,7 +55,7 @@ extent.reporter.spark.base64imagesrc=true
```
The Spark report file size will be **pretty large and there could be memory issues** if a substantial number of images are present. A generic thumbnail is created and on clicking the image is displayed.

**Environment or System Info Properties** *(NEW FEATURE)* - It is now possible to add environment or system info properties in the extent.properties or pass them in the maven command line. The key string should begin with the prefix - 'systeminfo.'. **Be careful of the dot at the end**. For more details refer to the **Environment or System Info Properties** section of the [article](http://ghchirp.tech/2098/).
**Environment or System Info Properties** *(NEW FEATURE)* - It is now possible to add environment or system info properties in the extent.properties or pass them in the maven command line. The key string should begin with the prefix - 'systeminfo.'. **Be careful of the dot at the end**. For more details refer to the **Environment or System Info Properties** section of the [article](http://ghchirp.tech/3196/).

```
systeminfo.os=windows
Expand Down

0 comments on commit c2ecc21

Please sign in to comment.