3.3.0 (#317)

* version update * re-introduced Maven skip option * re-introduced Maven skip option * removed Twitter link * removed twitter * click on bar charts work * skipped state handling * updated changelog for 3.3.0
trivago · Aug 7, 2023 · ab12cea · ab12cea
1 parent 37ed3c4
commit ab12cea
Show file tree

Hide file tree

Showing 19 changed files with 280 additions and 61 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Back to [Readme](README.md).
 
+## [3.3.0] - 2023-08-07
+
+### Fixed
+* Scenarios having skipped steps after a passed step are now considered skipped (used to be passed) (#314) 
+* `skip` parameter in Cluecumber Maven was not recognized anymore (#316)
+
+### Added
+* Charts in "All Tags", "All Features" and "All Steps" can now be clicked and redirect to the according detail page
+
 ## [3.2.2] - 2023-05-12
 
 ### Fixed
@@ -737,6 +746,7 @@ steps with status `pending` or `undefined` (default value is `false`) (#74)
 
 Initial project version on GitHub and Maven Central.
 
+[3.3.0]: https://github.com/trivago/cluecumber-report-plugin/tree/3.3.0
 [3.2.2]: https://github.com/trivago/cluecumber-report-plugin/tree/3.2.2
 [3.2.1]: https://github.com/trivago/cluecumber-report-plugin/tree/3.2.1
 [3.2.0]: https://github.com/trivago/cluecumber-report-plugin/tree/3.2.0

diff --git a/core/pom.xml b/core/pom.xml
@@ -6,13 +6,13 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>cluecumber-core</artifactId>
-    <version>3.2.2</version>
+    <version>3.3.0</version>
     <packaging>jar</packaging>
 
     <parent>
         <artifactId>cluecumber-parent</artifactId>
         <groupId>com.trivago.rta</groupId>
-        <version>3.2.2</version>
+        <version>3.3.0</version>
     </parent>
 
     <name>Cluecumber Core</name>

diff --git a/engine/pom.xml b/engine/pom.xml
@@ -8,11 +8,11 @@
     <parent>
         <artifactId>cluecumber-parent</artifactId>
         <groupId>com.trivago.rta</groupId>
-        <version>3.2.2</version>
+        <version>3.3.0</version>
     </parent>
 
     <artifactId>cluecumber-engine</artifactId>
-    <version>3.2.2</version>
+    <version>3.3.0</version>
     <packaging>jar</packaging>
 
     <name>Cluecumber Engine</name>

diff --git a/engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Element.java b/engine/src/main/java/com/trivago/cluecumber/engine/json/pojo/Element.java
@@ -413,7 +413,7 @@ public Status getStatus() {
             if (failOnPendingOrUndefined) {
                 return Status.FAILED;
             }
-            return Status.PASSED;
+            return Status.SKIPPED;
         }
 
         // If all steps are skipped return skipped (or failed if failOnPendingOrUndefined is true).

diff --git a/engine/src/main/java/com/trivago/cluecumber/engine/rendering/pages/pojos/ReportDetails.java b/engine/src/main/java/com/trivago/cluecumber/engine/rendering/pages/pojos/ReportDetails.java
@@ -21,14 +21,16 @@
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Information about the report generation date and Cluecumber version.
  */
 public class ReportDetails {
     private final String date;
     private String chartJson;
-
+    private Map<String, String> chartUrlLookup = new HashMap<>();
 
     /**
      * Constructor setting the generation date.
@@ -75,4 +77,12 @@ public String getGeneratorName() {
         return String.format("%s version %s",
                 Settings.NAME, RenderingUtils.getPluginVersion());
     }
+
+    public Map<String, String> getChartUrlLookup() {
+        return chartUrlLookup;
+    }
+
+    public void setChartUrlLookup(Map<String, String> chartUrlLookup) {
+        this.chartUrlLookup = chartUrlLookup;
+    }
 }
diff --git a/...va/com/trivago/cluecumber/engine/rendering/pages/renderering/AllFeaturesPageRenderer.java b/...va/com/trivago/cluecumber/engine/rendering/pages/renderering/AllFeaturesPageRenderer.java
@@ -31,6 +31,7 @@
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -87,9 +88,15 @@ private void addChartJsonToReportDetails(final AllFeaturesPageCollection allFeat
         List<Float> passed = new ArrayList<>();
         List<Float> failed = new ArrayList<>();
         List<Float> skipped = new ArrayList<>();
+        Map<String, String> urlLookup = new HashMap<>();
 
         int maximumNumberOfRuns = 0;
         for (Map.Entry<Feature, ResultCount> entry : allFeaturesPageCollection.getFeatureResultCounts().entrySet()) {
+            urlLookup.put(
+                    entry.getKey().getName(),
+                    propertyManager.getGeneratedHtmlReportDirectory() + "/" +
+                            Settings.PAGES_DIRECTORY + Settings.FEATURE_SCENARIOS_PAGE_FRAGMENT +
+                            entry.getKey().getIndex() + Settings.HTML_FILE_EXTENSION);
             ResultCount featureResultCount = entry.getValue();
             passed.add((float) featureResultCount.getPassed());
             failed.add((float) featureResultCount.getFailed());
@@ -117,6 +124,7 @@ private void addChartJsonToReportDetails(final AllFeaturesPageCollection allFeat
                         .build();
 
         allFeaturesPageCollection.getReportDetails().setChartJson(convertChartToJson(chart));
+        allFeaturesPageCollection.getReportDetails().setChartUrlLookup(urlLookup);
     }
 }
 
diff --git a/.../java/com/trivago/cluecumber/engine/rendering/pages/renderering/AllStepsPageRenderer.java b/.../java/com/trivago/cluecumber/engine/rendering/pages/renderering/AllStepsPageRenderer.java
@@ -30,6 +30,7 @@
 
 import javax.inject.Inject;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -86,9 +87,15 @@ private void addChartJsonToReportDetails(final AllStepsPageCollection allTagsPag
         List<Float> passed = new ArrayList<>();
         List<Float> failed = new ArrayList<>();
         List<Float> skipped = new ArrayList<>();
+        Map<String, String> urlLookup = new HashMap<>();
 
         int maximumNumberOfRuns = 0;
         for (Map.Entry<Step, ResultCount> entry : allTagsPageCollection.getStepResultCounts().entrySet()) {
+            urlLookup.put(
+                    entry.getKey().returnNameWithArgumentPlaceholders(),
+                    propertyManager.getGeneratedHtmlReportDirectory() + "/" +
+                            Settings.PAGES_DIRECTORY + Settings.STEP_SCENARIO_PAGE_FRAGMENT +
+                            entry.getKey().getUrlFriendlyName() + Settings.HTML_FILE_EXTENSION);
             ResultCount stepResultCount = entry.getValue();
             passed.add((float) stepResultCount.getPassed());
             failed.add((float) stepResultCount.getFailed());
@@ -117,5 +124,6 @@ private void addChartJsonToReportDetails(final AllStepsPageCollection allTagsPag
 
 
         allTagsPageCollection.getReportDetails().setChartJson(convertChartToJson(chart));
+        allTagsPageCollection.getReportDetails().setChartUrlLookup(urlLookup);
     }
 }
diff --git a/...n/java/com/trivago/cluecumber/engine/rendering/pages/renderering/AllTagsPageRenderer.java b/...n/java/com/trivago/cluecumber/engine/rendering/pages/renderering/AllTagsPageRenderer.java
@@ -31,6 +31,7 @@
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -87,9 +88,15 @@ private void addChartJsonToReportDetails(final AllTagsPageCollection allTagsPage
         List<Float> passed = new ArrayList<>();
         List<Float> failed = new ArrayList<>();
         List<Float> skipped = new ArrayList<>();
+        Map<String, String> urlLookup = new HashMap<>();
 
         int maximumNumberOfRuns = 0;
         for (Map.Entry<Tag, ResultCount> entry : allTagsPageCollection.getTagResultCounts().entrySet()) {
+            urlLookup.put(
+                    entry.getKey().getName(),
+                    propertyManager.getGeneratedHtmlReportDirectory() + "/" +
+                            Settings.PAGES_DIRECTORY + Settings.TAG_SCENARIO_PAGE_FRAGMENT +
+                            entry.getKey().getUrlFriendlyName() + Settings.HTML_FILE_EXTENSION);
             ResultCount tagResultCount = entry.getValue();
             passed.add((float) tagResultCount.getPassed());
             failed.add((float) tagResultCount.getFailed());
@@ -116,6 +123,7 @@ private void addChartJsonToReportDetails(final AllTagsPageCollection allTagsPage
                         .build();
 
         allTagsPageCollection.getReportDetails().setChartJson(convertChartToJson(chart));
+        allTagsPageCollection.getReportDetails().setChartUrlLookup(urlLookup);
     }
 }
 
diff --git a/engine/src/main/resources/template/macros/page.ftl b/engine/src/main/resources/template/macros/page.ftl
@@ -89,4 +89,4 @@ limitations under the License.
     <div id="canvas-holder" class="w-auto h-auto text-center" style="min-height: 15rem;" data-cluecumber-item="chart">
         <canvas id="chart-area" class="w-100"></canvas>
     </div>
-</#macro>
+</#macro>
diff --git a/engine/src/main/resources/template/snippets/js.ftl b/engine/src/main/resources/template/snippets/js.ftl
@@ -48,51 +48,68 @@ limitations under the License.
 
             // Chart
             <#if (reportDetails.chartJson?has_content)>
-            var canvas = document.getElementById('chart-area');
-            var ctx = canvas.getContext("2d");
-            var chart = new Chart(ctx, ${reportDetails.chartJson});
-
-            var original;
-            if (chart.config.type === "pie") {
-                original = Chart.defaults.pie.legend.onClick;
-            } else {
-                original = Chart.defaults.global.legend.onClick;
-            }
-
-            chart.options.onClick = function (evt, elements) {
-                if (chart.config.type !== "pie") return;
-                chartArea = elements[0];
-                if (chartArea === undefined) return;
-                chartArea.hidden = !chartArea.hidden;
-                chart.update();
-                toggleVisibilityByStatus(chartArea._model.label, !chartArea.hidden)
-            };
-
-            chart.options.legend.onClick = function (evt, label) {
-                original.call(this, evt, label);
-                toggleVisibilityByStatus(label.text, label.hidden);
-            };
+                var canvas = document.getElementById('chart-area');
+                var ctx = canvas.getContext("2d");
+                var chart = new Chart(ctx, ${reportDetails.chartJson});
+
+                var original;
+                if (chart.config.type === "pie") {
+                    original = Chart.defaults.pie.legend.onClick;
+                    chart.options.onClick = function (evt, elements) {
+                        chartArea = elements[0];
+                        if (chartArea === undefined) return;
+                        chartArea.hidden = !chartArea.hidden;
+                        chart.update();
+                        toggleVisibilityByStatus(chartArea._model.label, !chartArea.hidden)
+                    };
+                } else if (chart.config.type === "bar") {
+                    <#if (reportDetails.chartUrlLookup?has_content)>
+                        console.log("LOOKUP: " + ${reportDetails.chartUrlLookup?size})
+                        const chartUrls = {
+                            <#list reportDetails.chartUrlLookup as stepName, urlFriendlyStepName>
+                            "${stepName?js_string}": "${urlFriendlyStepName}",
+                            </#list>
+                        };
+                        canvas.onclick = function (evt) {
+                            const activePoints = chart.getElementsAtEvent(evt);
+                            if (activePoints.length <= 0) return;
+                            const clickedElementindex = activePoints[0]["_index"];
+                            const label = chart.data.labels[clickedElementindex];
+                            if (label == null) return;
+                            urlSnippet = chartUrls[label];
+                            //const url = document.evaluate("//a[text()='" + label + "']", document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+                            console.log(urlSnippet);
+                            if (urlSnippet == null) return;
+                            window.location.href = urlSnippet;
+                        }
+                    </#if>
+                    original = Chart.defaults.global.legend.onClick;
+                }
 
-            function toggleVisibilityByStatus(statusText, show) {
-                var card = $("#card_" + statusText);
-                if (card !== undefined) {
-                    if (show) {
-                        card.show();
-                    } else {
-                        card.hide();
+                chart.options.legend.onClick = function (evt, label) {
+                    original.call(this, evt, label);
+                    toggleVisibilityByStatus(label.text, label.hidden);
+                };
+
+                function toggleVisibilityByStatus(statusText, show) {
+                    var card = $("#card_" + statusText);
+                    if (card !== undefined) {
+                        if (show) {
+                            card.show();
+                        } else {
+                            card.hide();
+                        }
                     }
-                }
 
-                var row = $(".table-row-" + statusText);
-                if (row !== undefined) {
-                    if (show) {
-                        row.show();
-                    } else {
-                        row.hide();
+                    var row = $(".table-row-" + statusText);
+                    if (row !== undefined) {
+                        if (show) {
+                            row.show();
+                        } else {
+                            row.hide();
+                        }
                     }
                 }
-            }
-
             </#if>
 
             if (${expandBeforeAfterHooks?c}) {

diff --git a/engine/src/main/resources/template/step-summary.ftl b/engine/src/main/resources/template/step-summary.ftl
@@ -100,4 +100,11 @@ preheadlineLink="">
             </table>
         </@page.card>
     </div>
-</@page.page>
+<#--    <script>-->
+<#--        const chartUrls = {-->
+<#--            <#list stepResultCounts as step, stepResultCount>-->
+<#--                "${step.name?js_string}": "${step.getUrlFriendlyName()}",-->
+<#--            </#list>-->
+<#--        };-->
+<#--    </script>-->
+</@page.page>
diff --git a/engine/src/test/java/com/trivago/cluecumber/engine/json/pojo/ElementTest.java b/engine/src/test/java/com/trivago/cluecumber/engine/json/pojo/ElementTest.java
@@ -44,7 +44,7 @@ public void getPassedStatusTest() {
     }
 
     @Test
-    public void passedStatusOnPassedAndSkippedStepsTest() {
+    public void skippedStatusOnPassedAndSkippedStepsTest() {
         List<Step> steps = new ArrayList<>();
         Step step = new Step();
         Result result = new Result();
@@ -60,7 +60,7 @@ public void passedStatusOnPassedAndSkippedStepsTest() {
         element.setSteps(steps);
 
         Status status = element.getStatus();
-        assertEquals(status, Status.PASSED);
+        assertEquals(status, Status.SKIPPED);
     }
 
     @Test

diff --git a/examples/core-example/pom.xml b/examples/core-example/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>blog.softwaretester</groupId>
     <artifactId>core-example</artifactId>
-    <version>3.2.2</version>
+    <version>3.3.0</version>
     <packaging>pom</packaging>
 
     <properties>