net.masterthought.cucumber

Class ReportBuilder

java.lang.Object

net.masterthought.cucumber.ReportBuilder

public class ReportBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Constructor and Description

ReportBuilder(List<String> 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) Configures report that will be used for further generation.

Method Summary

Methods

Modifier and Type	Method and Description
void	generateReports()
String	getBuildNumber()
String	getBuildProject()
boolean	getBuildStatus()
Map<String,String>	getCustomHeader()
List<String>	getJsonFiles()
String	getPluginUrlPath()
File	getReportDirectory()
ReportInformation	getReportInformation()
boolean	isFlashCharts()
boolean	isHighCharts()
static boolean	isParallel()
boolean	isParsingError()
boolean	isRunWithJenkins()
void	setBuildNumber(String buildNumber)
void	setBuildProject(String buildProject)
void	setCustomHeader(Map<String,String> customHeader)
void	setFlashCharts(boolean flashCharts)
void	setHighCharts(boolean highCharts)
static void	setParallel(boolean p)
void	setParsingError(boolean parsingError)
void	setPluginUrlPath(String pluginUrlPath)
void	setReportDirectory(File reportDirectory)
void	setRi(ReportInformation ri)
void	setRunWithJenkins(boolean runWithJenkins)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

ReportBuilder

public ReportBuilder(List<String> 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,
                     org.apache.velocity.exception.VelocityException

Configures report that will be used for further generation.

Parameters:

jsonReports - list of the json files with cucumber results

reportDirectory - where the report should be generated

pluginUrlPath -

buildNumber - number of the build, helpful when report is generated by Jenkins or other CI

buildProject - name of the project for which the report is generated

skippedFails - mark steps with skipped status as failure

pendingFails - mark steps with pending status as failure

undefinedFailsmark - steps with undefined status as failure

missingFailsmark - steps with missing status as failure

flashCharts - set to true when expect to have generated report in Flash technology, false for JavaScript

runWithJenkins - set to true to include additional information in the report such as build number

artifactsEnabled -

artifactConfig -

highCharts -

parallelTesting -

Throws:

IOException

org.apache.velocity.exception.VelocityException

Method Detail

getReportInformation

public ReportInformation getReportInformation()

setRi

public void setRi(ReportInformation ri)

isParallel

public static boolean isParallel()

setParallel

public static void setParallel(boolean p)

getReportDirectory

public File getReportDirectory()

setReportDirectory

public void setReportDirectory(File reportDirectory)

getBuildNumber

public String getBuildNumber()

setBuildNumber

public void setBuildNumber(String buildNumber)

getBuildProject

public String getBuildProject()

setBuildProject

public void setBuildProject(String buildProject)

getPluginUrlPath

public String getPluginUrlPath()

setPluginUrlPath

public void setPluginUrlPath(String pluginUrlPath)

isRunWithJenkins

public boolean isRunWithJenkins()

setRunWithJenkins

public void setRunWithJenkins(boolean runWithJenkins)

isParsingError

public boolean isParsingError()

setParsingError

public void setParsingError(boolean parsingError)

getCustomHeader

public Map<String,String> getCustomHeader()

setCustomHeader

public void setCustomHeader(Map<String,String> customHeader)

isFlashCharts

public boolean isFlashCharts()

setFlashCharts

public void setFlashCharts(boolean flashCharts)

isHighCharts

public boolean isHighCharts()

setHighCharts

public void setHighCharts(boolean highCharts)

getJsonFiles

public List<String> getJsonFiles()

getBuildStatus

public boolean getBuildStatus()

generateReports

public void generateReports()
                     throws IOException,
                            org.apache.velocity.exception.VelocityException

Throws:

IOException

org.apache.velocity.exception.VelocityException