1 /* |
|
2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef USBMSCPERSONALITYTEST_H |
|
20 #define USBMSCPERSONALITYTEST_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <StifLogger.h> |
|
24 #include <TestScripterInternal.h> |
|
25 #include <StifTestModule.h> |
|
26 #include <TestclassAssert.h> |
|
27 |
|
28 #include <cusbpersonalityplugin.h> |
|
29 #include <cusbpersonalitynotifier.h> |
|
30 |
|
31 #include "UsbMscPersonalityTestActiveObject.h" |
|
32 #include <tusbpersonalityparams.h> |
|
33 #include "DismountClient.h" |
|
34 |
|
35 // CONSTANTS |
|
36 // Logging path |
|
37 _LIT( KUsbMscPersonalityTestLogPath, "\\logs\\testframework\\UsbMscPersonalityTest\\" ); |
|
38 |
|
39 // Logging path for ATS - for phone builds comment this line |
|
40 //_LIT( KUsbMscPersonalityTestLogPath, "e:\\testing\\stiflogs\\" ); |
|
41 |
|
42 // Log file |
|
43 _LIT( KUsbMscPersonalityTestLogFile, "UsbMscPersonalityTest.txt" ); |
|
44 _LIT( KUsbMscPersonalityTestLogFileWithTitle, "UsbMscPersonalityTest_[%S].txt" ); |
|
45 |
|
46 // MACROS |
|
47 #define TEST_CLASS_VERSION_MAJOR 0 |
|
48 #define TEST_CLASS_VERSION_MINOR 0 |
|
49 #define TEST_CLASS_VERSION_BUILD 0 |
|
50 |
|
51 // Macros used to extract test block parameters |
|
52 #define TESTENTRY( A, B )\ |
|
53 if ( !iTestBlockParams.iTestBlockName.Compare( TPtrC( ( TText* ) L ##A ) ) )\ |
|
54 { iTestBlockFunction = &B; iTestBlockFound = ETrue; }\ |
|
55 if ( !iTestBlockParams.iTestBlockName.Compare( TPtrC( ( TText* ) L ##A ) ) ) |
|
56 |
|
57 #define TESTPARAM( A, B )\ |
|
58 GetTestBlockParamL( ( TGetTestBlockParamOperation ) A, ( TTestBlockParamName ) B ); |
|
59 |
|
60 // FUNCTION PROTOTYPES |
|
61 |
|
62 // FORWARD DECLARATIONS |
|
63 |
|
64 // DATA TYPES |
|
65 |
|
66 // Enum type used to determine test block execution result |
|
67 enum TUsbMscPersonalityTestResult |
|
68 { |
|
69 ETestCasePassed, |
|
70 ETestCaseFailed |
|
71 }; |
|
72 |
|
73 // Enum type indicating test block parameter which should be used to store |
|
74 // data extracted from test script |
|
75 enum TTestBlockParamName |
|
76 { |
|
77 eTestOption1, |
|
78 eTestOption2, |
|
79 eTestOption3, |
|
80 eTestIntOption1, |
|
81 eTestIntOption2, |
|
82 eTestIntOption3, |
|
83 eTestCharOption1, |
|
84 eTestCharOption2, |
|
85 eTestCharOption3 |
|
86 }; |
|
87 |
|
88 // Enum type used to indicate which get parameter function should be used |
|
89 enum TGetTestBlockParamOperation |
|
90 { |
|
91 eGetString, |
|
92 eGetInt, |
|
93 eGetChar |
|
94 }; |
|
95 |
|
96 // CLASS DECLARATION |
|
97 /** |
|
98 * TUsbMscPersonalityTestBlockParams test class for storing test block parameters. |
|
99 */ |
|
100 NONSHARABLE_CLASS( TUsbMscPersonalityTestBlockParams ) |
|
101 { |
|
102 public: |
|
103 TPtrC iTestBlockName; |
|
104 |
|
105 TPtrC iTestOption1; |
|
106 TPtrC iTestOption2; |
|
107 TPtrC iTestOption3; |
|
108 |
|
109 TInt iTestIntOption1; |
|
110 TInt iTestIntOption2; |
|
111 TInt iTestIntOption3; |
|
112 |
|
113 TChar iTestCharOption1; |
|
114 TChar iTestCharOption2; |
|
115 TChar iTestCharOption3; |
|
116 }; |
|
117 |
|
118 /** |
|
119 * CUsbMscPersonalityTest test class for STIF Test Framework TestScripter. |
|
120 */ |
|
121 NONSHARABLE_CLASS( CUsbMscPersonalityTest ) : public CScriptBase |
|
122 { |
|
123 public: // Constructors and destructor |
|
124 |
|
125 /** |
|
126 * Two-phased constructor. |
|
127 */ |
|
128 static CUsbMscPersonalityTest* NewL( CTestModuleIf& aTestModuleIf ); |
|
129 |
|
130 /** |
|
131 * Destructor. |
|
132 */ |
|
133 virtual ~CUsbMscPersonalityTest(); |
|
134 |
|
135 public: // New functions |
|
136 public: // Functions from base classes |
|
137 |
|
138 /** |
|
139 * From CScriptBase Runs a script line. |
|
140 * @since ?Series60_version |
|
141 * @param aItem Script line containing method name and parameters |
|
142 * @return Symbian OS error code |
|
143 */ |
|
144 virtual TInt RunMethodL( CStifItemParser& aItem ); |
|
145 |
|
146 protected: // New functions |
|
147 protected: // Functions from base classes |
|
148 private: |
|
149 |
|
150 /** |
|
151 * C++ default constructor. |
|
152 */ |
|
153 CUsbMscPersonalityTest( CTestModuleIf& aTestModuleIf ); |
|
154 |
|
155 /** |
|
156 * By default Symbian 2nd phase constructor is private. |
|
157 */ |
|
158 void ConstructL(); |
|
159 |
|
160 /** |
|
161 * Frees all resources allocated from test methods. |
|
162 * @since ?Series60_version |
|
163 */ |
|
164 void TestDelete(); |
|
165 |
|
166 /** |
|
167 * Constructs all test resources for test methods. |
|
168 */ |
|
169 void TestConstructL(); |
|
170 |
|
171 /** |
|
172 * Extracts test block parameters from script file |
|
173 */ |
|
174 void TestBlocksInfoL(); |
|
175 |
|
176 /** |
|
177 * Executes test block |
|
178 */ |
|
179 TInt ExecuteTestBlock( CStifItemParser& aItem ); |
|
180 |
|
181 /** |
|
182 * Executes proper get parameter function indicated by its arguments |
|
183 */ |
|
184 void GetTestBlockParamL( TGetTestBlockParamOperation aOperation, |
|
185 TTestBlockParamName aParamName ); |
|
186 |
|
187 /** |
|
188 * Method used to log version of test class |
|
189 */ |
|
190 void SendTestClassVersion(); |
|
191 |
|
192 // ADD NEW METHOD DEC HERE |
|
193 // [TestMethods] - Do not remove |
|
194 void ExampleTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
195 TUsbMscPersonalityTestResult& aTestResult ); |
|
196 |
|
197 void ExecuteDismounting(); |
|
198 |
|
199 void PreparePersonalityStartTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
200 TUsbMscPersonalityTestResult& aTestResult ); |
|
201 void FinishPersonalityStartTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
202 TUsbMscPersonalityTestResult& aTestResult ); |
|
203 void PreparePersonalityStopTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
204 TUsbMscPersonalityTestResult& aTestResult ); |
|
205 void FinishPersonalityStopTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
206 TUsbMscPersonalityTestResult& aTestResult ); |
|
207 void InitializationTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
208 TUsbMscPersonalityTestResult& aTestResult ); |
|
209 void StateChangeNotifyTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
210 TUsbMscPersonalityTestResult& aTestResult ); |
|
211 void StateChangeNotifyUndefinedTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
212 TUsbMscPersonalityTestResult& aTestResult ); |
|
213 void StateChangeNotifyStateAddressTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
214 TUsbMscPersonalityTestResult& aTestResult ); |
|
215 void ConfirmPersonalityUnloadTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
216 TUsbMscPersonalityTestResult& aTestResult ); |
|
217 void AllowDismountAfter2SecTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
218 TUsbMscPersonalityTestResult& aTestResult ); |
|
219 void AllowDismountTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
220 TUsbMscPersonalityTestResult& aTestResult ); |
|
221 void NotAllowDismountTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
222 TUsbMscPersonalityTestResult& aTestResult ); |
|
223 void AllowDismountTooLateTestL( TUsbMscPersonalityTestBlockParams& aParams, |
|
224 TUsbMscPersonalityTestResult& aTestResult ); |
|
225 |
|
226 |
|
227 void InitializeTestObjectsL(); |
|
228 void DeleteTestObjects(); |
|
229 |
|
230 |
|
231 public: // Data |
|
232 protected: // Data |
|
233 private: // Data |
|
234 |
|
235 // Member object used to store test block parameters |
|
236 TUsbMscPersonalityTestBlockParams iTestBlockParams; |
|
237 |
|
238 // Used to indicate if test block with specified parameters exist |
|
239 TBool iTestBlockFound; |
|
240 |
|
241 // Function pointer used to call proper test block methods |
|
242 void ( CUsbMscPersonalityTest::*iTestBlockFunction ) |
|
243 ( TUsbMscPersonalityTestBlockParams&, TUsbMscPersonalityTestResult& ); |
|
244 |
|
245 // Not own |
|
246 CStifItemParser* iItem; |
|
247 |
|
248 // Reserved pointer for future extension |
|
249 //TAny* iReserved; |
|
250 |
|
251 // ADD NEW DATA DEC HERE |
|
252 |
|
253 RUsb* iUsb; |
|
254 CUsbPersonalityNotifier* iNotifier; |
|
255 TRequestStatus iRequestStatus; |
|
256 CActiveScheduler* iScheduler; |
|
257 CUsbMscPersonalityTestActiveObject* iActive; |
|
258 CUsbPersonalityPlugin* iPlugin; |
|
259 TUsbPersonalityParams* iParams; |
|
260 CDismountClient* iDismountClient; |
|
261 |
|
262 public: // Friend classes |
|
263 protected: // Friend classes |
|
264 private: // Friend classes |
|
265 |
|
266 }; |
|
267 #endif // USBMSCPERSONALITYTEST_H |
|
268 |
|
269 // End of File |
|