/*

* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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:  FavouritesEngineTest test module.

*

*/

#ifndef FAVOURITESENGINETEST_H

#define FAVOURITESENGINETEST_H

// INCLUDES

#include "StifTestModule.h"

#include <StifLogger.h>

#include <f32file.h>

#include <FavouritesSession.h>

#include <FavouritesItem.h>

#include <FavouritesItemList.h>

#include <FavouritesDb.h>

#include <FavouritesFile.h>

//#include <RfsApMapper.h>

#include <FavouritesDbIncremental.h>

#include <FavouritesDbObserver.h>

#include <ActiveFavouritesDbNotifier.h>

#include "FavouritesItemTestData.h"

// CONSTANTS

_LIT( KTestDbName, "Test" );

// MACROS

/// Cosmetic purpose macro, to initialize reference item.

#define InitItemL(name)                             \

    name->SetType( CFavouritesItem::EItem );        \

    name->SetNameL( _L( #name ) );                  \

    name->SetUrlL( _L( #name ) );                   \

    name->SetUserNameL( _L( #name ) );              \

    name->SetPasswordL( _L( #name ) );              \

    name->SetParentFolder( KFavouritesRootUid );

/// Cosmetic purpose macro, to initialize reference folder.

#define InitFolderL(name)                           \

    name->SetType( CFavouritesItem::EFolder );      \

    name->SetNameL( _L( #name ) );                  \

    name->SetUrlL( _L( "" ) );                      \

    name->SetUserNameL( _L( "" ) );                 \

    name->SetPasswordL( _L( "" ) );                 \

    name->SetParentFolder( KFavouritesRootUid );

/// Cosmetic purpose macro, to create and initialize reference item.

#define CreateItemL(name)                           \

    name = CFavouritesItem::NewL();                 \

    InitItemL( name );

/// Cosmetic purpose macro, to create and initialize reference folder.

#define CreateFolderL(name)                         \

    name = CFavouritesItem::NewL();                 \

    InitFolderL( name );

// Logging path

_LIT( KFavouritesEngineTestLogPath, "\\logs\\testframework\\FavouritesEngineTest\\" ); 

// Log file

_LIT( KFavouritesEngineTestLogFile, "FavouritesEngineTest.txt" ); 

// Function pointer related internal definitions

// Rounding known bug in GCC

#ifdef __VC32__

#define GETPTR 

#else

#define GETPTR &

#endif  

#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}

// DATA TYPES

//enum ?declaration

//typedef ?declaration

//extern ?data_type;

// FUNCTION PROTOTYPES

//?type ?function_name(?arg_list);

// FORWARD DECLARATIONS

class CFavouritesEngineTest;

class CActiveFavouritesDbNotifier;

// A typedef for function that does the actual testing,

// function is a type 

// TInt CDemoModule::<NameOfFunction> ( TTestResult& aResult )

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

// CLASS DECLARATION

/**

*  An internal structure containing a test case name and

*  the pointer to function doing the test

*

*  \b Library: ?library

*

*  @since ?Series60_version

*/

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

*

*  \b Library: ?library

*

*  @since ?Series60_version

*/

class TCaseInfo

    {

    public:

        TPtrC           iCaseName;    

        TestFunction    iMethod;

        TBool           iIsOOMTest;

        TInt            iFirstMemoryAllocation;

        TInt            iLastMemoryAllocation;

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

        {        

        };

    };

// CLASS DECLARATION

/**

*  This a FavouritesBCTest class.

*  ?other_description_lines

*

*  \b Library: ?library

*

*  @since ?Series60_version

*/

//NONSHARABLE_CLASS(CFavouritesEngineTest) : public CTestModuleBase,

//                                       public MRfsApMapper

NONSHARABLE_CLASS(CFavouritesEngineTest) : public CTestModuleBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CFavouritesEngineTest* NewL();

        /**

        * Destructor.

        */

        virtual ~CFavouritesEngineTest();

    public: // New functions

        /**

        * ?member_description.

        * @since ?Series60_version

        * @param ?arg1 ?description

        * @return ?description

        */

        //?type ?member_function( ?type ?arg1 );

    private:    // from MRfsApMApper

        /**

        * Dummy AP mapping to test RFS. Original value is returned always.

        * @return ETrue.

        */

        TBool MapAccessPoint( TUint aOldUid, TUint& aNewUid );

    public: // Functions from base classes

        /**

        * From CTestModuleBase InitL is used to initialize the FavouritesBCTest. 

        *       It is called once for every instance of FavouritesBCTest after

        *       its creation.

        * @since ?Series60_version

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

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

        *               created instance of FavouritesBCTest.

        * @return Symbian OS error code

        */

        TInt InitL( TFileName& aIniFile, TBool aFirstTime );

        /**

        * From CTestModuleBase GetTestCasesL is used to inquiry test cases 

        *   from FavouritesBCTest. 

        * @since ?Series60_version

        * @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 ?Series60_version

        * @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.

        */

        CFavouritesEngineTest();

        /**

        * By default Symbian 2nd phase constructor is private.

        */

        void ConstructL();

        // Prohibit copy constructor if not deriving from CBase.

        // ?classname( const ?classname& );

        // Prohibit assigment operator if not deriving from CBase.

        // ?classname& operator=( const ?classname& );

        /**

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

        * @since ?Series60_version

        * @param aCaseNumber test case number

        * @return TCaseInfo 

        */

        const TCaseInfo Case ( const TInt aCaseNumber ) const;

    private:   // Functions to test FavouritesItem interface

        /**

        * FavouritesItem NewLC test case.

        * @since ?Series60_version

        * @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 ItemNewLCTestL( TTestResult& aResult );

        /**

        * FavouritesItem NewL test case.

        * @since ?Series60_version

        * @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 ItemNewLTestL( TTestResult& aResult );

        /**

        * FavouritesItem destructor test case.

        * @since ?Series60_version

        * @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 ItemDestructorTestL( TTestResult& aResult );

        /**

        * FavouritesItem Assign(=) operator test case.

        * @since ?Series60_version

        * @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 ItemAssignTestL( TTestResult& aResult );

        /**

        * FavouritesItem Uid test case.

        * @since ?Series60_version

        * @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 ItemUidTestL( TTestResult& aResult );

        /**

        * FavouritesItem ParentFolder test case.

        * @since ?Series60_version

        * @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 ItemParentFolderTestL( TTestResult& aResult );

        /**

        * FavouritesItem Type test case.

        * @since ?Series60_version

        * @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 ItemTypeTestL( TTestResult& aResult );

        /**

        * FavouritesItem Name test case.

        * @since ?Series60_version

        * @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 ItemNameTestL( TTestResult& aResult );

        /**

        * FavouritesItem Url test case.

        * @since ?Series60_version

        * @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 ItemUrlTestL( TTestResult& aResult );

        /**

        * FavouritesItem WapAp test case.

        * @since ?Series60_version

        * @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 ItemWapApTestL( TTestResult& aResult );

        /**

        * FavouritesItem UserName test case.

        * @since ?Series60_version

        * @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 ItemUserNameTestL( TTestResult& aResult );

        /**

        * FavouritesItem Password test case.

        * @since ?Series60_version

        * @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 ItemPasswordTestL( TTestResult& aResult );

        /**

        * FavouritesItem ContextId test case.

        * @since ?Series60_version

        * @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 ItemContextIdTestL( TTestResult& aResult );

        /**

        * FavouritesItem IsItem test case.

        * @since ?Series60_version

        * @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 ItemIsItemTestL( TTestResult& aResult );

        /**

        * FavouritesItem IsFolder test case.

        * @since ?Series60_version

        * @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 ItemIsFolderTestL( TTestResult& aResult );

        /**

        * FavouritesItem IsFactoryItem test case.

        * @since ?Series60_version

        * @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 ItemIsFactoryItemTestL( TTestResult& aResult );

        /**

        * FavouritesItem IsReadOnly test case.

        * @since ?Series60_version

        * @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 ItemIsReadOnlyTestL( TTestResult& aResult );

        /**

        * FavouritesItem Modified test case.

        * @since ?Series60_version

        * @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 ItemModifiedTestL( TTestResult& aResult );

        /**

        * FavouritesItem ClearL test case.

        * @since ?Series60_version

        * @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 ItemClearLTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetParentFolder test case.

        * @since ?Series60_version

        * @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 ItemSetParentFolderTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetType test case.

        * @since ?Series60_version

        * @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 ItemSetTypeTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetNameL test case.

        * @since ?Series60_version

        * @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 ItemSetNameLTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetUrlL test case.

        * @since ?Series60_version

        * @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 ItemSetUrlLTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetWapAp test case.

        * @since ?Series60_version

        * @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 ItemSetWapApTestL( TTestResult& aResult );

        /**

        * FavouritesItem SetUserNameL test case.

        * @since ?Series60_version

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

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