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

// Implements the integration tests for the SPUD using RawIpNif

// 

//

/**

 @file

 @internalComponent

*/

#include "te_spudNetworkSideSteps.h"

#include <c32comm.h> // uniquely for the call to StartC32WithCMISuppressions

#include "spudNetSideQos.h"

#include <simtsy.h>

#include <commdbconnpref.h>

#include <nifvar.h> // Nifman Progress notifications

#include <in_sock.h>

#include <es_enum.h> 

#include <comms-infras/es_config.h>

#include <nifman.h>

#ifndef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

#include <networking/qoslib.h>

#else

#include <commsdat.h>

#include <commsdattypesv1_1.h>

#include <commsdattypeinfov1_1_internal.h>

#endif

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

using namespace CommsDat;

#define PDPIAP 2

#endif

using namespace te_spudNetworkSide; 

_LIT(KCsyName,"PKTLOOPBACK");

_LIT8(KCommWriteData, "Data to send");

_LIT8(KCommWriteData2, "Second data to send");

// length of a buffer long enough to read KCommWriteData

const TUint KCommReadBufSize = 64;

// These aren't defined in a common header file.

static const RProperty::TType KUidPSCsyWriteResultCategoryKeyType = RProperty::EInt;

static const TUid KUidPSCsyWriteResultCategory = {0x10206869}; //KUidLoopbackCSYMin + 5

const TTimeIntervalMicroSeconds32 KReadDelay(10000000);

const TUint KTimeToStartSecondary(1000000*5); // give it 5 seconds in case logging is on

/**

 Implements the pure virtual doTestStepPreambleL defined in CTestStep. 

 Used to disable the phone book synchronizer

 which may cause the tests to fail.

 @return EPass if successful.

 @leave If Phonebook synchronizer disabling fails. 

 */

TVerdict CSpudNetSideTestBase::doTestStepPreambleL()

	{	

	_LIT(KPhbkSyncCMI, "phbsync.cmi");

	TInt err = StartC32WithCMISuppressions(KPhbkSyncCMI);

	TESTL(KErrNone == err || KErrAlreadyExists == err);

	INFO_PRINTF1(_L("Test Step Preamble: disabled Phonebook Synchronizer."));	

	return EPass;

	}

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

TVerdict CSpudNetSideTestBase::doTestStepPostambleL()

	{	

	ClearPolicySelector2QosParametersTableL();

	return TestStepResult();

	}

#endif

void CSpudNetSideTestBase::FailNextPktLoopbackCsyWriteL(TInt aPortNum, TInt aErrorCode)

	{

	TInt dummy(0);

	TInt ret = RProperty::Get(KUidPSCsyWriteResultCategory, aPortNum, dummy);

	if(ret == KErrNotFound)

		{

		RProperty::Define(KUidPSCsyWriteResultCategory, aPortNum, KUidPSCsyWriteResultCategoryKeyType);

		}

	TestL(RProperty::Set(KUidPSCsyWriteResultCategory, aPortNum, aErrorCode), _L("Set PSCsy write result"));

  	INFO_PRINTF3(_L("Next write on [PKTLOOPBACK::%d] is going to fail with [%d]"), aPortNum, aErrorCode);

  	}

/**

Blocks until Nifman progress notification is received.

@param aReqStatus Request status to wait on for the notification

@param aProgress Nifman progress notification code, for sanity check. This is the progress that was subscribed for.

@param aErrCode expected progress error code.

@leave if the error code received is not equal to the expected.

*/

void CSpudNetSideTestBase::WaitForProgressNotificationL(TRequestStatus& aReqStatus, TInt aProgress, TInt aErrCode)

	{

	INFO_PRINTF3(_L("Waiting for Nifman Progress: stage[%d] with error[%d]"), aProgress, aErrCode);

	User::WaitForRequest(aReqStatus);

	if(KErrNone != aReqStatus.Int())

		{

		INFO_PRINTF2(_L("Unexpected error on progress notification: [%d]"), aReqStatus.Int());

		User::Leave(aReqStatus.Int());

		}

	INFO_PRINTF3(_L("Received Progress [%d], error[%d]"), iProgressBuf().iStage, iProgressBuf().iError);

	if(aErrCode != iProgressBuf().iError)

		{

		User::Leave(KErrArgument);

		}

	ASSERT(aProgress == iProgressBuf().iStage); // Error in Nifman Progress Notification mechanism

	}

/**

Retrieves the PDP context type (EPrimaryContext or ESecondaryContext) from the configuration file

@param aContextTypeName the name of the context to retrieve the type for

@return the type of fhe context

@leave if this setting is not in the configuration file, or if the type is unrecognized 

*/	

TContextType CSpudNetSideTestBase::RetrieveContextTypeFromConfigL(const TDesC& aContextTypeName)

	{

	TPtrC eventStr;

	if(!GetStringFromConfig(ConfigSection(), aContextTypeName, eventStr))

		{

		INFO_PRINTF2(_L("Context config type[%S] not in config. Leaving with KErrNotFound"), &aContextTypeName);

		User::Leave(KErrNotFound);

		}

	INFO_PRINTF3(_L("Context type is [%S] for request [%S]"), &eventStr, &aContextTypeName);	

	// convert the enum

	TContextType contextType(EPrimaryContext);

	if(eventStr.Compare(TPtrC(_L("EPrimaryContext"))) == 0)

		{

		contextType =  EPrimaryContext;

		}

	else if(eventStr.Compare(TPtrC(_L("ESecondaryContext"))) == 0)

		{

		contextType =  ESecondaryContext;

		}

	else

		{

		INFO_PRINTF2(_L("Context type [%S] does not match 'EPrimaryContext' or 'ESecondaryContext'"), &eventStr);

		User::Leave(KErrCorrupt);

		}

	return contextType;

	}

/**

Retrieves the COMM role (DTE / DCE) from config

@param aCommRoleName the name of the parameter to retrieve the role for

@return the comm role

@leave the setting is not found or if the role is unrecognized 

*/	

TCommRole CSpudNetSideTestBase::RetrieveCommRoleFromConfigL(const TDesC& aCommRoleName)

	{

	TPtrC roleStr;

	if(!GetStringFromConfig(ConfigSection(), aCommRoleName, roleStr))

		{

		INFO_PRINTF2(_L("Comm role[%S] not in config. Leaving with KErrNotFound"), &aCommRoleName);

		User::Leave(KErrNotFound);

		}

	INFO_PRINTF3(_L("Comm role is [%S] for request [%S]"), &roleStr, &aCommRoleName);

	// convert the enum

	TCommRole commRole(ECommRoleDTE);

	if(roleStr.Compare(TPtrC(_L("ECommRoleDTE"))) == 0)

		{

		commRole =  ECommRoleDTE;

		}

	else if(roleStr.Compare(TPtrC(_L("ECommRoleDCE"))) == 0)

		{

		commRole =  ECommRoleDCE;

		}

	else

		{

		INFO_PRINTF2(_L("Comm role [%S] does not match 'ECommRoleDTE' or 'ECommRoleDCE'"), &roleStr);

		User::Leave(KErrCorrupt);

		}

	return commRole;

	}

/**

Retrieves the value of the network side event from the configuration file

@param the name of the even parameter

@return the network side event value (actually an index in publish-subscribe section in the SIM.TSY config.txt)	

@leave if the setting cannot be found 

*/

TInt CSpudNetSideTestBase::RetrieveNetSideEventValFromConfigL(const TDesC& aEventValName)

	{

	TInt val(0);

	if(!GetIntFromConfig(ConfigSection(), aEventValName, val))

		{

		User::Leave(KErrNotFound);

		}

	return val;

	}

/**

Retrieves the type of the network side event (QoS Change, ContextStatus change, etc)

@param aEventName event parameter name

@return the event type

@leave if parameter cannot be found, or if the value is unrecognized 

*/		

TEtelRequestType CSpudNetSideTestBase::RetrieveNetSideEventRequestFromConfigL(const TDesC& aEventName)

	{

	TPtrC eventStr;

	if(!GetStringFromConfig(ConfigSection(), aEventName, eventStr))

		{

		INFO_PRINTF2(_L("NetSide event [%S] not in config. Leaving with KErrNotFound"), &aEventName);	

		User::Leave(KErrNotFound);

		}

	INFO_PRINTF3(_L("NetSide event is [%S] for request [%S]"), &eventStr, &aEventName);	

	// convert the enum

	TEtelRequestType request(EInvalidRequest);

	if(eventStr.Compare(TPtrC(_L("ENetworkQoSChange"))) == 0)

		{

		request =  ENetworkQoSChange;

		}

	else if(eventStr.Compare(TPtrC(_L("ENetworkChangeRegStatus"))) == 0)

		{

		request =  ENetworkChangeRegStatus;

		}

	else if(eventStr.Compare(TPtrC(_L("EContextStatusChange"))) == 0)

		{

		request =  EContextStatusChange;

		}

	else

		{

		ERR_PRINTF2(_L("Unknown event [%S] requested. Leaving with KErrArgument"), &eventStr);

		User::Leave(KErrArgument);

		}

	return request;

	}

/**

 Sets the section for the simtsy to use in its config.txt file.

 The section that will be used is testX, where X is the parameter aTestNumber

 */

void CSpudNetSideTestBase::SetSimTsyTestNumberL(TInt aTestNumber)

  	{

	TestL(RProperty::Set(KUidPSSimTsyCategory, KPSSimTsyTestNumber, aTestNumber), _L("Set Sim TSY test number"));

  	}

/**

Gets the mandatory settings from the test configuration

@leave if not found 

*/

void CSpudNetSideTestBase::RetrieveMandatorySettingsFromConfigL()

	{

	if(!GetIntFromConfig(ConfigSection(), _L("SimTsyTestNum"), iSimTsyTestNum))

		{

		ERR_PRINTF1(_L("Failed to read mandatory settings (SimTsyTestNum, etc) from the config file."));

		User::Leave(KErrNotFound);

		}

	}

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

/**

Read Qos Parameter Settings from config

@leave if not found 

*/

void CSpudNetSideTestBase::ReadQosParameterSettingsFromConfigL()

	{

	_LIT(KPolicySelector, "PolicySelector");

	_LIT(KParametersType, "ParametersType");

	_LIT(KGenericQosRecord, "GenericQosRecord");

	_LIT(KUmtsR99QoSAndOnTableRecord, "UmtsR99QoSAndOnTableRecord");

	_LIT(KParametersRecordId, "ParametersRecordId");

	TPtrC parameterType;

	TInt record;

	if(!GetStringFromConfig(ConfigSection(), KParametersType, parameterType))

		{

		ERR_PRINTF1(_L("Failed to read mandatory settings (ParametersType, etc) from the config file."));

		User::Leave(KErrNotFound);

		}

	if(!GetIntFromConfig(ConfigSection(), KParametersRecordId, record))

		{

		ERR_PRINTF1(_L("Failed to read mandatory settings (ParametersRecord, etc) from the config file."));

		User::Leave(KErrNotFound);

		}

	if(!GetIntFromConfig(ConfigSection(), KPolicySelector, iPolicySelector))

		{

		ERR_PRINTF1(_L("Failed to read mandatory settings (PolicySelector, etc) from the config file."));

		User::Leave(KErrNotFound);

		}

	if (parameterType.Compare(KGenericQosRecord()) == 0)

		{

		iQosParametersRecord = KCDTIdGenericQosRecord | record;

		}

	else if (parameterType.Compare(KUmtsR99QoSAndOnTableRecord()) == 0)

		{

		iQosParametersRecord = KCDTIdUmtsR99QoSAndOnTableRecord | record;

		}

	else

		{

		ERR_PRINTF2(_L("Invalid value for ParametersType. %S"), &parameterType);

		User::Leave(KErrArgument);

		}

	}

#endif

/**

 Implements the pure virtual doTestStepL defined in CTestStep. 

 Allows the base class to execute before any of the derived 

 tests is called.

 @leave If any of the called methods leaves.

 */

TVerdict CSpudNetSideTestBase::doTestStepL()

	{

	// Initialize the mandatory objects, without which there is not point in running the tests.

	RetrieveMandatorySettingsFromConfigL();	

	TRAPD(esockConnErr, TestL(iEsock.Connect(), _L("RSockeServ::Connect")));

	if(KErrNone != esockConnErr)

		{

		INFO_PRINTF1(_L("ESock thread is dead. Most likely, it was crashed by the previous test case. Check the Root Server logs."));

		SetTestStepResult(EInconclusive);

		return TestStepResult();

		}

	// Sim.Tsy test section to use with the test

	INFO_PRINTF2(_L("Sim TSY test number: [%d]"), iSimTsyTestNum);

	SetSimTsyTestNumberL(iSimTsyTestNum);

	ASSERT(!CActiveScheduler::Current()); // We should not have an AS at this point.

	CActiveScheduler* testSched = new(ELeave) CActiveScheduler;

	CleanupStack::PushL(testSched);

	CActiveScheduler::Install(testSched);

	// Test sequence itself:

	TVerdict testResult = EFail;		

	TRAPD(err, testResult = RunTestStepL());

	if(KErrNone == err)

		{

		INFO_PRINTF1(_L("Test Step Completion."));

		SetTestStepResult(testResult);

		}

	else

		{

		ERR_PRINTF2(_L("Test Step Failure: the step left with [%d]"), err);

		SetTestStepResult(EFail);

		}

	// It's OK to close these more than once.

	iLoopbackPort.Close();

	iCommServer.Close();

#ifndef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

	iQoSPolicy_1.Close();

#endif

	iSocketJoin.Close();

	iSocket.Close();

	iInterface.Close();

	iEsock.Close();

	CActiveScheduler::Install(NULL); // uninstall the test scheduler

	CleanupStack::PopAndDestroy(testSched);

	return TestStepResult();	

	}

#ifndef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

/**

Blocks until a QoS event is received

@param aQosEventString the name of config parameter holding the expected event

@param aReasonCodeString the name of the config parameter holding the expected reason

@leave if the received event is not what was expected 

*/

void CSpudNetSideTestBase::WaitForQoSEventL(const TDesC& aQosEventString, const TDesC& aReasonCodeString)

	{

	TQoSEvent expQosEvent = RetrieveQosEventFromConfigL(aQosEventString);

	if(expQosEvent == EQoSEventFailure || expQosEvent == EQoSEventAdapt || expQosEvent == EQoSEventJoin)

		{

		TInt reason = RetrieveNetSideEventValFromConfigL(aReasonCodeString);

		WaitForQoSEventL(expQosEvent,reason);

		}

	else

		{

		WaitForQoSEventL(expQosEvent,KErrNone);

		}

	}

/**

Blocks until a QoS event is received

@param aQosEventString the name of config parameter holding the expecting event

@param aReasonCode the expected reason

@leave if the received event is not what was expected 

*/

void CSpudNetSideTestBase::WaitForQoSEventL(const TDesC& aQosEventString, TInt aReasonCode)

	{

	TQoSEvent expQosEvent = RetrieveQosEventFromConfigL(aQosEventString);

	WaitForQoSEventL(expQosEvent,aReasonCode);

	}

/**

Blocks until a QoS event is received

@param aQosEventString the expected event

@param aReasonCode the expected reason

@leave if the received event is not what was expected 

*/

void CSpudNetSideTestBase::WaitForQoSEventL(TQoSEvent aQosEvent, TInt aReasonCode)

	{

	INFO_PRINTF1(_L("Waiting for QoS Event: starting ActiveScheduler"));

	CActiveScheduler::Start();

	// We have received QoS event at this point. 

	TPtrC expectedEvent(QoSEventToText(aQosEvent));

	TPtrC receivedEvent(QoSEventToText(iReceivedQosEvent));

	if(aQosEvent == EQoSEventFailure || aQosEvent == EQoSEventAdapt || aQosEvent == EQoSEventJoin)

		{

		INFO_PRINTF5(_L("Qos Event [%S] and Reason [%d] expected, [%S] and Reason [%d] received"), &expectedEvent,aReasonCode, &receivedEvent,iQosReason );

		if(aQosEvent == iReceivedQosEvent && iQosReason == aReasonCode)	

			{

			INFO_PRINTF1(_L("OK. correct event and reason received."));

			}

		else

			{

			INFO_PRINTF1(_L("Failure: unexpected event or reason"));

			User::Leave(KErrCorrupt);

			}

		}

	else

		{

		INFO_PRINTF3(_L("Qos Event [%S] expected, [%S] received"), &expectedEvent, &receivedEvent);

		if(aQosEvent == iReceivedQosEvent)	

			{

			INFO_PRINTF1(_L("OK. correct event received."));

			}

		else

			{

			INFO_PRINTF1(_L("Failure: unexpected event"));

			User::Leave(KErrCorrupt);

			}

		}

	}

/**

 Wrapper for WaitForOptionalQoSEventL(TQoSEvent aQosEvent, TInt aReasonCode, TQoSEvent aOptionalQosEvent, TInt aOptionalReasonCode)

*/

void CSpudNetSideTestBase::WaitForOptionalQoSEventL(const TDesC& aQosEventString, const TDesC& aReasonCodeString, const TDesC& aOptionalQosEventString, const TDesC& aOptionalReasonCodeString)

	{

	TQoSEvent optionalEvent = (TQoSEvent)0;

	TRAPD(err, optionalEvent = RetrieveQosEventFromConfigL(aOptionalQosEventString));

	if (KErrArgument == err)

		{

		// Could not find any optional events

		WaitForQoSEventL(aQosEventString,aReasonCodeString);

		}

	else

		{

		// found an optional event

		WaitForOptionalQoSEventL(aQosEventString,aReasonCodeString,optionalEvent,aOptionalReasonCodeString);

		}

	}

/**

 Wrapper for WaitForOptionalQoSEventL(TQoSEvent aQosEvent, TInt aReasonCode, TQoSEvent aOptionalQosEvent, TInt aOptionalReasonCode)

*/

void CSpudNetSideTestBase::WaitForOptionalQoSEventL(const TDesC& aQosEventString, const TDesC& aReasonCodeString, TQoSEvent aOptionalQosEvent, const TDesC& aOptionalReasonCodeString)

	{

	TQoSEvent expQosEvent = RetrieveQosEventFromConfigL(aQosEventString);

	TInt expQosReason = KErrNone;

	TInt optionalExpQosReason = KErrNone;

	if(expQosEvent == EQoSEventFailure || expQosEvent == EQoSEventAdapt || expQosEvent == EQoSEventJoin)

		{

		expQosReason = RetrieveNetSideEventValFromConfigL(aReasonCodeString);

		}

	if(aOptionalQosEvent == EQoSEventFailure || aOptionalQosEvent == EQoSEventAdapt || aOptionalQosEvent == EQoSEventJoin)

		{

		optionalExpQosReason = RetrieveNetSideEventValFromConfigL(aOptionalReasonCodeString);

		}

	WaitForOptionalQoSEventL(expQosEvent, expQosReason, aOptionalQosEvent, optionalExpQosReason);