/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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: 

* tststestsuitestep.h

*

*/

/**

 @file

 @test

 @internalComponent

*/

#include "tststestsuitestep.h"

#include "tststestsuiteserver.h"

#include <s32file.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include "stsrecovery.h"

#endif //SYMBIAN_ENABLE_SPLIT_HEADERS

_LIT(KEFileShareExclusive, 				"EFileShareExclusive");

_LIT(KEFileShareReadersOnly,			"EFileShareReadersOnly");

_LIT(KEFileShareAny,					"EFileShareAny");

_LIT(KEFileShareReadersOrWriters, 		"EFileShareReadersOrWriters");

_LIT(KEFileStream, 						"EFileStream");

_LIT(KEFileStreamText,					"EFileStreamText");

_LIT(KEFileRead,						"EFileRead");

_LIT(KEFileWrite,						"EFileWrite");

_LIT(KEFileReadAsyncAll,				"EFileReadAsyncAll");

_LIT(KEFileWriteBuffered,				"EFileWriteBuffered");

_LIT(KEFileWriteDirectIO,				"EFileWriteDirectIO");

_LIT(KEFileReadBuffered,				"EFileReadBuffered");

_LIT(KEFileReadDirectIO,				"EFileReadDirectIO");

_LIT(KEFileReadAheadOn,					"EFileReadAheadOn");

_LIT(KEFileReadAheadOff,				"EFileReadAheadOff");

_LIT(KORSign,							"|");

CStsBaseTestStep::CStsBaseTestStep(CStsTestServer &aStsTestServer): iStsTestServer(aStsTestServer)

	{

	}

CStsTestServer& CStsBaseTestStep::Server()

	{

	return iStsTestServer;

	}

TInt CStsBaseTestStep::GetIntFromConfigL(const TDesC& aName)

	{

	TInt ret(0);

	if(!GetIntFromConfig(ConfigSection(), aName, ret))

		{

		ERR_PRINTF2(_L("%S is not found in config!"), &aName);

		User::Leave(KErrNotFound);

		}

	return ret;

	}

TInt CStsBaseTestStep::GetTransactionSlotFromConfigL()

/**

 Reads the target file's path from the ini file

 */

	{

	return GetIntFromConfigL(KTransactionSlot);

	}

TInt CStsBaseTestStep::GetTransactionSlotToReuseTransactionIdFromConfigL()

	{

	return GetIntFromConfigL(KTransactionSlotID);

	}

TInt CStsBaseTestStep::GetTransactionIdFromConfigL()

	{

	return GetIntFromConfigL(KTransactionID);

	}

TPtrC CStsBaseTestStep::GetStringFromConfigL(const TDesC& aName)

	{

	TPtrC ret;

	if(!GetStringFromConfig(ConfigSection(), aName, ret))

		{

		ERR_PRINTF2(_L("%S is not found in config!"), &aName);

		User::Leave(KErrNotFound);

		}

	return ret;

	}

TPtrC CStsBaseTestStep::GetTargetFilePathFromConfigL()

	{

	return GetStringFromConfigL(KTargetFile);

	}

void CStsBaseTestStep::WriteToFileL(RFile &aFile, TDesC& aString)

	{

	RFileWriteStream stream;

	CleanupClosePushL(stream);

	stream.Attach(aFile);

	TRAPD(err,

		stream.WriteL(aString);

		stream.CommitL();

		); //catch the error so that it can be reported

	if(err!=KErrNone)

		{

		ERR_PRINTF2(_L("CStsBaseTestStep::WriteToFileL() Writing to file failed! Error code: %d"), err);

		User::Leave(err);

		}

	stream.Close();

	CleanupStack::PopAndDestroy(&stream);

	}

TBool CStsBaseTestStep::FileExistsL(const TDesC &aFileName)

	{

	INFO_PRINTF2(_L("CStsBaseTestStep::FileExistsL() %S"), &aFileName);

	TBool ret=EFalse;

	TRAPD(err, ret=Server().GetTestUtil().FileExistsL(aFileName)); //trap leaving fucntion to log error

	if(err!=KErrNone)

		{

		ERR_PRINTF3(_L("CStsBaseTestStep::FileExistsL() File existence check failed for %S Error code: %d"), &aFileName, err);

		User::Leave(err);

		}

	return ret;

	}

void CStsBaseTestStep::DeleteFileL(const TDesC &aFileName)	

	{

	TInt err=Server().GetTestUtil().Delete(aFileName); 

	if(err!=KErrNone)

		{

		ERR_PRINTF3(_L("DeleteFileL() Deletion failed for %S Error code: %d"), &aFileName, err);

		User::Leave(err);

		}

	}

void CStsBaseTestStep::CopyFileL(const TDesC& aSourceFile, const TDesC& aDestinationFile)

	{

	TInt err=Server().GetTestUtil().Copy(aSourceFile, aDestinationFile); 

	if(err!=KErrNone)

		{

		ERR_PRINTF4(_L("CStsBaseTestStep::CopyFileL() Copying %S to %S failed. Error code: %d"), &aSourceFile, &aDestinationFile, err);

		User::Leave(err);

		}

	}

void CStsBaseTestStep::RmDirL(const TDesC& aFileName)

	{

	TInt err=Server().GetTestUtil().RmDir(aFileName); 

	if(err!=KErrNone)

		{

		ERR_PRINTF3(_L("CStsBaseTestStep::RmDirL() Deleting dir %S failed. Error code: %d"), &aFileName, err);

		User::Leave(err);

		}

	}

void CStsBaseTestStep::MkDirAllL(const TDesC& aFileName)

	{

	TInt err=Server().GetTestUtil().MkDirAll(aFileName); 

	if(err!=KErrNone)

		{

		ERR_PRINTF3(_L("CStsBaseTestStep::MkDirAllL() Creating dir %S failed. Error code: %d"), &aFileName, err);

		User::Leave(err);

		}

	}

void CStsBaseTestStep::DeleteL(const TDesC& aFileName)

	{

	TInt err=Server().GetTestUtil().Delete(aFileName); 

	if(err!=KErrNone)

		{

		ERR_PRINTF3(_L("CStsBaseTestStep::DeleteL() Deleting %S failed. Error code: %d"), &aFileName, err);

		User::Leave(err);

		}

	}

void CStsBaseTestStep::SetReadOnlyL(const TDesC& aFileName, TInt aSetReadOnly)

	{

	TInt err=Server().GetTestUtil().SetReadOnly(aFileName, aSetReadOnly);

	if(err!=KErrNone)

		{

		ERR_PRINTF4(_L("CStsBaseTestStep::SetReadOnly() Trying to set \"readonly\" flag on %S failed to %d. Error code: %d"), &aFileName, aSetReadOnly, err);

		User::Leave(err);

		}

	}

HBufC* CStsBaseTestStep::CreateDataForNewFileCreatedByStsServerLC(const TDesC& aTestStepName, TNewFileType aType)

	{

	HBufC *buf = HBufC::NewLC(200);

	TPtr bufPtr = buf->Des();

	bufPtr.Append(KFileData1);

	switch(aType)

		{

		case ENewTemporaryFile:

			bufPtr.Append(KFileData2);

			break;

		case ENewPermanentFile:

			bufPtr.Append(KFileData3);

			break;

		default:

			bufPtr.Append(KFileData4);

			break;

		}

	bufPtr.Append(KFileData5);

	bufPtr.Append(KFileData7);

	bufPtr.Append(aTestStepName);

	bufPtr.Append(KFileData6);

	return buf;

	}

//----------------------------------------

CCreateTransactionStep::CCreateTransactionStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KCreateTransactionStep);

	}

void CCreateTransactionStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCreateTransactionStep Preamble"));

	SetTestStepResult(EPass);

	}

void CCreateTransactionStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("CCreateTransactionStep in test step"));

	TInt trSlot = GetTransactionSlotFromConfigL();

	TInt trID = Server().CreateTransactionL(trSlot);

	SetTestStepResult(EPass);

	}

void CCreateTransactionStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCreateTransactionStep Postamble"));

	}

//----------------------------------------

COpenTransactionStep::COpenTransactionStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KOpenTransactionStep);

	}

void COpenTransactionStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("COpenTransactionStep Preamble"));

	SetTestStepResult(EPass);

	}

void COpenTransactionStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("COpenTransactionStep in test step"));

	TInt trSlot = GetTransactionSlotFromConfigL(); //get required transaction slot from ini

	TInt requiredSlotToTakeIdFrom(0);

	TStsTransactionId trID(0);

	TRAPD(err, requiredSlotToTakeIdFrom = GetTransactionSlotToReuseTransactionIdFromConfigL()); //get transaction id from ini to reuse its id

	if(err == KErrNone)

		{

		trID = Server().GetTransactionIDL(requiredSlotToTakeIdFrom); //get ID from server from the requested slot

		}

	else

		{

		if(err == KErrNotFound)

			{

			trID =GetTransactionIdFromConfigL();

			}

		else

			{

			User::Leave(err);

			}

		}

	//open transaction

	Server().OpenTransactionL(trSlot, trID);

	SetTestStepResult(EPass);

	}

void COpenTransactionStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("COpenTransactionStep Postamble"));

	}

//----------------------------------------

CCloseTransactionStep::CCloseTransactionStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KCloseTransactionStep);

	}

void CCloseTransactionStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCloseTransactionStep Preamble"));

	SetTestStepResult(EPass);

	}

void CCloseTransactionStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("CCloseTransactionStep in test step"));

	//get transaction slot from ini

	TInt trSlot = GetTransactionSlotFromConfigL();

	//close transaction

	Server().CloseTransactionL(trSlot);

	SetTestStepResult(EPass);

	}

void CCloseTransactionStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCloseTransactionStep Postamble"));

	}

//----------------------------------------

CRegisterNewFileStep::CRegisterNewFileStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KRegisterNewFileStep);

	}

void CRegisterNewFileStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CRegisterNewFileStep Preamble"));

	SetTestStepResult(EPass);

	}

void CRegisterNewFileStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("CRegisterNewFileStep in test step"));

	//get transaction slot from ini

	TInt trSlot = GetTransactionSlotFromConfigL();

	//get the target file path from ini

	TPtrC filePathInIni = GetTargetFilePathFromConfigL();

	Server().RegisterNewL(trSlot, filePathInIni);

	SetTestStepResult(EPass);

	}

void CRegisterNewFileStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CRegisterNewFileStep Postamble"));

	}

//----------------------------------------

CCreateNewFileStep::CCreateNewFileStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KCreateNewFileStep);

	}

void CCreateNewFileStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCreateNewFileStep Preamble"));

	SetTestStepResult(EPass);

	}

void CCreateNewFileStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("CCreateNewFileStep in test step"));

	TFileMode fileMode(static_cast<TFileMode>(EFileShareExclusive|EFileWrite));

	//get transaction slot from ini

	TInt trSlot = GetTransactionSlotFromConfigL();

	//get the target file path from ini

	TPtrC filePathInIni = GetTargetFilePathFromConfigL();

	//the handle to the newly created file

	RFile newFile;

	CleanupClosePushL(newFile);

	//register newly created file

	Server().CreateNewL(trSlot, filePathInIni, newFile, fileMode);

	HBufC *bufPtr=CreateDataForNewFileCreatedByStsServerLC(KCreateNewFileStep, ENewPermanentFile);

	WriteToFileL(newFile, *bufPtr);

	CleanupStack::PopAndDestroy(2, &newFile);

	SetTestStepResult(EPass);

	}

void CCreateNewFileStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CCreateNewFileStep Postamble"));

	}

//----------------------------------------

CRemoveStep::CRemoveStep(CStsTestServer &aStsTestServer): CStsBaseTestStep(aStsTestServer)

	{

	// Call base class method to set up the human readable name for logging

	SetTestStepName(KRemoveStep);

	}

void CRemoveStep::ImplTestStepPreambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CRemoveStep Preamble"));

	SetTestStepResult(EPass);

	}

void CRemoveStep::ImplTestStepL()

/**

 @return - void code

 Override of base class pure virtual

 */

	{

	INFO_PRINTF1(_L("CRemoveStep in test step"));

	//get transaction slot from ini

	TInt trSlot = GetTransactionSlotFromConfigL();

	//get the target file path from ini

	TPtrC filePathInIni = GetTargetFilePathFromConfigL();

	Server().RemoveL(trSlot, filePathInIni);

	SetTestStepResult(EPass);

	}

void CRemoveStep::ImplTestStepPostambleL()

/**

 @return - void code

 Override of base class virtual

 */

	{

	INFO_PRINTF1(_L("CRemoveStep Postamble"));