fixing display issues when using <> or \" characters in scenario outl…

…ine titles / data table values (#3524)
serenity-bdd · Sep 5, 2024 · 38f02ca · 38f02ca
1 parent 8368742
commit 38f02ca
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/serenity-report-resources/src/main/resources/freemarker/default.ftl b/serenity-report-resources/src/main/resources/freemarker/default.ftl
@@ -38,11 +38,14 @@
         <#list breadcrumbs as breadcrumb>
             <#assign breadcrumbReport = absoluteReportName.forRequirement(breadcrumb) />
             <#assign breadcrumbTitle = breadcrumb.displayName > <!-- inflection.of(breadcrumb.displayName).asATitle()-->
-            > <a href="${breadcrumbReport}">${formatter.htmlCompatibleStoryTitle(breadcrumbTitle)}</a>
+            > <a href="${breadcrumbReport}">
+            ${formatter.escapeHtmlTags(formatter.htmlCompatibleStoryTitle(breadcrumbTitle))}
+        </a>
         </#list>
 <#--        > ${formatter.htmlCompatibleTestTitle(formatter.renderTitle(testOutcome.title))}-->
 <#--        > ${formatter.htmlCompatibleTestTitle(testOutcome.title)}-->
-        > ${formatter.htmlCompatibleTestTitle(formatter.humanReadableFormOf(testOutcome.title))}
+        >
+            ${formatter.escapeHtmlTags(formatter.htmlCompatibleTestTitle(formatter.humanReadableFormOf(testOutcome.title)))}
         </span>
         </div>
         <div class="rightbg"></div>
@@ -346,7 +349,7 @@
                                 <#assign roeResult = row.result/>
                             </#if>
                             <td class="test-${roeResult}"><a
-                                        href="#${rowIndex}">${formatter.plainHtmlCompatible(value)}</a>
+                                        href="#${rowIndex}"><#outputformat 'HTML'>${formatter.plainHtmlCompatible(value)}</#outputformat></a>
                             </td>
                         </#list>
                     </tr>

diff --git a/serenity-report-resources/src/main/resources/freemarker/junit5/default.ftl b/serenity-report-resources/src/main/resources/freemarker/junit5/default.ftl
@@ -338,7 +338,7 @@
                                     <#assign roeResult = row.result/>
                                 </#if>
                                 <td class="test-${roeResult}"><a
-                                            href="#${rowIndex}">${formatter.plainHtmlCompatible(value)}</a>
+                                            href="#${rowIndex}"><#outputformat 'HTML'>${formatter.plainHtmlCompatible(value)}</#outputformat></a>
                                 </td>
                             </#list>
                         </tr>

diff --git a/serenity-reports/src/main/java/net/thucydides/core/reports/html/Formatter.java b/serenity-reports/src/main/java/net/thucydides/core/reports/html/Formatter.java
@@ -481,6 +481,10 @@ public String htmlCompatibleStoryTitle(Object fieldValue) {
                 (htmlCompatible(renderMarkdownWithoutTags(firstLine))) : htmlCompatible(firstLine);
     }
 
+    public String escapeHtmlTags(String fieldValue) {
+        return fieldValue.replace("<", "&lt;").replace(">", "&gt;");
+    }
+
     public String htmlCompatibleTestTitle(Object fieldValue) {
         String firstLine = fieldValue.toString().split("\\n")[0];