/*

* 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 the implementation of 

* CTestCase class member functions.

*

*/

// INCLUDE FILES

#include "TestCombiner.h"

#include "TestCase.h"

#include "TestCaseNotify.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 iTestCombiner->iLog

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

/*

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

     Class: CTestCase

     Method: CTestCase

     Description: Default constructor

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

     might leave.

     Parameters: CTestCombiner* testCombiner: in: Backpointer to CTestCombiner

                 TDesC& aModuleName: in: name of the used test module

                 TDesC& aTestId: in: TestId for testcase

                 TInt aExpectedResult: in: expected result for the testcase

     Return Values: None.

     Errors/Exceptions: None.

     Status: Draft

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

*/

CTestCase::CTestCase( CTestCombiner* testCombiner,

                      TInt aExpectedResult,

                      TFullTestResult::TCaseExecutionResult aCategory,

                      TCaseType aType,

                      CTCTestModule* aModule ): //--PYTHON

    CActive(  CActive::EPriorityStandard ),

    iType( aType ),

    iTestCombiner( testCombiner ),

    iState( ETestCaseIdle ),

    iExpectedResult( aExpectedResult ),

    iExpectedResultCategory( aCategory ),

    iTestModule( aModule ) //--PYTHON

    {

    CActiveScheduler::Add( this );   

    }

/*

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

     Class: CTestCase

     Method: ConstructL

     Description: Symbian OS second phase constructor

     Symbian OS default constructor can leave.     

     Parameters: TDesC& aTestId: in: Test identifier

     Return Values: None.

     Errors/Exceptions: None

     Status: Proposal

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

*/

void CTestCase::ConstructL( TDesC& aTestId )

    {

    __ASSERT_ALWAYS( aTestId.Length() < KMaxFileName, User::Leave( KErrArgument ) );

    iTestId = aTestId.AllocL();

    }

/*

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

     Class: CTestCase

     Method: ~CTestCase

     Description: Destructor

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/     

CTestCase::~CTestCase()

    {    

    Cancel();    

    delete iTestId;

    }

/*

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

     Class: CTestCase

     Method: RunL

     Description: Derived from CActive. Handles the completed testcase.

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: Leaves if completed with error. 

     Status: Proposal

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

*/

void CTestCase::RunL()

    {

    __TRACE( KMessage, ( _L("CTestCase::RunL: [%d] "), iStatus.Int() ));

    Complete( iStatus.Int() );

    __TRACE( KMessage, ( _L( "CTestCase::RunL: Testcase completed" )));

    }

/*

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

     Class: CTestCase

     Method: DoCancel

     Description: Derived from CActive, handles the Cancel.

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

void CTestCase::DoCancel()

    {

    __TRACE( KMessage, ( _L("CTestCase::DoCancel")));

    TRequestStatus* rs = &iStatus;

    User::RequestComplete( rs, KErrCancel );

    Complete( KErrCancel );

    }

/*

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

     Class: CTestCase

     Method: Start

     Description: Start progress and event notifiers and set CTestCase active.

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

void CTestCase::StartL()

    {

    iState = ETestCaseRunning;

    iStatus = KRequestPending;

    SetActive();

    }

/*

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

     Class: CTestCase

     Method: Complete

     Description: Completes testcase to CTestCombiner.

     Parameters: TInt aError: in: Completion error

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

void CTestCase::Complete( TInt aError )

    {

    __TRACE( KMessage, ( _L("CTestCase::Complete: %d "), aError ));

    iState = ETestCaseCompleted;

    iTestCombiner->Complete( this, aError );

    }

/*

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

     Class: CTestCase

     Method: IsCompletelyFinished

     Description: Checks state.

     Parameters: None

     Return Values: TBool.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

TBool CTestCase::IsCompletelyFinished(void)

    {

    TBool result = (iState == CTestCase::ETestCaseCompleted);

    return result;

    }

/*

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

    DESCRIPTION

    This module contains the implementation of CTCTestCase class 

    member functions.

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

*/

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

/*

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

     Class: CTCTestCase

     Method: CTCTestCase

     Description: Default constructor

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

     might leave.

     Parameters: CTestCombiner* testCombiner: in: Backpointer to CTestCombiner

                 TDesC& aModuleName: in: name of the used test module

                 TDesC& aTestId: in: TestId for testcase

                 TInt aExpectedResult: in: expected result for the testcase

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

CTCTestCase::CTCTestCase( CTestCombiner* testCombiner,

                          TInt aExpectedResult,

                          TFullTestResult::TCaseExecutionResult aCategory,

                          CTCTestModule* aModule ): //--PYTHON

    CTestCase( testCombiner, aExpectedResult, aCategory, ECaseLocal, aModule ), //--PYTHON

    iResultPckg( iResult )

    {

    }

/*

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

     Class: CTCTestCase

     Method: ConstructL

     Description: Symbian OS second phase constructor

     Symbian OS default constructor can leave.     

     Parameters: None. 

     Return Values: None.

     Errors/Exceptions: None

     Status: Proposal

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

*/

void CTCTestCase::ConstructL( TDesC& aModuleName,

                              TDesC& aTestId,

                              const TDesC& aTestCaseArguments )

    {

    __ASSERT_ALWAYS( aModuleName.Length() < KMaxFileName, User::Leave( KErrArgument ) );

    CTestCase::ConstructL( aTestId );

    iModuleName = aModuleName.AllocL();

    iTestCaseArguments = aTestCaseArguments.AllocL();

    }

/*

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

     Class: CTCTestCase

     Method: NewL

     Description: Two-phased constructor.

     Parameters: CTestCombiner* testCombiner: in: Backpointer to CTestCombiner

     Return Values: CTCTestCase*: pointer to new CTCTestCase object

     Errors/Exceptions: Leaves if new or ConstructL leaves.

     Status: Proposal

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

*/

CTCTestCase* CTCTestCase::NewL( CTestCombiner* testCombiner,

                                TDesC& aModuleName,

                                TDesC& aTestId,

                                TInt aExpectedResult,

                                TFullTestResult::TCaseExecutionResult aCategory,

                                const TDesC& aTestCaseArguments,

                                CTCTestModule* aModule ) //--PYTHON

    {

    CTCTestCase* self = new (ELeave) CTCTestCase( testCombiner,

                                                   aExpectedResult,

                                                   aCategory,

                                                   aModule ); //--PYTHON

    CleanupStack::PushL( self );

    self->ConstructL( aModuleName, aTestId, aTestCaseArguments );

    CleanupStack::Pop();

    return self;

    }

/*

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

     Class: CTCTestCase

     Method: ~CTCTestCase

     Description: Destructor

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: None.

     Status: Proposal

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

*/     

CTCTestCase::~CTCTestCase()

    {    

    Cancel();

    delete iEvent;

    // Unset all set events

    TInt count = iStateEventArray.Count();

    TInt i = 0;

    for( i = 0; i < count; i++ )

        {

		if( iStateEventArray[i] != NULL )

			{

			iStateEventArray[i]->SetType( TEventIf::EUnsetEvent );

			}

		if( iTestCombiner != NULL )

			{

			iTestCombiner->TestModuleIf().Event( *iStateEventArray[i] );

			}

        }

    iStateEventArray.ResetAndDestroy();

    iStateEventArray.Close();

    // to be sure..

    count = iEventArray.Count();

    TEventIf event;

    for( i = 0; i < count; i++ )

        {

        event.Copy( iEventArray[i]->Event() );

        event.SetType( TEventIf::ERelEvent );

		if( iTestCombiner != NULL )

			{

			iTestCombiner->TestModuleIf().Event( event );

			}

        }

    iEventArray.ResetAndDestroy();

    iEventArray.Close();

    delete iProgress;

    delete iModuleName;

    delete iTestCaseArguments;

    delete iCommand;

    }

/*

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

     Class: CTCTestCase

     Method: TestCaseArguments

     Description: Get test case arguments

     Parameters: None.

     Return Values: Test case arguments.

     Errors/Exceptions: None.

     Status: Proposal

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

*/

const TDesC& CTCTestCase::TestCaseArguments() const 

    {

    if ( iTestCaseArguments !=NULL ) 

        {

        return *iTestCaseArguments; 

        }

    return KNullDesC;

    }

/*

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

     Class: CTCTestCase

     Method: DoCancel

     Description: Derived from CActive, handles the Cancel.

     Parameters: None.

     Return Values: None.

     Errors/Exceptions: None.