sl@0: /*
sl@0: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of the License "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __T_TESTRUNNER_H__
sl@0: #define __T_TESTRUNNER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: class Output;
sl@0: class CTestAction;
sl@0: 
sl@0: /**
sl@0:  * A class that is used to invoke individual tests.  This can be derived to
sl@0:  * implement OOM testing, cancel testing and the like.  The default
sl@0:  * implementation just runs the test.
sl@0:  *
sl@0:  * One instance of this class is used to run multiple tests.  A CTestHandler
sl@0:  * owns an instance of this class (or a class derived from it).
sl@0:  *
sl@0:  * Note that this class provides a synchronous interface, which is implemented
sl@0:  * in terms of CTestActions's asynchronous interface.
sl@0:  */
sl@0: class CTestRunner : public CActive
sl@0:     {
sl@0:  public:
sl@0:     IMPORT_C CTestRunner(Output& aOut);
sl@0:     IMPORT_C virtual ~CTestRunner();
sl@0: 
sl@0:     // The following methods return the status code from test action, but leave
sl@0:     // if there is an error in the test handler.
sl@0:     
sl@0:     IMPORT_C virtual TInt PerformPrerequisiteL(CTestAction* aAction);
sl@0:     IMPORT_C virtual TInt PerformActionL(CTestAction* aAction);
sl@0:     IMPORT_C virtual TInt PerformPostrequisiteL(CTestAction* aAction, TInt aInitialStatus);
sl@0: 
sl@0:  protected:
sl@0:     /// Typedef for any of CTestAction's async methods
sl@0:     typedef void (CTestAction::*TTestMethod)(TRequestStatus&);
sl@0:         
sl@0:     /// Run one of CTestAction's async methods synchronously and return the result
sl@0:     TInt RunAsyncMethodL(TTestMethod aMethod, CTestAction* aAction, TInt aInitialStatus);
sl@0: 
sl@0: 	/// Run the active scheduler until our request is completed
sl@0: 	void RunSchedulerL();
sl@0: 
sl@0: 	/// Run the active scheduler to process one outstanding request
sl@0: 	/// @return If our request has been completed yet
sl@0: 	TBool StepScheduler();
sl@0: 	
sl@0:  protected:
sl@0:     Output& iOut;
sl@0: 
sl@0:  private:
sl@0:     IMPORT_C virtual TInt RunError(TInt aError);
sl@0:     IMPORT_C virtual void DoCancel();
sl@0:     IMPORT_C virtual void RunL();
sl@0: 
sl@0:  private:
sl@0:     /// Whether an async method is currently being executed by the active scheduler
sl@0:     TBool iSchedulerRunning;  
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  * Abstract base class for a test runner that implements OOM testing.
sl@0:  */
sl@0: class COOMTestRunnerBase : public CTestRunner
sl@0:     {
sl@0:  public:
sl@0:     IMPORT_C virtual ~COOMTestRunnerBase();
sl@0: 
sl@0:  protected:
sl@0:     IMPORT_C COOMTestRunnerBase(Output& aOut);
sl@0: 
sl@0: 	/// Called at the start of the OOM test
sl@0: 	virtual void StartOOMTestL() = 0;	
sl@0: 	/// Increment the simulated heap fail point
sl@0: 	virtual void IncHeapFailPoint() = 0;
sl@0: 	/// Reset simulated heap failures
sl@0: 	virtual void ResetHeapFail() = 0;
sl@0: 	/// Get the number of cells currently allocated
sl@0: 	virtual TInt AllocCount() = 0;
sl@0: 	/// Called at the end of the OOM test
sl@0: 	virtual void EndOOMTestL() = 0;
sl@0: 	
sl@0:  private:
sl@0: 	// Override CTestRunner interface
sl@0:     IMPORT_C virtual TInt PerformActionL(CTestAction* aAction);
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  * Implementation of an test runner for OOM testing.
sl@0:  */
sl@0: class COOMTestRunner : public COOMTestRunnerBase
sl@0: 	{
sl@0:  public:
sl@0: 	COOMTestRunner(Output& aOut);
sl@0: 	virtual ~COOMTestRunner();
sl@0: 	
sl@0:  private:
sl@0: 	// Implement interface defined by COOMTestRunnerBase
sl@0: 	virtual void StartOOMTestL();	
sl@0: 	virtual void IncHeapFailPoint();
sl@0: 	virtual void ResetHeapFail();
sl@0: 	virtual TInt AllocCount();
sl@0: 	virtual void EndOOMTestL();
sl@0: 
sl@0:  private:
sl@0: 	TInt iFailPoint;
sl@0: 	};
sl@0: 
sl@0: /// A test runner that performs cancellation tests.
sl@0: class CCancelTestRunner : public CTestRunner
sl@0:     {
sl@0:  public:
sl@0:     CCancelTestRunner(Output& aOut);
sl@0:     virtual ~CCancelTestRunner();
sl@0: 
sl@0:     virtual TInt PerformActionL(CTestAction* aAction);
sl@0: 
sl@0:  private:
sl@0:     TInt RunAndCancelPeformActionMethod(CTestAction* aAction, TInt aInitialStatus,
sl@0:                                         TInt aCancelStep, TInt& aStep);
sl@0:     TInt RunAndCancelTestAction(CTestAction* aAction, TInt aCancelStep);
sl@0: 
sl@0:  private:
sl@0:     TBool iAbort;         ///< Set when we want to abort the test
sl@0:     };
sl@0: 
sl@0: #endif