io.qameta.allure

Class Allure

java.lang.Object

io.qameta.allure.Allure

public final class Allure
extends java.lang.Object

The class contains some useful methods to work with AllureLifecycle.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Allure.StepContext Step context.
static interface	Allure.ThrowableContextRunnable<T,U> Runnable that allows to throw an exception and return any type.
static interface	Allure.ThrowableContextRunnableVoid<T> Callable that allows to throw an exception and return void.
static interface	Allure.ThrowableRunnable<T> Runnable that allows to throw an exception and return any type.
static interface	Allure.ThrowableRunnableVoid Runnable that allows to throw an exception and return void.

Method Summary

Modifier and Type	Method and Description
static void	addAttachment(java.lang.String name, java.io.InputStream content)
static void	addAttachment(java.lang.String name, java.lang.String content)
static void	addAttachment(java.lang.String name, java.lang.String type, java.io.InputStream content, java.lang.String fileExtension)
static void	addAttachment(java.lang.String name, java.lang.String type, java.lang.String content)
static void	addAttachment(java.lang.String name, java.lang.String type, java.lang.String content, java.lang.String fileExtension)
static java.util.concurrent.CompletableFuture<byte[]>	addByteAttachmentAsync(java.lang.String name, java.lang.String type, java.lang.String fileExtension, java.util.function.Supplier<byte[]> body)
static java.util.concurrent.CompletableFuture<byte[]>	addByteAttachmentAsync(java.lang.String name, java.lang.String type, java.util.function.Supplier<byte[]> body)
static void	addDescription(java.lang.String description) Deprecated. use description(String) instead.
static void	addDescriptionHtml(java.lang.String descriptionHtml) Deprecated. use descriptionHtml(String) instead.
static void	addLabels(io.qameta.allure.model.Label... labels) Deprecated. use label(String, String) instead.
static void	addLinks(io.qameta.allure.model.Link... links) Deprecated. use link(String, String, String) instead.
static java.util.concurrent.CompletableFuture<java.io.InputStream>	addStreamAttachmentAsync(java.lang.String name, java.lang.String type, java.lang.String fileExtension, java.util.function.Supplier<java.io.InputStream> body)
static java.util.concurrent.CompletableFuture<java.io.InputStream>	addStreamAttachmentAsync(java.lang.String name, java.lang.String type, java.util.function.Supplier<java.io.InputStream> body)
static void	attachment(java.lang.String name, java.io.InputStream content) Adds attachment.
static void	attachment(java.lang.String name, java.lang.String content) Adds attachment.
static void	description(java.lang.String description) Adds description to current test or step (or fixture) if any.
static void	descriptionHtml(java.lang.String descriptionHtml) Adds descriptionHtml to current test or step (or fixture) if any.
static void	epic(java.lang.String value) Adds epic label to current test or step (or fixture) if any.
static void	feature(java.lang.String value) Adds feature label to current test or step (or fixture) if any.
static AllureLifecycle	getLifecycle() Returns AllureLifecycle for low level operations with results.
static void	issue(java.lang.String name, java.lang.String url) Adds issue link to current test or step (or fixture) if any.
static void	label(java.lang.String name, java.lang.String value) Adds label to current test or step (or fixture) if any.
static void	link(java.lang.String url) Adds link to current test or step (or fixture) if any.
static void	link(java.lang.String name, java.lang.String url) Adds link to current test or step (or fixture) if any.
static void	link(java.lang.String name, java.lang.String type, java.lang.String url) Adds link to current test or step (or fixture) if any.
static <T> T	parameter(java.lang.String name, T value) Adds parameter to current test or step (or fixture) if any.
static void	setLifecycle(AllureLifecycle lifecycle) Sets AllureLifecycle.
static <T> T	step(Allure.ThrowableContextRunnable<T,Allure.StepContext> runnable) Run provided Allure.ThrowableRunnable as step with given name.
static void	step(Allure.ThrowableContextRunnableVoid<Allure.StepContext> runnable) Syntax sugar for step(ThrowableContextRunnable).
static void	step(java.lang.String name) Adds passed step with provided name in current test or step (or test fixture).
static <T> T	step(java.lang.String name, Allure.ThrowableContextRunnable<T,Allure.StepContext> runnable) Syntax sugar for step(ThrowableContextRunnable).
static void	step(java.lang.String name, Allure.ThrowableContextRunnableVoid<Allure.StepContext> runnable) Syntax sugar for step(ThrowableContextRunnable).
static <T> T	step(java.lang.String name, Allure.ThrowableRunnable<T> runnable) Syntax sugar for step(ThrowableContextRunnable).
static void	step(java.lang.String name, Allure.ThrowableRunnableVoid runnable) Syntax sugar for step(String, ThrowableRunnable).
static void	step(java.lang.String name, io.qameta.allure.model.Status status) Adds step with provided name and status in current test or step (or test fixture).
static void	story(java.lang.String value) Adds story label to current test or step (or fixture) if any.
static void	suite(java.lang.String value) Adds suite label to current test or step (or fixture) if any.
static void	tms(java.lang.String name, java.lang.String url) Adds tms link to current test or step (or fixture) if any.

Methods inherited from class java.lang.Object

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

Method Detail

getLifecycle

public static AllureLifecycle getLifecycle()

Returns AllureLifecycle for low level operations with results.

Returns:

the lifecycle.

setLifecycle

public static void setLifecycle(AllureLifecycle lifecycle)

Sets AllureLifecycle.

step

public static void step(java.lang.String name)

Adds passed step with provided name in current test or step (or test fixture). Takes no effect if no test run at the moment. Shortcut for step(String, Status).

Parameters:

name - the name of step.

step

public static void step(java.lang.String name,
                        io.qameta.allure.model.Status status)

Adds step with provided name and status in current test or step (or test fixture). Takes no effect if no test run at the moment.

Parameters:

name - the name of step.

status - the step status.

step

public static void step(java.lang.String name,
                        Allure.ThrowableRunnableVoid runnable)

Syntax sugar for step(String, ThrowableRunnable).

Parameters:

name - the name of step.

runnable - the step's body.

step

public static <T> T step(java.lang.String name,
                         Allure.ThrowableRunnable<T> runnable)

Syntax sugar for step(ThrowableContextRunnable).

Parameters:

name - the name of step.

runnable - the step's body.

step

public static void step(Allure.ThrowableContextRunnableVoid<Allure.StepContext> runnable)

Syntax sugar for step(ThrowableContextRunnable).

Parameters:

runnable - the step's body.

step

public static void step(java.lang.String name,
                        Allure.ThrowableContextRunnableVoid<Allure.StepContext> runnable)

Syntax sugar for step(ThrowableContextRunnable).

Parameters:

name - the name of step.

runnable - the step's body.

step

public static <T> T step(java.lang.String name,
                         Allure.ThrowableContextRunnable<T,Allure.StepContext> runnable)

Syntax sugar for step(ThrowableContextRunnable).

Parameters:

name - the name of step.

runnable - the step's body.

step

public static <T> T step(Allure.ThrowableContextRunnable<T,Allure.StepContext> runnable)

Run provided Allure.ThrowableRunnable as step with given name. Takes no effect if no test run at the moment.

Parameters:

runnable - the step's body.

epic

public static void epic(java.lang.String value)

Adds epic label to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for label(String, String).

Parameters:

value - the value of label.

feature

public static void feature(java.lang.String value)

Adds feature label to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for label(String, String).

Parameters:

value - the value of label.

story

public static void story(java.lang.String value)

Adds story label to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for label(String, String).

Parameters:

value - the value of label.

suite

public static void suite(java.lang.String value)

Adds suite label to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for label(String, String).

Parameters:

value - the value of label.

label

public static void label(java.lang.String name,
                         java.lang.String value)

Adds label to current test or step (or fixture) if any. Takes no effect if no test run at the moment.

Parameters:

name - the name of label.

value - the value of label.

parameter

public static <T> T parameter(java.lang.String name,
                              T value)

Adds parameter to current test or step (or fixture) if any. Takes no effect if no test run at the moment.

Parameters:

name - the name of parameter.

value - the value of parameter.

issue

public static void issue(java.lang.String name,
                         java.lang.String url)

Adds issue link to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for link(String, String, String).

Parameters:

name - the name of link.

url - the link's url.

tms

public static void tms(java.lang.String name,
                       java.lang.String url)

Adds tms link to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for link(String, String, String).

Parameters:

name - the name of link.

url - the link's url.

link

public static void link(java.lang.String url)

Adds link to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for link(String, String)

Parameters:

url - the link's url.

link

public static void link(java.lang.String name,
                        java.lang.String url)

Adds link to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Shortcut for link(String, String, String)

Parameters:

name - the name of link.

url - the link's url.

link

public static void link(java.lang.String name,
                        java.lang.String type,
                        java.lang.String url)

Adds link to current test or step (or fixture) if any. Takes no effect if no test run at the moment.

Parameters:

name - the name of link.

type - the type of link, used to display link icon in the report.

url - the link's url.

description

public static void description(java.lang.String description)

Adds description to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Expecting description provided in Markdown format.

Parameters:

description - the description in markdown format.

See Also:

descriptionHtml(String)

descriptionHtml

public static void descriptionHtml(java.lang.String descriptionHtml)

Adds descriptionHtml to current test or step (or fixture) if any. Takes no effect if no test run at the moment. Note that description will take no effect if descriptionHtml is specified.

Parameters:

descriptionHtml - the description in html format.

See Also:

description(String)

attachment

public static void attachment(java.lang.String name,
                              java.lang.String content)

Adds attachment.

Parameters:

name - the name of attachment.

content - the attachment content.

attachment

public static void attachment(java.lang.String name,
                              java.io.InputStream content)

Adds attachment.

Parameters:

name - the name of attachment.

content - the stream that contains attachment content.

addLabels

@Deprecated
public static void addLabels(io.qameta.allure.model.Label... labels)

Deprecated. use label(String, String) instead.

addLinks

@Deprecated
public static void addLinks(io.qameta.allure.model.Link... links)

Deprecated. use link(String, String, String) instead.

addDescription

@Deprecated
public static void addDescription(java.lang.String description)

Deprecated. use description(String) instead.

addDescriptionHtml

@Deprecated
public static void addDescriptionHtml(java.lang.String descriptionHtml)

Deprecated. use descriptionHtml(String) instead.

addAttachment

public static void addAttachment(java.lang.String name,
                                 java.lang.String content)

addAttachment

public static void addAttachment(java.lang.String name,
                                 java.lang.String type,
                                 java.lang.String content)

addAttachment

public static void addAttachment(java.lang.String name,
                                 java.lang.String type,
                                 java.lang.String content,
                                 java.lang.String fileExtension)

addAttachment

public static void addAttachment(java.lang.String name,
                                 java.io.InputStream content)

addAttachment

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

addByteAttachmentAsync

public static java.util.concurrent.CompletableFuture<byte[]> addByteAttachmentAsync(java.lang.String name,
                                                                                    java.lang.String type,
                                                                                    java.util.function.Supplier<byte[]> body)

addByteAttachmentAsync

public static java.util.concurrent.CompletableFuture<byte[]> addByteAttachmentAsync(java.lang.String name,
                                                                                    java.lang.String type,
                                                                                    java.lang.String fileExtension,
                                                                                    java.util.function.Supplier<byte[]> body)

addStreamAttachmentAsync

public static java.util.concurrent.CompletableFuture<java.io.InputStream> addStreamAttachmentAsync(java.lang.String name,
                                                                                                   java.lang.String type,
                                                                                                   java.util.function.Supplier<java.io.InputStream> body)

addStreamAttachmentAsync

public static java.util.concurrent.CompletableFuture<java.io.InputStream> addStreamAttachmentAsync(java.lang.String name,
                                                                                                   java.lang.String type,
                                                                                                   java.lang.String fileExtension,
                                                                                                   java.util.function.Supplier<java.io.InputStream> body)