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

// Test step definitions for the DTMF functional unit.

// 

//

/**

 @internalTechnology

*/

#include "cctsyintegrationtestdtmf.h"

#include "cctsyinidata.h"

CCTSYIntegrationTestDTMFBase::CCTSYIntegrationTestDTMFBase(CEtelSessionMgr& aEtelSessionMgr)

	: CCTSYIntegrationTestSuiteStepBase(aEtelSessionMgr), iCallControlTestHelper(*this), iNetworkTestHelper(*this)

/**

 * Constructor

 */

	{

	}

CCTSYIntegrationTestDTMFBase::~CCTSYIntegrationTestDTMFBase()

/*

 * Destructor

 */

	{

	}

CCTSYIntegrationTestDTMF0001::CCTSYIntegrationTestDTMF0001(CEtelSessionMgr& aEtelSessionMgr)

	: CCTSYIntegrationTestDTMFBase(aEtelSessionMgr)

/**

 * Constructor.

 */

	{

	SetTestStepName(CCTSYIntegrationTestDTMF0001::GetTestStepName());

	}

CCTSYIntegrationTestDTMF0001::~CCTSYIntegrationTestDTMF0001()

/**

 * Destructor.

 */

	{

	}

TVerdict CCTSYIntegrationTestDTMF0001::doTestStepL()

/**

 * @SYMTestCaseID BA-CTSY-INT-DTMF-0001

 * @SYMFssID BA/CTSY/DTMF-0001

 * @SYMTestCaseDesc Get DTMF caps.

 * @SYMTestPriority High

 * @SYMTestActions RCall::Dial, RCall::HangUp, RMobilePhone::NotifyDTMFCapsChange, RMobilePhone::SetAlternatingCallMode

 * @SYMTestExpectedResults Pass - DTMF caps set when call is active. DTMF caps are 0 when call is not active.

 * @SYMTestType CIT

 * @SYMTestCaseDependencies live/automatic

 *

 * Reason for test: Verify dynamic  DTMF caps set correctly.

 *

 * @return - TVerdict code

 */

	{

	//

	// SET UP

	//

	RMobilePhone& mobilePhone = iEtelSessionMgr.GetPhoneL(KMainServer, KMainPhone);

	// Get voice line 1. 	

	RMobileLine& mobileLine= iEtelSessionMgr.GetLineL(KMainServer, KMainPhone, KVoiceLine);

	// Get call 1. 			

	RMobileCall& mobileCall= iEtelSessionMgr.GetCallL(KMainServer,KMainPhone, KVoiceLine, KCall1);

	// Call TNetworkTsyTestHelper::WaitForRegisteredOnHomeNetworkL		

	CHECK_EQUALS_L(iNetworkTestHelper.WaitForRegisteredOnHomeNetworkL(mobilePhone), KErrNone, _L("TNetworkTsyTestHelper::WaitForRegisteredOnHomeNetworkL returned with an error"));

	//

	// SET UP END

	//

	StartTest();

	//

	// TEST START

	//

	// Post notification RMobilePhone::NotifyDTMFCapsChange

	TUint32 caps = 0;

	TExtEtelRequestStatus notifyDTMFCapsChangeStatus(mobilePhone, EMobilePhoneNotifyDTMFCapsChange);	

	CleanupStack::PushL(notifyDTMFCapsChangeStatus);

	mobilePhone.NotifyDTMFCapsChange(notifyDTMFCapsChangeStatus,caps);

	// Dial a Phone Number

	TPtrC number; 

	ASSERT_TRUE(GetStringFromConfig(KIniVoiceNumSection, KIniVoiceNumber1, number) != EFalse, _L("GetStringFromConfig did not complete as expected"));

	DEBUG_PRINTF1(_L("Board Now Dialling: "));

	TCoreEtelRequestStatus<RCall> dialStatus(mobileCall, &RCall::DialCancel);

	CleanupStack::PushL(dialStatus);

	mobileCall.Dial(dialStatus, number); 

	ASSERT_EQUALS(WaitForRequestWithTimeOut(dialStatus, ETimeMedium), KErrNone, _L("RCall::Dial timed-out"));

	ASSERT_EQUALS(dialStatus.Int(), KErrNone, _L("RCall::Dial returned with an error"));

	// Check RMobilePhone::NotifyDTMFCapsChange completes with caps of KCapsSendDTMFString | KCapsSendDTMFSingleTone

	TUint32 wantedCaps = RMobilePhone::KCapsSendDTMFString | RMobilePhone::KCapsSendDTMFSingleTone;

	iCallControlTestHelper.WaitForMobilePhoneNotifyDTMFCapsChange(mobilePhone,

																  notifyDTMFCapsChangeStatus,

																  caps, 

																  wantedCaps,

																  KNoUnwantedBits,

																  KErrNone);

	// Check RMobilePhone::GetDTMFCaps returns caps of KCapsSendDTMFString | KCapsSendDTMFSingleTone

	ASSERT_EQUALS(mobilePhone.GetDTMFCaps(caps), KErrNone,_L("RMobilePhone::GetDTMFCaps returned with an error"))

	ASSERT_BITS_SET(caps, wantedCaps, KNoUnwantedBits, _L("RMobilePhone::GetDTMFCaps returned wrong dynamic caps"))

	// Post notifer

	mobilePhone.NotifyDTMFCapsChange(notifyDTMFCapsChangeStatus,caps);	

	// Hang up call.

	ASSERT_EQUALS(mobileCall.HangUp(), KErrNone,_L("RMobileCall::HangUp returned with an error"))

	// Check RMobilePhone::NotifyDTMFCapsChange completes with caps of 0

	wantedCaps=0;

	iCallControlTestHelper.WaitForMobilePhoneNotifyDTMFCapsChange(mobilePhone,

																  notifyDTMFCapsChangeStatus,

																  caps, 

																  wantedCaps,

																  KNoUnwantedBits,

																  KErrNone);

	// Check RMobilePhone::GetDTMFCaps returns caps of 0

	wantedCaps = 0;

	ASSERT_EQUALS(mobilePhone.GetDTMFCaps(caps), KErrNone,_L("RMobilePhone::GetDTMFCaps returned with an error"))

	ASSERT_BITS_SET(caps, wantedCaps, KNoUnwantedBits, _L("RMobilePhone::GetDTMFCaps returned wrong dynamic caps"))

	//

	// TEST END

	//

     StartCleanup();

    // Pop

    // notifyDTMFCapsChangeStatus

    // dialStatus

    CleanupStack::PopAndDestroy(2,&notifyDTMFCapsChangeStatus);

	return TestStepResult();

	}

TPtrC CCTSYIntegrationTestDTMF0001::GetTestStepName()

/**

 * @return The test step name.

 */

	{

	return _L("CCTSYIntegrationTestDTMF0001");

	}

CCTSYIntegrationTestDTMF0002::CCTSYIntegrationTestDTMF0002(CEtelSessionMgr& aEtelSessionMgr)

	: CCTSYIntegrationTestDTMFBase(aEtelSessionMgr)

/**

 * Constructor.

 */

	{

	SetTestStepName(CCTSYIntegrationTestDTMF0002::GetTestStepName());

	}

CCTSYIntegrationTestDTMF0002::~CCTSYIntegrationTestDTMF0002()

/**

 * Destructor.

 */

	{

	}

TVerdict CCTSYIntegrationTestDTMF0002::doTestStepL()

/**

 * @SYMTestCaseID BA-CTSY-INT-DTMF-0002

 * @SYMFssID BA/CTSY/DTMF-0002

 * @SYMTestCaseDesc Send valid DTMF digits and strings.

 * @SYMTestPriority High

 * @SYMTestActions RMobilePhone::StopDTMFTone, RMobilePhone::SendDTMFTones, RMobilePhone::ContinueDTMFStringSending

 * @SYMTestExpectedResults Pass - DTMF tones can be sent individually and as a string.

 * @SYMTestType CIT

 * @SYMTestCaseDependencies live/automatic

 *

 * Reason for test: Verify single tones and strings can be sent.

 *

 * @return - TVerdict code

 */

	{

	//

	// SET UP

	//

	RMobilePhone& mobilePhone = iEtelSessionMgr.GetPhoneL(KMainServer, KMainPhone);	

	// Get Voice Line 1.

	RMobileLine& mobileLine= iEtelSessionMgr.GetLineL(KMainServer, KMainPhone, KVoiceLine);

	// Get Call 1.

	RMobileCall& mobileCall= iEtelSessionMgr.GetCallL(KMainServer, KMainPhone, KVoiceLine, KCall1);

	// Call TNetworkTsyTestHelper::WaitForRegisteredOnHomeNetworkL		

	CHECK_EQUALS_L(iNetworkTestHelper.WaitForRegisteredOnHomeNetworkL(mobilePhone), KErrNone, _L("TNetworkTsyTestHelper::WaitForRegisteredOnHomeNetworkL returned with an error"));

	// Dial a number that answers. 

	TPtrC number; 

	CHECK_TRUE_L(GetStringFromConfig(KIniVoiceNumSection, KIniVoiceNumber1, number) != EFalse, _L("GetStringFromConfig did not complete as expected"));

	DEBUG_PRINTF2(_L("Board Now Dialling: %S"), &number);

	TCoreEtelRequestStatus<RCall> dialStatus(mobileCall, &RCall::DialCancel);

	CleanupStack::PushL(dialStatus);

	mobileCall.Dial(dialStatus, number); 

	CHECK_EQUALS_L(WaitForRequestWithTimeOut(dialStatus, ETimeMedium), KErrNone, _L("RCall::Dial timed-out"));

	CHECK_EQUALS_L(dialStatus.Int(), KErrNone, _L("RCall::Dial problem dialling"));

	// Check RMobilePhone::GetDTMFCaps returns caps of KCapsSendDTMFString | KCapsSendDTMFSingleTone

	TUint32 dtmfCaps=0;

	CHECK_TRUE_L(mobilePhone.GetDTMFCaps(dtmfCaps)==KErrNone, _L("RMobilePhone::GetDTMFCaps return value not KErrNone"));

	TUint32 expectedCaps = RMobilePhone::KCapsSendDTMFString | RMobilePhone::KCapsSendDTMFSingleTone;

	CHECK_BITS_SET_L(dtmfCaps, expectedCaps, KNoUnwantedBits, _L("RMobilePhone::GetDTMFCaps returned wrong dynamic caps"));

	//

	// SET UP END

	//

	StartTest();

	//

	// TEST START

	//

	// ===  Send DTMF tones individually. Do the following with aTone = 0-9, A,B,C,D, #,*, p, w in turn. ===	

	TChar tone[18] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9','A' ,'B' ,'C' ,'D' ,'#' ,'*', 'p', 'w'};

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

		{

		DEBUG_PRINTF2(_L("Send DTMF tones: %c"), (char)tone[i]);

		// Use RMobilePhone::StartDTMFTone to start sending a DTMF tone.

		ASSERT_EQUALS(mobilePhone.StartDTMFTone(tone[i]), KErrNone, _L("RMobilePhone::StartDTMFTone completed with incorrect error"));

		// Wait for one second

		User::After(KOneSecond);

		// Use RMobilePhone::StopDTMFTone to stop sending.

		ASSERT_EQUALS(mobilePhone.StopDTMFTone(), KErrNone, _L("RMobilePhone::StopDTMFTone completed with incorrect error"));

		// Repeat the above with other valid digits.

		}

	// Wait for 5 seconds

	User::After(5*KOneSecond);

	// ===  Send DTMF string with no 'w' character ===

	// Send DTMF tones

	TExtEtelRequestStatus sendDtmfTonesStatus(mobilePhone, EMobilePhoneSendDTMFTones);

	CleanupStack::PushL(sendDtmfTonesStatus);

	TBufC<50> toneSet1 = _L("0123456p789ABCD");

	DEBUG_PRINTF2(_L("Send DTMF tones: %S"), &toneSet1);	

	mobilePhone.SendDTMFTones(sendDtmfTonesStatus, toneSet1);	

	ASSERT_EQUALS(WaitForRequestWithTimeOut(sendDtmfTonesStatus, ETimeMedium), KErrNone, _L("RMobilePhone::SendDTMFTones timed-out"));

    //Check request completes with KErrNone each time.

    ASSERT_EQUALS(sendDtmfTonesStatus.Int(), KErrNone, _L("RMobilePhone::SendDTMFTones completed with incorrect error"));

	// ===  Send DTMF string with 'w' character and continue sending (then repeat and not continue sending after the stop) ===

	// Post notification for RMobilePhone::NotifyStopInDTMFString

	TExtEtelRequestStatus notifyStopStatus(mobilePhone, EMobilePhoneNotifyStopInDTMFString);

	CleanupStack::PushL(notifyStopStatus);

	mobilePhone.NotifyStopInDTMFString(notifyStopStatus);

	// Send a DTMF string "1234w567"	

	TBufC<50> toneSet2 = _L("1234w567");

	DEBUG_PRINTF2(_L("Send DTMF tones: %S"), &toneSet2);	

	mobilePhone.SendDTMFTones(sendDtmfTonesStatus, toneSet2);

	// Check RMobilePhone::NotifyStopInDTMFString completes

	iCallControlTestHelper.WaitForMobilePhoneNotifyStopInDTMFString(notifyStopStatus, KErrNone);

	// Continue sending the string with RMobilePhone::ContinueDTMFStringSending with aContinue = ETrue 

	ASSERT_EQUALS(mobilePhone.ContinueDTMFStringSending(ETrue), KErrNone, _L("RMobilePhone::ContinueDTMFStringSending has not returned KErrNone"));

	ASSERT_EQUALS(WaitForRequestWithTimeOut(sendDtmfTonesStatus, ETimeMedium), KErrNone, _L("RMobilePhone::SendDTMFTones sendDtmfTonesStatus is not KErrNone."));

	// Check request completes with KErrNone

    ASSERT_EQUALS(sendDtmfTonesStatus.Int(), KErrNone, _L("RMobilePhone::SendDTMFTones sendDtmfTonesStatus completed with incorrect error"));

	// Hang up the call

	DEBUG_PRINTF1(_L("Hangup call"));	

	ASSERT_EQUALS(mobileCall.HangUp(), KErrNone, _L("RCall::HangUp return value not KErrNone"));

	//

	// TEST END

	//

    StartCleanup();

	CleanupStack::PopAndDestroy(&notifyStopStatus);

	CleanupStack::PopAndDestroy(&sendDtmfTonesStatus);

	CleanupStack::PopAndDestroy(&dialStatus);

	return TestStepResult();

	}

TPtrC CCTSYIntegrationTestDTMF0002::GetTestStepName()

/**

 * @return The test step name.

 */

	{

	return _L("CCTSYIntegrationTestDTMF0002");

	}

CCTSYIntegrationTestDTMF0003::CCTSYIntegrationTestDTMF0003(CEtelSessionMgr& aEtelSessionMgr)

	: CCTSYIntegrationTestDTMFBase(aEtelSessionMgr)

/**

 * Constructor.

 */

	{

	SetTestStepName(CCTSYIntegrationTestDTMF0003::GetTestStepName());

	}

CCTSYIntegrationTestDTMF0003::~CCTSYIntegrationTestDTMF0003()

/**

 * Destructor.

 */

	{

	}

TVerdict CCTSYIntegrationTestDTMF0003::doTestStepL()

/**

 * @SYMTestCaseID BA-CTSY-INT-DTMF-0003

 * @SYMFssID BA/CTSY/DTMF-0003

 * @SYMTestCaseDesc Send DTMF strings containing 'p' and 'w'

 * @SYMTestPriority High

 * @SYMTestActions RMobilePhone::ContinueDTMFStringSending, RMobilePhone::NotifyStopInDTMFString

 * @SYMTestExpectedResults Pass - Notification of a pause in DTMF received.

 * @SYMTestType CIT

 * @SYMTestCaseDependencies live/automatic

 *

 * Reason for test: Verify DTMF stop notifications are received.

 *

 * @return - TVerdict code

 */

	{

	//

	// SET UP

	//

	RMobilePhone& mobilePhone = iEtelSessionMgr.GetPhoneL(KMainServer, KMainPhone);	

	// Get Voice Line 1.

	RMobileLine& mobileLine= iEtelSessionMgr.GetLineL(KMainServer, KMainPhone, KVoiceLine);

	// Get Call 1.

	RMobileCall& mobileCall= iEtelSessionMgr.GetCallL(KMainServer, KMainPhone, KVoiceLine, KCall1);

	// Dial a number that answers. 

	TPtrC number; 

	CHECK_TRUE_L(GetStringFromConfig(KIniVoiceNumSection, KIniVoiceNumber1, number) != EFalse,

				 _L("GetStringFromConfig did not complete as expected"));

	DEBUG_PRINTF2(_L("Board Now Dialling: %S"), &number);

	TCoreEtelRequestStatus<RMobileCall> dialStatus(mobileCall, &RCall::DialCancel);

	CleanupStack::PushL(dialStatus);

	mobileCall.Dial(dialStatus, number); 

	CHECK_EQUALS_L(WaitForRequestWithTimeOut(dialStatus, ETimeMedium), KErrNone, _L("RCall::Dial timed-out"));

	CHECK_EQUALS_L(dialStatus.Int(), KErrNone, _L("RCall::Dial problem dialling"));

	// Check RMobilePhone::GetDTMFCaps returns caps of KCapsSendDTMFString | KCapsSendDTMFSingleTone

	TUint32 dtmfCaps=0;

	CHECK_EQUALS_L(mobilePhone.GetDTMFCaps(dtmfCaps), KErrNone,

				   _L("RMobilePhone::GetDTMFCaps return value not KErrNone"));

	TUint32 expectedCaps = RMobilePhone::KCapsSendDTMFString | RMobilePhone::KCapsSendDTMFSingleTone;

	TUint32 unwantedCaps = KNoWantedBits;

	CHECK_BITS_SET_L(dtmfCaps, expectedCaps, unwantedCaps,

					_L("RMobilePhone::GetDTMFCaps returned wrong dynamic caps"));

	//

	// SET UP END

	//

	StartTest();

	//

	// TEST START

	//

	// Request for notification of RMobilePhone::NotifyStopInDTMFString 

	TExtEtelRequestStatus notifyStopInDTMFStringStatus(mobilePhone, EMobilePhoneNotifyStopInDTMFString);

	CleanupStack::PushL(notifyStopInDTMFStringStatus);

	mobilePhone.NotifyStopInDTMFString(notifyStopInDTMFStringStatus);

	// ===  Send DTMF string that contains digits only and check that ===

	// Send DTMF tones with RMobilePhone::SendDTMFTones with aTones = "1234567890" 

	TBufC<50> toneDigitSet = _L("1234567890");

	DEBUG_PRINTF2(_L("Send DTMF tones: %S"), &toneDigitSet);

	TExtEtelRequestStatus sendDTMFTonesStatus(mobilePhone, EMobilePhoneSendDTMFTones);

	CleanupStack::PushL(sendDTMFTonesStatus);

	mobilePhone.SendDTMFTones(sendDTMFTonesStatus, toneDigitSet);

	ASSERT_EQUALS(WaitForRequestWithTimeOut(sendDTMFTonesStatus, ETimeMedium), KErrNone,

				  _L("RMobilePhone::SendDTMFTones timed-out"));

	ASSERT_EQUALS(sendDTMFTonesStatus.Int(), KErrNone, _L("RMobilePhone::SendDTMFTones status is not KErrNone"));

	// ===  RMobilePhone::NotifyStopInDTMFString is still pending ===

	ASSERT_EQUALS(notifyStopInDTMFStringStatus.Int(), KRequestPending, 

				  _L("RMobilePhone::NotifyStopInDTMFString status is not KRequestPending"));

	// *** Note: expecting NotifyStopInDTMFString to still be active from previous post

	// ===  Send DTMF string with a pause and check that ===

	// Send DTMF tones with RMobilePhone::SendDTMFTones with aTones = "12345p67890" 

	TBufC<50> toneDigitSet2 = _L("12345p67890");

	DEBUG_PRINTF2(_L("Send DTMF tones: %S"), &toneDigitSet2);

	mobilePhone.SendDTMFTones(sendDTMFTonesStatus, toneDigitSet2);

	ASSERT_EQUALS(WaitForRequestWithTimeOut(sendDTMFTonesStatus, ETimeMedium), KErrNone,

				  _L("RMobilePhone::SendDTMFTones timed-out"));

	ASSERT_EQUALS(sendDTMFTonesStatus.Int(), KErrNone, _L("RMobilePhone::SendDTMFTones status is not KErrNone"));

	// Check RMobilePhone::NotifyStopInDTMFString is still KRequestPending

	ASSERT_EQUALS(notifyStopInDTMFStringStatus.Int(), KRequestPending, 

				  _L("RMobilePhone::NotifyStopInDTMFString status is not KRequestPending"));

	// Send DTMF tones with RMobilePhone::SendDTMFTones with aTones = "12345w67890" 

	// ===  Send DTMF string with a stop and check that ===

	TBufC<50> toneDigitSet3 = _L("12345w67890");

	DEBUG_PRINTF2(_L("Send DTMF tones: %S"), &toneDigitSet3);

	mobilePhone.SendDTMFTones(sendDTMFTonesStatus, toneDigitSet3);

	// Check RMobilePhone::NotifyStopInDTMFString completes

	iCallControlTestHelper.WaitForMobilePhoneNotifyStopInDTMFString(notifyStopInDTMFStringStatus, KErrNone);

	// Complete the send

	ASSERT_EQUALS(mobilePhone.ContinueDTMFStringSending(ETrue), KErrNone,

				  _L("RMobilePhone::ContinueDTMFStringSending has not returned KErrNone"));

	ASSERT_EQUALS(WaitForRequestWithTimeOut(sendDTMFTonesStatus, ETimeMedium), KErrNone,

				  _L("RMobilePhone::SendDTMFTones timed-out"));

	ASSERT_EQUALS(sendDTMFTonesStatus.Int(), KErrNone, _L("RMobilePhone::SendDTMFTones status is not KErrNone"));

	// Hang-up call

	DEBUG_PRINTF1(_L("Hangup call"));

	ASSERT_EQUALS(mobileCall.HangUp(), KErrNone, _L("RMobileCall::HangUp return value not KErrNone"));

	//

	// TEST END

	//

    StartCleanup();

	CleanupStack::PopAndDestroy(3, &dialStatus);

						// sendDTMFTonesStatus

						// notifyStopInDTMFStringStatus

						// dialStatus

	return TestStepResult();

	}

TPtrC CCTSYIntegrationTestDTMF0003::GetTestStepName()

/**

 * @return The test step name.

 */

	{

	return _L("CCTSYIntegrationTestDTMF0003");

	}

CCTSYIntegrationTestDTMF0004::CCTSYIntegrationTestDTMF0004(CEtelSessionMgr& aEtelSessionMgr)

	: CCTSYIntegrationTestDTMFBase(aEtelSessionMgr)

/**

 * Constructor.

 */

	{

	SetTestStepName(CCTSYIntegrationTestDTMF0004::GetTestStepName());

	}

CCTSYIntegrationTestDTMF0004::~CCTSYIntegrationTestDTMF0004()

/**

 * Destructor.

 */

	{

	}

TVerdict CCTSYIntegrationTestDTMF0004::doTestStepL()

/**

 * @SYMTestCaseID BA-CTSY-INT-DTMF-0004

 * @SYMFssID BA/CTSY/DTMF-0004

 * @SYMTestCaseDesc Send an invalid DTMF tone.

 * @SYMTestPriority High

 * @SYMTestActions RMobilePhone::StartDTMFTone

 * @SYMTestExpectedResults Pass - Error from baseband / dispatch layer when sending an invalid tone.

 * @SYMTestType CIT

 * @SYMTestCaseDependencies live/automatic

 *

 * Reason for test: Verify error is returned on attempt to send invalid tone.

 *

 * @return - TVerdict code

 * 

 * $CTSYProblem - The invalid tone is sent to CTSY.  CTSY simply passes it down to the LTSY.

 * The LTSY is returning KErrNone, and CTSY is propogating the error back up to Etel.

 */

	{

	//

	// SET UP