ch.inftec.ju.ee.test

Class ContainerTest

java.lang.Object

ch.inftec.ju.ee.test.ContainerTest

All Implemented Interfaces:

TestRunnerFacade.ContextAware, TestRunnerFacade.Initializable, TestRunnerFacade.TransactionAware

public abstract class ContainerTest
extends Object
implements TestRunnerFacade.ContextAware, TestRunnerFacade.Initializable, TestRunnerFacade.TransactionAware

Base class for container tests, i.e. integration tests that run in the application server VM.

Note that any JUnit related features like @Before, @After and so on will run in the client JVM and not on the server.

You can, however, override the doInit method to perform initialization tasks and use the serviceLocator to perform CDI and JNDI lookups in the container.

Note that the container will have to provide an EntityManager producer so we can inject it into our test class.

The ContainerTest provides a TxHandler instance that can be used to control the transaction if necessary. When entering the test method, we will have a running transaction and it will be automatically committed if necessary after completing the test.

Parameterized tests are not supported.

Author:

Martin

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.logging.Logger	_log
protected javax.persistence.EntityManager	em EntityManager provided by the container.
protected ch.inftec.ju.db.JuEmUtil	emUtil JuEmUtil instance wrapped around the EntityManager.
protected ServiceLocator	serviceLocator ServiceLocator instance that can be used to lookup JNDI or CDI objects on the server.
ContainerTestRunnerRule	testRunnerRule Rule that runs the method statements on the remote JBoss container VM
protected ch.inftec.ju.db.TxHandler	txHandler TxHandler that can be used to control the DB transaction.

Constructor Summary

Constructors

Constructor and Description
ContainerTest()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInit() Extending classes can override this method to perform custom initialization.
protected Path	getLocalPath(Path relativePath, boolean createParentDirectories) Gets a Path instance relative to the 'local' test (rather than the JBoss server context).
protected Path	getLocalPath(String relativePath, boolean createParentDirectories) Gets a Path instance relative to the 'local' test (rather than the JBoss server context).
void	init() Initializer method that is called before the unit test is executed.
protected void	initFrom(ContainerTest hostTest) Initializes the context and txHandler fields from the specified host test.
void	setContext(TestRunnerFacade.TestRunnerContext context) Sets the TestRunnerContext
void	setTxHandler(ch.inftec.ju.db.TxHandler txHandler) Sets the TxHandler used to control the transaction.

Methods inherited from class java.lang.Object

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

Field Detail

_log

protected org.jboss.logging.Logger _log

testRunnerRule

public ContainerTestRunnerRule testRunnerRule

Rule that runs the method statements on the remote JBoss container VM

em

protected javax.persistence.EntityManager em

EntityManager provided by the container.

emUtil

protected ch.inftec.ju.db.JuEmUtil emUtil

JuEmUtil instance wrapped around the EntityManager.

txHandler

protected ch.inftec.ju.db.TxHandler txHandler

TxHandler that can be used to control the DB transaction.

serviceLocator

protected ServiceLocator serviceLocator

ServiceLocator instance that can be used to lookup JNDI or CDI objects on the server.

Note that the ServiceLocator is not configured to lookup remote objects

Constructor Detail

ContainerTest

public ContainerTest()

Method Detail

setContext

public final void setContext(TestRunnerFacade.TestRunnerContext context)

Description copied from interface: TestRunnerFacade.ContextAware

Sets the TestRunnerContext

Specified by:

setContext in interface TestRunnerFacade.ContextAware

setTxHandler

public void setTxHandler(ch.inftec.ju.db.TxHandler txHandler)

Description copied from interface: TestRunnerFacade.TransactionAware

Sets the TxHandler used to control the transaction.

Specified by:

setTxHandler in interface TestRunnerFacade.TransactionAware

Parameters:

txHandler - TxHandler

init

public final void init()

Description copied from interface: TestRunnerFacade.Initializable

Initializer method that is called before the unit test is executed.

The method will be called within the same EJB / transaction context as the test method

Specified by:

init in interface TestRunnerFacade.Initializable

doInit

protected void doInit()

Extending classes can override this method to perform custom initialization.

initFrom

protected void initFrom(ContainerTest hostTest)

Initializes the context and txHandler fields from the specified host test.

Can be used if we want to call a test from another test.

Parameters:

hostTest - Test to load settings from

getLocalPath

protected final Path getLocalPath(String relativePath,
                boolean createParentDirectories)

Gets a Path instance relative to the 'local' test (rather than the JBoss server context).

Parameters:

relativePath - Relative path like target/file.xml

createParentDirectories - If true, the parent directories of the path are created if necessary

Returns:

Path relative to the unit test VM

getLocalPath

protected final Path getLocalPath(Path relativePath,
                boolean createParentDirectories)

Gets a Path instance relative to the 'local' test (rather than the JBoss server context).

Parameters:

relativePath - Relative path like target/file.xml

createParentDirectories - If true, the parent directories of the path are created if necessary

Returns:

Path relative to the unit test VM