Package com.trivago.cluecumber.engine

Class CluecumberEngine

java.lang.Object

com.trivago.cluecumber.engine.CluecumberEngine

public final class CluecumberEngine
extends Object

The main plugin class.

Constructor Summary

Constructors

Constructor	Description
CluecumberEngine(CluecumberLogger logger, PropertyManager propertyManager, FileSystemManager fileSystemManager, FileIO fileIO, JsonPojoConverter jsonPojoConverter, ElementIndexPreProcessor elementIndexPreProcessor, ReportGenerator reportGenerator)

Method Summary

Modifier and Type	Method	Description
void	build(String sourceJsonReportDirectory, String generatedHtmlReportDirectory)	Cluecumber Report start method.
void	setCustomCssFile(String customCss)
void	setCustomNavigationLinks(LinkedHashMap<String,String> customNavigationLinks)
void	setCustomPageTitle(String customPageTitle)
void	setCustomParameters(LinkedHashMap<String,String> customParameters)
void	setCustomParametersDisplayMode(String customParametersDisplayMode)
void	setCustomParametersFile(String customParametersFile)
void	setCustomStatusColorFailed(String customStatusColorFailed)
void	setCustomStatusColorPassed(String customStatusColorPassed)
void	setCustomStatusColorSkipped(String customStatusColorSkipped)
void	setExpandAttachments(boolean expandAttachments)
void	setExpandBeforeAfterHooks(boolean expandBeforeAfterHooks)
void	setExpandDocStrings(boolean expandDocStrings)
void	setExpandStepHooks(boolean expandStepHooks)
void	setFailScenariosOnPendingOrUndefinedSteps(boolean failScenariosOnPendingOrUndefinedSteps)
void	setLogLevel(String logLevel)
void	setStartPage(String startPage)

Methods inherited from class java.lang.Object

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

Constructor Detail

CluecumberEngine

@Inject
public CluecumberEngine(CluecumberLogger logger,
                        PropertyManager propertyManager,
                        FileSystemManager fileSystemManager,
                        FileIO fileIO,
                        JsonPojoConverter jsonPojoConverter,
                        ElementIndexPreProcessor elementIndexPreProcessor,
                        ReportGenerator reportGenerator)

Method Detail

build

public void build(String sourceJsonReportDirectory,
                  String generatedHtmlReportDirectory)
           throws CluecumberException

Cluecumber Report start method.

Throws:

CluecumberException - When thrown, the plugin execution is stopped.

setCustomParameters

public void setCustomParameters(LinkedHashMap<String,String> customParameters)

setCustomParametersFile

public void setCustomParametersFile(String customParametersFile)
                             throws CluecumberException

Throws:

CluecumberException

setCustomParametersDisplayMode

public void setCustomParametersDisplayMode(String customParametersDisplayMode)

setCustomNavigationLinks

public void setCustomNavigationLinks(LinkedHashMap<String,String> customNavigationLinks)

setFailScenariosOnPendingOrUndefinedSteps

public void setFailScenariosOnPendingOrUndefinedSteps(boolean failScenariosOnPendingOrUndefinedSteps)

setExpandBeforeAfterHooks

public void setExpandBeforeAfterHooks(boolean expandBeforeAfterHooks)

setExpandStepHooks

public void setExpandStepHooks(boolean expandStepHooks)

setExpandDocStrings

public void setExpandDocStrings(boolean expandDocStrings)

setExpandAttachments

public void setExpandAttachments(boolean expandAttachments)

setCustomCssFile

public void setCustomCssFile(String customCss)
                      throws MissingFileException

Throws:

MissingFileException

setCustomStatusColorPassed

public void setCustomStatusColorPassed(String customStatusColorPassed)
                                throws WrongOrMissingPropertyException

Throws:

WrongOrMissingPropertyException

setCustomStatusColorFailed

public void setCustomStatusColorFailed(String customStatusColorFailed)
                                throws WrongOrMissingPropertyException

Throws:

WrongOrMissingPropertyException

setCustomStatusColorSkipped

public void setCustomStatusColorSkipped(String customStatusColorSkipped)
                                 throws WrongOrMissingPropertyException

Throws:

WrongOrMissingPropertyException

setCustomPageTitle

public void setCustomPageTitle(String customPageTitle)

setStartPage

public void setStartPage(String startPage)

setLogLevel

public void setLogLevel(String logLevel)