diff -r 000000000000 -r 9cfd9a3ee49c lbstest/lbstestproduct/lbsconflict/src/ctlbsconflictstepselflocatex3ppush.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lbstest/lbstestproduct/lbsconflict/src/ctlbsconflictstepselflocatex3ppush.cpp Tue Feb 02 01:50:39 2010 +0200 @@ -0,0 +1,605 @@ +// Copyright (c) 2006-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 ctlbsassdatastepselflocatex3ppush.cpp +// This is the class implementation for the Module Information Tests +// EPOC includes. +// +// + +// LBS includes. +#include +#include +#include +#include +#include +#include + +// LBS test includes. +#include "ctlbsconflictstepselflocatex3ppush.h" +#include + + +/** Test case development notes + =========================== + + It was decided to aid readablity each test class shall only support a single test case. + This example has been produced to show how a typical conflict test case should be coded. + + + Net Sim and Sequence Events + --------------------------- + Every test case implementation will use the ctlbsconflictstep class which supports Net Sim + interactions and a way to ensure Net Sim events and client completion events have a occured + in the correct order. An array is used to hold the expected sequence event values, and a second + array contains the actual events produced during the test. Once the test moves into the EWaiting + state typically after all the client requests have been made, the event arrays are compared to + ensure the correct events were given. + + To set the expected sequence events populate the array in the SetExpectedSeq() function. + + + Async wappers + ------------- + Each Lbs client async request is wappared in a active object class, to allow a number of + outstanding async requests during the test. Any async calls you wish to make should also + be wrapped in the same way, see CT_LbsDoX3P and CT_LbsDoPosUpdate for examples. + These classes are constructed in the test class ConstructL, and maybe started or cancelled + during the test at any point. + + + Verify Position Information + --------------------------- + A test should verify each client call which expected a location to be returned. The + location data should be validation to ensure it's correct. See VerifyPosInfos. +*/ + + +/** +Static Constructor +*/ +CT_LbsConflictStep_selflocatex3ppush* CT_LbsConflictStep_selflocatex3ppush::New(CT_LbsConflictServer& aParent) + { + // Note the lack of ELeave. + // This means that having insufficient memory will return NULL; + CT_LbsConflictStep_selflocatex3ppush* testStep = new CT_LbsConflictStep_selflocatex3ppush(aParent); + if (testStep) + { + TInt err = KErrNone; + + TRAP(err, testStep->ConstructL()); + if (err) + { + delete testStep; + testStep = NULL; + } + } + return testStep; + } + + +/** + * Constructor + */ +CT_LbsConflictStep_selflocatex3ppush::CT_LbsConflictStep_selflocatex3ppush(CT_LbsConflictServer& aParent) : CT_LbsConflictStep(aParent) + { + SetTestStepName(KLbsConflictStepselflocatex3ppush); + } + + +void CT_LbsConflictStep_selflocatex3ppush::ConstructL() + { + // Create the base class objects. + CT_LbsConflictStep::ConstructL(); + + // Self locate async wrapper. + iDoPosUpdate = CT_LbsDoPosUpdate::NewL(this); + + // X3P async wrapper. + iDoX3P = CT_LbsDoX3P::NewL(this); + } + + +/** + * Destructor + */ +CT_LbsConflictStep_selflocatex3ppush::~CT_LbsConflictStep_selflocatex3ppush() + { + iDoPosUpdate->Cancel(); + delete iDoPosUpdate; + + iDoX3P->Cancel(); + delete iDoX3P; + } + + +/** Called at the start of the test... + + Each test case MUST implement this. + + The table below describes the expcted order that the callbacks should be called + during the test. + + Note that the tests deliberateley do NOT check the order that the client requests + are completed. This is because the delivery order is not guaranteed by LBS. + The tests will check that all client requests are completed with the correct error + code and position at the end of the test. +*/ +void CT_LbsConflictStep_selflocatex3ppush::SetExpectedSeq() + { + // Self locate MOLR (iState = ERegPosUpdate) + SetVerifySeqEvent(ESelf_MOLR_NetSim_Got_NotifyRegisterLcsMoLr); // --> To Net + SetVerifySeqEvent(ESelf_MOLR_NetSim_Got_NotifyReleaseLcsMoLr); // --> To Net + + // followed by a X3P MOLR (after X3P register iState = ERegX3P), + SetVerifySeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyRegisterLcsMoLr); // --> To Net + SetVerifySeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementControlLocation); // <-- From Net + SetVerifySeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementReportLocation); // --> To Net + SetVerifySeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyFacilityLcsMoLrResult); + + SetVerifySeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyReleaseLcsMoLr); // --> To Net + + // (after X3P release iState = EWaiting). + + SetVerifyAdhocEvent(EClient_Got_PosUpdate_Complete); + SetVerifyAdhocEvent(EClient_Got_X3P_Complete); + + } + + + +/** Called at the end of the test to verify the correct position data has been returned to the + client. + + Each test case SHOULD implement a version of this. +*/ +void CT_LbsConflictStep_selflocatex3ppush::VerifyPosInfos() + { + T_LbsUtils utils; + RPointerArray& verifyPosInfoArr = iParent.iSharedData->iVerifyPosInfoArr; + RPointerArray& currPosInfoArr = iParent.iSharedData->iCurrentPosInfoArr; + TPositionInfo* currPosInfo; + + // Verify both the self locate and X3P MOLR position information. + + // Actually, Don't bother with the self locate for now - it's not been set anyway + + // Verify entry 1 for the X3P. We expect a real location value, compare using the data + // sent to the test APGS module. + TPositionInfo* verifyPosInfo = reinterpret_cast(verifyPosInfoArr[0]); + currPosInfo = reinterpret_cast(currPosInfoArr[1]); + if (!utils.Compare_PosInfo(*verifyPosInfo, *currPosInfo)) + { + INFO_PRINTF1(_L("Failed test, X3P position incorrect.")); + SetTestStepResult(EFail); + } + } + + +/** A standard TEF test case doTestStepL, this SHOULD only support a single test case. + + Typically the function will look much like this. + */ +TVerdict CT_LbsConflictStep_selflocatex3ppush::doTestStepL() + { + // Generic test step used to test the LBS Client Notify position update API. + INFO_PRINTF1(_L(">>CT_LbsConflictStep_selflocatex3ppush::doTestStepL()")); + + if (TestStepResult() == EPass) + { + // Setup the expected sequence events for the test. + SetExpectedSeq(); + + // Open and setup net sim. + OpenNetSim(this); + + // Kick off the test abort and keep alive timers. + TTimeIntervalMicroSeconds32 abortInterval(KLbsAbortPeriod); + TTimeIntervalMicroSeconds32 keepAliveInterval(KLbsKeepAlivePeriod); + + iKeepAliveTimer->SetTimer(keepAliveInterval); + + // Set up test module so there's a delay in responding to request for fix: + TModuleDataIn modDataInTimeout; // Used to send test information to the test module. + const TInt KLbsTestModuleTimeOut = 3000000; // 3 sec delay + // The module request type - time out value. + modDataInTimeout.iRequestType = TModuleDataIn::EModuleRequestTimeOut; + // Micro seconds time value to delay the return position update from the module. + modDataInTimeout.iTimeOut = KLbsTestModuleTimeOut; + T_LbsUtils utils; + utils.NotifyModuleOfConfigChangeL(modDataInTimeout); + + // Kick off test. + CActiveScheduler::Start(); + + // Verify location data. + VerifyPosInfos(); + + // Clean up. + CloseNetSim(); + } + + INFO_PRINTF1(_L("<<CT_LbsConflictStep_selflocatex3ppush::doTestStepL()")); + + return TestStepResult(); + } + + +/** NetSim callbacks given for a MoLr, which we invoke as a result of the notify position update. +*/ +void CT_LbsConflictStep_selflocatex3ppush::Connected() + { + // Call base implementation. + CT_LbsConflictStep::Connected(); + + // Kick off first pos update. + + // Create a posinfo and store in our shared array for later verification. + RPointerArray& posInfoArr = iParent.iSharedData->iCurrentPosInfoArr; + TPositionInfo* posInfo = new(ELeave) TPositionInfo(); + + T_LbsUtils utils; + utils.ResetAndDestroy_PosInfoArr(posInfoArr); // Clear previous entries before new entry is appended. + + posInfoArr.Append(posInfo); + + // Kick off pos update. + TInt testCaseId; + if (GetIntFromConfig(ConfigSection(), KTestCaseId, testCaseId)) + { + switch (testCaseId) + { + // Test case LBS-UpdateOptions-001 + case 7: + { + TPositionUpdateOptions optsA; + TTimeIntervalMicroSeconds interval = 30 * 1000000; // tracking! + + optsA.SetUpdateInterval(interval); + iDoPosUpdate->SetOptions(optsA); + break; + } + + } + } + + iDoPosUpdate->StartL(*posInfo); + iState = EReqPosUpdate; + } + + +void CT_LbsConflictStep_selflocatex3ppush::Disconnected() + { + // Call base implementation. + CT_LbsConflictStep::Disconnected(); + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyRegisterLcsMoLr(const TDesC& aData) + { + // Determine and record the sequence event. A blank aData indicates a self locate + // MOLR, otherwise we have a X3P MOLR. Also the current test state indicates which + // type MOLR is being carried out. + + if (aData != KNullDesC) + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Register Lcs MoLr - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyRegisterLcsMoLr); + + // Verify telephone number. + if (aData.Compare(KTransmitPushDestination)) + { + INFO_PRINTF1(_L("Failed test, bad X3P register data.")); + SetTestStepResult(EFail); + } + // Mark as started now it has, to ensure the self MOLR are not recorded incorrectly. + iState = EReqX3P; + + } + + else if ((aData == KNullDesC) && (iState == EReqPosUpdate)) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Register Lcs MoLr - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyRegisterLcsMoLr); + } + + // Start the X3P + if (iState == EReqPosUpdate) + { + // Create a posinfo and store in our shared array for later verification + RPointerArray& posInfoArr = iParent.iSharedData->iCurrentPosInfoArr; + TPositionInfo* posInfo = new(ELeave) TPositionInfo(); + + posInfoArr.Append(posInfo); + + // Start X3P. + TLbsTransmitPositionOptions transOpts; + + INFO_PRINTF1(_L("Starting X3P")); + iDoX3P->SetOptions(transOpts); // Set timeout value to 0, to disable the timeout. + iDoX3P->StartL(KTransmitPushDestination, KTransmitPushPriority, *posInfo); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyReleaseLcsMoLr(TInt aReason) + { + TInt expectedErr = KErrNone; + + // Determine and set sequence event. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Release Lcs MoLr - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyReleaseLcsMoLr); + + expectedErr = KErrPositionHighPriorityReceive; + } + + else if(iState == EReqX3P) + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Release Lcs MoLr - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyReleaseLcsMoLr); + + iState = EWaiting; // End of test. + } + + // Verify reason code. + if (aReason != expectedErr) + { + INFO_PRINTF2(_L("Failed test, bad release reason %d."), aReason); + SetTestStepResult(EFail); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyMeasurementControlLocation(const TPositionInfo& aPosition, + const RLbsAssistanceDataBuilderSet& aData, + const TLbsNetPosRequestQuality& aQuality) + { + T_LbsUtils utils; + TInt err; + + // Determine and record sequence event. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Measurement Control Location - Event.")); + // cannot record this event since it may/maynot occur depending on timing but ... + // SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyMeasurementControlLocation); + // ... if we do get one of these, we must get a failure message so add that to adhoc list + SetVerifyAdhocEvent(ESelf_MOLR_NetSim_Got_NotifyMeasurementReportControlFailure); + } + + else if(iState == EReqX3P) + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Measurement Control Location - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementControlLocation); + } + + // Verify the reference position. + TPositionInfo verifyRefPosInfo; + + verifyRefPosInfo.SetPosition(iRefPos); + if (!utils.Compare_PosInfo(verifyRefPosInfo, aPosition)) + { + INFO_PRINTF1(_L("Failed test, position incorrect.")); + SetTestStepResult(EFail); + } + + + // Verify the assistance data. + RLbsAssistanceDataBuilderSet& data = const_cast(aData); + RUEPositioningGpsReferenceTimeBuilder* refTimeBuilder = NULL; + + data.GetDataBuilder(refTimeBuilder); + + // Create a reader from the builder's data to allow us to verify the actual + // assistance data. + RUEPositioningGpsReferenceTimeReader refTimeReader; + + TRAP(err, refTimeReader.OpenL()); + if (err == KErrNone) + { + refTimeReader.DataBuffer() = refTimeBuilder->DataBuffer(); + + if (!utils.VerifySimpleAssistanceData(refTimeReader)) + { + INFO_PRINTF1(_L("Failed test, assistance data incorrect.")); + SetTestStepResult(EFail); + } + refTimeReader.Close(); + } + + else + { + INFO_PRINTF2(_L("Failed test, assistance data reader err %d."), err); + SetTestStepResult(EFail); + } + + + // TODO: Check if we can verify aQuality in any way. + (void)aQuality; + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyReleaseLcsLocationNotification(const CLbsNetworkProtocolBase::TLbsPrivacyResponse& aResult) + { + (void)aResult; + + // Unexpected callback for this test log the sequence event to fail test. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Release Lcs Location Notification - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyReleaseLcsLocationNotification); + } + + else + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Release Lcs Location Notification - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyReleaseLcsLocationNotification); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyFacilityLcsMoLrResult(TInt aReason, const TPositionInfo& aPosition) + { + // Determine and record sequence event. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Facility Lcs MoLr Result - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyFacilityLcsMoLrResult); + } + + else + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Facility Lcs MoLr Result - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyFacilityLcsMoLrResult); + } + + // Verify reason code.. + if (aReason != KErrNone) + { + INFO_PRINTF2(_L("Failed test, bad release reason %d."), aReason); + SetTestStepResult(EFail); + } + + // Verify the real position returned from the network, this will be the same position + // we sent to the network as the result of the MO-LR, thus use the entry given by + // the test module. + T_LbsUtils utils; + RPointerArray& verifyPosInfoArr = iParent.iSharedData->iVerifyPosInfoArr; + TPositionInfo* verifyRealPosInfo = reinterpret_cast(verifyPosInfoArr[0]); + + if (!utils.Compare_PosInfo(*verifyRealPosInfo, aPosition)) + { + INFO_PRINTF1(_L("Failed test, position incorrect.")); + SetTestStepResult(EFail); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyMeasurementReportLocation(const TPositionInfo& aPosition) + { + // Determine and record sequence event. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Measurement Report - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyMeasurementReportLocation); + } + + else if(iState == EReqX3P) + { + INFO_PRINTF1(_L("Got - X3P MOLR - NetSim Notify Measurement Report - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementReportLocation); + } + + + // Verify the real position given to the network, this will be the same position + // returned as the result of the MO-LR, thus use the entry given by + // the test module. + T_LbsUtils utils; + RPointerArray& verifyPosInfoArr = iParent.iSharedData->iVerifyPosInfoArr; + TPositionInfo* verifyRealPosInfo = reinterpret_cast(verifyPosInfoArr[0]); + + if (!utils.Compare_PosInfo(*verifyRealPosInfo, aPosition)) + { + INFO_PRINTF1(_L("Failed test, position incorrect.")); + SetTestStepResult(EFail); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyMeasurementReportRequestMoreAssistanceData(const TLbsAssistanceDataGroup& aFilter) + { + (void)aFilter; + + // Unexpected callback for this test, record the sequence event to fail test. + if (iState == EReqPosUpdate) + { + INFO_PRINTF1(_L("Got - Self MOLR - NetSim Notify Measurement Report Request More Assistance Data - Event.")); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyMeasurementReportRequestMoreAssistanceData); + } + + else + { + INFO_PRINTF1(_L("Got - X3P(PUSH) MOLR - NetSim Notify Measurement Report Request More Assistance Data - Event.")); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementReportRequestMoreAssistanceData); + } + } + + +void CT_LbsConflictStep_selflocatex3ppush::NotifyMeasurementReportControlFailure(TInt aReason) + { + // Unexpected callback for this test, record the sequence event to fail test. + if (iState == EReqPosUpdate) + { + INFO_PRINTF2(_L("Got - Self MOLR - Net Sim Notify Measurement Report Control Failure - Event. Reason = %d"), aReason); + SetCurrentSeqEvent(ESelf_MOLR_NetSim_Got_NotifyMeasurementReportControlFailure); + if(aReason != KErrPositionHighPriorityReceive) + { + SetTestStepResult(EFail); + } + } + + else + { + INFO_PRINTF2(_L("Got - X3P MOLR(PUSH) - Net Sim Notify Measurement Report Control Failure - Event. Reason = %d"), aReason); + SetCurrentSeqEvent(EX3P_PUSH_MOLR_NetSim_Got_NotifyMeasurementReportControlFailure); + } + } + + +/** Notify position update callback. + + The notify position update has completed. +*/ +void CT_LbsConflictStep_selflocatex3ppush::MT_LbsDoPosUpdateCallback(TRequestStatus& aStatus) + { + INFO_PRINTF1(_L("Got - Client Notify Update Complete - Callback Event.")); + SetCurrentSeqEvent(EClient_Got_PosUpdate_Complete); + + // Expect the self locate MOLR to be stopped because of the X3P + if (KErrPositionHighPriorityReceive != aStatus.Int()) + { + INFO_PRINTF2(_L("Failed test, pos info request err = %d."), aStatus.Int()); + SetTestStepResult(EFail); + } + else + { + INFO_PRINTF2(_L("Got KErrPositionHighPriorityReceive err = %d."), aStatus.Int()); + } + } + + +/** X3P transmit callback. + + The X3P transmit request has completed. +*/ +void CT_LbsConflictStep_selflocatex3ppush::MT_LbsDoX3PCallback(TInt aTransmitId, TRequestStatus& aStatus) + { + (void)aTransmitId; + + INFO_PRINTF1(_L("Got - Client X3P Complete - Callback Event.")); + SetCurrentSeqEvent(EClient_Got_X3P_Complete); + + if (KErrNone != aStatus.Int()) + { + INFO_PRINTF2(_L("Failed test, X3P transmit request err = %d."), aStatus.Int()); + SetTestStepResult(EFail); + } + else + { + INFO_PRINTF2(_L("Got KErrNone err = %d."), aStatus.Int()); + } + } + +