/*

* Copyright (c) 2007 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:  DrmHelperTest class member functions

*

*/

// INCLUDE FILES

#include <stiftestinterface.h>

#include "drmhelpertest.h"

// Forward declarations

extern void CreateDataFilesL( RFs& aFs );

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

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

// CDrmHelperTest::CDrmHelperTest

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

// might leave.

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

//

CDrmHelperTest::CDrmHelperTest()

    {

    }

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

// CDrmHelperTest::ConstructL

// Symbian 2nd phase constructor can leave.

//

// Note: If OOM test case uses STIF Logger, then STIF Logger must be created

// with static buffer size parameter (aStaticBufferSize). Otherwise Logger

// allocates memory from heap and therefore causes error situations with OOM

// testing. For more information about STIF Logger construction, see STIF Users

// Guide.

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

//

void CDrmHelperTest::ConstructL()

    {

    iLog = CStifLogger::NewL( KDrmHelperTestLogPath,

                              KDrmHelperTestLogFile);

    // Sample how to use logging

    _LIT( KLogStart, "DrmHelperTest logging starts!" );

    iLog->Log( KLogStart );

    User::LeaveIfError( iFs.Connect() );

    _LIT( KFsConnected, "Connected to RFs.");

    iLog->Log( KFsConnected );

    }

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

// CDrmHelperTest::NewL

// Two-phased constructor.

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

//

CDrmHelperTest* CDrmHelperTest::NewL()

    {

    CDrmHelperTest* self = new (ELeave) CDrmHelperTest;

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

// Destructor

CDrmHelperTest::~CDrmHelperTest()

    {

    delete iLog;

    iFs.Close();

    }

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

// CDrmHelperTest::InitL

// InitL is used to initialize the Test Module.

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

//

TInt CDrmHelperTest::InitL(

    TFileName& /*aIniFile*/,

    TBool aFirstTime )

    {

    _LIT( KInitStart, "InitL" );

    iLog->Log( KInitStart );

    if ( aFirstTime )

       {

       _LIT( KFirstTime, "aFirstTime == ETrue" );

       iLog->Log( KFirstTime );

       CreateDataFilesL( iFs );

       _LIT( KFilesCreated, "data files created" );

       iLog->Log( KFilesCreated );

       }

    return KErrNone;

    }

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

// CDrmHelperTest::GetTestCasesL

// GetTestCases is used to inquire test cases from the Test Module. Test

// cases are stored to array of test cases. The Test Framework will be

// the owner of the data in the RPointerArray after GetTestCases return

// and it does the memory deallocation.

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

//

TInt CDrmHelperTest::GetTestCasesL(

    const TFileName& /*aConfig*/,

    RPointerArray<TTestCaseInfo>& aTestCases )

    {

    // Loop through all test cases and create new

    // TTestCaseInfo items and append items to aTestCase array

    for( TInt i = 0; Case(i).iMethod; i++ )

        {

        // Allocate new TTestCaseInfo from heap for a testcase definition.

        TTestCaseInfo* newCase = new( ELeave ) TTestCaseInfo();

        // PushL TTestCaseInfo to CleanupStack.

        CleanupStack::PushL( newCase );

        // Set number for the testcase.

        // When the testcase is run, this comes as a parameter to RunTestCaseL.

        newCase->iCaseNumber = i;

        // Set title for the test case. This is shown in UI to user.

        newCase->iTitle.Copy( Case(i).iCaseName );

        // Append TTestCaseInfo to the testcase array. After appended

        // successfully the TTestCaseInfo object is owned (and freed)

        // by the TestServer.

        User::LeaveIfError(aTestCases.Append ( newCase ) );

        // Pop TTestCaseInfo from the CleanupStack.

        CleanupStack::Pop( newCase );

        }

    return KErrNone;

    }

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

// CDrmHelperTest::RunTestCaseL

// RunTestCaseL is used to run an individual test case specified

// by aTestCase. Test cases that can be run may be requested from

// Test Module by GetTestCases method before calling RunTestCase.

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

//

TInt CDrmHelperTest::RunTestCaseL(

    const TInt aCaseNumber,

    const TFileName& /*aConfig*/,

    TTestResult& aResult )

    {

    // Return value

    TInt execStatus = KErrNone;

    // Get the pointer to test case function

    TCaseInfo tmp = Case ( aCaseNumber );

    _LIT( KLogStartTC, "Starting testcase [%S]" );

    iLog->Log( KLogStartTC, &tmp.iCaseName);

    // Check that case number was valid

    if ( tmp.iMethod )

        {

        // Valid case was found, call it via function pointer

        iMethod = tmp.iMethod;

        execStatus  = ( this->*iMethod )( aResult );

        }

    else

        {

        // Valid case was not found, return error.

        execStatus = KErrNotFound;

        }

    // Return case execution status (not the result of the case execution)

    return execStatus;

    }

// ========================== OTHER EXPORTED FUNCTIONS =========================

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

// LibEntryL is a polymorphic Dll entry point

// Returns: CTestModuleBase*: Pointer to Test Module object

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

//

EXPORT_C CTestModuleBase* LibEntryL()

    {

    return CDrmHelperTest::NewL();

    }

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

// SetRequirements handles test module parameters(implements evolution

// version 1 for test module's heap and stack sizes configuring).

// Returns: TInt: Symbian error code.

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

//

EXPORT_C TInt SetRequirements( CTestModuleParam*& /*aTestModuleParam*/,

                               TUint32& /*aParameterValid*/ )

    {

    /* --------------------------------- NOTE ---------------------------------

       USER PANICS occurs in test thread creation when:

       1) "The panic occurs when the value of the stack size is negative."

       2) "The panic occurs if the minimum heap size specified is less

       than KMinHeapSize".

KMinHeapSize: "Functions that require a new heap to be allocated will

either panic, or will reset the required heap size to this value if

a smaller heap size is specified".

3) "The panic occurs if the minimum heap size specified is greater than

the maximum size to which the heap can grow".

Other:

1) Make sure that your hardware or Symbian OS is supporting given sizes.

e.g. Hardware might support only sizes that are divisible by four.

------------------------------- NOTE end ------------------------------- */

    // Normally STIF uses default heap and stack sizes for test thread, see:

    // KTestThreadMinHeap, KTestThreadMinHeap and KStackSize.

    // If needed heap and stack sizes can be configured here by user. Remove

    // comments and define sizes.

    /*

       aParameterValid = KStifTestModuleParameterChanged;

       CTestModuleParamVer01* param = CTestModuleParamVer01::NewL();

    // Stack size

    param->iTestThreadStackSize= 16384; // 16K stack

    // Heap sizes

    param->iTestThreadMinHeap = 4096;   // 4K heap min

    param->iTestThreadMaxHeap = 1048576;// 1M heap max

    aTestModuleParam = param;

    */

    return KErrNone;

    }

//  End of File