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

//

/**

 @file The TEFUnit test suite for PhonebookOnControl in the Common TSY.

*/

#include "cctsyphonebookonfu.h"

#include <etel.h>

#include <et_clsvr.h>

#include <ctsy/mmtsy_names.h>

#include <ctsy/serviceapi/mmtsy_ipcdefs.h>

#include <test/tmockltsydata.h>

#include <ctsy/serviceapi/gsmerror.h>

#include <ctsy/ltsy/mltsydispatchphonebookoninterface.h>

#include "mockltsyindicatorids.h"

#include "listretrieverao.h"

CTestSuite* CCTsyPhonebookOnFU::CreateSuiteL(const TDesC& aName)

	{

	SUB_SUITE;

	//add use-case tests

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUseCase0001L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUseCase0002L);

	//add other unit tests

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0001L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0002L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0003L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0004L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0005L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0006L);

	ADD_TEST_STEP_ISO_CPP(CCTsyPhonebookOnFU, TestUnit0007L);

	END_SUITE;

	}

void CCTsyPhonebookOnFU::GenerateONList3L(CMobilePhoneONList* aONList)

/*

 * Create a list of 3 ON entries

 * @param aONList The list to be returned.

 * 

 */

	{

	RMobileONStore::TMobileONEntryV1 writeEntry;

	writeEntry.iMode = RMobilePhone::ENetworkModeGsm; 							

	writeEntry.iService = RMobilePhone::ETelephony;								

	writeEntry.iNumber.iTypeOfNumber = RMobilePhone::EAlphanumericNumber;		

	writeEntry.iNumber.iNumberPlan = RMobilePhone::EDataNumberPlan;				

	for (TInt i=0; i<3; i++)

		{

		writeEntry.iNumber.iTelNumber.Format(KText,i+1);								

		writeEntry.iText.Format(KNumber,i+1);												

		writeEntry.iIndex = i+1;														

		aONList->AddEntryL(writeEntry);

		}

	}

void CCTsyPhonebookOnFU::StoreAllL(RMobileONStore& aOnStore)

/*

 * Store all entries into the ON Storage.

 * 

 * @param aOnStore The ON storage where the entries will be stored.

 */

	{

	TRequestStatus reqStatus;

	RBuf8 completeData;

	CleanupClosePushL(completeData);

	TRequestStatus notifyStatus;

	TUint32 notifyEvent;

	TInt notifyIndex;

	RBuf8 expectEntryData;

	CleanupClosePushL(expectEntryData);	

    CMobilePhoneONList* onList = CMobilePhoneONList::NewL();

    CleanupStack::PushL(onList);

    GenerateONList3L(onList);

    TInt size = onList->Enumerate();

    TMockLtsyData1<TInt> sizeLTsyData(size);

    completeData.Close();

    sizeLTsyData.SerialiseL(completeData);

    iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreDeleteAll::KLtsyDispatchPhonebookOnStoreDeleteAllApiId);

    iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreDeleteAll::KLtsyDispatchPhonebookOnStoreDeleteAllApiId, KErrNone);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreGetStoreSize::KLtsyDispatchPhonebookOnStoreGetStoreSizeApiId);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreGetStoreSize::KLtsyDispatchPhonebookOnStoreGetStoreSizeApiId, KErrNone, completeData);	

    RMobileONStore::TMobileONEntryV1 writeEntry[3];

    for (TInt i=0; i<size; i++)

    	{

    	writeEntry[i]=onList->GetEntryL(i);

    	TMockLtsyData1<RMobileONStore::TMobileONEntryV1> entryLTsyData(writeEntry[i]);

    	expectEntryData.Close();

    	entryLTsyData.SerialiseL(expectEntryData);

    	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreWriteEntry::KLtsyDispatchPhonebookOnStoreWriteEntryApiId, expectEntryData);

    	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreWriteEntry::KLtsyDispatchPhonebookOnStoreWriteEntryApiId, KErrNone);

    	}

	aOnStore.NotifyStoreEvent(notifyStatus, notifyEvent, notifyIndex);

	aOnStore.StoreAllL(reqStatus, onList);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	User::WaitForRequest(notifyStatus);

	TUint32 tempEventStoreAll = RMobilePhoneStore::KStoreDoRefresh;

	ASSERT_EQUALS(notifyEvent, tempEventStoreAll); 

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(3, &completeData); //  onList, expectEntryData, completeData

	}

void CCTsyPhonebookOnFU::ReadAllL(RMobileONStore& aOnStore)

/*

 * Read all entries from the ON Storage.

 * 

 * @param aAsyncRetrieveList 

 * @param aActiveRetriever 

 */

	{

    TInt size = 3;

	RBuf8 completeData;

	CleanupClosePushL(completeData);

	RBuf8 expectReadData;

	CleanupClosePushL(expectReadData);	

	TMockLtsyData1<TInt> sizeReadAllLTsyData(size);

    completeData.Close();

    sizeReadAllLTsyData.SerialiseL(completeData);

    iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreGetReadStoreSize::KLtsyDispatchPhonebookOnStoreGetReadStoreSizeApiId);

    iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreGetReadStoreSize::KLtsyDispatchPhonebookOnStoreGetReadStoreSizeApiId, KErrNone, completeData);

    TInt location[3];

    TBuf<RMobileONStore::KOwnNumberTextSize> name[3];

    TBuf<KPBStoreNumSize> telNumber[3];

    for (TInt i=0; i<size; i++)

    	{

    	TInt index = i+1;

    	location[i] = index;	

    	name[i].Format(KText,index);	

    	telNumber[i].Format(KNumber,index);

    	TMockLtsyData1<TInt> locationLTsyData(location[i]);

    	expectReadData.Close();

    	locationLTsyData.SerialiseL(expectReadData);

        TMockLtsyData3< TInt, TBuf<RMobileONStore::KOwnNumberTextSize>, TBuf<KPBStoreNumSize> > readLTsyDataComplete(location[i], name[i], telNumber[i]);

        completeData.Close();

        readLTsyDataComplete.SerialiseL(completeData);

        iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreReadEntry::KLtsyDispatchPhonebookOnStoreReadEntryApiId, expectReadData);

        iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreReadEntry::KLtsyDispatchPhonebookOnStoreReadEntryApiId, KErrNone, completeData);

    	}

    CGetONListAO* getOnListAO = CGetONListAO::NewLC(aOnStore);

    getOnListAO->TestRetrieveL();

    ASSERT_EQUALS(KErrNone, getOnListAO->RetrieveLastError());

	CMobilePhoneONList* list = getOnListAO->RetrieveListL();

	for (TInt j=0; j< size; j++)

		{

		RMobileONStore::TMobileONEntryV1 readEntry=list->GetEntryL(j);

		ASSERT_EQUALS(location[j], readEntry.iIndex);

		ASSERT_EQUALS(name[j], readEntry.iText);

		ASSERT_EQUALS(telNumber[j], readEntry.iNumber.iTelNumber);

		}

	AssertMockLtsyStatusL();

	CActiveScheduler::Install(NULL);

	CleanupStack::PopAndDestroy(3, &completeData); // getOnListAO, expectReadData, completeData

	}

//

// Use-case tests

//

/**

@SYMTestCaseID BA-CTSYD-DIS-PHONEBOOKON-UC0001

@SYMComponent telephony_ctsy

@SYMTestCaseDesc Test support in CTSY for RMobileONStore::GetInfo(), RMobileONStore::Write(), RMobileONStore::Read(), RMobileONStore::Delete()

@SYMTestPriority High

@SYMTestActions Invokes RMobileONStore::GetInfo(), RMobileONStore::Write(), RMobileONStore::Read(), RMobileONStore::Delete()

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCTsyPhonebookOnFU::TestUseCase0001L()

	{

	OpenEtelServerL(EUseExtendedError);

	CleanupStack::PushL(TCleanupItem(Cleanup,this));

	OpenPhoneL();

    RMobilePhoneBookStore adnPhoneBookStore;

    CleanupClosePushL(adnPhoneBookStore);

    OpenCachingPhoneBookL(DispatcherPhonebook::EIccAdn,adnPhoneBookStore,KErrNone);

	RMobileONStore onStore;

	TInt ret = onStore.Open(iPhone);

	ASSERT_EQUALS(ret, KErrNone);

	CleanupClosePushL(onStore);

	RBuf8 expectData;

	CleanupClosePushL(expectData);	

	RBuf8 completeData;

	CleanupClosePushL(completeData);	

	TRequestStatus reqStatus;

	TRequestStatus notifyStatus;

	TUint32 notifyEvent;

	TInt notifyIndex;

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

	// TEST A: getinfo	

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

	RMobileONStore::TMobileONStoreInfoV1 onStoreInfoV1;

	TPckg<RMobileONStore::TMobileONStoreInfoV1> pckgInfoV1(onStoreInfoV1);

	TInt numOfEntries = 0;

	TInt usedEntries = 0;

	TInt maxNameLen = 25;

	TInt maxNumLen = 20;

	TMockLtsyData4<TInt, TInt, TInt, TInt> onStoreInfoReturn(numOfEntries, usedEntries, maxNameLen, maxNumLen);

	completeData.Close();

	onStoreInfoReturn.SerialiseL(completeData);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreGetInfo::KLtsyDispatchPhonebookOnStoreGetInfoApiId);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreGetInfo::KLtsyDispatchPhonebookOnStoreGetInfoApiId, KErrNone, completeData);

	onStore.GetInfo(reqStatus, pckgInfoV1);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	ASSERT_EQUALS(onStoreInfoV1.iTotalEntries, numOfEntries);

	ASSERT_EQUALS(onStoreInfoV1.iUsedEntries, usedEntries);

	ASSERT_EQUALS(onStoreInfoV1.iTextLen, maxNameLen);

	ASSERT_EQUALS(onStoreInfoV1.iNumberLen, maxNumLen);

	AssertMockLtsyStatusL();

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

	// TEST B: write	

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

	TInt location = 1;

	RMobileONStore::TMobileONEntryV1 writeEntry1;

    writeEntry1.iMode = RMobilePhone::ENetworkModeGsm;

    writeEntry1.iService = RMobilePhone::ETelephony;

    writeEntry1.iNumber.iTypeOfNumber = RMobilePhone::EAlphanumericNumber;

    writeEntry1.iNumber.iNumberPlan = RMobilePhone::EDataNumberPlan;

    writeEntry1.iNumber.iTelNumber.Copy(KNumber1);

    writeEntry1.iText.Copy(KText1);

    writeEntry1.iIndex = location;

    TPckg<RMobileONStore::TMobileONEntryV1> pckgWriteEntry1(writeEntry1);

    TMockLtsyData1<RMobileONStore::TMobileONEntryV1> writeLTsyData1(writeEntry1);

    expectData.Close();

    writeLTsyData1.SerialiseL(expectData);

    TMockLtsyData1<TInt> writeLTsyDataComplete(location);

    completeData.Close();

    writeLTsyDataComplete.SerialiseL(completeData);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreWrite::KLtsyDispatchPhonebookOnStoreWriteApiId, expectData);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreWrite::KLtsyDispatchPhonebookOnStoreWriteApiId, KErrNone, completeData);

	onStore.NotifyStoreEvent(notifyStatus, notifyEvent, notifyIndex);	

	onStore.Write(reqStatus, pckgWriteEntry1);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	ASSERT_EQUALS(writeEntry1.iIndex, location);

	User::WaitForRequest(notifyStatus);

	TUint32 tempEventEntryAdded = RMobilePhoneStore::KStoreEntryAdded;

	ASSERT_EQUALS(notifyEvent, tempEventEntryAdded);

	ASSERT_EQUALS(notifyIndex, location);

	AssertMockLtsyStatusL();

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

	// TEST C: read	

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

	RMobileONStore::TMobileONEntryV1 readEntry;

	readEntry.iIndex = location;

	TPckg<RMobileONStore::TMobileONEntryV1> pckgReadEntry(readEntry);

	TBuf<RMobileONStore::KOwnNumberTextSize> name;

	name.Copy(KText1);

	TBuf<KPBStoreNumSize> telNumber;

	telNumber.Copy(KNumber1);

    TMockLtsyData1<TInt> readLTsyData(location);

    expectData.Close();

    readLTsyData.SerialiseL(expectData);

    TMockLtsyData3< TInt, TBuf<RMobileONStore::KOwnNumberTextSize>, TBuf<KPBStoreNumSize> > readLTsyDataComplete(location, name, telNumber);

    completeData.Close();

    readLTsyDataComplete.SerialiseL(completeData);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreRead::KLtsyDispatchPhonebookOnStoreReadApiId, expectData);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreRead::KLtsyDispatchPhonebookOnStoreReadApiId, KErrNone, completeData);

	onStore.Read(reqStatus, pckgReadEntry);	

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	ASSERT_EQUALS(location, readEntry.iIndex);

	ASSERT_EQUALS(name, readEntry.iText);

	ASSERT_EQUALS(telNumber, readEntry.iNumber.iTelNumber);

	AssertMockLtsyStatusL();

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

	// TEST D: delete	

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

    TMockLtsyData1<TInt> deleteLTsyData(location);

    expectData.Close();

    deleteLTsyData.SerialiseL(expectData);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreDeleteEntry::KLtsyDispatchPhonebookOnStoreDeleteEntryApiId, expectData);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreDeleteEntry::KLtsyDispatchPhonebookOnStoreDeleteEntryApiId, KErrNone);

	onStore.NotifyStoreEvent(notifyStatus, notifyEvent, notifyIndex);	

	onStore.Delete(reqStatus, location);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	User::WaitForRequest(notifyStatus);

	TUint32 tempEventEntryDeleted = RMobilePhoneStore::KStoreEntryDeleted;

	ASSERT_EQUALS(notifyEvent, tempEventEntryDeleted); 

	ASSERT_EQUALS(notifyIndex, location);

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(5, this); // completeData, expectData, onStore, adnPhoneBookStore, this

	}

/**

@SYMTestCaseID BA-CTSYD-DIS-PHONEBOOKON-UC0002

@SYMComponent telephony_ctsy

@SYMTestCaseDesc Test support in CTSY for RMobileONStore::GetInfo(), RMobileONStore::StoreAll, CRetrieveMobilePhoneONList::Start(), RMobileONStore::DeleteAll()

@SYMTestPriority High

@SYMTestActions Invokes RMobileONStore::GetInfo(), RMobileONStore::StoreAll, CRetrieveMobilePhoneONList::Start(), RMobileONStore::DeleteAll()

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCTsyPhonebookOnFU::TestUseCase0002L()

	{

	OpenEtelServerL(EUseExtendedError);

	CleanupStack::PushL(TCleanupItem(Cleanup,this));

	OpenPhoneL();

    RMobilePhoneBookStore adnPhoneBookStore;

    CleanupClosePushL(adnPhoneBookStore);

    OpenCachingPhoneBookL(DispatcherPhonebook::EIccAdn,adnPhoneBookStore,KErrNone);

	RMobileONStore onStore;

	TInt ret = onStore.Open(iPhone);

	ASSERT_EQUALS(ret, KErrNone);

	CleanupClosePushL(onStore);

	RBuf8 completeData;

	CleanupClosePushL(completeData);	

	TRequestStatus reqStatus;

	TRequestStatus notifyStatus;

	TUint32 notifyEvent;

	TInt notifyIndex;

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

	// TEST A: getinfo	

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

	RMobileONStore::TMobileONStoreInfoV1 onStoreInfoV1;

	TPckg<RMobileONStore::TMobileONStoreInfoV1> pckgInfoV1(onStoreInfoV1);

	TInt numOfEntries = 3;

	TInt usedEntries = 3;

	TInt nameLen = 25;

	TInt numLen = 20;

	TMockLtsyData4<TInt, TInt, TInt, TInt> onStoreInfoReturn(numOfEntries, usedEntries, nameLen, numLen);

	completeData.Close();

	onStoreInfoReturn.SerialiseL(completeData);

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreGetInfo::KLtsyDispatchPhonebookOnStoreGetInfoApiId);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreGetInfo::KLtsyDispatchPhonebookOnStoreGetInfoApiId, KErrNone, completeData);

	onStore.GetInfo(reqStatus, pckgInfoV1);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	ASSERT_EQUALS(onStoreInfoV1.iTotalEntries, numOfEntries);

	ASSERT_EQUALS(onStoreInfoV1.iUsedEntries, usedEntries);

	ASSERT_EQUALS(onStoreInfoV1.iTextLen, nameLen);

	ASSERT_EQUALS(onStoreInfoV1.iNumberLen, numLen);

	AssertMockLtsyStatusL();

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

	// TEST B: storeall	

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

	StoreAllL(onStore);

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

	// TEST C: readall	

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

	ReadAllL(onStore);

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

	// TEST D: deleteall	

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

	iMockLTSY.ExpectL(MLtsyDispatchPhonebookOnStoreDeleteAll::KLtsyDispatchPhonebookOnStoreDeleteAllApiId);

	iMockLTSY.CompleteL(MLtsyDispatchPhonebookOnStoreDeleteAll::KLtsyDispatchPhonebookOnStoreDeleteAllApiId, KErrNone);

	onStore.NotifyStoreEvent(notifyStatus, notifyEvent, notifyIndex);

	onStore.DeleteAll(reqStatus);

	User::WaitForRequest(reqStatus);

	ASSERT_EQUALS(reqStatus.Int(), KErrNone);

	User::WaitForRequest(notifyStatus);

	TUint32 tempEventDeleteAll = RMobilePhoneStore::KStoreEmpty;

	ASSERT_EQUALS(notifyEvent, tempEventDeleteAll); 

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(4, this); // completeData, onStore, adnPhoneBookStore, this

	}

//

// Other unit tests

//

/**

@SYMTestCaseID BA-CTSYD-DIS-PHONEBOOKON-UN0001

@SYMComponent telephony_ctsy

@SYMTestCaseDesc Test support in CTSY for RMobileONStore::GetInfo()

@SYMTestPriority High

@SYMTestActions Invokes RMobileONStore::GetInfo()

@SYMTestExpectedResults Pass

@SYMTestType UT

*/