add more info on failures in FreemarkerAttachmentRenderer (via #921)

Author: a-simeshin

allure-attachments/src/main/java/io/qameta/allure/attachment/FreemarkerAttachmentRenderer.java

@@ -17,6 +17,9 @@
 
 import freemarker.template.Configuration;
 import freemarker.template.Template;
+import freemarker.template.TemplateExceptionHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.StringWriter;
 import java.io.Writer;
@@ -27,6 +30,8 @@
  */
 public class FreemarkerAttachmentRenderer implements AttachmentRenderer<AttachmentData> {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(FreemarkerAttachmentRenderer.class);
+
     private final Configuration configuration;
 
     private final String templateName;
@@ -36,6 +41,7 @@ public FreemarkerAttachmentRenderer(final String templateName) {
         this.configuration = new Configuration(Configuration.VERSION_2_3_23);
         this.configuration.setLocalizedLookup(false);
         this.configuration.setTemplateUpdateDelayMilliseconds(0);
+        this.configuration.setTemplateExceptionHandler(TemplateExceptionHandler.HTML_DEBUG_HANDLER);
         this.configuration.setClassLoaderForTemplateLoading(getClass().getClassLoader(), "tpl");
     }
 
@@ -46,6 +52,7 @@ public DefaultAttachmentContent render(final AttachmentData data) {
             template.process(Collections.singletonMap("data", data), writer);
             return new DefaultAttachmentContent(writer.toString(), "text/html", ".html");
         } catch (Exception e) {
+            LOGGER.debug(data.toString());
             throw new AttachmentRenderException("Could't render http attachment file", e);
         }
     }

allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpRequestAttachment.java

@@ -16,6 +16,7 @@
 package io.qameta.allure.attachment.http;
 
 import io.qameta.allure.attachment.AttachmentData;
+import io.qameta.allure.util.ObjectUtils;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -81,6 +82,17 @@ public String getName() {
         return name;
     }
 
+    @Override
+    public String toString() {
+        return "HttpRequestAttachment("
+                + "\n\tname=" + this.name
+                + ",\n\turl=" + this.url
+                + ",\n\tbody=" + this.body
+                + ",\n\theaders=" + ObjectUtils.mapToString(this.headers)
+                + ",\n\tcookies=" + ObjectUtils.mapToString(this.cookies)
+                + "\n)";
+    }
+
     /**
      * Builder for HttpRequestAttachment.
      */

allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpResponseAttachment.java

@@ -16,6 +16,7 @@
 package io.qameta.allure.attachment.http;
 
 import io.qameta.allure.attachment.AttachmentData;
+import io.qameta.allure.util.ObjectUtils;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -74,6 +75,18 @@ public Map<String, String> getCookies() {
         return cookies;
     }
 
+    @Override
+    public String toString() {
+        return "HttpResponseAttachment("
+                + "\n\tname=" + this.name
+                + ",\n\turl=" + this.url
+                + ",\n\tbody=" + this.body
+                + ",\n\tresponseCode=" + this.responseCode
+                + ",\n\theaders=" + ObjectUtils.mapToString(this.headers)
+                + ",\n\tcookies=" + ObjectUtils.mapToString(this.cookies)
+                + "\n)";
+    }
+
     /**
      * Builder for HttpRequestAttachment.
      */
@@ -146,6 +159,7 @@ public Builder setBody(final String body) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -155,6 +169,7 @@ public Builder withUrl(final String url) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -164,6 +179,7 @@ public Builder withResponseCode(final int responseCode) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -173,6 +189,7 @@ public Builder withHeader(final String name, final String value) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -182,6 +199,7 @@ public Builder withHeaders(final Map<String, String> headers) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -191,6 +209,7 @@ public Builder withCookie(final String name, final String value) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated
@@ -200,6 +219,7 @@ public Builder withCookies(final Map<String, String> cookies) {
 
         /**
          * Use setter method instead.
+         *
          * @deprecated scheduled for removal in 3.0 release
          */
         @Deprecated

allure-attachments/src/test/java/io/qameta/allure/attachment/FreemarkerAttachmentRendererTest.java

@@ -16,17 +16,26 @@
 package io.qameta.allure.attachment;
 
 import io.qameta.allure.attachment.http.HttpRequestAttachment;
+import io.qameta.allure.attachment.http.HttpResponseAttachment;
 import io.qameta.allure.test.AllureFeatures;
 import org.junit.jupiter.api.Test;
 
 import static io.qameta.allure.attachment.testdata.TestData.randomHttpRequestAttachment;
+import static io.qameta.allure.attachment.testdata.TestData.randomHttpResponseAttachment;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
  * @author charlie (Dmitry Baev).
  */
 class FreemarkerAttachmentRendererTest {
 
+    private static final String CONTENT = "content";
+    private static final String CONTENT_TYPE = "contentType";
+    private static final String TEXT_HTML = "text/html";
+    private static final String FILE_EXTENSION = "fileExtension";
+    private static final String HTML = ".html";
+
+
     @AllureFeatures.Attachments
     @Test
     void shouldRenderRequestAttachment() {
@@ -35,21 +44,21 @@ void shouldRenderRequestAttachment() {
                 .render(data);
 
         assertThat(content)
-                .hasFieldOrPropertyWithValue("contentType", "text/html")
-                .hasFieldOrPropertyWithValue("fileExtension", ".html")
-                .hasFieldOrProperty("content");
+                .hasFieldOrPropertyWithValue(CONTENT_TYPE, TEXT_HTML)
+                .hasFieldOrPropertyWithValue(FILE_EXTENSION, HTML)
+                .hasFieldOrProperty(CONTENT);
     }
 
     @AllureFeatures.Attachments
     @Test
     void shouldRenderResponseAttachment() {
-        final HttpRequestAttachment data = randomHttpRequestAttachment();
+        final HttpResponseAttachment data = randomHttpResponseAttachment();
         final DefaultAttachmentContent content = new FreemarkerAttachmentRenderer("http-response.ftl")
                 .render(data);
 
         assertThat(content)
-                .hasFieldOrPropertyWithValue("contentType", "text/html")
-                .hasFieldOrPropertyWithValue("fileExtension", ".html")
-                .hasFieldOrProperty("content");
+                .hasFieldOrPropertyWithValue(CONTENT_TYPE, TEXT_HTML)
+                .hasFieldOrPropertyWithValue(FILE_EXTENSION, HTML)
+                .hasFieldOrProperty(CONTENT);
     }
 }

allure-attachments/src/test/java/io/qameta/allure/attachment/NegativeFreemarkerAttachmentRendererTest.java

@@ -0,0 +1,87 @@
+/*
+ *  Copyright 2019 Qameta Software OÜ
+ *
+ *  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
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package io.qameta.allure.attachment;
+
+import io.qameta.allure.attachment.http.HttpRequestAttachment;
+import io.qameta.allure.test.AllureFeatures;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.io.UnsupportedEncodingException;
+import java.nio.charset.StandardCharsets;
+
+import static io.qameta.allure.attachment.testdata.TestData.negativeHttpRequestAttachment;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+/**
+ * @author a-simeshin (Simeshin Artem).
+ */
+class NegativeFreemarkerAttachmentRendererTest {
+
+    private static final String TEMPLATE_FOR_EXCEPTION = "body-npe-non-safe-attachment.ftl";
+
+    private PrintStream realSysOut;
+    private ByteArrayOutputStream sysOutBuffer;
+
+    @BeforeEach
+    void setUpSysOut() throws UnsupportedEncodingException {
+        realSysOut = System.err;
+        sysOutBuffer = new ByteArrayOutputStream();
+        System.setErr(new PrintStream(sysOutBuffer, false, StandardCharsets.UTF_8.toString()));
+    }
+
+    @AfterEach
+    void rollBackSysOut() {
+        System.setErr(realSysOut);
+    }
+
+    @AllureFeatures.Attachments
+    @Test
+    void shouldThrowExceptionalSituationsForFreeMarketRendererWithIncorrectAttachmentData() {
+        assertThrows(AttachmentRenderException.class, () -> {
+            final HttpRequestAttachment data = negativeHttpRequestAttachment();
+            new FreemarkerAttachmentRenderer(TEMPLATE_FOR_EXCEPTION).render(data);
+        });
+    }
+
+    @AllureFeatures.Attachments
+    @Test
+    void shouldExplainExceptionalSituationsForFreeMarketRenderer() throws UnsupportedEncodingException {
+        try {
+            final HttpRequestAttachment data = negativeHttpRequestAttachment();
+            new FreemarkerAttachmentRenderer(TEMPLATE_FOR_EXCEPTION).render(data);
+        } catch (Exception ignored) {
+            // for test purposes
+        }
+        assertThat(sysOutBuffer.toString(StandardCharsets.UTF_8.toString()))
+                .contains("SEVERE: Error executing FreeMarker template")
+                .contains("FreeMarker template error:")
+                .contains("The following has evaluated to null or missing:")
+                .contains("==> data.body")
+                .contains("[in template \"body-npe-non-safe-attachment.ftl\" at line 8, column 11]")
+                .contains("\t- Failed at: ${data.body.size}")
+                .contains("io.qameta.allure.attachment.FreemarkerAttachmentRenderer - HttpRequestAttachment")
+                .contains("\tname=null,")
+                .contains("\turl=null,")
+                .contains("\tbody=null,")
+                .contains("\theaders={},")
+                .contains("\tcookies={}");
+    }
+}

allure-attachments/src/test/java/io/qameta/allure/attachment/testdata/TestData.java

@@ -72,4 +72,17 @@ public static Map<String, String> randomMap() {
         map.put(randomString(), null);
         return map;
     }
+
+    public static HttpRequestAttachment negativeHttpRequestAttachment() {
+        return new HttpRequestAttachment(
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null
+        );
+    }
+
 }

allure-attachments/src/test/resources/tpl/body-npe-non-safe-attachment.ftl

@@ -0,0 +1,36 @@
+<#ftl output_format="HTML">
+<#-- @ftlvariable name="data" type="io.qameta.allure.attachment.http.HttpRequestAttachment" -->
+<div><#if data.method??>${data.method}<#else>GET</#if> to <#if data.url??>${data.url}<#else>Unknown</#if></div>
+
+<h4>Body</h4>
+<div>
+    <pre class="preformatted-text">
+    <#t>${data.body.size}
+    </pre>
+</div>
+
+<#if (data.headers)?has_content>
+    <h4>Headers</h4>
+    <div>
+        <#list data.headers as name, value>
+            <div>${name}: ${value!"null"}</div>
+        </#list>
+    </div>
+</#if>
+
+
+<#if (data.cookies)?has_content>
+    <h4>Cookies</h4>
+    <div>
+        <#list data.cookies as name, value>
+            <div>${name}: ${value!"null"}</div>
+        </#list>
+    </div>
+</#if>
+
+<#if data.curl??>
+    <h4>Curl</h4>
+    <div>
+        ${data.curl}
+    </div>
+</#if>

allure-java-commons/src/main/java/io/qameta/allure/util/ObjectUtils.java

@@ -19,7 +19,9 @@
 import org.slf4j.LoggerFactory;
 
 import java.util.Arrays;
+import java.util.Map;
 import java.util.Objects;
+import java.util.stream.Collectors;
 
 /**
  * @author charlie (Dmitry Baev).
@@ -76,4 +78,14 @@ public static String toString(final Object object) {
             return "<NPE>";
         }
     }
+
+    public static String mapToString(final Map<String, String> map) {
+        if (map == null || map.isEmpty()) {
+            return "{}";
+        }
+        return map.keySet()
+                .stream()
+                .map(key -> key + "=" + map.get(key))
+                .collect(Collectors.joining(",", "{", "}"));
+    }
 }