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_TESTACTION_H__
sl@0: #define __T_TESTACTION_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: #include "t_testactionspec.h"
sl@0: 
sl@0: class CConsoleBase;
sl@0: class CConsoleBase;
sl@0: class Output;
sl@0: class CTestHandler;
sl@0: 
sl@0: const TInt KMaxErrorSize = 100;
sl@0: 
sl@0: class CTestAction : public CBase 
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C virtual ~CTestAction();
sl@0: 
sl@0: public:
sl@0: 	enum TScriptError
sl@0: 		{
sl@0: 		ENone,
sl@0: 		ESyntax,
sl@0: 		EFileNotFound
sl@0: 		};
sl@0: 	IMPORT_C virtual void PerformPrerequisite(TRequestStatus& aStatus);
sl@0: 	virtual void PerformAction(TRequestStatus& aStatus) = 0;
sl@0: 	IMPORT_C virtual void PerformPostrequisite(TRequestStatus& aStatus);
sl@0: 	TBool Finished();
sl@0: 	IMPORT_C virtual void ReportAction();
sl@0: 	IMPORT_C virtual void CheckResult(TInt aError);
sl@0: 	IMPORT_C void virtual FailTestNow(TRequestStatus& aStatus);
sl@0: 	IMPORT_C virtual TScriptError ScriptError(void);
sl@0: 	IMPORT_C virtual void ScriptError(TDes& aError);
sl@0: 	IMPORT_C virtual void SetScriptError(const TScriptError &iScriptError, const TDesC& aError);
sl@0: 
sl@0: 	// Specific functions for testing cancellation
sl@0: public:
sl@0: 	IMPORT_C virtual void PerformCancel();
sl@0: 
sl@0: 	// Specific functions for testing OOM
sl@0: public:
sl@0: 	IMPORT_C virtual void Reset();
sl@0: 	IMPORT_C virtual void AfterOOMFailure();
sl@0: 	IMPORT_C virtual void ResetState();
sl@0: 
sl@0: 	// Functions for accessing data shared between all test actions in a test run
sl@0: public:
sl@0: 	void SetTestHandler(CTestHandler& aTestHandler);
sl@0: protected:
sl@0: 	IMPORT_C CBase* SharedData() const;
sl@0: 	IMPORT_C void SetSharedData(CBase* aData);
sl@0: 	
sl@0: protected:
sl@0: 	IMPORT_C CTestAction(CConsoleBase& aConsole, Output& aOut);
sl@0: 	IMPORT_C void ConstructL(const TTestActionSpec& aTestActionSpec);
sl@0: 
sl@0: private:
sl@0: 	IMPORT_C virtual void DoPerformPrerequisite(TRequestStatus& aStatus);
sl@0: 	IMPORT_C virtual void DoPerformPostrequisite(TRequestStatus& aStatus);
sl@0: 	virtual void DoReportAction() = 0;
sl@0: 	virtual void DoCheckResult(TInt aError) = 0;
sl@0: public:
sl@0: 	enum TActionState
sl@0: 		{
sl@0: 		EPrerequisite,
sl@0: 		EAction,
sl@0: 		EPostrequisite
sl@0: 		};
sl@0: 
sl@0: protected:
sl@0: 	TBool iFinished;
sl@0: 	TInt iExpectedResult;
sl@0: 
sl@0: public:
sl@0: 	/**
sl@0: 	 * After the test, this will be ETrue if the test succeeded or EFalse otherwise.
sl@0: 	 */
sl@0: 	TBool iResult;
sl@0: 	
sl@0: 
sl@0: 	/**
sl@0: 	 * Inidicates if it s .script file
sl@0: 	 */
sl@0: 	TBool iTefScript;
sl@0: 	
sl@0: 	/**
sl@0: 	 * Denote a failure of any RUNTESTSTEP within a single TESTCASE
sl@0: 	 * */
sl@0: 	TBool iRunningResult;
sl@0: 	
sl@0: 	
sl@0: 	/**
sl@0: 	*	Indicates whether the test will fail because of known deferred defects etc
sl@0: 	*/
sl@0: 	TBool iKnownFailure;
sl@0: 	TActionState iActionState;
sl@0: 	HBufC8* iNameInfo;
sl@0: 
sl@0: protected:
sl@0: 	CConsoleBase& iConsole;
sl@0: 	Output& iOut;
sl@0: 	TBuf<KMaxErrorSize> aScriptErrorDescription;
sl@0: 	TScriptError iScriptError;
sl@0: 	CTestHandler* iTestHandler;
sl@0: 	};
sl@0: 
sl@0: #endif