Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
net.masterthought.cucumber.ReportBuilder Maven / Gradle / Ivy
package net.masterthought.cucumber;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.URISyntaxException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import net.masterthought.cucumber.charts.FlashChartBuilder;
import net.masterthought.cucumber.charts.JsChartUtil;
import net.masterthought.cucumber.json.Feature;
import net.masterthought.cucumber.util.UnzipUtils;
import net.masterthought.cucumber.util.Util;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.exception.VelocityException;
import org.apache.velocity.tools.generic.EscapeTool;
import com.google.common.base.Charsets;
public class ReportBuilder {
ReportInformation ri;
private File reportDirectory;
private String buildNumber;
private String buildProject;
private String pluginUrlPath;
private boolean flashCharts;
private boolean runWithJenkins;
private boolean artifactsEnabled;
private boolean highCharts;
private boolean parsingError;
//Added to control parallel reports
private static boolean parallel = false;
public static boolean isParallel(){
return parallel;
}
public static void setParallel(boolean p){
parallel = p;
}
public Map getCustomHeader() {
return customHeader;
}
public void setCustomHeader(Map customHeader) {
this.customHeader = customHeader;
}
private Map customHeader;
private final String VERSION = "cucumber-reporting-0.1.0";
/**
* Configures report that will be used for further generation.
*
* @param jsonReports
* list of the json files with cucumber results
* @param reportDirectory
* where the report should be generated
* @param pluginUrlPath
* @param buildNumber
* number of the build, helpful when report is generated by Jenkins or other CI
* @param buildProject
* name of the project for which the report is generated
* @param skippedFails
* mark steps with skipped status as failure
* @param pendingFails
* mark steps with pending status as failure
* @param undefinedFailsmark
* steps with undefined status as failure
* @param missingFailsmark
* steps with missing status as failure
* @param flashCharts
* set to true when expect to have generated report in Flash technology, false for JavaScript
* @param runWithJenkins
* set to true to include additional information in the report such as build number
* @param artifactsEnabled
* @param artifactConfig
* @param highCharts
* @param parallelTesting
* @throws IOException
* @throws VelocityException
*/
public ReportBuilder(List jsonReports, File reportDirectory, String pluginUrlPath, String buildNumber,
String buildProject, boolean skippedFails, boolean pendingFails, boolean undefinedFails,
boolean missingFails, boolean flashCharts, boolean runWithJenkins, boolean artifactsEnabled,
String artifactConfig, boolean highCharts, boolean parallelTesting) throws IOException, VelocityException {
try {
this.reportDirectory = reportDirectory;
this.buildNumber = buildNumber;
this.buildProject = buildProject;
this.pluginUrlPath = getPluginUrlPath(pluginUrlPath);
this.flashCharts = flashCharts;
this.runWithJenkins = runWithJenkins;
this.artifactsEnabled = artifactsEnabled;
this.highCharts = highCharts;
this.parallel = parallelTesting;
ConfigurationOptions configuration = ConfigurationOptions.instance();
configuration.setSkippedFailsBuild(skippedFails);
configuration.setPendingFailsBuild(pendingFails);
configuration.setUndefinedFailsBuild(undefinedFails);
configuration.setMissingFailsBuild(missingFails);
configuration.setArtifactsEnabled(artifactsEnabled);
if (artifactsEnabled) {
ArtifactProcessor artifactProcessor = new ArtifactProcessor(artifactConfig);
configuration.setArtifactConfiguration(artifactProcessor.process());
}
ReportParser reportParser = new ReportParser(jsonReports);
this.ri = new ReportInformation(reportParser.getFeatures());
// whatever happens we want to provide at least error page instead of empty report
} catch (Exception exception) {
parsingError = true;
generateErrorPage(exception);
System.out.println(exception);
}
}
public boolean getBuildStatus() {
return !(ri.getTotalStepsFailed() > 0);
}
public void generateReports() throws IOException, VelocityException {
try {
copyResource("themes", "blue.zip");
if (flashCharts) {
copyResource("charts", "flash_charts.zip");
} else {
copyResource("charts", "js.zip");
}
if (artifactsEnabled) {
copyResource("charts", "codemirror.zip");
}
//Added to correlate feature with each report
setJsonFilesInFeatures();
generateFeatureOverview();
generateFeatureReports();
generateTagReports();
generateTagOverview();
// whatever happens we want to provide at least error page instead of empty report
} catch (Exception exception) {
if (!parsingError) {
generateErrorPage(exception);
System.out.println(exception);
exception.printStackTrace();
}
}
}
private void setJsonFilesInFeatures() {
for (Map.Entry> pairs : ri.getProjectFeatureMap().entrySet()) {
List featureList = pairs.getValue();
for (Feature feature : featureList) {
String jsonFile = pairs.getKey().split("/")[pairs.getKey().split("/").length - 1];
feature.setJsonFile(jsonFile);
}
}
}
public void generateFeatureReports() throws IOException, VelocityException {
for (Map.Entry> pairs : ri.getProjectFeatureMap().entrySet()) {
List featureList = pairs.getValue();
for (Feature feature : featureList) {
VelocityEngine ve = new VelocityEngine();
ve.init(getProperties());
Template featureResult = ve.getTemplate("templates/featureReport.vm");
VelocityContextMap contextMap = VelocityContextMap.of(new VelocityContext());
contextMap.putAll(getGeneralParameters());
contextMap.put("parallel", ReportBuilder.isParallel());
contextMap.put("feature", feature);
contextMap.put("report_status_colour", ri.getReportStatusColour(feature));
contextMap.put("scenarios", feature.getElements().toList());
contextMap.put("time_stamp", ri.timeStamp());
contextMap.put("artifactsEnabled", ConfigurationOptions.instance().artifactsEnabled());
contextMap.put("esc", new EscapeTool());
generateReport(feature.getFileName(), featureResult, contextMap.getVelocityContext());
}
}
}
private void generateFeatureOverview() throws IOException, VelocityException {
VelocityEngine ve = new VelocityEngine();
ve.init(getProperties());
Template featureOverview = ve.getTemplate("templates/featureOverview.vm");
VelocityContextMap contextMap = VelocityContextMap.of(new VelocityContext());
contextMap.putAll(getGeneralParameters());
contextMap.put("features", ri.getFeatures());
contextMap.put("parallel", ReportBuilder.isParallel());
contextMap.put("total_features", ri.getTotalFeatures());
contextMap.put("total_steps", ri.getTotalSteps());
contextMap.put("total_passes", ri.getTotalStepsPassed());
contextMap.put("total_fails", ri.getTotalStepsFailed());
contextMap.put("total_skipped", ri.getTotalStepsSkipped());
contextMap.put("total_pending", ri.getTotalStepsPending());
contextMap.put("total_undefined", ri.getTotalStepsUndefined());
contextMap.put("total_missing", ri.getTotalStepsMissing());
contextMap.put("scenarios_passed", ri.getTotalScenariosPassed());
contextMap.put("scenarios_failed", ri.getTotalScenariosFailed());
contextMap.put("total_scenarios", ri.getTotalScenarios());
if (flashCharts) {
contextMap.put(
"step_data",
FlashChartBuilder.getStepsChart(ri.getTotalStepsPassed(), ri.getTotalStepsFailed(),
ri.getTotalStepsSkipped(), ri.getTotalStepsPending(),
ri.getTotalStepsUndefined(), ri.getTotalStepsMissing()));
contextMap.put(
"scenario_data",
FlashChartBuilder.pieScenariosChart(ri.getTotalScenariosPassed(), ri.getTotalScenariosFailed()));
} else {
JsChartUtil pie = new JsChartUtil();
List stepColours = pie.orderStepsByValue(ri.getTotalStepsPassed(),
ri.getTotalStepsFailed(), ri.getTotalStepsSkipped(), ri.getTotalStepsPending(),
ri.getTotalStepsUndefined(), ri.getTotalStepsMissing());
contextMap.put("step_data", stepColours);
List scenarioColours = pie.orderScenariosByValue(ri.getTotalScenariosPassed(),
ri.getTotalScenariosFailed());
contextMap.put("scenario_data", scenarioColours);
}
contextMap.put("time_stamp", ri.timeStamp());
contextMap.put("total_duration", ri.getTotalDurationAsString());
contextMap.put("flashCharts", flashCharts);
contextMap.put("highCharts", highCharts);
generateReport("feature-overview.html", featureOverview, contextMap.getVelocityContext());
}
public void generateTagReports() throws IOException, VelocityException {
for (TagObject tagObject : ri.getTags()) {
VelocityEngine ve = new VelocityEngine();
ve.init(getProperties());
Template featureResult = ve.getTemplate("templates/tagReport.vm");
VelocityContextMap contextMap = VelocityContextMap.of(new VelocityContext());
contextMap.putAll(getGeneralParameters());
contextMap.put("tag", tagObject);
contextMap.put("time_stamp", ri.timeStamp());
contextMap.put("report_status_colour", ri.getTagReportStatusColour(tagObject));
generateReport(tagObject.getTagName().replace("@", "").trim() + ".html", featureResult, contextMap.getVelocityContext());
contextMap.put("hasCustomHeader", false);
if (customHeader != null && customHeader.get(tagObject.getTagName()) != null) {
contextMap.put("hasCustomHeader", true);
contextMap.put("customHeader", customHeader.get(tagObject.getTagName()));
}
}
}
public void generateTagOverview() throws IOException, VelocityException {
VelocityEngine ve = new VelocityEngine();
ve.init(getProperties());
Template featureOverview = ve.getTemplate("templates/tagOverview.vm");
VelocityContextMap contextMap = VelocityContextMap.of(new VelocityContext());
contextMap.putAll(getGeneralParameters());
contextMap.put("tags", ri.getTags());
contextMap.put("total_tags", ri.getTotalTags());
contextMap.put("total_scenarios", ri.getTotalTagScenarios());
contextMap.put("total_passed_scenarios", ri.getTotalTagScenariosPassed());
contextMap.put("total_failed_scenarios", ri.getTotalTagScenariosFailed());
contextMap.put("total_steps", ri.getTotalTagSteps());
contextMap.put("total_passes", ri.getTotalTagPasses());
contextMap.put("total_fails", ri.getTotalTagFails());
contextMap.put("total_skipped", ri.getTotalTagSkipped());
contextMap.put("total_pending", ri.getTotalTagPending());
contextMap.put("total_undefined", ri.getTotalTagUndefined());
contextMap.put("total_missing", ri.getTotalTagMissing());
contextMap.put("hasCustomHeaders", false);
if (customHeader != null) {
contextMap.put("hasCustomHeaders", true);
contextMap.put("customHeaders", customHeader);
}
contextMap.put("backgrounds", ri.getBackgroundInfo());
if (flashCharts) {
contextMap.put("chart_data", FlashChartBuilder.StackedColumnChart(ri.tagMap));
} else {
if (highCharts) {
contextMap.put("chart_categories", JsChartUtil.getTags(ri.tagMap));
contextMap.put("chart_data", JsChartUtil.generateTagChartDataForHighCharts(ri.tagMap));
} else {
contextMap.put("chart_rows", JsChartUtil.generateTagChartData(ri.tagMap));
}
}
contextMap.put("total_duration", ri.getTotalTagDuration());
contextMap.put("time_stamp", ri.timeStamp());
contextMap.put("flashCharts", flashCharts);
contextMap.put("highCharts", highCharts);
long durationl = ri.getBackgroundInfo().getTotalDuration() + ri.getLongTotalTagDuration();
String duration = Util.formatDuration(durationl);
contextMap.put("total_duration", duration);
generateReport("tag-overview.html", featureOverview, contextMap.getVelocityContext());
}
public void generateErrorPage(Exception exception) throws IOException, VelocityException {
VelocityEngine ve = new VelocityEngine();
ve.init(getProperties());
Template errorPage = ve.getTemplate("templates/errorPage.vm");
VelocityContextMap contextMap = VelocityContextMap.of(new VelocityContext());
contextMap.putAll(getGeneralParameters());
contextMap.put("error_message", exception);
contextMap.put("time_stamp", new SimpleDateFormat("dd-MM-yyyy HH:mm:ss").format(new Date()));
generateReport("feature-overview.html", errorPage, contextMap.getVelocityContext());
}
private void copyResource(String resourceLocation, String resourceName) throws IOException, URISyntaxException {
final File tmpResourcesArchive = File.createTempFile("temp", resourceName + ".zip");
InputStream resourceArchiveInputStream = ReportBuilder.class.getResourceAsStream(resourceLocation + "/" + resourceName);
if (resourceArchiveInputStream == null) {
resourceArchiveInputStream = ReportBuilder.class.getResourceAsStream("/" + resourceLocation + "/" + resourceName);
}
OutputStream resourceArchiveOutputStream = new FileOutputStream(tmpResourcesArchive);
try {
IOUtils.copy(resourceArchiveInputStream, resourceArchiveOutputStream);
} finally {
IOUtils.closeQuietly(resourceArchiveInputStream);
IOUtils.closeQuietly(resourceArchiveOutputStream);
}
UnzipUtils.unzipToFile(tmpResourcesArchive, reportDirectory);
FileUtils.deleteQuietly(tmpResourcesArchive);
}
private String getPluginUrlPath(String path) {
return path.isEmpty() ? "/" : path;
}
private void generateReport(String fileName, Template featureResult, VelocityContext context) throws IOException {
try (FileOutputStream fileStream = new FileOutputStream(new File(reportDirectory, fileName))) {
try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(fileStream, Charsets.UTF_8))) {
featureResult.merge(context, writer);
}
}
}
private Properties getProperties() {
Properties props = new Properties();
props.setProperty("resource.loader", "class");
props.setProperty("class.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
props.setProperty("runtime.log", new File(reportDirectory, "velocity.log").getPath());
return props;
}
private Map getGeneralParameters() {
Map result = new HashMap();
result.put("version", VERSION);
result.put("fromJenkins", runWithJenkins);
result.put("jenkins_base", pluginUrlPath);
result.put("build_project", buildProject);
result.put("build_number", buildNumber);
int previousBuildNumber = -1;
try {
previousBuildNumber = Integer.parseInt(buildNumber);
previousBuildNumber--;
} catch (NumberFormatException e) {
// could not parse build number, probably not valid int value
}
result.put("previous_build_number", previousBuildNumber);
return result;
}
}
