/*

* Copyright (c) 2007 - 2008 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:  DrmLicenseCheckerTest test module.

*

*/

#ifndef DRMLICENSECHECKERTEST_H

#define DRMLICENSECHECKERTEST_H

// INCLUDES

#include <StifLogger.h>

#include "StifTestModule.h"

// Logging path

_LIT( KDrmLicenseCheckerTestLogPath, "\\logs\\testframework\\DrmLicenseCheckerTest\\" ); 

// Log file

_LIT( KDrmLicenseCheckerTestLogFile, "DrmLicenseCheckerTest.txt" ); 

#define GETPTR &

#define ENTRY(str,func) {_S(str), GETPTR func,0,0,0}

#define FUNCENTRY(func) {_S(#func), GETPTR func,0,0,0}

#define OOM_ENTRY(str,func,a,b,c) {_S(str), GETPTR func,a,b,c}

#define OOM_FUNCENTRY(func,a,b,c) {_S(#func), GETPTR func,a,b,c}

// FORWARD DECLARATIONS

class CDrmLicenseCheckerTest;

typedef TInt (CDrmLicenseCheckerTest::* TestFunction)(TTestResult&);

class TCaseInfoInternal

    {

    public:

        const TText*    iCaseName;

        TestFunction    iMethod;

        TBool           iIsOOMTest;

        TInt            iFirstMemoryAllocation;

        TInt            iLastMemoryAllocation;

    };

// CLASS DECLARATION

/**

*  A structure containing a test case name and

*  the pointer to function doing the test

*

*  @lib DRMCommonTest.lib

*  @since S60 3.2

*/

class TCaseInfo

    {

    public:

        TPtrC iCaseName;

        TestFunction iMethod;

        TBool           iIsOOMTest;

        TInt            iFirstMemoryAllocation;

        TInt            iLastMemoryAllocation;

    TCaseInfo( const TText* a ) : iCaseName( (TText*) a )

        {

        };

    };

// CLASS DECLARATION

/**

*  This a DrmLicenseCheckerTest class.

*

*  @lib DrmLicenseCheckerTest.lib

*  @since S60 3.2

*/

NONSHARABLE_CLASS(CDrmLicenseCheckerTest) : public CTestModuleBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CDrmLicenseCheckerTest* NewL();

        /**

        * Destructor.

        */

        virtual ~CDrmLicenseCheckerTest();

    public: // Functions from base classes

        /**

        * From CTestModuleBase InitL is used to initialize the 

        * DrmLicenseCheckerTest. 

        * It is called once for every instance of DrmLicenseCheckerTest 

        * after its creation.

        * @since S60 3.2

        * @param aIniFile Initialization file for the test module (optional)

        * @param aFirstTime Flag is true when InitL is executed for first 

        *               created instance of DrmLicenseCheckerTest.

        * @return Symbian OS error code

        */

        TInt InitL( TFileName& aIniFile, TBool aFirstTime );

        /**

        * From CTestModuleBase GetTestCasesL is used to inquiry test cases 

        *   from DrmLicenseCheckerTest. 

        * @since S60 3.2

        * @param aTestCaseFile Test case file (optional)

        * @param aTestCases  Array of TestCases returned to test framework

        * @return Symbian OS error code

        */

        TInt GetTestCasesL( const TFileName& aTestCaseFile, 

                            RPointerArray<TTestCaseInfo>& aTestCases );

        /**

        * From CTestModuleBase RunTestCaseL is used to run an individual 

        *   test case. 

        * @since S60 3.2

        * @param aCaseNumber Test case number

        * @param aTestCaseFile Test case file (optional)

        * @param aResult Test case result returned to test framework (PASS/FAIL)

        * @return Symbian OS error code (test case execution error, which is 

        *           not reported in aResult parameter as test case failure).

        */   

        TInt RunTestCaseL( const TInt aCaseNumber, 

                           const TFileName& aTestCaseFile,

                           TTestResult& aResult );

        /**

        * From CTestModuleBase; OOMTestQueryL is used to specify is particular

        * test case going to be executed using OOM conditions

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

        * @param aFailureType OOM failure type (optional)

        * @param aFirstMemFailure The first heap memory allocation failure value (optional)

        * @param aLastMemFailure The last heap memory allocation failure value (optional)

        * @return TBool

        */

        virtual TBool OOMTestQueryL( const TFileName& /* aTestCaseFile */, 

                                     const TInt /* aCaseNumber */, 

                                     TOOMFailureType& /* aFailureType */,

                                     TInt& /* aFirstMemFailure */, 

                                     TInt& /* aLastMemFailure */ );

        /**

        * From CTestModuleBase; User may add implementation for OOM test 

        * environment initialization. Usually no implementation is required.

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

        * @return None

        */

        virtual void OOMTestInitializeL( const TFileName& /* aTestCaseFile */, 

                                    const TInt /* aCaseNumber */ ); 

        /**

        * From CTestModuleBase; OOMHandleWarningL. User may add implementation 

        * for OOM test warning handling. Usually no implementation is required.

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

        * @param aFailNextValue FailNextValue for OOM test execution (optional)

        * @return None

        */

        virtual void OOMHandleWarningL( const TFileName& /* aTestCaseFile */,

                                        const TInt /* aCaseNumber */, 

                                        TInt& /* aFailNextValue */);

        /**

        * From CTestModuleBase; OOMTestFinalizeL may be used to finalize OOM

        * test environment. Usually no implementation is required.

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

        * @return None

        */

        virtual void OOMTestFinalizeL( const TFileName& /* aTestCaseFile */, 

                                       const TInt /* aCaseNumber */ );

    private:

        /**

        * C++ default constructor.

        */

        CDrmLicenseCheckerTest();

        /**

        * By default Symbian 2nd phase constructor is private.

        */

        void ConstructL();

        /**

        * Function returning test case name and pointer to test case function.

        * @since S60 3.2

        * @param aCaseNumber test case number

        * @return TCaseInfo 

        */

        const TCaseInfo Case( const TInt aCaseNumber ) const;

        /**

        * Constructor tests

        * @since S60 3.2

        * @param aResult Test case result (PASS/FAIL)

        * @return Symbian OS error code (test case execution error 

        *   that is not returned as test case result in aResult)

        */

        TInt ConstructTestL( TTestResult& aResult );

        /**

        * Check license tests

        * @since S60 3.2

        * @param aResult Test case result (PASS/FAIL)

        * @return Symbian OS error code (test case execution error 

        *   that is not returned as test case result in aResult)

        */

        TInt CheckLicenseTestL( TTestResult& aResult);

    private:    // Data

        // Pointer to test (function) to be executed

        TestFunction iMethod;

        // Pointer to logger

        CStifLogger * iLog;

    };

#endif      // DRMLICENSECHECKERTEST_H

// End of File