/*
* 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 "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: ICMSTIF test module.
*
*/
#ifndef ICMSTIF_H
#define ICMSTIF_H
// INCLUDES
#include "StifTestModule.h"
#include <StifLogger.h>
#include "imagingconfigmanager.h"
// CONSTANTS
//const ?type ?constant_var = ?constant;
// MACROS
// Function pointer related internal definitions
// Hack around known GCC bug.
#ifndef __GCC32__
#define GETPTR
#else
#define GETPTR &
#endif
#define ENTRY(str,func) {(TText*)L##str, GETPTR func}
// Logging path
_LIT( KICMSTIFLogPath, "\\logs\\testframework\\ICMSTIF\\" );
// Log file
_LIT( KICMSTIFLogFile, "ICMSTIF.txt" );
// FORWARD DECLARATIONS
class CICMSTIF;
// DATA TYPES
typedef TInt (CICMSTIF::* TestFunction)(TTestResult&);
//enum ?declaration
//typedef ?declaration
//extern ?data_type;
/**
* An internal structure containing a test case name and
* the pointer to function doing the test
*
*/
class TCaseInfoInternal
{
public:
const TText* iCaseName;
TestFunction iMethod;
};
/**
* A structure containing a test case name and
* the pointer to function doing the test
*
*/
class TCaseInfo
{
public:
TPtrC iCaseName;
TestFunction iMethod;
TCaseInfo( const TText* a ) : iCaseName( (TText*) a )
{
};
};
// FUNCTION PROTOTYPES
//?type ?function_name(?arg_list);
// FORWARD DECLARATIONS
//class ?FORWARD_CLASSNAME;
// CLASS DECLARATION
/**
* This a ICMSTIF class.
* ?other_description_lines
*
* @lib ?library
* @since ?Series60_version
*/
NONSHARABLE_CLASS(CICMSTIF) : public CTestModuleBase
{
public: // Constructors and destructor
/**
* Two-phased constructor.
*/
static CICMSTIF* NewL();
/**
* Destructor.
*/
virtual ~CICMSTIF();
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 ICMSTIF.
* It is called once for every instance of ICMSTIF 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 ICMSTIF.
* @return Symbian OS error code
*/
TInt InitL( TFileName& aIniFile, TBool aFirstTime );
/**
* From CTestModuleBase GetTestCasesL is used to inquiry test cases
* from ICMSTIF.
* @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 */ );
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.
*/
CICMSTIF();
/**
* 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 cases
*/
TInt TestCase_001L( TTestResult& aResult );
TInt TestCase_002L( TTestResult& aResult );
TInt TestCase_003L( TTestResult& aResult );
TInt TestCase_004L( TTestResult& aResult );
TInt TestCase_005L( TTestResult& aResult );
TInt TestCase_006L( TTestResult& aResult );
TInt TestCase_007L( TTestResult& aResult );
TInt TestCase_008L( TTestResult& aResult );
TInt TestCase_009L( TTestResult& aResult );
TInt TestCase_010L( TTestResult& aResult );
TInt TestCase_OOML( TTestResult& aResult );
void AllocFailureSimulation (TBool aSwitchedOn);
void SetAllocFailureSimulation( RHeap::TAllocFail aAllocFailureType, TInt aAllocFailureRate );
public: // Data
// Pointer to test (function) to be executed
TestFunction iMethod;
protected: // Data
// ?one_line_short_description_of_data
//?data_declaration;
private: // Data
// ?one_line_short_description_of_data
//?data_declaration;
CStifLogger * iLog;
RHeap::TAllocFail iAllocFailureType;
TInt iAllocFailureRate;
TInt iCurrentAllocFailureRate;
TBool iMemTestEnabled;
// 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 // ICMSTIF_H
// End of File