/*

* Copyright (c) 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: This module contains implementation of 

* RTestEngineServer class member functions.

*

*/

// INCLUDE FILES

#include <e32svr.h>

#include "TestEngineClient.h"

#include "TestEngineCommon.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES  

// None

// CONSTANTS

// None

// MACROS

// None

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

// None

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

/*

-------------------------------------------------------------------------------

    Class: RTestEngineServer

    Method: Connect

    Description: Connect method creates new RTestEngineServer session.

    RTestEngineServer session is used to manage the test case execution.

    Parameters: None

    Return Values: TInt KErrNone : TestEngineServer created successfully

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngineServer::Connect()

    {

    TInt ret = StartEngine();

    if ( ret == KErrNone)

        {

        ret = CreateSession( KTestEngineName, Version() );

        }

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngineServer

    Method: Version

    Description: Return client side version number from RTestEngineServer.

    Parameters: None

    Return Values: TVersion : Version number from RTestEngineServer

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TVersion RTestEngineServer::Version() const

    {

    return ( TVersion( KTestEngineMajorVersionNumber,

        KTestEngineMinorVersionNumber, KTestEngineBuildVersionNumber ) );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngineServer

    Method: Close

    Description: Closes the RTestEngineServer session.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C void RTestEngineServer::Close()

    {

    // Check that server is connected

    if ( Handle() != 0 )

        {

        TIpcArgs args( TIpcArgs::ENothing, TIpcArgs::ENothing, TIpcArgs::ENothing );

        SendReceive( ETestEngineServerCloseSession, args );

        }

    RSessionBase::Close();

    }

/*

-------------------------------------------------------------------------------

    DESCRIPTION

    This module contains implementation of RTestEngine class member functions.

-------------------------------------------------------------------------------

*/

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

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: Open

    Description: Open creates a subsession to TestEngine.

    Parameters: RTestEngineServer& aServer : Handle to Test Engine Server

                const TFileName& aIniFile : Ini file to be used for 

                 initialization of the Test Engine

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::Open( RTestEngineServer& aServer,

                                 const TFileName& aIniFile )

    {

    TIpcArgs args( &aIniFile, TIpcArgs::ENothing, TIpcArgs::ENothing );

    return CreateSubSession( aServer, ETestEngineCreateSubSession, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: Close

    Description: Close the RTestEngine subsession.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C void RTestEngine::Close()

    {

    RSubSessionBase::CloseSubSession( ETestEngineCloseSubSession );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: SetAttribute

    Description: Sets attributes to Test Framework

    Parameters: TAttribute aAttribute: in: Attribute type

                const TDesC& aValue: in: Attribute value

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Proposal

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::SetAttribute( TAttribute aAttribute,

                                          const TDesC& aValue )

    {

    TIpcArgs args( aAttribute, &aValue, TIpcArgs::ENothing );

    return SendReceive( ETestEngineSetAttribute, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: AddTestModule

    Description: Load dynamically a new Test Module to the Test Framework.

    Parameters: const TName& aTestModule : Name of the Test Module to be added

                const TFileName& aIniFile : Initialization file of Test Module

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::AddTestModule( const TName& aTestModule,

                                          const TFileName& aIniFile )

    {

    TIpcArgs args( &aTestModule, &aIniFile, TIpcArgs::ENothing );

    return SendReceive( ETestEngineAddTestModule, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: RemoveTestModule

    Description: Remove the existing Test Module from the Test Framework.

    Parameters: const TName& aTestModule : Name of the Test Module to be 

                                           removed

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::RemoveTestModule( const TName& aTestModule )

    {

    TIpcArgs args( &aTestModule, TIpcArgs::ENothing, TIpcArgs::ENothing );

    return SendReceive( ETestEngineRemoveTestModule, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: AddConfigFile

    Description: Add new config file to Test Module.

    Parameters: const TName& aTestModule : Name of Test Module where the config

                 file will be added

                const TFileName& aConfigFile : Name of config file to be added

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::AddConfigFile( const TName& aTestModule,

                                          const TFileName& aConfigFile )

    {

    TIpcArgs args( &aTestModule, &aConfigFile, TIpcArgs::ENothing );

    return SendReceive( ETestEngineAddConfigFile, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: RemoveConfigFile

    Description: Remove config file from Test Module.

    Parameters: const TName& aTestModule : Test Module name

                const TFileName& aConfigFile : Name of config file to be removed

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Proposal

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::RemoveConfigFile( const TName& aTestModule,

                                             const TFileName& aConfigFile )

    {

    TIpcArgs args( &aTestModule, &aConfigFile, TIpcArgs::ENothing );

    return SendReceive( ETestEngineRemoveConfigFile, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: EnumerateTestCases

    Description: First phase of two-phased test case query operation.

    Test cases are inquired by two-phased operation calling first the 

    EnumerateTestCases method and then the GetTestCases. 

    Parameters: TInt& aCount : Test case count

                TRequestStatus& aStatus : Request status

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C void RTestEngine::EnumerateTestCases( TCaseCount& aCount,

                                              TRequestStatus& aStatus )

    {

    TIpcArgs args( &aCount, TIpcArgs::ENothing, TIpcArgs::ENothing );

    SendReceive( ETestEngineEnumerateTestCases, args, aStatus );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: GetTestCases

    Description: Second phase of two-phased test case query operation.

    GetTestCases retrieves test cases from Test Modules to aTestCases that is

    a list consisting of several TTestInfo objects.

    Parameters: CArrayFixFlat<TTestInfo>& aTestCaseBuffer : Test case array

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::GetTestCases( 

                     CFixedFlatArray<TTestInfo>& aTestCaseBuffer )

    {

    // Construct and send message

    TIpcArgs args( &aTestCaseBuffer.Des(), TIpcArgs::ENothing, TIpcArgs::ENothing );

    return SendReceive( ETestEngineGetTestCases, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: ErrorNotification

    Description: Obtains error notifications from Test Engine and Test

    Servers via Test Engine.

    Parameters: TTestProgressPckg& aError : Error package

                TRequestStatus& aStatus : Request status

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/ 

EXPORT_C void RTestEngine::ErrorNotification( TErrorNotificationPckg& aError,

                                              TRequestStatus& aStatus )

    {

    TIpcArgs args( &aError, TIpcArgs::ENothing, TIpcArgs::ENothing );

    SendReceive( ETestEngineErrorNotification, args, aStatus );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: CancelAsyncRequest

    Description: Asynchronous requests can be canceled by this function.

    Parameters: TInt aReqToCancel : Request to be cancelled

    Return Values: TInt: Symbian OS error code

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::CancelAsyncRequest( TInt aReqToCancel )

    {

    TIpcArgs args( aReqToCancel, TIpcArgs::ENothing, TIpcArgs::ENothing );

    return SendReceive( ETestEngineCancelAsyncRequest, args );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: Event

    Description: Used to control STIF Test Framework event system.

    Parameters: TEventIfPckg& aEvent : in : Event information

                 TRequestStatus& aStatus : in :  Request status

    Return Values: TInt KErrNone : No errors occurred

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C void RTestEngine::Event( TEventIfPckg& aEvent, 

                                  TRequestStatus& aStatus )

    {

    TIpcArgs args( &aEvent, TIpcArgs::ENothing, TIpcArgs::ENothing );

    SendReceive( ETestEngineEvent, args, aStatus );

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine

    Method: OpenLoggerSession

    Description: Open created subsession to TestEngine.

    Parameters: RTestEngineServer& aServer : Handle to Test Engine Server

                TLoggerSettings& aLoggerSettings: in: Logger's overwrite struct

    Return Values: TInt KErrNone: TestEngine opened and initialized

                                  succesfully

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt RTestEngine::OpenLoggerSession( RTestEngineServer& aServer, 

                                            TLoggerSettings& aLoggerSettings )

    {

    // Package

    TPckg<TLoggerSettings> loggerSettingsPckg( aLoggerSettings );

    TIpcArgs args( &loggerSettingsPckg, TIpcArgs::ENothing, TIpcArgs::ENothing );

    // Goes to CTestEngine's DispatchMessageL() method

    CreateSubSession( aServer, ETestEngineLoggerSettings, args );

    RSubSessionBase::CloseSubSession( ETestEngineCloseLoggerSettings );

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: RTestEngine