Package com.epam.reportportal.testng

Class TestNGService

java.lang.Object

com.epam.reportportal.testng.TestNGService

All Implemented Interfaces:

ITestNGService

public class TestNGService
extends java.lang.Object
implements ITestNGService

TestNG service implements operations for interaction ReportPortal

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESCRIPTION_ERROR_FORMAT
static com.epam.reportportal.service.tree.TestItemTree	ITEM_TREE
static java.lang.String	NULL_VALUE
static java.lang.String	RP_ID
static java.lang.String	RP_METHOD_TYPE
static java.lang.String	RP_RETRY
static java.lang.String	SKIPPED_ISSUE_KEY

Constructor Summary

Constructors

Constructor	Description
TestNGService(com.epam.reportportal.service.ReportPortal reportPortal)
TestNGService(java.util.function.Supplier<com.epam.reportportal.service.Launch> launchSupplier)

Method Summary

Modifier and Type	Method	Description
protected com.epam.ta.reportportal.ws.model.FinishExecutionRQ	buildFinishLaunchRq(com.epam.reportportal.listeners.ListenerParameters parameters)	Extension point to customize launch finishing event/request
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ	buildFinishTestMethodRq(com.epam.reportportal.listeners.ItemStatus status, org.testng.ITestResult testResult)	Extension point to customize test method on it's finish
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ	buildFinishTestRq(org.testng.ITestContext testContext)	Extension point to customize test on it's finish
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ	buildFinishTestSuiteRq(org.testng.ISuite suite)	Extension point to customize test suite on it's finish
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartConfigurationRq(org.testng.ITestResult testResult, TestMethodType type)	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.testng.ITestResult testResult)	Extension point to customize test step creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartStepRq(org.testng.ITestResult testResult, TestMethodType type)	Extension point to customize test step creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartSuiteRq(org.testng.ISuite suite)	Extension point to customize suite creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartTestItemRq(org.testng.ITestContext testContext)	Extension point to customize test creation event/request
protected java.lang.String	createConfigurationDescription(org.testng.ITestResult testResult)	Extension point to customize beforeXXX step description
protected java.lang.String	createConfigurationName(org.testng.ITestResult testResult)	Extension point to customize beforeXXX step name
protected com.epam.ta.reportportal.ws.model.issue.Issue	createIssue(org.testng.ITestResult testResult)
protected void	createSkippedSteps(org.testng.ITestResult testResult)	Extension point to customize skipped test insides
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ>	createStepAttributes(org.testng.ITestResult testResult)
protected java.lang.String	createStepDescription(org.testng.ITestResult testResult)	Extension point to customize test step description
protected java.lang.String	createStepName(org.testng.ITestResult testResult)	Extension point to customize test step name
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource>	createStepParameters(org.testng.ITestResult testResult)	Extension point to customize ReportPortal test parameters
void	finishLaunch()	Finish current launch
void	finishTest(org.testng.ITestContext testContext)	Finish test event handler
void	finishTestMethod(com.epam.reportportal.listeners.ItemStatus status, org.testng.ITestResult testResult)	Finish test method event handler
void	finishTestSuite(org.testng.ISuite suite)	Finish test suite event handler
protected <T> T	getAttribute(org.testng.IAttributes attributes, java.lang.String attribute)
void	sendReportPortalMsg(org.testng.ITestResult result)
void	startConfiguration(org.testng.ITestResult testResult)	Start configuration method(any before of after method)
void	startLaunch()	Start current launch
void	startTest(org.testng.ITestContext testContext)	Start test event handler
void	startTestMethod(org.testng.ITestResult testResult)	Start test method event handler
void	startTestSuite(org.testng.ISuite suite)	Start test suite event handler

Methods inherited from class java.lang.Object

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

Field Detail

SKIPPED_ISSUE_KEY

public static final java.lang.String SKIPPED_ISSUE_KEY

See Also:

Constant Field Values

RP_ID

public static final java.lang.String RP_ID

See Also:

Constant Field Values

RP_RETRY

public static final java.lang.String RP_RETRY

See Also:

Constant Field Values

RP_METHOD_TYPE

public static final java.lang.String RP_METHOD_TYPE

See Also:

Constant Field Values

NULL_VALUE

public static final java.lang.String NULL_VALUE

See Also:

Constant Field Values

DESCRIPTION_ERROR_FORMAT

public static final java.lang.String DESCRIPTION_ERROR_FORMAT

See Also:

Constant Field Values

ITEM_TREE

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

Constructor Detail

TestNGService

public TestNGService(@Nonnull
                     com.epam.reportportal.service.ReportPortal reportPortal)

TestNGService

public TestNGService(java.util.function.Supplier<com.epam.reportportal.service.Launch> launchSupplier)

Method Detail

startLaunch

public void startLaunch()

Description copied from interface: ITestNGService

Start current launch

Specified by:

startLaunch in interface ITestNGService

finishLaunch

public void finishLaunch()

Description copied from interface: ITestNGService

Finish current launch

Specified by:

finishLaunch in interface ITestNGService

startTestSuite

public void startTestSuite(org.testng.ISuite suite)

Description copied from interface: ITestNGService

Start test suite event handler

Specified by:

startTestSuite in interface ITestNGService

Parameters:

suite - TestNG's suite

getAttribute

protected <T> T getAttribute(org.testng.IAttributes attributes,
                             java.lang.String attribute)

finishTestSuite

public void finishTestSuite(org.testng.ISuite suite)

Description copied from interface: ITestNGService

Finish test suite event handler

Specified by:

finishTestSuite in interface ITestNGService

Parameters:

suite - TestNG's suite

startTest

public void startTest(org.testng.ITestContext testContext)

Description copied from interface: ITestNGService

Start test event handler

Specified by:

startTest in interface ITestNGService

Parameters:

testContext - TestNG's test context

finishTest

public void finishTest(org.testng.ITestContext testContext)

Description copied from interface: ITestNGService

Finish test event handler

Specified by:

finishTest in interface ITestNGService

Parameters:

testContext - TestNG's test context

buildStartConfigurationRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartConfigurationRq(@Nonnull
                                                                                      org.testng.ITestResult testResult,
                                                                                      @Nullable
                                                                                      TestMethodType type)

Extension point to customize beforeXXX creation event/request

Parameters:

testResult - TestNG's testResult context

type - Type of method

Returns:

Request to ReportPortal

startConfiguration

public void startConfiguration(org.testng.ITestResult testResult)

Description copied from interface: ITestNGService

Start configuration method(any before of after method)

Specified by:

startConfiguration in interface ITestNGService

Parameters:

testResult - TestNG's test result

createStepDescription

@Nonnull
protected java.lang.String createStepDescription(@Nonnull
                                                 org.testng.ITestResult testResult)

Extension point to customize test step description

Parameters:

testResult - TestNG's testResult context

Returns:

Test/Step Description being sent to ReportPortal

buildStartStepRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartStepRq(@Nonnull
                                                                             org.testng.ITestResult testResult,
                                                                             @Nonnull
                                                                             TestMethodType type)

Extension point to customize test step creation event/request

Parameters:

testResult - TestNG's testResult context

type - method type

Returns:

Request to ReportPortal

buildStartStepRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartStepRq(@Nonnull
                                                                             org.testng.ITestResult testResult)

Extension point to customize test step creation event/request

Parameters:

testResult - TestNG's testResult context

Returns:

Request to ReportPortal

startTestMethod

public void startTestMethod(@Nonnull
                            org.testng.ITestResult testResult)

Description copied from interface: ITestNGService

Start test method event handler

Specified by:

startTestMethod in interface ITestNGService

Parameters:

testResult - TestNG's test result

buildFinishTestMethodRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ buildFinishTestMethodRq(@Nonnull
                                                                                     com.epam.reportportal.listeners.ItemStatus status,
                                                                                     @Nonnull
                                                                                     org.testng.ITestResult testResult)

Extension point to customize test method on it's finish

Parameters:

status - item execution status

testResult - TestNG's testResult context

Returns:

Request to ReportPortal

createSkippedSteps

protected void createSkippedSteps(org.testng.ITestResult testResult)

Extension point to customize skipped test insides

Parameters:

testResult - TestNG's testResult context

createIssue

@Nullable
protected com.epam.ta.reportportal.ws.model.issue.Issue createIssue(@Nonnull
                                                                    org.testng.ITestResult testResult)

finishTestMethod

public void finishTestMethod(com.epam.reportportal.listeners.ItemStatus status,
                             org.testng.ITestResult testResult)

Description copied from interface: ITestNGService

Finish test method event handler

Specified by:

finishTestMethod in interface ITestNGService

Parameters:

status - Status (PASSED/FAILED)

testResult - TestNG's test result

See Also:

ItemStatus

sendReportPortalMsg

public void sendReportPortalMsg(org.testng.ITestResult result)

Specified by:

sendReportPortalMsg in interface ITestNGService

buildStartSuiteRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartSuiteRq(org.testng.ISuite suite)

Extension point to customize suite creation event/request

Parameters:

suite - TestNG suite

Returns:

Request to ReportPortal

buildStartTestItemRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartTestItemRq(@Nonnull
                                                                                 org.testng.ITestContext testContext)

Extension point to customize test creation event/request

Parameters:

testContext - TestNG test context

Returns:

Request to ReportPortal

buildStartLaunchRq

@Nonnull
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

buildFinishLaunchRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishExecutionRQ buildFinishLaunchRq(com.epam.reportportal.listeners.ListenerParameters parameters)

Extension point to customize launch finishing event/request

Parameters:

parameters - Launch Configuration parameters

Returns:

Request to ReportPortal

buildFinishTestSuiteRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ buildFinishTestSuiteRq(org.testng.ISuite suite)

Extension point to customize test suite on it's finish

Parameters:

suite - TestNG's suite context

Returns:

Request to ReportPortal

buildFinishTestRq

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ buildFinishTestRq(org.testng.ITestContext testContext)

Extension point to customize test on it's finish

Parameters:

testContext - TestNG test context

Returns:

Request to ReportPortal

createStepParameters

@Nullable
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource> createStepParameters(org.testng.ITestResult testResult)

Extension point to customize ReportPortal test parameters

Parameters:

testResult - TestNG's testResult context

Returns:

Test/Step Parameters being sent to ReportPortal

createConfigurationName

protected java.lang.String createConfigurationName(org.testng.ITestResult testResult)

Extension point to customize beforeXXX step name

Parameters:

testResult - TestNG's testResult context

Returns:

Test/Step Name being sent to ReportPortal

createConfigurationDescription

protected java.lang.String createConfigurationDescription(org.testng.ITestResult testResult)

Extension point to customize beforeXXX step description

Parameters:

testResult - TestNG's testResult context

Returns:

Test/Step Description being sent to ReportPortal

createStepName

protected java.lang.String createStepName(org.testng.ITestResult testResult)

Extension point to customize test step name

Parameters:

testResult - TestNG's testResult context

Returns:

Test/Step Name being sent to ReportPortal

createStepAttributes

@Nullable
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ> createStepAttributes(@Nonnull
                                                                                                           org.testng.ITestResult testResult)