sl@0: // Copyright (c) 2002-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 "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: // Public API for GT0137 Integration Test Framework
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __TESTFRAMEWORK_H__
sl@0: #define __TESTFRAMEWORK_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: #include <ecom/ecom.h>
sl@0: 
sl@0: #include <mmf/common/mmfipc.h>
sl@0: #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/common/mmfipcserver.h>
sl@0: #endif
sl@0: #include <testframeworkipc.h>
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Server name
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: _LIT(KTestFrameworkServerName, "TestFrameworkServer");
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Server .EXE name
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: 
sl@0: // Multimedia Heap Macros
sl@0: #define __MM_HEAP_MARK __UHEAP_MARK;
sl@0: #define __MM_HEAP_MARKEND REComSession::FinalClose(); __UHEAP_MARKEND;
sl@0: 
sl@0: 
sl@0: _LIT(KTestFrameworkServerImg, "z:\\system\\libs\\TestFrameworkServer.exe"); //<DLL/EXE name
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Server UID - MUST match the UID in TestFrameworkServer.mmp
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TUid KTestFrameworkServerUid3={0x101f45ef};
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Server stack/heap sizes.
sl@0:  * Only needed for WINS
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: // #if defined (__WINS__)
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * To specify a version when creating a session with the server
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TUint KTestFrameworkServerMajorVersionNumber = 1;
sl@0: const TUint KTestFrameworkServerMinorVersionNumber = 1;
sl@0: const TUint KTestFrameworkServerBuildVersionNumber = 1;
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Opcodes used in message passing between client and server
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TTestFrameworkRequest
sl@0:     {
sl@0:     ECreateInputWindow,
sl@0:     ENotifyIfWindowChange,
sl@0:     ECancelNotifyIfWindowChange,
sl@0:     EOpenLog,
sl@0:     EWriteLog,
sl@0:     ECloseLog,
sl@0:     ELogStatus,
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Bitmask flags for logging mode.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TTestFrameworkLogMode
sl@0:     {
sl@0:     ELogToConsole = 0x0001,
sl@0:     ELogToFile = 0x0002,
sl@0:     ELogToPort = 0x0004,
sl@0:     ELogConsoleFull = 0x0008
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * For passing window dimensions to console windows.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: typedef TPckgBuf<TRect> TRectBuf;
sl@0: 
sl@0: // Logging includes
sl@0: 
sl@0: /** 
sl@0:  *
sl@0:  * Max length of log file line and source filename.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TInt KMaxLogLineLength =  256;
sl@0: const TInt KMaxLogFilenameLength = 200;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Bitmask flags for logging severity levels.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TSeverity
sl@0:     {
sl@0:     ESevrErr  = 0x0001,
sl@0:     ESevrWarn = 0x0002,
sl@0:     ESevrInfo = 0x0004,
sl@0:     ESevrVer  = 0x0007,     // always log verdicts
sl@0:     ESevrAll  = 0x0007
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Static helper class for TSeverity.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class LogSeverity
sl@0:     {
sl@0: public:
sl@0:     IMPORT_C static TBool IsValid(TInt aSev);
sl@0:     IMPORT_C static TBool IsActive(TInt aThisSev, TInt aGlobalSev);
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Verdict enumerators for test results.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TVerdict
sl@0:     {
sl@0:     EPass = 0,
sl@0:     EFail,
sl@0:     EInconclusive,
sl@0:     ETestSuiteError,
sl@0:     EAbort,
sl@0: 
sl@0:     //A new TVerdict for a known failed test which cannot be fixed in the near 
sl@0:     //future, and is not allowed to be removed from the suite.
sl@0:     EKnownFailure 
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Logging client session class.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class RTestFrameworkClientSession : public RMmfSessionBaseX
sl@0:     {
sl@0: public:
sl@0:     RTestFrameworkClientSession();
sl@0:     TInt Connect();
sl@0:     void CreateInputWindow(TRectBuf& aAllocatedWindow, TRequestStatus& aReqStat);
sl@0:     void NotifyIfWindowChange(TRectBuf& aNewWindow, TRequestStatus& aReqStat);
sl@0:     TInt CancelNotifyIfWindowChange();
sl@0:     void OpenLog(const TDesC& aLogName, TInt aLogMode);
sl@0:     void OpenLog();
sl@0:     void WriteLog(const TDesC& aMsg, TInt aLogMode);
sl@0:     void CloseLog();
sl@0:     TInt LogStatus();
sl@0:     };
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Logging helper class, used to panic if format text overflows 
sl@0:  * the internal buffer.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class TIntegrationTestLog16Overflow :public TDes16Overflow
sl@0:     {
sl@0: public:
sl@0:     // TDes16Overflow pure virtual
sl@0:     virtual void Overflow(TDes16& aDes);
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Flags for logging mode.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TLogFlags
sl@0:     {
sl@0:     ELogPutSrcInfo = 0x01,
sl@0:     ELogHtmlMode = 0x02
sl@0:     };
sl@0: 
sl@0:  /**
sl@0:  *
sl@0:  * Logging class for all console/file/port output.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class CLog  : public CBase
sl@0:     {
sl@0: public:
sl@0:     IMPORT_C static CLog* NewL();
sl@0:     IMPORT_C static CLog* NewLC();
sl@0:     IMPORT_C void Construct();
sl@0:     IMPORT_C ~CLog();
sl@0: 
sl@0:     // open / close log file
sl@0:     IMPORT_C void OpenLogFileL(const TDesC& aLogName, TInt aLogMode);
sl@0:     IMPORT_C void OpenLogFileL();
sl@0:     IMPORT_C void CloseLogFile();
sl@0: 
sl@0:     // write to log output in Printf() style
sl@0:     IMPORT_C void Log(TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void Log(TInt aSeverity, TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void Log(TRefByValue<const TDesC16> aFmt, VA_LIST aList);
sl@0: 
sl@0:     IMPORT_C void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0:         TRefByValue<const TDesC16> aFmt, VA_LIST aList);
sl@0:     IMPORT_C void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0:         TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void LogResult(TVerdict aVerdict, TRefByValue<const TDesC16> aFmt, ...);
sl@0: 
sl@0:     // add some blank lines to log output
sl@0:     IMPORT_C void LogBlankLine(TInt aNumber = 1);
sl@0:     
sl@0:     // convert an EPOC error to text
sl@0:     IMPORT_C static TPtrC EpocErrorToText(TInt aError);
sl@0: 
sl@0:     // convert a test verdict to text 
sl@0:     IMPORT_C static TPtrC TestResultText(TVerdict aTestVerdict);
sl@0: 
sl@0:     // write formatted text to file - moved from CFileLogger
sl@0:     IMPORT_C void WriteFormat(TRefByValue<const TDesC16> aFmt, ...);
sl@0: 
sl@0:     // write text to console with date / time stamp
sl@0:     IMPORT_C void WriteLogConsole(const TDesC& aBuf);
sl@0: 
sl@0:     // get logging status from session
sl@0:     IMPORT_C TInt LogStatus();
sl@0: 
sl@0:     // accessors
sl@0:     IMPORT_C void SetSeverity(TInt aSeverity);
sl@0:     IMPORT_C TInt Severity() const; 
sl@0:     IMPORT_C void SetPutSrcInfo(TBool aPutSrcInfo);
sl@0:     IMPORT_C void SetHtmlLogMode(TBool aArg);
sl@0:     IMPORT_C TBool HtmlLogMode() const;
sl@0:     
sl@0: private:
sl@0:     // the client session
sl@0:     RTestFrameworkClientSession iClientSession;
sl@0: 
sl@0: protected:
sl@0:     // Current server logging status
sl@0:     TInt iLogStatus;
sl@0:     // Severity level
sl@0:     TInt iSeverity;
sl@0:     // Do we need to put information about source file & #line? Default is yes.
sl@0:     // Do we need to produce HTML log file? Default is yes.
sl@0:     TUint iLogFlags;
sl@0: 
sl@0:     // data buffer for logging - avoids panics in alloc testing
sl@0:     TBuf16<KMaxLogLineLength> iDataBuf;
sl@0:     };
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Print formatting macros.
sl@0:  * Any class which implements LogExtra() can use these.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: #define __FILE8__                                   REINTERPRET_CAST(const TText8*, __FILE__)
sl@0: 
sl@0: #define INFO_PRINTF1(p1)                            LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1)) 
sl@0: #define INFO_PRINTF2(p1, p2)                        LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2)) 
sl@0: #define INFO_PRINTF3(p1, p2, p3)                    LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3)) 
sl@0: #define INFO_PRINTF4(p1, p2, p3, p4)                LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4)) 
sl@0: #define INFO_PRINTF5(p1, p2, p3, p4, p5)            LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4), (p5)) 
sl@0: #define INFO_PRINTF6(p1, p2, p3, p4, p5, p6)        LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4), (p5), (p6)) 
sl@0: #define INFO_PRINTF7(p1, p2, p3, p4, p5, p6, p7)    LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7)) 
sl@0: #define INFO_PRINTF8(p1, p2, p3, p4, p5, p6, p7, p8)        LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8)) 
sl@0: #define INFO_PRINTF9(p1, p2, p3, p4, p5, p6, p7, p8, p9)    LogExtra(__FILE8__, __LINE__, ESevrInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9)) 
sl@0: 
sl@0: #define WARN_PRINTF1(p1)                            LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1)) 
sl@0: #define WARN_PRINTF2(p1, p2)                        LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2)) 
sl@0: #define WARN_PRINTF3(p1, p2, p3)                    LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2), (p3)) 
sl@0: #define WARN_PRINTF4(p1, p2, p3, p4)                LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2), (p3), (p4)) 
sl@0: #define WARN_PRINTF5(p1, p2, p3, p4, p5)            LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2), (p3), (p4), (p5)) 
sl@0: #define WARN_PRINTF6(p1, p2, p3, p4, p5, p6)        LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2), (p3), (p4), (p5), (p6)) 
sl@0: #define WARN_PRINTF7(p1, p2, p3, p4, p5, p6, p7)    LogExtra(__FILE8__, __LINE__, ESevrWarn, (p1), (p2), (p3), (p4), (p5), (p6), (p7)) 
sl@0: 
sl@0: #define ERR_PRINTF1(p1)                             LogExtra(__FILE8__, __LINE__, ESevrErr, (p1)) 
sl@0: #define ERR_PRINTF2(p1, p2)                         LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2)) 
sl@0: #define ERR_PRINTF3(p1, p2, p3)                     LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2), (p3)) ;
sl@0: #define ERR_PRINTF4(p1, p2, p3, p4)                 LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2), (p3), (p4)) 
sl@0: #define ERR_PRINTF5(p1, p2, p3, p4, p5)             LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2), (p3), (p4), (p5)) 
sl@0: #define ERR_PRINTF6(p1, p2, p3, p4, p5, p6)         LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2), (p3), (p4), (p5), (p6)) 
sl@0: #define ERR_PRINTF7(p1, p2, p3, p4, p5, p6, p7)     LogExtra(__FILE8__, __LINE__, ESevrErr, (p1), (p2), (p3), (p4), (p5), (p6), (p7)) 
sl@0: 
sl@0: #define TEST_START(p1)                              LogExtra(__FILE8__, __LINE__, ESevrInfo, (_L("======Start test %S")), (p1)) 
sl@0: #define TEST_NEXT(p1)                               LogExtra(__FILE8__, __LINE__, ESevrInfo, _L("Next test %S"), (p1)) 
sl@0: #define TEST_END()                                  LogExtra(__FILE8__, __LINE__, ESevrInfo, _L("======End test =====") ) 
sl@0: 
sl@0: // Test Suite includes
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Max length of test suite name.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TInt KMaxLenTestSuiteName = 55;
sl@0: 
sl@0: class RTestStep;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Enumerator to indicate what stage a test has reached.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: enum TTestStepStatus
sl@0:     {
sl@0:     EStepStatusNone = -1,
sl@0:     EStepStatusStart = 0,
sl@0:     EStepStatusPreamble,
sl@0:     EStepStatusTest,
sl@0:     EStepStatusFinished
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Base test suite class. All test suite classes
sl@0:  * derive from this.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class CTestSuite : public CBase
sl@0:     {
sl@0: public:
sl@0:     // second phase constructor
sl@0:     // NB this is public because it is called by the factory function
sl@0:     IMPORT_C void ConstructL();
sl@0:     // destructor
sl@0:     IMPORT_C virtual ~CTestSuite();
sl@0:     // add a test step to the suite
sl@0:     IMPORT_C void AddTestStepL(RTestStep* aTestStep);
sl@0:     // get stack and heap size of a named step
sl@0:     IMPORT_C void GetHeapAndStackSize(const TDesC& aStep, TInt* aHeapSize, TInt* aStackSize);
sl@0:     // public interface to run test steps
sl@0:     IMPORT_C TVerdict DoTestStep(const TDesC& aStep, const TDesC& aConfig, const TDesC& aPAramSet);
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test suite second phase initialiser, called from CTestSuite::ConstructL().
sl@0:  * All test suites must implement this.
sl@0:  * 
sl@0:  *
sl@0:  *
sl@0:  */
sl@0:     virtual void InitialiseL() = 0;
sl@0: 
sl@0:     IMPORT_C void Log(TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void Log(TInt aSeverity, TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0:         TRefByValue<const TDesC16> aFmt, ...);
sl@0: 
sl@0:     // this should be a pure virtual so every test DLL
sl@0:     // has to provide a version, but for now defaults to ?.?
sl@0:     IMPORT_C virtual TPtrC GetVersion() const;
sl@0: 
sl@0:     // accessors
sl@0:     IMPORT_C void SetSeverity(TInt aSeverity);
sl@0:     IMPORT_C TInt Severity() const;
sl@0:     IMPORT_C void SetStepStatus(TTestStepStatus aStatus);
sl@0:     IMPORT_C TTestStepStatus StepStatus() const;
sl@0:     IMPORT_C void SetLogSystem(CLog* aLogger);
sl@0:     IMPORT_C CLog* LogSystem() const;
sl@0: 
sl@0: protected:
sl@0:     // test functions
sl@0:     IMPORT_C void TestBooleanTrueL(TBool aCondition, const TText8* aFile, TInt aLine);
sl@0: 
sl@0: private:
sl@0:     // severity level
sl@0:     TInt iSeverity;
sl@0:     // File logging system
sl@0:     CLog* iLogger;
sl@0:     // array of pointers to the test steps in this suite
sl@0:     CArrayPtr<RTestStep>* iArrayTestSteps;
sl@0:     // status of current test step
sl@0:     TTestStepStatus iStepStatus;
sl@0: 
sl@0: protected:
sl@0:     // the name of this suite
sl@0:     TBuf<KMaxLenTestSuiteName> iSuiteName;
sl@0: 
sl@0:     };
sl@0: 
sl@0: // Test Step includes
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Max length of step name
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TInt KMaxLenTestStepName = 55;
sl@0: 
sl@0: class CTestIniData;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Default stack and heap sizes for test step
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: const TInt KTestStackSize = KDefaultStackSize;  // 0x2000 = 8k
sl@0: const TInt KMaxTestThreadHeapSize = 0x10000;    // = 64k
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Base test step class. All test step classes
sl@0:  * derive from this
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class RTestStep
sl@0:     {
sl@0: public:
sl@0: 
sl@0:     IMPORT_C RTestStep();
sl@0: 
sl@0:     IMPORT_C TAny* operator new(TUint aSize, TAny* aBase) __NO_THROW;
sl@0:     IMPORT_C TAny* operator new(TUint aSize, TLeave);
sl@0:     IMPORT_C TAny* operator new(TUint aSize) __NO_THROW;
sl@0:     IMPORT_C static TAny* newL(TUint aSize);
sl@0:     IMPORT_C TAny* operator new(TUint aSize,TUint anExtraSize) __NO_THROW;
sl@0: 
sl@0:     IMPORT_C void PreOpenL();
sl@0:     IMPORT_C virtual TVerdict OpenL();
sl@0:     IMPORT_C virtual void CleanupAfterOpenFail();
sl@0:     IMPORT_C virtual void Close();
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Perform the test step.
sl@0:  *
sl@0:  * @return  "TVerdict"
sl@0:  *          The result of the test step.
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0:     virtual TVerdict DoTestStepL() = 0;
sl@0:     
sl@0:     // initialise the config parameter system
sl@0:     IMPORT_C void LoadConfig(const TDesC& aConfig);
sl@0:     IMPORT_C void UnloadConfig();
sl@0: 
sl@0:     // accessors for stack / heap size
sl@0:     IMPORT_C TInt StackSize() const;
sl@0:     IMPORT_C TInt HeapSize() const;
sl@0: 
sl@0:     IMPORT_C void SetSuite(CTestSuite* aSuite);
sl@0:     IMPORT_C void SetResult(TVerdict aResult);
sl@0:     IMPORT_C TPtrC StepName() const;
sl@0:     
sl@0:     // param set - not required to be exported. Note assumes actual param is stable
sl@0:     void SetDefaultParamSet(const TDesC& aParamSet);
sl@0: 
sl@0: protected:
sl@0: 
sl@0:     // tests may optionally implement pre- and post-ambles
sl@0:     IMPORT_C virtual TVerdict DoTestStepPreambleL();
sl@0:     IMPORT_C virtual TVerdict DoTestStepPostambleL();
sl@0: 
sl@0:     // read values from the Config file functions
sl@0:     IMPORT_C TBool GetBoolFromConfig(const TDesC& aSectName,const TDesC& aKeyName,TBool& aResult);
sl@0:     IMPORT_C TBool GetIntFromConfig(const TDesC& aSectName,const TDesC& aKeyName,TInt& aResult);
sl@0:     IMPORT_C TBool GetStringFromConfig(const TDesC& aSectName,const TDesC& aKeyName,TPtrC& aResult);
sl@0:     IMPORT_C TBool GetHexFromConfig(const TDesC &aSectName,const TDesC &aKeyName,TInt &aResult);
sl@0: 
sl@0:     // test functions
sl@0:     IMPORT_C void TestBooleanTrue(TBool aCondition, const TText8* aFile, TInt aLine);
sl@0:     IMPORT_C void TestBooleanTrueL(TBool aCondition, const TText8* aFile, TInt aLine);
sl@0:     IMPORT_C void TestBooleanTrueWithErrorCode(TBool aCondition, TInt aErrorCode, const TText8* aFile, TInt aLine);
sl@0:     IMPORT_C void TestBooleanTrueWithErrorCodeL(TBool aCondition, TInt aErrorCode, const TText8* aFile, TInt aLine);
sl@0:     IMPORT_C void TestCheckPointCompareL(TInt aVal, TInt aExpectedVal, 
sl@0:                                          const TDesC& aText, const TText8* aFile, TInt aLine);
sl@0: 
sl@0:     // printf format log
sl@0:     IMPORT_C void Log(TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void Log(TInt aSeverity, TRefByValue<const TDesC16> aFmt, ...);
sl@0:     IMPORT_C void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0:         TRefByValue<const TDesC16> aFmt,...);
sl@0: 
sl@0: private:
sl@0:     // true if ConfigData has been loaded
sl@0:     TBool   iConfigDataAvailable;
sl@0: 
sl@0: protected:
sl@0:     // the name of the test step
sl@0:     TBuf<KMaxLenTestStepName> iTestStepName;
sl@0:     // the parameter set to use - supplied to the run_test statement
sl@0:     TPtrC iDefaultParamSet;
sl@0:     // pointer to suite which owns this test 
sl@0:     CTestSuite* iSuite;
sl@0:     // the current test step verdict
sl@0:     TVerdict iTestStepResult;
sl@0:     // config file data
sl@0:     CTestIniData *iConfigData;
sl@0:     // stack and heap size
sl@0:     TInt iStackSize;
sl@0:     TInt iHeapSize;
sl@0:     };
sl@0:     
sl@0: class CAsyncTestActiveScheduler; 
sl@0:     
sl@0: /**
sl@0: Sub-class of RTestStep that encapsulates CActiveScheduler and works asynchonously
sl@0: */
sl@0: 
sl@0: class RAsyncTestStep : public RTestStep
sl@0:     {
sl@0:     friend class CAsyncTestActiveScheduler;
sl@0: protected:
sl@0:     IMPORT_C RAsyncTestStep();
sl@0:     
sl@0:     // from RTestStep - these should not be replaced by RAsyncTestStep children
sl@0:     IMPORT_C TVerdict DoTestStepL();
sl@0:     IMPORT_C TVerdict DoTestStepPostambleL();
sl@0:     
sl@0:     // new methods
sl@0:     /**
sl@0:     Start the test
sl@0:     This method is used at the beginning of the test, and should initialise whatever
sl@0:     is required - typically setting up asynchronous calls that will activate once
sl@0:     the call returns. The method is abstract, and must be supplied by any derived
sl@0:     class.
sl@0:     The ActiveScheduler is active (this call is made from a RunL() instance).
sl@0:     If this test leaves, then StopTest() will be called with the leave value, so
sl@0:     implicitly the test stops.
sl@0:     */
sl@0:     virtual void KickoffTestL() = 0;
sl@0:     /**
sl@0:     Called after the test has stopped to workout the result.
sl@0:     This can be replaced by derived classes, if they have specific requirements, but
sl@0:     the default should be suitable for most uses. The default returns the result
sl@0:     set by StopTest() - if this is not pass, this result will also be written to the log.
sl@0:     */
sl@0:     IMPORT_C virtual TVerdict CheckTestResult();
sl@0:     /**
sl@0:     Close test.
sl@0:     This call requests the test step to delete any remaining objects left when running
sl@0:     a test. It is always called following the test being stopped.
sl@0:     */
sl@0:     virtual void CloseTest() = 0;
sl@0:     
sl@0:     // new commands
sl@0:     /**
sl@0:     Stop the test.
sl@0:     This is called by the client to stop a test - calling CActiveScheduler::Stop() on the
sl@0:     embedded active scheduler object. aReason is a standard error code. It defaults to
sl@0:     KErrNone. aResult is the verdict to use as the result of the test - its default depends
sl@0:     on aReason, EPass if the reason is KErrNone and EFail otherwise. 
sl@0:     Note that StopTest() can be called multiple times - in which case only the first non-KErrNone
sl@0:     reason and the first non-EPass result are used. */
sl@0:     IMPORT_C void StopTest();
sl@0:     IMPORT_C void StopTest(TInt aReason);
sl@0:     IMPORT_C void StopTest(TInt aReason, TVerdict aResult);
sl@0:     
sl@0:     // these two are intended for overrides of CheckTestResult()
sl@0:     /**
sl@0:     The aReason value set by StopTest()
sl@0:     */
sl@0:     IMPORT_C TInt Reason() const;
sl@0:     /**
sl@0:     The aResult value set by StopTest()
sl@0:     */
sl@0:     IMPORT_C TVerdict Result() const;
sl@0:     
sl@0: private:
sl@0:     CActiveScheduler* iScheduler;
sl@0:     
sl@0:     void SetResult(TVerdict aResult);
sl@0:     
sl@0:     static TInt CallBack (TAny* aPtr);
sl@0:     void DoCallBack();
sl@0:     
sl@0:     void HandleError(TInt aReason);
sl@0:     
sl@0: private:
sl@0: // have copies of these here, as they are commonly required
sl@0:     TInt iReason;
sl@0:     TVerdict iResult;
sl@0:     TBool iResultSet;
sl@0: 
sl@0:     CAsyncCallBack* iStartAO;
sl@0:     CActiveSchedulerWait* iActiveSchedulerWait;
sl@0:     TBool iStarted;
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestStep, thin subclass of RTestStep - provided for
sl@0:  * backward compatibility
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class CTestStep : public RTestStep
sl@0:     {
sl@0: public :
sl@0:     // CTestStep destructor - provided for backward compatibility ONLY
sl@0:     IMPORT_C virtual ~CTestStep();
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Autotest macros mapped to RTestStep functions
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: // check a boolean is true
sl@0: #define TESTL(a) TestBooleanTrueL((a), __FILE8__, __LINE__) 
sl@0: #define TEST(a)  TestBooleanTrue((a), __FILE8__, __LINE__) 
sl@0: 
sl@0: // check a boolean is true if not return error code b
sl@0: #define TESTE(a, b) TestBooleanTrueWithErrorCode((a), (b), __FILE8__, __LINE__) 
sl@0: #define TESTEL(a, b) TestBooleanTrueWithErrorCodeL((a), (b), __FILE8__, __LINE__)  
sl@0: #define TEST_CHECKL(p1, p2, p3) TestCheckPointCompareL((p1), (p2), (p3), __FILE8__, __LINE__)   
sl@0: // leave error code
sl@0: const TInt KTestErrorCode = 84; 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utilities class
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  *
sl@0:  */
sl@0: class CTestUtils : public CBase
sl@0:     {
sl@0: public:
sl@0: 
sl@0:     IMPORT_C  static CTestUtils* NewL(CLog* aLogSystem);
sl@0:     IMPORT_C  void RunUtils(const TDesC& aText);
sl@0: 
sl@0: private:
sl@0:     void Construct(CLog* aLogSystem);
sl@0:     void RunUtilsL(const TDesC& aText);
sl@0: 
sl@0:     void MakeDirL (const TDesC& aDirname);
sl@0:     void CopyFileL (const TDesC& aOld,const TDesC& aNew); 
sl@0:     void CopyAndInvertFileL (const TDesC& aOld,const TDesC& aNew);
sl@0:     void DeleteFileL (const TDesC& aFile); 
sl@0:     void MakeReadWriteL(const TDesC& aFile);
sl@0: 
sl@0:     // printf format log
sl@0:     void Log(TRefByValue<const TDesC16> aFmt, ...);
sl@0:     void Log(TInt aSeverity, TRefByValue<const TDesC16> aFmt, ...);
sl@0:     void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0:         TRefByValue<const TDesC16> aFmt,...);
sl@0: 
sl@0: private:
sl@0: 
sl@0:     // called by CopyAndInvertFileL func
sl@0:     void DoCopyAndInvertL (const TDesC& aOld,const TDesC& aNew);
sl@0:     
sl@0:     // pointer to Logging object which handles File and Console logging
sl@0:     CLog* iLogSystem;
sl@0:     // local file server
sl@0:     RFs iFs;
sl@0:     };
sl@0:     
sl@0: /*
sl@0: Busy unit - once started, uses a log of CPU time.
sl@0: */
sl@0: 
sl@0: NONSHARABLE_CLASS(CBusyTestUnit) : public CBase
sl@0:     {
sl@0:     CBusyTestUnit();
sl@0:     CBusyTestUnit(TInt aPercentBusy, TThreadPriority aThreadPriority);
sl@0:     void ConstructL();
sl@0:     
sl@0: public:
sl@0:     ~CBusyTestUnit();
sl@0:     
sl@0:     IMPORT_C static CBusyTestUnit* NewL(TInt aPercentBusy, TThreadPriority aThreadPriority);
sl@0:     IMPORT_C static CBusyTestUnit* NewLC(TInt aPercentBusy, TThreadPriority aThreadPriority);
sl@0:     
sl@0:     IMPORT_C TInt Start(); // run until Stop()
sl@0:     IMPORT_C TInt Start(TTimeIntervalMicroSeconds aRunFor); 
sl@0:             // run til Stop or aRunFor. aRunFor=0 means run until Stop()
sl@0:     IMPORT_C TInt Start(TTimeIntervalMicroSeconds32 aDelayFor, TTimeIntervalMicroSeconds aRunFor); 
sl@0:             // after aDelayFor, run til Stop or aRunFor
sl@0:     
sl@0:     IMPORT_C void Stop();
sl@0:     
sl@0:     
sl@0: private:
sl@0:     TInt RunThread();
sl@0:     static TInt StartThread(TAny* aPtr);
sl@0:     void ThreadFunction();
sl@0:     
sl@0:     static TInt StaticTimerCallback(TAny* aPtr);
sl@0:     TInt TimerCallback();
sl@0:     
sl@0: private:
sl@0:     const TInt iPercentBusy;
sl@0:     const TThreadPriority iThreadPriority;
sl@0:     TTimeIntervalMicroSeconds iRunFor;
sl@0:     CPeriodic* iTimer;
sl@0:     volatile TInt iBusyVariable;
sl@0:     RThread iChildThread;
sl@0:     };
sl@0: 
sl@0: 
sl@0: #endif // __TESTFRAMEWORK_H__