From 641294d614e5a1b25f9902aa37329956745f6113 Mon Sep 17 00:00:00 2001 From: Benjamin Bischoff Date: Mon, 15 Jan 2018 14:49:36 +0100 Subject: [PATCH 01/12] made report engine more resilient to missinv json values --- pom.xml | 2 +- .../com/trivago/rta/constants/Status.java | 7 +++++- .../com/trivago/rta/json/pojo/Element.java | 18 ++++++++++----- .../com/trivago/rta/json/pojo/Embedding.java | 2 +- .../java/com/trivago/rta/json/pojo/Match.java | 2 +- .../com/trivago/rta/json/pojo/Report.java | 11 +++++++++- .../com/trivago/rta/json/pojo/Result.java | 9 ++++---- .../trivago/rta/json/pojo/ResultMatch.java | 11 ++++++---- .../pages/pojos/CustomParameter.java | 2 +- src/main/resources/template/index.html | 22 +++++++++---------- .../template/scenario-detail/detail.html | 8 +++---- .../rta/json/JsonPojoConverterTest.java | 2 +- 12 files changed, 61 insertions(+), 35 deletions(-) diff --git a/pom.xml b/pom.xml index acb56d2b..220da4c4 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.trivago.rta cluecumber-report-plugin - 0.1.1 + 0.1.2 https://github.com/trivago/cluecumber-report-plugin Cluecumber Maven Plugin for Cucumber Reports diff --git a/src/main/java/com/trivago/rta/constants/Status.java b/src/main/java/com/trivago/rta/constants/Status.java index 3c7efad3..eefcc55a 100644 --- a/src/main/java/com/trivago/rta/constants/Status.java +++ b/src/main/java/com/trivago/rta/constants/Status.java @@ -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; diff --git a/src/main/java/com/trivago/rta/json/pojo/Element.java b/src/main/java/com/trivago/rta/json/pojo/Element.java index f527de7c..d9e3a145 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Element.java +++ b/src/main/java/com/trivago/rta/json/pojo/Element.java @@ -25,12 +25,12 @@ public class Element { private List 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 = new ArrayList<>(); - private String type; - private String keyword; + private String type = ""; + private String keyword = ""; private List steps = new ArrayList<>(); private List tags = new ArrayList<>(); @@ -60,6 +60,10 @@ public void setLine(final int line) { this.line = line; } + public String getEncodedName(){ + return RenderingUtils.escapeHTML(getName()); + } + public String getName() { return name; } @@ -68,6 +72,10 @@ public void setName(final String name) { this.name = name; } + public String getEncodedDescription(){ + return RenderingUtils.escapeHTML(getDescription()); + } + public String getDescription() { return description; } diff --git a/src/main/java/com/trivago/rta/json/pojo/Embedding.java b/src/main/java/com/trivago/rta/json/pojo/Embedding.java index 9adfb678..6b340965 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Embedding.java +++ b/src/main/java/com/trivago/rta/json/pojo/Embedding.java @@ -22,7 +22,7 @@ public class Embedding { private String data; @SerializedName("mime_type") - private String mimeType; + private String mimeType = "unknown"; private transient String filename; diff --git a/src/main/java/com/trivago/rta/json/pojo/Match.java b/src/main/java/com/trivago/rta/json/pojo/Match.java index fc96a695..20410707 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Match.java +++ b/src/main/java/com/trivago/rta/json/pojo/Match.java @@ -20,7 +20,7 @@ import java.util.List; public class Match { - private String location; + private String location = ""; private List arguments = new ArrayList<>(); public String getLocation() { diff --git a/src/main/java/com/trivago/rta/json/pojo/Report.java b/src/main/java/com/trivago/rta/json/pojo/Report.java index f4d48a12..f85a8a05 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Report.java +++ b/src/main/java/com/trivago/rta/json/pojo/Report.java @@ -16,7 +16,8 @@ package com.trivago.rta.json.pojo; -import java.time.Duration; +import com.trivago.rta.rendering.RenderingUtils; + import java.util.ArrayList; import java.util.List; @@ -45,6 +46,10 @@ public void setElements(final List elements) { this.elements = elements; } + public String getEncodedName() { + return RenderingUtils.escapeHTML(getName()); + } + public String getName() { return name; } @@ -53,6 +58,10 @@ public void setName(final String name) { this.name = name; } + public String getEncodedDescription() { + return RenderingUtils.escapeHTML(getDescription()); + } + public String getDescription() { return description; } diff --git a/src/main/java/com/trivago/rta/json/pojo/Result.java b/src/main/java/com/trivago/rta/json/pojo/Result.java index ef101122..3777a768 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Result.java +++ b/src/main/java/com/trivago/rta/json/pojo/Result.java @@ -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 + '\'' + '}'; } } diff --git a/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java b/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java index c1a457e3..2c38ff4a 100644 --- a/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java +++ b/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java @@ -38,12 +38,12 @@ public void setMatch(final Match match) { this.match = match; } - public String getGlueMethodName(){ - return match != null ? match.getLocation() : ""; + public String getGlueMethodName() { + return getMatch().getLocation(); } public Status getStatus() { - return Status.fromString(result.getStatus()); + return Status.fromString(getResult().getStatus()); } public boolean isFailed() { @@ -55,7 +55,10 @@ public boolean isPassed() { } public boolean isSkipped() { - return getStatus() == Status.SKIPPED || getStatus() == Status.PENDING || getStatus() == Status.UNDEFINED; + return getStatus() == Status.SKIPPED || + getStatus() == Status.PENDING || + getStatus() == Status.UNDEFINED || + getStatus() == Status.AMBIGUOUS; } @Override diff --git a/src/main/java/com/trivago/rta/rendering/pages/pojos/CustomParameter.java b/src/main/java/com/trivago/rta/rendering/pages/pojos/CustomParameter.java index 47721755..15516969 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/pojos/CustomParameter.java +++ b/src/main/java/com/trivago/rta/rendering/pages/pojos/CustomParameter.java @@ -16,7 +16,7 @@ public String getKey() { } public String getValue() { - return value; + return value != null ? value : ""; } public boolean isUrl() { diff --git a/src/main/resources/template/index.html b/src/main/resources/template/index.html index 8369582f..7bc5111d 100644 --- a/src/main/resources/template/index.html +++ b/src/main/resources/template/index.html @@ -47,12 +47,12 @@
Test Suite Overview | ${reportDetails.date
Custom Parameters
    - <#list customParameters as parameter> -
  • ${parameter.key}: - <#if parameter.url> - ${parameter.value} + <#list customParameters as customParameter> +
  • ${customParameter.key}: + <#if customParameter.url> + ${customParameter.value} <#else/> - ${parameter.value} + ${customParameter.value}
    • @@ -113,10 +113,10 @@
    Test Suite Overview | ${reportDetails.date <#if element.failed> ${report.name} + title="${report.uri}">${report.encodedName} - ${element.name} + ${element.encodedName} @@ -154,10 +154,10 @@
    Test Suite Overview | ${reportDetails.date <#if element.skipped> ${report.name} + title="${report.uri}">${report.encodedName} - ${element.name} + ${element.encodedName} @@ -195,10 +195,10 @@
    Test Suite Overview | ${reportDetails.date <#if element.passed> ${report.name} + title="${report.uri}">${report.encodedName} - ${element.name} + ${element.encodedName} diff --git a/src/main/resources/template/scenario-detail/detail.html b/src/main/resources/template/scenario-detail/detail.html index 5d8437b3..e6876d4c 100644 --- a/src/main/resources/template/scenario-detail/detail.html +++ b/src/main/resources/template/scenario-detail/detail.html @@ -22,7 +22,7 @@ - Scenario Details - ${element.name} - ${reportDetails.date} + Scenario Details - ${element.encodedName} - ${reportDetails.date} @@ -73,9 +73,9 @@
    Scenario Details | ${reportDetails.date}
    -
    ${element.name}
    +
    ${element.encodedName}
    <#if element.description != ""> -
    ${element.description}
    +
    ${element.encodedDescription}
    @@ -136,7 +136,7 @@
    Scenario Details | ${reportDetails.date}${step.status.statusString}
    - <#if step.failed> + <#if step.result.hasErrorMessage()>
    diff --git a/src/test/java/com/trivago/rta/json/JsonPojoConverterTest.java b/src/test/java/com/trivago/rta/json/JsonPojoConverterTest.java index a0b1b386..3b0232e7 100644 --- a/src/test/java/com/trivago/rta/json/JsonPojoConverterTest.java +++ b/src/test/java/com/trivago/rta/json/JsonPojoConverterTest.java @@ -113,6 +113,6 @@ public void convertJsonToReportPojosTest() throws CluecumberPluginException { Report report = reports[0]; assertThat(report.getName(), is("Test")); assertThat(report.getId(), is("test")); - assertThat(report.toString(), is("Report{line=1, elements=[Element{before=[ResultMatch{result=Result{duration=5554929, status='passed', errorMessage='null', durationString='null'}, match=Match{location='BeforeAfterScenario.before(Scenario)', arguments=[]}}], line=5, name='Test feature', description='', id='test;id', after=[ResultMatch{result=Result{duration=153270, status='passed', errorMessage='null', durationString='null'}, match=Match{location='BeforeAfterScenario.after(Scenario)', arguments=[]}}], type='scenario', keyword='Scenario', steps=[Step{line=7, name='the start page is opened', keyword='Given '}, Step{line=8, name='I see something', keyword='Then '}], tags=[Tag{name='@sometag'}, Tag{name='@someothertag'}], scenarioIndex=-1}], name='Test', description='', id='test', keyword='Feature', uri='parallel/features/Test.feature'}")); + assertThat(report.toString(), is("Report{line=1, elements=[Element{before=[ResultMatch{result=Result{duration=5554929, status='passed', errorMessage=''}, match=Match{location='BeforeAfterScenario.before(Scenario)', arguments=[]}}], line=5, name='Test feature', description='', id='test;id', after=[ResultMatch{result=Result{duration=153270, status='passed', errorMessage=''}, match=Match{location='BeforeAfterScenario.after(Scenario)', arguments=[]}}], type='scenario', keyword='Scenario', steps=[Step{line=7, name='the start page is opened', keyword='Given '}, Step{line=8, name='I see something', keyword='Then '}], tags=[Tag{name='@sometag'}, Tag{name='@someothertag'}], scenarioIndex=-1}], name='Test', description='', id='test', keyword='Feature', uri='parallel/features/Test.feature'}")); } } From 040e15e04c4feb682f012e07fdd00de36375c8fe Mon Sep 17 00:00:00 2001 From: Benjamin Bischoff Date: Mon, 15 Jan 2018 16:33:22 +0100 Subject: [PATCH 02/12] new report header, killed js back function --- pom.xml | 2 +- src/main/java/CluecumberReportPlugin.java | 2 +- .../com/trivago/rta/constants/ChartColor.java | 2 +- .../trivago/rta/constants/PluginSettings.java | 2 +- .../com/trivago/rta/constants/Status.java | 2 +- .../exceptions/CluecumberPluginException.java | 2 +- .../filesystem/FileCreationException.java | 2 +- .../filesystem/MissingFileException.java | 2 +- .../filesystem/PathCreationException.java | 2 +- .../WrongOrMissingPropertyException.java | 2 +- .../com/trivago/rta/filesystem/FileIO.java | 2 +- .../rta/filesystem/FileSystemManager.java | 2 +- .../trivago/rta/json/JsonPojoConverter.java | 2 +- .../java/com/trivago/rta/json/pojo/After.java | 2 +- .../com/trivago/rta/json/pojo/Before.java | 2 +- .../com/trivago/rta/json/pojo/Element.java | 2 +- .../com/trivago/rta/json/pojo/Embedding.java | 11 +++- .../java/com/trivago/rta/json/pojo/Match.java | 2 +- .../com/trivago/rta/json/pojo/Report.java | 2 +- .../com/trivago/rta/json/pojo/Result.java | 2 +- .../trivago/rta/json/pojo/ResultMatch.java | 2 +- .../java/com/trivago/rta/json/pojo/Step.java | 2 +- .../java/com/trivago/rta/json/pojo/Tag.java | 2 +- .../postprocessors/ElementPostProcessor.java | 2 +- .../trivago/rta/logging/CluecumberLogger.java | 2 +- .../rta/properties/PropertyManager.java | 2 +- .../trivago/rta/rendering/RenderingUtils.java | 49 +++++++++++++----- .../rta/rendering/ReportGenerator.java | 2 +- .../trivago/rta/rendering/TemplateEngine.java | 2 +- .../rendering/pages/DetailPageRenderer.java | 2 +- .../rta/rendering/pages/PageRenderer.java | 2 +- .../rendering/pages/StartPageRenderer.java | 2 +- .../pages/pojos/DetailPageCollection.java | 2 +- .../rendering/pages/pojos/ReportDetails.java | 2 +- .../pages/pojos/StartPageCollection.java | 2 +- .../resources/template/css/cluecumber.css | 2 +- src/main/resources/template/index.html | 21 +++++--- .../template/scenario-detail/detail.html | 50 ++++++++++++------- .../filesystem/FileCreationExceptionTest.java | 2 +- .../filesystem/MissingFileExceptionTest.java | 2 +- .../filesystem/PathCreationExceptionTest.java | 2 +- .../WrongOrMissingPropertyExceptionTest.java | 2 +- 42 files changed, 132 insertions(+), 75 deletions(-) diff --git a/pom.xml b/pom.xml index 220da4c4..b7d20fea 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.trivago.rta cluecumber-report-plugin - 0.1.2 + 0.2.0 https://github.com/trivago/cluecumber-report-plugin Cluecumber Maven Plugin for Cucumber Reports diff --git a/src/main/java/CluecumberReportPlugin.java b/src/main/java/CluecumberReportPlugin.java index 672261ce..5bc5f6d9 100644 --- a/src/main/java/CluecumberReportPlugin.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/constants/ChartColor.java b/src/main/java/com/trivago/rta/constants/ChartColor.java index 5d6c37e1..c29c3903 100644 --- a/src/main/java/com/trivago/rta/constants/ChartColor.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/constants/PluginSettings.java b/src/main/java/com/trivago/rta/constants/PluginSettings.java index 7d04893d..71f250b9 100644 --- a/src/main/java/com/trivago/rta/constants/PluginSettings.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/constants/Status.java b/src/main/java/com/trivago/rta/constants/Status.java index eefcc55a..21581c0a 100644 --- a/src/main/java/com/trivago/rta/constants/Status.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/exceptions/CluecumberPluginException.java b/src/main/java/com/trivago/rta/exceptions/CluecumberPluginException.java index 1fad22a7..07f6ee8c 100644 --- a/src/main/java/com/trivago/rta/exceptions/CluecumberPluginException.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/exceptions/filesystem/FileCreationException.java b/src/main/java/com/trivago/rta/exceptions/filesystem/FileCreationException.java index 81d99d61..d16a4e03 100644 --- a/src/main/java/com/trivago/rta/exceptions/filesystem/FileCreationException.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/exceptions/filesystem/MissingFileException.java b/src/main/java/com/trivago/rta/exceptions/filesystem/MissingFileException.java index 6f18b72a..208c678d 100644 --- a/src/main/java/com/trivago/rta/exceptions/filesystem/MissingFileException.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/exceptions/filesystem/PathCreationException.java b/src/main/java/com/trivago/rta/exceptions/filesystem/PathCreationException.java index 8d6d7e61..ba63aa1f 100644 --- a/src/main/java/com/trivago/rta/exceptions/filesystem/PathCreationException.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/exceptions/properties/WrongOrMissingPropertyException.java b/src/main/java/com/trivago/rta/exceptions/properties/WrongOrMissingPropertyException.java index cbba3832..e389f27b 100644 --- a/src/main/java/com/trivago/rta/exceptions/properties/WrongOrMissingPropertyException.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/filesystem/FileIO.java b/src/main/java/com/trivago/rta/filesystem/FileIO.java index 51c49118..bc3566e3 100644 --- a/src/main/java/com/trivago/rta/filesystem/FileIO.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/filesystem/FileSystemManager.java b/src/main/java/com/trivago/rta/filesystem/FileSystemManager.java index 6a25cfdd..97af4ca1 100644 --- a/src/main/java/com/trivago/rta/filesystem/FileSystemManager.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/JsonPojoConverter.java b/src/main/java/com/trivago/rta/json/JsonPojoConverter.java index f847fbd0..aceae473 100644 --- a/src/main/java/com/trivago/rta/json/JsonPojoConverter.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/After.java b/src/main/java/com/trivago/rta/json/pojo/After.java index 3380d9f3..913a7a81 100644 --- a/src/main/java/com/trivago/rta/json/pojo/After.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Before.java b/src/main/java/com/trivago/rta/json/pojo/Before.java index 55063757..1c806873 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Before.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Element.java b/src/main/java/com/trivago/rta/json/pojo/Element.java index d9e3a145..7363bc26 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Element.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Embedding.java b/src/main/java/com/trivago/rta/json/pojo/Embedding.java index 6b340965..c10ecf2d 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Embedding.java +++ b/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,6 +17,7 @@ package com.trivago.rta.json.pojo; import com.google.gson.annotations.SerializedName; +import com.trivago.rta.rendering.RenderingUtils; public class Embedding { private String data; @@ -26,6 +27,10 @@ public class Embedding { 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"); + } } diff --git a/src/main/java/com/trivago/rta/json/pojo/Match.java b/src/main/java/com/trivago/rta/json/pojo/Match.java index 20410707..5a5e0b1a 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Match.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Report.java b/src/main/java/com/trivago/rta/json/pojo/Report.java index f85a8a05..452ac212 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Report.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Result.java b/src/main/java/com/trivago/rta/json/pojo/Result.java index 3777a768..ca2517a9 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Result.java +++ b/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. diff --git a/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java b/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java index 2c38ff4a..33bc1bab 100644 --- a/src/main/java/com/trivago/rta/json/pojo/ResultMatch.java +++ b/src/main/java/com/trivago/rta/json/pojo/ResultMatch.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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Step.java b/src/main/java/com/trivago/rta/json/pojo/Step.java index a746a822..8828ca46 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Step.java +++ b/src/main/java/com/trivago/rta/json/pojo/Step.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. diff --git a/src/main/java/com/trivago/rta/json/pojo/Tag.java b/src/main/java/com/trivago/rta/json/pojo/Tag.java index 62778143..2eb7f1d4 100644 --- a/src/main/java/com/trivago/rta/json/pojo/Tag.java +++ b/src/main/java/com/trivago/rta/json/pojo/Tag.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. diff --git a/src/main/java/com/trivago/rta/json/postprocessors/ElementPostProcessor.java b/src/main/java/com/trivago/rta/json/postprocessors/ElementPostProcessor.java index 1ca8342f..67196ae3 100644 --- a/src/main/java/com/trivago/rta/json/postprocessors/ElementPostProcessor.java +++ b/src/main/java/com/trivago/rta/json/postprocessors/ElementPostProcessor.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. diff --git a/src/main/java/com/trivago/rta/logging/CluecumberLogger.java b/src/main/java/com/trivago/rta/logging/CluecumberLogger.java index 757c13b4..2c7591f6 100644 --- a/src/main/java/com/trivago/rta/logging/CluecumberLogger.java +++ b/src/main/java/com/trivago/rta/logging/CluecumberLogger.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. diff --git a/src/main/java/com/trivago/rta/properties/PropertyManager.java b/src/main/java/com/trivago/rta/properties/PropertyManager.java index 44624ac6..bb426991 100644 --- a/src/main/java/com/trivago/rta/properties/PropertyManager.java +++ b/src/main/java/com/trivago/rta/properties/PropertyManager.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. diff --git a/src/main/java/com/trivago/rta/rendering/RenderingUtils.java b/src/main/java/com/trivago/rta/rendering/RenderingUtils.java index c39ff34b..2027f16e 100644 --- a/src/main/java/com/trivago/rta/rendering/RenderingUtils.java +++ b/src/main/java/com/trivago/rta/rendering/RenderingUtils.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. @@ -21,6 +21,12 @@ public class RenderingUtils { private static final int MICROSECOND_FACTOR = 1000000; + /** + * Convert microseconds to a human readable time string. + * + * @param microseconds The amount of microseconds. + * @return The human readable string representation. + */ public static String convertMicrosecondsToTimeString(final long microseconds) { Duration durationMilliseconds = Duration.ofMillis(microseconds / MICROSECOND_FACTOR); long minutes = durationMilliseconds.toMinutes(); @@ -29,28 +35,45 @@ public static String convertMicrosecondsToTimeString(final long microseconds) { return String.format("%dm %02ds %03dms", minutes, seconds, milliseconds); } + /** + * Convert microseconds to milliseconds. + * + * @param microseconds The amount of microseconds. + * @return The millisecond representation. + */ public static long convertMicrosecondsToMilliseconds(final long microseconds) { return Duration.ofMillis(microseconds / MICROSECOND_FACTOR).toMillis(); } - public static String escapeHTML(final String htmlString) { - StringBuilder out = new StringBuilder(Math.max(16, htmlString.length())); - for (int i = 0; i < htmlString.length(); i++) { - char c = htmlString.charAt(i); - if (c > 127 || c == '"' || c == '<' || c == '>' || c == '&') { - out.append("&#"); - out.append((int) c); - out.append(';'); + /** + * Escape HTML tags in a string. + * + * @param sourceString The source string. + * @return The escaped string. + */ + public static String escapeHTML(final String sourceString) { + StringBuilder stringBuilder = new StringBuilder(Math.max(16, sourceString.length())); + for (int i = 0; i < sourceString.length(); i++) { + char character = sourceString.charAt(i); + if (character > 127 || character == '"' || character == '<' || character == '>' || character == '&') { + stringBuilder.append("&#"); + stringBuilder.append((int) character); + stringBuilder.append(';'); } else { - out.append(c); + stringBuilder.append(character); } } - return out.toString(); + return stringBuilder.toString(); } - public static String getPluginVersion(){ + /** + * Return the current Cluecumber version. + * + * @return The version string. + */ + public static String getPluginVersion() { String version = RenderingUtils.class.getPackage().getImplementationVersion(); - if (version == null){ + if (version == null) { version = "unknown"; } return version; diff --git a/src/main/java/com/trivago/rta/rendering/ReportGenerator.java b/src/main/java/com/trivago/rta/rendering/ReportGenerator.java index bc2b2663..b5d0fb29 100644 --- a/src/main/java/com/trivago/rta/rendering/ReportGenerator.java +++ b/src/main/java/com/trivago/rta/rendering/ReportGenerator.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. diff --git a/src/main/java/com/trivago/rta/rendering/TemplateEngine.java b/src/main/java/com/trivago/rta/rendering/TemplateEngine.java index ea58449b..882e9dae 100644 --- a/src/main/java/com/trivago/rta/rendering/TemplateEngine.java +++ b/src/main/java/com/trivago/rta/rendering/TemplateEngine.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/DetailPageRenderer.java b/src/main/java/com/trivago/rta/rendering/pages/DetailPageRenderer.java index c4a8c967..a26ce395 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/DetailPageRenderer.java +++ b/src/main/java/com/trivago/rta/rendering/pages/DetailPageRenderer.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/PageRenderer.java b/src/main/java/com/trivago/rta/rendering/pages/PageRenderer.java index 606354ff..f7d72b81 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/PageRenderer.java +++ b/src/main/java/com/trivago/rta/rendering/pages/PageRenderer.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/StartPageRenderer.java b/src/main/java/com/trivago/rta/rendering/pages/StartPageRenderer.java index 46dc8d03..d42518db 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/StartPageRenderer.java +++ b/src/main/java/com/trivago/rta/rendering/pages/StartPageRenderer.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/pojos/DetailPageCollection.java b/src/main/java/com/trivago/rta/rendering/pages/pojos/DetailPageCollection.java index eddd66c7..9202a21e 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/pojos/DetailPageCollection.java +++ b/src/main/java/com/trivago/rta/rendering/pages/pojos/DetailPageCollection.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/pojos/ReportDetails.java b/src/main/java/com/trivago/rta/rendering/pages/pojos/ReportDetails.java index ac0e3be1..e5a61e31 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/pojos/ReportDetails.java +++ b/src/main/java/com/trivago/rta/rendering/pages/pojos/ReportDetails.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. diff --git a/src/main/java/com/trivago/rta/rendering/pages/pojos/StartPageCollection.java b/src/main/java/com/trivago/rta/rendering/pages/pojos/StartPageCollection.java index fde0752f..321b052a 100644 --- a/src/main/java/com/trivago/rta/rendering/pages/pojos/StartPageCollection.java +++ b/src/main/java/com/trivago/rta/rendering/pages/pojos/StartPageCollection.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. diff --git a/src/main/resources/template/css/cluecumber.css b/src/main/resources/template/css/cluecumber.css index 98e5eda2..e4b41cbe 100644 --- a/src/main/resources/template/css/cluecumber.css +++ b/src/main/resources/template/css/cluecumber.css @@ -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. diff --git a/src/main/resources/template/index.html b/src/main/resources/template/index.html index 7bc5111d..945f8bee 100644 --- a/src/main/resources/template/index.html +++ b/src/main/resources/template/index.html @@ -1,5 +1,5 @@