3.9.0

CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Back to [Readme](README.md).
 
+## [3.9.0] - 2024-11-05
+
+### Fixed
+
+* Plugin doesn't support parallel compilation (#358)
+* Merging of reports with same test scenario doesn't work when output is different (#359)
+* Dark mode flickering on navigation
+* Wrong dark mode toggle caption when starting with dark mode active
+* Fixed all Javadoc warnings
+
+### Changed
+
+* Shortened dark/light mode button caption
+* Allow report generation even if `<customParametersFile>` defined file does not exist (#357)
+* Updated JUnit Jupiter, Mockito, JavaDoc and GPG plugins
+
 ## [3.8.2] - 2024-10-30
 
 ### Added
@@ -924,6 +940,8 @@ the core component is now the reporting engine that is the base for other forms
 
 Initial project version on GitHub and Maven Central.
 
+[3.9.0]: https://github.com/trivago/cluecumber-report-plugin/tree/v3.9.0
+
 [3.8.2]: https://github.com/trivago/cluecumber-report-plugin/tree/v3.8.2
 
 [3.8.1]: https://github.com/trivago/cluecumber-report-plugin/tree/v3.8.1

core/src/main/java/com/trivago/cluecumber/core/CluecumberCore.java

@@ -36,7 +36,7 @@ public class CluecumberCore {
      * @param builder The builder instance.
      * @throws CluecumberException Thrown in case of any error.
      */
-    private CluecumberCore(Builder builder) throws CluecumberException {
+    private CluecumberCore(final Builder builder) throws CluecumberException {
         cluecumberEngine = DaggerCluecumberCoreGraph.create().getCluecumberEngine();
         cluecumberEngine.setCustomCssFile(builder.customCssFile);
         cluecumberEngine.setCustomFavicon(builder.customFavicon);
@@ -73,7 +73,7 @@ public void generateReports(final String jsonDirectory, final String reportDirec
     }
 
     /**
-     * The builder class for a new {@link CluecumberCore} instance.
+     * The builder class for the {@link CluecumberCore}.
      */
     public static class Builder {
         private String customCssFile;
@@ -98,6 +98,13 @@ public static class Builder {
         private boolean failScenariosOnPendingOrUndefinedSteps;
         private boolean expandOutputs;
 
+        /**
+         * Default constructor for the Builder class.
+         */
+        public Builder() {
+            // Default constructor
+        }
+
         /**
          * Finalize the {@link CluecumberCore} builder.
          *
@@ -141,7 +148,6 @@ public Builder setCustomNavigationLinks(final LinkedHashMap<String, String> cust
             return this;
         }
 
-
         /**
          * Custom parameters to display at the top of the test report.
          *
@@ -153,7 +159,6 @@ public Builder setCustomParameters(final LinkedHashMap<String, String> customPar
             return this;
         }
 
-
         /**
          * Where to display custom parameters.
          *

engine/pom.xml

@@ -29,7 +29,6 @@
     <properties>
         <maven.compiler.release>11</maven.compiler.release>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
         <tinylog-impl.version>2.8.0-M1</tinylog-impl.version>
         <freemarker.version>2.3.33</freemarker.version>
         <gson-fire.version>1.9.0</gson-fire.version>
@@ -38,7 +37,6 @@
         <property-aggregator.version>1.5.0</property-aggregator.version>
         <properties-maven-plugin.version>1.1.0</properties-maven-plugin.version>
         <openpojo.version>0.9.1</openpojo.version>
-        <maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>
     </properties>
 
     <dependencies>
@@ -95,7 +93,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>${maven-compiler-plugin.version}</version>
                 <configuration>
                     <annotationProcessorPaths>
                         <path>
@@ -112,7 +109,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
-                <version>${maven-jar-plugin.version}</version>
                 <configuration>
                     <archive>
                         <manifest>

engine/src/main/java/com/trivago/cluecumber/engine/CluecumberEngine.java

@@ -166,7 +166,11 @@ public void setCustomParameters(final LinkedHashMap<String, String> customParame
      * @throws CluecumberException Thrown on any error.
      */
     public void setCustomParametersFile(final String customParametersFile) throws CluecumberException {
-        propertyManager.setCustomParametersFile(customParametersFile);
+        try {
+            propertyManager.setCustomParametersFile(customParametersFile);
+        } catch (MissingFileException e) {
+            logger.warn("Could not read custom parameters file: " + e.getMessage());
+        }
     }
 
     /**
@@ -284,6 +288,12 @@ public void setCustomCssFile(final String customCss) throws MissingFileException
         propertyManager.setCustomCssFile(customCss);
     }
 
+    /**
+     * Custom favicon file to use for the report.
+     *
+     * @param customFavicon The path to a favicon file.
+     * @throws MissingFileException Thrown if the specified file does not exist.
+     */
     public void setCustomFavicon(final String customFavicon) throws MissingFileException {
         if (customFavicon == null) {
             return;

engine/src/main/java/com/trivago/cluecumber/engine/constants/Navigation.java

@@ -25,6 +25,13 @@
  * Report navigation.
  */
 public class Navigation {
+    /**
+     * Default constructor.
+     */
+    public Navigation() {
+        // Default constructor
+    }
+
     /**
      * The list of internal report navigation links.
      */

engine/src/main/java/com/trivago/cluecumber/engine/constants/Settings.java

@@ -20,6 +20,13 @@
  */
 public class Settings {
 
+    /**
+     * Default constructor.
+     */
+    public Settings() {
+        // Default constructor
+    }
+
     /**
      * The name of the Cluecumber plugin.
      */

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Argument.java

@@ -22,6 +22,13 @@ public class Argument {
     private String val;
     private int offset;
 
+    /**
+     * Default constructor.
+     */
+    public Argument() {
+        // Default constructor
+    }
+
     /**
      * Gets the value of the argument.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/DocString.java

@@ -24,6 +24,13 @@ public class DocString {
     private int line;
     private String value = "";
 
+    /**
+     * Default constructor.
+     */
+    public DocString() {
+        // Default constructor
+    }
+
     /**
      * Get the line number.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Element.java

@@ -52,6 +52,13 @@ public class Element {
     private transient int scenarioIndex = 0;
     private transient boolean failOnPendingOrUndefined = false;
 
+    /**
+     * Default constructor.
+     */
+    public Element() {
+        // Default constructor
+    }
+
     /**
      * Get the list of tags of this scenario.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Embedding.java

@@ -36,6 +36,13 @@ public class Embedding {
 
     private transient String filename = "";
 
+    /**
+     * Default constructor.
+     */
+    public Embedding() {
+        // Default constructor
+    }
+
     /**
      * Get the raw attachment data.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Match.java

@@ -22,9 +22,17 @@
  * The match of the {@link ResultMatch}.
  */
 public class Match {
+
     private String location = "";
     private List<Argument> arguments = new ArrayList<>();
 
+    /**
+     * Default constructor.
+     */
+    public Match() {
+        // Default constructor
+    }
+
     /**
      * Get the class and method where this step is defined.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Report.java

@@ -32,6 +32,13 @@ public class Report implements Cloneable {
 
     private transient int featureIndex = -1;
 
+    /**
+     * Default constructor.
+     */
+    public Report() {
+        // Default constructor
+    }
+
     /**
      * Get the line number where this feature starts.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Result.java

@@ -30,6 +30,13 @@ public class Result {
     @SerializedName("error_message")
     private String errorMessage = "";
 
+    /**
+     * Default constructor.
+     */
+    public Result() {
+        // Default constructor
+    }
+
     /**
      * Get the duration of this result.
      *
@@ -104,7 +111,7 @@ public long getDurationInMilliseconds() {
     }
 
     /**
-     * Get the human readable duration string.
+     * Get the human-readable duration string.
      *
      * @return The duration string.
      */

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/ResultMatch.java

@@ -30,6 +30,13 @@ public class ResultMatch {
     private List<String> output = new ArrayList<>();
     private List<Embedding> embeddings = new ArrayList<>();
 
+    /**
+     * Default constructor.
+     */
+    public ResultMatch() {
+        // Default constructor
+    }
+
     /**
      * Get the result.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Row.java

@@ -22,8 +22,16 @@
  * Table row.
  */
 public class Row {
+
     private List<String> cells = new ArrayList<>();
 
+    /**
+     * Default constructor.
+     */
+    public Row() {
+        // Default constructor
+    }
+
     /**
      * Get the individual table cells in this row.
      *

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Step.java

@@ -30,6 +30,7 @@
  * A Cucumber step.
  */
 public class Step extends ResultMatch {
+
     private List<ResultMatch> before = new ArrayList<>();
     private int line;
     private String name = "";
@@ -44,6 +45,13 @@ public class Step extends ResultMatch {
 
     private static final Map<String, String> stepMatchToNameWithArgumentPlaceholders = new HashMap<>();
 
+    /**
+     * Default constructor.
+     */
+    public Step() {
+        // Default constructor
+    }
+
     /**
      * Check if there are before or after step hooks with content.
      *
@@ -344,14 +352,19 @@ public boolean hasSubSections() {
     }
 
     /**
-     * Set if the step has sub sections.
+     * Set if the step has subsections.
      *
      * @param hasSubSections true if the step has sub sections.
      */
     public void setHasSubSections(boolean hasSubSections) {
         this.hasSubSections = hasSubSections;
     }
 
+    /**
+     * Get the unique name of the step.
+     *
+     * @return The unique name.
+     */
     public String getUniqueName() {
         return getGlueMethodName() + "_" + returnNameWithArgumentPlaceholders();
     }

engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Tag.java

@@ -25,8 +25,16 @@
  * This represents a Cucumber tag.
  */
 public class Tag {
+
     private String name;
 
+    /**
+     * Default constructor.
+     */
+    public Tag() {
+        // Default constructor
+    }
+
     /**
      * Get the tag name.
      *