Symbian^3 Application Developer Library >

CTestEngine Class Reference

class CTestEngine : public CSession2

Inherits from

Public Member Functions
RPointerArray < TEventMsg > & ClientEvents ()
void CloseSession ()
TInt CountResources ()
CTestEventController * CtlEventL (const TEventIf &, TRequestStatus &)
void EnumerationCompleted ( TInt , TInt )
void ErrorPrint (const TInt , TPtrC )
void ErrorPrint ( TErrorNotificationPckg )
void ExecuteCommandL ( TCommand , TDesC8 &)
void FlushAtsLogger ()
TPtrC GetDeviceResetDllName ()
CTestModuleController * GetFreeOrCreateModuleControllerL ( TTestInfo &, CTestModuleController **)
TInt GetIndexForNewTestModuleController (void)
TBool IsStateEventAndSet (const TName &)
void LeaveIfErrorWithNotify ( TInt , const TDesC &)
void LeaveIfErrorWithNotify ( TInt )
void LeaveWithNotifyL ( TInt , const TDesC &)
void LeaveWithNotifyL ( TInt )
CStifLogger * Logger ()
CTestEngine * NewL ( CTestEngineServer *)
void NumResources (const RMessage2 &)
void PanicClient ( TTestEnginePanic , const RMessage2 &)
void PauseAllTestCases ()
TInt ReadRebootParams ( TTestInfo &, TDes &, TInt &)
void ServiceL (const RMessage2 &)
TInt StifMeasurement ()
RPointerArray < CTestCase > & TestCaseArray ()
void TestModuleCrash ( CTestModuleController *)
TInt WriteRebootParams ( TTestInfo &, TInt &, TDesC &)
Private Member Functions
CTestEngine ()
void AddConfigFileL (const RMessage2 &)
TInt AddTestCaseToTestReport (const RMessage2 &)
void AddTestModuleL (const RMessage2 &)
void CancelAsyncRequest (const RMessage2 &)
void CloseLoggerSettings ()
void CloseTestEngineL ( TUint )
void ConstructL ( CTestEngineServer *)
void DeleteTestCase ( TUint )
TInt DisableStifMeasurement (const TDesC &)
void DispatchMessageL (const RMessage2 &)
TInt EnableStifMeasurement (const TDesC &)
void EnumerateTestCasesL (const RMessage2 &)
void EventControlL (const RMessage2 &)
void GetTestCasesL (const RMessage2 &)
void HandleErrorNotificationL (const RMessage2 &)
void InitEngineL (const RMessage2 &)
void InitTestReportAndLoggerVarL ()
void LoggerSettings (const RMessage2 &)
CTestModuleController * ModuleControllerByName (const TName &)
void NewTestCaseL (const RMessage2 &)
TInt ParseRebootParamsL ()
void ParseTestModulesL ( CStifParser *, CTestModuleList *, const TDesC &, const TDesC &)
void ProcessErrorQueue ()
void ReadEngineDefaultsL ( CStifParser *, CSTIFTestFrameworkSettings *)
void ReadTestModulesL ( CStifParser *)
void RemoveConfigFileL (const RMessage2 &)
TInt RemoveTestModuleL (const RMessage2 &)
void SetAttributeL (const RMessage2 &)
void SetLoggerSettings ( TLoggerSettings &)
CTestCase * TestCaseByHandle ( TUint , const RMessage2 &)
void TestModuleConfigFileL ( CTestModuleController *, CStifSectionParser *, TDesC &)
void UpdateEventL (const TEventIf &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
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()
CSession2::CSession2()
CSession2::Disconnect(const RMessage2 &)
CSession2::Extension_(TUint,TAny *&,TAny *)
CSession2::ResourceCountMarkEnd(const RMessage2 &)
CSession2::ResourceCountMarkStart()
CSession2::Server()const
CSession2::ServiceError(const RMessage2 &,TInt)
CSession2::SetServer(const CServer2 *)
CSession2::~CSession2()
Inherited Enumerations
CSession2:TPanicNo
Private Attributes
TInt iCaseCount
RPointerArray < TEventMsg > iClientEvents
TBool iComplete
CObjectCon * iContainer
TInt64 iDefaultTimeout
HBufC * iDeviceResetDllName
TInt iDisableMeasurement
TInt iEnumError
TInt iEnumerateModuleCount
RMessage2 iEnumerationMessage
RMessage2 iErrorMessage
TBool iErrorMessageAvailable
RArray < TErrorNotification > iErrorQueue
TInt iIndexTestModuleControllers
HBufC * iIniFile
TBool iIsTestReportGenerated
RPointerArray < CTestModuleController > iModules
TPtrC iRebootDefaultFilename
TPtrC iRebootDefaultPath
HBufC * iRebootFilename
CRebootParams * iRebootParams
HBufC * iRebootPath
TUint iReportMode
TUint iReportOutput
TInt iResourceCount
TInt iReturn
TBool iSeparateProcesses
RSettingServer iSettingServer
RPointerArray < HBufC > iStateEvents
RPointerArray < CTestCase > iTestCaseArray
CObjectIx * iTestCases
CTestEngineServer * iTestEngineServer
CObjectIx * iTestEngineSubSessions
RPointerArray < TTestModuleVersionInfo > iTestModulesVersionInfo
CTestReport * iTestReport
TBool iUITestingSupport

Constructor & Destructor Documentation

CTestEngine()

CTestEngine ( ) [private]

C++ default constructor.

Member Functions Documentation

AddConfigFileL(const RMessage2 &)

void AddConfigFileL ( const RMessage2 & aMessage ) [private]

Adds new config file to Test Module

Parameters

const RMessage2 & aMessage

AddTestCaseToTestReport(const RMessage2 &)

TInt AddTestCaseToTestReport ( const RMessage2 & aMessage ) [private]

Add test case info to test report.

Parameters

const RMessage2 & aMessage

AddTestModuleL(const RMessage2 &)

void AddTestModuleL ( const RMessage2 & aMessage ) [private]

Adds new Test Module

Parameters

const RMessage2 & aMessage

CancelAsyncRequest(const RMessage2 &)

void CancelAsyncRequest ( const RMessage2 & aMessage ) [private]

Cancel outstanding asynchronous request

Parameters

const RMessage2 & aMessage

ClientEvents()

RPointerArray < TEventMsg > & ClientEvents ( ) [inline]

Return client events.

CloseLoggerSettings()

void CloseLoggerSettings ( ) [private]

Close logger settings

CloseSession()

void CloseSession ( )

Close the session to CTestEngineServer .

CloseTestEngineL(TUint)

void CloseTestEngineL ( TUint aHandle ) [private]

Close Test Engine

Parameters

TUint aHandle

ConstructL(CTestEngineServer *)

void ConstructL ( CTestEngineServer * aServer ) [private]

By default Symbian OS constructor is private.

Parameters

CTestEngineServer * aServer

CountResources()

TInt CountResources ( ) [virtual]

Return the number of resources owned by the session. Required by CSession if derived class implements resource mark-start and mark-end protocol.

CtlEventL(const TEventIf &, TRequestStatus &)

CTestEventController * CtlEventL ( const TEventIf & aEvent,
TRequestStatus & aStatus
)

Callback to control events.

Parameters

const TEventIf & aEvent
TRequestStatus & aStatus

DeleteTestCase(TUint)

void DeleteTestCase ( TUint aHandle ) [private]

Destroy the created CTestCase subsession. Cannot fail - can panic client.

Parameters

TUint aHandle

DisableStifMeasurement(const TDesC &)

TInt DisableStifMeasurement ( const TDesC & aInfoType ) [private]

Set measurements related information, disable measurement.

Parameters

const TDesC & aInfoType

DispatchMessageL(const RMessage2 &)

void DispatchMessageL ( const RMessage2 & aMessage ) [private]

DispatchMessageL handles the messages to CTestEngineServer

Parameters

const RMessage2 & aMessage

EnableStifMeasurement(const TDesC &)

TInt EnableStifMeasurement ( const TDesC & aInfoType ) [private]

Set measurements related information, enable measurement.

Parameters

const TDesC & aInfoType

EnumerateTestCasesL(const RMessage2 &)

void EnumerateTestCasesL ( const RMessage2 & aMessage ) [private]

Enumerates test cases

Parameters

const RMessage2 & aMessage

EnumerationCompleted(TInt, TInt)

void EnumerationCompleted ( TInt aCount,
TInt aError =  KErrNone
)

Callback to inform that enumeration of test cases is completed

Parameters

TInt aCount
TInt aError =  KErrNone

ErrorPrint(const TInt, TPtrC)

void ErrorPrint ( const TInt aPriority,
TPtrC aError
)

ErrorPrint print errors. This version is used to print engine own errors.

Parameters

const TInt aPriority
TPtrC aError

ErrorPrint(TErrorNotificationPckg)

void ErrorPrint ( TErrorNotificationPckg aError )

ErrorPrint print errors. This version is used to forward errors.

Parameters

TErrorNotificationPckg aError

EventControlL(const RMessage2 &)

void EventControlL ( const RMessage2 & aMessage ) [private]

Event system control.

Parameters

const RMessage2 & aMessage

ExecuteCommandL(TCommand, TDesC8 &)

void ExecuteCommandL ( TCommand aCommand,
TDesC8 & aParamsPckg
)

Executes command received from test case. It was created to allow test case to kill itself.

Parameters

TCommand aCommand
TDesC8 & aParamsPckg

FlushAtsLogger()

void FlushAtsLogger ( )

Flush ATS logger buffers.

GetDeviceResetDllName()

TPtrC GetDeviceResetDllName ( )

Get device reset module's DLL name.

GetFreeOrCreateModuleControllerL(TTestInfo &, CTestModuleController **)

CTestModuleController * GetFreeOrCreateModuleControllerL ( TTestInfo & aTestInfo,
CTestModuleController ** aRealModuleController
)

Return free module controller specified by given parameter. If it can't be found, new one will be created.

Parameters

TTestInfo & aTestInfo
CTestModuleController ** aRealModuleController

GetIndexForNewTestModuleController(void)

TInt GetIndexForNewTestModuleController ( void )

Returns new index for test module controller. This number is appended to module controller name. This method is used when option to run every test case in separate process is set to on.

Parameters

void

GetTestCasesL(const RMessage2 &)

void GetTestCasesL ( const RMessage2 & aMessage ) [private]

Get test cases

Parameters

const RMessage2 & aMessage

HandleErrorNotificationL(const RMessage2 &)

void HandleErrorNotificationL ( const RMessage2 & iMessage ) [private]

Handles error notifications

Parameters

const RMessage2 & iMessage

InitEngineL(const RMessage2 &)

void InitEngineL ( const RMessage2 & aMessage ) [private]

Initialize the Test Engine.

Parameters

const RMessage2 & aMessage

InitTestReportAndLoggerVarL()

void InitTestReportAndLoggerVarL ( ) [private]

Initialize test report and logger's overwrite variables

IsStateEventAndSet(const TName &)

TBool IsStateEventAndSet ( const TName & aEventName )

Callback to check state event status.

Parameters

const TName & aEventName

LeaveIfErrorWithNotify(TInt, const TDesC &)

void LeaveIfErrorWithNotify ( TInt aCode,
const TDesC & aText
)

If error leave with notify

Parameters

TInt aCode
const TDesC & aText

LeaveIfErrorWithNotify(TInt)

void LeaveIfErrorWithNotify ( TInt aCode )

If error leave with notify

Parameters

TInt aCode

LeaveWithNotifyL(TInt, const TDesC &)

void LeaveWithNotifyL ( TInt aCode,
const TDesC & aText
)

Leave with notify

Parameters

TInt aCode
const TDesC & aText

LeaveWithNotifyL(TInt)

void LeaveWithNotifyL ( TInt aCode )

Leave with notify

Parameters

TInt aCode

Logger()

CStifLogger * Logger ( )

Return the pointer to CStifLogger owned by CTestEngineServer

LoggerSettings(const RMessage2 &)

void LoggerSettings ( const RMessage2 & iMessage ) [private]

Get Logger's overwrite parameters

Parameters

const RMessage2 & iMessage

ModuleControllerByName(const TName &)

CTestModuleController * ModuleControllerByName ( const TName & aModuleName ) [private]

Get module controller by name

Parameters

const TName & aModuleName

NewL(CTestEngineServer *)

CTestEngine * NewL ( CTestEngineServer * aServer ) [static]

NewL is two-phased constructor.

Parameters

CTestEngineServer * aServer

NewTestCaseL(const RMessage2 &)

void NewTestCaseL ( const RMessage2 & aMessage ) [private]

Create CTestCase subsession.

Parameters

const RMessage2 & aMessage

NumResources(const RMessage2 &)

void NumResources ( const RMessage2 & aMessage )

NumResources is used to provide reserver resources to client.

Parameters

const RMessage2 & aMessage

PanicClient(TTestEnginePanic, const RMessage2 &)

void PanicClient ( TTestEnginePanic aPanic,
const RMessage2 & aMessage
) const

PanicClient panics the user of CTestEngine ( RTestEngine user )

Parameters

TTestEnginePanic aPanic
const RMessage2 & aMessage

ParseRebootParamsL()

TInt ParseRebootParamsL ( ) [private]

Parse the Reboot related information from the file.

ParseTestModulesL(CStifParser *, CTestModuleList *, const TDesC &, const TDesC &)

void ParseTestModulesL ( CStifParser * aParser,
CTestModuleList * aModuleList,
const TDesC & aSectionStart,
const TDesC & aSectionEnd
) [private]

Parse and search for module info and fill list of modules.

Parameters

CStifParser * aParser
CTestModuleList * aModuleList
const TDesC & aSectionStart
const TDesC & aSectionEnd

PauseAllTestCases()

void PauseAllTestCases ( )

Pause all test case(s) which are/is running.

ProcessErrorQueue()

void ProcessErrorQueue ( ) [private]

Process error queue.

ReadEngineDefaultsL(CStifParser *, CSTIFTestFrameworkSettings *)

void ReadEngineDefaultsL ( CStifParser * aParser,
CSTIFTestFrameworkSettings * aSettings
) [private]

Parse Test Engine defaults from STIF initialization file.

Parameters

CStifParser * aParser
CSTIFTestFrameworkSettings * aSettings

ReadRebootParams(TTestInfo &, TDes &, TInt &)

TInt ReadRebootParams ( TTestInfo & aTestInfo,
TDes & aStateDes,
TInt & aState
)

Read the Reboot related information from the file.

Parameters

TTestInfo & aTestInfo
TDes & aStateDes
TInt & aState

ReadTestModulesL(CStifParser *)

void ReadTestModulesL ( CStifParser * aParser ) [private]

Parse Test modules and module information from STIFTestFramework initialization file.

Parameters

CStifParser * aParser

RemoveConfigFileL(const RMessage2 &)

void RemoveConfigFileL ( const RMessage2 & aMessage ) [private]

Removes config file from test module

Parameters

const RMessage2 & aMessage

RemoveTestModuleL(const RMessage2 &)

TInt RemoveTestModuleL ( const RMessage2 & aMessage ) [private]

Removes Test Module

Parameters

const RMessage2 & aMessage

ServiceL(const RMessage2 &)

void ServiceL ( const RMessage2 & aMessage ) [virtual]

ServiceL handles the messages to CTestEngineServer

Parameters

const RMessage2 & aMessage

SetAttributeL(const RMessage2 &)

void SetAttributeL ( const RMessage2 & aMessage ) [private]

Sets attributes to Test Framework

Parameters

const RMessage2 & aMessage

SetLoggerSettings(TLoggerSettings &)

void SetLoggerSettings ( TLoggerSettings & aLoggerSettings ) [private]

Set parsed logger's settings to TestEngine side.

Parameters

TLoggerSettings & aLoggerSettings

StifMeasurement()

TInt StifMeasurement ( )

Get measurements related information. Returns is measurement disable.

TestCaseArray()

RPointerArray < CTestCase > & TestCaseArray ( ) [inline]

Return testcases.

TestCaseByHandle(TUint, const RMessage2 &)

CTestCase * TestCaseByHandle ( TUint aHandle,
const RMessage2 & aMessage
) [private]

Resolve the correct CTestCase object

Parameters

TUint aHandle
const RMessage2 & aMessage

TestModuleConfigFileL(CTestModuleController *, CStifSectionParser *, TDesC &)

void TestModuleConfigFileL ( CTestModuleController * aModule,
CStifSectionParser * aSectionParser,
TDesC & aTag
) [private]

Parameters

CTestModuleController * aModule
CStifSectionParser * aSectionParser
TDesC & aTag

TestModuleCrash(CTestModuleController *)

void TestModuleCrash ( CTestModuleController * aTestModuleController )

For Recovering from serious testmodulecrash situations (KErrserverTerminated (-15)) Clones TestModuleController

Parameters

CTestModuleController * aTestModuleController

UpdateEventL(const TEventIf &)

void UpdateEventL ( const TEventIf & aEvent ) [private]

Update state event list.

Parameters

const TEventIf & aEvent

WriteRebootParams(TTestInfo &, TInt &, TDesC &)

TInt WriteRebootParams ( TTestInfo & aTestInfo,
TInt & aCode,
TDesC & aName
)

Write the Reboot related information to file.

Parameters

TTestInfo & aTestInfo
TInt & aCode
TDesC & aName

Member Data Documentation

TInt iCaseCount

TInt iCaseCount [private]

RPointerArray< TEventMsg > iClientEvents

RPointerArray < TEventMsg > iClientEvents [private]

TBool iComplete

TBool iComplete [private]

CObjectCon * iContainer

CObjectCon * iContainer [private]

TInt64 iDefaultTimeout

TInt64 iDefaultTimeout [private]

HBufC * iDeviceResetDllName

HBufC * iDeviceResetDllName [private]

TInt iDisableMeasurement

TInt iDisableMeasurement [private]

TInt iEnumError

TInt iEnumError [private]

TInt iEnumerateModuleCount

TInt iEnumerateModuleCount [private]

RMessage2 iEnumerationMessage

RMessage2 iEnumerationMessage [private]

RMessage2 iErrorMessage

RMessage2 iErrorMessage [private]

TBool iErrorMessageAvailable

TBool iErrorMessageAvailable [private]

RArray< TErrorNotification > iErrorQueue

RArray < TErrorNotification > iErrorQueue [private]

TInt iIndexTestModuleControllers

TInt iIndexTestModuleControllers [private]

HBufC * iIniFile

HBufC * iIniFile [private]

TBool iIsTestReportGenerated

TBool iIsTestReportGenerated [private]

RPointerArray< CTestModuleController > iModules

RPointerArray < CTestModuleController > iModules [private]

TPtrC iRebootDefaultFilename

TPtrC iRebootDefaultFilename [private]

TPtrC iRebootDefaultPath

TPtrC iRebootDefaultPath [private]

HBufC * iRebootFilename

HBufC * iRebootFilename [private]

CRebootParams * iRebootParams

CRebootParams * iRebootParams [private]

HBufC * iRebootPath

HBufC * iRebootPath [private]

TUint iReportMode

TUint iReportMode [private]

TUint iReportOutput

TUint iReportOutput [private]

TInt iResourceCount

TInt iResourceCount [private]

TInt iReturn

TInt iReturn [private]

TBool iSeparateProcesses

TBool iSeparateProcesses [private]

RSettingServer iSettingServer

RSettingServer iSettingServer [private]

RPointerArray< HBufC > iStateEvents

RPointerArray < HBufC > iStateEvents [private]

RPointerArray< CTestCase > iTestCaseArray

RPointerArray < CTestCase > iTestCaseArray [private]

CObjectIx * iTestCases

CObjectIx * iTestCases [private]

CTestEngineServer * iTestEngineServer

CTestEngineServer * iTestEngineServer [private]

CObjectIx * iTestEngineSubSessions

CObjectIx * iTestEngineSubSessions [private]

RPointerArray< TTestModuleVersionInfo > iTestModulesVersionInfo

RPointerArray < TTestModuleVersionInfo > iTestModulesVersionInfo [private]

CTestReport * iTestReport

CTestReport * iTestReport [private]

TBool iUITestingSupport

TBool iUITestingSupport [private]

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.