com.cucumber.listener

Class Reporter

java.lang.Object

com.cucumber.listener.Reporter

public class Reporter
extends Object

This class houses few utilities required for the report

Method Summary

Modifier and Type	Method and Description
static void	addScenarioLog(String message) Adds an info message to the current scenario
static void	addScreenCaptureFromPath(String imagePath) Adds the screenshot from the given path to the current step
static void	addScreenCaptureFromPath(String imagePath, String title) Adds the screenshot from the given path with the given title to the current step
static void	addScreenCast(String screenCastPath) Adds the screen cast from the given path to the current step
static void	addStepLog(String message) Adds an info message to the current step
static void	assignAuthor(String... authorName) Sets the author name for the current scenario
static com.aventstack.extentreports.reporter.ExtentHtmlReporter	getExtentHtmlReport() Gets the ExtentHtmlReporter instance created through listener
static com.aventstack.extentreports.ExtentReports	getExtentReport() Gets the ExtentReports instance created through the listener
static void	loadXMLConfig(File file) Loads the XML config file
static void	loadXMLConfig(String xmlPath) Loads the XML config file
static void	setSystemInfo(String key, String value) Sets the system information with the given key value pair
static void	setTestRunnerOutput(List<String> log) Sets the test runner output with the given list of strings
static void	setTestRunnerOutput(String outputMessage) Sets the test runner output with the given string

Methods inherited from class java.lang.Object

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

Method Detail

getExtentHtmlReport

public static com.aventstack.extentreports.reporter.ExtentHtmlReporter getExtentHtmlReport()

Gets the ExtentHtmlReporter instance created through listener

Returns:

The ExtentHtmlReporter instance

getExtentReport

public static com.aventstack.extentreports.ExtentReports getExtentReport()

Gets the ExtentReports instance created through the listener

Returns:

The ExtentReports instance

loadXMLConfig

public static void loadXMLConfig(String xmlPath)

Loads the XML config file

Parameters:

xmlPath - The xml path in string

loadXMLConfig

public static void loadXMLConfig(File file)

Loads the XML config file

Parameters:

file - The file path of the XML

addStepLog

public static void addStepLog(String message)

Adds an info message to the current step

Parameters:

message - The message to be logged to the current step

addScenarioLog

public static void addScenarioLog(String message)

Adds an info message to the current scenario

Parameters:

message - The message to be logged to the current scenario

addScreenCaptureFromPath

public static void addScreenCaptureFromPath(String imagePath)
                                     throws IOException

Adds the screenshot from the given path to the current step

Parameters:

imagePath - The image path

Throws:

IOException - Exception if imagePath is erroneous

addScreenCaptureFromPath

public static void addScreenCaptureFromPath(String imagePath,
                                            String title)
                                     throws IOException

Adds the screenshot from the given path with the given title to the current step

Parameters:

imagePath - The image path

title - The title for the image

Throws:

IOException - Exception if imagePath is erroneous

addScreenCast

public static void addScreenCast(String screenCastPath)
                          throws IOException

Adds the screen cast from the given path to the current step

Parameters:

screenCastPath - The screen cast path

Throws:

IOException - Exception if imagePath is erroneous

setSystemInfo

public static void setSystemInfo(String key,
                                 String value)

Sets the system information with the given key value pair

Parameters:

key - The name of the key

value - The value of the given key

setTestRunnerOutput

public static void setTestRunnerOutput(List<String> log)

Sets the test runner output with the given list of strings

Parameters:

log - The list of string messages

setTestRunnerOutput

public static void setTestRunnerOutput(String outputMessage)

Sets the test runner output with the given string

Parameters:

outputMessage - The message to be shown in the test runner output screen

assignAuthor

public static void assignAuthor(String... authorName)

Sets the author name for the current scenario

Parameters:

authorName - The author name of the current scenario