// 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 SetUpMenu in the SAT.

*/

#include <cstktsy/bertlv_defs.h>

#include <etel.h>

#include <etelmm.h>

#include <satcs.h>

#include <ctsy/ltsy/mltsydispatchsatinterface.h>

#include <test/mockltsyindicatorids.h>

#include <test/tmockltsydata.h>

#include "ccsatsetupmenufu.h"

static const TInt KDelay = 10;

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

	{

	SUB_SUITE;

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001L);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001bL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001cL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001dL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001eL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001fL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001gL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001hL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001iL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0001jL);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0002L);

	ADD_TEST_STEP_ISO_CPP(CCSatSetUpMenuFU, TestNotifySetUpMenuPCmd0004L);

	END_SUITE;

	}

//

// Actual test cases

//

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001L()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	RBuf8 data;

	CleanupClosePushL(data);

	TUint8 KPCmdNumber = 1;

	// prepare tlv buffer for serialisation

	TTlv tlv;

	tlv.Begin(KBerTlvProactiveSimCommandTag);

	tlv.AddTag(KTlvCommandDetailsTag);

	tlv.AddByte(KPCmdNumber);//ETLV_CommandNumber

	tlv.AddByte(KSetUpMenu); //ETLV_TypeOfCommand

	tlv.AddByte(0); //ETLV_CommandQualifier

	tlv.AddTag(KTlvDeviceIdentityTag); 

	tlv.AddByte(KSim); //ETLV_SourceDeviceIdentity

	tlv.AddByte(KDisplay); //ETLV_DestinationDeviceIdentity

	tlv.AddTag(KTlvAlphaIdentifierTag);

	_LIT8(KSetupMenuTest8,"Menu AlphaIdent");

	tlv.AddData(KSetupMenuTest8);//ETLV_AlphaIdentifier

	tlv.AddTag(KTlvItemTag);

	tlv.AddByte(77); //item identifier

	tlv.AddData(_L8("Item AlphaIdent1"));

	TPtrC8 tlvDsc = tlv.End();

	TDesC8* tlvDscPtr = &tlvDsc;

	TMockLtsyData1<TDesC8*> tlvDscPack(tlvDscPtr);

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

	// TEST B: failure on completion of pending request from LTSY->CTSY

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

	// tell Mock about forthcoming RSat::NotifySetUpMenuPCmd

	TUint8 pcmdCode = KSetUpMenu;

	TMockLtsyData1<TUint8> expLtsyData(pcmdCode);

	expLtsyData.SerialiseL(data);

	iMockLTSY.ExpectL(MLtsyDispatchSatPCmdNotification::KLtsyDispatchSatPCmdNotificationApiId,data);

	data.Close();

	RSat::TSetUpMenuV2 setupMenu;

	RSat::TSetUpMenuV2Pckg setpPck(setupMenu);

	TRequestStatus stat;

	iSat.NotifySetUpMenuPCmd(stat, setpPck);

	tlvDscPack.SerialiseL(data);

	iMockLTSY.CompleteL(KMockLtsyDispatchSatPcmdIndId, KErrGeneral, data, KDelay);

	User::WaitForRequest(stat);

	ASSERT_EQUALS(KErrGeneral, stat.Int());	

	AssertMockLtsyStatusL();

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

	// TEST E: Unsolicited completion of RSat::NotifySetUpMenuPCmd from LTSY.

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

	TRequestStatus mockLtsyStatus;

	iMockLTSY.NotifyTerminated(mockLtsyStatus);	    

	tlvDscPack.SerialiseL(data);

	iMockLTSY.CompleteL(KMockLtsyDispatchSatPcmdIndId, KErrNone, data, KDelay);

	data.Close();

	RSat::TAdditionalInfo addInfo;

	addInfo.Zero();

	addInfo.Append(RSat::KNoSpecificMeProblem);

	PrepareTerminalResponseMockDataL( KPCmdNumber, KSetUpMenu, 0,

			addInfo, RSat::KMeUnableToProcessCmd, KNullDesC8);	

	User::WaitForRequest(mockLtsyStatus);

	AssertMockLtsyStatusL();

	ASSERT_EQUALS(KErrNone, mockLtsyStatus.Int());

	// test C - Successful completion request of

	// RSat::NotifySetFramesPCmd() - implemented in 0001b()-0001i() functions

	CleanupStack::PopAndDestroy(2, this); // data, this

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001b

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd - SET UP MENU (help request support) and ENVELOPE MENU SELECTION

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001bL()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	// Expected Sequence 2.1 

	//(SET UP MENU and MENU SELECTION, with Help Request, Replace and Remove a Toolkit Menu)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.2.4.2, Expected Sequence 2.1.

	TUint8 cmdNumber = 1;

	const TInt KNumItems = 4;	

	TUint8 ids[KNumItems] = {1, 2, 3, 4};

	TPtrC8 idNames[KNumItems] = {_L8("Item 1"), _L8("Item 2"), _L8("Item 3"), _L8("Item 4")};

	SetUpMenuL( cmdNumber, KHelpAvailabilityMask, _L8("Toolkit Menu"), KNumItems, ids, idNames );

	//generate the terminal response

	RSat::TSetUpMenuRspV1 resp;

	RSat::TSetUpMenuRspV1Pckg respPck(resp);

	resp.iGeneralResult = RSat::KSuccess;

	resp.iInfoType = RSat::KNoAdditionalInfo;

	resp.iAdditionalInfo.Zero();

	resp.SetPCmdNumber(cmdNumber);

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, KHelpAvailabilityMask, RSat::ESetUpMenu,

			 respPck, resp.iAdditionalInfo, resp.iGeneralResult);	

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(1, this);

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001c

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd - SET UP MENU (next action support) and ENVELOPE MENU SELECTION

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001cL()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	// Expected Sequence 3.1 

	//(SET UP MENU, next action indicator "Send SM", "Set Up Call", "LaunchBrowser", 

	//"Provide Local Information", successful)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.3.4.2, Expected Sequence 3.1.

	TUint8 cmdNumber = 1;

	TUint8 noPref(0);	// no selection preferences

	const TInt KNumItems = 4;	

	TUint8 ids[KNumItems] = {1, 2, 3, 4};

	TPtrC8 idNames[KNumItems] = {_L8("Item 1"), _L8("Item 2"), _L8("Item 3"), _L8("Item 4")};

	TUint8 actions[KNumItems] = {KSendShortMessage, KSetUpCall, KLaunchBrowser, KProvideLocalInformation};

	SetUpMenuL( cmdNumber, noPref, _L8("Toolkit Menu"), KNumItems, ids, idNames, actions );

	//generate the terminal response

	RSat::TSetUpMenuRspV1 resp;

	RSat::TSetUpMenuRspV1Pckg respPck(resp);

	resp.iGeneralResult = RSat::KSuccess;

	resp.iInfoType = RSat::KNoAdditionalInfo;

	resp.iAdditionalInfo.Zero();

	resp.SetPCmdNumber(cmdNumber);

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, noPref, RSat::ESetUpMenu, 

			respPck, resp.iAdditionalInfo, resp.iGeneralResult);

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(1, this); 

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001d

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd - SET UP MENU (display of icons) and ENVELOPE MENU SELECTION

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001dL()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	// Expected Sequence 4.1A 

	//(SET UP MENU, BASIC ICON NOT SELF EXPLANATORY in ALPHA ID and ITEMS DATA OBJECTS, successful)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.4.4.2, Expected Sequence 4.1A.

	TUint8 cmdNumber = 1;

	TUint8 noPref(0);	// no preferences

	const TInt KNumItems = 3;	

	TUint8 ids[KNumItems] = {1, 2, 3};

	TPtrC8 idNames[KNumItems] = {_L8("Item 1"), _L8("Item 2"), _L8("Item 3")};

	TUint8 iconList[KNumItems] = {5, 5, 5};

	SetUpMenuL( cmdNumber, noPref, _L8("Toolkit Menu"), KNumItems, ids, idNames, NULL,

		RSat::ENotSelfExplanatory, 1, RSat::ENotSelfExplanatory, iconList );

	//generate the terminal response

	RSat::TSetUpMenuRspV1 resp;

	RSat::TSetUpMenuRspV1Pckg respPck(resp);

	resp.iGeneralResult = RSat::KSuccess;

	resp.iInfoType = RSat::KNoAdditionalInfo;

	resp.iAdditionalInfo.Zero();

	resp.SetPCmdNumber(cmdNumber);

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, noPref, RSat::ESetUpMenu, 

			respPck, resp.iAdditionalInfo, resp.iGeneralResult);

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	//Expected Sequence 4.1B 

	//(SET UP MENU, BASIC ICON NOT SELF EXPLANATORY in ALPHA ID and ITEMS DATA OBJECTS, 

	//requested icon could not be displayed)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.4.4.2, Expected Sequence 4.1B.

	SetUpMenuL( cmdNumber, noPref, _L8("Toolkit Menu"), KNumItems, ids, idNames, NULL,

		RSat::ENotSelfExplanatory, 1, RSat::ENotSelfExplanatory, iconList );

	//generate the terminal response

	resp.iGeneralResult = RSat::KSuccessRequestedIconNotDisplayed;

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, noPref, RSat::ESetUpMenu, 

			respPck, resp.iAdditionalInfo, resp.iGeneralResult);

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	//Expected Sequence 4.2A (SET UP MENU, BASIC ICON SELF EXPLANATORY in ALPHA ID and ITEMS

	//DATA OBJECTS, successful)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.4.4.2, Expected Sequence 4.2A.

	SetUpMenuL( cmdNumber, noPref, _L8("Toolkit Menu"), KNumItems, ids, idNames, NULL,

		RSat::ESelfExplanatory, 1, RSat::ESelfExplanatory, iconList );

	//generate the terminal response

	resp.iGeneralResult = RSat::KSuccess;

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, noPref, RSat::ESetUpMenu, respPck,

			 resp.iAdditionalInfo, resp.iGeneralResult);

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	//Expected Sequence 4.2B (SET UP MENU, BASIC ICON SELF EXPLANATORY in ALPHA ID and ITEMS

	//DATA OBJECTS, requested icon could not be displayed)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.4.4.2, Expected Sequence 4.2B.

	SetUpMenuL( cmdNumber, noPref, _L8("Toolkit Menu"), KNumItems, ids, idNames, NULL,

		RSat::ESelfExplanatory, 1, RSat::ESelfExplanatory, iconList );

	//generate the terminal response

	resp.iGeneralResult = RSat::KSuccessRequestedIconNotDisplayed;

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, noPref, RSat::ESetUpMenu, 

			respPck, resp.iAdditionalInfo, resp.iGeneralResult);

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	SelectMenuItemL(ids[1], ETrue);

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(1, this);

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001e

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd - SET UP MENU (soft keys support) and ENVELOPE MENU SELECTION

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001eL()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	// Expected Sequence 5.1 (SET UP MENU, SOFT KEY PREFERRED, successful)

	//See ETSI TS 102 384 [26] in subclause 27.22.4.8.5.4.2, Expected Sequence 5.1.

	TUint8 cmdNumber = 1;

	const TInt KNumItems = 2;	

	TUint8 ids[KNumItems] = {1, 2};

	TPtrC8 idNames[KNumItems] = {_L8("Item 1"), _L8("Item 2")};

	SetUpMenuL( cmdNumber, KSelectionUsingSoftKey, _L8("Toolkit Menu"), KNumItems, ids, idNames );

	//generate the terminal response

	RSat::TSetUpMenuRspV1 resp;

	RSat::TSetUpMenuRspV1Pckg respPck(resp);

	resp.iGeneralResult = RSat::KSuccess;

	resp.iInfoType = RSat::KNoAdditionalInfo;

	resp.iAdditionalInfo.Zero();

	resp.SetPCmdNumber(cmdNumber);

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, KSelectionUsingSoftKey, RSat::ESetUpMenu,

			 respPck, resp.iAdditionalInfo, resp.iGeneralResult);	

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	// select second item	

	SelectMenuItemL(ids[1]);   

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(1, this);

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001f

@SYMPREQ 1780

@SYMComponent  telephony_csat

@SYMTestCaseDesc Test support in CSAT for RSat::NotifySetUpMenuPCmd - SET UP MENU (help request support) and ENVELOPE MENU SELECTION

@SYMTestPriority High

@SYMTestActions Invokes RSat::NotifySetUpMenuPCmd

@SYMTestExpectedResults Pass

@SYMTestType CT

*/

void CCSatSetUpMenuFU::TestNotifySetUpMenuPCmd0001fL()

	{

	OpenEtelServerL(EUseExtendedError);

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

	OpenPhoneL();

	OpenSatL();

	// Check SATTSY for handling error value

	TUint8 cmdNumber = 1;

	const TInt KNumItems = 4;	

	TUint8 ids[KNumItems] = {1, 2, 3, 4};

	TPtrC8 idNames[KNumItems] = {_L8("Item 1"), _L8("Item 2"), _L8("Item 3"), _L8("Item 4")};

	SetUpMenuL( cmdNumber, KHelpAvailabilityMask, _L8("Toolkit Menu"), KNumItems, ids, idNames );

	//generate the terminal response

	RSat::TSetUpMenuRspV1 resp;

	RSat::TSetUpMenuRspV1Pckg respPck(resp);

	resp.iGeneralResult = RSat::KSuccess;

	resp.iInfoType = RSat::KNoAdditionalInfo;

	resp.iAdditionalInfo.Zero();

	resp.SetPCmdNumber(cmdNumber);

	GenerateTerminalResponseL(cmdNumber, KSetUpMenu, KHelpAvailabilityMask, RSat::ESetUpMenu,

			 respPck, resp.iAdditionalInfo, resp.iGeneralResult);	

	AssertMockLtsyStatusL();

	// now end session		

	EndProactiveSimSessionL();

	AssertMockLtsyStatusL();

	// select 2

	// now tell Mock to return KErrUnknown when dispatching forthcoming RSat::MenuSelection()

	SelectMenuItemL(ids[1], ETrue, KErrUnknown);

	AssertMockLtsyStatusL();

	CleanupStack::PopAndDestroy(1, this);

	}

/**

@SYMTestCaseID BA-CSAT-SUM-SNSUMPC-0001g