os/ossrv/lowlevellibsandfws/pluginfw/Framework/BackupNotifierTest/BackupNotifierUnitTest.h
1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // The unit test class definitions for the CBackupNotifier class.
18 #ifndef __BACKUPNOTIFIERUNITTEST_H__
19 #define __BACKUPNOTIFIERUNITTEST_H__
21 #include <test_bed/testbeddefinitions.h>
22 #include "BackupNotifierStateAccessor.h"
23 #include "BackupNotifierTransitionValidation.h"
24 #include "BackupNotifierTransitions.h"
26 // ______________________________________________________________________________
31 Comments : Unit Test for CreateAndDestroy on CBackupNotifier, the class under test.
33 class CBackupNotifier_CreateAndDestroy_UnitTest : public CUnitTest
37 @fn NewL(CDataLogger& aDataLogger,
38 MUnitTestObserver& aObserver)
39 Intended Usage : Standard two-phase construction which leaves nothing on the
41 Error Condition : Leaves with the error code.
44 @param aDataLogger The output logging object.
45 @param aObserver The observer of this UnitTest.
46 @return CBackupNotifier_CreateAndDestroy_UnitTest* The constructed object.
48 @post CBackupNotifier_CreateAndDestroy_UnitTest is fully constructed, and initialised.
50 static CBackupNotifier_CreateAndDestroy_UnitTest* NewL(CDataLogger& aDataLogger,
51 MUnitTestObserver& aObserver);
54 @fn RunError(TInt aError)
55 Intended Usage : Intercept the panic caused by a RunL leave,
56 to restore the CBackupNotifier_CreateAndDestroy_UnitTest
57 object to a sensible state.
58 (called by the Active Scheduler immediately before the Panic).
59 Error Condition : @see CUnitTest::RunError().
61 @return TInt KErrNone if cleanup successful, otherwise
62 @see CUnitTest::RunError()
63 @pre CBackupNotifier_CreateAndDestroy_UnitTest is fully constructed, and initialised.
64 @post The object has been restored to a sensible state.
66 inline TInt RunError(TInt aError);
69 @fn ~CBackupNotifier_CreateAndDestroy_UnitTest()
70 Intended Usage : Standard Destructor.
71 Error Condition : None.
73 @pre CBackupNotifier_CreateAndDestroy_UnitTest is fully constructed.
74 @post CBackupNotifier_CreateAndDestroy_UnitTest is fully destroyed.
76 ~CBackupNotifier_CreateAndDestroy_UnitTest();
80 @fn CBackupNotifier_CreateAndDestroy_UnitTest(CDataLogger& aDataLogger,
81 MUnitTestObserver& aObserver)
82 Intended Usage : Default constructor.
83 Error Condition : None.
85 @param aDataLogger The output logging object.
86 @param aObserver The observer of this UnitTest.
87 @param aStateAccessor WhiteBox state access to the CBackupNotifier class.
89 @post CBackupNotifier_CreateAndDestroy_UnitTest is fully constructed.
91 inline CBackupNotifier_CreateAndDestroy_UnitTest(CDataLogger& aDataLogger,
92 MUnitTestObserver& aObserver);
96 Intended Usage : Second phase of safe two phase construction,
97 to complete the object initialisation.
98 Error Condition : Leaves with an error code.
99 @leave KErrNoMemory, and @see CUnitTest::BaseNewL().
102 @pre CBackupNotifier_CreateAndDestroy_UnitTest is fully constructed.
103 @post CBackupNotifier_CreateAndDestroy_UnitTest is fully initialised.
108 The context of the Unit Test.
109 i.e The CBackupNotifier class tested by this UnitTest's transitions.
111 CBackupNotifier_UnitTestContext* iUTContext;
112 TBackupNotifier_StateAccessor* iStateAccessor;
113 /* C'tor, d'tor, and method transition validators */
114 TBackupNotifier_Ctor_TransitionValidator* iCtorValidator;
115 // TBackupNotifier_CreateAndDestroy_TransitionValidator* iCreateAndDestroyValidator;
116 TBackupNotifier_Dtor_TransitionValidator* iDtorValidator;
117 }; // CBackupNotifier_CreateAndDestroy_UnitTest
119 #endif // __BACKUPNOTIFIERUNITTEST_H__