#19 ExtentSparkReporter

Author: anshooarora

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.aventstack</groupId>
 	<artifactId>extentreports</artifactId>
-	<version>4.0.6</version>
+	<version>4.0.7-SNAPSHOT</version>
 
 	<name>extentreports</name>
 	<url>www.extentreports.com</url>

src/main/java/com/aventstack/extentreports/ExtentTest.java

@@ -1104,14 +1104,14 @@ public ExtentTest assignAuthor(String... author) {
      */
     public ExtentTest assignDevice(String... device) {
     	Arrays.stream(device)
-		.filter(StringUtil::isNotNullOrEmpty)
-		.forEach(x -> {
-			Device d = new Device(x.replace(" ", ""));
-			test.setDevice(d);
-			extent.assignDevice(test, d);
-		}
-	);
-    return this;
+    		.filter(StringUtil::isNotNullOrEmpty)
+    		.forEach(x -> {
+    			Device d = new Device(x.replace(" ", ""));
+    			test.setDevice(d);
+    			extent.assignDevice(test, d);
+    		}
+    	);
+        return this;
     }
 
     @Override

src/main/java/com/aventstack/extentreports/model/Media.java

@@ -4,6 +4,8 @@
 
 import org.bson.types.ObjectId;
 
+import com.aventstack.extentreports.utils.FileUtil;
+
 public class Media 
 	implements Serializable {
 
@@ -18,6 +20,7 @@ public class Media
     private String path;
     private String base64String;
     private int seq;
+    private long fileSize = 0;
 
     private MediaType mediaType;
 
@@ -71,12 +74,23 @@ protected String getDescription() {
 
     public void setPath(String path) {
         this.path = path;
+        setFileSize(FileUtil.getFileSize(path));
+        if (getName() == null || getName().isEmpty())
+            setName(FileUtil.getFileName(path)); 
     }
 
     public String getPath() { 
     	return path; 
 	}
 
+    public long getFileSize() {
+        return fileSize;
+    }
+
+    public void setFileSize(long fileSize) {
+        this.fileSize = fileSize;
+    }
+
     public void setMediaType(MediaType mediaType) {
         this.mediaType = mediaType;
     }

src/main/java/com/aventstack/extentreports/model/ScreenCapture.java

@@ -16,7 +16,7 @@ public String getSourceWithIcon() {
         return "<a href='#' class='indigo badge' data-featherlight='" + getScreenCapturePath() + "'>img</a>";
     }
 
-    private String getScreenCapturePath() {
+    public String getScreenCapturePath() {
         return getPath() != null ? getPath() : getBase64String();
     }
 

src/main/java/com/aventstack/extentreports/model/Test.java

@@ -348,6 +348,10 @@ public String getHierarchicalName() {
     	return hierarchicalName; 
 	}
 
+    public boolean hasAttributes() {
+        return hasAuthor() || hasCategory() || hasDevice();
+    }
+    
     public AbstractStructure<TestAttribute> getCategoryContext() {
         if (category == null) {
             category = new AbstractStructure<>();

src/main/java/com/aventstack/extentreports/reporter/ExtentSparkReporter.java

@@ -0,0 +1,77 @@
+package com.aventstack.extentreports.reporter;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import com.aventstack.extentreports.ReportAggregates;
+import com.aventstack.extentreports.reporter.configuration.ExtentSparkReporterConfiguration;
+
+import freemarker.template.Template;
+import freemarker.template.TemplateException;
+
+/**
+ * The ExtentSparkReporter creates a rich standalone spark file. It allows several
+ * configuration options via the <code>config()</code> method.
+ */
+public class ExtentSparkReporter extends BasicFileReporter {
+
+    private static final Logger logger = Logger.getLogger(ExtentSparkReporter.class.getName());
+    private static final String REPORTER_NAME = "spark";
+    private static final String TEST_TEMPLATE_NAME = REPORTER_NAME + "/test.ftl";
+    private static final String TAG_TEMPLATE_NAME = REPORTER_NAME + "/tag.ftl";
+    private static final String EXCEPTION_TEMPLATE_NAME = REPORTER_NAME + "/exception.ftl";
+    private static final String DASHBOARD_TEMPLATE_NAME = REPORTER_NAME + "/dashboard.ftl";
+    private static final String[] DEFAULT_CONFIG_FILE_PATH = new String[] { "spark.properties",
+            "src/main/resources/spark.properties" };
+
+    private ExtentSparkReporterConfiguration userConfig = new ExtentSparkReporterConfiguration(this);
+
+    public ExtentSparkReporter(String path) {
+        super(path);
+        init(DEFAULT_CONFIG_FILE_PATH, config());
+    }
+
+    public ExtentSparkReporter(File file) {
+        super(file);
+        init(DEFAULT_CONFIG_FILE_PATH, config());
+    }
+
+    public ExtentSparkReporterConfiguration config() {
+        return userConfig;
+    }
+
+    @Override
+    public synchronized void flush(ReportAggregates reportAggregates) {
+        super.flush(reportAggregates);
+
+        if (getTestList().isEmpty())
+            return;
+
+        loadUserConfig();
+
+        try {
+            Template template = getFreemarkerConfig().getTemplate(TEST_TEMPLATE_NAME);
+            processTemplate(template, new File(destination + "index.html"));
+            if (!getCategoryContextInfo().getTestAttributeTestContextList().isEmpty()) {
+                template = getFreemarkerConfig().getTemplate(TAG_TEMPLATE_NAME);
+                processTemplate(template, new File(destination + "tag.html"));
+            }
+            if (!getExceptionContextInfo().getExceptionTestContextList().isEmpty()) {
+                template = getFreemarkerConfig().getTemplate(EXCEPTION_TEMPLATE_NAME);
+                processTemplate(template, new File(destination + "exception.html"));
+            }
+            template = getFreemarkerConfig().getTemplate(DASHBOARD_TEMPLATE_NAME);
+            processTemplate(template, new File(destination + "dashboard.html"));
+        } catch (IOException | TemplateException e) {
+            logger.log(Level.SEVERE, "An exception occurred", e);
+        }
+    }
+
+    @Override
+    public String getReporterName() {
+        return REPORTER_NAME;
+    }
+
+}

src/main/java/com/aventstack/extentreports/reporter/configuration/ExtentSparkReporterConfiguration.java

@@ -0,0 +1,15 @@
+package com.aventstack.extentreports.reporter.configuration;
+
+import com.aventstack.extentreports.reporter.ExtentSparkReporter;
+
+/**
+ * Defines configuration settings for the Spark reporter
+ */
+public class ExtentSparkReporterConfiguration 
+	extends RichViewReporterConfiguration {
+
+    public ExtentSparkReporterConfiguration(ExtentSparkReporter reporter) {
+		super(reporter);
+	}
+
+}

src/main/java/com/aventstack/extentreports/utils/FileUtil.java

@@ -8,6 +8,16 @@
 public class FileUtil {
 
     private FileUtil() { }
+
+    public static String getFileName(File f) {
+        if (f == null || !f.exists())
+            return "";
+        return f.getName();
+    }
+    
+    public static String getFileName(String path) {
+        return getFileName(new File(path));
+    }
 
     public static String getFileNameWithoutExtension(File f) {
         String name = f.getName();
@@ -56,4 +66,11 @@ public static Boolean fileExists(String path) {
     	return f.exists() && !f.isDirectory();
     }
 
+    public static long getFileSize(String path) {
+        if (path == null)
+            return 0;
+        File f = new File(path);
+        return f.exists() ? f.length() : 0;
+    }
+    
 }