ru.yandex.qatools.allure.storages

Class StepStorage

java.lang.Object

java.lang.ThreadLocal<T>

java.lang.InheritableThreadLocal<Deque<ru.yandex.qatools.allure.model.Step>>

ru.yandex.qatools.allure.storages.StepStorage

public class StepStorage
extends InheritableThreadLocal<Deque<ru.yandex.qatools.allure.model.Step>>

Using to storage information about current step context. How it works:

 create new step storage | root() -> null
 start step1             | step1() -> root() -> null
 finish step1            | root(step1()) -> null
 start step2             | step2() -> root(step1()) -> null
 finish step2            | root(step1() -> step2()) -> null
 ...
 

In the end just get all children of root step. It's step three which you can see in report

See Also:

Allure

Field Summary

Fields

Modifier and Type	Field and Description
static Object	LOCK

Constructor Summary

Constructors

Constructor and Description
StepStorage()

Method Summary

Modifier and Type	Method and Description
ru.yandex.qatools.allure.model.Step	adopt() Move last step to children of previous step.
protected Deque<ru.yandex.qatools.allure.model.Step>	childValue(Deque<ru.yandex.qatools.allure.model.Step> parentValue) In case parent thread spawn thread we need create a new queue for child thread but use the only one root step.
ru.yandex.qatools.allure.model.Step	createRootStep() Construct new root step.
ru.yandex.qatools.allure.model.Step	getLast() Retrieves, but does not remove, the last element of this deque.
protected Deque<ru.yandex.qatools.allure.model.Step>	initialValue() Returns the current thread's "initial value".
ru.yandex.qatools.allure.model.Step	pollLast() Removes the last element of deque in the current thread's copy of this thread-local variable.
void	put(ru.yandex.qatools.allure.model.Step step) Inserts the specified element into the queue represented by this deque

Methods inherited from class java.lang.ThreadLocal

get, remove, set, withInitial

Methods inherited from class java.lang.Object

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

Field Detail

LOCK

public static final Object LOCK

Constructor Detail

StepStorage

public StepStorage()

Method Detail

initialValue

protected Deque<ru.yandex.qatools.allure.model.Step> initialValue()

Returns the current thread's "initial value". Construct an new Deque with root step createRootStep()

Overrides:

initialValue in class ThreadLocal<Deque<ru.yandex.qatools.allure.model.Step>>

Returns:

the initial value for this thread-local

childValue

protected Deque<ru.yandex.qatools.allure.model.Step> childValue(Deque<ru.yandex.qatools.allure.model.Step> parentValue)

In case parent thread spawn thread we need create a new queue for child thread but use the only one root step. In the end all steps will be children of root step, all we need is sync adding steps

Overrides:

childValue in class InheritableThreadLocal<Deque<ru.yandex.qatools.allure.model.Step>>

Parameters:

parentValue - value from parent thread

Returns:

local copy of queue in this thread with parent root as first element

getLast

public ru.yandex.qatools.allure.model.Step getLast()

Retrieves, but does not remove, the last element of this deque.

Returns:

the tail of this deque

put

public void put(ru.yandex.qatools.allure.model.Step step)

Inserts the specified element into the queue represented by this deque

Parameters:

step - the element to add

pollLast

public ru.yandex.qatools.allure.model.Step pollLast()

Removes the last element of deque in the current thread's copy of this thread-local variable. If after this deque is empty add new root step createRootStep()

Returns:

the element removed from deque

adopt

public ru.yandex.qatools.allure.model.Step adopt()

Move last step to children of previous step. How it works:

 before: step1(...) -> step2(child1 -> ... -> childN) -> step3(...) -> ... -> null
 after:  step2(child1 -> ... -> childN -> step1(...)) -> step3(...) -> ... -> null
 

Returns:

ex-last step

createRootStep

public ru.yandex.qatools.allure.model.Step createRootStep()

Construct new root step. Used for inspect problems with Allure lifecycle

Returns:

new root step marked as broken