alma::acs::component::client::ComponentClientTestCase Class Reference

Inherits junit::framework::TestCase.

Inherited by alma::acs::alarm::test::panel::AlarmContainerTest, alma::acs::alarm::test::panel::SpecialAlarmTest, alma::acs::alarmsystem::test::BACITest, alma::acs::callbacks::SampleRequester, alma::acs::component::client::ClientWithLogReceiverTest, alma::acs::component::client::ComponentClientTestCaseTest, alma::acs::container::ComponentTestclient, alma::acs::container::corba::AcsCorbaTestWithContainer, alma::acs::container::corba::ClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerMonitorTest, alma::acs::container::corba::ThreadDelayTest, alma::acs::jlog::test::EngineFilteringTest, alma::acs::jlog::test::ErrorLogFileTest, alma::acs::lasercore::test::CoreCDBAlarmTest, alma::acs::lasercore::test::IDLSendAlarmTest, alma::acs::lasercore::test::StressTest, alma::acs::lasercore::test::TestAlarmDAO, alma::acs::lasercore::test::TestAlarmService, alma::ACS::MasterComponentImpl::MasterComponentTest, alma::acs::nc::AnyAideTest, alma::acs::nc::ConsumerWithComponentClientTestCaseTest, alma::acs::nc::HelperTest, alma::acs::nc::refactored::NCPublisherTest, alma::acs::nc::refactored::NCSubscriberTest, alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentTest, alma::acsexmpl::clients::ErrorComponentTest, alma::acsjms::test::MessageTest, alma::acsjms::test::PubSubTest, alma::alarmsystem::clients::test::CategoryClientChildren, alma::alarmsystem::clients::test::CategoryClientParent, alma::alarmsystem::clients::test::CategoryClientTest, alma::alarmsystem::clients::test::CategoryClientThreshold, alma::alarmsystem::clients::test::TestCategoryActiveChildren, alma::alarmsystem::clients::test::UserPropsTest, alma::alarmsystem::source::test::FactoryTest, alma::alarmsystem::source::test::ProxyTest, alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest, alma::COUNTER::CounterTestImpl::CounterTest, alma::demo::client::LampAccessClient, alma::demo::client::XmlComponentClient, alma::demo::test::client::ArchiveConsumerTest, alma::lasersource::test::ObjectsTest, alma::lasersource::test::SendTest, alma::lasersource::test::SourceStressTest, alma::lifecycleTest::TestLifeCycleCompImpl::TestMultipleComponents, alma::nctest::clients::ClosedLoopEventTest, com::cosylab::acs::alarm::ACSCategoryDAOTest, utfsm::Loader, and utfsm::TestAlarmDAO.

Collaboration diagram for alma::acs::component::client::ComponentClientTestCase:

[legend]

List of all members.

Public Member Functions
	ComponentClientTestCase (String name) throws Exception
Protected Member Functions
void	runTest () throws Throwable
void	setUp () throws Exception
void	connectToManager () throws Exception
String	getFullName ()
ContainerServices	getContainerServices ()
void	tearDown () throws Exception
void	initRemoteLogging ()
LogReceiver	getLogReceiver () throws AcsJContainerServicesEx
Protected Attributes
AcsCorba	acsCorba
AcsManagerProxy	m_acsManagerProxy
AcsLogger	m_logger
String	m_managerLoc
Private Attributes
ContainerServicesImpl	m_containerServices
CleaningDaemonThreadFactory	m_threadFactory
LogReceiver	logReceiver
ManagerClient	managerClientImpl
Client	m_managerClient
String	m_namePrefix

Detailed Description

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

Constructor & Destructor Documentation

alma::acs::component::client::ComponentClientTestCase::ComponentClientTestCase ( String name ) throws Exception [inline]

Subclasses must call this ctor.

Parameters:

name

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

Exceptions:

Exception

References m_namePrefix.

Member Function Documentation

void alma::acs::component::client::ComponentClientTestCase::connectToManager ( ) throws Exception [inline, protected]

Connects to the ACS Manager using AcsManagerProxy.

Exceptions:

Exception

References si::ijs::maci::ClientPOA::_this(), acsCorba, getFullName(), alma::acs::container::corba::AcsCorba::getORB(), alma::acs::container::AcsManagerProxy::loginToManager(), alma::acs::container::AcsManagerProxy::logoutFromManager(), m_acsManagerProxy, m_logger, m_managerClient, m_managerLoc, and managerClientImpl.

Referenced by setUp().

ContainerServices alma::acs::component::client::ComponentClientTestCase::getContainerServices ( ) [inline, protected]

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

References m_containerServices.

String alma::acs::component::client::ComponentClientTestCase::getFullName ( ) [inline, protected]

References m_namePrefix.

Referenced by connectToManager(), runTest(), and setUp().

LogReceiver alma::acs::component::client::ComponentClientTestCase::getLogReceiver ( ) throws AcsJContainerServicesEx [inline, protected]

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).

Exceptions:

AcsJContainerServicesEx

if the LogReceiver fails to initialize within 20 seconds.

References acsCorba, alma::acs::container::AcsManagerProxy::getManager(), alma::acs::container::corba::AcsCorba::getORB(), alma::acs::logging::engine::LogReceiver::initialize(), logReceiver, m_acsManagerProxy, and alma::JavaContainerError::wrappers::AcsJContainerServicesEx::setContextInfo().

Referenced by alma::acs::component::client::ClientWithLogReceiverTest::setUp(), and alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest::testLoggingConfigurableCentralLogLevels().

void alma::acs::component::client::ComponentClientTestCase::initRemoteLogging ( ) [inline, protected]

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.

References acsCorba, alma::acs::container::AcsManagerProxy::getManager(), alma::acs::container::AcsManagerProxy::getManagerHandle(), alma::acs::container::corba::AcsCorba::getORB(), m_acsManagerProxy, and m_logger.

Referenced by setUp().

void alma::acs::component::client::ComponentClientTestCase::runTest ( ) throws Throwable [inline, protected]

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

See also:: junit.framework.TestCase::runTest()

Since:: ACS 6.0

References getFullName(), alma::acs::logging::AcsLogger::log(), and m_logger.

void alma::acs::component::client::ComponentClientTestCase::setUp ( ) throws Exception [inline, protected]

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.

See also:: junit.framework.TestCase::setUp()

Reimplemented in alma::acs::callbacks::SampleRequester, alma::acsjms::test::MessageTest, alma::acsjms::test::PubSubTest, alma::alarmsystem::clients::test::CategoryClientChildren, alma::alarmsystem::clients::test::CategoryClientParent, alma::alarmsystem::clients::test::CategoryClientTest, alma::alarmsystem::clients::test::CategoryClientThreshold, alma::alarmsystem::clients::test::TestCategoryActiveChildren, alma::alarmsystem::clients::test::UserPropsTest, alma::acs::alarm::test::panel::AlarmContainerTest, alma::acs::alarm::test::panel::SpecialAlarmTest, utfsm::TestAlarmDAO, alma::acs::alarmsystem::test::BACITest, alma::acs::lasercore::test::CoreCDBAlarmTest, alma::acs::lasercore::test::IDLSendAlarmTest, alma::acs::lasercore::test::StressTest, alma::acs::lasercore::test::TestAlarmDAO, alma::acs::lasercore::test::TestAlarmService, com::cosylab::acs::alarm::ACSCategoryDAOTest, alma::lasersource::test::ObjectsTest, alma::lasersource::test::SendTest, alma::lasersource::test::SourceStressTest, alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest, alma::COUNTER::CounterTestImpl::CounterTest, alma::lifecycleTest::TestLifeCycleCompImpl::TestMultipleComponents, alma::alarmsystem::source::test::FactoryTest, alma::alarmsystem::source::test::ProxyTest, alma::acs::component::client::ClientWithLogReceiverTest, alma::acs::container::ComponentTestclient, alma::acs::container::corba::AcsCorbaTestWithContainer, alma::acs::container::corba::ClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerMonitorTest, alma::acs::container::corba::ThreadDelayTest, alma::acsexmpl::clients::ErrorComponentTest, alma::demo::client::LampAccessClient, alma::demo::client::XmlComponentClient, alma::acs::component::client::ComponentClientTestCaseTest, alma::acs::nc::AnyAideTest, alma::acs::nc::ConsumerWithComponentClientTestCaseTest, alma::acs::nc::HelperTest, alma::acs::nc::refactored::NCPublisherTest, alma::acs::nc::refactored::NCSubscriberTest, alma::demo::test::client::ArchiveConsumerTest, alma::acs::jlog::test::ErrorLogFileTest, alma::acs::jlog::test::EngineFilteringTest, alma::ACS::MasterComponentImpl::MasterComponentTest, alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentTest, and alma::nctest::clients::ClosedLoopEventTest.

References acsCorba, connectToManager(), alma::acs::container::corba::AcsCorba::doneCorba(), getFullName(), alma::acs::container::AcsManagerProxy::getManagerHandle(), alma::acs::container::corba::AcsCorba::initCorbaForClient(), initRemoteLogging(), alma::acs::logging::AcsLogger::log(), m_acsManagerProxy, m_containerServices, m_logger, m_namePrefix, m_threadFactory, managerClientImpl, alma::acs::component::client::ManagerClient::setContainerServices(), and alma::acs::container::corba::AcsCorba::shutdownORB().

void alma::acs::component::client::ComponentClientTestCase::tearDown ( ) throws Exception [inline, protected]

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.

See also:: junit.framework.TestCase::tearDown()

Reimplemented in alma::acsjms::test::MessageTest, alma::acsjms::test::PubSubTest, alma::alarmsystem::clients::test::CategoryClientChildren, alma::alarmsystem::clients::test::CategoryClientParent, alma::alarmsystem::clients::test::CategoryClientTest, alma::alarmsystem::clients::test::CategoryClientThreshold, alma::alarmsystem::clients::test::UserPropsTest, alma::acs::alarm::test::panel::AlarmContainerTest, utfsm::TestAlarmDAO, alma::acs::alarmsystem::test::BACITest, alma::acs::lasercore::test::CoreCDBAlarmTest, alma::acs::lasercore::test::IDLSendAlarmTest, alma::acs::lasercore::test::StressTest, alma::acs::lasercore::test::TestAlarmDAO, alma::acs::lasercore::test::TestAlarmService, alma::lasersource::test::ObjectsTest, alma::lasersource::test::SendTest, alma::lasersource::test::SourceStressTest, alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest, alma::COUNTER::CounterTestImpl::CounterTest, alma::alarmsystem::source::test::FactoryTest, alma::alarmsystem::source::test::ProxyTest, alma::acs::component::client::ClientWithLogReceiverTest, alma::acs::container::corba::AcsCorbaTestWithContainer, alma::acs::container::corba::ClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerClientPendingReplyTimeoutTest, alma::acs::container::corba::ContainerMonitorTest, alma::acs::container::corba::ThreadDelayTest, alma::acsexmpl::clients::ErrorComponentTest, alma::acs::component::client::ComponentClientTestCaseTest, alma::acs::nc::AnyAideTest, alma::acs::nc::ConsumerWithComponentClientTestCaseTest, alma::acs::nc::HelperTest, alma::acs::nc::refactored::NCPublisherTest, alma::demo::test::client::ArchiveConsumerTest, alma::acs::jlog::test::EngineFilteringTest, alma::ACS::MasterComponentImpl::MasterComponentTest, alma::ACS::SpecialTestMasterComponentImpl::SpecialTestMasterComponentTest, and alma::nctest::clients::ClosedLoopEventTest.

References acsCorba, alma::acs::container::ContainerServicesImpl::cleanUp(), alma::acs::container::CleaningDaemonThreadFactory::cleanUp(), alma::acs::container::corba::AcsCorba::doneCorba(), alma::acs::logging::engine::LogReceiver::isInitialized(), alma::acs::container::AcsManagerProxy::logoutFromManager(), logReceiver, m_acsManagerProxy, m_containerServices, m_threadFactory, alma::acs::container::ContainerServicesImpl::releaseAllComponents(), alma::acs::container::AcsManagerProxy::shutdownNotify(), alma::acs::container::corba::AcsCorba::shutdownORB(), and alma::acs::logging::engine::LogReceiver::stop().

Member Data Documentation

AcsCorba alma::acs::component::client::ComponentClientTestCase::acsCorba [protected]

Referenced by connectToManager(), getLogReceiver(), initRemoteLogging(), alma::acs::container::corba::ContainerMonitorTest::setUp(), setUp(), tearDown(), and alma::acs::container::ComponentTestclient::testComponentListening().

LogReceiver alma::acs::component::client::ComponentClientTestCase::logReceiver [private]

Reimplemented in alma::acs::component::client::ClientWithLogReceiverTest.

Referenced by getLogReceiver(), and tearDown().

AcsManagerProxy alma::acs::component::client::ComponentClientTestCase::m_acsManagerProxy [protected]

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.

Referenced by connectToManager(), getLogReceiver(), initRemoteLogging(), alma::contLogTest::TestLogLevelsCompImpl::TestLogLevelsCompTest::setUp(), alma::alarmsystem::source::test::ProxyTest::setUp(), alma::alarmsystem::source::test::FactoryTest::setUp(), alma::COUNTER::CounterTestImpl::CounterTest::setUp(), setUp(), tearDown(), and alma::acs::lasercore::test::CoreCDBAlarmTest::testCDBAlarm().