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

// 1. What is the test code testing?

// TNotdial has been designed to exercise the API of the extended notifier 

// framework. The extended notifier framework has 

// support for priorities, channels, and plugin-in implementation modules --- see the 

// tplugin.* files.

// When the notifier framework is started for the first time Connect is called on

// a RNotifier object. The manager is created and Register is called and the plug-in 

// dll implementing the MEikSrvNotifierbase2 classes:

// CMyPhoneNotifierSubject 

// CMyLEDPhoneNotifierSubject

// CMyLEDLowBatteryNotifierSubject

// CMyLowBatteryNotifierSubject

// CMyAgendaNotifierSubject 

// CMyLEDAgendaNotifierSubject

// is created and registered in the list of notifiers owned by the manager class. 

// The basic tests performed are starting notifiers, updating notifiers and cancelling

// notifiers. Notifiers for phone, agenda and low battery can be requested. Each notifier

// has two channels visually displayed as a busy message and dialog in the middle of the

// screen. Updates are displayed along the bottom of the screen as info messages.

// Messages when starting agenda notifier asynchronously are displayed as info messages

// along the top of the screen. The notifiers have been assigned priorities with Low 

// Battery having the highest and Agenda the lowest. When a notifier is already displayed,

// and another request is called on a notifier with a higher notifier priority on the same 

// channel, the high priority notifier has focus, and the low priority notifier remains

// in the background where it can be updated. When a notifier is alreday displayed, and

// another request is called on a notifier with a lower priority on the same channel, 

// nothing happens until the high priority notifier is in an idle state.

// 2. The APIs:

// ------ class RNotifier

// TInt Connect()

// Creates a session to the extended notifier server, if the server isn't started already,

// it will be started, and the plug-in dll(s) will be loaded. Returns an error code.

// Tint StartNotifier(TUid aNotifierUid, const TDesC8& aBuffer,TDes8& aResponse)

// When started the two channels for a notifier appear as a busy message and dialog, 

// horizontally, in the middle of the display. The busy message on the left displays

// the contents of aBuffer.

// TInt CancelNotifier(TUid aNotifierUid)

// This removes the two channels from the screen

// TInt UpdateNotifier(TUid aNotifierUid,const TDesC8& aBuffer,TDes8& aResponse)

// When a notifier is already displayed and another request is called on a notifier with a higher priority

// on the same channel, the high priority notifier has focus and the low priority notifier

// remains in updated in the background. Updates are displayed as info messages along the

// bottom of the screen ---  an info message on the left displays the content of aBuffer

// and an info message on the right displays the content of aResponse. If an update is not

// possible because the notifier has not been started, then a suitable info message is

// displayed in the bottom right hand corner.

// void StartNotifierAndGetResponse(TRequestStatus& aRs,TUid aNotifierUid,

// const TDesC8& aBuffer,TDes8& aResponse)

// This function is only implemented for Agenda. Calling results in Agenda channels 

// displayed in the middle of screen as expected and an info message at the top left

// hand corner of the screen. If the call completes and returns, an info message displays

// aResponse at the top right hand corner of the screen.

// ------ class MEikSrvNotifierBase

// This is a mixin class and the following pure virtual functions from (eiknotapi.h) are

// implemented in the plug-in, (see tplugin.* files), for the notifiers

// virtual void Release()

// Called when all resources allocated by notifiers should be freed.

// TNotifierInfo RegisterL()

// Called when a notifier is first loaded to allow any initial construction 

// that is required.

// TNotifierInfo Info() const

// Packages the notifier info, contains public members:

// TUid iUid - The notifier's own uid (e.g KPhoneNotifierUid)

// TUid iChannel - a Uid specifying which channel the notifier uses

// TNotifierPriority iPriority - the priority channel

// TPtrC8 StartL(const TDesC8& aBuffer)

// Will be called by the manager to start the notifier, the contents of the 

// buffer are passed unchanged from RNotifier call (and in the test code displayed

// in the busy message representing the LED channel).

// void StartL(const TDesC8& aBuffer, const TAny* aReturnVal, RMessage aMessage)

// Same as above but asynchronous version. Response is returned to

// void StartNotifierAndGetResponse(TRequestStatus& aRs,TUid aNotifierUid,

// const TDesC8& aBuffer,TDes8& aResponse)

// by calling

// aMessage.WriteL(aReturnVal,descriptor).

// The test code calls

// StartL(const TDesC8& aBuffer), and then aMessage.WriteL(aReturnVal,descriptor),

// successful completion is noted by calling 

// aMessage.Complete(EEikNotExtRequestCompleted); 

// void Cancel()

// Will be called by the manager to stop the notifier. Nothing hapens when a call to

// cancel is made on a notifier that hasn't started. Calling cancel in the test code

// cancels the busy message and dialog channels.

// TPtrC8 UpdateL(const TDesC8& aBuffer)

// Will be called by the manager to update an already started notifier, the contents

// of aBuffer are passed unchanged from the RNotifier call and can be used by the notifier

// implementation. In the test code aBuffer is displayed as an info message at the

// bottom left hand corner of the screen. A response is returned to:

// TInt UpdateNotifier(TUid aNotifierUid,const TDesC8& aBuffer,TDes8& aResponse)

// 3. The test code does not check the error codes returned by StartNotifier, UpdateNotifier

// and CancelNotifier. Also code and checks for the responses from

// StartL(const TDesC8& aBuffer) are not implemented. Only three of the 5 priority levels

// a notifier can have are implemented.

// 

//

/**

 @file

 @test

 @internalComponent - Internal Symbian test code

*/

#include <basched.h>

#include <eikenv.h>

#include  "tnotdial.h"

#include "tpluginV2.h"

#include "tnotify2v2.h"

#include <techview/eikmenup.h>

#include <e32test.h>

#include "w32std.h"

#include <ecom/ecom.h>

// globals 

_LIT(KTNOTDIALResourceFilePath, "z:\\system\\test\\tnotdial\\tnotdial.rsc");

//

// Models

//

/**

   This method creates an empty control which provides the background for

   the test step.

 */

void CEmptyControl::ConstructL(const TRect& aRect)

	{

	CreateWindowL();

	SetRect(aRect);

	SetBlank();

	ActivateL();

	}

//

// class CTNotdialAppUi

//

CTNotdialAppUi::CTNotdialAppUi(CTmsTestStep* aTestStep) :

	CTestAppUi(aTestStep, KTNOTDIALResourceFilePath, R_TNOT_HOTKEYS, R_TDLG_MENUBAR, R_TDLG_TOOLBAR)

	{

	}

/**

   This method copies notifiers along with its resource file from ROM to RAM

   and connects to the extended notifier server. The method also creates an

   empty control and a periodic timer. Once all the construction is completed

   it prepares to execute the test step.

 */

void CTNotdialAppUi::ConstructL()

	{

	INFO_PRINTF1(_L("CTNotdialAppUi::ConstructL"));

	CTestAppUi::ConstructL();

	iEmptyControl=new(ELeave) CEmptyControl;

	iEmptyControl->ConstructL(ClientRect());

	INFO_PRINTF1(_L("iNotifier Connect"));

	User::LeaveIfError(iNotifier.Connect());

	iColor[0]=KRgbBlack;

	iColor[1]=KRgbBlack;

	iBattTimer = CPeriodic::NewL(CActive::EPriorityIdle);

	INFO_PRINTF1(_L("Start Auto Test"));

	iMyPhoneNotifierUid = KMyNewPhoneNotifierUid ;

	iMySmsNotifierUid = KMyNewSmsNotifierUid ;

	iMyEmailNotifierUid = KMyNewEmailNotifierUid;

	iMyLowBatteryNotifierUid =KMyNewLowBatteryNotifierUid ;

	iMyAgendaAlarmUid =KMyNewAgendaAlarmUid ;

	AutoTestManager().StartAutoTest();

	}

CTNotdialAppUi::~CTNotdialAppUi()

	{

	delete iEmptyControl;

	iNotifier.Close();

	if(iBattTimer->IsActive())

		{

		iBattTimer->Cancel();

		}

	delete iBattTimer;

	}

/**

   The method is an override from CTestAppUi. The method initiates tests on

   public APIs of RNotifier and  MEikSrvNotifierBase.

 */

void CTNotdialAppUi::RunTestStepL(TInt aNextStep)

	{

	switch(aNextStep)

		{

	case 1:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep01L"));

		TestStep01L();

		RecordTestResultL();

		break;

	case 2:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep02L"));

		TestStep02L();

		RecordTestResultL();

		break;

	case 3:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep03L"));

		TestStep03L();

		RecordTestResultL();

		break;

	case 4:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep04L"));

		TestStep04L();

		RecordTestResultL();

		break;

	case 5:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep05L"));

		TestStep05L();

		RecordTestResultL();

		break;

	case 6:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep06L"));

		TestStep06L();

		RecordTestResultL();

		break;

	case 7:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep07L"));

		TestStep07L();

		RecordTestResultL();

		break;

	case 8:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep08L"));

		TestStep08L();

		RecordTestResultL();

		break;

	case 9:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep09L"));

		TestStep09L();

		RecordTestResultL();

		break;

	case 10:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep10L"));

		TestStep10L();

		RecordTestResultL();

		break;

	case 11:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep11L"));

		TestStep11L();

		RecordTestResultL();

		break;

	case 12:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep12L"));

		TestStep12L();

		RecordTestResultL();

		break;

	case 13:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep13L"));

		TestStep13L();

		RecordTestResultL();

		break;

	case 14:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep14L"));

		TestStep14L();

		RecordTestResultL();

		break;

	case 15:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep15L"));

		TestStep15L();

		RecordTestResultL();

		break;

	case 16:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep16L"));

		TestStep16L();

		RecordTestResultL();

		break;

	case 17:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep17L"));

		TestStep17L();

		RecordTestResultL();

		break;

	case 18:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep18L"));

		TestStep18L();

		RecordTestResultL();

		break;

	case 19:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep19L"));

		TestStep19L();

		RecordTestResultL();

		break;

	case 20:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep20L"));

		TestStep20L();

		RecordTestResultL();

		break;

	case 21:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep21L"));

		TestStep21L();

		RecordTestResultL();

		break;

	case 22:

		TestStep22L();

		break;

	case 23:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep23L"));

		TestStep23L();

		RecordTestResultL();

		break;

	case 24:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep24L"));

		TestStep24L();

		RecordTestResultL();

		break;

	case 25:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep25L"));

		TestStep25L();

		RecordTestResultL();

		break;

	case 26:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep26L"));

		TestStep26L();

		RecordTestResultL();

		break;

	case 27:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep27L"));

		TestStep27L();

		RecordTestResultL();

		break;

	case 28:

		SetTestStepID(_L("UIF-TNotdialStep-TestStep28L"));

		TestStep28L();

		RecordTestResultL();

		break;

	case 29:

		SetTestStepID(_L("UIF-NotdialStep-TestStep29L"));

		TestStep29L();

		RecordTestResultL();

		break;

	case 30:

		SetTestStepID(_L("UIF-NotdialStep-TestStep30L"));

		TestStep30L();

		RecordTestResultL();

		break;

	case 31:

		SetTestStepID(_L("UIF-NotdialStep-TestStep31L"));

		TestStep31L();

		RecordTestResultL();

		break;

	case 32:

		SetTestStepID(_L("UIF-NotdialStep-TestStep32L"));

		TestStep32L();

		RecordTestResultL();

		CloseTMSGraphicsStep();

		break;

	case 33:

		{

		INFO_PRINTF1(_L("Last test case reached -> finishing!"));

		CTestAppUi::AutoTestManager().FinishAllTestCases(CAutoTestManager::EPass);

		}

	default:

		break;

		}

	INFO_PRINTF1(_L("Test case completed\n"));

	}

/**

  @SYMTestCaseID UIF-TNotdialStep-TestStep01L

  @SYMPREQ

  @SYMTestCaseDesc Test RNotifier::StartNotifier() & RNotifier::CancelNotifier()

  APIs.

  @SYMTestPriority High

  @SYMTestStatus Implemented

  @SYMTestActions The method calls CTNotdialAppUi::HandleCommandL() to test

  StartNotifier() & CancelNotifier() APIs for the following plug-in notifiers:

  (a) Phone Ring Notifier.

  (b) Low Battery Notifier.

  (c) Agenda Alarm Notifier.

  @SYMTestExpectedResults The test verifies whether StartNotifier() &

  CancelNotifier() method returns KErrNone on successful completion of

  function call.

 */

void CTNotdialAppUi::TestStep01L()

	{

	INFO_PRINTF1(_L(" ------------------------- Test Case 1:"));

	INFO_PRINTF1(_L("Start Phone Ring Notifier"));

	HandleCommandL(EAppRingPhone);

	INFO_PRINTF1(_L("Cancel Phone Ring Notifier"));

	HandleCommandL(EAppCancelRingPhone);

	INFO_PRINTF1(_L("Start Low Battery Notifier"));

	HandleCommandL(EAppLowBattery);

	INFO_PRINTF1(_L("Cancel Low Battery Notifier"));

	HandleCommandL(EAppCancelLowBattery);

	INFO_PRINTF1(_L("Start Agenda Alarm Notifier"));

	HandleCommandL(EAppAgendaAlarm);

	INFO_PRINTF1(_L("Cancel Agenda Alarm Notifier"));

	HandleCommandL(EAppCancelAgendaAlarm);

	}

/**

   @SYMTestCaseID UIF-TNotdialStep-TestStep02L

   @SYMPREQ

   @SYMTestCaseDesc Test cancelling the plug-in notifiers via dialog.

   @SYMTestPriority High

   @SYMTestStatus Implemented

   @SYMTestActions The test method starts the plug-in notifier by calling

   CTNotdialAppUi::HandleCommandL(). The test then connects to Windows Server

   and simulates an ENTER key event on the notifier dialog to cancel. This test

   is carried out for the following plug-in notifiers:

   (a) Phone Ring Notifier.

   (b) Low Battery Notifier.

   (c) Agenda Alarm Notifier.

   @SYMTestExpectedResults The tests should be able to simulate the ENTER Key

   for the notifier dialog and cancel the notifier.

 */

void CTNotdialAppUi::TestStep02L()

	{

	INFO_PRINTF1(_L(" ------------------------- Test Case 2:"));

	RWsSession ws;

	TKeyEvent event;

	//Set up key event "enter" to simulate key enter to replace clicking "ok" on dialog.

	event.iCode=event.iScanCode=EKeyEnter;

	event.iModifiers=event.iRepeats=0;

	//Connect to Window Server Session

	TEST(ws.Connect()==KErrNone);

	//Start Notifier

	INFO_PRINTF1(_L("Start Phone Ring Notifier"));

	HandleCommandL(EAppRingPhone);

	//Cancel Notifier using dialog

	INFO_PRINTF1(_L("Cancel Phone Ring Notifier via dialog"));

	// Simulate key entry and flush the buffer to send event to windows server session.

	ws.SimulateKeyEvent(event);

	ws.Flush();

	//Low battery notifier

	INFO_PRINTF1(_L("Start Low Battery Notifier"));

	HandleCommandL(EAppLowBattery);

	INFO_PRINTF1(_L("Cancel Low Battery Notifier via dialog"));

	ws.SimulateKeyEvent(event);

	ws.Flush();		

	//Agenda alarm notifier

	INFO_PRINTF1(_L("Start Agenda Alarm Notifier"));

	HandleCommandL(EAppAgendaAlarm);

	INFO_PRINTF1(_L("Cancel Agenda Alarm Notifier via dialog"));

	ws.SimulateKeyEvent(event);

	ws.Flush();

	ws.Close();

	}

/**

   @SYMTestCaseID UIF-TNotdialStep-TestStep03L

   @SYMPREQ

   @SYMTestCaseDesc Test RNotifier::UpdateNotifier() API.

   @SYMTestPriority High

   @SYMTestStatus Implemented

   @SYMTestActions The test method starts the plug-in notifier by calling

   RNotifier::StartNotifier(). It then calls CTNotdialAppUi::AppUpdate()

   method which calls RNotifier::UpdateNotifier() to update the plug-in

   notifier identified by the specified UID. The test then cancels the

   notifier. The test is carried out for the following plug-in notifiers:

   (a) Phone Ring Notifier.

   (b) Low Battery Notifier.

   (c) Agenda Alarm Notifier.

   @SYMTestExpectedResults The response received from RNotifier::UpdateNotifier()

   is verified and displayed.

  */

void CTNotdialAppUi::TestStep03L()

	{

	INFO_PRINTF1(_L(" ------------------------- Test Case 3:"));

	INFO_PRINTF1(_L("Start Low Battery Notifier"));

	HandleCommandL(EAppLowBattery);

	INFO_PRINTF1(_L("Update Low Battery Notifier"));

	HandleCommandL(EAppUpdateLowBattery);

	INFO_PRINTF1(_L("Cancel Low Battery Notifier"));

	HandleCommandL(EAppCancelLowBattery);