Merge pull request #24 from trivago/0.1.2

0.1.2

CHANGELOG.md

@@ -7,7 +7,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Back to [Readme](README.md).
 
-## [0.1.1] - 2017-12-12
+## [0.2.0] - 2017-12-12
+
+# Added
+
+- Support for data tables within steps
+- Cleaner report headers
+
+# Removed
+
+- Javascript back method is replaced with simple links on the detail pages
+
+# Fixed
+
+- Report generation is now much more resilient if information is missing in the JSON sources
+
+## [0.1.1] - 2018-01-16
 
 # Removed
 
@@ -68,7 +83,7 @@ Back to [Readme](README.md).
 
 Initial project version on GitHub and Maven Central.
 
-[Unreleased]: https://github.com/trivago/cluecumber-report-plugin/compare/0.1.1...HEAD
+[0.2.0]: https://github.com/trivago/cluecumber-report-plugin/tree/0.2.0
 [0.1.1]: https://github.com/trivago/cluecumber-report-plugin/tree/0.1.1
 [0.1.0]: https://github.com/trivago/cluecumber-report-plugin/tree/0.1.0
 [0.0.6]: https://github.com/trivago/cluecumber-report-plugin/tree/0.0.6

README.md

@@ -11,6 +11,7 @@
 
 
 - [Cluecumber Report Maven Plugin](#cluecumber-report-maven-plugin)
+  - [Changelog](#changelog)
 - [Prerequisites](#prerequisites)
 - [Maven POM settings](#maven-pom-settings)
   - [Mandatory Configuration Parameters](#mandatory-configuration-parameters)
@@ -41,6 +42,10 @@ This project was created because
 
 **Note:** If you need to run Cucumber tests in parallel, please check out our [Cucable](https://github.com/trivago/cucable-plugin) project!
 
+## Changelog
+
+All changes are documented in the [full changelog](CHANGELOG.md).
+
 # Prerequisites
 
 In order to have the JSON files as a source for the Cluecumber Report generation, you need to specify this option in your Cucumber runner configuration:
@@ -141,7 +146,7 @@ Cluecumber requires Java 8 and Maven 3.3.9. It is available in [Maven central](h
 
 # License
 
-Copyright 2017 trivago NV
+Copyright 2018 trivago NV
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.trivago.rta</groupId>
     <artifactId>cluecumber-report-plugin</artifactId>
-    <version>0.1.1</version>
+    <version>0.2.0</version>
     <url>https://github.com/trivago/cluecumber-report-plugin</url>
 
     <name>Cluecumber Maven Plugin for Cucumber Reports</name>

src/main/java/CluecumberReportPlugin.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/constants/ChartColor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/constants/PluginSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/constants/Status.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,12 @@
  * Enum to manage all states for steps and scenarios.
  */
 public enum Status {
-    PASSED("passed"), FAILED("failed"), SKIPPED("skipped"), PENDING("pending"), UNDEFINED("undefined");
+    PASSED("passed"),
+    FAILED("failed"),
+    SKIPPED("skipped"),
+    PENDING("pending"),
+    UNDEFINED("undefined"),
+    AMBIGUOUS("ambiguous");
 
     private final String status;
 

src/main/java/com/trivago/rta/exceptions/CluecumberPluginException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/exceptions/filesystem/FileCreationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/exceptions/filesystem/MissingFileException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/exceptions/filesystem/PathCreationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/exceptions/properties/WrongOrMissingPropertyException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/filesystem/FileIO.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/filesystem/FileSystemManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/json/JsonPojoConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/json/pojo/After.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/json/pojo/Before.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/trivago/rta/json/pojo/Element.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,12 +25,12 @@
 public class Element {
     private List<Before> before = new ArrayList<>();
     private int line;
-    private String name;
-    private String description;
-    private String id;
+    private String name = "";
+    private String description = "";
+    private String id = "";
     private List<After> after = new ArrayList<>();
-    private String type;
-    private String keyword;
+    private String type = "";
+    private String keyword = "";
     private List<Step> steps = new ArrayList<>();
     private List<Tag> tags = new ArrayList<>();
 
@@ -60,14 +60,22 @@ public void setLine(final int line) {
         this.line = line;
     }
 
+    public String getEncodedName(){
+        return RenderingUtils.escapeHTML(getName());
+    }
+
     public String getName() {
-        return name;
+        return !name.isEmpty() ? name : "[Unnamed]";
     }
 
     public void setName(final String name) {
         this.name = name;
     }
 
+    public String getEncodedDescription(){
+        return RenderingUtils.escapeHTML(getDescription());
+    }
+
     public String getDescription() {
         return description;
     }
@@ -149,6 +157,7 @@ public Status getStatus() {
                 }
             }
         }
+
         return Status.FAILED;
     }
 

src/main/java/com/trivago/rta/json/pojo/Embedding.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,15 +17,20 @@
 package com.trivago.rta.json.pojo;
 
 import com.google.gson.annotations.SerializedName;
+import com.trivago.rta.rendering.RenderingUtils;
 
 public class Embedding {
     private String data;
 
     @SerializedName("mime_type")
-    private String mimeType;
+    private String mimeType = "unknown";
 
     private transient String filename;
 
+    public String getEncodedData(){
+        return RenderingUtils.escapeHTML(getData());
+    }
+
     public String getData() {
         return data;
     }
@@ -58,4 +63,8 @@ public boolean isImage() {
                 mimeType.equalsIgnoreCase("image/svg+xml");
 
     }
+
+    public boolean isPlainText(){
+        return mimeType.equalsIgnoreCase("text/plain");
+    }
 }

src/main/java/com/trivago/rta/json/pojo/Match.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
 import java.util.List;
 
 public class Match {
-    private String location;
+    private String location = "";
     private List<Argument> arguments = new ArrayList<>();
 
     public String getLocation() {

src/main/java/com/trivago/rta/json/pojo/Report.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,18 +16,19 @@
 
 package com.trivago.rta.json.pojo;
 
-import java.time.Duration;
+import com.trivago.rta.rendering.RenderingUtils;
+
 import java.util.ArrayList;
 import java.util.List;
 
 public class Report {
     private int line;
     private List<Element> elements = new ArrayList<>();
-    private String name;
-    private String description;
-    private String id;
-    private String keyword;
-    private String uri;
+    private String name = "";
+    private String description = "";
+    private String id = "";
+    private String keyword = "";
+    private String uri = "";
 
     public int getLine() {
         return line;
@@ -45,14 +46,22 @@ public void setElements(final List<Element> elements) {
         this.elements = elements;
     }
 
+    public String getEncodedName() {
+        return RenderingUtils.escapeHTML(getName());
+    }
+
     public String getName() {
-        return name;
+        return !name.isEmpty() ? name : "[Unnamed]";
     }
 
     public void setName(final String name) {
         this.name = name;
     }
 
+    public String getEncodedDescription() {
+        return RenderingUtils.escapeHTML(getDescription());
+    }
+
     public String getDescription() {
         return description;
     }

src/main/java/com/trivago/rta/json/pojo/Result.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 trivago N.V.
+ * Copyright 2018 trivago N.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,9 +26,7 @@ public class Result {
     private String status = Status.UNDEFINED.toString();
 
     @SerializedName("error_message")
-    private String errorMessage;
-
-    private transient String durationString;
+    private String errorMessage = "";
 
     public long getDuration() {
         return duration;
@@ -46,6 +44,10 @@ public String getStatus() {
         return status;
     }
 
+    public boolean hasErrorMessage() {
+        return !errorMessage.isEmpty();
+    }
+
     public String getErrorMessage() {
         return errorMessage;
     }
@@ -72,7 +74,6 @@ public String toString() {
                 "duration=" + duration +
                 ", status='" + status + '\'' +
                 ", errorMessage='" + errorMessage + '\'' +
-                ", durationString='" + durationString + '\'' +
                 '}';
     }
 }