/*

* Copyright (c) 2002 - 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:  xmppsettingsfetchermt test module.

*

*/

#ifndef XMPPSETTINGSFETCHERMT_H

#define XMPPSETTINGSFETCHERMT_H

// INCLUDES

#include "StifTestModule.h"

#include <StifLogger.h>

#include "xmppparams.h"

#include <xmppservicesettingsapi.h>

// CONSTANTS

//const ?type ?constant_var = ?constant;

// MACROS

//#define ?macro ?macro_def

// Logging path

_LIT( KxmppsettingsfetchermtLogPath, "\\logs\\testframework\\xmppsettingsfetchermt\\" ); 

// Log file

_LIT( KxmppsettingsfetchermtLogFile, "xmppsettingsfetchermt.txt" ); 

_LIT( KxmppsettingsfetchermtLogFileWithTitle, "xmppsettingsfetchermt_[%S].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}

// FUNCTION PROTOTYPES

//?type ?function_name(?arg_list);

// FORWARD DECLARATIONS

//class ?FORWARD_CLASSNAME;

class Cxmppsettingsfetchermt;

class CXmppParameters;

// DATA TYPES

//enum ?declaration

enum TTestCase

    {

    EPositiveTest,

    EDescriptorTest,

    EIntegerTest

    };

//typedef ?declaration

//extern ?data_type;

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

// function is a type 

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

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

// CLASS DECLARATION

/**

*  An internal structure containing a test case name and

*  the pointer to function doing the test

*

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

*

*  @lib ?library

*  @since ?Series60_version

*/

class TCaseInfo

    {

    public:

        TPtrC iCaseName;

        TestFunction iMethod;

        TBool           iIsOOMTest;

        TInt            iFirstMemoryAllocation;

        TInt            iLastMemoryAllocation;

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

        {

        };

    };

    _LIT( KTestcasePassed, "test case passed" );

    _LIT( KTestcaseFailed, "test case failed" );

    _LIT( KVerificationFailed, "Verification of data failed" );

	//parameter values to set

	const TInt port = 2020;

    const TBool httpsProxyPort = 19;

	const TInt iapId = 3;

	_LIT( KXmppServerAddress , "Test.Server.com");

	_LIT( KUsername , "user@server.com");

	_LIT( KPassword , "password");

// gabble specific things

	_LIT( KResouceText , "resource");

	_LIT( KHttpsProxyServerAddressText , "proxy.server.com");

	_LIT( KAliasText , "alias");

	_LIT( KConnMgrBus, "org.freedesktop.Telepathy.ConnectionManager.gabble" );

	_LIT( KConnMgrPath, "/org/freedesktop/Telepathy/ConnectionManager/gabble" );

	_LIT( KParamProtocol , "jabber" );

    const TBool oldSSL = ETrue;

    const TBool resigter = EFalse;

// values for error cases

	_LIT( KNullUsername , ""); //empty string

	const TInt portNegative = -20;

	const TInt iapIdZero = 0;

// CLASS DECLARATION

/**

*  This a xmppsettingsfetchermt class.

*  ?other_description_lines

*

*  @lib ?library

*  @since ?Series60_version

*/

NONSHARABLE_CLASS(Cxmppsettingsfetchermt) : public CTestModuleBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static Cxmppsettingsfetchermt* NewL();

        /**

        * Destructor.

        */

        virtual ~Cxmppsettingsfetchermt();

    public: // New functions

        /**

        * ?member_description.

        * @since ?Series60_version

        * @param ?arg1 ?description

        * @return ?description

        */

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

    public: // Functions from base classes

        /**

        * From CTestModuleBase InitL is used to initialize the 

        *       xmppsettingsfetchermt. It is called once for every instance of 

        *       TestModulexmppsettingsfetchermt 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 xmppsettingsfetchermt.

        * @return Symbian OS error code

        */

        TInt InitL( TFileName& aIniFile, TBool aFirstTime );

        /**

        * From CTestModuleBase GetTestCasesL is used to inquiry test cases 

        *   from xmppsettingsfetchermt. 

        * @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; OOMTestInitializeL may be used to initialize OOM

        * test environment

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

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

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

        * @return None

        *

        * User may add implementation for OOM test warning handling. Usually no

        * implementation is required.           

        */

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

                                        const TInt /* aCaseNumber */, 

                                        TInt& /* aFailNextValue */); 

        /**

        * From CTestModuleBase; OOMTestFinalizeL may be used to finalize OOM

        * test environment

        * @param aTestCaseFile Test case file (optional)

        * @param aCaseNumber Test case number (optional)

        * @return None

        *

        */

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

                                       const TInt /* aCaseNumber */ );

    protected:  // New functions

        /**

        * ?member_description.

        * @since ?Series60_version

        * @param ?arg1 ?description

        * @return ?description

        */

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

    protected:  // Functions from base classes

        /**

        * From ?base_class ?member_description

        */

        //?type ?member_function();

    private:

        /**

        * C++ default constructor.

        */

        Cxmppsettingsfetchermt();

        /**

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

        /**

        * [test case declarations] - do not remove

        */

        //ADD NEW METHOD DEC HERE"

        /**

        * Positive 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 SetAndReadSettingsL( TTestResult& aResult );

        TInt ReadUnexistingSettingsL( TTestResult& aResult );

        TInt ReadIncompleteSettingsL( TTestResult& aResult );

        TInt ReadDescSettingsL( TTestResult& aResult );

        TInt ReadIntSettingsL( TTestResult& aResult );

		void WriteSettingsL( CXmppSettingsApi* aApi, TUint32 aSettingId, TTestCase aTestCase );

		TBool VerifySettingsL( CXmppParameters* aXmppParams, TUint32 settingId, TTestCase aTestCase );

		void WriteIncompleteSettingsL( CXmppSettingsApi* aApi, TUint32 aSettingId );

    public:     // Data

        // ?one_line_short_description_of_data

        //?data_declaration;

    protected:  // Data

        // ?one_line_short_description_of_data

        //?data_declaration;

    private:    // Data

        // Pointer to test (function) to be executed

        TestFunction iMethod;

        // Pointer to logger

        CStifLogger * iLog; 

        // Normal logger

        CStifLogger* iStdLog;

        // Test case logger

        CStifLogger* iTCLog;

        // Flag saying if test case title should be added to log file name

        TBool iAddTestCaseTitleToLogName;

        // ?one_line_short_description_of_data

        //?data_declaration;

        // Reserved pointer for future extension

        //TAny* iReserved;

    public:     // Friend classes

        //?friend_class_declaration;

    protected:  // Friend classes

        //?friend_class_declaration;

    private:    // Friend classes

        //?friend_class_declaration;

    };

#endif      // XMPPSETTINGSFETCHERMT_H

// End of File