// 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 "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:

// T_MSGS_CACHE_VISIBLEFOLDER_STEP.CPP

// 

//

#include "t_msv_cache_visiblefolder_step.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS  

#include "msvconsts.h"

#endif

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

#include "msvindexadapter.h"

#include <flogger.h>

#endif

#define MY_ASSERT_TRUE(a)  \

		INFO_PRINTF1(KFunction);   \

		ASSERT_TRUE(a);

#define MY_ASSERT_FALSE(a)  \

		INFO_PRINTF1(KFunction);   \

		ASSERT_FALSE(a);

#define MY_ASSERT_EQUALS(a,b)  \

		INFO_PRINTF1(KFunction);   \

		ASSERT_EQUALS(a,b);

//Database used for testing

#ifdef SYMBIAN_MESSAGESTORE_UNIT_TESTCODE

_LIT(KTestDbFileName, "c:\\messaging.db");

#else

#endif

_LIT(KSTDMSGINI, "C:\\private\\1000484b\\msgcache.ini");

_LIT(KMSGINI_2, "C:\\private\\1000484b\\msgcache2.ini");

CTestVisibleFolder::CTestVisibleFolder()

	{

	}

CTestVisibleFolder::~CTestVisibleFolder()

	{

	}

void CTestVisibleFolder::SetupL()

	{

	_LIT(KFunction, "CreateFolderList");

	INFO_PRINTF1(KFunction);

	//__UHEAP_MARK;

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

	TMsvPreferredDrive driveEntry;

	driveEntry.driveNum = EDriveC;

	driveEntry.driveId = 2;		// This is in sync with InitDb()

	driveEntry.status = EMsvMessageStoreAvailableStatus;

	TRAP_IGNORE(iDriveList = CMsvPreferredDriveList::CreateL());

	iDriveList->Insert(driveEntry, 0);

	iDriveList->SetCurrentDriveIndex(0);

#endif 

	TMsvId aId = 5;

	CMsvCacheVisibleFolder *folderA = NULL;

	TRAP_IGNORE(folderA= CMsvCacheVisibleFolder::NewL(aId));

	iFolderPointer.Append (folderA);

	aId = 30;

	CMsvCacheVisibleFolder *folderB = NULL;	

	TRAP_IGNORE(folderB= CMsvCacheVisibleFolder::NewL(aId));

	iFolderPointer.Append (folderB);

	//===============Init============================//

	TInt err =	iFileHandle.Connect();

	MY_ASSERT_EQUALS(err, KErrNone);

	//err = iFileHandle.Replace(KMSGINI_2, KSTDMSGINI);

	CFileMan* file  = NULL;

	TRAP_IGNORE(file = CFileMan::NewL(iFileHandle));

	err = file->Copy(KMSGINI_2, KSTDMSGINI);

	MY_ASSERT_EQUALS(err, KErrNone);

	delete file;

	TDblQue<CMsvCacheVisibleFolder> iEntryCache;

	TRAP_IGNORE(iMsvEntryFreePool = CMsvEntryFreePool::CreateL(&iEntryCache));

	}

void CTestVisibleFolder::AddTestEntries()

	{

	TMsvId msvId = 05;

	//===============Init============================//

	aEntryA = Entry();

	aEntryB = Entry();

	aEntryC = Entry();

	aEntryA->Entry().SetParent((TMsvId)30);

	aEntryA->Entry().SetId (msvId);//TMsvId = 05

	iEntryPointer.Append (aEntryA);

	++msvId;//TMsvId = 06 is missing in the block for now

	aEntryB->Entry().SetParent((TMsvId)30);

	aEntryB->Entry().SetId (++msvId);//TMsvId = 07

	iEntryPointer.Append (aEntryB);

	++msvId;//TMsvId = 08 is missing in the block for now

	aEntryC->Entry().SetParent((TMsvId)30);

	aEntryC->Entry().SetId (++msvId);//TMsvId = 09

	iEntryPointer.Append (aEntryC);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryListL(iEntryPointer, ETrue));

	//===============Func============================//

	}

void CTestVisibleFolder::TearDownL()

	{

	_LIT(KDeleteFolderList, "DeleteFolderList");

	INFO_PRINTF1(KDeleteFolderList);

	iEntryPointer.Reset();

	iFolderPointer.ResetAndDestroy();

	//iFileHandle.Replace(KSTDMSGINI, KMSGINI_2);

	iFileHandle.Close();

#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

	delete iDriveList;

#endif

#ifdef _DEBUG

	CMsvEntryFreePool::Destroy(iMsvEntryFreePool);

	iMsvEntryFreePool = NULL;

#else

	delete iMsvEntryFreePool;

	iMsvEntryFreePool = NULL;

#endif

	//__UHEAP_MARKEND;

	}

void CTestVisibleFolder::CreateEntry(TMsvId aId, TMsvId aParentId, TUid aUid, TMsvId& aVisibleFolder, TBool aIsVisible /* (Default = EFalse)*/)

	{

	TMsvEntry sampleTMsvEntry;

	sampleTMsvEntry.SetId(aId);

	sampleTMsvEntry.SetParent(aParentId);

	sampleTMsvEntry.iDate.UniversalTime();

	sampleTMsvEntry.iType = aUid;

	sampleTMsvEntry.SetVisible(aIsVisible);

	// Extra Information (Needed only in TestGetEntry()

	sampleTMsvEntry.SetUnread(ETrue);

	sampleTMsvEntry.iServiceId = aId+10;		// Some Random Id.

	sampleTMsvEntry.iRelatedId = aId+20;		// Some Random Id.

	sampleTMsvEntry.iMtm = aUid;		

	sampleTMsvEntry.iSize = 32;

	sampleTMsvEntry.iError = NULL;		

	sampleTMsvEntry.iBioType = 64;		

	sampleTMsvEntry.iMtmData1 = 64;		

	sampleTMsvEntry.iMtmData2 = 64;		

	sampleTMsvEntry.iMtmData3 = 64;	

	_LIT(KName, "Hello World");

	HBufC* data = NULL;

	TRAP_IGNORE(data = HBufC::NewL(15)); 

	*data = KName;

	sampleTMsvEntry.iDescription.Set(data->Des());

	TRAP_IGNORE(iMsvDbAdaptor->CreateEntryL(sampleTMsvEntry, aVisibleFolder));	

	delete data;

	data = NULL;	

	}

/**

 TestAddEntry()

@param None.

@return None.

Tests the AddEntryL() functionality of CMsCacheVisibleFolder Class.

Tested Steps

01. Init

02. Add Entry When IndexTable is not created

03. Add entry when index table is created and Entry in range

04. Add entry when index table is created and Entry not in range

05. Adding an already Existing Entry in the cache

06. Adding a Child entry when index table is not created

07. Adding a Child entry whose parent is available and child entry is in range

08. Adding a Child entry whose parent is available and child entry is not in range

09. Adding a Child entry whose parent is not available

10. Adding a Great Grand Child entry whose parent is available

11. Adding a Great Grand Child entry whose parent is not available

*/

void CTestVisibleFolder::TestAddEntry()

	{

	_LIT(KFunction, "TestAddEntry");

	INFO_PRINTF1(KFunction);

	// 01. Init

	CMsvCacheEntry *entryE;

	TInt releasedEntries;

	// 02. Add Entry When IndexTable is not created

	CMsvCacheEntry* entryF = Entry();

	entryF->Entry().SetParent((TMsvId)30);

	entryF->Entry().SetId ((TMsvId)06);//TMsvId = 06

	entryF->LockEntry();

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)06, entryE));

	TRAP_IGNORE(iFolderPointer[1]->DeleteEntryL((TMsvId)06));

	ASSERT_SAME(entryF, entryE);

	entryE = NULL;

	entryF = NULL;

	// 03. Add entry when index table is created and Entry in range

	AddTestEntries();

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)30);

	entryF->Entry().SetId ((TMsvId)8);//TMsvId = 08

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)8, entryE));

	ASSERT_SAME(entryF, entryE);

	entryE =NULL;

	entryF =NULL;

	// 04. Add entry when index table is created and Entry not in range

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)30);

	entryF->Entry().SetId ((TMsvId)15);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)15, entryE));

	ASSERT_SAME(entryF, entryE);

	entryE = NULL;

	entryF = NULL;

	// 05. Adding an already Existing Entry in the cache

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)30);

	entryF->Entry().SetId ((TMsvId)15);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)15, entryE));

	ASSERT_SAME(entryF, entryE);

	entryE = NULL;

	entryF = NULL;

	//ReCreate

	TRAP_IGNORE(TearDownL());

	TRAP_IGNORE(SetupL());

	INFO_PRINTF1(KFunction);

	// 06. Adding a Child entry when index table is not created

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)5);

	entryF->Entry().SetId ((TMsvId)15);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)15, entryE));

	entryE =NULL;

	MY_ASSERT_TRUE(iFolderPointer[1]->ReleaseAllBlocks(releasedEntries));

	ASSERT_EQUALS(1, releasedEntries);

	// 07. Adding a Child entry whose parent is available and child entry is in range

	AddTestEntries();

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)5);

	entryF->Entry().SetId ((TMsvId)6);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)6, entryE));

	ASSERT_SAME(entryF, entryE);

	entryE = NULL;

	entryF = NULL;

	// 08. Adding a Child entry whose parent is available and child entry is not in range

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)5);

	entryF->Entry().SetId ((TMsvId)19);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)19, entryE));

	ASSERT_SAME(entryF, entryE);

	entryE = NULL;

	entryF = NULL;

	// 09. Adding a Child entry whose parent is not available

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)50);

	entryF->Entry().SetId ((TMsvId)51);

	TRAP_IGNORE(iFolderPointer[1]->AddEntryL(entryF));

	MY_ASSERT_TRUE(iFolderPointer[1]->GetEntry ((TMsvId)51, entryE));

	entryE = NULL;

	}

/**

 TestAddEntryList()

@param None.

@return None.

Tests the AddEntryListL() functionality of CMsCacheVisibleFolder Class.

Tested Steps

01. Init

-- Index Table is not created

02. Add Zero Entries into the cache

03. Add one Entry into the cache

04. Add 64(Maximum size of a block) entries into the cache

05. Add 65 entries into the cache

06. Add 128 entries into the cache

07. Add 350 entries into the cache

-- Index Table already exists

08. Add Already existing entries ino the cache

09. Add new set of entries to the existing entries

10. Add existing and non-existing entries into the cache

-- Index Table is not created(Rogue Entries)

12. Add complete childrens

13. Add Grand Childrens

14. Add Great Grand Childrens

*/

void CTestVisibleFolder::TestAddEntryList()

	{

	_LIT(KFunction, "TestAddEntryList");

	INFO_PRINTF1(KFunction);

	//01. Init

	CMsvCacheEntry* entryF;

	TInt releasedEntries;

	TInt p = 0, j = 0, k = 0;

	RPointerArray<CMsvCacheEntry> addEntryPointer;

	RPointerArray<CMsvCacheEntry> getEntryPointer;

	RPointerArray<CMsvCacheIndexTableEntry>* indexTable;

	//02. Add Zero Entries into the cache

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer));

	/**************** 

	  * TEST CASE WITH (aIsCompleteChildOfFolder = ETrue)

	  * IndexTable is not created.

	  * 

	  * This will mainly check the functionality

	  * of SplitAndAppend()

	  */

	//03. Add one Entry into the cache

	entryF = Entry();

	entryF->Entry().SetParent((TMsvId)5);

	entryF->Entry().SetId ((TMsvId)10);

	entryF->LockEntry();

	addEntryPointer.Append(entryF);

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer, ETrue));

    indexTable = iFolderPointer[0]->GetIndexTableEntry();

	TRAP_IGNORE(MY_ASSERT_TRUE(iFolderPointer[0]->GetChildrenL((TMsvId)5, NULL, getEntryPointer)));

	MY_ASSERT_EQUALS(1, getEntryPointer.Count());

	MY_ASSERT_EQUALS(1, addEntryPointer.Count());

	MY_ASSERT_EQUALS((TMsvId)10, getEntryPointer[0]->Entry().Id());

	MY_ASSERT_EQUALS((TMsvId)10, addEntryPointer[0]->Entry().Id());

	MY_ASSERT_EQUALS(1, indexTable->Count());

	MY_ASSERT_EQUALS((TMsvId)0, (*indexTable)[0]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)10, (*indexTable)[0]->GetMaxMsvIdRange());

	MY_ASSERT_FALSE((*indexTable)[0]->IsGrandChildPresent());

	MY_ASSERT_EQUALS(1, (*indexTable)[0]->BlockPtr()->Count());

	getEntryPointer.Reset();

	addEntryPointer.Reset();

	entryF = NULL;

	delete iFolderPointer[0];

	TRAP_IGNORE(iFolderPointer[0] = CMsvCacheVisibleFolder::NewL((TMsvId)5));

	//04. Add 64(Maximum size of a block) entries into the cache

	for (TInt index = 10; index < 74; ++index)

		{

		entryF = Entry();

		entryF->Entry().SetParent((TMsvId)5);

		entryF->Entry().SetId ((TMsvId)index);

		addEntryPointer.Append(entryF);

		}

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer, ETrue));

	indexTable = iFolderPointer[0]->GetIndexTableEntry();

	MY_ASSERT_TRUE(iFolderPointer[0]->IsComplete());

	TRAP_IGNORE(MY_ASSERT_TRUE(iFolderPointer[0]->GetChildrenL((TMsvId)5, NULL, getEntryPointer)));

	MY_ASSERT_EQUALS(64, getEntryPointer.Count());

	MY_ASSERT_EQUALS(64, addEntryPointer.Count());

	for (TInt index = 0; index < 64; ++index)

		{

		ASSERT_EQUALS((TMsvId)(index+10), getEntryPointer[index]->Entry().Id());

		ASSERT_EQUALS((TMsvId)(index+10), addEntryPointer[index]->Entry().Id());

		}

	MY_ASSERT_EQUALS(1, indexTable->Count());

	MY_ASSERT_EQUALS((TMsvId)0, (*indexTable)[0]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)73, (*indexTable)[0]->GetMaxMsvIdRange());

	MY_ASSERT_FALSE((*indexTable)[0]->IsGrandChildPresent());

	MY_ASSERT_EQUALS(64, (*indexTable)[0]->BlockPtr()->Count());

	getEntryPointer.Reset();

	addEntryPointer.Reset();

	ASSERT_TRUE(iFolderPointer[0]->ReleaseAllBlocks(releasedEntries));

	ASSERT_EQUALS(64, releasedEntries);

	entryF=NULL;

	delete iFolderPointer[0];

	TRAP_IGNORE(iFolderPointer[0] = CMsvCacheVisibleFolder::NewL((TMsvId)5));

	//05. Add 80(maximum size of block + 16) entries into the cache

	for (TInt index = 30; index < 110; ++index)

		{

		entryF = Entry();

		entryF->Entry().SetParent((TMsvId)5);

		entryF->Entry().SetId ((TMsvId)index);

		addEntryPointer.Append(entryF);

		}

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer, ETrue));

	indexTable = iFolderPointer[0]->GetIndexTableEntry();

	MY_ASSERT_TRUE(iFolderPointer[0]->IsComplete());

	TRAP_IGNORE(MY_ASSERT_TRUE(iFolderPointer[0]->GetChildrenL((TMsvId)5, NULL, getEntryPointer)));

	MY_ASSERT_EQUALS(80, getEntryPointer.Count());

	MY_ASSERT_EQUALS(80, addEntryPointer.Count());

	for (TInt index = 0; index < 80; ++index)

		{

		ASSERT_EQUALS((TMsvId)(index+30), getEntryPointer[index]->Entry().Id());

		ASSERT_EQUALS((TMsvId)(index+30), addEntryPointer[index]->Entry().Id());

		}

	MY_ASSERT_EQUALS(1, indexTable->Count());

	MY_ASSERT_EQUALS((TMsvId)0, (*indexTable)[0]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)109, (*indexTable)[0]->GetMaxMsvIdRange());

	MY_ASSERT_FALSE((*indexTable)[0]->IsGrandChildPresent());

	MY_ASSERT_EQUALS(80, (*indexTable)[0]->BlockPtr()->Count());

	getEntryPointer.Reset();

	addEntryPointer.Reset();

	ASSERT_TRUE(iFolderPointer[0]->ReleaseAllBlocks(releasedEntries));

	ASSERT_EQUALS(80, releasedEntries);

	entryF=NULL;

	delete iFolderPointer[0];

	TRAP_IGNORE(iFolderPointer[0] = CMsvCacheVisibleFolder::NewL((TMsvId)5));

	//5.1 Add 16 (BLOCK_THRESHOLD) entries to cache

	for (TInt index = 100; index < 116; ++index)

		{

		entryF = Entry();

		entryF->Entry().SetParent((TMsvId)5);

		entryF->Entry().SetId ((TMsvId)index);

		addEntryPointer.Append(entryF);

		}

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer, ETrue));

	indexTable = iFolderPointer[0]->GetIndexTableEntry();

	MY_ASSERT_TRUE(iFolderPointer[0]->IsComplete());

	TRAP_IGNORE(MY_ASSERT_TRUE(iFolderPointer[0]->GetChildrenL((TMsvId)5, NULL, getEntryPointer)));

	MY_ASSERT_EQUALS(16, getEntryPointer.Count());

	MY_ASSERT_EQUALS(16, addEntryPointer.Count());

	MY_ASSERT_EQUALS(1, indexTable->Count());

	MY_ASSERT_EQUALS((TMsvId)0, (*indexTable)[0]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)115, (*indexTable)[0]->GetMaxMsvIdRange());

	MY_ASSERT_EQUALS(16, (*indexTable)[0]->BlockPtr()->Count());

	getEntryPointer.Reset();

	addEntryPointer.Reset();

	MY_ASSERT_TRUE(iFolderPointer[0]->ReleaseAllBlocks(releasedEntries));

	MY_ASSERT_EQUALS(16, releasedEntries);

	entryF=NULL;

	delete iFolderPointer[0];

	TRAP_IGNORE(iFolderPointer[0] = CMsvCacheVisibleFolder::NewL((TMsvId)5));

	//06. Add 100(64 + 16 + 10 ) entries into the cache

	for (TInt index = 100; index < 300; index+=2)

		{

		entryF = Entry();

		entryF->Entry().SetParent((TMsvId)5);

		entryF->Entry().SetId ((TMsvId)index);

		addEntryPointer.Append(entryF);

		}

	TRAP_IGNORE(iFolderPointer[0]->AddEntryListL(addEntryPointer, ETrue));

	indexTable = iFolderPointer[0]->GetIndexTableEntry();

	MY_ASSERT_TRUE(iFolderPointer[0]->IsComplete());

	TRAP_IGNORE(MY_ASSERT_TRUE(iFolderPointer[0]->GetChildrenL((TMsvId)5, NULL, getEntryPointer)));

	MY_ASSERT_EQUALS(100, getEntryPointer.Count());

	MY_ASSERT_EQUALS(100, addEntryPointer.Count());

	MY_ASSERT_EQUALS(2, indexTable->Count());

	MY_ASSERT_EQUALS((TMsvId)0, (*indexTable)[0]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)198, (*indexTable)[0]->GetMaxMsvIdRange());

	MY_ASSERT_FALSE((*indexTable)[0]->IsGrandChildPresent());

	MY_ASSERT_EQUALS((TMsvId)199, (*indexTable)[1]->GetMinMsvIdRange());

	MY_ASSERT_EQUALS((TMsvId)298, (*indexTable)[1]->GetMaxMsvIdRange());

	MY_ASSERT_FALSE((*indexTable)[1]->IsGrandChildPresent());

	MY_ASSERT_EQUALS(50, (*indexTable)[0]->BlockPtr()->Count());

	MY_ASSERT_EQUALS(50, (*indexTable)[1]->BlockPtr()->Count());

	getEntryPointer.Reset();

	addEntryPointer.Reset();

	MY_ASSERT_TRUE(iFolderPointer[0]->ReleaseAllBlocks(releasedEntries));

	MY_ASSERT_EQUALS(100, releasedEntries);