Skip to content

Commit 5a27904

Browse files
anshooaroraanshooarora
committed
prepare release 5.0.0
1 parent afe6c1e commit 5a27904

File tree

5 files changed

+72
-52
lines changed

5 files changed

+72
-52
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ deploycmd.txt
3939
.idea/
4040

4141
#
42-
pom-nexus.xml
42+
pom.nexus.xml

‎Readme.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
## ExtentReports 5 [![Join the chat at https://gitter.im/anshooarora/extentreports](https://badges.gitter.im/anshooarora/extentreports.svg)](https://gitter.im/anshooarora/extentreports?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Maven Central](https://img.shields.io/maven-central/v/com.aventstack/extentreports.svg?maxAge=300)](http://search.maven.org/#search|ga|1|g:"com.aventstack") [![Build Status](https://travis-ci.com/extent-framework/extentreports-java.svg?branch=master)](https://travis-ci.com/extent-framework/extentreports-java) [![CodeFactor](https://www.codefactor.io/repository/github/extent-framework/extentreports-java/badge)](https://www.codefactor.io/repository/github/extent-framework/extentreports-java) [![codecov](https://codecov.io/gh/extent-framework/extentreports-java/branch/master/graph/badge.svg)](https://codecov.io/gh/extent-framework/extentreports-java)
22

3-
Version 5 is currently in development. Refer [wiki](https://github.com/extent-framework/extentreports-java/wiki) for SNAPSHOT installation instructions.
4-
53
### Documentation ###
64

75
* Documentation for ExtentReports 5.x is hosted on GitHub at [ExtentReports Wiki](https://github.com/extent-framework/extentreports-java/wiki).
@@ -15,8 +13,9 @@ A complete list of contributors since ExtentReports migrated from [@anshooarora/
1513

1614
### Upcoming ###
1715

18-
* See [v5.0.x milestones](https://github.com/extent-framework/extentreports-java/issues?q=is%3Aopen+is%3Aissue+milestone%3A5.0.x)
19-
* Want to see a feature added? You can raise one [here](https://github.com/extent-framework/extentreports-java/issues?q=is%3Aopen+is%3Aissue+milestone%3A5.0.x)
16+
* See [v5.0.x milestones](https://github.com/extent-framework/extentreports-java/milestone/2)
17+
* See [v5.1.x milestones](https://github.com/extent-framework/extentreports-java/milestone/3)
18+
* Want to see a feature added? Let me know [here](https://github.com/extent-framework/extentreports-java/issues?q=is%3Aopen+is%3Aissue+milestone%3A5.0.x)
2019

2120
### Versions ###
2221

‎pom.xml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@
55
<modelVersion>4.0.0</modelVersion>
66
<groupId>com.aventstack</groupId>
77
<artifactId>extentreports</artifactId>
8-
<version>5.0.0-SNAPSHOT</version>
8+
<version>5.0.0</version>
9+
910
<name>ExtentReports</name>
11+
<url>www.extentreports.com</url>
12+
<description>ExtentReports library</description>
1013

1114
<scm>
1215
<connection>scm:git:https://github.com/extent-framework/extentreports-java.git</connection>

‎src/main/java/com/aventstack/extentreports/ExtentReports.java‎

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -62,20 +62,7 @@ public class ExtentReports extends AbstractProcessor implements Writable, Analys
6262
* Attach a {@link ExtentObserver} reporter, allowing it to access all
6363
* started tests, nodes and logs
6464
*
65-
* <p>
66-
* Available reporter types are:
67-
* </p>
68-
*
69-
* <ul>
70-
* <li>ExtentHtmlReporter provided by artifactId
71-
* "extent-html-formatter"</li>
72-
* <li>ExtentEmailReporter (pro-only) provided by artifactId
73-
* "extent-email-formatter"</li>
74-
* <li>KlovReporter provided by artifactId "extent-klov-reporter"</li>
75-
* <li>ConsoleLogger</li>
76-
* </ul>
77-
*
78-
* @param reporter
65+
* @param observer
7966
* {@link ExtentObserver} reporter
8067
*/
8168
@SuppressWarnings("rawtypes")
@@ -467,10 +454,10 @@ public void setGherkinDialect(String language) throws UnsupportedEncodingExcepti
467454
}
468455

469456
/**
470-
* Returns an instance of {@link ReportStatusStats} with counts of tests
471-
* executed by their status (pass, fail, skip etc)
457+
* Returns an instance of {@link ReportStats} with counts of tests executed
458+
* by their status (pass, fail, skip etc)
472459
*
473-
* @return an instance of {@link ReportStatusStats}
460+
* @return an instance of {@link ReportStats}
474461
*/
475462
public ReportStats getStats() {
476463
return getReport().getStats();

‎src/main/java/com/aventstack/extentreports/ExtentTest.java‎

Lines changed: 60 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
import com.aventstack.extentreports.gherkin.model.IGherkinFormatterModel;
77
import com.aventstack.extentreports.markuputils.Markup;
8+
import com.aventstack.extentreports.markuputils.MarkupHelper;
89
import com.aventstack.extentreports.model.Author;
910
import com.aventstack.extentreports.model.Category;
1011
import com.aventstack.extentreports.model.Device;
@@ -285,10 +286,21 @@ public ExtentTest createNode(String name) {
285286
}
286287

287288
/**
289+
* Create a non-standard log with details. This is unlike the
290+
* <code>log</code> method, which creates a fixed table layout with the
291+
* following columns:
292+
*
293+
* <ul>
294+
* <li>Timestamp</li>
295+
* <li>Status</li>
296+
* <li>Details</li>
297+
* </ul>
288298
*
289299
* @param status
300+
* {@link Status}
290301
* @param details
291-
* @return
302+
* Text details of the step
303+
* @return an {@link ExtentTest} object
292304
*/
293305
public ExtentTest generateLog(Status status, String details) {
294306
Log log = Log.builder().status(status).details(details).build();
@@ -297,10 +309,24 @@ public ExtentTest generateLog(Status status, String details) {
297309
}
298310

299311
/**
312+
* Create a non-standard log with details. This is unlike the
313+
* <code>log</code> method, which creates a fixed table layout with the
314+
* following columns:
315+
*
316+
* <ul>
317+
* <li>Timestamp</li>
318+
* <li>Status</li>
319+
* <li>Details</li>
320+
* </ul>
321+
*
322+
* <code>generateLog</code> with {@link Markup} allows for a user-defined
323+
* log with any type of markup supported by {@link MarkupHelper}.
300324
*
301325
* @param status
326+
* {@link Status}
302327
* @param markup
303-
* @return
328+
* A {@link Markup} created by {@link MarkupHelper}
329+
* @return an {@link ExtentTest} object
304330
*/
305331
public ExtentTest generateLog(Status status, Markup markup) {
306332
return generateLog(status, markup.getMarkup());
@@ -322,6 +348,9 @@ public ExtentTest generateLog(Status status, Markup markup) {
322348
* {@link Status}
323349
* @param details
324350
* Details
351+
* @param t
352+
* A {@link Throwable} exception to be logged, enabling the
353+
* Exception view of certain HTML reporters
325354
* @param media
326355
* A {@link Media} object
327356
*
@@ -479,8 +508,8 @@ public ExtentTest log(Status status, Throwable t) {
479508
*
480509
* @param details
481510
* Details
482-
* @param provider
483-
* A {@link MediaEntityModelProvider} object
511+
* @param media
512+
* A {@link Media} object provided by {@link MediaEntityBuilder}
484513
*
485514
* @return An {@link ExtentTest} object
486515
*/
@@ -515,9 +544,10 @@ public ExtentTest info(String details) {
515544
* </pre>
516545
*
517546
* @param t
518-
* {@link Throwable}
519-
* @param provider
520-
* A {@link MediaEntityModelProvider} object
547+
* A {@link Throwable} exception to be logged, enabling the
548+
* Exception view of certain HTML reporters
549+
* @param media
550+
* A {@link Media} object provided by {@link MediaEntityBuilder}
521551
*
522552
* @return An {@link ExtentTest} object
523553
*/
@@ -530,7 +560,8 @@ public ExtentTest info(Throwable t, Media media) {
530560
* Logs an event with <code>Status.INFO</code> and exception
531561
*
532562
* @param t
533-
* {@link Throwable}
563+
* A {@link Throwable} exception to be logged, enabling the
564+
* Exception view of certain HTML reporters
534565
*
535566
* @return {@link ExtentTest} object
536567
*/
@@ -562,7 +593,7 @@ public ExtentTest info(Markup m) {
562593
* Logs an event with <code>Status.INFO</code> and {@link ScreenCapture}
563594
*
564595
* @param media
565-
* {@link Media}
596+
* A {@link Media} object provided by {@link MediaEntityBuilder}
566597
*
567598
* @return {@link ExtentTest} object
568599
*/
@@ -585,8 +616,8 @@ public ExtentTest info(Media media) {
585616
*
586617
* @param details
587618
* Details
588-
* @param provider
589-
* A {@link MediaEntityModelProvider} object
619+
* @param media
620+
* A {@link Media} object provided by {@link MediaEntityBuilder}
590621
*
591622
* @return An {@link ExtentTest} object
592623
*/
@@ -622,8 +653,8 @@ public ExtentTest pass(String details) {
622653
*
623654
* @param t
624655
* {@link Throwable}
625-
* @param provider
626-
* A {@link MediaEntityModelProvider} object
656+
* @param media
657+
* A {@link Media} object provided by {@link MediaEntityBuilder}
627658
*
628659
* @return An {@link ExtentTest} object
629660
*/
@@ -668,7 +699,7 @@ public ExtentTest pass(Markup m) {
668699
* Logs an event with <code>Status.PASS</code> and {@link ScreenCapture}
669700
*
670701
* @param media
671-
* {@link Media}
702+
* A {@link Media} object provided by {@link MediaEntityBuilder}
672703
*
673704
* @return {@link ExtentTest} object
674705
*/
@@ -683,8 +714,8 @@ public ExtentTest pass(Media media) {
683714
*
684715
* @param details
685716
* Details
686-
* @param provider
687-
* A {@link MediaEntityModelProvider} object
717+
* @param media
718+
* A {@link Media} object provided by {@link MediaEntityBuilder}
688719
*
689720
* @return An {@link ExtentTest} object
690721
*/
@@ -720,8 +751,8 @@ public ExtentTest fail(String details) {
720751
*
721752
* @param t
722753
* {@link Throwable}
723-
* @param provider
724-
* A {@link MediaEntityModelProvider} object
754+
* @param media
755+
* A {@link Media} object provided by {@link MediaEntityBuilder}
725756
*
726757
* @return An {@link ExtentTest} object
727758
*/
@@ -766,7 +797,7 @@ public ExtentTest fail(Markup m) {
766797
* Logs an event with <code>Status.FAIL</code> and {@link ScreenCapture}
767798
*
768799
* @param media
769-
* {@link Media}
800+
* A {@link Media} object provided by {@link MediaEntityBuilder}
770801
*
771802
* @return {@link ExtentTest} object
772803
*/
@@ -781,8 +812,8 @@ public ExtentTest fail(Media media) {
781812
*
782813
* @param details
783814
* Details
784-
* @param provider
785-
* A {@link MediaEntityModelProvider} object
815+
* @param media
816+
* A {@link Media} object provided by {@link MediaEntityBuilder}
786817
*
787818
* @return An {@link ExtentTest} object
788819
*/
@@ -818,8 +849,8 @@ public ExtentTest warning(String details) {
818849
*
819850
* @param t
820851
* {@link Throwable}
821-
* @param provider
822-
* A {@link MediaEntityModelProvider} object
852+
* @param media
853+
* A {@link Media} object provided by {@link MediaEntityBuilder}
823854
*
824855
* @return An {@link ExtentTest} object
825856
*/
@@ -864,7 +895,7 @@ public ExtentTest warning(Markup m) {
864895
* Logs an event with <code>Status.WARNING</code> and {@link ScreenCapture}
865896
*
866897
* @param media
867-
* {@link Media}
898+
* A {@link Media} object provided by {@link MediaEntityBuilder}
868899
*
869900
* @return {@link ExtentTest} object
870901
*/
@@ -877,8 +908,8 @@ public ExtentTest warning(Media media) {
877908
*
878909
* @param details
879910
* Details
880-
* @param provider
881-
* A {@link MediaEntityModelProvider} object
911+
* @param media
912+
* A {@link Media} object provided by {@link MediaEntityBuilder}
882913
*
883914
* @return An {@link ExtentTest} object
884915
*/
@@ -914,8 +945,8 @@ public ExtentTest skip(String details) {
914945
*
915946
* @param t
916947
* {@link Throwable}
917-
* @param provider
918-
* A {@link MediaEntityModelProvider} object
948+
* @param media
949+
* A {@link Media} object provided by {@link MediaEntityBuilder}
919950
*
920951
* @return An {@link ExtentTest} object
921952
*/
@@ -960,7 +991,7 @@ public ExtentTest skip(Markup m) {
960991
* Logs an event with <code>Status.SKIP</code> and {@link ScreenCapture}
961992
*
962993
* @param media
963-
* {@link Media}
994+
* A {@link Media} object provided by {@link MediaEntityBuilder}
964995
*
965996
* @return {@link ExtentTest} object
966997
*/

0 commit comments

Comments
 (0)