com.aventstack.extentreports.reporter.ExtentHtmlReporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extentreports Show documentation

ExtentReports library

There is a newer version: 5.1.2

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.ExtentHtmlReporterConfiguration;

import freemarker.template.Template;
import freemarker.template.TemplateException;

/**
 * The ExtentHtmlReporter creates a rich standalone HTML file. It allows several configuration options
 * via the config() method.
 */
public class ExtentHtmlReporter 
	extends BasicFileReporter {
    
    private static final Logger logger = Logger.getLogger(ExtentHtmlReporter.class.getName());
    private static final String REPORTER_NAME = "html";
    private static final String TEMPLATE_NAME = "v3html/v3-html-index.ftl";
    private static final String[] DEFAULT_CONFIG_FILE_PATH = new String[] {
    		"html.properties", 
    		"src/main/resources/html.properties"};

    private ExtentHtmlReporterConfiguration userConfig = new ExtentHtmlReporterConfiguration(this);

    
    public ExtentHtmlReporter(String path) {
        super(path);
        init(DEFAULT_CONFIG_FILE_PATH, config());
    }
    
    public ExtentHtmlReporter(File file) {
    	super(file);
    	init(DEFAULT_CONFIG_FILE_PATH, config());
    }
    
    public ExtentHtmlReporterConfiguration config() {
        return userConfig;
    }

    @Override
    public synchronized void flush(ReportAggregates reportAggregates) {
    	super.flush(reportAggregates);
    	
        if (getTestList().isEmpty())
            return;
        
        loadUserConfig();
        
        try {
            Template template = getFreemarkerConfig().getTemplate(TEMPLATE_NAME);
            processTemplate(template, new File(filePath));
        } catch (IOException | TemplateException e) {
            logger.log(Level.SEVERE, "An exception occurred", e);
        }
    }
    
	@Override
	public String getReporterName() {
		return REPORTER_NAME;
	}

}