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