os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/UnitTestTest/UnitTestStateAccessor.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/UnitTestTest/UnitTestStateAccessor.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,156 @@
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 definition of the accessor class upon the CUnitTest
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __UNITTESTSTATEACCESSOR_H__
1.22 +#define __UNITTESTSTATEACCESSOR_H__
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <f32file.h>
1.26 +#include <s32stor.h>
1.27 +#include <s32file.h>
1.28 +
1.29 +#include "TestUtilities.h"
1.30 +#include <ecom/test_bed/testbeddefinitions.h>
1.31 +#include "StateAccessor.h"
1.32 +#include <ecom/test_bed/unittest.h>
1.33 +
1.34 +
1.35 +class CUnitTestTestDerivation : public CUnitTest
1.36 + {
1.37 +public:
1.38 + inline CUnitTestTestDerivation(const TDesC& aName, CDataLogger& aDataLogger, MUnitTestObserver& aUnitTestObserver);
1.39 +
1.40 + inline void ConstructL();
1.41 + };
1.42 +
1.43 +// ______________________________________________________________________________
1.44 +//
1.45 +/**
1.46 + @internalComponent
1.47 +
1.48 + Comments : State accessor for the CUnitTest object under test.
1.49 + */
1.50 +class TUnitTest_StateAccessor : public MStateAccessor
1.51 + {
1.52 +public:
1.53 + /**
1.54 + @fn InvariantTest(TAny* aTestObject)
1.55 + Intended Usage : Checks for Incariant violation by the CUnitTest class.
1.56 + @since 7.0
1.57 + @param TAny* A pointer to the object under test.
1.58 + @return TInt KErrNone if the invariants were valid, error code otherwise.
1.59 + @pre TUnitTest_StateAccessor is fully constructed.
1.60 + @post The class under test is set to the state specified.
1.61 + */
1.62 + inline TInt InvariantTest(TAny* aTestObject);
1.63 +
1.64 + /**
1.65 + @fn Internalize(TAny* aTestObject)
1.66 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.67 + @since 7.0
1.68 + @param aTestObject The object to be tested
1.69 + @return KErrNone if the internalize was successful.
1.70 + @return One of the EPOC standard error codes indicating the reason
1.71 + for the failure to load the object state.
1.72 + @pre TUnitTest_StateAccessor is fully constructed, and
1.73 + valid test object must be passed in.
1.74 + @post The class under test is set to the state specified
1.75 + */
1.76 + inline virtual TInt Internalize(TAny* aTestObject);
1.77 +
1.78 + /**
1.79 + @fn Externalize(TAny* aTestObject)
1.80 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.81 + @since 7.0
1.82 + @param aTestObject The object to be tested
1.83 + @return KErrNone if the internalize was successful.
1.84 + @return One of the EPOC standard error codes indicating the reason
1.85 + for the failure to externalize the object.
1.86 + @pre TUnitTest_StateAccessor is fully constructed, and
1.87 + valid test object must be passed in.
1.88 + @post Returns an error code dependant on the result of the test
1.89 + */
1.90 + inline virtual TInt Externalize(TAny* aTestObject);
1.91 +
1.92 + /**
1.93 + @fn InternalizeL(RFileReadStream& aStream, CUnitTest* aUnitTest)
1.94 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.95 + Error Condition : Leaves with an error code.
1.96 + @since 7.0
1.97 + @param aStream The filestream to read from .
1.98 + @param aUnitTest A pointer to the CUnitTest object under test.
1.99 + @return None.
1.100 + @pre TUnitTest_StateAccessor is fully constructed.
1.101 + @post The class under test is set to the state specified.
1.102 + */
1.103 + inline void InternalizeL(RFileReadStream& aStream, CUnitTest* aUnitTest);
1.104 +
1.105 + /**
1.106 + @fn ExternalizeL(RFileWriteStream& aStream, CUnitTest* aUnitTest)
1.107 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.108 + Error Condition : Leaves with an error code.
1.109 + @since 7.0
1.110 + @param aStream The filestream to persist into.
1.111 + @param aUnitTest A pointer to the CUnitTest object under test.
1.112 + @return None.
1.113 + @pre TUnitTest_StateAccessor is fully constructed.
1.114 + @post No change to the class under test, its internal state.
1.115 + is persisted.
1.116 + */
1.117 + inline void ExternalizeL(RFileWriteStream& aStream, CUnitTest* aUnitTest);
1.118 +
1.119 + inline CUnitTestTestDerivation* CreateUnitTest(CUnitTest& aUnitTest, const TDesC& aName, CDataLogger& aDataLogger, MUnitTestObserver& aUnitTestObserver);
1.120 +
1.121 + inline void RunL(CUnitTest& aUnitTest);
1.122 +
1.123 + inline void AddTransitionL(CUnitTest& aUnitTest, CTransition* aTransition);
1.124 +
1.125 + inline void AddBlockingTransitionL(CUnitTest& aUnitTest, CTransition* aTransition);
1.126 +
1.127 + inline void AddLeaveErrorCodeL(CUnitTest& aUnitTest, TInt& aLeaveErrorCode);
1.128 +
1.129 +private:
1.130 + /**
1.131 + @fn InternalizeL(CUnitTest* aUnitTest)
1.132 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.133 + Error Condition : Leaves with an error code.
1.134 + @since 7.0
1.135 + @param TAny* A pointer to the object under test.
1.136 + @return None.
1.137 + @pre TUnitTest_StateAccessor is fully constructed.
1.138 + @post The class under test is set to the state specified.
1.139 + */
1.140 + inline void InternalizeL(CUnitTest* aUnitTest);
1.141 +
1.142 + /**
1.143 + @fn ExternalizeL(CUnitTest* aUnitTest)
1.144 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.145 + Error Condition : Leaves with an error code.
1.146 + @since 7.0
1.147 + @param TAny* A pointer to the object under test.
1.148 + @return None.
1.149 + @pre TUnitTest_StateAccessor is fully constructed.
1.150 + @post No change to the class under test, its internal state.
1.151 + is persisted.
1.152 + */
1.153 + inline void ExternalizeL(CUnitTest* aUnitTest);
1.154 + }; // TUnitTest_StateAccessor
1.155 +
1.156 +#include "UnitTestStateAccessor.inl"
1.157 +
1.158 +#endif // __UNITTESTSTATEACCESSOR_H__
1.159 +