/*

* Copyright (c) 2005-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:  

* Contains the CTestStep base class implementation

*

*/

/**

 @file TestStepBase.cpp

*/

#include "TestExecuteStepBase.h"

/**

 * Default virtual implementation for pre-processing  within test steps

 * Virtual - May be overidden by subclass

 * @return One of TVerdict enum values defined

 */

EXPORT_C enum TVerdict CTestStep::doTestStepPreambleL(void)

	{

	SetTestStepResult(EPass);

	SetTestStepError(0);

	return TestStepResult();

	}

/**

 * Default virtual implementation for post-processing within test steps

 * Virtual - May be overidden by subclass

 * @return One of TVerdict enum values defined

 */

EXPORT_C enum TVerdict CTestStep::doTestStepPostambleL(void)

	{

	return TestStepResult();

	}

/**

 * Sets the current heap's to fail upon the subsequent "aFailureIndex" attempt

 * Virtual - may be overridden by derived test step

 * @param aFailureIndex - Index within heap allocation table that needs to be failed

 */

EXPORT_C void CTestStep::SetHeapFailNext(TInt aFailureIndex)

	{

	if (aFailureIndex >= 0)

		{

		__UHEAP_FAILNEXT(aFailureIndex);

		}

	}

/**

 * Resets the the current heap's simulated "fail next" mode (if active)

 * Virtual - may be overridden by derived test step

 */

EXPORT_C void CTestStep::ResetHeapFailNext()

	{

	__UHEAP_RESET;

	}

/**

 * Tests whether the current heap is in "fail next" mode. Used to check whether 

 * the code-under-test has "consumed" the simulated failure when OOM looping.

 * Virtual - may be overridden by derived test step

 * @return Boolean true if code has comsumed a simulated failure, false otherwise

 */

EXPORT_C TBool CTestStep::CheckForHeapFailNext()

	{

	TBool finishedCorrectly(EFalse);

	TInt* myInt = new TInt;

	if (myInt == NULL)

		finishedCorrectly = ETrue; // NULL means no memory

	delete myInt;

	return finishedCorrectly;

	}

/**

 * Destructor

 * Only heap resource is the Ini file data

 */

EXPORT_C CTestStep::~CTestStep()

	{

	CloseLogger();

	delete iConfigData;

	delete iIniFileName;

	delete iLogger ; 

	}

/**

 * Constructor

 */

EXPORT_C CTestStep::CTestStep()

	{

	// current logger can't using to log infomation.

	// because SetLoggerL must called before write logs.

	// the initial operation codes at SetLoggerL()

	iLogger = new CTestExecuteLogger();

	}

/**

 * Called by server base code that loads the test step

 * Can be called multiple times for any loaded test step instance.

 * Sets up the instance variables

 * @param aStepArgs - The arguments to the RUN_TEST_STEP command

 * @param aServerName - Name of the server that requested initialisation of its test step object

 * @param aSharedDataMode - Boolean true or false indicating the mode in which the test step is running

 * @Leave system wide errors

 */

void CTestStep::InitialiseL(const TDesC& aStepArgs, const TDesC& aServerName, TBool& aSharedDataMode)

	{

	// Assume pass

	iTestStepResult = EPass;

	iSharedDataMode = aSharedDataMode;

	iSection.SetLength(0);

	// In the case of re-initialise we need to free the existing resource

	if(iIniFileName)

		{

		delete iIniFileName;

		iIniFileName = NULL;

		}

	if(iConfigData)

		{

		delete iConfigData;

		iConfigData = NULL;

		}

	TLex lex(aStepArgs);

	// Extract the first token for OOM request status

	TPtrC oomRequestString(lex.NextToken());

	_LIT(KTEFOomOff,"OOM=0");

	if (oomRequestString.CompareF(KTEFOomOff) == 0)

		{

		// Not required to run OOM tests if OOM=0

		iOOMRequestStatus = EFalse;

		}

	else

		{

		// Required to run OOM tests if OOM=1

		iOOMRequestStatus = ETrue;

		}

	// Extract the second token for !Setup value

	TLex setupParamValue(lex.NextToken().Mid(7));

	TInt err = setupParamValue.Val(iSetupParamValue);

	if (err != KErrNone)

		{

		iSetupParamValue = TTestSetupState(ESetupNone);

		}

	// Extract the third token from aStepArgs for loop index

	TLex loopIndex(lex.NextToken());

	loopIndex.Val(iLoopIndex);

	iTestCaseID.Copy(lex.NextToken());

	TPtrC path(lex.NextToken());

	iScriptDriveName.Copy(path);

	path.Set(lex.NextToken());

	iSystemDrive.Copy(path);

	path.Set(lex.NextToken());

	iSystemDriveForTest.Copy(path);

	// Set the logger instance

	//before SetLogger(). iSystemDrive is needed, because SetLogger() will using iSystemDrive

	//before LoadConfigFileL(). SetLogger() is needed, because LoadConfigFileL() may needs write logs.

	SetLoggerL();

	// Get the ini file name if any

	TPtrC configFile(lex.NextToken());

	if(configFile.Length())

		{

		LoadConfigFileL(configFile);

		TPtrC iniSection(lex.NextToken());

		// In the case of re-initialise zero the old one

		ConfigSection().SetLength(0);

		// Get the ini section name if any

		if(iniSection.Length() && iniSection.Length() <= ConfigSection().MaxLength())

			ConfigSection().Copy(iniSection);

		}

	// Set the inifile name.

	iIniFileName = configFile.AllocL();

	// Set the server name

	iServerName = aServerName;

	}

/**

 * Creates a Cinidata instance for the ini file path specified for a particular test step

 * @param aFilePath - Full pathname of the ini file

 * @Leave system wide errors

 */

void CTestStep::LoadConfigFileL(const TDesC& aFilePath)

	{

	if(!aFilePath.Length())

		User::Leave(KErrNotFound);

		// Pass the system drive letter finalised to the Cinidata construction

		// So, that the ini files can be expanded for the ${SYSDRIVE} variables

		TRAPD(err,iConfigData = CIniData::NewL(aFilePath, GetSystemDrive()));		

		if(err != KErrNone)

			{

			//defect 121613: TEF will report ini file too large

			ERR_PRINTF3(_L("Leave when loading %S . Error Code = %d"),&aFilePath,err);

			// This is a hit message to user to split ini file to smaller one

			if (err == KErrNoMemory ) // -4

				{

				_LIT(KTEFLOADINIFILENOENOUGHMEM,"The configuration file is too large that TEF don't have enough memory to load. Please consider split the configuration file into smaller one or load the file in your own test codes.");

				INFO_PRINTF1(KTEFLOADINIFILENOENOUGHMEM);

				}

			User::Leave(err);

			}

	}

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TBool reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the boolean

 * @return TBool - ETrue for found, EFalse for not found 

 */

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

	{

	TPtrC result;

	if(!iConfigData)

		return EFalse;

	if(!iConfigData->FindVar(aSectName, aKeyName, result))

		return EFalse;

	_LIT(KTrue,"true");

	if (result.FindF(KTrue) == KErrNotFound) 

		aResult = EFalse;

	else

		aResult = ETrue;

	if (iEnableIniAccessLog)

		{

		INFO_PRINTF5(KTEFIniReadInteger,iIniFileName, &aSectName, &aKeyName , aResult);

		}

	return(ETrue);

	}

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TInt reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the integer

 * @return TBool - ETrue for found, EFalse for not found 

 */

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

	{

	if(!iConfigData)

		return EFalse;

	if(!iConfigData->FindVar(aSectName, aKeyName, aResult))

		return EFalse;

	if (iEnableIniAccessLog)

		{

		INFO_PRINTF5(KTEFIniReadInteger,iIniFileName, &aSectName, &aKeyName , aResult);

		}

	return ETrue;

	}

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TInt64 reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the 64-bit integer

 * @return TBool - ETrue for found, EFalse for not found 

 */

EXPORT_C TBool CTestStep::GetIntFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TInt64& aResult)

	{

	if(!iConfigData)

		return EFalse;

	if(!iConfigData->FindVar(aSectName, aKeyName, aResult))

		return EFalse;

	if (iEnableIniAccessLog)

		{

		INFO_PRINTF5(KTEFIniReadInt64,iIniFileName, &aSectName, &aKeyName , aResult);

		}

	return ETrue;

	}

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TPtrC reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - Reference to the string on the heap

 * @return TBool - ETrue for found, EFalse for not found 

 */

EXPORT_C TBool CTestStep::GetStringFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TPtrC& aResult) 

	{

	if(!iConfigData)

		return EFalse;

	if(!iConfigData->FindVar(aSectName, aKeyName, aResult))

		return EFalse;

	if (iEnableIniAccessLog)

		{

		INFO_PRINTF5(KTEFIniReadString,iIniFileName, &aSectName, &aKeyName , &aResult);

		}

	return ETrue;

	}

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TInt reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The integer value of the Hex input

 * @return TBool - ETrue for found, EFalse for not found 

 */	

EXPORT_C TBool CTestStep::GetHexFromConfig(const TDesC& aSectName,const TDesC& aKeyName,TInt& aResult)

	{

	TPtrC result;

	if(!iConfigData)

		return EFalse;

	if(!iConfigData->FindVar(aSectName, aKeyName, result))

		return EFalse;

	TLex lex(result);

	TInt err = lex.Val((TUint &)aResult, EHex);

	if(err)

		return EFalse;

	if (iEnableIniAccessLog)

		{

		INFO_PRINTF5(KTEFIniReadInteger,iIniFileName, &aSectName, &aKeyName , aResult);

		}

	return(ETrue);

	}

/**

 * Writes the integer value  passed in to the test steps ini file under the section and key name mentioned

 * Creates a new section or key name if it does not existing already

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aValue - Reference to the integer to be written on to the test steps ini file

 * @return TBool - ETrue for found, EFalse for not found 

 */

EXPORT_C TBool CTestStep::WriteIntToConfig(const TDesC& aSectName, const TDesC& aKeyName, const TInt& aValue)

	{

	TBuf<KMaxTestExecuteNameLength> value;

	TBool retVal(ETrue);

	TInt err(KErrNone);

	value.AppendNum(aValue);

	if(!iConfigData)

		{

		retVal = EFalse;

		}

	else if(iConfigData->SetValue(aSectName,aKeyName,value)==KErrNotFound)

		{

		err = iConfigData->AddValue(aSectName,aKeyName,value);

		}

	if(retVal && KErrNone==err)

		{

		TRAP(err, iConfigData->WriteToFileL());

		if (iEnableIniAccessLog)

			{

			if (KErrNone == err)

				{

				INFO_PRINTF5(KTEFIniWriteInteger,iIniFileName, &aSectName, &aKeyName , aValue);

				}

			}

		}

	if (!retVal || KErrNone!=err)

		{

		retVal = EFalse;

		if (iEnableIniAccessLog)

			{

			_LIT(KWriteIntegerError, "Error occurs when writing integer to file, error code=%d");

			ERR_PRINTF2(KWriteIntegerError, err);

			}

		}

	return retVal;

	}

/**

 * Writes the 64-bit integer value  passed in to the test steps ini file under the section and key name mentioned

 * Creates a new section or key name if it does not existing already

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aValue - Reference to the 64-bit integer to be written on to the test steps ini file

 * @return TBool - ETrue for found, EFalse for not found 

 */

EXPORT_C TBool CTestStep::WriteIntToConfig(const TDesC& aSectName, const TDesC& aKeyName, const TInt64& aValue)

	{

	TBuf<KMaxTestExecuteNameLength> value;

	TBool retVal(ETrue);

	TInt err(KErrNone);

	value.AppendNum(aValue);

	if(!iConfigData)

		{

		retVal = EFalse;

		}

	else if(iConfigData->SetValue(aSectName,aKeyName,value)==KErrNotFound)

		{

		err = iConfigData->AddValue(aSectName,aKeyName,value);

		}

	if(retVal && KErrNone==err)

		{

		TRAP(err, iConfigData->WriteToFileL());

		if (iEnableIniAccessLog)

			{

			if (KErrNone == err)

				{

				INFO_PRINTF5(KTEFIniWriteInt64,iIniFileName, &aSectName, &aKeyName , aValue);

				}

			}

		}

	if (!retVal || KErrNone!=err)

		{

		retVal = EFalse;

		if (iEnableIniAccessLog)

			{

			_LIT(KWriteIntegerError, "Error occurs when writing integer to file, error code=%d");

			ERR_PRINTF2(KWriteIntegerError, err);

			}

		}

	return retVal;	

	}

/**

 * Writes the string value  passed in to the test steps ini file under the section and key name mentioned

 * Creates a new section or key name if it does not existing already

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aValue - Reference to the string to be written on to the test steps ini file

 * @return TBool - ETrue for found, EFalse for not found 

 */

EXPORT_C TBool CTestStep::WriteStringToConfig(const TDesC& aSectName, const TDesC& aKeyName, const TPtrC& aValue)

	{

	TBool retVal(ETrue);

	TInt err(KErrNone);

	if(!iConfigData)

		{

		retVal = EFalse;

		}

	else if(iConfigData->SetValue(aSectName,aKeyName,aValue)==KErrNotFound)

		{

		err = iConfigData->AddValue(aSectName,aKeyName,aValue);

		}

	if(retVal && KErrNone==err)

		{

		TRAP(err, iConfigData->WriteToFileL());

		if (iEnableIniAccessLog)

			{

			if (KErrNone == err)

				{

				INFO_PRINTF5(KTEFIniWriteString,iIniFileName, &aSectName, &aKeyName , &aValue);

				}

			}

		}

	if (!retVal || KErrNone!=err)

		{

		retVal = EFalse;

		if (iEnableIniAccessLog)

			{

			_LIT(KWriteIntegerError, "Error occurs when writing string to file, error code=%d");

			ERR_PRINTF2(KWriteIntegerError, err);

			}

		}

	return retVal;

	}

/**

 * Writes the boolean value  passed in to the test steps ini file under the section and key name mentioned

 * Creates a new section or key name if it does not existing already

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aValue - Reference to the boolean value to be written onto the test steps ini file

 * @return TBool - ETrue for found, EFalse for not found 

 */	

EXPORT_C TBool CTestStep::WriteBoolToConfig(const TDesC& aSectName, const TDesC& aKeyName, const TBool& aValue)

	{

	TBuf<KMaxTestExecuteNameLength> value;

	TBool retVal(ETrue);

	TInt err(KErrNone);

	if(aValue==1)

		{

		_LIT(KTrue,"True");

		value.Append(KTrue);

		}

	else if(aValue==0) 

		{

		_LIT(KFalse,"False");

		value.Append(KFalse);

		}

	else 

		{

		return(EFalse);

		}

	if(!iConfigData)

		{

		retVal = EFalse;

		}

	else if(iConfigData->SetValue(aSectName,aKeyName,value)==KErrNotFound)

		{

		err = iConfigData->AddValue(aSectName,aKeyName,value);

		}

	if(retVal && KErrNone==err)

		{

		TRAP(err, iConfigData->WriteToFileL());

		if (iEnableIniAccessLog)

			{

			if (KErrNone == err)

				{

				INFO_PRINTF5(KTEFIniWriteInteger,iIniFileName, &aSectName, &aKeyName , aValue);

				}

			}

		}