Symbian^3 Application Developer Library >

CTestController Class Reference

class CTestController : public CBase

Comments : Manages the whole test procedure.

Inherits from

Public Member Functions
~CTestController ()
IMPORT_C void Cancel ()
IMPORT_C CDataLogger & DataLogger ()
IMPORT_C const RPointerArray < CComponentInfo > & FindComponents ()
IMPORT_C CTestController * NewL ( CActiveScheduler *, ComponentTesterInitialiserLC , RTest *, TLoggingInfo *)
IMPORT_C CTestController * NewLC ( CActiveScheduler *, ComponentTesterInitialiserLC , RTest *, TLoggingInfo *)
IMPORT_C void Start ()
IMPORT_C void Start ( RPointerArray < TTestInfo > *)
IMPORT_C void Start ( TRequestStatus *)
IMPORT_C void Start ( TRequestStatus *, RPointerArray < TTestInfo > *)
Private Member Functions
CTestController ( CActiveScheduler *, RTest *)
void ConstructL ( TLoggingInfo *, ComponentTesterInitialiserLC )
void InitialiseComponentTesterL ( ComponentTesterInitialiserLC )
void TestsComplete ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TRequestStatus * iClientStatus
CDataLogger * iDataLogger
TBool iOwnScheduler
RTest * iRTest
CActiveScheduler * iScheduler
RPointerArray < CComponentInfo > iTestList
CTestManager * iTestManager

Constructor & Destructor Documentation

CTestController(CActiveScheduler *, RTest *)

CTestController ( CActiveScheduler * aScheduler,
RTest * aRTest = NULL
) [private]

Parameters

CActiveScheduler * aScheduler
RTest * aRTest = NULL

~CTestController()

IMPORT_C ~CTestController ( ) [virtual]
Intended Usage : Standardized virtual destruction method
Since
7.0

Member Functions Documentation

Cancel()

IMPORT_C void Cancel ( )
Intended Usage : Cancels any outstanding tests.
Since
7.0
Pre-condition
This object has been created and the asynchronous version of Start has been called.
Post-condition
Any outstanding tests have been cancelled.

ConstructL(TLoggingInfo *, ComponentTesterInitialiserLC)

void ConstructL ( TLoggingInfo * aLogInfo,
ComponentTesterInitialiserLC aEntryPoint
) [private]
Intended Usage : Completes the safe construction of the CTestController object
leave
KErrNoMemory.
Since
7.0
Pre-condition
First phase of construction is complete
Post-condition
Object is fully constructed

Parameters

TLoggingInfo * aLogInfo The logging configuration information
ComponentTesterInitialiserLC aEntryPoint The global function used to create the derived CComponentTester object.

DataLogger()

IMPORT_C CDataLogger & DataLogger ( ) [static]
Intended Usage : Returns a reference to the file logging functionality for use by the user interface component.
Since
7.0
Pre-condition
The CTestController has been created so that the data logger exists
Post-condition
Unspecified

FindComponents()

IMPORT_C const RPointerArray < CComponentInfo > & FindComponents ( ) const
Intended Usage : Returns an array of the components available for testing Error Condition :
Since
7.0
Pre-condition
The object is fully constructed
Post-condition
Returns an array of the available components which can be used to select which test to run.

InitialiseComponentTesterL(ComponentTesterInitialiserLC)

void InitialiseComponentTesterL ( ComponentTesterInitialiserLC aEntryPointLC ) [private]
leave
KErrNoMemory. Intended Usage : Called during construction to find all test modules Error Condition :
Since
7.0
Pre-condition
None
Post-condition
A list of all tests is available

Parameters

ComponentTesterInitialiserLC aEntryPointLC The global function used to create the derived CComponentTester object.

NewL(CActiveScheduler *, ComponentTesterInitialiserLC, RTest *, TLoggingInfo *)

IMPORT_C CTestController * NewL ( CActiveScheduler * aScheduler,
ComponentTesterInitialiserLC aEntryPoint,
RTest * aRTest = NULL,
TLoggingInfo * aLogInfo = NULL
) [static]
Intended Usage : Standardized safe construction which leaves nothing on the cleanup stack.
leave
KErrNoMemory.
Since
7.0
Pre-condition
None
Post-condition
Nothing is on the CleanupStack

Parameters

CActiveScheduler * aScheduler The active scheduler to use, pass NULL if no scheduler exists
ComponentTesterInitialiserLC aEntryPoint The global function used to create the derived CComponentTester object.
RTest * aRTest = NULL Optional RTest object to use in check unit test results
TLoggingInfo * aLogInfo = NULL The logging info to use, defaults to NULL

NewLC(CActiveScheduler *, ComponentTesterInitialiserLC, RTest *, TLoggingInfo *)

IMPORT_C CTestController * NewLC ( CActiveScheduler * aScheduler,
ComponentTesterInitialiserLC aEntryPoint,
RTest * aRTest = NULL,
TLoggingInfo * aLogInfo = NULL
) [static]
Intended Usage : Standardized safe construction which leaves CTestController* on the cleanup stack.
leave
KErrNoMemory.
Since
7.0
Pre-condition
None
Post-condition
CTestController is on the CleanupStack

Parameters

CActiveScheduler * aScheduler The active scheduler, if one exists, otherwise NULL
ComponentTesterInitialiserLC aEntryPoint The global function used to create the derived CComponentTester object.
RTest * aRTest = NULL Optional RTest object to use in check unit test results
TLoggingInfo * aLogInfo = NULL The logging configuration information

Start()

IMPORT_C void Start ( )
Intended Usage : Starts the testbed and runs all tests on all components. This function runs synchronously and does not return until all tests are complete.
Since
7.0
Pre-condition
This object is constructed
Post-condition
Starts the active scheduler and therefore doesn't complete until the active scheduler is stopped.

Start(RPointerArray< TTestInfo > *)

IMPORT_C void Start ( RPointerArray < TTestInfo > * aTests )
Intended Usage : Starts the specified tests.This function runs synchronously and does not return until all tests are complete.
Since
7.0
Pre-condition
This object is constructed
Post-condition
Starts the active scheduler and therefore doesn't complete until the active scheduler is stopped.

Parameters

RPointerArray < TTestInfo > * aTests The list of tests to be run.

Start(TRequestStatus *)

IMPORT_C void Start ( TRequestStatus * aStatus )
Intended Usage : Starts the testbed and runs all tests on all components. This function runs asynchronously and completes aStatus when all tests are complete.
Since
7.0
Pre-condition
This object is constructed
Post-condition
An asynchronous request is issued to run all tests.

Parameters

TRequestStatus * aStatus Status word for the calling function. Is completed when all tests are complete.

Start(TRequestStatus *, RPointerArray< TTestInfo > *)

IMPORT_C void Start ( TRequestStatus * aStatus,
RPointerArray < TTestInfo > * aTests
)
Intended Usage : Starts the specified tests. If the default for aTest is used then all tests are run on all components. This function runs asynchronously and completes aStatus when all tests are complete.
Since
7.0
Pre-condition
This object is constructed.
Post-condition
An asynchronous request is issued to run the specified tests.

Parameters

TRequestStatus * aStatus Status word for the calling function. Is completed when all tests are complete.
RPointerArray < TTestInfo > * aTests The list of tests to be run.

TestsComplete()

void TestsComplete ( ) [private]
Intended Usage : Called by the CTestManager to indicate that all tests are complete. Either stops the active scheduler if in synchronous mode or completes the client if in async mode.
Since
7.0
Pre-condition
This object is constructed
Post-condition
Appropriate action is taken to complete the tests.

Member Data Documentation

TRequestStatus * iClientStatus

TRequestStatus * iClientStatus [private]

The status word of the client (if tests were run asynchronously). Will be completed when all tests have finished running.

CDataLogger * iDataLogger

CDataLogger * iDataLogger [private]

Provides the file logging capability

TBool iOwnScheduler

TBool iOwnScheduler [private]

Flag indicating if we own the active scheduler in iScheduler

RTest * iRTest

RTest * iRTest [private]

Optional reference to the RTest object used in the EXE test harness code which kicked off this test framework

CActiveScheduler * iScheduler

CActiveScheduler * iScheduler [private]

Placeholder for an active scheduler if one is passed in on creation

RPointerArray< CComponentInfo > iTestList

RPointerArray < CComponentInfo > iTestList [private]

A list of the available tests

CTestManager * iTestManager

CTestManager * iTestManager [private]

Starts the tests and stops the active scheduler when finished

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.