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: // This contains file utilities which can be called from Test Framework scripts
sl@0: // 
sl@0: //
sl@0: 
sl@0: // EPOC includes
sl@0: #include <e32base.h>
sl@0: #include <f32file.h> 
sl@0: 
sl@0: // Test system includes
sl@0: #include <testframework.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: 
sl@0: /**
sl@0:  *
sl@0:  * Initialise the test utilities.
sl@0:  *
sl@0:  * @param	"CLog* aLogSystem"
sl@0:  *			The logger the test utilities are to use.
sl@0:  *
sl@0:  * @xxxx 
sl@0:  *
sl@0:  */
sl@0: EXPORT_C CTestUtils* CTestUtils::NewL(CLog* aLogSystem)
sl@0: 	{
sl@0: 	CTestUtils* self = new(ELeave) CTestUtils;
sl@0: 	self->Construct(aLogSystem);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Initialise the test utilities (second phase).
sl@0:  *
sl@0:  * @param	"CLog* aLogSystem"
sl@0:  *			The logger the test utilities are to use.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::Construct(CLog* aLogSystem)
sl@0: 	{
sl@0: 	iLogSystem = aLogSystem;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Run the test utilities inside a trap harness.
sl@0:  *
sl@0:  * @param	"const TDesC& aText"
sl@0:  *			Test string giving the utility to run.
sl@0:  *
sl@0:  * @xxxx 
sl@0:  *
sl@0:  */
sl@0: EXPORT_C void CTestUtils::RunUtils(const TDesC& aText)
sl@0: 	{
sl@0: 	TRAPD(r, RunUtilsL(aText));
sl@0: 
sl@0: 	if (r != KErrNone)
sl@0: 		{
sl@0: 		WARN_PRINTF3(_L("Warning: Test Utils : %S left, error %d"), &aText, r);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Run the test utilities inside a trap harness.
sl@0:  *
sl@0:  * @param	"const TDesC& aText"
sl@0:  *			Test string giving the utility to run.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::RunUtilsL(const TDesC& aText)
sl@0: 	{
sl@0: 	// use Tlex to decode the cmd line
sl@0: 	TLex lex(aText);
sl@0: 
sl@0: 	// step over the keyword
sl@0: 	lex.NextToken();
sl@0: 
sl@0: 	// get util required
sl@0: 	TPtrC token;
sl@0: 	token.Set(lex.NextToken());
sl@0: 
sl@0: 	if (token.FindF( _L("ChangeDir")) == 0)
sl@0: 		{
sl@0: 		User::Panic(_L("ChangeDir is not supported on EKA2"), KErrNotSupported);
sl@0: 		}
sl@0: 	else if (token.FindF( _L("CopyFile")) == 0)
sl@0: 		{
sl@0: 		// get the parameter
sl@0: 		TPtrC file1 = lex.NextToken();
sl@0: 		TPtrC file2 = lex.NextToken();
sl@0: 
sl@0: 		CopyFileL(file1, file2);
sl@0: 		}
sl@0: 	else if (token.FindF( _L("CopyAndInvertFile")) == 0)
sl@0: 		{
sl@0: 		// get the parameter
sl@0: 		TPtrC file1 = lex.NextToken();
sl@0: 		TPtrC file2 = lex.NextToken();
sl@0: 
sl@0: 		CopyAndInvertFileL(file1, file2);
sl@0: 		}	
sl@0: 	else if (token.FindF( _L("MkDir")) == 0)
sl@0: 		{
sl@0: 		// get the parameter
sl@0: 		token.Set(lex.NextToken());
sl@0: 
sl@0: 		MakeDirL(token);
sl@0: 		}
sl@0: 	else if (token.FindF( _L("Delete")) == 0)
sl@0: 		{
sl@0: 		// get the parameter
sl@0: 		token.Set(lex.NextToken());
sl@0: 
sl@0: 		DeleteFileL(token);
sl@0: 		}
sl@0: 	else if (token.FindF( _L("MakeReadWrite")) == 0)
sl@0: 		{
sl@0: 		// get the parameter
sl@0: 		token.Set(lex.NextToken());
sl@0: 
sl@0: 		MakeReadWriteL(token);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		ERR_PRINTF2(_L("Failed to decode RUN_UTILS command : %S"), &aText);
sl@0: 		User::Leave(KErrNotFound);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utility : make new directory
sl@0:  *
sl@0:  * @param	"const TDesC& aDirname"
sl@0:  *			New directory path.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::MakeDirL(const TDesC& aDirname) 
sl@0: 	{
sl@0: 	// parse the filenames
sl@0: 	_LIT(KDefault,"C:\\"); 
sl@0: 	TParse fullFileName;
sl@0: 	TInt returnCode = fullFileName.Set(aDirname, &KDefault, NULL);
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3(_L("Failed to decode full path name %S - %S"), 
sl@0: 			&fullFileName.FullName(), 
sl@0: 			&errortxt);
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// connect to file server
sl@0: 	returnCode = iFs.Connect();
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("Error connecting to file server"));	
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// now create the new directory
sl@0: 	returnCode = iFs.MkDirAll(fullFileName.DriveAndPath()); 
sl@0: 	if ((returnCode != KErrNone) && (returnCode != KErrAlreadyExists))
sl@0: 		{		
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 
sl@0: 		ERR_PRINTF3(_L("Error %S making directory %S"), 
sl@0: 			&errortxt, 
sl@0: 			&fullFileName.FullName());
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 	if(returnCode == KErrNone)
sl@0: 		{
sl@0: 		// display full (including path) file name
sl@0: 		INFO_PRINTF2( _L("Made directory %S"), &fullFileName.FullName());	
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		INFO_PRINTF2( _L("directory already exists %S"), &fullFileName.FullName());		
sl@0: 		}
sl@0: 	iFs.Close();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utility : copy a file
sl@0:  *
sl@0:  * @param	"const TDesC& aOld"
sl@0:  *			Source file.
sl@0:  *
sl@0:  * @param	"const TDesC& aNew"
sl@0:  *			Destination file.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::CopyFileL (const TDesC& aOld,const TDesC& aNew) 
sl@0: 	{
sl@0: 	// connect to file server
sl@0: 	TInt returnCode = iFs.Connect();
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("Error connecting to file server"));	
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// create a file manager
sl@0: 	CFileMan* fileMan = CFileMan::NewL(iFs);
sl@0: 	CleanupStack::PushL(fileMan);
sl@0: 
sl@0: 	// parse the filenames
sl@0: 	TParse parseSource;
sl@0: 	returnCode = parseSource.Set(aOld, NULL, NULL);
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3( _L("Failed to parse %S - %S"), 
sl@0: 			&aOld, 
sl@0: 			&errortxt);
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0:  
sl@0: 	// parse the filenames
sl@0: 	TParse parseTarget;
sl@0: 	returnCode = parseTarget.Set(aNew, NULL, NULL);
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3(_L("Failed to parse %S - %S"), 
sl@0: 			&aNew, 
sl@0: 			&errortxt);
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// do the copy
sl@0: 	returnCode = fileMan->Copy(parseSource.FullName(), 
sl@0: 		parseTarget.FullName(), 
sl@0: 		CFileMan::EOverWrite | CFileMan::ERecurse);
sl@0: 
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 
sl@0: 		ERR_PRINTF4(_L("Failed to copy %S to %S - %S"), 
sl@0: 			&parseSource.FullName(), 
sl@0: 			&parseTarget.FullName(),
sl@0: 			&errortxt);
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	INFO_PRINTF3(_L("Copied file from %S to %S"), 
sl@0: 					&parseSource.FullName(), 
sl@0: 					&parseTarget.FullName());
sl@0: 
sl@0: 	iFs.Close();
sl@0: 	CleanupStack::PopAndDestroy(fileMan);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utility : invert a file and copy it to a tartget file
sl@0:  *
sl@0:  * @param	"const TDesC& aOld"
sl@0:  *			Source file.
sl@0:  *
sl@0:  * @param	"const TDesC& aNew"
sl@0:  *			Destination file.
sl@0:  *          Will contain the inverted file
sl@0:  *          
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::CopyAndInvertFileL (const TDesC& aOld,const TDesC& aNew) 
sl@0: 	{
sl@0:     
sl@0:     TRAPD(error, DoCopyAndInvertL(aOld, aNew));  
sl@0: 
sl@0:     if (error != KErrNone)
sl@0: 		{
sl@0:    		TPtrC errortxt = CLog::EpocErrorToText(error);
sl@0: 		ERR_PRINTF2(_L("Failed to copy Files - %S"), &errortxt);
sl@0: 		User::Leave(error);
sl@0: 		}	
sl@0:     	
sl@0: 	}
sl@0: 	
sl@0: 
sl@0: 	
sl@0: 	
sl@0: /**
sl@0:  *
sl@0:  * Test utility : Do the invert and copy of a source file
sl@0:  *				  into a target file. 
sl@0:  *
sl@0:  * @param	"const TDesC& aOld"
sl@0:  *			Source file.
sl@0:  *
sl@0:  * @param	"const TDesC& aNew"
sl@0:  *			Destination file.
sl@0:  *          Will contain the inverted file
sl@0:  *          
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::DoCopyAndInvertL (const TDesC& aOld,const TDesC& aNew)
sl@0: 	{
sl@0: 	// connect to file server
sl@0: 	TInt returnCode = iFs.Connect();
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("Error connecting to file server"));	
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0:     CleanupClosePushL(iFs);	
sl@0: 		
sl@0: 	// parse the filenames
sl@0: 	TParse parseSource;
sl@0: 	User::LeaveIfError(parseSource.Set(aOld, NULL, NULL));
sl@0: 
sl@0: 	// parse the filenames
sl@0: 	TParse parseTarget;
sl@0: 	User::LeaveIfError(parseTarget.Set(aNew, NULL, NULL));
sl@0: 	
sl@0: 	RFile sourceFile;
sl@0: 	
sl@0: 	// open the source file for reading
sl@0: 	User::LeaveIfError(sourceFile.Open(iFs, parseSource.FullName(), EFileRead));
sl@0: 	CleanupClosePushL(sourceFile);
sl@0: 	
sl@0: 	RFile targetFile;
sl@0: 	
sl@0: 	// open the target file for writing
sl@0: 	User::LeaveIfError(targetFile.Replace(iFs, parseTarget.FullName(), EFileWrite));
sl@0: 	CleanupClosePushL(targetFile);
sl@0: 	
sl@0: 	const TInt KSizeOfInvertBuf = 256;
sl@0: 	
sl@0: 	// Buffers used for read,invert and write to the target file
sl@0: 	TBuf8<KSizeOfInvertBuf> invertBuffer;
sl@0: 	TInt8 byteBuf;//A temp byte size buffer
sl@0: 	
sl@0: 	//Invert the source file and copy it into the target file 
sl@0: 	do 
sl@0: 		{
sl@0: 		User::LeaveIfError(sourceFile.Read(invertBuffer));
sl@0: 		
sl@0: 		for (TInt index=0; index<invertBuffer.Length(); index++)
sl@0: 			 {
sl@0: 			 byteBuf = invertBuffer[index];
sl@0: 			 byteBuf ^= 0xFF; //inverting the buf bits
sl@0: 			 invertBuffer[index] = byteBuf;
sl@0: 			 }
sl@0: 		User::LeaveIfError(targetFile.Write(invertBuffer));
sl@0: 	 	}
sl@0:    while (invertBuffer.Length() != 0);
sl@0:    
sl@0: 
sl@0:     // Flush the data to the target file
sl@0: 	User::LeaveIfError(targetFile.Flush());
sl@0: 	
sl@0:     // display full (including path) file name
sl@0: 	INFO_PRINTF3(_L("Copied and Inverted successfully file %S to file %S"), 
sl@0: 		&parseSource.FullName(),
sl@0: 		&parseTarget.FullName());
sl@0: 	
sl@0: 	//closing the files
sl@0: 	CleanupStack::PopAndDestroy(3, &iFs);
sl@0: 	
sl@0: 	}	
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utility : delete a file
sl@0:  *
sl@0:  * @param	"const TDesC& aFile"
sl@0:  *			File to be deleted.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::DeleteFileL (const TDesC& aFile) 
sl@0: 	{
sl@0: 	// parse the filenames
sl@0: 	_LIT(KDefault,"C:\\xxxxx.xxx"); 
sl@0: 	TParse fullFileName;
sl@0: 	TInt returnCode = fullFileName.Set(aFile, &KDefault, NULL);
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3(_L("Failed to decode full path name %S - %S"), 
sl@0: 			&fullFileName.FullName(), 
sl@0: 			&errortxt);
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// connect to file server
sl@0: 	returnCode = iFs.Connect();
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("Error connecting to file server"));	
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// now do the delete
sl@0: 	returnCode = iFs.Delete(fullFileName.FullName()); 
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{		
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3(_L("Error %S deleting %S"), 
sl@0: 			&errortxt, 
sl@0: 			&fullFileName.FullName());
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// display full (including path) file name
sl@0: 	INFO_PRINTF2(_L("Deleted %S"), &fullFileName.FullName());	
sl@0: 	iFs.Close();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test utility : make a file read-write (clear the read-only attribute)
sl@0:  *
sl@0:  * @param	"const TDesC& aFile"
sl@0:  *			File to be made read-write.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::MakeReadWriteL (const TDesC& aFile) 
sl@0: 	{
sl@0: 	// parse the filenames
sl@0: 	_LIT(KDefault,"C:\\xxxxx.xxx"); 
sl@0: 	TParse fullFileName;
sl@0: 	TInt returnCode = fullFileName.Set(aFile, &KDefault, NULL);
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 		ERR_PRINTF3(_L("Failed to decode full path name %S - %S"), 
sl@0: 			&fullFileName.FullName(), 
sl@0: 			&errortxt);
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// connect to file server
sl@0: 	returnCode = iFs.Connect();
sl@0: 	if (returnCode != KErrNone)
sl@0: 		{
sl@0: 		ERR_PRINTF1(_L("Error connecting to file server"));	
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// now do the delete
sl@0: 	returnCode = iFs.SetAtt(fullFileName.FullName(), 0, KEntryAttReadOnly); 
sl@0: 
sl@0: 	// check for errors
sl@0: 	if (returnCode != KErrNone )
sl@0: 		{		
sl@0: 		TPtrC errortxt = CLog::EpocErrorToText(returnCode);
sl@0: 
sl@0: 		ERR_PRINTF3(_L("Error %S making %S read-write"), 
sl@0: 			&errortxt, 
sl@0: 			&fullFileName.FullName());
sl@0: 		iFs.Close();
sl@0: 		User::Leave(returnCode);
sl@0: 		}
sl@0: 
sl@0: 	// display full (including path) file name
sl@0: 	INFO_PRINTF2(_L("Made %S read-write"), &fullFileName.FullName());	
sl@0: 	iFs.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * General logging function for test utils.
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: void CTestUtils::Log(TRefByValue<const TDesC16> aFmt, ...)
sl@0: 	{
sl@0: 
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 
sl@0: 	if(iLogSystem) 
sl@0: 		iLogSystem->Log(aFmt, aList);
sl@0: 
sl@0: 	VA_END(aList);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * General logging function for test utils, 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 format.
sl@0:  *
sl@0:  * @param	"..."
sl@0:  *			Variable print parameters
sl@0:  *
sl@0:  * @xxxx 
sl@0:  *
sl@0:  */
sl@0: void CTestUtils::Log(TInt /* aSeverity */, TRefByValue<const TDesC16> aFmt, ...)
sl@0: 	{
sl@0: 	VA_LIST aList;
sl@0: 	VA_START(aList, aFmt);
sl@0: 
sl@0: 	// NB : Test Utils log regardless of severity (as they are tied to no suite)
sl@0: 	if(iLogSystem) 
sl@0: 		iLogSystem->Log(aFmt, aList);
sl@0: 
sl@0: 	VA_END(aList);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Traceable logging function for test utils.
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: void CTestUtils::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: 	// NB : Test Utils log regardless of severity (as they are tied to no suite)
sl@0: 	if(iLogSystem)
sl@0: 		iLogSystem->LogExtra(aFile, aLine, aSeverity, aFmt, aList);
sl@0: 
sl@0: 	VA_END(aList);
sl@0: 	}
sl@0: 
sl@0: