/*

* 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: CStifTFwIf: This object executes test cases from 

* STIF Test Framework.

*

*/

// INCLUDE FILES

#include <e32base.h>

#include <e32svr.h>

#include "UIEngineEvent.h"

#include <stifinternal/UIEngineContainer.h>

#include "StifTFwIf.h"

#include "StifTFw.h"

#include "Logging.h"

#include "StifPython.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES

// None

// CONSTANTS

// None

// MACROS

#ifdef LOGGER

#undef LOGGER

#endif

#define LOGGER iStifTFw->iLogger

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

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

/*

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

    Class: CStifTFwIf

    Method: CStifTFwIf

    Description: Default constructor

    C++ default constructor can NOT contain any code, that

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C CStifTFwIf::CStifTFwIf()

    {

    __RDEBUG( _L( "CStifTFwIf::CStifTFwIf()" ) );

    }

/*

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

    Class: CStifTFwIf

    Method: ~CStifTFwIf

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C CStifTFwIf::~CStifTFwIf()

    {

    __RDEBUG( _L( "CStifTFwIf::~CStifTFwIf()" ) );

    }

/*

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

    Class: CStifTFwIf

    Method: Open

    Description: Open test engine.

    Parameters: TDesC& aTestFrameworkIni: in: Initialization file to Test Framework

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::Open( TDesC& aTestFrameworkIni )

    {

    RDebug::Print(_L("CStifTFwIf::Open"));

    TInt err( KErrNone );

    TRAP( err,

        iStifTFw = CStifTFw::NewL( this );

        )

    return iStifTFw->iUIEngine->Open( aTestFrameworkIni );

    }

/*

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

    Class: CStifTFwIf

    Method: Close

    Description: Close test engine.

    Parameters: None

    Return Values: TInt KErrNone: Always returned KErrNone

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::Close()

    {

    RDebug::Print(_L("CStifTFwIf::Close"));

    iStifTFw->DeleteData(); //Delete objects before closing session to TestEngine server

    iStifTFw->iUIEngine->Close();

    delete iStifTFw;

    iStifTFw = 0;

    return KErrNone;

    }

/*

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

    Class: CStifTFwIf

    Method: SetAttribute

    Description: Used to set attributes for Test Framework.

    Parameters: TAttribute aAttribute: in: Attribute type

                TDesC& aValue: in: Attribute value

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Proposal

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

*/

EXPORT_C TInt CStifTFwIf::SetAttribute( TAttribute aAttribute,

                                        const TDesC& aValue )

    {

    RDebug::Print(_L("CStifTFwIf::SetAttribute"));

    // Check aValue max length

    if( aValue.Length() > KMaxName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CStifTFwIf::SetAttribute() method's second parameter length is incorrect" ) ) );

        return KErrArgument;

        }

    TInt ret = iStifTFw->iUIEngine->TestEngine().SetAttribute( aAttribute, aValue );

    if ( ret != KErrNone )

        {

        __TRACE( KPrint, ( _L( "CStifTFwIf::SetAttribute() method fails with error:%d" ), ret  ) );

        return ret;

        }

    return KErrNone;

    }

/*

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

    Class: CStifTFwIf

    Method: AddTestModule

    Description: Add test module to module list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which is added to module list

                TDesC& aIniFile: in: Initialization file to the test module

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::AddTestModule( TDesC& aModuleName,

                                         TDesC& aIniFile )

    {

    RDebug::Print(_L("CStifTFwIf::AddTestModule"));

    return iStifTFw->iUIEngine->AddTestModule( aModuleName, aIniFile );

    }

/*

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

    Class: CStifTFwIf

    Method: RemoveTestModule

    Description: Add test module to module list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which is removed of module list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::RemoveTestModule( TDesC& aModuleName )

    {

    RDebug::Print(_L("CStifTFwIf::RemoveTestModule"));

    return iStifTFw->iUIEngine->RemoveTestModule( aModuleName );

    }

/*

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

    Class: CStifTFwIf

    Method: AddTestCaseFile

    Description: Add test case file to test case file list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which own test cases of test case list.

                TDesC& aCaseFile: in: Test case list, which is added to test case list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::AddTestCaseFile( TDesC& aModuleName, TDesC& aCaseFile )

    {

    RDebug::Print(_L("CStifTFwIf::AddTestCaseFile"));

    return iStifTFw->iUIEngine->AddTestCaseFile( aModuleName, aCaseFile );

    }

/*

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

    Class: CStifTFwIf

    Method: RemoveTestCaseFile

    Description: Remove test case file of test case file list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which own test cases of test case list

                TDesC& aCaseFile: in: Test case list, which is removed of test case list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::RemoveTestCaseFile( TDesC& aModuleName, TDesC& aCaseFile )

    {

    RDebug::Print(_L("CStifTFwIf::RemoveTestCaseFile"));

    return iStifTFw->iUIEngine->RemoveTestCaseFile( aModuleName, aCaseFile );

    }

/*

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

    Class: CStifTFwIf

    Method: GetTestCases

    Description: Get test cases of enumerated list of test engine. Method is copied

                 list of test cases to aTestCaseInfo. Copied tests are test cases

                 of test module (aTestModule) and defined

                 in test case file (aTestCaseFile), which are given as argument

                 Method copied all enumerated test cases if aTestModule

                 and aTestCaseFile are not defined

    Parameters: RPointerArray<CTestInfo>& aTestCaseInfo: inout: List of test cases

                TDesC& aModuleName: in: Testmodule, which own test cases of test case list

                TDesC& aTestCaseFile: in: Test case list, which is got of test case list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::GetTestCases( RPointerArray<CTestInfo>& aTestCaseInfo,

                                        TDesC& aTestModule,

                                        TDesC& aTestCaseFile )

    {

    RDebug::Print(_L("CStifTFwIf::GetTestCases"));

    TRAPD( ret,

        ret = iStifTFw->iUIEngine->GetTestCasesL( aTestCaseInfo,

                                                  aTestModule,

                                                  aTestCaseFile );

        );

    return ret;

    }

/*

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

    Class: CStifTFwIf

    Method: StartTestCase

    Description: Start test case execution.

    Parameters: TInt& aTestId: in: ID for test case. Test ID given of address of

                current CStifTFwIfContainer.

                const CTestInfo& aTestInfo: in: Test case information

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::StartTestCase( TInt& aTestId,

                                         const CTestInfo& aTestInfo )

    {

    RDebug::Print(_L("CStifTFwIf::StartTestCase"));

    CUIEngineContainer* container = NULL;

    TInt ret = iStifTFw->iUIEngine->StartTestCase( container,

                                                   aTestInfo );

    if( ret != KErrNone )

        {

        return ret;

        }

    // Add container to test case execution table

    ret = iStifTFw->iTestExecutionTable.Append( container );

    if( ret != KErrNone )

        {

        iStifTFw->iUIEngine->AbortStartedTestCase( container );

        return ret;

        }

    // Get test id.

    aTestId = (TInt)container;

    __TRACE( KPrint, (  _L( "aTestId: %d"), aTestId ) );

    __TRACE( KPrint, (  _L( "aTest case: %S"), &(aTestInfo.TestCaseTitle()) ) );

    return ret;

    }

/*

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

    Class: CStifTFwIf

    Method: CancelTestCase

    Description: Cancel test case execution

    Parameters: TInt& aTestId: in: ID for test case

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::CancelTestCase( TInt aTestId )

    {

    RDebug::Print(_L("CStifTFwIf::CancelTestCase"));

    TInt ret(KErrNone);

    // Find test case from execution table

    TInt index = iStifTFw->iTestExecutionTable.Find( ( CUIEngineContainer* )aTestId );

    // Check if test id is found

    if( index < 0)

        {

        __TRACE( KPrint, (  _L( "CStifTFwIf::CancelTestCase. Container not found. TestId = %d"), aTestId ) );

        return index;

        }

    // Cancel test

    ret = iStifTFw->iTestExecutionTable[index]->CancelTest();

    __TRACE( KPrint, (  _L( "CStifTFwIf::CancelTestCase. Canceled testId %d"), aTestId ) );

    return ret;

    }

/*

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

    Class: CStifTFwIf

    Method: PauseTestCase

    Description: Pause test case execution

    Parameters: TInt& aTestId: in: ID for test case

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

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

*/

EXPORT_C TInt CStifTFwIf::PauseTestCase(  TInt aTestId  )

    {

    RDebug::Print(_L("CStifTFwIf::PauseTestCase"));

    TInt ret(KErrNone);

    // Find test case from execution table

    TInt index = iStifTFw->iTestExecutionTable.Find( ( CUIEngineContainer*) aTestId );

    // Check if test id is found

    if( index < 0 )

        {

        __TRACE( KPrint, (  _L( "CStifTFwIf::PauseTestCase. Container not found: testId = %d"), aTestId ) );

        return index;

        }

    // Pause test

    ret = iStifTFw->iTestExecutionTable[index]->PauseTest();

    __TRACE( KPrint, (  _L( "CStifTFwIf::PauseTest. Paused testId %d"), aTestId ) );

    return ret;

    }

/*

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

    Class: CStifTFwIf

    Method: ResumeTestCase