sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // Overload of the CTransition test that provides sl@0: // Heap and Handle leak testing upon a test method. sl@0: // sl@0: // sl@0: sl@0: /** sl@0: @test sl@0: */ sl@0: sl@0: #ifndef __LEAKTESTTRANSITIONS_H__ sl@0: #define __LEAKTESTTRANSITIONS_H__ sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: sl@0: // Constants used to specify various internal states of the CLeakTestTransition sl@0: const TInt KMemoryLeakTestBreakNone = -1; sl@0: const TInt KMemoryLeakTestFailNone = 0; sl@0: const TInt KMemoryLeakTestFailInit = 1; sl@0: /** RunError depth limit test */ sl@0: const TInt KProbablyInfinitelyLooping = 10000; sl@0: sl@0: /** sl@0: @internalAll sl@0: Comments : Overloaded Base class from which test developers sl@0: can derive their own transitions for both sl@0: synchronous and asynchronous methods on sl@0: the test class. sl@0: @see CTransition. sl@0: This overload checks that memory does not sl@0: leak when using a test method, and that sl@0: open handles are closed correctly. sl@0: It is therefore not suitable for testing methods sl@0: which allocate/ or deallocate memory that persists after the method has sl@0: completed, or which open/close handles to resources for the class sl@0: which remain open/closed after the method completes. sl@0: sl@0: This base class is not really suitable for use in testing non-leaving methods. sl@0: (The result being that sections of the code called from within the sl@0: leaving method will if trapped, fail and not exercise the code fully.) sl@0: */ sl@0: sl@0: class CLeakTestTransition : public CTransition sl@0: { sl@0: protected: sl@0: /** sl@0: @fn IMPORT_C CLeakTestTransition(const TDesC& aTransitionId, sl@0: CUnitTestContext& aUTContext, sl@0: TTransitionValidator& aValidator) sl@0: Intended Usage : Default Constructor sl@0: @since 7.0 sl@0: @param aTransactionId The unique id of this transition. sl@0: @param aUTContext The context to run this transition in sl@0: @param aValidator Provides Pre & Post Validation checking sl@0: @pre None sl@0: @post First phase of two phase construction is complete sl@0: */ sl@0: IMPORT_C CLeakTestTransition(const TDesC& aTransitionId, sl@0: CUnitTestContext& aUTContext, sl@0: TTransitionValidator& aValidator); sl@0: /** sl@0: @fn IMPORT_C virtual void RunL() sl@0: Intended Usage : Override of CTransition virtual method. sl@0: @see CTransition::RunL() for normal CTransition behaviour. sl@0: This overload sets up the heap allocation to fail upon a deterministic sl@0: count that is incremented once for each time the RunError method fires sl@0: with a KErrNoMemory error. sl@0: Whichever method is used the second call of RunL() will complete the request sl@0: of the CUnitTest which called this transition by setting its status word. sl@0: If it has been requested that this transition is repeated then the status sl@0: word will be set to KTestBedRepeatTest. sl@0: Error Condition : sl@0: @since 7.0 sl@0: @pre RunTransition() ensures the preconditions for this function sl@0: @post With iTransitionFinished == ETrue test has been completed. sl@0: Otherwise - Leak test has been initialized and sl@0: test method has been called via CTransition::RunL() sl@0: */ sl@0: sl@0: IMPORT_C virtual void RunL(); sl@0: sl@0: sl@0: /** sl@0: @fn IMPORT_C virtual TInt RunError(TInt aErrorCode) sl@0: Intended Usage : Handle the RunL leave that upsets the Active Scheduler. sl@0: Error Condition : @see CTransition. sl@0: @since 7.0 sl@0: @param anErrorCode The error code that was returned by the Leave; sl@0: @return TInt KErrNone sl@0: @pre CLeakTestTransition has been fully constructed, and initialized and sl@0: RunL left with an error code. sl@0: @post CLeakTestTransition is returned to a sensible state and the test is sl@0: resceduled if aErrorCode was KErrNoMemory. sl@0: */ sl@0: sl@0: IMPORT_C virtual TInt RunError(TInt aErrorCode); sl@0: sl@0: /** sl@0: @fn PostTransitionCleanup() sl@0: Intended Usage : Called from the RunL immediately after TransitMethodL() executes sl@0: @since 7.0 sl@0: @pre Must be called from RunL only after TransitMethodL() has completed. sl@0: @post Heap failure is immediately disabled. sl@0: */ sl@0: sl@0: IMPORT_C virtual void PostTransitionCleanup(); sl@0: sl@0: /** The count of process open handles at the start of the RunL. */ sl@0: sl@0: TInt iStartProcessHandleCount; sl@0: /** The count of thread open handles at the start of the RunL. */ sl@0: sl@0: TInt iStartThreadHandleCount; sl@0: /** The count of process open handles at the end of the RunL/RunError. */ sl@0: sl@0: TInt iEndProcessHandleCount; sl@0: /** The count of thread open handles at the end of the RunL/RunError. */ sl@0: sl@0: TInt iEndThreadHandleCount; sl@0: /** The current thread handle */ sl@0: sl@0: RThread iThread; sl@0: sl@0: /** The current iteration of the test method upon which to fail. */ sl@0: sl@0: TInt iFailStep; sl@0: /** The iteration of the test method upon which an unexpected failure occurred. */ sl@0: sl@0: TInt iBreakStep; sl@0: }; sl@0: sl@0: #endif // __LEAKTESTTRANSITIONS_H__ sl@0: