ru.yandex.qatools.allure

Class Allure

java.lang.Object

ru.yandex.qatools.allure.Allure

public class Allure
extends Object

Allure Java API. Use this class to access to Allure lifecycle

Field Summary

Fields

Modifier and Type	Field and Description
static Allure	LIFECYCLE

Method Summary

Modifier and Type	Method and Description
void	addListener(LifecycleListener listener) Experimental.
void	fire(ClearStepStorageEvent event) This method just clear current step context.
void	fire(ClearTestStorageEvent event) This method just clear current testCase context.
void	fire(StepEvent event) Process any StepEvent.
void	fire(StepFinishedEvent event) Process StepFinishedEvent.
void	fire(StepStartedEvent event) Process StepStartedEvent.
void	fire(TestCaseEvent event) Process TestCaseEvent.
void	fire(TestCaseFinishedEvent event) Process TestCaseFinishedEvent.
void	fire(TestCaseStartedEvent event) Process TestCaseStartedEvent.
void	fire(TestSuiteEvent event) Process TestSuiteEvent.
void	fire(TestSuiteFinishedEvent event) Process TestSuiteFinishedEvent.
String	getVersion() Use this method to get Allure version in runtime.

Methods inherited from class java.lang.Object

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

Field Detail

LIFECYCLE

public static final Allure LIFECYCLE

Method Detail

fire

public void fire(StepStartedEvent event)

Process StepStartedEvent. New step will be created and added to stepStorage.

Parameters:

event - to process

fire

public void fire(StepEvent event)

Process any StepEvent. You can change last added to stepStorage step using this method.

Parameters:

event - to process

fire

public void fire(StepFinishedEvent event)

Process StepFinishedEvent. Change last added to stepStorage step and add it as child of previous step.

Parameters:

event - to process

fire

public void fire(TestCaseStartedEvent event)

Process TestCaseStartedEvent. New testCase will be created and added to suite as child.

Parameters:

event - to process

fire

public void fire(TestCaseEvent event)

Process TestCaseEvent. You can change current testCase context using this method.

Parameters:

event - to process

fire

public void fire(TestCaseFinishedEvent event)

Process TestCaseFinishedEvent. Add steps and attachments from top step from stepStorage to current testCase, then remove testCase and step from stores. Also remove attachments matches removeAttachments config.

Parameters:

event - to process

fire

public void fire(TestSuiteEvent event)

Process TestSuiteEvent. You can use this method to change current testSuite context. Using event.getUid() to access testSuite.

Parameters:

event - to process

fire

public void fire(TestSuiteFinishedEvent event)

Process TestSuiteFinishedEvent. Using event.getUid() to access testSuite. Then remove this suite from storage and marshal testSuite to xml using AllureResultsUtils.writeTestSuiteResult()

Parameters:

event - to process

fire

public void fire(ClearStepStorageEvent event)

This method just clear current step context.

Parameters:

event - will be ignored

fire

public void fire(ClearTestStorageEvent event)

This method just clear current testCase context.

Parameters:

event - will be ignored

addListener

public void addListener(LifecycleListener listener)

Experimental. Can be removed in next releases.

Add specified listener to notifier.

Parameters:

listener - to add

Since:

1.4.0

See Also:

LifecycleListener

getVersion

public String getVersion()

Use this method to get Allure version in runtime. Supported since version 1.3.6

Returns:

current Allure version