com.epam.reportportal.service

Class Launch

java.lang.Object

com.epam.reportportal.service.Launch

Direct Known Subclasses:

LaunchImpl

public abstract class Launch
extends java.lang.Object

Launch object represents a lifecycle of a Launch on ReportPortal. It is used to manipulate its state: starting, finishing, adding test results.

Field Summary

Fields

Modifier and Type	Field and Description
protected ReportPortalClient	client
static Launch	NOOP_LAUNCH Implementation for disabled Reporting
static com.epam.ta.reportportal.ws.model.issue.Issue	NOT_ISSUE An Issue to remove 'To Investigate' mark from a skipped/failed Test Item

Method Summary

Modifier and Type	Method and Description
static Launch	currentLaunch() Returns a current launch in a link to the current thread.
abstract void	finish(com.epam.ta.reportportal.ws.model.FinishExecutionRQ rq) Finishes launch in ReportPortal.
abstract io.reactivex.Maybe<com.epam.ta.reportportal.ws.model.OperationCompletionRS>	finishTestItem(io.reactivex.Maybe<java.lang.String> itemId, com.epam.ta.reportportal.ws.model.FinishTestItemRQ rq) Finishes Test Item in ReportPortal.
ReportPortalClient	getClient() Returns ReportPortal client for the launch.
abstract io.reactivex.Maybe<java.lang.String>	getLaunch() Returns current launch UUID Maybe, empty if the launch is not started.
ListenerParameters	getParameters()
StepReporter	getStepReporter() Returns Nested Step reporter for the current launch.
abstract io.reactivex.Maybe<java.lang.String>	start()
abstract io.reactivex.Maybe<java.lang.String>	startTestItem(io.reactivex.Maybe<java.lang.String> parentId, io.reactivex.Maybe<java.lang.String> retryOf, com.epam.ta.reportportal.ws.model.StartTestItemRQ rq) Starts new test item in ReportPortal in respect of provided retry item ID.
abstract io.reactivex.Maybe<java.lang.String>	startTestItem(io.reactivex.Maybe<java.lang.String> parentId, com.epam.ta.reportportal.ws.model.StartTestItemRQ rq) Starts new test item in ReportPortal asynchronously (non-blocking)
abstract io.reactivex.Maybe<java.lang.String>	startTestItem(com.epam.ta.reportportal.ws.model.StartTestItemRQ rq) Starts new test item in ReportPortal asynchronously (non-blocking)

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final ReportPortalClient client

NOOP_LAUNCH

public static final Launch NOOP_LAUNCH

Implementation for disabled Reporting

NOT_ISSUE

public static final com.epam.ta.reportportal.ws.model.issue.Issue NOT_ISSUE

An Issue to remove 'To Investigate' mark from a skipped/failed Test Item

Method Detail

start

@Nonnull
public abstract io.reactivex.Maybe<java.lang.String> start()

finish

public abstract void finish(com.epam.ta.reportportal.ws.model.FinishExecutionRQ rq)

Finishes launch in ReportPortal. Blocks until all items are reported correctly

Parameters:

rq - Finish RQ

startTestItem

@Nonnull
public abstract io.reactivex.Maybe<java.lang.String> startTestItem(com.epam.ta.reportportal.ws.model.StartTestItemRQ rq)

Starts new test item in ReportPortal asynchronously (non-blocking)

Parameters:

rq - Start RQ

Returns:

Test Item ID promise

startTestItem

@Nonnull
public abstract io.reactivex.Maybe<java.lang.String> startTestItem(io.reactivex.Maybe<java.lang.String> parentId,
                                                                            com.epam.ta.reportportal.ws.model.StartTestItemRQ rq)

Starts new test item in ReportPortal asynchronously (non-blocking)

Parameters:

rq - Start RQ

parentId - Parent ID

Returns:

Test Item ID promise

startTestItem

@Nonnull
public abstract io.reactivex.Maybe<java.lang.String> startTestItem(io.reactivex.Maybe<java.lang.String> parentId,
                                                                            io.reactivex.Maybe<java.lang.String> retryOf,
                                                                            com.epam.ta.reportportal.ws.model.StartTestItemRQ rq)

Starts new test item in ReportPortal in respect of provided retry item ID.

Parameters:

parentId - promise of ID of parent

retryOf - previous item ID promise

rq - promise of ID of request

Returns:

Promise of Test Item ID

finishTestItem

@Nonnull
public abstract io.reactivex.Maybe<com.epam.ta.reportportal.ws.model.OperationCompletionRS> finishTestItem(io.reactivex.Maybe<java.lang.String> itemId,
                                                                                                                    com.epam.ta.reportportal.ws.model.FinishTestItemRQ rq)

Finishes Test Item in ReportPortal. Non-blocking. Schedules finish after success of all child items

Parameters:

itemId - Item ID promise

rq - Finish request

Returns:

Promise of Test Item finish response

getParameters

@Nonnull
public ListenerParameters getParameters()

currentLaunch

@Nullable
public static Launch currentLaunch()

Returns a current launch in a link to the current thread.

Returns:

launch instance

getStepReporter

@Nonnull
public StepReporter getStepReporter()

Returns Nested Step reporter for the current launch.

Returns:

a StepReporter instance

getClient

@Nonnull
public ReportPortalClient getClient()

Returns ReportPortal client for the launch.

Returns:

a ReportPortalClient instance

getLaunch

@Nonnull
public abstract io.reactivex.Maybe<java.lang.String> getLaunch()

Returns current launch UUID Maybe, empty if the launch is not started.

Returns:

Launch UUID promise