/*

* Copyright (c) 2002 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:  ?Description

*

*/

// INCLUDE FILES

#include <e32math.h>

#include <mediatorpluginbase.h>

#include "MediatorTest.h"

#include "mediatortestdata.h"

using namespace MediatorService;

// EXTERNAL DATA STRUCTURES

//extern  ?external_data;

// EXTERNAL FUNCTION PROTOTYPES  

//extern ?external_function( ?arg_type,?arg_type );

// CONSTANTS

//const ?type ?constant_var = ?constant;

const TInt KTestUid = 0x101FB3E7;

const TInt KTestEventId = 1000;

const TInt KNonExistingDomainId = 999;

const TInt KReallyNonExistingDomainId = 1234567;

const TInt KNonExistingCategoryId = 99;

const TInt KNonExistingEventId = 99999;

const TInt KExistingEventId = 50;

const TInt KOtherUid = 0x00000124;           // static domain defined in StaticEvents.rss

const TInt KOtherSIDCategory = 0x00006767;   // static category defined in StaticEvents.rss

const TInt KOtherSIDEventId = 12;            // static event defined in StaticEvents.rss

const TInt KNonExistingEventCapaId = 5;

const TInt KMinListId = 1;

const TInt KMaxListId = 99;

//const TInt KNonExistingCapsEventId = 889;

const TInt KDefaultCommandId = 1000;

const TInt KDefaultTimeOut = 3000; // 3 seconds

const TInt KInvalidCommandId = 99999;

const TInt KDataSize = 2000;

const TInt KSecondaryCommandId = 700;

const TInt KMinDomainID = 200100;

const TInt KMidDomainID = 200150;

const TInt KMaxDomainID = 200660;

// MACROS

//#define ?macro ?macro_def

// LOCAL CONSTANTS AND MACROS

//const ?type ?constant_var = ?constant;

//#define ?macro_name ?macro_def

// MODULE DATA STRUCTURES

//enum ?declaration

//typedef ?declaration

// LOCAL FUNCTION PROTOTYPES

//?type ?function_name( ?arg_type, ?arg_type );

// FORWARD DECLARATIONS

//class ?FORWARD_CLASSNAME;

// ============================= LOCAL FUNCTIONS ===============================

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

// ?function_name ?description.

// ?description

// Returns: ?value_1: ?description

//          ?value_n: ?description_line1

//                    ?description_line2

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

//

/*

?type ?function_name(

    ?arg_type arg,  // ?description

    ?arg_type arg)  // ?description

    {

    ?code  // ?comment

    // ?comment

    ?code

    }

*/

// ============================ MEMBER FUNCTIONS ===============================

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

// CMediatorTest::Case

// Returns a test case by number.

//

// This function contains an array of all available test cases 

// i.e pair of case name and test function. If case specified by parameter

// aCaseNumber is found from array, then that item is returned.

// 

// The reason for this rather complicated function is to specify all the

// test cases only in one place. It is not necessary to understand how

// function pointers to class member functions works when adding new test

// cases. See function body for instructions how to add new test case.

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

//

const TCaseInfo CMediatorTest::Case ( 

    const TInt aCaseNumber ) const 

     {

    /**

    * To add new test cases, implement new test case function and add new 

    * line to KCases array specify the name of the case and the function 

    * doing the test case

    * In practice, do following

    * 1) Make copy of existing test case function and change its name

    *    and functionality. Note that the function must be added to 

    *    MediatorTest.cpp file and to MediatorTest.h 

    *    header file.

    *

    * 2) Add entry to following KCases array either by using:

    *

    * 2.1: FUNCENTRY or ENTRY macro

    * ENTRY macro takes two parameters: test case name and test case 

    * function name.

    *

    * FUNCENTRY macro takes only test case function name as a parameter and

    * uses that as a test case name and test case function name.

    *

    * Or

    *

    * 2.2: OOM_FUNCENTRY or OOM_ENTRY macro. Note that these macros are used

    * only with OOM (Out-Of-Memory) testing!

    *

    * OOM_ENTRY macro takes five parameters: test case name, test case 

    * function name, TBool which specifies is method supposed to be run using

    * OOM conditions, TInt value for first heap memory allocation failure and 

    * TInt value for last heap memory allocation failure.

    * 

    * OOM_FUNCENTRY macro takes test case function name as a parameter and uses

    * that as a test case name, TBool which specifies is method supposed to be

    * run using OOM conditions, TInt value for first heap memory allocation 

    * failure and TInt value for last heap memory allocation failure. 

    */ 

    static TCaseInfoInternal const KCases[] =

        {

        // To add new test cases, add new items to this array

        // Example how to use OOM functionality

        //OOM_ENTRY( "Loop test with OOM", LoopTest, ETrue, 2, 3 ),

        //OOM_FUNCENTRY( PrintTest, ETrue, 1, 3 ),

        };

    // Verify that case number is valid

    if( (TUint) aCaseNumber >= sizeof( KCases ) / 

                               sizeof( TCaseInfoInternal ) )

        {

        // Invalid case, construct empty object

        TCaseInfo null( (const TText*) L"" );

        null.iMethod = NULL;

        null.iIsOOMTest = EFalse;

        null.iFirstMemoryAllocation = 0;

        null.iLastMemoryAllocation = 0;

        return null;

        } 

    // Construct TCaseInfo object and return it

    TCaseInfo tmp ( KCases[ aCaseNumber ].iCaseName );

    tmp.iMethod = KCases[ aCaseNumber ].iMethod;

    tmp.iIsOOMTest = KCases[ aCaseNumber ].iIsOOMTest;

    tmp.iFirstMemoryAllocation = KCases[ aCaseNumber ].iFirstMemoryAllocation;

    tmp.iLastMemoryAllocation = KCases[ aCaseNumber ].iLastMemoryAllocation;

    return tmp;

    }

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

// CMediatorTest::PrintTest

// Simple printing to UI test.

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

//

TInt CMediatorTest::PrintTest( 

    TTestResult& aResult )

    {

     /* Simple print test */

    _LIT( KPrintTest, "PrintTest" );

    _LIT( KEnter, "Enter" );

    _LIT( KOnGoing, "On-going" );

    _LIT( KExit, "Exit" );

    TestModuleIf().Printf( 0, KPrintTest, KEnter );

    TestModuleIf().Printf( 1, KPrintTest, KOnGoing );

    TestModuleIf().Printf( 0, KPrintTest, KExit );

    // Test case passed

    // Sets test case result and description(Maximum size is KStifMaxResultDes)

    _LIT( KDescription, "PrintTest passed" );

    aResult.SetResult( KErrNone, KDescription );

    // Case was executed

    return KErrNone;

    }

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

// CMediatorTest::LoopTest

// Another printing to UI test.

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

//

TInt CMediatorTest::LoopTest( TTestResult& aResult )

    {

    /* Simple print and wait loop */

    _LIT( KState, "State" );

    _LIT( KLooping, "Looping" );

    TestModuleIf().Printf( 0, KState, KLooping );

    _LIT( KRunning, "Running" );

    _LIT( KLoop, "%d" );

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

        {

        TestModuleIf().Printf( 1, KRunning, KLoop, i);

        User::After( 1000000 );

        }

    _LIT( KFinished, "Finished" );

    TestModuleIf().Printf( 0, KState, KFinished );

    // Test case passed

    // Sets test case result and description(Maximum size is KStifMaxResultDes)

    _LIT( KDescription, "LoopTest passed" );

    aResult.SetResult( KErrNone, KDescription );

    // Case was executed

    return KErrNone;

    }

////////////////////////////////////////////////////////////////////////////////

//

// M E D I A T O R      T E S T S ->

//

//

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

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

// CMediatorTest::RegisterOneEvent

//

// Register one event in Mediator

// Expected precondition: No event created previously

// Expected behaviour: Registration succeed

// Cleaning: Unregister event

//

// Domain: KTestUid

// Category: KTestUid

// Event ID: KTestEventId

// 

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

//

TInt CMediatorTest::RegisterOneEvent( TTestResult& aResult )

    {    

    TInt status( KErrNone );

    TUid myUid = TUid::Uid( KTestUid );

    TCapabilitySet caps;

    caps.SetEmpty();

    status = iEventProvider->RegisterEvent( myUid, 

                                            myUid,

                                            KTestEventId,

                                            iDefaultVersion,

                                            caps ) ;        

    _LIT( KDescription, "RegisterEvent returns with" );

    aResult.SetResult( status, KDescription ); // set status as test result

    if( KErrNone == status  )

        {

        /* Registration succeeded -> Clean Event */

        TInt cleanStatus = CleanRegisterOneEvent( myUid, myUid, KTestEventId ); 

        if( KErrNone != cleanStatus )

            {

            _LIT( KDescription, "Test passed but cleaning failed" );

            aResult.SetResult( cleanStatus, KDescription );     

            }

        }

    return KErrNone;

    }

TInt CMediatorTest::CleanRegisterOneEvent( TUid aDomain, TUid aCategory, TInt aEventId )

    {

    return iEventProvider->UnregisterEvent( aDomain, 

                                            aCategory,

                                            aEventId );  

    }

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

// CMediatorTest::RegisterMultipleEvents

//

// Register 50 events in Mediator

// Expected precondition: No events created previously

// Expected behaviour: Registration succeed

// Cleaning: Unregister events

//

// Domain: KTestUid

// Category: KTestUid

// Event IDs: 50 - 99

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

//

TInt CMediatorTest::RegisterMultipleEventsL( TTestResult& aResult )

    {

    TInt status( KErrNone );

    TUid myUid = TUid::Uid( KTestUid );

    TCapabilitySet caps;

    caps.SetEmpty();    

    REventList eventList;

    CleanupClosePushL( eventList );

    for( TInt i=50; i<100; i++ ) // i = Event ID

        {

        TEvent newEvent;

        newEvent.iEventId = i;

        newEvent.iVersion = iDefaultVersion;

        newEvent.iCaps = caps;  

        eventList.AppendL( newEvent );

        }

    status = iEventProvider->RegisterEvent( myUid, 

                                            myUid,

                                            eventList);

    _LIT( KDescription, "RegisterEvent returns with" );

    aResult.SetResult( status, KDescription );

    if( KErrNone == status  )

        {

        /* Registration succeeded -> Clean Event */

        TInt cleanStatus = CleanRegisterMultipleEvents( myUid, myUid, eventList ); 

        if( KErrNone != cleanStatus )

            {

            _LIT( KDescription, "Test passed but cleaning failed" );

            aResult.SetResult( cleanStatus, KDescription );     

            }

        }

    CleanupStack::PopAndDestroy( &eventList );

    return KErrNone;

    }

TInt CMediatorTest::CleanRegisterMultipleEvents( TUid aDomain, TUid aCategory, REventList& aEventList )

    {

    return iEventProvider->UnregisterEvent( aDomain, 

                                            aCategory,

                                            aEventList );

    }

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

// CMediatorTest::RegisterOver500Events

//

// Register over 500 events

// Expected precondition: No events created previously

// Expected behaviour: Registration succeed

// Cleaning: Unregister events

//

// Domain: KTestUid

// Category: KTestUid

// Event IDs: 100 - 699

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

//       

TInt CMediatorTest::RegisterOver500EventsL( TTestResult& aResult )

    {

    TInt status( KErrNone );

    TUid myUid = TUid::Uid( KTestUid );

    TCapabilitySet caps;

    caps.SetEmpty();

    REventList eventList;

    CleanupClosePushL( eventList );

    for( TInt i=100; i<700; i++ ) // i = event ID

        {

        TEvent newEvent;

        newEvent.iEventId = i;

        newEvent.iVersion = iDefaultVersion;

        newEvent.iCaps = caps;    

        eventList.AppendL( newEvent );

        }

    status = iEventProvider->RegisterEvent( myUid, 

                                            myUid,

                                            eventList);

    _LIT( KDescription, "RegisterEvent returns with" );

    aResult.SetResult( status, KDescription );  // status is returned as test result

    if( KErrNone == status  )

        {

        /* Registration succeeded -> Clean Events */

        TInt cleanStatus = CleanRegisterOver500Events(myUid, myUid, eventList);  

        if( KErrNone != cleanStatus)

            {

            _LIT( KDescription, "Test passed but cleaning failed" );

            aResult.SetResult( cleanStatus, KDescription );     

            }

        }

    CleanupStack::PopAndDestroy( &eventList );

    return KErrNone;

    }

TInt CMediatorTest::CleanRegisterOver500Events( TUid aDomain, TUid aCategory, REventList aEventList )

    {

    TInt status = iEventProvider->UnregisterEvent( aDomain, 

                                                   aCategory,

                                                   aEventList );