ru.yandex.qatools.allure.experimental

Class LifecycleListener

java.lang.Object

ru.yandex.qatools.allure.experimental.LifecycleListener

Direct Known Subclasses:

ListenersNotifier

public abstract class LifecycleListener
extends Object

Warning: Experimental Allure feature. Can be removed in next releases.

If you need to respond to the Allure events during test run, extend LifecycleListener and override the appropriate methods. If a listener throws an exception while processing a Allure event, it will be removed for the remainder of the test run.

An example, if you want to log each step, you could write:

 public class EachStepLogger extends LifecycleListener {

     private Deque names = new LinkedList<>();

     @Override
     public void fire(StepStartedEvent event) {
         names.push(event.getName());
         System.out.println(getOffset() + "step started " + names.getFirst());
     }

     @Override
     public void fire(StepFinishedEvent event) {
         System.out.println(getOffset() + "step finished " + names.poll());
     }

     private String getOffset() {
         return new String(new char[names.size() == 0 ? 0 : names.size() - 1]).replaceAll("\0", "   ");
     }
 }
 

To add your listener you should use Java SPI https://docs.oracle.com/javase/tutorial/ext/basics/spi.html or Allure.addListener(LifecycleListener) method

All listener methods will be invoked after event processing. Do not change given events, it can affect others listeners.

Constructor Summary

Constructors

Constructor and Description
LifecycleListener()

Method Summary

Modifier and Type	Method and Description
void	fire(ClearStepStorageEvent event) Called when Allure clear current step context.
void	fire(ClearTestStorageEvent event) Called when Allure clear current test case context.
void	fire(StepEvent event) Called when Allure process any custom step event, such as MakeAttachmentEvent
void	fire(StepFinishedEvent event) Called when a step finished
void	fire(StepStartedEvent event) Called when a step started
void	fire(TestCaseEvent event) Called when Allure process any custom test case event, such as AddParameterEvent
void	fire(TestCaseFinishedEvent event) Called when a test case finished
void	fire(TestCaseStartedEvent event) Called when a test case started
void	fire(TestSuiteEvent event) Called when Allure process any custom test suite event
void	fire(TestSuiteFinishedEvent event) Called when a test suite finished

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleListener

public LifecycleListener()

Method Detail

fire

public void fire(StepStartedEvent event)

Called when a step started

fire

public void fire(StepEvent event)

Called when Allure process any custom step event, such as MakeAttachmentEvent

fire

public void fire(StepFinishedEvent event)

Called when a step finished

fire

public void fire(TestCaseStartedEvent event)

Called when a test case started

fire

public void fire(TestCaseEvent event)

Called when Allure process any custom test case event, such as AddParameterEvent

fire

public void fire(TestCaseFinishedEvent event)

Called when a test case finished

fire

public void fire(TestSuiteEvent event)

Called when Allure process any custom test suite event

fire

public void fire(TestSuiteFinishedEvent event)

Called when a test suite finished

fire

public void fire(ClearStepStorageEvent event)

Called when Allure clear current step context.

fire

public void fire(ClearTestStorageEvent event)

Called when Allure clear current test case context.