org.ops4j.pax.exam.testng.listener

Class PaxExam

java.lang.Object

org.ops4j.pax.exam.testng.listener.PaxExam

All Implemented Interfaces:

org.testng.IHookable, org.testng.IMethodInterceptor, org.testng.ISuiteListener, org.testng.ITestNGListener

Direct Known Subclasses:

ExamTestNGListener

public class PaxExam
extends Object
implements org.testng.ISuiteListener, org.testng.IMethodInterceptor, org.testng.IHookable

TestNG driver for Pax Exam, implementing a number of ITestNGListener interfaces. To run a TestNG test class with Pax Exam, add this class as a listener to your test class:

 @Listeners(PaxExam.class)
 public class MyTest {

     @BeforeMethod
     public void setUp() {
     }

     @AfterMethod
     public void tearDown() {
     }

     @Test
     public void test1() {
     }
 }
 

In OSGi and Java EE modes, Pax Exam processes each test class twice, once by test driver and then again inside the test container. The driver delegates each test method invocation to a probe invoker which excutes the test method inside the container via the probe.

It would be nice to separate these two aspects and handle them in two separate listeners, but TestNG has no way to override or disable the listener annotated on the test class.

TestNG provides a listener callback for configuration methods, but it does not let us intercept them. For this reason, we use an ugly reflection hack to disable them when running under the driver and to make sure they get executed inside the test container only.

Dependencies annotated by javax.inject.Inject get injected into the test class in the container (OSGi and Java EE modes) or by the driver (CDI mode).

Since:

2.3.0

Author:

Harald Wellmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAX_EXAM_SUITE_NAME

Constructor Summary

Constructors

Constructor and Description
PaxExam()

Method Summary

Methods

Modifier and Type	Method and Description
List<org.testng.IMethodInstance>	intercept(List<org.testng.IMethodInstance> testMethods, org.testng.ITestContext context) Callback from TestNG which lets us manipulate the list of test methods in the suite.
void	onFinish(org.testng.ISuite suite) Called by TestNG after the suite has finished.
void	onStart(org.testng.ISuite suite) Called by TestNG before the suite starts.
void	run(org.testng.IHookCallBack callBack, org.testng.ITestResult testResult) Callback from TestNG which lets us intercept a test method invocation.

Methods inherited from class java.lang.Object

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

Field Detail

PAX_EXAM_SUITE_NAME

public static final String PAX_EXAM_SUITE_NAME

See Also:

Constant Field Values

Constructor Detail

PaxExam

public PaxExam()

Method Detail

onStart

public void onStart(org.testng.ISuite suite)

Called by TestNG before the suite starts. When running in the container, this is a no op. Otherwise, we create and stage the reactor.

Specified by:

onStart in interface org.testng.ISuiteListener

Parameters:

suite - test suite

onFinish

public void onFinish(org.testng.ISuite suite)

Called by TestNG after the suite has finished. When running in the container, this is a no op. Otherwise, we stop the reactor.

Specified by:

onFinish in interface org.testng.ISuiteListener

Parameters:

suite - test suite

run

public void run(org.testng.IHookCallBack callBack,
       org.testng.ITestResult testResult)

Callback from TestNG which lets us intercept a test method invocation. The two cases of running in the container or under the driver are handled in separate methods.

Specified by:

run in interface org.testng.IHookable

intercept

public List<org.testng.IMethodInstance> intercept(List<org.testng.IMethodInstance> testMethods,
                                         org.testng.ITestContext context)

Callback from TestNG which lets us manipulate the list of test methods in the suite. When running under the driver and using a probe invoker, we now construct the test addresses to be used be the probe invoker, and we sort the methods by class to make sure we can fire beforeClass and afterClass events later on.

For some reason, TestNG invokes this callback twice. The second time over, we return the unchanged method list.

Specified by:

intercept in interface org.testng.IMethodInterceptor