alma.acs.component.client

Class ComponentClientTestCase

java.lang.Object

TestCase

alma.acs.component.client.ComponentClientTestCase

Direct Known Subclasses:

ComponentWithXmlOffshootClientTest, ErrorComponentTest, LampAccessClient, XmlComponentClient, XmlComponentClientTest

public class ComponentClientTestCase
extends TestCase

Base class for writing JUnit test clients for ACS components. Takes care of the communication with the ACS manager (local or provided in property ACS.manager). Provides the ContainerServices.

Author:

hsommer Nov 21, 2002 5:53:05 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected AcsCorba	acsCorba
protected AcsManagerProxy	m_acsManagerProxy Special tests that need to call directly the manager API could use this proxy object.
protected AcsLogger	m_logger
protected java.lang.String	m_managerLoc from property ACS.manager, or defaults to localhost

Constructor Summary

Constructors

Constructor and Description
ComponentClientTestCase(java.lang.String name) Subclasses must call this ctor.

Method Summary

Modifier and Type	Method and Description
protected void	connectToManager() Connects to the ACS Manager using AcsManagerProxy.
protected ContainerServices	getContainerServices() Gives access to the ContainerServices interface.
protected java.lang.String	getFullName()
protected LogReceiver	getLogReceiver() Gets a LogReceiver which can be used to verify log messages from both local and remote processes.
protected void	initRemoteLogging() Sets up the test client logger(s) to send log records to the remote log service.
protected void	runTest() Executes a single test method.
protected void	setUp() Starts CORBA in the client process and connects to the manager and logger.
protected void	tearDown() Releases all previously obtained components (using manager), logs out from the manager, and terminates the CORBA ORB.

Methods inherited from class java.lang.Object

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

Field Detail

acsCorba

protected AcsCorba acsCorba

m_acsManagerProxy

protected AcsManagerProxy m_acsManagerProxy

Special tests that need to call directly the manager API could use this proxy object. To be used sparingly, as we need to exercise (and extend if necessary) the regular classes such as ContainerServices.

m_logger

protected AcsLogger m_logger

m_managerLoc

protected java.lang.String m_managerLoc

from property ACS.manager, or defaults to localhost

Constructor Detail

ComponentClientTestCase

public ComponentClientTestCase(java.lang.String name)
                        throws java.lang.Exception

Subclasses must call this ctor.

Parameters:

name - the name used for the test case, and to talk with the ACS manager

Throws:

java.lang.Exception

Method Detail

runTest

protected void runTest()
                throws java.lang.Throwable

Executes a single test method. Stray exceptions are logged using the test logger, so that they show in system logs.

Throws:

java.lang.Throwable

Since:

ACS 6.0

See Also:

junit.framework.TestCase#runTest()

setUp

protected void setUp()
              throws java.lang.Exception

Starts CORBA in the client process and connects to the manager and logger.

Subclasses that override this method must call super.setUp(), likely before any other code in that method.

Throws:

java.lang.Exception

See Also:

junit.framework.TestCase#setUp()

connectToManager

protected void connectToManager()
                         throws java.lang.Exception

Connects to the ACS Manager using AcsManagerProxy.

Throws:

java.lang.Exception

getFullName

protected java.lang.String getFullName()

getContainerServices

protected ContainerServices getContainerServices()

Gives access to the ContainerServices interface. This class plays the part of the role of the Java container that has to do with providing explicit services to the component, or test case respectively.

Returns:

ContainerServices

tearDown

protected void tearDown()
                 throws java.lang.Exception

Releases all previously obtained components (using manager), logs out from the manager, and terminates the CORBA ORB.

Subclasses that override this method must call super.tearDown(), likely after any other code in that method.

Throws:

java.lang.Exception

See Also:

junit.framework.TestCase#tearDown()

initRemoteLogging

protected void initRemoteLogging()

Sets up the test client logger(s) to send log records to the remote log service. Only one attempt to connect to the remote logger is made. If it fails, remote logging will be disabled.

Override this method to prevent remote logging.

getLogReceiver

protected LogReceiver getLogReceiver()
                              throws AcsJContainerServicesEx

Gets a LogReceiver which can be used to verify log messages from both local and remote processes. The returned LogReceiver is already initialized. If initialization fails, an exception is thrown.

To receive logs from the log service, use either LogReceiver.getLogQueue() or LogReceiver.startCaptureLogs(java.io.PrintWriter).

Throws:

AcsJContainerServicesEx - if the LogReceiver fails to initialize within 20 seconds.