// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

// EPOC includes

#include <e32base.h>

// Test system includes

#include <testframework.h>

#include "TestIniData.h"

#include "asyncscheduler.h"

// do not export if Unit Testing

#if defined (__TSU_TESTFRAMEWORK__)

#undef EXPORT_C

#define EXPORT_C

#endif

static const TUint16*const KVerdictString[] = // must match up with TVerdict

	{

	_S("EPass"),

	_S("EFail"),

	_S("EInconclusive"),

	_S("ETestSuiteError"),

	_S("EAbort"),

	_S("EKnownFailure")

	};

/**

 *

 * Test step constructor.

 *

 * @xxxx

 *

 */

EXPORT_C RTestStep::RTestStep()

	{

	iTestStepResult = EPass;

	iTestStepName.Zero();

	iSuite = NULL;

	iConfigData = NULL;

	iConfigDataAvailable = EFalse;

	iStackSize = KTestStackSize;

	iHeapSize = KMaxTestThreadHeapSize;

	// NB : RTestStep has no destructor

	}

/**

 *

 * CBase compatibility functionality.

 *

 * @xxxx

 *

 */

EXPORT_C TAny* RTestStep::operator new(TUint aSize, TAny* aBase) __NO_THROW

	{

	Mem::FillZ(aBase,aSize);

	return(aBase);

	}

EXPORT_C TAny* RTestStep::operator new(TUint aSize, TLeave)

	{

	return newL(aSize);		// will leave on alloc failure

	}

EXPORT_C TAny* RTestStep::operator new(TUint aSize) __NO_THROW

	{

	TAny* pM=User::Alloc(aSize);

	if (pM)

		Mem::FillZ(pM,aSize);

	return(pM);

	}

EXPORT_C TAny* RTestStep::newL(TUint aSize)

	{

	TAny* pM=User::AllocL(aSize);

	Mem::FillZ(pM,aSize);

	return pM;

	}

EXPORT_C TAny* RTestStep::operator new(TUint aSize,TUint anExtraSize) __NO_THROW

	{

	aSize+=anExtraSize;

	TAny *pM=User::Alloc(aSize);

	if (pM)

		Mem::FillZ(pM,aSize);

	return(pM);

	}

/**

 *

 * Pre-preamble for all test steps. This grows the cleanup stack to

 * allow for allocation errors.

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::PreOpenL()

	{

	TAny* dummyPtr = NULL;

	for(TInt i = 0 ; i < 20 ; i++)

		CleanupStack::PushL(dummyPtr); // Grow the cleanup stack.

	CleanupStack::PopAndDestroy(20);

	}

/**

 *

 * Default empty implementation of OpenL (preamble).

 * Test steps can override this to implement required code.

 *

 * @return	"TVerdict"

 *			Result of preamble (should only be EPass or EInconclusive)

 *

 * @xxxx

 *

 */

EXPORT_C TVerdict RTestStep::OpenL()

	{

	// for backward compatibility with CTestStep

	return DoTestStepPreambleL();

	}

/**

 *

 * Default empty implementation of CleanupAfterOpenFail (preamble cleanup).

 * Test steps can override this to implement required code.

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::CleanupAfterOpenFail()

	{

	// default empty implementation

	// a step should implement its own method if required

	}

/**

 *

 * Default empty implementation of Close (postamble)

 * Test steps can override this to implement required code.

 *

 * NB this does NOT leave - any leaves should be trapped and panicked.

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::Close()

	{

	// for backward compatibility with CTestStep

	_LIT(KPanicStr, "RTestStep::Close");

	TVerdict ver = EPass;

	TRAPD(err, ver = DoTestStepPostambleL());

	if(err != KErrNone)

		User::Panic(KPanicStr, 0);

	// any DoTestStepPostambleL() which returns EInconclusive should be panicked

 	if(ver != EPass)

		User::Panic(KPanicStr, 1);

	}

/**

 *

 * Set the test suite

 *

 * @param	"CTestSuite*"

 *			The test suite

 *

 * @xxxx

 *

 */

void RTestStep::SetSuite(CTestSuite* aSuite)

	{

	iSuite = aSuite;

	}

/**

 *

 * Set the test result

 *

 * @param	"TVerdict"

 *			The test result

 *

 * @xxxx

 *

 */

void RTestStep::SetResult(TVerdict aResult)

	{

	iTestStepResult = aResult;

	}

/**

 *

 * Get the step name

 *

 * @return	"TPtrC"

 *			The step name

 *

 * @xxxx

 *

 */

TPtrC RTestStep::StepName() const

	{

	return iTestStepName;

	}

/**

 *

 * General logging function for test steps.

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style aFmt.

 *

 * @param	"..."

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::Log(TRefByValue<const TDesC16> aFmt, ...)

	{

	VA_LIST aList;

	VA_START(aList, aFmt);

	TIntegrationTestLog16Overflow iOverflow16;

	// decode formatted data for display on console

	TBuf<KMaxLogLineLength> lineBuf;

	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);

	// send the data to the log system via the suite

	iSuite->Log(_L("%S"),&lineBuf);

	VA_END(aList); 

	}

/**

 *

 * General logging function for test steps, with severity.

 *

 * @param	"TInt aSeverity"

 *			Severity level required to log

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style aFmt.

 *

 * @param	"..."

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::Log( TInt aSeverity, TRefByValue<const TDesC16> aFmt, ... )

{

	VA_LIST aList;

	VA_START(aList, aFmt);

	TIntegrationTestLog16Overflow iOverflow16;

	// decode formatted data for display on console

	TBuf<KMaxLogLineLength> lineBuf;

	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);

	// send the data to the log system via the suite

	if(LogSeverity::IsActive(aSeverity, iSuite->Severity()))

		iSuite->Log(aSeverity, _L("%S"),&lineBuf);

	VA_END(aList); 

}

/**

 *

 * Traceable logging function for test steps.

 *

 * @param	"const TText8* aFile"

 *			Source code file name

 *

 * @param	"TInt aLine"

 *			Source code line

 *

 * @param	"TInt aSeverity"

 *			Severity level required to log

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style format.

 *

 * @param	"..."

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,

		TRefByValue<const TDesC16> aFmt,...)

	{

	VA_LIST aList;

	VA_START(aList, aFmt);

	TIntegrationTestLog16Overflow iOverflow16;

	// decode formatted data for display on console

	TBuf<KMaxLogLineLength> lineBuf;

	lineBuf.AppendFormatList(aFmt, aList, &iOverflow16);

	// send the data to the log system via the suite

	if(LogSeverity::IsActive(aSeverity, iSuite->Severity()))

		iSuite->LogExtra(aFile, aLine, aSeverity, lineBuf);

	VA_END(aList); 

	}

/**

Set default paramSet

Test steps can use this when looking up configs, to provide a level of script control

*/

void RTestStep::SetDefaultParamSet(const TDesC& aParamSet)

	{

	iDefaultParamSet.Set(aParamSet);

	}

/**

 *

 * Load a configuration file.

 * If successful, data member iConfigDataAvailable is set.

 *

 * @param	"TPtrC aConfig"

 *			The configuration file name.

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::LoadConfig(const TDesC& aConfig)

	{

	// if a config file supplied then use

	if (aConfig.Length() != 0)

		{

		// get the full pathname default drive name and extension

		_LIT(KRelated,"C:\\config.ini"); 

		TParse configFileName;

		TInt returnCode = configFileName.Set(aConfig, &KRelated, NULL);

		if (returnCode != KErrNone)

			{

			// error opening FileManager

			ERR_PRINTF2(_L("Error opening config file %S"), &(configFileName.FullName())); 

			}

		// create and load the CTestIniData object

		TRAPD(r, iConfigData = CTestIniData::NewL(configFileName.FullName()));

		// check if loaded ok

		if (r == KErrNone)

			{

			// loaded ok

			iConfigDataAvailable = ETrue;

			}

		else

			{

			// failed to load

			iConfigDataAvailable = EFalse;

			iConfigData = NULL;

			// report error 

			TPtrC errortxt = CLog::EpocErrorToText(r);

			ERR_PRINTF2(_L("Failed to load config data file - error %S"), &errortxt);

			}

		}

	}

/**

 *

 * Unload any existing configuration data.

 *

 * @xxxx

 *

 */

EXPORT_C void RTestStep::UnloadConfig()

	{

	iConfigDataAvailable = EFalse;

	// clean up Config data object

	delete iConfigData;

	iConfigData = NULL;

	}

/**

 *

 * Check the config file for a boolean value

 *

 * @param	"const TDesC &aSectName"

 *			Section name to check in

 *

 * @param	"const TDesC &aKeyName"

 *			Key name to check for

 *

 * @param	"Bool &aResult"

 *			TBool returned from config file

 *

 * @return	"TBool"

 *			Result (ETrue if found)

 *

 * @xxxx

 *

 */

EXPORT_C TBool RTestStep::GetBoolFromConfig(const TDesC &aSectName, const TDesC &aKeyName, TBool &aResult)

	{

	// check file available

	if (!iConfigDataAvailable)

		{

		ERR_PRINTF1(_L("No config file available"));

		return EFalse;

		}

	TBool ret = EFalse;

	TPtrC result;

	// get the value 

	ret = iConfigData->FindVar(aSectName, aKeyName, result);

	// if failed to decode display error

	if (!ret) 

		{

		// display error message

		ERR_PRINTF3(_L("Failed to read section:%S key:%S "),

				&aSectName, &aKeyName );

		// return fail

		return EFalse;

		}

	// set result as a TBool

	if (result.FindF(_L("true")) == KErrNotFound)

		aResult = EFalse;

	else

		aResult = ETrue;

	// return success

	return ETrue;

	}

/**

 *

 * Check the config file for a TInt value

 *

 * @param	"const TDesC &aSectName"

 *			Section name to check in

 *

 * @param	"const TDesC &aKeyName"

 *			Key name to check for

 *

 * @param	"TInt &aResult"

 *			TInt returned from config file

 *

 * @return	"TBool"

 *			Result (ETrue if found)

 *

 * @xxxx

 *

 */

EXPORT_C TBool RTestStep::GetIntFromConfig(const TDesC &aSectName, const TDesC &aKeyName, TInt &aResult)

	{

	// check file available

	if ( !iConfigDataAvailable )

		{

		ERR_PRINTF1(_L("No config file available"));

		return EFalse;

		}	

	TBool ret = EFalse;

	TPtrC result;

	// get the value 

	ret = iConfigData->FindVar(aSectName, aKeyName, result);

	// if failed to decode display error

	if (!ret) 

		{

		// display error message

		ERR_PRINTF3(_L("Failed to read section:%S key:%S "),

				&aSectName, &aKeyName );

		// return fail

		return EFalse;

		}

	// use TLex to convert to a TInt

	TLex lex(result);

	if (lex.Val(aResult) == KErrNone)

		return ETrue;

	else

		return EFalse;

}

/**

 *

 * Check the config file for a string TPtr value

 *

 * @param	"const TDesC &aSectName"

 *			Section name to check in

 *

 * @param	"const TDesC &aKeyName"

 *			Key name to check for

 *

 * @param	"TPtrC &aResult"

 *			String returned from config file

 *

 * @return	"TBool"

 *			Result (ETrue if found)

 *

 * @xxxx