sl@0: /*
sl@0: * Copyright (c) 1998-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_TESTHANDLER_H__
sl@0: #define __T_TESTHANDLER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: class MTestSpec;
sl@0: class Output;
sl@0: class CTestHandlerSettings;
sl@0: class CTestSetup;
sl@0: class CTestAction;
sl@0: class CTestRunner;
sl@0: 
sl@0: class TTestSummary
sl@0: 	{
sl@0: public:
sl@0: 	TTestSummary();
sl@0: 	TBool AllTestsPassed();
sl@0: 	void PrintL(Output& aOut);
sl@0: 	
sl@0: public:
sl@0: 	TInt iTestsRun;
sl@0: 	TInt iTestsFailed;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  * CTestHandler is the class which runs the tests, and outputs results
sl@0:  */
sl@0: class CTestHandler : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	/*
sl@0: 	* MTestSpec is the interface class, providing GetNextTest
sl@0: 	* TTestHandlerSettings provides the command line switches
sl@0: 	*
sl@0: 	* 
sl@0: 	*/
sl@0: 
sl@0: 	IMPORT_C static CTestHandler* NewLC(RFs& aFs, MTestSpec& aTestSpec, 
sl@0: 										CTestHandlerSettings& aSettings,
sl@0: 										CConsoleBase* aConsole,
sl@0: 										Output* aOut);
sl@0: 	~CTestHandler();
sl@0: 
sl@0: private:
sl@0: 	CTestHandler(RFs& aFs, MTestSpec& aTestSpec, CConsoleBase* aConsole,
sl@0: 				 Output* aOut);
sl@0: 	void ConstructL(CTestHandlerSettings& aSettings);
sl@0: 
sl@0: public:
sl@0:     // API for test programs
sl@0:     
sl@0: 	/// Run the test sequence
sl@0: 	IMPORT_C void RunTestsL();
sl@0: 
sl@0:     /**
sl@0:      * Set the test runner to use.  This object takes ownership.  Passing NULL
sl@0:      * means use the default test runner.
sl@0:      */
sl@0:     IMPORT_C void SetTestRunnerL(CTestRunner *aTestRunner);
sl@0: 
sl@0: public:
sl@0:     // API for test actions
sl@0: 
sl@0: 	/// Access to shared data
sl@0: 	CBase* SharedData() const;
sl@0: 	void SetSharedData(CBase* aData);
sl@0: 
sl@0:     /// Set the heap mark
sl@0:     void SetHeapMark(TInt aAllocCount);
sl@0: 
sl@0:     /// Get the heap mark
sl@0:     TInt HeapMark();
sl@0: 
sl@0: 	/// Get the count of tests run/failed
sl@0: 	TTestSummary Summary();
sl@0: 
sl@0: private:
sl@0:     /// The different possible locations a test can fail in.
sl@0:     enum TTestFailLocation
sl@0:         {
sl@0:         EFailInTestHandler,
sl@0:         EFailInPrerequisite,
sl@0:         EFailInAction
sl@0:         };
sl@0: 
sl@0:     /// Get the human readable name for a fail location
sl@0:     const TDesC& GetFailLocationName(TTestFailLocation aLoc);
sl@0: 
sl@0: private:
sl@0:     /**
sl@0:      * Run one test.  Called repeatedly by RunTestsL().
sl@0:      */
sl@0: 	void RunTestL(CTestAction* aAction);
sl@0:     /**
sl@0:      * Record a test failure. 
sl@0:      */
sl@0:     void FailTestL(CTestAction* aAction, TTestFailLocation aLoc, TInt aErr);
sl@0: 	/**
sl@0: 	 * Add a test to the list of failed tests.
sl@0: 	 */
sl@0: 	void AppendFailedTestL(TInt aIndex, const TDesC8& aName);
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 	 * This function prints the number of tests passed, failed, etc at the end of
sl@0: 	 * the test series.
sl@0: 	 */
sl@0: 	void DisplaySummary();
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 	 * Used by the test handler itself and the iManager
sl@0: 	 */
sl@0: 	RFs& iFs;
sl@0: 
sl@0: 	/**
sl@0: 	 * The settings that define the behaviour of the handler.
sl@0: 	 */
sl@0: 	CTestHandlerSettings *iSettings;
sl@0: 
sl@0: 	CConsoleBase* iConsole;
sl@0: 	Output* iOut;
sl@0: 
sl@0: 	CTestSetup* iTestSetup;
sl@0: 	CActiveScheduler* iScheduler;
sl@0: 
sl@0: 	MTestSpec& iTestSpec;
sl@0: 
sl@0: 	TInt iActionNumber;
sl@0: 	TInt iActionCount;
sl@0: 	
sl@0: 	/**
sl@0: 	 * After completion of the series of tests, this array contains the numbers of
sl@0: 	 * the failed tests.
sl@0: 	 */
sl@0: 	RArray<TInt> iFailedTests;
sl@0: 	/**
sl@0: 	 * After completion of the series of tests, this array contains the names of
sl@0: 	 * the failed tests.
sl@0: 	 */
sl@0: 	RPointerArray<HBufC> iFailedTestNames;
sl@0: 	/**
sl@0: 	 * After completion of the series of tests, this array contains the names
sl@0: 	 * of tests that failed because of known defects	 */
sl@0: 
sl@0: 	RPointerArray<HBufC> iKnownDefects;
sl@0: 
sl@0: 	/**
sl@0: 	 * Pointer to shared data.  This is initially NULL.  It can be accessed by
sl@0: 	 * any of the test actions.  If it is not NULL when this class is destroyed,
sl@0: 	 * it is deleted.
sl@0: 	 */
sl@0: 	CBase* iSharedData;
sl@0: 
sl@0:     /// Pointer to the current test runner.  We own this.
sl@0:     CTestRunner* iTestRunner;
sl@0: 
sl@0:     /// Pointer to the test runner to install when we've finished the current
sl@0:     /// test.  We own this.
sl@0:     CTestRunner* iNextTestRunner;
sl@0: 
sl@0:     /// The heap mark, used by heap mark actions 
sl@0:     TInt iHeapMark;
sl@0: 	};
sl@0: 
sl@0: #endif