Merge pull request #137 from trivago/1.7.2-bugfix

1.7.2 bugfix
trivago · Mar 5, 2019 · 7063846 · 7063846
2 parents d046974 + 20d4140
commit 7063846
Show file tree

Hide file tree

Showing 10 changed files with 114 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Back to [Readme](README.md).
 
+## [1.7.2] - 2019-03-05
+
+### Fixed
+
+* Step times did not take step hook times into account (#135)
+
 ## [1.7.1] - 2019-02-28
 
 ### Fixed
@@ -20,9 +26,11 @@ Back to [Readme](README.md).
 * Feature name link is now shown on scenario detail pages (#125)
 * three new options to expand or collapse hooks and docstrings on scenario detail pages (default: false) (#117)
 ```xml
+<configuration>
     <expandBeforeAfterHooks>true|false</expandBeforeAfterHooks>
     <expandStepHooks>true|false</expandStepHooks>
     <expandDocStrings>true|false</expandDocStrings>
+</configuration>
 ```
 
 * Added data attributes for common elements (`data-cluecumber-item`) to simplify custom css configurations (related to #129)
@@ -359,6 +367,7 @@ Back to [Readme](README.md).
 
 Initial project version on GitHub and Maven Central.
 
+[1.7.2]: https://github.com/trivago/cluecumber-report-plugin/tree/1.7.2
 [1.7.1]: https://github.com/trivago/cluecumber-report-plugin/tree/1.7.1
 [1.7.0]: https://github.com/trivago/cluecumber-report-plugin/tree/1.7.0
 [1.6.5]: https://github.com/trivago/cluecumber-report-plugin/tree/1.6.5

diff --git a/example-project/json/scenario_with_step_hooks.json b/example-project/json/scenario_with_step_hooks.json
@@ -54,7 +54,7 @@
             "before": [
               {
                 "result": {
-                  "duration": 6236342,
+                  "duration": 10000000,
                   "status": "passed"
                 },
                 "match": {
@@ -63,7 +63,7 @@
               }
             ],
             "result": {
-              "duration": 5466433151,
+              "duration": 40000000,
               "status": "passed"
             },
             "line": 6,
@@ -87,7 +87,7 @@
                 ],
                 "result": {
                   "error_message": "some.AssertError: some stack trace for the after step hook\r\n",
-                  "duration": 6236342,
+                  "duration": 20000000,
                   "status": "failed"
                 },
                 "match": {

diff --git a/plugin-code/src/main/java/com/trivago/cluecumber/json/pojo/Element.java b/plugin-code/src/main/java/com/trivago/cluecumber/json/pojo/Element.java
@@ -233,7 +233,7 @@ public long getTotalDuration() {
             totalDurationMicroseconds += beforeStep.getResult().getDuration();
         }
         for (Step step : steps) {
-            totalDurationMicroseconds += step.getResult().getDuration();
+            totalDurationMicroseconds += step.getTotalDuration();
         }
         for (ResultMatch afterStep : after) {
             totalDurationMicroseconds += afterStep.getResult().getDuration();

diff --git a/plugin-code/src/main/java/com/trivago/cluecumber/json/pojo/Step.java b/plugin-code/src/main/java/com/trivago/cluecumber/json/pojo/Step.java
@@ -17,6 +17,7 @@
 package com.trivago.cluecumber.json.pojo;
 
 import com.google.gson.annotations.SerializedName;
+import com.trivago.cluecumber.rendering.RenderingUtils;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -100,4 +101,21 @@ public DocString getDocString() {
     public void setDocString(final DocString docString) {
         this.docString = docString;
     }
+
+    public long getTotalDuration() {
+        long totalDurationMicroseconds = 0;
+
+        for (ResultMatch beforeStep : before) {
+            totalDurationMicroseconds += beforeStep.getResult().getDuration();
+        }
+        totalDurationMicroseconds += getResult().getDuration();
+        for (ResultMatch afterStep : after) {
+            totalDurationMicroseconds += afterStep.getResult().getDuration();
+        }
+        return totalDurationMicroseconds;
+    }
+
+    public String returnTotalDurationString() {
+        return RenderingUtils.convertMicrosecondsToTimeString(getTotalDuration());
+    }
 }
diff --git a/plugin-code/src/main/resources/template/scenario-detail.ftl b/plugin-code/src/main/resources/template/scenario-detail.ftl
@@ -108,7 +108,7 @@ preheadlineLink="pages/feature-scenarios/feature_${element.featureIndex?c}.html"
                                 </span>
                             </div>
                             <div class="col-2 text-left small">
-                                ${step.result.returnDurationString()}
+                                ${step.returnTotalDurationString()}
                             </div>
                             <div class="col-1 text-right">
                                 <@common.status status=step.consolidatedStatusString/>

diff --git a/plugin-code/src/test/java/com/trivago/cluecumber/json/pojo/ResultMatchTest.java b/plugin-code/src/test/java/com/trivago/cluecumber/json/pojo/ResultMatchTest.java
@@ -111,4 +111,21 @@ public void getConsolidatedStatusTest() {
         assertThat(resultMatch.getConsolidatedStatus(), is(Status.PASSED));
         assertThat(resultMatch.getConsolidatedStatusString(), is("passed"));
     }
+
+    @Test
+    public void hasOutputsTest(){
+        assertThat(resultMatch.hasOutputs(), is(false));
+        List<String> output = new ArrayList<>();
+        output.add("Test");
+        resultMatch.setOutput(output);
+        assertThat(resultMatch.hasOutputs(), is(true));
+    }
+
+    @Test
+    public void returnEscapedOutputsTest(){
+        List<String> output = new ArrayList<>();
+        output.add("Testäöüß");
+        resultMatch.setOutput(output);
+        assertThat(resultMatch.returnEscapedOutputs().get(0), is("Testäöüß"));
+    }
 }
diff --git a/plugin-code/src/test/java/com/trivago/cluecumber/json/pojo/StepTest.java b/plugin-code/src/test/java/com/trivago/cluecumber/json/pojo/StepTest.java
@@ -1,5 +1,6 @@
 package com.trivago.cluecumber.json.pojo;
 
+import org.hamcrest.MatcherAssert;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -47,4 +48,33 @@ public void returnNameWithArguments() {
         step.setResult(result);
         assertThat(step.returnNameWithArguments(), is("This is a name with an <strong>argument</strong> inside."));
     }
+
+    @Test
+    public void totalDurationTest() {
+        Step step = new Step();
+
+        List<com.trivago.cluecumber.json.pojo.ResultMatch> beforeSteps = new ArrayList<>();
+        com.trivago.cluecumber.json.pojo.ResultMatch before = new com.trivago.cluecumber.json.pojo.ResultMatch();
+        Result beforeResult = new Result();
+        beforeResult.setDuration(1000000000L);
+        before.setResult(beforeResult);
+        beforeSteps.add(before);
+        step.setBefore(beforeSteps);
+
+        Result stepResult = new Result();
+        stepResult.setDuration(5000000000L);
+        step.setResult(stepResult);
+
+        List<com.trivago.cluecumber.json.pojo.ResultMatch> afterSteps = new ArrayList<>();
+        com.trivago.cluecumber.json.pojo.ResultMatch after = new com.trivago.cluecumber.json.pojo.ResultMatch();
+        Result afterResult = new Result();
+        afterResult.setDuration(2000000000L);
+        after.setResult(afterResult);
+        afterSteps.add(after);
+        step.setAfter(afterSteps);
+
+        MatcherAssert.assertThat(step.getTotalDuration(), is(8000000000L));
+        MatcherAssert.assertThat(step.returnTotalDurationString(), is("0m 08s 000ms"));
+    }
+
 }
diff --git a/plugin-code/src/test/java/com/trivago/cluecumber/rendering/TemplateConfigurationTest.java b/plugin-code/src/test/java/com/trivago/cluecumber/rendering/TemplateConfigurationTest.java
@@ -1,9 +1,13 @@
 package com.trivago.cluecumber.rendering;
 
 import com.trivago.cluecumber.exceptions.CluecumberPluginException;
+import freemarker.template.Template;
 import org.junit.Before;
 import org.junit.Test;
 
+import static org.hamcrest.core.Is.is;
+import static org.junit.Assert.assertThat;
+
 public class TemplateConfigurationTest {
 
     private TemplateConfiguration templateConfiguration;
@@ -22,4 +26,11 @@ public void validInitTest() {
     public void getNonexistentTemplateTest() throws CluecumberPluginException {
         templateConfiguration.getTemplate("testTemplate");
     }
+
+    @Test
+    public void getExistentTemplateTest() throws CluecumberPluginException {
+        templateConfiguration.init("/");
+        Template template = templateConfiguration.getTemplate("test");
+        assertThat(template.toString(), is("${test}"));
+    }
 }
diff --git a/...vago/cluecumber/rendering/pages/pojos/pagecollections/AllScenariosPageCollectionTest.java b/...vago/cluecumber/rendering/pages/pojos/pagecollections/AllScenariosPageCollectionTest.java
@@ -11,8 +11,10 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import static org.hamcrest.core.Is.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 public class AllScenariosPageCollectionTest {
 
@@ -63,6 +65,26 @@ public void getTotalDurationDefaultValueTest() {
         assertThat(totalDuration, is(0L));
     }
 
+    @Test
+    public void getTotalDurationTest() {
+        Report report = mock(Report.class);
+        when(report.getTotalDuration()).thenReturn(5000000000L);
+        Report[] reports = new Report[]{report, report};
+
+        allScenariosPageCollection.addReports(reports);
+        long totalDuration = allScenariosPageCollection.getTotalDuration();
+        assertThat(totalDuration, is(10000000000L));
+    }
+
+    @Test
+    public void getTotalDurationStringTest() {
+        Report report = mock(Report.class);
+        when(report.getTotalDuration()).thenReturn(5000000000L);
+        Report[] reports = new Report[]{report};
+        allScenariosPageCollection.addReports(reports);
+        assertThat(allScenariosPageCollection.getTotalDurationString(), is("0m 05s 000ms"));
+    }
+
     @Test
     public void hasFailedScenariosTest() {
         assertThat(allScenariosPageCollection.hasFailedScenarios(), is(false));

diff --git a/plugin-code/src/test/resources/test.ftl b/plugin-code/src/test/resources/test.ftl
@@ -0,0 +1 @@
+${test}