com.epam.reportportal.junit5

Class ReportPortalExtension

java.lang.Object

com.epam.reportportal.junit5.ReportPortalExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.InvocationInterceptor, org.junit.jupiter.api.extension.TestWatcher

public class ReportPortalExtension
extends java.lang.Object
implements org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.InvocationInterceptor, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.TestWatcher

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T>

Field Summary

Fields

Modifier and Type	Field and Description
static com.epam.reportportal.service.ReportPortal	REPORT_PORTAL
static com.epam.reportportal.service.tree.TestItemTree	TEST_ITEM_TREE

Constructor Summary

Constructors

Constructor and Description
ReportPortalExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ	buildFinishTestItemRq(org.junit.jupiter.api.extension.ExtensionContext context, com.epam.reportportal.listeners.ItemStatus status) Extension point to customize a test item result on it's finish
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartConfigurationRq(java.lang.reflect.Method method, org.junit.jupiter.api.extension.ExtensionContext parentContext, org.junit.jupiter.api.extension.ExtensionContext context, ItemType itemType) Extension point to customize beforeXXX creation event/request
protected com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ	buildStartLaunchRq(com.epam.reportportal.listeners.ListenerParameters parameters) Extension point to customize launch creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartStepRq(org.junit.jupiter.api.extension.ExtensionContext context, java.util.List<java.lang.Object> arguments, ItemType itemType, java.lang.String description, java.util.Date startTime) Extension point to customize test step creation event/request
protected java.lang.String	createConfigurationDescription(java.lang.Class<?> testClass, java.lang.reflect.Method method) Extension point to customize beforeXXX step description
protected java.lang.String	createConfigurationName(java.lang.Class<?> testClass, java.lang.reflect.Method method) Extension point to customize beforeXXX step name
protected void	createSkippedSteps(org.junit.jupiter.api.extension.ExtensionContext context, java.lang.Throwable cause) Extension point to customize skipped test insides
protected java.lang.String	createStepDescription(org.junit.jupiter.api.extension.ExtensionContext context) Extension point to customize test step description
protected java.lang.String	createStepName(org.junit.jupiter.api.extension.ExtensionContext context) Extension point to customize test step name
void	finish() Finishes all launches for the JVM
protected void	finishBeforeAll(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context, io.reactivex.Maybe<java.lang.String> id) Finishes a method marked with BeforeAll annotation, calls reportSkippedClassTests(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method>, org.junit.jupiter.api.extension.ExtensionContext, java.util.Date) method in case of failures
protected void	finishBeforeEach(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context, io.reactivex.Maybe<java.lang.String> id) Finishes a method marked with BeforeEach annotation, calls reportSkippedStep(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method>, org.junit.jupiter.api.extension.ExtensionContext, java.lang.Throwable, java.util.Date) method in case of failures
protected void	finishTemplate(org.junit.jupiter.api.extension.ExtensionContext context, com.epam.reportportal.listeners.ItemStatus status) Finish a test template execution (basically a test class) with a specific status, builds a finish request based on the status
protected void	finishTemplates(org.junit.jupiter.api.extension.ExtensionContext parentContext) Finish all test templates execution (basically a test class) within a specific context
protected void	finishTestItem(org.junit.jupiter.api.extension.ExtensionContext context) Finishes a test item in RP, calculates the item status and builds a finish request based on the status
protected void	finishTestItem(org.junit.jupiter.api.extension.ExtensionContext context, com.epam.ta.reportportal.ws.model.FinishTestItemRQ rq) Finishes a test item in RP with a custom request
protected void	finishTestItem(org.junit.jupiter.api.extension.ExtensionContext context, com.epam.reportportal.listeners.ItemStatus status) Finishes a test item in RP with a specific status, builds a finish request based on the status
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ>	getAttributes(java.lang.reflect.AnnotatedElement annotatedElement) Extract and returns static attributes of a test method or class (set with Attributes annotation)
protected java.lang.String	getCodeRef(org.junit.jupiter.api.extension.ExtensionContext context) Returns a code reference of a test (static or dynamic).
protected com.epam.reportportal.listeners.ItemStatus	getExecutionStatus(org.junit.jupiter.api.extension.ExtensionContext context) Returns a status of a test based on whether or not it contains an execution exception
protected java.util.Optional<io.reactivex.Maybe<java.lang.String>>	getItemId(org.junit.jupiter.api.extension.ExtensionContext context)
protected com.epam.reportportal.service.Launch	getLaunch(org.junit.jupiter.api.extension.ExtensionContext context) Returns a current launch instance, starts new if no such instance
protected java.lang.String	getLaunchId(org.junit.jupiter.api.extension.ExtensionContext context) Returns a current launch unique ID
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource>	getParameters(java.lang.reflect.Method method, java.util.List<java.lang.Object> arguments) Extracts and returns a test parameters, respects ParameterKey annotation
protected com.epam.reportportal.service.ReportPortal	getReporter()
protected com.epam.reportportal.service.item.TestCaseIdEntry	getTestCaseId(java.lang.reflect.Method method, java.lang.String codeRef, java.util.List<java.lang.Object> arguments) Calculates a test case ID based on code reference and parameters
protected com.epam.reportportal.service.item.TestCaseIdEntry	getTestCaseId(java.lang.reflect.Method method, java.lang.String codeRef, java.util.List<java.lang.Object> arguments, java.lang.Object instance) Calculates a test case ID based on code reference and parameters
protected java.util.Optional<java.lang.reflect.Method>	getTestMethod(org.junit.jupiter.api.extension.ExtensionContext context) Recursively returns the first real test method found in test hierarchy
void	interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext parentContext)
void	interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context)
void	interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext parentContext)
void	interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context)
void	interceptDynamicTest(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
<T> T	interceptTestFactoryMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptTestTemplateMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
protected void	reportSkippedClassTests(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context, java.util.Date eventTime) Extension point to customize test steps skipped in case of a @BeforeAll method failed.
protected void	reportSkippedStep(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext context, java.lang.Throwable throwable, java.util.Date eventTime) Extension point to customize test steps skipped in case of a @BeforeEach method failed.
protected void	sendStackTraceToRP(java.lang.Throwable cause) Formats and reports a Throwable to Report Portal
protected io.reactivex.Maybe<java.lang.String>	startBeforeAfter(java.lang.reflect.Method method, org.junit.jupiter.api.extension.ExtensionContext parentContext, org.junit.jupiter.api.extension.ExtensionContext context, ItemType itemType) Starts the following methods: @BeforeEach, @AfterEach, @BeforeAll or @AfterAll
protected void	startTemplate(org.junit.jupiter.api.extension.ExtensionContext parentContext) Starts a test template (basically a test class)
protected void	startTestItem(org.junit.jupiter.api.extension.ExtensionContext context, ItemType type) Starts a test item of arbitrary type
protected void	startTestItem(org.junit.jupiter.api.extension.ExtensionContext context, java.util.List<java.lang.Object> arguments, ItemType type) Starts a test item of arbitrary type
protected void	startTestItem(org.junit.jupiter.api.extension.ExtensionContext context, java.util.List<java.lang.Object> arguments, ItemType itemType, java.lang.String description, java.util.Date startTime) Starts a test item of arbitrary type
void	testAborted(org.junit.jupiter.api.extension.ExtensionContext context, java.lang.Throwable throwable)
void	testDisabled(org.junit.jupiter.api.extension.ExtensionContext context, java.util.Optional<java.lang.String> reason)
void	testFailed(org.junit.jupiter.api.extension.ExtensionContext context, java.lang.Throwable throwable)
void	testSuccessful(org.junit.jupiter.api.extension.ExtensionContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptTestClassConstructor

Field Detail

TEST_ITEM_TREE

public static final com.epam.reportportal.service.tree.TestItemTree TEST_ITEM_TREE

REPORT_PORTAL

public static final com.epam.reportportal.service.ReportPortal REPORT_PORTAL

Constructor Detail

ReportPortalExtension

public ReportPortalExtension()

Method Detail

getItemId

@Nonnull
protected java.util.Optional<io.reactivex.Maybe<java.lang.String>> getItemId(@Nonnull
                                                                                      org.junit.jupiter.api.extension.ExtensionContext context)

finish

public void finish()

Finishes all launches for the JVM

buildStartLaunchRq

protected com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ buildStartLaunchRq(com.epam.reportportal.listeners.ListenerParameters parameters)

Extension point to customize launch creation event/request

Parameters:

parameters - Launch Configuration parameters

Returns:

Request to ReportPortal

getReporter

protected com.epam.reportportal.service.ReportPortal getReporter()

Returns:

ReportPortal client instance

getLaunchId

protected java.lang.String getLaunchId(org.junit.jupiter.api.extension.ExtensionContext context)

Returns a current launch unique ID

Parameters:

context - JUnit's launch context

Returns:

ID of the launch

getLaunch

protected com.epam.reportportal.service.Launch getLaunch(org.junit.jupiter.api.extension.ExtensionContext context)

Returns a current launch instance, starts new if no such instance

Parameters:

context - JUnit's launch context

Returns:

represents current launch

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

interceptBeforeAllMethod

public void interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                     org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                     org.junit.jupiter.api.extension.ExtensionContext parentContext)
                              throws java.lang.Throwable

Specified by:

interceptBeforeAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptBeforeEachMethod

public void interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                      org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                      org.junit.jupiter.api.extension.ExtensionContext context)
                               throws java.lang.Throwable

Specified by:

interceptBeforeEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptAfterAllMethod

public void interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                    org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                    org.junit.jupiter.api.extension.ExtensionContext parentContext)
                             throws java.lang.Throwable

Specified by:

interceptAfterAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptAfterEachMethod

public void interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                     org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                     org.junit.jupiter.api.extension.ExtensionContext context)
                              throws java.lang.Throwable

Specified by:

interceptAfterEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptTestMethod

public void interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws java.lang.Throwable

Specified by:

interceptTestMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptTestFactoryMethod

public <T> T interceptTestFactoryMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation,
                                        org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                        org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                                 throws java.lang.Throwable

Specified by:

interceptTestFactoryMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptDynamicTest

public void interceptDynamicTest(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                          throws java.lang.Throwable

Specified by:

interceptDynamicTest in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

interceptTestTemplateMethod

public void interceptTestTemplateMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                        org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                        org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                                 throws java.lang.Throwable

Specified by:

interceptTestTemplateMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

java.lang.Throwable

afterTestExecution

public void afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

testDisabled

public void testDisabled(org.junit.jupiter.api.extension.ExtensionContext context,
                         java.util.Optional<java.lang.String> reason)

Specified by:

testDisabled in interface org.junit.jupiter.api.extension.TestWatcher

testSuccessful

public void testSuccessful(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

testSuccessful in interface org.junit.jupiter.api.extension.TestWatcher

testAborted

public void testAborted(org.junit.jupiter.api.extension.ExtensionContext context,
                        java.lang.Throwable throwable)

Specified by:

testAborted in interface org.junit.jupiter.api.extension.TestWatcher

testFailed

public void testFailed(org.junit.jupiter.api.extension.ExtensionContext context,
                       java.lang.Throwable throwable)

Specified by:

testFailed in interface org.junit.jupiter.api.extension.TestWatcher

finishBeforeAll

protected void finishBeforeAll(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                               org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                               org.junit.jupiter.api.extension.ExtensionContext context,
                               io.reactivex.Maybe<java.lang.String> id)
                        throws java.lang.Throwable

Finishes a method marked with BeforeAll annotation, calls reportSkippedClassTests(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method>, org.junit.jupiter.api.extension.ExtensionContext, java.util.Date) method in case of failures

Parameters:

invocation - the invocation that is being intercepted

invocationContext - the context of the invocation that is being intercepted

context - JUnit's test context

id - an ID of the method to finish

Throws:

java.lang.Throwable - in case of failures

finishBeforeEach

protected void finishBeforeEach(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<java.lang.Void> invocation,
                                org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                org.junit.jupiter.api.extension.ExtensionContext context,
                                io.reactivex.Maybe<java.lang.String> id)
                         throws java.lang.Throwable

Finishes a method marked with BeforeEach annotation, calls reportSkippedStep(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method>, org.junit.jupiter.api.extension.ExtensionContext, java.lang.Throwable, java.util.Date) method in case of failures

Parameters:

invocation - the invocation that is being intercepted

invocationContext - the context of the invocation that is being intercepted

context - JUnit's test context

id - an ID of the method to finish

Throws:

java.lang.Throwable - in case of failures

startTemplate

protected void startTemplate(org.junit.jupiter.api.extension.ExtensionContext parentContext)

Starts a test template (basically a test class)

Parameters:

parentContext - JUnit's test context of a parent entity

startTestItem

protected void startTestItem(org.junit.jupiter.api.extension.ExtensionContext context,
                             ItemType type)

Starts a test item of arbitrary type

Parameters:

context - JUnit's test context

type - a type of the item

startTestItem

protected void startTestItem(org.junit.jupiter.api.extension.ExtensionContext context,
                             java.util.List<java.lang.Object> arguments,
                             ItemType type)

Starts a test item of arbitrary type

Parameters:

context - JUnit's test context

arguments - a list of test parameters

type - a type of the item

startTestItem

protected void startTestItem(@Nonnull
                             org.junit.jupiter.api.extension.ExtensionContext context,
                             @Nonnull
                             java.util.List<java.lang.Object> arguments,
                             @Nonnull
                             ItemType itemType,
                             @Nonnull
                             java.lang.String description,
                             @Nonnull
                             java.util.Date startTime)

Starts a test item of arbitrary type

Parameters:

context - JUnit's test context

arguments - a list of test parameters

itemType - a type of the item

description - the test description

startTime - the test start time

startBeforeAfter

protected io.reactivex.Maybe<java.lang.String> startBeforeAfter(java.lang.reflect.Method method,
                                                                org.junit.jupiter.api.extension.ExtensionContext parentContext,
                                                                org.junit.jupiter.api.extension.ExtensionContext context,
                                                                ItemType itemType)

Starts the following methods: @BeforeEach, @AfterEach, @BeforeAll or @AfterAll

Parameters:

method - a method reference

parentContext - JUnit's test context of a parent item

context - JUnit's test context of a method to start

itemType - a method's item type (to display on RP)

Returns:

an ID of the method

finishTemplate

protected void finishTemplate(org.junit.jupiter.api.extension.ExtensionContext context,
                              com.epam.reportportal.listeners.ItemStatus status)

Finish a test template execution (basically a test class) with a specific status, builds a finish request based on the status

Parameters:

context - JUnit's test context

status - an ItemStatus

finishTemplates

protected void finishTemplates(org.junit.jupiter.api.extension.ExtensionContext parentContext)

Finish all test templates execution (basically a test class) within a specific context

Parameters:

parentContext - JUnit's test context

getExecutionStatus

protected com.epam.reportportal.listeners.ItemStatus getExecutionStatus(@Nonnull
                                                                        org.junit.jupiter.api.extension.ExtensionContext context)

Returns a status of a test based on whether or not it contains an execution exception

Parameters:

context - JUnit's test context

Returns:

an ItemStatus

finishTestItem

protected void finishTestItem(@Nonnull
                              org.junit.jupiter.api.extension.ExtensionContext context)

Finishes a test item in RP, calculates the item status and builds a finish request based on the status

Parameters:

context - JUnit's test context

finishTestItem

protected void finishTestItem(@Nonnull
                              org.junit.jupiter.api.extension.ExtensionContext context,
                              @Nonnull
                              com.epam.reportportal.listeners.ItemStatus status)

Finishes a test item in RP with a specific status, builds a finish request based on the status

Parameters:

context - JUnit's test context

status - a test execution status

finishTestItem

protected void finishTestItem(@Nonnull
                              org.junit.jupiter.api.extension.ExtensionContext context,
                              @Nonnull
                              com.epam.ta.reportportal.ws.model.FinishTestItemRQ rq)

Finishes a test item in RP with a custom request

Parameters:

context - JUnit's test context

rq - a test item finish request

getTestCaseId

protected com.epam.reportportal.service.item.TestCaseIdEntry getTestCaseId(@Nonnull
                                                                           java.lang.reflect.Method method,
                                                                           @Nonnull
                                                                           java.lang.String codeRef,
                                                                           @Nonnull
                                                                           java.util.List<java.lang.Object> arguments)

Calculates a test case ID based on code reference and parameters

Parameters:

method - a test method reference

codeRef - a code reference which will be used for the calculation

arguments - a list of test arguments

Returns:

a test case ID

getTestCaseId

protected com.epam.reportportal.service.item.TestCaseIdEntry getTestCaseId(@Nonnull
                                                                           java.lang.reflect.Method method,
                                                                           @Nonnull
                                                                           java.lang.String codeRef,
                                                                           @Nonnull
                                                                           java.util.List<java.lang.Object> arguments,
                                                                           @Nullable
                                                                           java.lang.Object instance)

Calculates a test case ID based on code reference and parameters

Parameters:

method - a test method reference

codeRef - a code reference which will be used for the calculation

arguments - a list of test arguments

instance - current test instance

Returns:

a test case ID

getCodeRef

@Nonnull
protected java.lang.String getCodeRef(@Nonnull
                                               org.junit.jupiter.api.extension.ExtensionContext context)

Returns a code reference of a test (static or dynamic). For dynamic tests appends each depth level where level names are display names separated by `$` symbol

Parameters:

context - JUnit's test context

Returns:

a code reference string

getTestMethod

protected java.util.Optional<java.lang.reflect.Method> getTestMethod(org.junit.jupiter.api.extension.ExtensionContext context)

Recursively returns the first real test method found in test hierarchy

Parameters:

context - JUnit's test context

Returns:

an Optional of a Method

getAttributes

@Nonnull
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ> getAttributes(@Nonnull
                                                                                                             java.lang.reflect.AnnotatedElement annotatedElement)

Extract and returns static attributes of a test method or class (set with Attributes annotation)

Parameters:

annotatedElement - a test method or class reference

Returns:

a set of attributes

getParameters

@Nonnull
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource> getParameters(@Nonnull
                                                                                                     java.lang.reflect.Method method,
                                                                                                     java.util.List<java.lang.Object> arguments)

Extracts and returns a test parameters, respects ParameterKey annotation

Parameters:

method - a test method reference

arguments - a list of parameter values

Returns:

a list of parameters

buildStartStepRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartStepRq(@Nonnull
                                                                                      org.junit.jupiter.api.extension.ExtensionContext context,
                                                                                      @Nonnull
                                                                                      java.util.List<java.lang.Object> arguments,
                                                                                      @Nonnull
                                                                                      ItemType itemType,
                                                                                      @Nonnull
                                                                                      java.lang.String description,
                                                                                      @Nonnull
                                                                                      java.util.Date startTime)

Extension point to customize test step creation event/request

Parameters:

context - JUnit's test context

arguments - a test arguments list

itemType - a test method item type

description - a test method description

startTime - a start time of the test

Returns:

Request to ReportPortal

buildStartConfigurationRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartConfigurationRq(@Nonnull
                                                                                               java.lang.reflect.Method method,
                                                                                               @Nonnull
                                                                                               org.junit.jupiter.api.extension.ExtensionContext parentContext,
                                                                                               @Nonnull
                                                                                               org.junit.jupiter.api.extension.ExtensionContext context,
                                                                                               @Nonnull
                                                                                               ItemType itemType)

Extension point to customize beforeXXX creation event/request

Parameters:

method - JUnit's test method reference

parentContext - JUnit's context of a parent item

context - JUnit's test context

itemType - a type of the item to build

Returns:

Request to ReportPortal

createSkippedSteps

protected void createSkippedSteps(org.junit.jupiter.api.extension.ExtensionContext context,
                                  java.lang.Throwable cause)

Extension point to customize skipped test insides

Parameters:

context - JUnit's test context

cause - an error thrown by skip culprit

buildFinishTestItemRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ buildFinishTestItemRq(@Nonnull
                                                                                            org.junit.jupiter.api.extension.ExtensionContext context,
                                                                                            @Nonnull
                                                                                            com.epam.reportportal.listeners.ItemStatus status)

Extension point to customize a test item result on it's finish

Parameters:

context - JUnit's test context

status - a test item execution result

Returns:

Request to ReportPortal

createStepName

protected java.lang.String createStepName(org.junit.jupiter.api.extension.ExtensionContext context)

Extension point to customize test step name

Parameters:

context - JUnit's test context

Returns:

Test/Step Name being sent to ReportPortal

createConfigurationName

@Nonnull
protected java.lang.String createConfigurationName(@Nonnull
                                                            java.lang.Class<?> testClass,
                                                            @Nonnull
                                                            java.lang.reflect.Method method)

Extension point to customize beforeXXX step name

Parameters:

testClass - JUnit's test class, by which the name will be calculated

method - JUnit's test method reference

Returns:

Test/Step Name being sent to ReportPortal

createStepDescription

protected java.lang.String createStepDescription(org.junit.jupiter.api.extension.ExtensionContext context)

Extension point to customize test step description

Parameters:

context - JUnit's test context

Returns:

Test/Step Description being sent to ReportPortal

createConfigurationDescription

protected java.lang.String createConfigurationDescription(java.lang.Class<?> testClass,
                                                          java.lang.reflect.Method method)

Extension point to customize beforeXXX step description

Parameters:

testClass - JUnit's test class, by which the name will be calculated

method - JUnit's test method reference

Returns:

Test/Step Description being sent to ReportPortal

reportSkippedStep

protected void reportSkippedStep(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                 org.junit.jupiter.api.extension.ExtensionContext context,
                                 java.lang.Throwable throwable,
                                 java.util.Date eventTime)

Extension point to customize test steps skipped in case of a @BeforeEach method failed.

Parameters:

invocationContext - JUnit's @BeforeAll invocation context

context - JUnit's test context

throwable - An exception which caused the skip

eventTime - @BeforeEach start time

reportSkippedClassTests

protected void reportSkippedClassTests(org.junit.jupiter.api.extension.ReflectiveInvocationContext<java.lang.reflect.Method> invocationContext,
                                       org.junit.jupiter.api.extension.ExtensionContext context,
                                       java.util.Date eventTime)

Extension point to customize test steps skipped in case of a @BeforeAll method failed.

Parameters:

invocationContext - JUnit's @BeforeAll invocation context

context - JUnit's test context

eventTime - @BeforeAll start time

sendStackTraceToRP

protected void sendStackTraceToRP(java.lang.Throwable cause)

Formats and reports a Throwable to Report Portal

Parameters:

cause - a Throwable