1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/LeakTestTransition.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,147 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Overload of the CTransition test that provides
1.18 +// Heap and Handle leak testing upon a test method.
1.19 +//
1.20 +//
1.21 +
1.22 +/**
1.23 + @test
1.24 +*/
1.25 +
1.26 +#ifndef __LEAKTESTTRANSITIONS_H__
1.27 +#define __LEAKTESTTRANSITIONS_H__
1.28 +
1.29 +#include <ecom/test_bed/testutilities.h>
1.30 +#include <ecom/test_bed/transition.h>
1.31 +#include <ecom/test_bed/testbeddefinitions.h>
1.32 +
1.33 +// Constants used to specify various internal states of the CLeakTestTransition
1.34 +const TInt KMemoryLeakTestBreakNone = -1;
1.35 +const TInt KMemoryLeakTestFailNone = 0;
1.36 +const TInt KMemoryLeakTestFailInit = 1;
1.37 +/** RunError depth limit test */
1.38 +const TInt KProbablyInfinitelyLooping = 10000;
1.39 +
1.40 +/**
1.41 + @internalAll
1.42 + Comments : Overloaded Base class from which test developers
1.43 + can derive their own transitions for both
1.44 + synchronous and asynchronous methods on
1.45 + the test class.
1.46 + @see CTransition.
1.47 + This overload checks that memory does not
1.48 + leak when using a test method, and that
1.49 + open handles are closed correctly.
1.50 + It is therefore not suitable for testing methods
1.51 + which allocate/ or deallocate memory that persists after the method has
1.52 + completed, or which open/close handles to resources for the class
1.53 + which remain open/closed after the method completes.
1.54 +
1.55 + This base class is not really suitable for use in testing non-leaving methods.
1.56 + (The result being that sections of the code called from within the
1.57 + leaving method will if trapped, fail and not exercise the code fully.)
1.58 + */
1.59 +
1.60 +class CLeakTestTransition : public CTransition
1.61 + {
1.62 +protected:
1.63 +/**
1.64 + @fn IMPORT_C CLeakTestTransition(const TDesC& aTransitionId,
1.65 + CUnitTestContext& aUTContext,
1.66 + TTransitionValidator& aValidator)
1.67 + Intended Usage : Default Constructor
1.68 + @since 7.0
1.69 + @param aTransactionId The unique id of this transition.
1.70 + @param aUTContext The context to run this transition in
1.71 + @param aValidator Provides Pre & Post Validation checking
1.72 + @pre None
1.73 + @post First phase of two phase construction is complete
1.74 + */
1.75 + IMPORT_C CLeakTestTransition(const TDesC& aTransitionId,
1.76 + CUnitTestContext& aUTContext,
1.77 + TTransitionValidator& aValidator);
1.78 +/**
1.79 + @fn IMPORT_C virtual void RunL()
1.80 + Intended Usage : Override of CTransition virtual method.
1.81 + @see CTransition::RunL() for normal CTransition behaviour.
1.82 + This overload sets up the heap allocation to fail upon a deterministic
1.83 + count that is incremented once for each time the RunError method fires
1.84 + with a KErrNoMemory error.
1.85 + Whichever method is used the second call of RunL() will complete the request
1.86 + of the CUnitTest which called this transition by setting its status word.
1.87 + If it has been requested that this transition is repeated then the status
1.88 + word will be set to KTestBedRepeatTest.
1.89 + Error Condition :
1.90 + @since 7.0
1.91 + @pre RunTransition() ensures the preconditions for this function
1.92 + @post With iTransitionFinished == ETrue test has been completed.
1.93 + Otherwise - Leak test has been initialized and
1.94 + test method has been called via CTransition::RunL()
1.95 + */
1.96 +
1.97 + IMPORT_C virtual void RunL();
1.98 +
1.99 +
1.100 +/**
1.101 + @fn IMPORT_C virtual TInt RunError(TInt aErrorCode)
1.102 + Intended Usage : Handle the RunL leave that upsets the Active Scheduler.
1.103 + Error Condition : @see CTransition.
1.104 + @since 7.0
1.105 + @param anErrorCode The error code that was returned by the Leave;
1.106 + @return TInt KErrNone
1.107 + @pre CLeakTestTransition has been fully constructed, and initialized and
1.108 + RunL left with an error code.
1.109 + @post CLeakTestTransition is returned to a sensible state and the test is
1.110 + resceduled if aErrorCode was KErrNoMemory.
1.111 + */
1.112 +
1.113 + IMPORT_C virtual TInt RunError(TInt aErrorCode);
1.114 +
1.115 +/**
1.116 + @fn PostTransitionCleanup()
1.117 + Intended Usage : Called from the RunL immediately after TransitMethodL() executes
1.118 + @since 7.0
1.119 + @pre Must be called from RunL only after TransitMethodL() has completed.
1.120 + @post Heap failure is immediately disabled.
1.121 + */
1.122 +
1.123 + IMPORT_C virtual void PostTransitionCleanup();
1.124 +
1.125 +/** The count of process open handles at the start of the RunL. */
1.126 +
1.127 + TInt iStartProcessHandleCount;
1.128 +/** The count of thread open handles at the start of the RunL. */
1.129 +
1.130 + TInt iStartThreadHandleCount;
1.131 +/** The count of process open handles at the end of the RunL/RunError. */
1.132 +
1.133 + TInt iEndProcessHandleCount;
1.134 +/** The count of thread open handles at the end of the RunL/RunError. */
1.135 +
1.136 + TInt iEndThreadHandleCount;
1.137 +/** The current thread handle */
1.138 +
1.139 + RThread iThread;
1.140 +
1.141 +/** The current iteration of the test method upon which to fail. */
1.142 +
1.143 + TInt iFailStep;
1.144 +/** The iteration of the test method upon which an unexpected failure occurred. */
1.145 +
1.146 + TInt iBreakStep;
1.147 + };
1.148 +
1.149 +#endif // __LEAKTESTTRANSITIONS_H__
1.150 +