/*

* 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 CTestServer 

* class member functions.

*

*/

// INCLUDE FILES

#include <e32std.h>

#include <e32svr.h>

#include "TestEngineClient.h"

#include <StifTestModule.h>

#include <stifinternal/TestServerClient.h>

#include "TestServer.h"

#include "TestServerCommon.h"

#include "TestServerModuleIf.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES  

// CONSTANTS

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// Struct to pass parameters to server thread

struct TThreadStartTestServerSession

    {

    RThread    iServerThread; // The server thread

    RSemaphore iStarted;      // Startup syncronisation semaphore   

    TInt       iStartupResult;// Start-up result

    };

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

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

// None

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

/*

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

    Class: CTestCasesList

    Method: NewL

    Description: Create new test cases list    

    Parameters: const TDesC& aConfigFileName :in:  Config file name

    Return Values: CTestCasesList* Pointer to new test cases list

    Errors/Exceptions: Leaves if memory allocation fails or ConstructL leaves.

    Status: Approved

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

*/

CTestCasesList* CTestCasesList::NewL( const TDesC& aConfigFileName )

    {    

    CTestCasesList* self = new(ELeave)CTestCasesList;

    CleanupStack::PushL( self );

    self->ConstructL( aConfigFileName );

    CleanupStack::Pop( self );

    return self;

    }

/*

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

    Class: CTestCasesList

    Method: ~CTestCasesList

    Description: Destructor    

    Parameters: 

    Return Values: 

    Errors/Exceptions: 

    Status: Approved

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

*/

CTestCasesList::~CTestCasesList()

    {

    delete iConfigFileName;

    iConfigFileName = NULL;

    iTestCases.ResetAndDestroy();

    iTestCases.Close();

    }

/*

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

    Class: CTestCasesList

    Method: AppendTestCaseL

    Description: Appends test case.

    Parameters: const TDesC& aTestCaseTitle  in: Test case title

    Return Values: 

    Errors/Exceptions: Leaves if memory allocation fails

    Status: Approved

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

*/

void CTestCasesList::AppendTestCaseL( const TDesC& aTestCaseTitle )

    {

    HBufC* testCaseTitle = aTestCaseTitle.AllocL();

    CleanupStack::PushL( testCaseTitle );

    iTestCases.AppendL( testCaseTitle );

    CleanupStack::Pop( testCaseTitle );

    }

/*

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

    Class: CTestCasesList

    Method: GetTestCaseTitleL

    Description: Returns specified test case title  

    Parameters: TInt aIndex: in: Requested test case index. 

    Return Values: Test case title.

    Errors/Exceptions: Leaves if test case index is invalid

    Status: Approved

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

*/

const TDesC& CTestCasesList::GetTestCaseTitleL( TInt aIndex ) const

    {    

    if ( ( aIndex < 0 ) || ( aIndex >= iTestCases.Count() ) )

        {

        User::Leave( KErrNotFound );

        }

    return *iTestCases[ aIndex ];

    }

/*

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

    Class: CTestCasesList

    Method: GetConfigFileName

    Description: Returns config file name  

    Parameters: 

    Return Values: Config file name.

    Errors/Exceptions: 

    Status: Approved

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

*/

const TDesC& CTestCasesList::GetConfigFileName() const

    {    

    return *iConfigFileName;

    }

/*

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

    Class: CTestCasesList

    Method: Count

    Description: Returns count of test cases.    

    Parameters: 

    Return Values: Test cases count.

    Errors/Exceptions: 

    Status: Approved

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

*/

TInt CTestCasesList::Count() const

    {

    return iTestCases.Count();

    }

/*

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

    Class: CTestCasesList

    Method: ResetAndDestroy

    Description: Resets list of test cases.    

    Parameters: 

    Return Values: 

    Errors/Exceptions: 

    Status: Approved

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

*/

void CTestCasesList::ResetAndDestroy()

    {    

    iTestCases.ResetAndDestroy();

    }

/*

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

    Class: CTestCasesList

    Method: ~CTestCasesList

    Description: Destructor    

    Parameters: 

    Return Values: 

    Errors/Exceptions: 

    Status: Approved

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

*/

CTestCasesList::CTestCasesList()

    {

    }

/*

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

    Class: CTestCasesList

    Method: ~CTestCasesList

    Description: Destructor    

    Parameters: 

    Return Values: 

    Errors/Exceptions: 

    Status: Approved

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

*/

void CTestCasesList::ConstructL( const TDesC& aConfigFileName )

    {

    iConfigFileName = aConfigFileName.AllocL();

    }

/*

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

    Class: CTestModule

    Method: NewL

    Description: Create new Test Module    

    Parameters: RThread& aClient              :in:  Handle to client

                CTestServer* aServer          :in:  Pointer to server

    Return Values: CTestModule*                     Pointer to new test module

    Errors/Exceptions: Leaves if memory allocation fails or ConstructL leaves.

    Status: Approved

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

*/

CTestModule* CTestModule::NewL( CTestServer* aServer )

    {

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

    CleanupStack::PushL( self );

    self->ConstructL( aServer );

    CleanupStack::Pop();

    return self;

    }

/*

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

    Class: CTestModule

    Method: CTestModule

    Description: Constructor.

    Initialise base class.

    Parameters: RThread& aClient              :in:  Handle to client

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

CTestModule::CTestModule() :

    CSession2(),

    iIni(0, 0)

    {

    }

/*

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

    Class: CTestModule

    Method: ~CTestModule

    Description: Destructor.

    Deallocate memory and close handles.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None.

    Status: Proposal

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

*/

CTestModule::~CTestModule()

    {

    __TRACE( KVerbose, ( _L( "Closing test module" ) ) );

    // Free test case related data. No error checking here, because if freeing

    // fails, then nothing can be done in destructor.

    FreeCaseData();

    // Delete all test module instances.

    // Cleanup all RTestExecution has been opened by client but not properly

    // closed for example if timeout occurs and client died. This almost do

    // same than CloseSession() in "if( iTestExecutionHandle )" branch.

    if( iTestExecutionHandle )

        {

        TInt handle = 0;

        CObject* theObj = NULL;

        TInt count = iTestExecutionHandle->Count();

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

            {

            // Get pointer to CTestExecution

            theObj=iTestExecutionHandle->operator[]( i );

            if( theObj )

                {

                handle=iTestExecutionHandle->At( theObj );

                CTestExecution* testcase = (CTestExecution*) theObj;

                // Cancels test(s) execution(timeout, exit, etc)

                // For example TestCombiner is timeouted => TestCombiner's

                // TestServer+TestModule(s) should cancel also.

                testcase->CancelTestExecution();

                // CTestExecution will panic if test case is ongoing!!! This

                // should be stopped, client should handless this.

                iTestExecutionHandle->Remove( handle );

                }

            }

        delete iTestExecutionHandle;

        iTestExecutionHandle = NULL;

        }

    // Delete all FREE Test Module instances.

    if( iTestModuleInstances )

        {

        iTestModuleInstances->ResetAndDestroy();

        delete iTestModuleInstances;

        iTestModuleInstances = NULL;

        }

    // Delete ini file heap buffer

    delete iIniBuffer;

    iIniBuffer = NULL;

    // Delete array of test case titles

    iTestCaseTitlesMap.ResetAndDestroy();

    iTestCaseTitlesMap.Close();

    }

/*

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

    Class: CTestModule

    Method: ConstructL

    Description: Second level constructor.

    Parameters: CTestServer* aServer          :in:  Server

    Return Values: None

    Errors/Exceptions: Leaves if:

                       base class CreateL leaves

                       Object index creation fails

                       Object container creation fails

                       Pointer array construction fails                       

    Status: Approved

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

*/

void CTestModule::ConstructL( CTestServer* aServer )

    {

	__TRACE( KVerbose, ( _L( "CTestModule::ConstructL - constructing server session" ) ) );

    // second-phase construct base class

    //CSession2::CreateL( /* *aServer */ );

    iTestServer = aServer;

    // create new object index

    iTestExecutionHandle = CObjectIx::NewL();

    // Initialize the object container using the object

    // container index in the server.

    iContainer = iTestServer->NewContainerL();

    iTestModuleInstances = new( ELeave ) RPointerArray<CTestModuleContainer>;

	__TRACE( KError, ( _L( "CTestModule::ConstructL - constructing server session done" ) ) );

    }

/*

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

    Class: CTestModule

    Method: CountResources

    Description: Resource counting

    Parameters: None

    Return Values: TInt                             Resource count

    Errors/Exceptions: None

    Status: Approved

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

*/

TInt CTestModule::CountResources()

    {

    return iResourceCount;

    }

/*

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

    Class: CTestModule

    Method: NumResources

    Description: Get resources, writes to Message()

    Parameters: None

    Return Values: None

    Errors/Exceptions: Panic client if result can't be written to descriptor.

    Status: Approved

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

*/

void CTestModule::NumResources( const RMessage2& aMessage )

    {

    TPckgBuf<TInt> countPckg( iResourceCount );

    TRAPD( r, aMessage.WriteL( 0, countPckg ) );

    if( r !=KErrNone )

        {

        PanicClient( EBadDescriptor, aMessage );

        }

    }

/*

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