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: //
sl@0: 
sl@0: // EPOC includes
sl@0: #include <e32base.h>
sl@0: 
sl@0: // Test system includes
sl@0: #include <testframework.h>
sl@0: #include "TestIniData.h"
sl@0: #include "asyncscheduler.h"
sl@0: 
sl@0: // do not export if Unit Testing
sl@0: #if defined (__TSU_TESTFRAMEWORK__)
sl@0: #undef EXPORT_C
sl@0: #define EXPORT_C
sl@0: #endif
sl@0: 
sl@0: static const TUint16*const KVerdictString[] = // must match up with TVerdict
sl@0: 	{
sl@0: 	_S("EPass"),
sl@0: 	_S("EFail"),
sl@0: 	_S("EInconclusive"),
sl@0: 	_S("ETestSuiteError"),
sl@0: 	_S("EAbort"),
sl@0: 	_S("EKnownFailure")
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test step constructor.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C RTestStep::RTestStep()
sl@0: 	{
sl@0: 	iTestStepResult = EPass;
sl@0: 	iTestStepName.Zero();
sl@0: 	iSuite = NULL;
sl@0: 	iConfigData = NULL;
sl@0: 	iConfigDataAvailable = EFalse;
sl@0: 	iStackSize = KTestStackSize;
sl@0: 	iHeapSize = KMaxTestThreadHeapSize;
sl@0: 
sl@0: 	// NB : RTestStep has no destructor
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CBase compatibility functionality.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: 
sl@0: 
sl@0: EXPORT_C TAny* RTestStep::operator new(TUint aSize, TAny* aBase) __NO_THROW
sl@0: 	{
sl@0: 	Mem::FillZ(aBase,aSize);
sl@0: 	return(aBase);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C TAny* RTestStep::operator new(TUint aSize, TLeave)
sl@0: 	{
sl@0: 	return newL(aSize);		// will leave on alloc failure
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TAny* RTestStep::operator new(TUint aSize) __NO_THROW
sl@0: 	{
sl@0: 	TAny* pM=User::Alloc(aSize);
sl@0: 	if (pM)
sl@0: 		Mem::FillZ(pM,aSize);
sl@0: 	return(pM);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TAny* RTestStep::newL(TUint aSize)
sl@0: 	{
sl@0: 	TAny* pM=User::AllocL(aSize);
sl@0: 	Mem::FillZ(pM,aSize);
sl@0: 	return pM;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TAny* RTestStep::operator new(TUint aSize,TUint anExtraSize) __NO_THROW
sl@0: 	{
sl@0: 	aSize+=anExtraSize;
sl@0: 	TAny *pM=User::Alloc(aSize);
sl@0: 	if (pM)
sl@0: 		Mem::FillZ(pM,aSize);
sl@0: 	return(pM);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Pre-preamble for all test steps. This grows the cleanup stack to
sl@0:  * allow for allocation errors.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::PreOpenL()
sl@0: 	{
sl@0: 	TAny* dummyPtr = NULL;
sl@0: 	for(TInt i = 0 ; i < 20 ; i++)
sl@0: 		CleanupStack::PushL(dummyPtr); // Grow the cleanup stack.
sl@0: 	CleanupStack::PopAndDestroy(20);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Default empty implementation of OpenL (preamble).
sl@0:  * Test steps can override this to implement required code.
sl@0:  *
sl@0:  * @return	"TVerdict"
sl@0:  *			Result of preamble (should only be EPass or EInconclusive)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TVerdict RTestStep::OpenL()
sl@0: 	{
sl@0: 	// for backward compatibility with CTestStep
sl@0: 	return DoTestStepPreambleL();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Default empty implementation of CleanupAfterOpenFail (preamble cleanup).
sl@0:  * Test steps can override this to implement required code.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::CleanupAfterOpenFail()
sl@0: 	{
sl@0: 	// default empty implementation
sl@0: 	// a step should implement its own method if required
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Default empty implementation of Close (postamble)
sl@0:  * Test steps can override this to implement required code.
sl@0:  *
sl@0:  * NB this does NOT leave - any leaves should be trapped and panicked.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::Close()
sl@0: 	{
sl@0: 	// for backward compatibility with CTestStep
sl@0: 	_LIT(KPanicStr, "RTestStep::Close");
sl@0: 	TVerdict ver = EPass;
sl@0: 	TRAPD(err, ver = DoTestStepPostambleL());
sl@0: 	if(err != KErrNone)
sl@0: 		User::Panic(KPanicStr, 0);
sl@0: 	// any DoTestStepPostambleL() which returns EInconclusive should be panicked
sl@0:  	if(ver != EPass)
sl@0: 		User::Panic(KPanicStr, 1);
sl@0: 
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Set the test suite
sl@0:  *
sl@0:  * @param	"CTestSuite*"
sl@0:  *			The test suite
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::SetSuite(CTestSuite* aSuite)
sl@0: 	{
sl@0: 	iSuite = aSuite;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Set the test result
sl@0:  *
sl@0:  * @param	"TVerdict"
sl@0:  *			The test result
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::SetResult(TVerdict aResult)
sl@0: 	{
sl@0: 	iTestStepResult = aResult;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Get the step name
sl@0:  *
sl@0:  * @return	"TPtrC"
sl@0:  *			The step name
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TPtrC RTestStep::StepName() const
sl@0: 	{
sl@0: 	return iTestStepName;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * General logging function for test steps.
sl@0:  *
sl@0:  * @param	"TRefByValue<const TDesC16> aFmt"
sl@0:  *			Printf-style aFmt.
sl@0:  *
sl@0:  * @param	"..."
sl@0:  *			Variable print parameters
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::Log(TRefByValue<const TDesC16> aFmt, ...)
sl@0: 	{
sl@0:     
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 
sl@0: 	TIntegrationTestLog16Overflow iOverflow16;
sl@0: 
sl@0: 	// decode formatted data for display on console
sl@0: 	TBuf<KMaxLogLineLength> lineBuf;
sl@0: 	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);
sl@0: 
sl@0: 	// send the data to the log system via the suite
sl@0: 	iSuite->Log(_L("%S"),&lineBuf);
sl@0: 
sl@0: 	VA_END(aList); 
sl@0: 
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * General logging function for test steps, with severity.
sl@0:  *
sl@0:  * @param	"TInt aSeverity"
sl@0:  *			Severity level required to log
sl@0:  *
sl@0:  * @param	"TRefByValue<const TDesC16> aFmt"
sl@0:  *			Printf-style aFmt.
sl@0:  *
sl@0:  * @param	"..."
sl@0:  *			Variable print parameters
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::Log( TInt aSeverity, TRefByValue<const TDesC16> aFmt, ... )
sl@0: {
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 
sl@0: 	TIntegrationTestLog16Overflow iOverflow16;
sl@0: 
sl@0: 	// decode formatted data for display on console
sl@0: 	TBuf<KMaxLogLineLength> lineBuf;
sl@0: 	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);
sl@0: 
sl@0: 	// send the data to the log system via the suite
sl@0: 	if(LogSeverity::IsActive(aSeverity, iSuite->Severity()))
sl@0: 		iSuite->Log(aSeverity, _L("%S"),&lineBuf);
sl@0: 
sl@0: 	VA_END(aList); 
sl@0: }
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable logging function for test steps.
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @param	"TInt aSeverity"
sl@0:  *			Severity level required to log
sl@0:  *
sl@0:  * @param	"TRefByValue<const TDesC16> aFmt"
sl@0:  *			Printf-style format.
sl@0:  *
sl@0:  * @param	"..."
sl@0:  *			Variable print parameters
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0: 		TRefByValue<const TDesC16> aFmt,...)
sl@0: 	{
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 
sl@0: 	TIntegrationTestLog16Overflow iOverflow16;
sl@0: 
sl@0: 	// decode formatted data for display on console
sl@0: 	TBuf<KMaxLogLineLength> lineBuf;
sl@0: 	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);
sl@0: 
sl@0: 	// send the data to the log system via the suite
sl@0: 	if(LogSeverity::IsActive(aSeverity, iSuite->Severity()))
sl@0: 		iSuite->LogExtra(aFile, aLine, aSeverity, lineBuf);
sl@0: 
sl@0: 	VA_END(aList); 
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Set default paramSet
sl@0: Test steps can use this when looking up configs, to provide a level of script control
sl@0: */
sl@0: void RTestStep::SetDefaultParamSet(const TDesC& aParamSet)
sl@0: 	{
sl@0: 	iDefaultParamSet.Set(aParamSet);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Load a configuration file.
sl@0:  * If successful, data member iConfigDataAvailable is set.
sl@0:  *
sl@0:  * @param	"TPtrC aConfig"
sl@0:  *			The configuration file name.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::LoadConfig(const TDesC& aConfig)
sl@0: 	{
sl@0: 
sl@0: 	// if a config file supplied then use
sl@0: 	if (aConfig.Length() != 0)
sl@0: 		{
sl@0: 
sl@0: 		// get the full pathname default drive name and extension
sl@0: 		_LIT(KRelated,"C:\\config.ini"); 
sl@0: 		TParse configFileName;
sl@0: 		TInt returnCode = configFileName.Set(aConfig, &KRelated, NULL);
sl@0: 
sl@0: 		if (returnCode != KErrNone)
sl@0: 			{
sl@0: 			// error opening FileManager
sl@0: 			ERR_PRINTF2(_L("Error opening config file %S"), &(configFileName.FullName())); 
sl@0: 			}
sl@0: 
sl@0: 		// create and load the CTestIniData object
sl@0: 		TRAPD(r, iConfigData = CTestIniData::NewL(configFileName.FullName()));
sl@0: 		
sl@0: 		// check if loaded ok
sl@0: 		if (r == KErrNone)
sl@0: 			{
sl@0: 			// loaded ok
sl@0: 			iConfigDataAvailable = ETrue;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			// failed to load
sl@0: 			iConfigDataAvailable = EFalse;
sl@0: 			iConfigData = NULL;
sl@0: 
sl@0: 			// report error 
sl@0: 			TPtrC errortxt = CLog::EpocErrorToText(r);
sl@0: 			ERR_PRINTF2(_L("Failed to load config data file - error %S"), &errortxt);
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Unload any existing configuration data.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::UnloadConfig()
sl@0: 	{
sl@0: 	iConfigDataAvailable = EFalse;
sl@0: 
sl@0: 	// clean up Config data object
sl@0: 	delete iConfigData;
sl@0: 	iConfigData = NULL;
sl@0: 
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Check the config file for a boolean value
sl@0:  *
sl@0:  * @param	"const TDesC &aSectName"
sl@0:  *			Section name to check in
sl@0:  *
sl@0:  * @param	"const TDesC &aKeyName"
sl@0:  *			Key name to check for
sl@0:  *
sl@0:  * @param	"Bool &aResult"
sl@0:  *			TBool returned from config file
sl@0:  *
sl@0:  * @return	"TBool"
sl@0:  *			Result (ETrue if found)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TBool RTestStep::GetBoolFromConfig(const TDesC &aSectName, const TDesC &aKeyName, TBool &aResult)
sl@0: 	{
sl@0: 	// check file available
sl@0: 	if (!iConfigDataAvailable)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("No config file available"));
sl@0: 		return EFalse;
sl@0: 		}
sl@0: 
sl@0: 	TBool ret = EFalse;
sl@0: 	TPtrC result;
sl@0: 
sl@0: 	// get the value 
sl@0: 	ret = iConfigData->FindVar(aSectName, aKeyName, result);
sl@0: 
sl@0: 	// if failed to decode display error
sl@0: 	if (!ret) 
sl@0: 		{
sl@0: 		// display error message
sl@0: 		ERR_PRINTF3(_L("Failed to read section:%S key:%S "),
sl@0: 				&aSectName, &aKeyName );
sl@0: 
sl@0: 		// return fail
sl@0: 		return EFalse;
sl@0: 		}
sl@0: 
sl@0: 	// set result as a TBool
sl@0: 	if (result.FindF(_L("true")) == KErrNotFound)
sl@0: 		aResult = EFalse;
sl@0: 	else
sl@0: 		aResult = ETrue;
sl@0: 	// return success
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Check the config file for a TInt value
sl@0:  *
sl@0:  * @param	"const TDesC &aSectName"
sl@0:  *			Section name to check in
sl@0:  *
sl@0:  * @param	"const TDesC &aKeyName"
sl@0:  *			Key name to check for
sl@0:  *
sl@0:  * @param	"TInt &aResult"
sl@0:  *			TInt returned from config file
sl@0:  *
sl@0:  * @return	"TBool"
sl@0:  *			Result (ETrue if found)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TBool RTestStep::GetIntFromConfig(const TDesC &aSectName, const TDesC &aKeyName, TInt &aResult)
sl@0: 	{
sl@0: 	// check file available
sl@0: 	if ( !iConfigDataAvailable )
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("No config file available"));
sl@0: 		return EFalse;
sl@0: 		}	
sl@0: 
sl@0: 	TBool ret = EFalse;
sl@0: 	TPtrC result;
sl@0: 
sl@0: 	// get the value 
sl@0: 	ret = iConfigData->FindVar(aSectName, aKeyName, result);
sl@0: 
sl@0: 	// if failed to decode display error
sl@0: 	if (!ret) 
sl@0: 		{
sl@0: 		// display error message
sl@0: 		ERR_PRINTF3(_L("Failed to read section:%S key:%S "),
sl@0: 				&aSectName, &aKeyName );
sl@0: 
sl@0: 		// return fail
sl@0: 		return EFalse;
sl@0: 		}
sl@0: 
sl@0: 	// use TLex to convert to a TInt
sl@0: 	TLex lex(result);
sl@0: 	if (lex.Val(aResult) == KErrNone)
sl@0: 		return ETrue;
sl@0: 	else
sl@0: 		return EFalse;
sl@0: }
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Check the config file for a string TPtr value
sl@0:  *
sl@0:  * @param	"const TDesC &aSectName"
sl@0:  *			Section name to check in
sl@0:  *
sl@0:  * @param	"const TDesC &aKeyName"
sl@0:  *			Key name to check for
sl@0:  *
sl@0:  * @param	"TPtrC &aResult"
sl@0:  *			String returned from config file
sl@0:  *
sl@0:  * @return	"TBool"
sl@0:  *			Result (ETrue if found)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TBool RTestStep::GetStringFromConfig(const TDesC &aSectName, const TDesC &aKeyName, TPtrC &aResult)
sl@0: 	{
sl@0: 	// check file available
sl@0: 	if (!iConfigDataAvailable)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("No config file available"));
sl@0: 		return EFalse;
sl@0: 		}	
sl@0: 
sl@0: 	// get the value 
sl@0: 	TBool ret = iConfigData->FindVar(aSectName, aKeyName, aResult);
sl@0: 
sl@0: 	// if failed to decode display error
sl@0: 	if (ret == EFalse) 
sl@0: 		{
sl@0: 		ERR_PRINTF3(_L("Failed to read section:%S key:%S "),
sl@0: 				&aSectName, &aKeyName );
sl@0: 		}
sl@0: 
sl@0: 	return ret;
sl@0: }
sl@0: 
sl@0: /**
sl@0:  * Reads the value present from the test steps ini file within the mentioned section name and key name
sl@0:  * Copies the value to the TInt reference passed in
sl@0:  * @param aSectName - Section within the test steps ini file
sl@0:  * @param aKeyName - Name of a key within a section
sl@0:  * @return aResult - The integer value of the Hex input
sl@0:  * @return TBool - ETrue for found, EFalse for not found 
sl@0:  */	
sl@0: EXPORT_C TBool RTestStep::GetHexFromConfig(const TDesC &aSectName,const TDesC &aKeyName,TInt &aResult)
sl@0: 	{
sl@0: 	TPtrC result;
sl@0: 	if(!iConfigData)
sl@0: 		return EFalse;
sl@0: 	if(!iConfigData->FindVar(aSectName, aKeyName, result))
sl@0: 		return EFalse;
sl@0: 	TLex lex(result);
sl@0: 	TInt err = lex.Val((TUint &)aResult, EHex);
sl@0: 	if(err)
sl@0: 		return EFalse;
sl@0: 	
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0:  *
sl@0:  * Default empty implementation of DoTestStepPreambleL.
sl@0:  * Test steps can override this to implement required code.
sl@0:  *
sl@0:  * @return	"TVerdict"
sl@0:  *			Result of preamble (should only be EPass or EInconclusive)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: // for backward compatibility with CTestStep
sl@0: EXPORT_C TVerdict RTestStep::DoTestStepPreambleL()
sl@0: 	{
sl@0: 	return EPass;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Default empty implementation of DoTestStepPostambleL.
sl@0:  * Test steps can override this to implement required code.
sl@0:  *
sl@0:  * @return	"TVerdict"
sl@0:  *			Result of postamble (should only be EPass or EInconclusive)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: // for backward compatibility with CTestStep
sl@0: EXPORT_C TVerdict RTestStep::DoTestStepPostambleL()
sl@0: 	{
sl@0: 	return EPass;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable Boolean condition tester.
sl@0:  * If the condition is not true, record an error.
sl@0:  *
sl@0:  * @param	"TBool aCondition"
sl@0:  *			Condition to be checked
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::TestBooleanTrue(TBool aCondition, const TText8* aFile, TInt aLine)
sl@0: 	{
sl@0: 
sl@0: 	// check condition
sl@0: 	if (aCondition)
sl@0: 		return;
sl@0: 
sl@0: 	// this is only relevant if the current result is pass
sl@0: 	if (iTestStepResult == EPass)
sl@0: 		iTestStepResult = EFail;
sl@0: 
sl@0: 	// convert filename for log
sl@0: 	TBuf<KMaxLogFilenameLength> fileName;
sl@0: 	TPtrC8 fileName8(aFile);
sl@0: 	fileName.Copy(fileName8);  // TText8->TBuf16
sl@0: 
sl@0: 	// display a log message
sl@0:  	ERR_PRINTF3(_L("Test Failed in file:%S line:%d"), &fileName, aLine);
sl@0: 
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable Boolean condition tester.
sl@0:  * If the condition is not true, record an error and leave.
sl@0:  *
sl@0:  * @param	"TBool aCondition"
sl@0:  *			Condition to be checked
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::TestBooleanTrueL(TBool aCondition, const TText8* aFile, TInt aLine)
sl@0: 	{
sl@0: 
sl@0: 	// check condition
sl@0: 	if (aCondition)
sl@0: 		return;
sl@0: 
sl@0: 	// this is only relevant if the current result is pass
sl@0: 	if (iTestStepResult == EPass)
sl@0: 		iTestStepResult = EFail;
sl@0: 
sl@0: 	// convert filename for log
sl@0: 	TBuf<KMaxLogFilenameLength> fileName;
sl@0: 	TPtrC8 fileName8(aFile);
sl@0: 	fileName.Copy(fileName8);  // TText8->TBuf16
sl@0: 
sl@0: 	// display a log message
sl@0:  	ERR_PRINTF3(_L("Test Failed in file:%S line:%d"), &fileName, aLine);
sl@0: 
sl@0: 	// leave with error code
sl@0: 	User::Leave(KTestErrorCode);
sl@0: 
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable Boolean condition tester.
sl@0:  * If the condition is not true, record an error with the supplied 
sl@0:  * error code, and leave.
sl@0:  *
sl@0:  * @param	"TBool aCondition"
sl@0:  *			Condition to be checked
sl@0:  *
sl@0:  * @param	"TInt aErrorCode"
sl@0:  *			Supplied error code
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::TestBooleanTrueWithErrorCodeL(TBool aCondition, TInt aErrorCode, const TText8* aFile, TInt aLine)
sl@0: 	{
sl@0: 	// check condition
sl@0: 	if (aCondition)
sl@0: 		return;
sl@0: 
sl@0: 	// this is only relevant if the current result is pass
sl@0: 	if (iTestStepResult == EPass)
sl@0: 		iTestStepResult = EFail;
sl@0: 
sl@0: 	// convert filename for log
sl@0: 	TBuf<KMaxLogFilenameLength> fileName;
sl@0: 	TPtrC8 fileName8(aFile);
sl@0: 	fileName.Copy(fileName8);  // TText8->TBuf16
sl@0: 
sl@0: 	// get the error text
sl@0: 	TPtrC errortxt = CLog::EpocErrorToText(aErrorCode);
sl@0: 
sl@0: 	// display a log message
sl@0: 	ERR_PRINTF4(_L("Test Failed with error:%S in file:%S line:%d"),
sl@0: 			&errortxt, &fileName, aLine);
sl@0: 
sl@0: 	// leave with error code
sl@0: 	User::Leave(aErrorCode);
sl@0: 	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable Boolean condition tester.
sl@0:  * If the condition is not true, record an error with the supplied 
sl@0:  * error code.
sl@0:  *
sl@0:  * @param	"TBool aCondition"
sl@0:  *			Condition to be checked
sl@0:  *
sl@0:  * @param	"TInt aErrorCode"
sl@0:  *			Supplied error code
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::TestBooleanTrueWithErrorCode(TBool aCondition, TInt aErrorCode, const TText8* aFile, TInt aLine)
sl@0: 	{
sl@0: 	// check condition
sl@0: 	if (aCondition)
sl@0: 		return;
sl@0: 
sl@0: 	// this is only relevant if the current result is pass
sl@0: 	if (iTestStepResult == EPass)
sl@0: 		iTestStepResult = EFail;
sl@0: 
sl@0: 	// convert filename for log
sl@0: 	TBuf<KMaxLogFilenameLength> fileName;
sl@0: 	TPtrC8 fileName8(aFile);
sl@0: 	fileName.Copy(fileName8);  // TText8->TBuf16
sl@0: 
sl@0: 	// get the error text
sl@0: 	TPtrC errortxt = CLog::EpocErrorToText(aErrorCode);
sl@0: 
sl@0: 	// display a log message
sl@0: 	ERR_PRINTF4(_L("Test Failed with error:%S in file:%S line:%d"),
sl@0: 			&errortxt, &fileName, aLine);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable checkpoint tester.
sl@0:  * If the value does not match expected, record an error with supplied
sl@0:  * text string, and leave.
sl@0:  *
sl@0:  * @param	"TInt aVal"
sl@0:  *			Value to be checked
sl@0:  *
sl@0:  * @param	"TInt aExpectedVal"
sl@0:  *			Value expected
sl@0:  *
sl@0:  * @param	"const TDesC& aText"
sl@0:  *			Supplied text string
sl@0:  *
sl@0:  * @param	"const TText8* aFile"
sl@0:  *			Source code file name
sl@0:  *
sl@0:  * @param	"TInt aLine"
sl@0:  *			Source code line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void RTestStep::TestCheckPointCompareL(TInt aVal, TInt aExpectedVal, 
sl@0: 												  const TDesC& aText, const TText8* aFile, TInt aLine)
sl@0: 	{
sl@0: 	if(aVal != aExpectedVal)
sl@0: 		{
sl@0: 		// this is only relevant if the current result is pass
sl@0: 		if (iTestStepResult == EPass)
sl@0: 			iTestStepResult = EFail;
sl@0: 
sl@0: 		// convert filename for log
sl@0: 		TBuf<KMaxLogFilenameLength> fileName;
sl@0: 		TPtrC8 fileName8(aFile);
sl@0: 		fileName.Copy(fileName8);  // TText8->TBuf16
sl@0: 
sl@0: 		ERR_PRINTF6(_L("FAILED test:  Val = %d Exp Val = %d %S in file:%S line:%d"), 
sl@0: 			aVal, aExpectedVal, &aText, &fileName, aLine);
sl@0: 
sl@0: 		User::Leave(aVal);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0:  *
sl@0:  * Accessors for stack / heap size
sl@0:  *
sl@0:  * NB - These can only be set from within the RTestStep derived constructor itself - there
sl@0:  * are no setter accessors.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C TInt RTestStep::StackSize() const
sl@0: {
sl@0: 	return iStackSize;
sl@0: }
sl@0: 
sl@0: EXPORT_C TInt RTestStep::HeapSize() const
sl@0: {
sl@0: 	return iHeapSize;
sl@0: }
sl@0: 
sl@0: 
sl@0: /** 
sl@0:  *
sl@0:  * Virtual destructor for CTestStep
sl@0:  * Provided for backward compatibility ONLY
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: EXPORT_C CTestStep::~CTestStep()
sl@0: {
sl@0: }
sl@0: 
sl@0: //
sl@0: // RAsyncTestStep
sl@0: //
sl@0: 
sl@0: EXPORT_C RAsyncTestStep::RAsyncTestStep():
sl@0: 	iReason (KErrNone),
sl@0: 	iResult (EPass),
sl@0: 	iStartAO (NULL),
sl@0: 	iActiveSchedulerWait (NULL),
sl@0: 	iStarted (EFalse)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TVerdict RAsyncTestStep::DoTestStepL()
sl@0: 	{
sl@0: 	// allow recalls to same test step (?), so re-initialise the basic variables. Can't delete
sl@0: 	// as if in that case, old heap would be dead
sl@0: 	iReason = KErrNone;
sl@0: 	iResult = EPass;
sl@0: 	iScheduler = NULL;
sl@0: 	iActiveSchedulerWait = NULL;
sl@0: 	
sl@0: 	iScheduler = new (ELeave) CAsyncTestActiveScheduler(*this);	
sl@0: 	CActiveScheduler::Install(iScheduler);
sl@0: 	iActiveSchedulerWait = new (ELeave) CActiveSchedulerWait();
sl@0: 	
sl@0: 	// arrange for DoCallBack() to be called as the first thing. Use low priority to reduce
sl@0: 	// the overhead of an extra AO on everything else
sl@0: 	TCallBack callback (CallBack, this);
sl@0: 	iStartAO = NULL;
sl@0: 	iStartAO = new (ELeave) CAsyncCallBack (callback, CActive::EPriorityIdle); 
sl@0: 	iStartAO->Call();
sl@0: 	
sl@0: 	iStarted = ETrue; // obviously do this before we start, as can't once it is
sl@0: 	iActiveSchedulerWait->Start();
sl@0: 	return CheckTestResult();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TVerdict RAsyncTestStep::DoTestStepPostambleL()
sl@0: 	{
sl@0: 	CloseTest();
sl@0: 	delete iStartAO; // no need to Cancel 
sl@0: 	iStartAO = NULL;
sl@0: 	delete iActiveSchedulerWait;
sl@0: 	iActiveSchedulerWait = NULL;
sl@0: 	delete iScheduler; 
sl@0: 	iScheduler = NULL;
sl@0: 	return EPass;
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void RAsyncTestStep::StopTest()
sl@0: 	{
sl@0: 	StopTest(KErrNone);
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void RAsyncTestStep::StopTest(TInt aReason)
sl@0: 	{
sl@0: 	TVerdict resultToUse = (aReason==KErrNone) ? EPass : EFail;
sl@0: 	StopTest (aReason, resultToUse);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RAsyncTestStep::StopTest(TInt aReason, TVerdict aResult)
sl@0: 	{
sl@0: 	// note if stop is called multiple times, we record last
sl@0: 	// non-KErrNone reason and last non-Pass result, but only actually stop once
sl@0: 	if (aReason!=KErrNone)
sl@0: 		{
sl@0: 		iReason = aReason;		
sl@0: 		}
sl@0: 	SetResult(aResult);
sl@0: 	if (iStarted)
sl@0: 		{
sl@0: 		iStarted = EFalse;
sl@0: 		iActiveSchedulerWait->AsyncStop();
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TInt RAsyncTestStep::Reason() const
sl@0: 	{
sl@0: 	return iReason;
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TVerdict RAsyncTestStep::Result() const
sl@0: 	{
sl@0: 	return iResult;
sl@0: 	}
sl@0: 	
sl@0: void RAsyncTestStep::SetResult(TVerdict aResult)
sl@0: 	{
sl@0: 	// remember the last non-Pass result
sl@0: 	if (aResult!=EPass)
sl@0: 		{
sl@0: 		iResult = aResult;
sl@0: 		}	
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TVerdict RAsyncTestStep::CheckTestResult()
sl@0: 	{
sl@0: 	TVerdict result = Result();
sl@0: 	
sl@0: 	if (result!=EPass) // if the result is a Pass, even if error is too we treat as test pass
sl@0: 		{
sl@0: 		INFO_PRINTF3(_L("Failed test with error %d, result %s"), Reason(), KVerdictString[result]);
sl@0: 		}
sl@0: 	return result;
sl@0: 	}
sl@0: 
sl@0: TInt RAsyncTestStep::CallBack(TAny* aPtr)
sl@0: 	{
sl@0: 	RAsyncTestStep* self = static_cast<RAsyncTestStep*> (aPtr);
sl@0: 	self->DoCallBack(); // if this fails, it will stop itself
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 	
sl@0: void RAsyncTestStep::DoCallBack()
sl@0: 	{
sl@0: 	TRAPD(error, KickoffTestL()); 
sl@0: 	if (error!=KErrNone)
sl@0: 		{
sl@0: 		StopTest(error); // if kickoff fails, we stop here
sl@0: 		}	
sl@0: 	}
sl@0: 
sl@0: void RAsyncTestStep::HandleError(TInt aError)
sl@0: 	{
sl@0: 	INFO_PRINTF2(_L("ActiveScheduler::Error(%d)"), aError);
sl@0: 	StopTest(aError);
sl@0: 	}
sl@0: 	
sl@0: //
sl@0: // CBusyTestUnit
sl@0: //
sl@0: 
sl@0: CBusyTestUnit::CBusyTestUnit():
sl@0: 		iPercentBusy(0), iThreadPriority(EPriorityNormal)
sl@0: 	{
sl@0: 	// non exported default constructor to enforce non-derivation
sl@0: 	}
sl@0: 
sl@0: CBusyTestUnit::CBusyTestUnit(TInt aPercentBusy, TThreadPriority aThreadPriority):
sl@0: 		iPercentBusy(aPercentBusy), iThreadPriority(aThreadPriority)
sl@0: 	{
sl@0: 	ASSERT(aPercentBusy>=0 && aPercentBusy<=100); // assume this
sl@0: 	}
sl@0: 	
sl@0: void CBusyTestUnit::ConstructL()
sl@0: 	{
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C CBusyTestUnit* CBusyTestUnit::NewLC(TInt aPercentBusy, TThreadPriority aThreadPriority)
sl@0: 	{
sl@0: 	CBusyTestUnit* self = new (ELeave) CBusyTestUnit(aPercentBusy, aThreadPriority);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	return self;
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C CBusyTestUnit* CBusyTestUnit::NewL(TInt aPercentBusy, TThreadPriority aThreadPriority)
sl@0: 	{
sl@0: 	CBusyTestUnit* self = NewLC(aPercentBusy, aThreadPriority);
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 	
sl@0: CBusyTestUnit::~CBusyTestUnit()
sl@0: 	{
sl@0: 	Stop();
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void CBusyTestUnit::Stop()
sl@0: 	{
sl@0: 	if (iTimer)
sl@0: 		{
sl@0: 		iTimer->Cancel();
sl@0: 		delete iTimer;
sl@0: 		iTimer=NULL;
sl@0: 		}
sl@0: 	if (iChildThread.Handle())
sl@0: 		{
sl@0: 		// child thread created, so kill
sl@0: 		iChildThread.Kill(0);
sl@0: 		iChildThread.Close();
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TInt CBusyTestUnit::Start()
sl@0: 	{
sl@0: 	return Start(0);	
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TInt CBusyTestUnit::Start(TTimeIntervalMicroSeconds aRunFor)
sl@0: 	{
sl@0: 	return Start(0, aRunFor);
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C TInt CBusyTestUnit::Start(TTimeIntervalMicroSeconds32 aDelayFor, TTimeIntervalMicroSeconds aRunFor)
sl@0: 	{
sl@0: 	iRunFor = aRunFor;
sl@0: 	if (!aDelayFor.Int())
sl@0: 		{
sl@0: 		// run immediately
sl@0: 		return RunThread();
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		iTimer = CPeriodic::NewL(CActive::EPriorityHigh);
sl@0: 		TCallBack callback(StaticTimerCallback, this);
sl@0: 		iTimer->Start(aDelayFor, 0, callback);
sl@0: 		return KErrNone;
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: TInt CBusyTestUnit::StaticTimerCallback(TAny* aPtr)
sl@0: 	{
sl@0: 	CBusyTestUnit* self = static_cast<CBusyTestUnit*>(aPtr);
sl@0: 	return self->TimerCallback();
sl@0: 	}
sl@0: 	
sl@0: TInt CBusyTestUnit::TimerCallback()
sl@0: 	{
sl@0: 	// called on timer callback, so assume iTimer!
sl@0: 	ASSERT(iTimer);
sl@0: 	// first stop and delete timer - don't need again this run
sl@0: 	iTimer->Cancel();
sl@0: 	// then kick off the thread
sl@0: 	TInt error = RunThread(); 
sl@0: 	// now delete the timer - do now as we've been called back by it!
sl@0: 	delete iTimer;
sl@0: 	iTimer = NULL;
sl@0: 	return error; // any error will stop the test, in theory
sl@0: 	}
sl@0: 	
sl@0: TInt CBusyTestUnit::RunThread()
sl@0: 	{
sl@0: 	TAny* paramPtr = this;
sl@0: 	TInt error = iChildThread.Create(KNullDesC, StartThread, 
sl@0: 					KDefaultStackSize, NULL, paramPtr, EOwnerThread);
sl@0: 	if (!error)
sl@0: 		{
sl@0: 		iChildThread.SetPriority(iThreadPriority);
sl@0: 		iChildThread.Resume();
sl@0: 		}
sl@0: 	return error;
sl@0: 	}
sl@0: 	
sl@0: TInt CBusyTestUnit::StartThread(TAny* aPtr)
sl@0: 	{
sl@0: 	CBusyTestUnit* self = static_cast<CBusyTestUnit*>(aPtr);
sl@0: 	if (self)
sl@0: 		{
sl@0: 		self->ThreadFunction();
sl@0: 		}
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 	
sl@0: void CBusyTestUnit::ThreadFunction()
sl@0: 	{
sl@0: 	// this runs in a separate thread and tries to use lots of CPU time up to percentage
sl@0: 	// nominally we run busy for loops for iPercentBusy/100ms, and then wait for rest of the
sl@0: 	// 100ms using User::After(). We keep doing this until we reach the target time, if there is
sl@0: 	// one
sl@0: 	
sl@0: 	const TInt KDefaultLoop = 10000;
sl@0: 	TTime timeAtStart; 
sl@0: 	timeAtStart.UniversalTime(); // time of start
sl@0: 	
sl@0: 	const TInt KLoopInterval =100000; // 100ms - loop time
sl@0: 	TTimeIntervalMicroSeconds32 busyInterval(KLoopInterval*iPercentBusy/100); // how much of loop time to be busy
sl@0: 	TTimeIntervalMicroSeconds32 quietInterval(KLoopInterval-busyInterval.Int()); // how much of loop time to be quiet
sl@0: 	
sl@0: 	while (ETrue)
sl@0: 		{
sl@0: 		// the interval, for loops for the busy bit and then a User::After()
sl@0: 		TTime startOfInterval;
sl@0: 		startOfInterval.UniversalTime();
sl@0: 		while (ETrue)
sl@0: 			{
sl@0: 			// the busy bit - iBusyVariable is volatile so should never be optimised out
sl@0: 			for (TInt i=0; i<KDefaultLoop; i++)
sl@0: 				{
sl@0: 				iBusyVariable = i;
sl@0: 				}
sl@0: 			TTime now;
sl@0: 			now.UniversalTime();
sl@0: 			if (startOfInterval + busyInterval < now)
sl@0: 				{
sl@0: 				// we're passed the time
sl@0: 				break;
sl@0: 				}
sl@0: 			}
sl@0: 		User::After(quietInterval);		
sl@0: 			
sl@0: 		if (iRunFor.Int64())
sl@0: 			{
sl@0: 			// check to see if we are passed the interval given at Start()
sl@0: 			TTime now;
sl@0: 			now.UniversalTime();
sl@0: 			if (timeAtStart + iRunFor < now)
sl@0: 				{
sl@0: 				// we're passed the time
sl@0: 				break;
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: