os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/ComponentTesterTest/ComponentTesterTransitions.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/ComponentTesterTest/ComponentTesterTransitions.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,483 @@
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 +// The definitions of the transition classes upon the CComponentTester class methods.
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __COMPONENTTESTERTRANSITIONS_H__
1.22 +#define __COMPONENTTESTERTRANSITIONS_H__
1.23 +
1.24 +#include "TestUtilities.h"
1.25 +#include "StateAccessor.h"
1.26 +#include "LeakTestTransition.h"
1.27 +#include <ecom/test_bed/datalogger.h>
1.28 +#include "ComponentTester.h"
1.29 +#include "ComponentTesterStateAccessor.h"
1.30 +#include <ecom/test_bed/unittest.h>
1.31 +
1.32 +#define CTransitionType CLeakTestTransition
1.33 +
1.34 +// ______________________________________________________________________________
1.35 +//
1.36 +/**
1.37 + @internalComponent
1.38 +
1.39 + Comments : Provide all the CComponentTester specific
1.40 + parameters and behaviour on the CComponentTester
1.41 + test class for a transition.
1.42 + */
1.43 +class CComponentTester_UnitTestContext : public CUnitTestContext
1.44 + {
1.45 +public:
1.46 + /**
1.47 + @fn CComponentTester_UnitTestContext(CDataLogger& aDataLogger,
1.48 + MStateAccessor& aStateAccessor,
1.49 + MTransitionObserver& aObserver)
1.50 + Intended Usage : Default constructor.
1.51 + Error Condition : None.
1.52 + @since 7.0
1.53 + @param aDataLogger The output logging object.
1.54 + @param aObserver The observer of this UnitTest's Transitions.
1.55 + @param aStateAccessor WhiteBox state access to the CComponentTester class under test.
1.56 + @pre None.
1.57 + @post CComponentTester_UnitTestContext is fully constructed, and initialised.
1.58 + */
1.59 + inline CComponentTester_UnitTestContext(CDataLogger& aDataLogger,
1.60 + MStateAccessor& aStateAccessor,
1.61 + MTransitionObserver& aObserver);
1.62 +
1.63 + /**
1.64 + @fn ~CComponentTester_UnitTestContext()
1.65 + Intended Usage : Default Destructor
1.66 + @since 7.0
1.67 + @pre CComponentTester_UnitTestContext is fully constructed.
1.68 + @post CComponentTester_UnitTestContext is fully destroyed
1.69 + */
1.70 + virtual inline ~CComponentTester_UnitTestContext();
1.71 +
1.72 + /** The instance of the class under test */
1.73 + CComponentTester* iComponentTester;
1.74 + /** The data logger for the ComponentTester to use */
1.75 + CDataLogger* iDataLogger;
1.76 + /** An observer to inform when the test has been completed */
1.77 + MComponentTestObserver* iObserver;
1.78 + /** The unit test for the ComponentTester to use */
1.79 + CUnitTest* iUnitTest;
1.80 + /** An array of the tests to be run by ComponentTester */
1.81 + RPointerArray<TTestInfo> iTests;
1.82 + /** A class derived from the class under test */
1.83 + CComponentTesterTestDerivation* iComponentUnderTest;
1.84 + }; // CComponentTester_UnitTestContext
1.85 +
1.86 +// ______________________________________________________________________________
1.87 +//
1.88 +/**
1.89 + @internalComponent
1.90 +
1.91 + Comments : Transition test of the CComponentTester::NewL method.
1.92 + */
1.93 +class CComponentTester_NewL_Transition : public CTransitionType
1.94 + {
1.95 +public:
1.96 + /**
1.97 + @fn CComponentTester_NewL_Transition(CUnitTestContext& aUTContext,
1.98 + TTransitionValidator& aValidator)
1.99 + Intended Usage : Standard c'tor method.
1.100 + Error Condition : None.
1.101 + @since 7.0
1.102 + @param aUTContext The context this transition is operating in.
1.103 + @param aValidator Used for checking the pre & post conditions of the test object.
1.104 + @pre None.
1.105 + @post CComponentTester_NewL_Transition is fully constructed.
1.106 + */
1.107 + CComponentTester_NewL_Transition(CUnitTestContext& aUTContext,
1.108 + TTransitionValidator& aValidator);
1.109 + /**
1.110 + @fn TransitMethodL()
1.111 + Intended Usage : To execute the CComponentTester::NewL method for the test harness.
1.112 + Error Condition : Leaves with an error code.
1.113 + @leave KErrNoMemory, (@see CComponentTester::NewL)
1.114 + @since 7.0
1.115 + @return None
1.116 + @pre CComponentTester_NewL_Transition is fully constructed.
1.117 + @post No change in the CComponentTester_NewL_Transition apart
1.118 + from iComponentTester, which may have changed state.
1.119 + (@see CComponentTester::NewL post-condition) for iComponentTester's new state.
1.120 + */
1.121 + inline void TransitMethodL();
1.122 +
1.123 + /**
1.124 + @fn Context() const
1.125 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.126 + Error Condition : None.
1.127 + @since 7.0
1.128 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.129 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.130 + @post No change in the CComponentTester_NewL_Transition
1.131 + */
1.132 + inline CComponentTester_UnitTestContext& Context() const;
1.133 + }; // CComponentTester_NewL_Transition
1.134 +
1.135 +// ______________________________________________________________________________
1.136 +//
1.137 +/**
1.138 + @internalComponent
1.139 +
1.140 + Comments : Transition test of the CComponentTester::Dtor method.
1.141 + */
1.142 +class CComponentTester_Dtor_Transition : public CTransition
1.143 + {
1.144 +public:
1.145 + /**
1.146 + @fn CComponentTester_Dtor_Transition(CUnitTestContext& aUTContext,
1.147 + TTransitionValidator& aValidator)
1.148 + Intended Usage : Standard c'tor method.
1.149 + Error Condition : None.
1.150 + @since 7.0
1.151 + @param aUTContext The context this transition is operating in.
1.152 + @param aValidator Used for checking the pre & post conditions of the test object.
1.153 + @pre None.
1.154 + @post CComponentTester_Dtor_Transition is fully constructed.
1.155 + */
1.156 + CComponentTester_Dtor_Transition(CUnitTestContext& aUTContext,
1.157 + TTransitionValidator& aValidator);
1.158 + /**
1.159 + @fn TransitMethodL()
1.160 + Intended Usage : To execute the CComponentTester::Dtor method for the test harness.
1.161 + Error Condition : Leaves with an error code.
1.162 + @leave KErrNoMemory, (@see CComponentTester::Dtor)
1.163 + @since 7.0
1.164 + @return None
1.165 + @pre CComponentTester_Dtor_Transition is fully constructed.
1.166 + @post No change in the CComponentTester_Dtor_Transition apart
1.167 + from iComponentTester, which may have changed state.
1.168 + (@see CComponentTester::Dtor post-condition) for iComponentTester's new state.
1.169 + */
1.170 + inline void TransitMethodL();
1.171 +
1.172 + /**
1.173 + @fn Context() const
1.174 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.175 + Error Condition : None.
1.176 + @since 7.0
1.177 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.178 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.179 + @post No change in the CComponentTester_Dtor_Transition
1.180 + */
1.181 + inline CComponentTester_UnitTestContext& Context() const;
1.182 + }; // CComponentTester_Dtor_Transition
1.183 +
1.184 +// ______________________________________________________________________________
1.185 +//
1.186 +/**
1.187 + @internalComponent
1.188 +
1.189 + Comments : Transition test of the CComponentTester::TransitionSetsL method.
1.190 + */
1.191 +class CComponentTester_TransitionSetsL_Transition : public CTransitionType
1.192 + {
1.193 +public:
1.194 + /**
1.195 + @fn CComponentTester_TransitionSetsL_Transition(CUnitTestContext& aUTContext,
1.196 + TTransitionValidator& aValidator)
1.197 + Intended Usage : Standard c'tor method.
1.198 + Error Condition : None.
1.199 + @since 7.0
1.200 + @param aUTContext The context this transition is operating in.
1.201 + @param aValidator Used for checking the pre & post conditions of the test object.
1.202 + @pre None.
1.203 + @post CComponentTester_TransitionSetsL_Transition is fully constructed.
1.204 + */
1.205 + CComponentTester_TransitionSetsL_Transition(CUnitTestContext& aUTContext,
1.206 + TTransitionValidator& aValidator);
1.207 + /**
1.208 + @fn TransitMethodL()
1.209 + Intended Usage : To execute the CComponentTester::TransitionSetsL method for the test harness.
1.210 + Error Condition : Leaves with an error code.
1.211 + @leave KErrNoMemory, (@see CComponentTester::TransitionSetsL)
1.212 + @since 7.0
1.213 + @return None
1.214 + @pre CComponentTester_TransitionSetsL_Transition is fully constructed.
1.215 + @post No change in the CComponentTester_TransitionSetsL_Transition apart
1.216 + from iComponentTester, which may have changed state.
1.217 + (@see CComponentTester::TransitionSetsL post-condition) for iComponentTester's new state.
1.218 + */
1.219 + inline void TransitMethodL();
1.220 +
1.221 + /**
1.222 + @fn Context() const
1.223 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.224 + Error Condition : None.
1.225 + @since 7.0
1.226 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.227 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.228 + @post No change in the CComponentTester_TransitionSetsL_Transition
1.229 + */
1.230 + inline CComponentTester_UnitTestContext& Context() const;
1.231 + }; // CComponentTester_TransitionSetsL_Transition
1.232 +
1.233 +// ______________________________________________________________________________
1.234 +//
1.235 +/**
1.236 + @internalComponent
1.237 +
1.238 + Comments : Transition test of the CComponentTester::AddUnitTestL method.
1.239 + */
1.240 +class CComponentTester_AddUnitTestL_Transition : public CTransitionType
1.241 + {
1.242 +public:
1.243 + /**
1.244 + @fn CComponentTester_AddUnitTestL_Transition(CUnitTestContext& aUTContext,
1.245 + TTransitionValidator& aValidator)
1.246 + Intended Usage : Standard c'tor method.
1.247 + Error Condition : None.
1.248 + @since 7.0
1.249 + @param aUTContext The context this transition is operating in.
1.250 + @param aValidator Used for checking the pre & post conditions of the test object.
1.251 + @pre None.
1.252 + @post CComponentTester_AddUnitTestL_Transition is fully constructed.
1.253 + */
1.254 + CComponentTester_AddUnitTestL_Transition(CUnitTestContext& aUTContext,
1.255 + TTransitionValidator& aValidator);
1.256 + /**
1.257 + @fn TransitMethodL()
1.258 + Intended Usage : To execute the CComponentTester::AddUnitTestL method for the test harness.
1.259 + Error Condition : Leaves with an error code.
1.260 + @leave KErrNoMemory, (@see CComponentTester::AddUnitTestL)
1.261 + @since 7.0
1.262 + @return None
1.263 + @pre CComponentTester_AddUnitTestL_Transition is fully constructed.
1.264 + @post No change in the CComponentTester_AddUnitTestL_Transition apart
1.265 + from iComponentTester, which may have changed state.
1.266 + (@see CComponentTester::AddUnitTestL post-condition) for iComponentTester's new state.
1.267 + */
1.268 + inline void TransitMethodL();
1.269 +
1.270 + /**
1.271 + @fn Context() const
1.272 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.273 + Error Condition : None.
1.274 + @since 7.0
1.275 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.276 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.277 + @post No change in the CComponentTester_AddUnitTestL_Transition
1.278 + */
1.279 + inline CComponentTester_UnitTestContext& Context() const;
1.280 + }; // CComponentTester_AddUnitTestL_Transition
1.281 +
1.282 +// ______________________________________________________________________________
1.283 +//
1.284 +/**
1.285 + @internalComponent
1.286 +
1.287 + Comments : Transition test of the CComponentTester::AddParamUnitTestL method.
1.288 + */
1.289 +class CComponentTester_AddParamUnitTestL_Transition : public CTransitionType
1.290 + {
1.291 +public:
1.292 + /**
1.293 + @fn CComponentTester_AddParamUnitTestL_Transition(CUnitTestContext& aUTContext,
1.294 + TTransitionValidator& aValidator)
1.295 + Intended Usage : Standard c'tor method.
1.296 + Error Condition : None.
1.297 + @since 7.0
1.298 + @param aUTContext The context this transition is operating in.
1.299 + @param aValidator Used for checking the pre & post conditions of the test object.
1.300 + @pre None.
1.301 + @post CComponentTester_AddParamUnitTestL_Transition is fully constructed.
1.302 + */
1.303 + CComponentTester_AddParamUnitTestL_Transition(CUnitTestContext& aUTContext,
1.304 + TTransitionValidator& aValidator);
1.305 + /**
1.306 + @fn TransitMethodL()
1.307 + Intended Usage : To execute the CComponentTester::AddParamUnitTestL method for the test harness.
1.308 + Error Condition : Leaves with an error code.
1.309 + @leave KErrNoMemory, (@see CComponentTester::AddParamUnitTestL)
1.310 + @since 7.0
1.311 + @return None
1.312 + @pre CComponentTester_AddParamUnitTestL_Transition is fully constructed.
1.313 + @post No change in the CComponentTester_AddParamUnitTestL_Transition apart
1.314 + from iComponentTester, which may have changed state.
1.315 + (@see CComponentTester::AddParamUnitTestL post-condition) for iComponentTester's new state.
1.316 + */
1.317 + inline void TransitMethodL();
1.318 +
1.319 + /**
1.320 + @fn Context() const
1.321 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.322 + Error Condition : None.
1.323 + @since 7.0
1.324 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.325 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.326 + @post No change in the CComponentTester_AddParamUnitTestL_Transition
1.327 + */
1.328 + inline CComponentTester_UnitTestContext& Context() const;
1.329 + }; // CComponentTester_AddParamUnitTestL_Transition
1.330 +
1.331 +// ______________________________________________________________________________
1.332 +//
1.333 +/**
1.334 + @internalComponent
1.335 +
1.336 + Comments : Transition test of the CComponentTester::TestComponent method.
1.337 + */
1.338 +class CComponentTester_TestComponent_Transition : public CTransition
1.339 + {
1.340 +public:
1.341 + /**
1.342 + @fn CComponentTester_TestComponent_Transition(CUnitTestContext& aUTContext,
1.343 + TTransitionValidator& aValidator)
1.344 + Intended Usage : Standard c'tor method.
1.345 + Error Condition : None.
1.346 + @since 7.0
1.347 + @param aUTContext The context this transition is operating in.
1.348 + @param aValidator Used for checking the pre & post conditions of the test object.
1.349 + @pre None.
1.350 + @post CComponentTester_TestComponent_Transition is fully constructed.
1.351 + */
1.352 + CComponentTester_TestComponent_Transition(CUnitTestContext& aUTContext,
1.353 + TTransitionValidator& aValidator);
1.354 + /**
1.355 + @fn TransitMethodL()
1.356 + Intended Usage : To execute the CComponentTester::TestComponent method for the test harness.
1.357 + Error Condition : Leaves with an error code.
1.358 + @leave KErrNoMemory, (@see CComponentTester::TestComponent)
1.359 + @since 7.0
1.360 + @return None
1.361 + @pre CComponentTester_TestComponent_Transition is fully constructed.
1.362 + @post No change in the CComponentTester_TestComponent_Transition apart
1.363 + from iComponentTester, which may have changed state.
1.364 + (@see CComponentTester::TestComponent post-condition) for iComponentTester's new state.
1.365 + */
1.366 + inline void TransitMethodL();
1.367 +
1.368 + /**
1.369 + @fn Context() const
1.370 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.371 + Error Condition : None.
1.372 + @since 7.0
1.373 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.374 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.375 + @post No change in the CComponentTester_TestComponent_Transition
1.376 + */
1.377 + inline CComponentTester_UnitTestContext& Context() const;
1.378 + }; // CComponentTester_TestComponent_Transition
1.379 +
1.380 +// ______________________________________________________________________________
1.381 +//
1.382 +/**
1.383 + @internalComponent
1.384 +
1.385 + Comments : Transition test of the CComponentTester::RunL method.
1.386 + */
1.387 +class CComponentTester_RunL_Transition : public CTransitionType
1.388 + {
1.389 +public:
1.390 + /**
1.391 + @fn CComponentTester_RunL_Transition(CUnitTestContext& aUTContext,
1.392 + TTransitionValidator& aValidator)
1.393 + Intended Usage : Standard c'tor method.
1.394 + Error Condition : None.
1.395 + @since 7.0
1.396 + @param aUTContext The context this transition is operating in.
1.397 + @param aValidator Used for checking the pre & post conditions of the test object.
1.398 + @pre None.
1.399 + @post CComponentTester_RunL_Transition is fully constructed.
1.400 + */
1.401 + CComponentTester_RunL_Transition(CUnitTestContext& aUTContext,
1.402 + TTransitionValidator& aValidator);
1.403 + /**
1.404 + @fn TransitMethodL()
1.405 + Intended Usage : To execute the CComponentTester::RunL method for the test harness.
1.406 + Error Condition : Leaves with an error code.
1.407 + @leave KErrNoMemory, (@see CComponentTester::RunL)
1.408 + @since 7.0
1.409 + @return None
1.410 + @pre CComponentTester_RunL_Transition is fully constructed.
1.411 + @post No change in the CComponentTester_RunL_Transition apart
1.412 + from iComponentTester, which may have changed state.
1.413 + (@see CComponentTester::RunL post-condition) for iComponentTester's new state.
1.414 + */
1.415 + inline void TransitMethodL();
1.416 +
1.417 + /**
1.418 + @fn Context() const
1.419 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.420 + Error Condition : None.
1.421 + @since 7.0
1.422 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.423 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.424 + @post No change in the CComponentTester_RunL_Transition
1.425 + */
1.426 + inline CComponentTester_UnitTestContext& Context() const;
1.427 + }; // CComponentTester_RunL_Transition
1.428 +
1.429 +// ______________________________________________________________________________
1.430 +//
1.431 +/**
1.432 + @internalComponent
1.433 +
1.434 + Comments : Transition test of the CComponentTester::Complete method.
1.435 + */
1.436 +class CComponentTester_Complete_Transition : public CTransition
1.437 + {
1.438 +public:
1.439 + /**
1.440 + @fn CComponentTester_Complete_Transition(CUnitTestContext& aUTContext,
1.441 + TTransitionValidator& aValidator)
1.442 + Intended Usage : Standard c'tor method.
1.443 + Error Condition : None.
1.444 + @since 7.0
1.445 + @param aUTContext The context this transition is operating in.
1.446 + @param aValidator Used for checking the pre & post conditions of the test object.
1.447 + @pre None.
1.448 + @post CComponentTester_Complete_Transition is fully constructed.
1.449 + */
1.450 + CComponentTester_Complete_Transition(CUnitTestContext& aUTContext,
1.451 + TTransitionValidator& aValidator);
1.452 + /**
1.453 + @fn TransitMethodL()
1.454 + Intended Usage : To execute the CComponentTester::Complete method for the test harness.
1.455 + Error Condition : Leaves with an error code.
1.456 + @leave KErrNoMemory, (@see CComponentTester::Complete)
1.457 + @since 7.0
1.458 + @return None
1.459 + @pre CComponentTester_Complete_Transition is fully constructed.
1.460 + @post No change in the CComponentTester_Complete_Transition apart
1.461 + from iComponentTester, which may have changed state.
1.462 + (@see CComponentTester::Complete post-condition) for iComponentTester's new state.
1.463 + */
1.464 + inline void TransitMethodL();
1.465 +
1.466 + /**
1.467 + @fn Context() const
1.468 + Intended Usage : To provide access to the unit test context cast to the correct type.
1.469 + Error Condition : None.
1.470 + @since 7.0
1.471 + @return The unit test context cast to a CComponentTester_UnitTestContext
1.472 + @pre iUTContext is a valid CComponentTester_UnitTestContext.
1.473 + @post No change in the CComponentTester_Complete_Transition
1.474 + */
1.475 + inline CComponentTester_UnitTestContext& Context() const;
1.476 + }; // CComponentTester_Complete_Transition
1.477 +
1.478 +
1.479 +// Add additional Transition class definitions here...
1.480 +
1.481 +#include "ComponentTesterTransitions.inl"
1.482 +
1.483 +#include "ComponentTesterUnitTestContext.inl"
1.484 +
1.485 +#endif // __COMPONENTTESTERTRANSITIONS_H__
1.486 +