CTestController Class Reference
| class CTestController : public CBase |
Comments : Manages the whole test procedure.
Constructor & Destructor Documentation
CTestController(CActiveScheduler *, RTest *)
~CTestController()
| IMPORT_C | ~CTestController | ( | ) | [virtual] |
Intended Usage : Standardized virtual destruction method
- Since
- 7.0
Member Functions Documentation
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)
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
DataLogger()
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()
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)
-
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
NewL(CActiveScheduler *, ComponentTesterInitialiserLC, RTest *, TLoggingInfo *)
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 *)
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()
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 > *)
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.
Start(TRequestStatus *)
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 > *)
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.
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
The status word of the client (if tests were run asynchronously). Will be completed when all tests have finished running.
CDataLogger * iDataLogger
Provides the file logging capability
TBool
iOwnScheduler
|
TBool
| iOwnScheduler | [private] |
Flag indicating if we own the active scheduler in iScheduler
RTest * iRTest
Optional reference to the RTest object used in the EXE test harness code which kicked off this test framework
CActiveScheduler * iScheduler
Placeholder for an active scheduler if one is passed in on creation
RPointerArray< CComponentInfo > iTestList
A list of the available tests
CTestManager * iTestManager
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.