// Copyright (c) 1997-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:

//

#include <e32test.h>

#include <baclipb.h>

#include <bautils.h>

#include <f32file.h>

#include <s32strm.h>

#include <s32file.h>

#include <e32lang.h>

#include <fbs.h>

LOCAL_D RTest theTest(_L("T_BaflUtils"));

const TInt KMaxDisplayedFullNameLen	= 29;

// File names for copying

const TPtrC KSystem1Folder				=_L("C:\\System1\\");

const TPtrC KSystem1Data1Folder			=_L("C:\\System1\\data1\\");

const TPtrC KSystem1Data1File1			=_L("C:\\System1\\data1\\file1.txt");

const TPtrC KFile1						=_L("C:\\file1.txt");

const TPtrC KSystem1Data1SrcFile1		=_L("C:\\System1\\data1\\src\\file1.txt");

const TPtrC KSystem1Data1DstFile2		=_L("C:\\System1\\data1\\dst\\file2.txt");

const TPtrC KSystem1Data1File123456789	=_L("C:\\System1\\data1\\file123456789.txt");

const TPtrC KSystem1Data1File2			=_L("C:\\System1\\data1\\file2.txt");

const TPtrC KSystem1Data1File5			=_L("C:\\System1\\data1\\file5.txt");

const TPtrC KSystem1Data1SrcFolder		=_L("C:\\System1\\data1\\src\\");

const TPtrC KSystem1Data1DstFolder		=_L("C:\\System1\\data1\\dst\\");

const TPtrC KZFile1						=_L("Z:\\file1.txt");

// Valid Paths / Folder Name

const TPtrC KValidPathName=_L("C:\\System1\\Data1\\");

const TPtrC KValidPathNameWithoutDrive=_L("\\System1\\Data1\\");

const TPtrC KValidPathNameWithoutDrive2=_L("\\System1\\Data1\\file1.txt");

const TPtrC KValidFileName=_L("C:\\file1.txt");

const TPtrC KValidFileNameNoExtension=_L("C:\\file1");

const TPtrC KValidPathAndFileName=_L("C:\\System1\\Data1\\file1.txt");

const TPtrC KValidFolderName=_L("C:\\System1\\Data1\\Dst\\");

const TPtrC KValidDrive=_L("C:\\");

const TPtrC KValidDrive2=_L("C:");

const TPtrC KValidDrive3=_L("C");

const TPtrC KValidDrive4=_L("Z:\\");

const TPtrC KCopyFileFrom=_L("C:\\System1\\Data1\\Src\\file1.txt");

const TPtrC KCopyFileTo=_L("C:\\System1\\Data1\\Dst\\file1.txt");

const TPtrC KDeleteFile=_L("C:\\System1\\Data1\\Dst\\file1.txt");

const TPtrC KRenameFromFile=_L("C:\\System1\\Data1\\file2.txt");

const TPtrC KRenameToFile=_L("C:\\System1\\Data1\\file2New.txt");

const TPtrC KValFolderName=_L("ValidFolderName");

const TPtrC KCurrentPath=_L("C:\\System1\\Data1\\");

const TPtrC KNoFolderName = _L("");

const TPtrC KSessionRoot = _L("\\");

// KFolderNameIsTooLong is 256 chars long

const TPtrC KFolderNameIsTooLong = _L("C:\\ThisFolderNameIsgoingToBeTooLongToBeCreatedOnTheSystemThisFolderNameIsgoingToBeTooLongToBeCreatedOnTheSystemThisFolderNameIsgoingToBeTooLongToBeCreatedOnTheSystemThisFolderNameIsgoingToBeTooLongToBeCreatedOnTheSystemThisFolderNameIsgoingToBeTooLongToBeC\\");

const TPtrC KAbbreviatesFileFrom=_L("C:\\System1\\Data1\\file5.txt");

const TPtrC KAbbreviatesFileFrom2=_L("C:\\System1\\Data1\\file123456789.txt");

// InValid Paths / Folder Names

const TPtrC KNoParameters=_L("");

const TPtrC KInValidParameters=_L("3: \\52324424");

const TPtrC KInValidPathName=_L("C:\\System1\\Data1\\InvalidPathName\\");

const TPtrC KInvalidFileName=_L("C:\\System1\\Data1\\thefiledoesnotexistatthislocation.txt");

const TPtrC KIllegalFileName=_L("C:\\System1\\Data1\\Illega<>.txt");

const TPtrC KIllegalFolderName=_L("C:\\System1\\Data*<\\");

const TPtrC KFolderNameWithWildcard=_L("C:\\System1\\data*\\");

const TPtrC KInValidFolderName=_L("C:\\System1\\Data1\\InValid3+FollderName");

const TPtrC KInValidDrive=_L("P:\\");

const TPtrC KAppAbbName=_L("\\System1");

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

//

// Timing macros.

//

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

const TInt KMaxIterations     =   100;

#define INCLUDE_VERBOSE

#define TIMERINSTALL \

	TTime start(0); \

	TTime end(0);   \

	TUint delta = 0; \

	TUint cummulative = 0; \

	TUint iterations = 0;

#define TIMERRESET \

	delta = 0, cummulative = 0, iterations = 0;

#define TIMERSTART \

	start.UniversalTime();

#define TIMERSTOP \

	end.UniversalTime(); \

	delta = I64LOW(end.MicroSecondsFrom(start).Int64()); \

	iterations++; \

	cummulative += delta;

#ifdef INCLUDE_VERBOSE

_LIT(KTimerResult,   "Average time = %dus over %d iterations\n");

_LIT(KTimingError,   "Error - no timing results to display\n");

# define TIMERRESULT \

	if (iterations) \

		{ \

		theTest.Printf(KTimerResult, cummulative/iterations, iterations); \

		} \

	else \

		{ \

		theTest.Printf(KTimingError); \

		}

#else

# define TIMERRESULT

#endif

#define TIMERAVERAGE \

		(iterations ? cummulative/iterations : 0xFFFFFFFF)

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

//

//BaflUtils::GetEquivalentLanguageList

//BaflUtils::NearestLanguageFileV2 

//test data

_LIT (KNullFilename, "");

_LIT (KRscFilename,  "C:\\geltest.rsc");

_LIT (KRscFilenameNoSuffix,  "C:\\geltest.");

_LIT (KAmericanLang, "C:\\geltest.r10");

_LIT (KFrenchLang,   "C:\\geltest.r02");

_LIT (KJapanEnglishLang, "C:\\geltest.r160");

_LIT (KEnglishLang, "C:\\geltest.r01");

_LIT (KInvalidDriveLetterV2, "q:\\geltest.rsc");

_LIT (KNoSuchLangFile, "c:\\geltest.r54");

//

//BaflUtils::PathExist test data

// Defines the maximum number of preconditions for each test case.

#define PATH_EXIST_MAX_PRECONDITIONS 1

// Literals for PathExist testing

const TPtrC KPathExistValid = _L("C:\\ValidPath\\Data1\\");

const TPtrC KPathExistInValid = _L("C:\\ValidPath\\Data1\\InvalidPathName\\");

const TPtrC KPathExistFullFile = _L("C:\\ValidPath\\Data1\\file1.txt");

const TPtrC KPathExist257 = _L("c:\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\256\\");

const TPtrC KPathExist256 = _L("c:\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\56\\");

const TPtrC KPathExist255 = _L("c:\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\10Letters\\6\\");

const TPtrC KPathExistShort = _L("c:\\10Letters\\10Letters\\");

const TPtrC KPathExistShortT1 = _L("c:\\10Letters\\10Letters");

const TPtrC KPathExistShortT2 = _L("c:\\10Letters\\10*\\");

const TPtrC KPathExistShortT3 = _L("c:\\10Letters\\10Letter?\\");

const TPtrC KPathExistSessionPath = _L("c:\\");

const TPtrC KPathExistRelativeT1 = _L("\\10Letters");

const TPtrC KPathExistRelativeT2 = _L("\\10Letters\\");

const TPtrC KPathExistRelativeT3 = _L("10Letters\\");

struct TPathExistTestRecord

// Defines the test case structure for PathExist unit testing

{

	// precondititions, directories to create before test run

	const TPtrC *iInPaths[PATH_EXIST_MAX_PRECONDITIONS];

	// the directory to test for

	const TPtrC  *iTestPath;

	// expected results

	TBool iResult;

	// test case line number for quick test identification

	TInt iLineNum;

};

LOCAL_D const TPathExistTestRecord pathExistTestCases[] =

// Test cases for PathExist unit testing

{

	{{&KPathExistValid}, &KPathExistValid, ETrue, 		__LINE__},

	{{&KPathExistValid}, &KPathExistInValid, EFalse, 	__LINE__},

	{{&KPathExistFullFile}, &KPathExistFullFile, EFalse,__LINE__},

	{{}, &KInValidParameters, EFalse, 					__LINE__},

	{{}, &KInValidFolderName, EFalse, 					__LINE__},

	{{}, &KValidDrive2, EFalse, 						__LINE__},

	{{}, &KNoParameters, EFalse, 						__LINE__},

	{{&KPathExistShort}, &KPathExistShort, ETrue, 		__LINE__},

	{{&KPathExistShort}, &KPathExistShortT1, EFalse, 	__LINE__},

	{{&KPathExistShort}, &KPathExistShortT2, EFalse, 	__LINE__},

	{{&KPathExistShort}, &KPathExistShortT3, EFalse, 	__LINE__},

	{{&KPathExistShort}, &KPathExistRelativeT1, EFalse, __LINE__},

	{{&KPathExistShort}, &KPathExistRelativeT2, EFalse, __LINE__},

	{{&KPathExistShort}, &KPathExistRelativeT3, EFalse, __LINE__},

#if !defined __WINS__ && !defined __WINSCW__

// max boundary tests - can only be tested on hardware

	{{&KPathExist255}, &KPathExist255, ETrue, 			__LINE__},

	{{&KPathExist256}, &KPathExist256, ETrue, 			__LINE__},

	{{&KPathExist257}, &KPathExist257, EFalse, 			__LINE__},

#endif //!defined __WINS__ && !defined __WINSCW__

	{{}, NULL, ETrue} // mandatory, last element

};

TBool DoTestPathExistsL(RFs& aFs, const struct TPathExistTestRecord& aTestRecord);

//

//Create/Destroy test environment global functions

//Delete "aFullName" file.

LOCAL_C void DeleteTestFile(const TDesC& aFullName)

	{

	RFs fsSession;

	TInt err = fsSession.Connect();

	if(err == KErrNone)

		{

		TEntry entry;

		if(fsSession.Entry(aFullName, entry) == KErrNone)

			{

			RDebug::Print(_L("Deleting \"%S\" file.\n"), &aFullName);

			err = fsSession.SetAtt(aFullName, 0, KEntryAttReadOnly);

			if(err != KErrNone)

				{

				RDebug::Print(_L("Error %d changing \"%S\" file attributes.\n"), err, &aFullName);

				}

			err = fsSession.Delete(aFullName);

			if(err != KErrNone)

				{

				RDebug::Print(_L("Error %d deleting \"%S\" file.\n"), err, &aFullName);

				}

			}

		fsSession.Close();

		}

	else

		{

		RDebug::Print(_L("Error %d connecting file session. File: %S.\n"), err, &aFullName);

		}

	}

//Delete "aFullName" dir.

LOCAL_C void DeleteTestDir(const TDesC& aFullName)

	{

	RFs fsSession;

	TInt err = fsSession.Connect();

	if(err == KErrNone)

		{

		TEntry entry;

		if(fsSession.Entry(aFullName, entry) == KErrNone)

			{

			RDebug::Print(_L("Deleting \"%S\" dir.\n"), &aFullName);

			err = fsSession.SetAtt(aFullName, 0, KEntryAttReadOnly);

			if(err != KErrNone)

				{

				RDebug::Print(_L("Error %d changing \"%S\" dir attributes.\n"), err, &aFullName);

				}

			err = fsSession.RmDir(aFullName);

			if(err != KErrNone)

				{

				RDebug::Print(_L("Error %d deleting \"%S\" dir.\n"), err, &aFullName);

				}

			}

		fsSession.Close();

		}

	else

		{

		RDebug::Print(_L("Error %d connecting file session. Dir: %S.\n"), err, &aFullName);

		}

	}

//Delete data files used by the test

LOCAL_C void DeleteTestFiles()

	{

		DeleteTestFile(KSystem1Data1File1);

		DeleteTestFile(KFile1);

		DeleteTestFile(KSystem1Data1SrcFile1);

		DeleteTestFile(KSystem1Data1DstFile2);

		DeleteTestFile(KSystem1Data1File123456789);

		DeleteTestFile(KSystem1Data1File2);

		DeleteTestFile(KSystem1Data1File5);

		DeleteTestDir(KSystem1Data1SrcFolder);

		DeleteTestDir(KSystem1Data1DstFolder);

		DeleteTestDir(KSystem1Data1Folder);

		DeleteTestDir(KSystem1Folder);

	}

//

//Test macroses and functions

LOCAL_C void Check(TInt aValue, TInt aLine)

	{

	if(!aValue)

		{

		::DeleteTestFiles();

		theTest(EFalse, aLine);

		}

	}

LOCAL_C void Check(TInt aValue, TInt aExpected, TInt aLine)

	{

	if(aValue != aExpected)

		{

		RDebug::Print(_L("*** Expected error: %d, got: %d\r\n"), aExpected, aValue);

		::DeleteTestFiles();

		theTest(EFalse, aLine);

		}

	}

#define TEST(arg) ::Check((arg), __LINE__)

#define TEST2(aValue, aExpected) ::Check(aValue, aExpected, __LINE__)

LOCAL_C void DeleteTestFiles2(RFs &aFs)

{

	BaflUtils::DeleteFile (aFs, KRscFilename);

	BaflUtils::DeleteFile (aFs, KAmericanLang);

	BaflUtils::DeleteFile (aFs, KFrenchLang);

	BaflUtils::DeleteFile (aFs, KJapanEnglishLang);

	BaflUtils::DeleteFile (aFs, KEnglishLang);

}

LOCAL_C void CreateTestFiles2(RFs &aFs)

{

	TEST (BaflUtils::FileExists (aFs, KRscFilename) == EFalse);

	TEST (BaflUtils::FileExists (aFs, KAmericanLang) == EFalse);

	TEST (BaflUtils::FileExists (aFs, KFrenchLang) == EFalse);

	TEST (BaflUtils::FileExists (aFs, KJapanEnglishLang) == EFalse);

	TEST (BaflUtils::FileExists (aFs, KEnglishLang) == EFalse);

	// Create the files...

	RFile rFile;

	TEST (KErrNone == rFile.Create (aFs, KRscFilename, EFileRead));

	rFile.Close ();

	TEST (KErrNone == rFile.Create (aFs, KAmericanLang, EFileRead));

	rFile.Close ();

	TEST (KErrNone == rFile.Create (aFs, KFrenchLang, EFileRead));

	rFile.Close ();

	TEST (KErrNone == rFile.Create (aFs, KEnglishLang, EFileRead));

	rFile.Close ();

}

//

//Copy test file from Z: to C: drive.

LOCAL_C void CopyTestFiles()

	{

	RFs fsSession;

	TInt err = fsSession.Connect();

	if(err == KErrNone)

		{

		User::LeaveIfError(fsSession.MkDir(KSystem1Folder));

		User::LeaveIfError(fsSession.MkDir(KSystem1Data1Folder));

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1File1), KErrNone);

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KFile1), KErrNone);

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1File123456789), KErrNone);

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1File2), KErrNone);

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1File5), KErrNone);

		User::LeaveIfError(fsSession.MkDir(KSystem1Data1SrcFolder));

		User::LeaveIfError(fsSession.MkDir(KSystem1Data1DstFolder));

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1SrcFile1), KErrNone);

		TEST2( BaflUtils::CopyFile(fsSession, KZFile1, KSystem1Data1DstFile2), KErrNone);

		fsSession.Close();

		}

	else

		{

		RDebug::Print(_L("Error %d connecting file session.\n"), err);

		}

	}

//

/**

@SYMTestCaseID SYSLIB-BAFL-CT-1571

@SYMTestCaseDesc Tests BaflUtils::PersistHAL()

@SYMTestPriority Medium

@SYMTestActions It starts halsetting.exe and persist hal settings

@SYMTestExpectedResults The test must not fail.

@SYMDEF DEF083235 	Prop: HAL Attributes (eg screen calibration) lost if the battery is pulled out

*/

void TestPersistHAL()

	{

	TEST (BaflUtils::PersistHAL() == KErrNone);

	theTest.Next(_L(" @SYMTestCaseID SYSLIB-BAFL-CT-1571 "));

	theTest.Printf(_L("BaflUtils::PersistHAL() called"));

	}

/**

@SYMTestCaseID SYSLIB-BAFL-CT-0038-0001

@SYMTestCaseDesc Tests Baflutils::EnsurePathExists.

@SYMTestPriority Medium

@SYMTestActions Passes in existing and non-existing pathnames and removes any directories created.

@SYMTestExpectedResults The test must not fail.

@SYMDEF DEF050397 - Crimson test code improvement to be propagated into MCL

*/

void TestEnsurePathExistsL(RFs& aFs)

	{

	theTest.Next(_L(" @SYMTestCaseID SYSLIB-BAFL-CT-0038-0001 "));

	CleanupClosePushL(aFs);

	User::LeaveIfError(aFs.Connect());

	// Path already exists so -11 will be returned within EnsurePathExistsL, Method Leaves with error code 0

	TRAPD(err, BaflUtils::EnsurePathExistsL(aFs, KValidPathName));

	TEST(!err);

	// Path does not exist so -12 will be returned within EnsurePathExistsL, The Directory will be created, Method Leaves with error code 0

	TRAPD(err2, BaflUtils::EnsurePathExistsL(aFs, KInValidPathName));

	TEST(!err2);

	TEST(!aFs.RmDir(KInValidPathName));

	CleanupStack::PopAndDestroy(&aFs);

	}

/**

@SYMTestCaseID SYSLIB-BAFL-CT-0038-0002

@SYMTestCaseDesc Tests Baflutils::TestFileExists.

@SYMTestPriority Medium

@SYMTestActions Passes in valid and invalid files.

@SYMTestExpectedResults The test must not fail.

@SYMDEF DEF050397 - Crimson test code improvement to be propagated into MCL

*/

void TestFileExists(RFs& aFs)

	{

	theTest.Next(_L(" @SYMTestCaseID SYSLIB-BAFL-CT-0038-0002 "));

	CleanupClosePushL(aFs);

	User::LeaveIfError(aFs.Connect());

	TEST (BaflUtils::FileExists(aFs,KValidPathAndFileName));

	TEST (!BaflUtils::FileExists(aFs,KInvalidFileName));

	CleanupStack::PopAndDestroy(&aFs);

	}

/**

@SYMTestCaseID SYSLIB-BAFL-CT-0038-0003

@SYMTestCaseDesc Tests Baflutils::TestFolderExists.

@SYMTestPriority Medium

@SYMTestActions Passes in valid and invalid folders.

@SYMTestExpectedResults The test must not fail.

@SYMDEF DEF050397 - Crimson test code improvement to be propagated into MCL

*/

void TestFolderExists(RFs& aFs)

	{

	theTest.Next(_L(" @SYMTestCaseID SYSLIB-BAFL-CT-0038-0003 "));

	CleanupClosePushL(aFs);

	User::LeaveIfError(aFs.Connect());

	TInt x = KMaxIterations;

	TIMERINSTALL

	while (x--)

	{

		TIMERSTART

		TEST(BaflUtils::FolderExists(aFs, KValidPathName));

		TEST(BaflUtils::FolderExists(aFs, KValidFileName));

		TEST(BaflUtils::FolderExists(aFs, KValidFileNameNoExtension));

	 	TEST(BaflUtils::FolderExists(aFs, KValidPathAndFileName));

	 	TEST(BaflUtils::FolderExists(aFs, KValidPathNameWithoutDrive));

	 	TEST(BaflUtils::FolderExists(aFs, KValidPathNameWithoutDrive2));

	 	TEST(BaflUtils::FolderExists(aFs, KValidDrive));

	 	TEST(BaflUtils::FolderExists(aFs, KValidDrive4));

	 	TEST(BaflUtils::FolderExists(aFs, KSessionRoot));

	 	TIMERSTOP

	}

	theTest.Printf(_L("\nBenchmark results for FolderExists tests returning ETrue:\n"));

	TIMERRESULT

	TIMERRESET

	x = KMaxIterations;

	while (x--)

	{

		TIMERSTART

		TEST(!BaflUtils::FolderExists(aFs, KInValidPathName));

		TEST(!BaflUtils::FolderExists(aFs, KNoFolderName));

		TEST(!BaflUtils::FolderExists(aFs, KFolderNameIsTooLong));

	 	TEST(!BaflUtils::FolderExists(aFs, KIllegalFileName));

	 	TEST(!BaflUtils::FolderExists(aFs, KIllegalFolderName));

	 	TEST(!BaflUtils::FolderExists(aFs, KFolderNameWithWildcard));

		TIMERSTOP

	}

	theTest.Printf(_L("\nBenchmark results for FolderExists tests returning EFalse:\n"));

	TIMERRESULT

	theTest.Printf(_L("\n"));

	CleanupStack::PopAndDestroy(&aFs);

	}

/**

@SYMTestCaseID SYSLIB-BAFL-CT-0038-0004

@SYMTestCaseDesc Tests Baflutils::TestPathExists.

@SYMTestPriority Medium

@SYMTestActions Passes in valid and invalid paths.

@SYMTestExpectedResults The test must not fail.

@SYMDEF DEF050397 - Crimson test code improvement to be propagated into MCL

@SYMDEF INC084050 - BaflUtils::PathExists does not work for 256 long folder paths

*/

void TestPathExistsL(RFs& aFs)

	{

	theTest.Next(_L(" @SYMTestCaseID SYSLIB-BAFL-CT-0038-0004 "));

	CleanupClosePushL(aFs);