os/ossrv/lowlevellibsandfws/pluginfw/Framework/BackupNotifierTest/BackupNotifierTransitions.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/BackupNotifierTest/BackupNotifierTransitions.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,229 @@
1.4 +// Copyright (c) 2001-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 +// The definitions of the transition classes upon the CBackupNotifier class methods.
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __BACKUPNOTIFIERTRANSITIONS_H__
1.22 +#define __BACKUPNOTIFIERTRANSITIONS_H__
1.23 +
1.24 +#include "TestUtilities.h"
1.25 +#include "StateAccessor.h"
1.26 +#include "LeakTestTransition.h"
1.27 +#include <test_bed/datalogger.h>
1.28 +#include "BackupNotifier.h"
1.29 +#include "BackupNotifierObserver.h"
1.30 +#include "BackupNotifierStateAccessor.h"
1.31 +#include <test_bed/unittest.h>
1.32 +
1.33 +#define CTransitionType CLeakTestTransition
1.34 +
1.35 +class CNotificationStub : public CBase, public MBackupNotifierObserver
1.36 + {
1.37 +public:
1.38 + /**
1.39 + @fn CNotificationStub(CDataLogger& aDataLogger)
1.40 + Intended Usage : Default constructor.
1.41 + Error Condition : None.
1.42 + @since 7.0
1.43 + @param aDataLogger The output logging object.
1.44 + @pre None.
1.45 + @post CNotificationStub is fully constructed, and initialised.
1.46 + */
1.47 + inline CNotificationStub(CDataLogger& aDataLogger);
1.48 +
1.49 + /**
1.50 + @fn ~CNotificationStub()
1.51 + Intended Usage : Default Destructor
1.52 + @since 7.0
1.53 + @pre CNotificationStub is fully constructed.
1.54 + @post CNotificationStub is fully destroyed
1.55 + */
1.56 + virtual inline ~CNotificationStub();
1.57 +
1.58 + /**
1.59 + @fn Suspend()
1.60 + Intended Usage : Overload of the MBackupNotifierObserver method.
1.61 + Error Condition : None.
1.62 + @since 7.0
1.63 + @pre CNotificationStub has been fully constructed.
1.64 + @post Suspend message is logged.
1.65 + */
1.66 + virtual inline TInt Suspend();
1.67 +
1.68 + /**
1.69 + @fn Resume()
1.70 + Intended Usage : Overload of the MBackupNotifierObserver method.
1.71 + Error Condition : None.
1.72 + @since 7.0
1.73 + @pre CNotificationStub has been fully constructed.
1.74 + @post Resume message is logged.
1.75 + */
1.76 + virtual inline TInt Resume();
1.77 +
1.78 +private:
1.79 + CDataLogger& iDataLogger;
1.80 + };
1.81 +
1.82 +// ______________________________________________________________________________
1.83 +//
1.84 +/**
1.85 + @internalComponent
1.86 +
1.87 + Comments : Provide all the CBackupNotifier specific
1.88 + parameters and behaviour on the CBackupNotifier
1.89 + test class for a transition.
1.90 + */
1.91 +class CBackupNotifier_UnitTestContext : public CUnitTestContext
1.92 + {
1.93 +public:
1.94 + /**
1.95 + @fn CBackupNotifier_UnitTestContext(CDataLogger& aDataLogger,
1.96 + MStateAccessor& aStateAccessor,
1.97 + MTransitionObserver& aObserver)
1.98 + Intended Usage : Default constructor.
1.99 + Error Condition : None.
1.100 + @since 7.0
1.101 + @param aDataLogger The output logging object.
1.102 + @param aObserver The observer of this UnitTest's Transitions.
1.103 + @param aStateAccessor WhiteBox state access to the CBackupNotifier class under test.
1.104 + @pre None.
1.105 + @post CBackupNotifier_UnitTestContext is fully constructed, and initialised.
1.106 + */
1.107 + inline CBackupNotifier_UnitTestContext(CDataLogger& aDataLogger,
1.108 + MStateAccessor& aStateAccessor,
1.109 + MTransitionObserver& aObserver);
1.110 +
1.111 + /**
1.112 + @fn ~CBackupNotifier_UnitTestContext()
1.113 + Intended Usage : Default Destructor
1.114 + @since 7.0
1.115 + @pre CBackupNotifier_UnitTestContext is fully constructed.
1.116 + @post CBackupNotifier_UnitTestContext is fully destroyed
1.117 + */
1.118 + virtual inline ~CBackupNotifier_UnitTestContext();
1.119 +
1.120 + /** The instance of the class under test */
1.121 + CBackupNotifier* iBackupNotifier;
1.122 +
1.123 + /** The instance of the stubbed observer of the class under test */
1.124 + CNotificationStub* iStub;
1.125 + }; // CBackupNotifier_UnitTestContext
1.126 +
1.127 +// ______________________________________________________________________________
1.128 +//
1.129 +/**
1.130 + @internalComponent
1.131 +
1.132 + Comments : Transition test of the CBackupNotifier::NewL method.
1.133 + */
1.134 +class CBackupNotifier_NewL_Transition : public CTransitionType
1.135 + {
1.136 +public:
1.137 + /**
1.138 + @fn CBackupNotifier_NewL_Transition(CUnitTestContext& aUTContext,
1.139 + TTransitionValidator& aValidator)
1.140 + Intended Usage : Standard c'tor method.
1.141 + Error Condition : None.
1.142 + @since 7.0
1.143 + @param aUTContext The context this transition is operating in.
1.144 + @param aValidator Used for checking the pre & post conditions of the test object.
1.145 + @pre None.
1.146 + @post CBackupNotifier_NewL_Transition is fully constructed.
1.147 + */
1.148 + CBackupNotifier_NewL_Transition(CUnitTestContext& aUTContext,
1.149 + TTransitionValidator& aValidator);
1.150 + /**
1.151 + @fn TransitMethodL()
1.152 + Intended Usage : To execute the CBackupNotifier::NewL method for the test harness.
1.153 + Error Condition : Leaves with an error code.
1.154 + @leave KErrNoMemory, (@see CBackupNotifier::NewL)
1.155 + @since 7.0
1.156 + @return None
1.157 + @pre CBackupNotifier_NewL_Transition is fully constructed.
1.158 + @post No change in the CBackupNotifier_NewL_Transition apart
1.159 + from iBackupNotifier, which may have changed state.
1.160 + (@see CBackupNotifier::NewL post-condition) for iBackupNotifier's new state.
1.161 + */
1.162 + inline void TransitMethodL();
1.163 +
1.164 + /**
1.165 + @fn Context() const
1.166 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.167 + Error Condition : None.
1.168 + @since 7.0
1.169 + @return The unit test context cast to a CBackupNotifier_UnitTestContext
1.170 + @pre iUTContext is a valid CBackupNotifier_UnitTestContext.
1.171 + @post No change in the CBackupNotifier_NewL_Transition
1.172 + */
1.173 + inline CBackupNotifier_UnitTestContext& Context() const;
1.174 + }; // CBackupNotifier_NewL_Transition
1.175 +
1.176 +// ______________________________________________________________________________
1.177 +//
1.178 +/**
1.179 + @internalComponent
1.180 +
1.181 + Comments : Transition test of the CBackupNotifier::Dtor method.
1.182 + */
1.183 +class CBackupNotifier_Dtor_Transition : public CTransitionType
1.184 + {
1.185 +public:
1.186 + /**
1.187 + @fn CBackupNotifier_Dtor_Transition(CUnitTestContext& aUTContext,
1.188 + TTransitionValidator& aValidator)
1.189 + Intended Usage : Standard c'tor method.
1.190 + Error Condition : None.
1.191 + @since 7.0
1.192 + @param aUTContext The context this transition is operating in.
1.193 + @param aValidator Used for checking the pre & post conditions of the test object.
1.194 + @pre None.
1.195 + @post CBackupNotifier_Dtor_Transition is fully constructed.
1.196 + */
1.197 + CBackupNotifier_Dtor_Transition(CUnitTestContext& aUTContext,
1.198 + TTransitionValidator& aValidator);
1.199 + /**
1.200 + @fn TransitMethodL()
1.201 + Intended Usage : To execute the CBackupNotifier::Dtor method for the test harness.
1.202 + Error Condition : Leaves with an error code.
1.203 + @leave KErrNoMemory, (@see CBackupNotifier::Dtor)
1.204 + @since 7.0
1.205 + @return None
1.206 + @pre CBackupNotifier_Dtor_Transition is fully constructed.
1.207 + @post No change in the CBackupNotifier_Dtor_Transition apart
1.208 + from iBackupNotifier, which may have changed state.
1.209 + (@see CBackupNotifier::Dtor post-condition) for iBackupNotifier's new state.
1.210 + */
1.211 + inline void TransitMethodL();
1.212 +
1.213 + /**
1.214 + @fn Context() const
1.215 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.216 + Error Condition : None.
1.217 + @since 7.0
1.218 + @return The unit test context cast to a CBackupNotifier_UnitTestContext
1.219 + @pre iUTContext is a valid CBackupNotifier_UnitTestContext.
1.220 + @post No change in the CBackupNotifier_Dtor_Transition
1.221 + */
1.222 + inline CBackupNotifier_UnitTestContext& Context() const;
1.223 + }; // CBackupNotifier_Dtor_Transition
1.224 +
1.225 +// Add additional Transition class definitions here...
1.226 +
1.227 +#include "BackupNotifierTransitions.inl"
1.228 +
1.229 +#include "BackupNotifierUnitTestContext.inl"
1.230 +
1.231 +#endif // __BACKUPNOTIFIERTRANSITIONS_H__
1.232 +