diff -r 7259cf1302ad -r 169364e7e4b4 stif/TestModuleTemplates/TestModuleXXX/inc/TestModuleXXX.h --- a/stif/TestModuleTemplates/TestModuleXXX/inc/TestModuleXXX.h Tue Jul 06 16:05:13 2010 +0300 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,262 +0,0 @@ -/* -* Copyright (c) 2009 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: STIF normal test module declaration -* -*/ - -#ifndef TESTMODULEXXX_H -#define TESTMODULEXXX_H - -// INCLUDES -#include "StifTestModule.h" -#include -#include - -// CONSTANTS -//const ?type ?constant_var = ?constant; - -// MACROS -//#define ?macro ?macro_def -#define TEST_MODULE_VERSION_MAJOR 0 -#define TEST_MODULE_VERSION_MINOR 0 -#define TEST_MODULE_VERSION_BUILD 0 - -// Logging path -_LIT( KTestModuleXXXLogPath, "\\logs\\testframework\\TestModuleXXX\\" ); -// Log file -_LIT( KTestModuleXXXLogFile, "TestModuleXXX.txt" ); -_LIT( KTestModuleXXXLogFileWithTitle, "TestModuleXXX_[%S].txt" ); - -// DATA TYPES -//enum ?declaration -//typedef ?declaration -//extern ?data_type; - -// FUNCTION PROTOTYPES -//?type ?function_name(?arg_list); - -// FORWARD DECLARATIONS -//class ?FORWARD_CLASSNAME; - -// CLASS DECLARATION - -/** -* This a TestModuleXXX class. -* ?other_description_lines -* -* @lib ?library -* @since ?Series60_version -*/ -NONSHARABLE_CLASS(CTestModuleXXX) : public CTestModuleBase - { - public: // Constructors and destructor - - /** - * Two-phased constructor. - */ - static CTestModuleXXX* NewL(); - - /** - * Destructor. - */ - virtual ~CTestModuleXXX(); - - 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 TestModuleXXX. - * It is called once for every instance of TestModuleXXX 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 TestModuleXXX. - * @return Symbian OS error code - */ - TInt InitL( TFileName& aIniFile, TBool aFirstTime ); - - /** - * From CTestModuleBase GetTestCasesL is used to inquiry test cases - * from TestModuleXXX. - * @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& 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 */ ); - - /** - * Method used to log version of test module - */ - void SendTestModuleVersion(); - - - 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. - */ - CTestModuleXXX(); - - /** - * By default Symbian 2nd phase constructor is private. - */ - void ConstructL(); - - /** - * Check for settings and create logger with test case title in file name. - */ - void CreateTitleLoggerL(void); - - /** - * Check for logger settings and delete title logger. - */ - void DeleteTitleLogger(void); - - // Prohibit copy constructor if not deriving from CBase. - // ?classname( const ?classname& ); - // Prohibit assigment operator if not deriving from CBase. - // ?classname& operator=( const ?classname& ); - - public: // Data - // ?one_line_short_description_of_data - //?data_declaration; - - protected: // Data - // ?one_line_short_description_of_data - //?data_declaration; - - private: // Data - // ?one_line_short_description_of_data - //?data_declaration; - - CStifLogger * iLog; - - // Standard logger - CStifLogger *iStdLog; - - // Logger for currently running test case - CStifLogger *iTCLog; - - // Flag saying if test case title should be added to log file name - TBool iAddTestCaseTitleToLogName; - - // Flag saying if test module version was already sent - TBool iVersionLogged; - - // 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 // TESTMODULEXXX_H - -// End of File