io.qameta.allure

Class AllureLifecycle

java.lang.Object

io.qameta.allure.AllureLifecycle

public class AllureLifecycle
extends java.lang.Object

The class contains Allure context and methods to change it.

Constructor Summary

Constructors

Constructor and Description
AllureLifecycle() Creates a new lifecycle with default results writer.
AllureLifecycle(AllureResultsWriter writer) Creates a new lifecycle instance with specified AllureResultsWriter.

Method Summary

Modifier and Type	Method and Description
void	addAttachment(java.lang.String name, java.lang.String type, java.lang.String fileExtension, byte[] body) Adds attachment into current test or step if any exists.
void	addAttachment(java.lang.String name, java.lang.String type, java.lang.String fileExtension, java.io.InputStream stream) Adds attachment to current running test or step.
java.util.Optional<java.lang.String>	getCurrentTestCase() Returns uuid of current running test case if any.
java.util.Optional<java.lang.String>	getCurrentTestCaseOrStep() Returns uuid of current running test case or step if any.
java.lang.String	prepareAttachment(java.lang.String name, java.lang.String type, java.lang.String fileExtension) Adds attachment to current running test or step, and returns source.
void	scheduleTestCase(java.lang.String containerUuid, io.qameta.allure.model.TestResult result) Schedules test case with given parent.
void	scheduleTestCase(io.qameta.allure.model.TestResult result) Schedule given test case.
boolean	setCurrentTestCase(java.lang.String uuid) Sets specified test case uuid as current.
void	startPrepareFixture(java.lang.String containerUuid, java.lang.String uuid, io.qameta.allure.model.FixtureResult result) Start a new prepare fixture with given parent.
void	startStep(java.lang.String uuid, io.qameta.allure.model.StepResult result) Start a new step as child step of current running test case or step.
void	startStep(java.lang.String parentUuid, java.lang.String uuid, io.qameta.allure.model.StepResult result) Start a new step as child of specified parent.
void	startTearDownFixture(java.lang.String containerUuid, java.lang.String uuid, io.qameta.allure.model.FixtureResult result) Start a new tear down fixture with given parent.
void	startTestCase(java.lang.String uuid) Starts test case with given uuid.
void	startTestContainer(java.lang.String containerUuid, io.qameta.allure.model.TestResultContainer container) Starts test container with specified parent container.
void	startTestContainer(io.qameta.allure.model.TestResultContainer container) Starts test container.
void	stopFixture(java.lang.String uuid) Stops fixture by given uuid.
void	stopStep() Stops current running step.
void	stopStep(java.lang.String uuid) Stops step by given uuid.
void	stopTestCase(java.lang.String uuid) Stops test case by given uuid.
void	stopTestContainer(java.lang.String uuid) Stops test container by given uuid.
void	updateFixture(java.util.function.Consumer<io.qameta.allure.model.FixtureResult> update) Updates current running fixture.
void	updateFixture(java.lang.String uuid, java.util.function.Consumer<io.qameta.allure.model.FixtureResult> update) Updates fixture by given uuid.
void	updateStep(java.util.function.Consumer<io.qameta.allure.model.StepResult> update) Updates current step.
void	updateStep(java.lang.String uuid, java.util.function.Consumer<io.qameta.allure.model.StepResult> update) Updates step by specified uuid.
void	updateTestCase(java.util.function.Consumer<io.qameta.allure.model.TestResult> update) Shortcut for updateTestCase(String, Consumer) for current running test case uuid.
void	updateTestCase(java.lang.String uuid, java.util.function.Consumer<io.qameta.allure.model.TestResult> update) Updates test case by given uuid.
void	updateTestContainer(java.lang.String uuid, java.util.function.Consumer<io.qameta.allure.model.TestResultContainer> update) Updates test container.
void	writeAttachment(java.lang.String attachmentSource, java.io.InputStream stream) Writes attachment with specified source.
void	writeTestCase(java.lang.String uuid) Writes test case with given uuid using configured AllureResultsWriter.
void	writeTestContainer(java.lang.String uuid) Writes test container with given uuid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllureLifecycle

public AllureLifecycle()

Creates a new lifecycle with default results writer. Shortcut for AllureLifecycle(AllureResultsWriter)

AllureLifecycle

public AllureLifecycle(AllureResultsWriter writer)

Creates a new lifecycle instance with specified AllureResultsWriter.

Parameters:

writer - the results writer.

Method Detail

startTestContainer

public void startTestContainer(java.lang.String containerUuid,
                               io.qameta.allure.model.TestResultContainer container)

Starts test container with specified parent container.

Parameters:

containerUuid - the uuid of parent container.

container - the container.

startTestContainer

public void startTestContainer(io.qameta.allure.model.TestResultContainer container)

Starts test container.

Parameters:

container - the container.

updateTestContainer

public void updateTestContainer(java.lang.String uuid,
                                java.util.function.Consumer<io.qameta.allure.model.TestResultContainer> update)

Updates test container.

Parameters:

uuid - the uuid of container.

update - the update function.

stopTestContainer

public void stopTestContainer(java.lang.String uuid)

Stops test container by given uuid.

Parameters:

uuid - the uuid of container.

writeTestContainer

public void writeTestContainer(java.lang.String uuid)

Writes test container with given uuid.

Parameters:

uuid - the uuid of container.

startPrepareFixture

public void startPrepareFixture(java.lang.String containerUuid,
                                java.lang.String uuid,
                                io.qameta.allure.model.FixtureResult result)

Start a new prepare fixture with given parent.

Parameters:

containerUuid - the uuid of parent container.

uuid - the fixture uuid.

result - the fixture.

startTearDownFixture

public void startTearDownFixture(java.lang.String containerUuid,
                                 java.lang.String uuid,
                                 io.qameta.allure.model.FixtureResult result)

Start a new tear down fixture with given parent.

Parameters:

containerUuid - the uuid of parent container.

uuid - the fixture uuid.

result - the fixture.

updateFixture

public void updateFixture(java.util.function.Consumer<io.qameta.allure.model.FixtureResult> update)

Updates current running fixture. Shortcut for updateFixture(String, Consumer).

Parameters:

update - the update function.

updateFixture

public void updateFixture(java.lang.String uuid,
                          java.util.function.Consumer<io.qameta.allure.model.FixtureResult> update)

Updates fixture by given uuid.

Parameters:

uuid - the uuid of fixture.

update - the update function.

stopFixture

public void stopFixture(java.lang.String uuid)

Stops fixture by given uuid.

Parameters:

uuid - the uuid of fixture.

getCurrentTestCase

public java.util.Optional<java.lang.String> getCurrentTestCase()

Returns uuid of current running test case if any.

Returns:

the uuid of current running test case.

getCurrentTestCaseOrStep

public java.util.Optional<java.lang.String> getCurrentTestCaseOrStep()

Returns uuid of current running test case or step if any.

Returns:

the uuid of current running test case or step.

setCurrentTestCase

public boolean setCurrentTestCase(java.lang.String uuid)

Sets specified test case uuid as current. Note that test case with such uuid should be created and existed in storage, otherwise method take no effect.

Parameters:

uuid - the uuid of test case.

Returns:

true if current test case was configured successfully, false otherwise.

scheduleTestCase

public void scheduleTestCase(java.lang.String containerUuid,
                             io.qameta.allure.model.TestResult result)

Schedules test case with given parent.

Parameters:

containerUuid - the uuid of container.

result - the test case to schedule.

scheduleTestCase

public void scheduleTestCase(io.qameta.allure.model.TestResult result)

Schedule given test case.

Parameters:

result - the test case to schedule.

startTestCase

public void startTestCase(java.lang.String uuid)

Starts test case with given uuid. In order to start test case it should be scheduled at first.

Parameters:

uuid - the uuid of test case to start.

updateTestCase

public void updateTestCase(java.util.function.Consumer<io.qameta.allure.model.TestResult> update)

Shortcut for updateTestCase(String, Consumer) for current running test case uuid.

Parameters:

update - the update function.

updateTestCase

public void updateTestCase(java.lang.String uuid,
                           java.util.function.Consumer<io.qameta.allure.model.TestResult> update)

Updates test case by given uuid.

Parameters:

uuid - the uuid of test case to update.

update - the update function.

stopTestCase

public void stopTestCase(java.lang.String uuid)

Stops test case by given uuid. Test case marked as Stage.FINISHED and also stop timestamp is calculated. Result would be stored in memory until writeTestCase(String) method is called. Also stopped test case could be updated by updateTestCase(String, Consumer) method.

Parameters:

uuid - the uuid of test case to stop.

writeTestCase

public void writeTestCase(java.lang.String uuid)

Writes test case with given uuid using configured AllureResultsWriter.

Parameters:

uuid - the uuid of test case to write.

startStep

public void startStep(java.lang.String uuid,
                      io.qameta.allure.model.StepResult result)

Start a new step as child step of current running test case or step. Shortcut for startStep(String, String, StepResult).

Parameters:

uuid - the uuid of step.

result - the step.

startStep

public void startStep(java.lang.String parentUuid,
                      java.lang.String uuid,
                      io.qameta.allure.model.StepResult result)

Start a new step as child of specified parent.

Parameters:

parentUuid - the uuid of parent test case or step.

uuid - the uuid of step.

result - the step.

updateStep

public void updateStep(java.util.function.Consumer<io.qameta.allure.model.StepResult> update)

Updates current step. Shortcut for updateStep(String, Consumer).

Parameters:

update - the update function.

updateStep

public void updateStep(java.lang.String uuid,
                       java.util.function.Consumer<io.qameta.allure.model.StepResult> update)

Updates step by specified uuid.

Parameters:

uuid - the uuid of step.

update - the update function.

stopStep

public void stopStep()

Stops current running step. Shortcut for stopStep(String).

stopStep

public void stopStep(java.lang.String uuid)

Stops step by given uuid.

Parameters:

uuid - the uuid of step to stop.

addAttachment

public void addAttachment(java.lang.String name,
                          java.lang.String type,
                          java.lang.String fileExtension,
                          byte[] body)

Adds attachment into current test or step if any exists. Shortcut for addAttachment(String, String, String, InputStream)

Parameters:

name - the name of attachment

type - the content type of attachment

fileExtension - the attachment file extension

body - attachment content

addAttachment

public void addAttachment(java.lang.String name,
                          java.lang.String type,
                          java.lang.String fileExtension,
                          java.io.InputStream stream)

Adds attachment to current running test or step.

Parameters:

name - the name of attachment

type - the content type of attachment

fileExtension - the attachment file extension

stream - attachment content

prepareAttachment

public java.lang.String prepareAttachment(java.lang.String name,
                                          java.lang.String type,
                                          java.lang.String fileExtension)

Adds attachment to current running test or step, and returns source. In order to store attachment content use writeAttachment(String, InputStream) method.

Parameters:

name - the name of attachment

type - the content type of attachment

fileExtension - the attachment file extension

Returns:

the source of added attachment

writeAttachment

public void writeAttachment(java.lang.String attachmentSource,
                            java.io.InputStream stream)

Writes attachment with specified source.

Parameters:

attachmentSource - the source of attachment.

stream - the attachment content.