/*

* Copyright (c) 2008 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:  EUnit module test class for CPS Wrapper

*

*/

// System include files

#include <hsccapiclient.h>

#include <hscontentcontrol.h>

#include <hscontentinfo.h>

#include <hscontentinfoarray.h>

#include <ccresource.h>

// User include files

#include "mthsccapiclient.h"

// Local constants

_LIT8( KInfoTypeWidget, "widget" );

_LIT8( KInfoTypeTemplate, "template" );

_LIT8( KInfoTypeView, "view" );

_LIT8( KInfoTypeApp, "application" );

_LIT8( KTemplateViewUid, "0x20026f50" );

_LIT8( KHsViewUid, "0x2001f48b" );

_LIT8( KDesktopWidgetUid, "0x20026f4f" );

_LIT8( KNotFoundAppUid, "0xffffffff" );

_LIT8( KNotFoundViewUid, "0xffffffff" );

_LIT8( KNotFoundWidgetUid, "0xffffffff" );

_LIT8( KNotFoundViewPluginId, "999" );

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

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

// CMTHsCcApiClient::NewL()

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

//

CMTHsCcApiClient* CMTHsCcApiClient::NewL()

    {

    CMTHsCcApiClient* self = new ( ELeave ) CMTHsCcApiClient();

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CMTHsCcApiClient::ConstructL()

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

//

void CMTHsCcApiClient::ConstructL()

    {

    // The ConstructL from the base class CEUnitTestSuiteClass must be called.

    // It generates the test case table.

    CEUnitTestSuiteClass::ConstructL();

    }

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

// CMTHsCcApiClient::CMTHsCcApiClient()

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

//

CMTHsCcApiClient::CMTHsCcApiClient()

    :iApiClient( NULL )

    {

    }

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

// CMTHsCcApiClient::~CMTHsCcApiClient()

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

//

CMTHsCcApiClient::~CMTHsCcApiClient()

    {

    delete iApiClient;

    }

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

// CMTHsCcApiClient::SetupL()

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

//

void CMTHsCcApiClient::SetupL()

    {

    iWidgetListNtfExpected = EFalse;

    iWidgetListNtfReceived = EFalse;

    iViewListNtfExpected = EFalse;

    iViewListNtfReceived = EFalse;

    iAppListNtfExpected = EFalse;

    iAppListNtfReceived = EFalse;

    if ( iApiClient )

        {

        delete iApiClient;

        iApiClient = NULL;

        }

    iApiClient = CHsCcApiClient::NewL( NULL );

    // Remove all removable views from Home screen

    CHsContentInfo* app = CHsContentInfo::NewL();

    CleanupStack::PushL( app );

    iApiClient->ActiveAppL( *app );

    CHsContentInfoArray* views = CHsContentInfoArray::NewL();

    CleanupStack::PushL( views );

    iApiClient->ViewListL( *app, *views );

    for ( TInt i = 0; i < views->Array().Count(); i++ )

        {

        CHsContentInfo* info = views->Array()[ i ];

        if ( info->CanBeRemoved() )

            {

            iApiClient->RemoveViewL( *info );

            }

        }

    CleanupStack::PopAndDestroy( views );

    // Remove all removable widgets from Home screen

    CHsContentInfoArray* widgets = CHsContentInfoArray::NewL();

    CleanupStack::PushL( widgets );

    iApiClient->WidgetListL( *app, *widgets );

    for ( TInt i = 0; i < widgets->Array().Count(); i++ )

        {

        CHsContentInfo* info = widgets->Array()[ i ];

        if ( info->CanBeRemoved() )

            {

            iApiClient->RemoveWidgetL( *info );

            }

        }

    CleanupStack::PopAndDestroy( widgets );

    CleanupStack::PopAndDestroy( app );

    delete iApiClient;

    iApiClient = NULL;

    }

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

// CMTHsCcApiClient::Teardown()

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

//

void CMTHsCcApiClient::Teardown()

    {

    }

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

// CMTHsCcApiClient::NotifyWidgetListChanged()

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

//

void CMTHsCcApiClient::NotifyWidgetListChanged()

    {

    if ( iWidgetListNtfExpected )

        {

        iWidgetListNtfReceived = ETrue;

        iWait.AsyncStop();

        }

    }

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

// CMTHsCcApiClient::NotifyViewListChanged()

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

//

void CMTHsCcApiClient::NotifyViewListChanged()

    {

    if ( iViewListNtfExpected )

        {

        iViewListNtfReceived = ETrue;

        iWait.AsyncStop();

        }

    }

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

// CMTHsCcApiClient::NotifyAppListChanged()

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

//

void CMTHsCcApiClient::NotifyAppListChanged()

    {

    if ( iAppListNtfExpected )

        {

        iAppListNtfReceived = ETrue;

        iWait.AsyncStop();

        }

    }

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

// CMTHsCcApiClient::ConnectHsCcApiClientL()

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

//

void CMTHsCcApiClient::ConnectHsCcApiClientL( MHsContentControl* aObserver )

    {

    iApiClient = CHsCcApiClient::NewL( aObserver );

    }

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

// CMTHsCcApiClient::DisconnectHsCcApiClient()

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

//

void CMTHsCcApiClient::DisconnectHsCcApiClient()

    {

    delete iApiClient;

    iApiClient = NULL;

    }

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

// CMTHsCcApiClient::AddViewL()

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

//

CHsContentInfo* CMTHsCcApiClient::AddViewL(

    const TDesC8& aUid )

    {

    CHsContentInfo* info = GetViewL( NULL, aUid );

    CleanupStack::PushL( info );

    TInt err = iApiClient->AddViewL( *info );

    User::LeaveIfError( err );

    CleanupStack::PopAndDestroy( info );

    info = NULL;

    CHsContentInfo* app = CHsContentInfo::NewL();

    CleanupStack::PushL( app );

    err = iApiClient->ActiveAppL( *app );

    User::LeaveIfError( err );

    info = GetViewL( app, aUid );

    CleanupStack::PopAndDestroy( app );

    User::LeaveIfNull( info );

    return info;

    }

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

// CMTHsCcApiClient::AddWidgetL()

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

//

CHsContentInfo* CMTHsCcApiClient::AddWidgetL(

    const TDesC8& aUid )

    {

    CHsContentInfo* info = GetWidgetL( NULL, aUid );

    CleanupStack::PushL( info );

    TInt err = iApiClient->AddWidgetL( *info );

    User::LeaveIfError( err );

    CleanupStack::PopAndDestroy( info );

    info = NULL;

    CHsContentInfo* view = CHsContentInfo::NewL();

    CleanupStack::PushL( view );

    err = iApiClient->ActiveViewL( *view );

    User::LeaveIfError( err );

    info = GetWidgetL( view, aUid );

    CleanupStack::PopAndDestroy( view );

    User::LeaveIfNull( info );

    return info;

    }

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

// CMTHsCcApiClient::GetViewL()

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

//

CHsContentInfo* CMTHsCcApiClient::GetViewL(

    CHsContentInfo* aApp,

    const TDesC8& aUid )

    {

    CHsContentInfoArray* views = CHsContentInfoArray::NewL();

    CleanupStack::PushL( views );

    TInt err( KErrNone );

    if ( aApp )

        {

        err = iApiClient->ViewListL( *aApp, *views );

        }

    else

        {

        err = iApiClient->ViewListL( *views );

        }

    User::LeaveIfError( err );

    CHsContentInfo* info = NULL;

    for ( TInt i = 0; i < views->Array().Count() && !info; i++ )

        {

        if ( views->Array()[ i ]->Uid().CompareF( aUid ) == 0 )

            {

            info = views->Array()[ i ];

            views->Array().Remove( i );

            break;

            }

        }

    CleanupStack::PopAndDestroy( views );

    User::LeaveIfNull( info );

    return info;

    }

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

// CMTHsCcApiClient::GetWidgetL()

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

//

CHsContentInfo* CMTHsCcApiClient::GetWidgetL(

    CHsContentInfo* aView,

    const TDesC8& aUid )

    {

    CHsContentInfoArray* widgets = CHsContentInfoArray::NewL();

    CleanupStack::PushL( widgets );

    TInt err( KErrNone );

    if ( aView )

        {

        err = iApiClient->WidgetListL( *aView, *widgets );

        }

    else

        {

        err = iApiClient->WidgetListL( *widgets );

        }

    User::LeaveIfError( err );

    CHsContentInfo* info = NULL;

    for ( TInt i = 0; i < widgets->Array().Count() && !info; i++ )

        {

        if ( widgets->Array()[ i ]->Uid().CompareF( aUid ) == 0 )

            {

            info = widgets->Array()[ i ];

            widgets->Array().Remove( i );

            break;

            }

        }

    CleanupStack::PopAndDestroy( widgets );

    User::LeaveIfNull( info );

    return info;

    }

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

// CMTHsCcApiClient::ConnectDisconnectHsCcApiClientL()

// 

// Test purpose:

// The purpose of this test case is to verify that a connection to the

// Home screen Content Control server is successfully established and 

// closed via Home screen Content Control API client when the api observer

// is not defined

//

// Pre conditions (SetupL()):

// Empty homescreen

//

// Test step 1:

// Create CHsCcApiClient

//

// Expected result:

// Connection is successfully established

//

// Test step 2:

// Delete CHsCcApiClient

//

// Expected result:

// Connection is successfully closed

//

// Post conditions (Teardown()):

// -

//

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

//

void CMTHsCcApiClient::ConnectDisconnectHsCcApiClientL()

    {

    // Test step 1

    ConnectHsCcApiClientL( NULL );

    // Test step 2

    DisconnectHsCcApiClient();

    }

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

// CMTHsCcApiClient::RegisterUnregisterHsCcApiObserverL()

// 

// Test purpose:

// The purpose of this test case is to verify that a connection to the

// Home screen Content Control server is successfully established and 

// closed via Home screen Content Control API client when the api observer

// is defined

//

// Pre conditions (SetupL()):

// Empty homescreen

//

// Test step 1:

// Create CHsCcApiClient

//

// Expected result:

// Connection is successfully established and 

// observation is successfully started

//

// Test step 2:

// Delete CHsCcApiClient

//

// Expected result:

// Connection is successfully closed

//

// Post conditions (Teardown()):

// -

//

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

//

void CMTHsCcApiClient::RegisterUnregisterHsCcApiObserverL()

    {

    // Test step 1

    ConnectHsCcApiClientL( this );

    // Test step 2

    DisconnectHsCcApiClient();

    }

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

// CMTHsCcApiClient::RegisterUnregisterMultipleObserversL()

// 

// Test purpose:

// The purpose of this test case is to verify that multiple connections to 

// the Home screen Content Control server are successfully established and 

// closed via Home screen Content Control API client when the api observer

// is defined

//

// Pre conditions (SetupL()):

// Empty homescreen

//

// Test step 1:

// Create CHsCcApiClient

//

// Expected result:

// Connection is successfully established and 

// observation is successfully started

//

// Test step 2

// Create additional connection 1

//

// Expected result:

// Connection is successfully established and 

// observation is successfully started

//

// Test step 3

// Create additional connection 2

//

// Expected result:

// Connection is successfully established and 

// observation is successfully started

//

// Test step 4:

// Delete additional connection 1

//

// Expected result:

// Connection is successfully closed

//

// Test step 5:

// Delete additional connection 2

//

// Expected result:

// Connection is successfully closed

//

// Test step 6:

// Delete CHsCcApiClient

//

// Expected result:

// Connection is successfully closed

//

// Post conditions (Teardown()):

// -

//

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

//

void CMTHsCcApiClient::RegisterUnregisterMultipleObserversL()

    {

    // Test step 1

    ConnectHsCcApiClientL( this );

    // Test step 2

    CHsCcApiClient* addClient1 = CHsCcApiClient::NewL( this );

    CleanupStack::PushL( addClient1 );

    // Test step 3

    CHsCcApiClient* addClient2 = CHsCcApiClient::NewL( this );

    // Test step 4

    CleanupStack::PopAndDestroy( addClient1 );

    // Test step 5

    delete addClient2;

    // Test step 6

    DisconnectHsCcApiClient();

    }

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

// CMTHsCcApiClient::WidgetListL()

// 

// Test purpose:

// The purpose of this test case is to verify that a correct list of

// widgets is returned

//

// Pre conditions (SetupL()):

// Empty homescreen

//

// Test step 1:

// Create CHsCcApiClient

//

// Expected result:

// Connection is successfully established

//

// Test step 2:

// Get widget list

//

// Expected result:

// Content info list with widget or template type content info

//

// Test step 3:

// Delete CHsCcApiClient

//

// Expected result:

// Connection is successfully closed

//