Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 016dce254e4c4a3b478dd177a366cef9d7766e06 / . / TestON / Documentation / TestON_Document / TestON.core.teston.TestON-class.html
blob: 410441c9b60f9eb84d3a6b1c9a87955b7326b51e [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.core.teston.TestON</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
41 <a href="TestON.core-module.html">Package&nbsp;core</a> ::
42 <a href="TestON.core.teston-module.html">Module&nbsp;teston</a> ::
43 Class&nbsp;TestON
44 </span>
45 </td>
46 <td>
47 <table cellpadding="0" cellspacing="0">
48 <!-- hide/show private -->
49 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51 <tr><td align="right"><span class="options"
52 >[<a href="frames.html" target="_top">frames</a
53 >]&nbsp;|&nbsp;<a href="TestON.core.teston.TestON-class.html"
54 target="_top">no&nbsp;frames</a>]</span></td></tr>
55 </table>
56 </td>
57 </tr>
58</table>
59<!-- ==================== CLASS DESCRIPTION ==================== -->
60<h1 class="epydoc">Class TestON</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON">source&nbsp;code</a></span></p>
61<p>TestON will initiate the specified test. The main tasks are : *
62 Initiate the required Component handles for the test. * Create Log file
63 Handles.</p>
64
65<!-- ==================== INSTANCE METHODS ==================== -->
66<a name="section-InstanceMethods"></a>
67<table class="summary" border="1" cellpadding="3"
68 cellspacing="0" width="100%" bgcolor="white">
69<tr bgcolor="#70b0f0" class="table-header">
70 <td colspan="2" class="table-header">
71 <table border="0" cellpadding="0" cellspacing="0" width="100%">
72 <tr valign="top">
73 <td align="left"><span class="table-header">Instance Methods</span></td>
74 <td align="right" valign="top"
75 ><span class="options">[<a href="#section-InstanceMethods"
76 class="privatelink" onclick="toggle_private();"
77 >hide private</a>]</span></td>
78 </tr>
79 </table>
80 </td>
81</tr>
82<tr>
83 <td width="15%" align="right" valign="top" class="summary">
84 <span class="summary-type">&nbsp;</span>
85 </td><td class="summary">
86 <table width="100%" cellpadding="0" cellspacing="0" border="0">
87 <tr>
88 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
89 <span class="summary-sig-arg">options</span>)</span><br />
90 Initialise the component handles specified in the topology file of
91 the specified test.</td>
92 <td align="right" valign="top">
93 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.__init__">source&nbsp;code</a></span>
94
95 </td>
96 </tr>
97 </table>
98
99 </td>
100 </tr>
101<tr>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">&nbsp;</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <td><span class="summary-sig"><a name="configparser"></a><span class="summary-sig-name">configparser</span>(<span class="summary-sig-arg">self</span>)</span><br />
108 It will parse the config file (ofa.cfg) and return as dictionary</td>
109 <td align="right" valign="top">
110 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.configparser">source&nbsp;code</a></span>
111
112 </td>
113 </tr>
114 </table>
115
116 </td>
117 </tr>
118<tr>
119 <td width="15%" align="right" valign="top" class="summary">
120 <span class="summary-type">&nbsp;</span>
121 </td><td class="summary">
122 <table width="100%" cellpadding="0" cellspacing="0" border="0">
123 <tr>
124 <td><span class="summary-sig"><a name="componentInit"></a><span class="summary-sig-name">componentInit</span>(<span class="summary-sig-arg">self</span>,
125 <span class="summary-sig-arg">component</span>)</span><br />
126 This method will initialize specified component</td>
127 <td align="right" valign="top">
128 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.componentInit">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136<tr>
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type">&nbsp;</span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
141 <tr>
142 <td><span class="summary-sig"><a href="TestON.core.teston.TestON-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
143 The Execution of the test script's cases listed in the Test params
144 file will be done here.</td>
145 <td align="right" valign="top">
146 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.run">source&nbsp;code</a></span>
147
148 </td>
149 </tr>
150 </table>
151
152 </td>
153 </tr>
154<tr>
155 <td width="15%" align="right" valign="top" class="summary">
156 <span class="summary-type">&nbsp;</span>
157 </td><td class="summary">
158 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <tr>
160 <td><span class="summary-sig"><a name="runCase"></a><span class="summary-sig-name">runCase</span>(<span class="summary-sig-arg">self</span>,
161 <span class="summary-sig-arg">testCaseNumber</span>)</span></td>
162 <td align="right" valign="top">
163 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.runCase">source&nbsp;code</a></span>
164
165 </td>
166 </tr>
167 </table>
168
169 </td>
170 </tr>
171<tr>
172 <td width="15%" align="right" valign="top" class="summary">
173 <span class="summary-type">&nbsp;</span>
174 </td><td class="summary">
175 <table width="100%" cellpadding="0" cellspacing="0" border="0">
176 <tr>
177 <td><span class="summary-sig"><a name="runStep"></a><span class="summary-sig-name">runStep</span>(<span class="summary-sig-arg">self</span>,
178 <span class="summary-sig-arg">stepList</span>,
179 <span class="summary-sig-arg">code</span>,
180 <span class="summary-sig-arg">testCaseNumber</span>)</span></td>
181 <td align="right" valign="top">
182 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.runStep">source&nbsp;code</a></span>
183
184 </td>
185 </tr>
186 </table>
187
188 </td>
189 </tr>
190<tr>
191 <td width="15%" align="right" valign="top" class="summary">
192 <span class="summary-type">&nbsp;</span>
193 </td><td class="summary">
194 <table width="100%" cellpadding="0" cellspacing="0" border="0">
195 <tr>
196 <td><span class="summary-sig"><a name="addCaseHeader"></a><span class="summary-sig-name">addCaseHeader</span>(<span class="summary-sig-arg">self</span>)</span></td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.addCaseHeader">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr>
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
212 <td><span class="summary-sig"><a name="addCaseFooter"></a><span class="summary-sig-name">addCaseFooter</span>(<span class="summary-sig-arg">self</span>)</span></td>
213 <td align="right" valign="top">
214 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.addCaseFooter">source&nbsp;code</a></span>
215
216 </td>
217 </tr>
218 </table>
219
220 </td>
221 </tr>
222<tr>
223 <td width="15%" align="right" valign="top" class="summary">
224 <span class="summary-type">&nbsp;</span>
225 </td><td class="summary">
226 <table width="100%" cellpadding="0" cellspacing="0" border="0">
227 <tr>
228 <td><span class="summary-sig"><a href="TestON.core.teston.TestON-class.html#cleanup" class="summary-sig-name">cleanup</a>(<span class="summary-sig-arg">self</span>)</span><br />
229 Release all the component handles and the close opened file handles.</td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.cleanup">source&nbsp;code</a></span>
232
233 </td>
234 </tr>
235 </table>
236
237 </td>
238 </tr>
239<tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr>
245 <td><span class="summary-sig"><a name="pause"></a><span class="summary-sig-name">pause</span>(<span class="summary-sig-arg">self</span>)</span><br />
246 This function will pause the test's execution, and will continue
247 after user provide 'resume' command.</td>
248 <td align="right" valign="top">
249 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.pause">source&nbsp;code</a></span>
250
251 </td>
252 </tr>
253 </table>
254
255 </td>
256 </tr>
257<tr>
258 <td width="15%" align="right" valign="top" class="summary">
259 <span class="summary-type">&nbsp;</span>
260 </td><td class="summary">
261 <table width="100%" cellpadding="0" cellspacing="0" border="0">
262 <tr>
263 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>,
264 <span class="summary-sig-arg">*components</span>)</span><br />
265 When test step failed, calling all the components onfail.</td>
266 <td align="right" valign="top">
267 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.onfail">source&nbsp;code</a></span>
268
269 </td>
270 </tr>
271 </table>
272
273 </td>
274 </tr>
275<tr>
276 <td width="15%" align="right" valign="top" class="summary">
277 <span class="summary-type">&nbsp;</span>
278 </td><td class="summary">
279 <table width="100%" cellpadding="0" cellspacing="0" border="0">
280 <tr>
281 <td><span class="summary-sig"><a name="getDriverPath"></a><span class="summary-sig-name">getDriverPath</span>(<span class="summary-sig-arg">self</span>,
282 <span class="summary-sig-arg">driverName</span>)</span><br />
283 Based on the component 'type' specified in the params , this method
284 will find the absolute path , by recursively searching the name of
285 the component.</td>
286 <td align="right" valign="top">
287 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.getDriverPath">source&nbsp;code</a></span>
288
289 </td>
290 </tr>
291 </table>
292
293 </td>
294 </tr>
295<tr>
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
300 <tr>
301 <td><span class="summary-sig"><a name="step"></a><span class="summary-sig-name">step</span>(<span class="summary-sig-arg">self</span>,
302 <span class="summary-sig-arg">stepDesc</span>)</span><br />
303 The step information of the test-case will append to the logs.</td>
304 <td align="right" valign="top">
305 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.step">source&nbsp;code</a></span>
306
307 </td>
308 </tr>
309 </table>
310
311 </td>
312 </tr>
313<tr>
314 <td width="15%" align="right" valign="top" class="summary">
315 <span class="summary-type">&nbsp;</span>
316 </td><td class="summary">
317 <table width="100%" cellpadding="0" cellspacing="0" border="0">
318 <tr>
319 <td><span class="summary-sig"><a name="case"></a><span class="summary-sig-name">case</span>(<span class="summary-sig-arg">self</span>,
320 <span class="summary-sig-arg">testCaseName</span>)</span><br />
321 Test's each test-case information will append to the logs.</td>
322 <td align="right" valign="top">
323 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.case">source&nbsp;code</a></span>
324
325 </td>
326 </tr>
327 </table>
328
329 </td>
330 </tr>
331<tr>
332 <td width="15%" align="right" valign="top" class="summary">
333 <span class="summary-type">&nbsp;</span>
334 </td><td class="summary">
335 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr>
337 <td><span class="summary-sig"><a name="testDesc"></a><span class="summary-sig-name">testDesc</span>(<span class="summary-sig-arg">self</span>,
338 <span class="summary-sig-arg">description</span>)</span><br />
339 Test description will append to the logs.</td>
340 <td align="right" valign="top">
341 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.testDesc">source&nbsp;code</a></span>
342
343 </td>
344 </tr>
345 </table>
346
347 </td>
348 </tr>
349<tr class="private">
350 <td width="15%" align="right" valign="top" class="summary">
351 <span class="summary-type">&nbsp;</span>
352 </td><td class="summary">
353 <table width="100%" cellpadding="0" cellspacing="0" border="0">
354 <tr>
355 <td><span class="summary-sig"><a name="_getTest"></a><span class="summary-sig-name">_getTest</span>(<span class="summary-sig-arg">self</span>)</span><br />
356 This method will parse the test script to find required test
357 information.</td>
358 <td align="right" valign="top">
359 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON._getTest">source&nbsp;code</a></span>
360
361 </td>
362 </tr>
363 </table>
364
365 </td>
366 </tr>
367<tr>
368 <td width="15%" align="right" valign="top" class="summary">
369 <span class="summary-type">&nbsp;</span>
370 </td><td class="summary">
371 <table width="100%" cellpadding="0" cellspacing="0" border="0">
372 <tr>
373 <td><span class="summary-sig"><a name="exit"></a><span class="summary-sig-name">exit</span>(<span class="summary-sig-arg">self</span>)</span></td>
374 <td align="right" valign="top">
375 <span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.exit">source&nbsp;code</a></span>
376
377 </td>
378 </tr>
379 </table>
380
381 </td>
382 </tr>
383</table>
384<!-- ==================== METHOD DETAILS ==================== -->
385<a name="section-MethodDetails"></a>
386<table class="details" border="1" cellpadding="3"
387 cellspacing="0" width="100%" bgcolor="white">
388<tr bgcolor="#70b0f0" class="table-header">
389 <td colspan="2" class="table-header">
390 <table border="0" cellpadding="0" cellspacing="0" width="100%">
391 <tr valign="top">
392 <td align="left"><span class="table-header">Method Details</span></td>
393 <td align="right" valign="top"
394 ><span class="options">[<a href="#section-MethodDetails"
395 class="privatelink" onclick="toggle_private();"
396 >hide private</a>]</span></td>
397 </tr>
398 </table>
399 </td>
400</tr>
401</table>
402<a name="run"></a>
403<div>
404<table class="details" border="1" cellpadding="3"
405 cellspacing="0" width="100%" bgcolor="white">
406<tr><td>
407 <table width="100%" cellpadding="0" cellspacing="0" border="0">
408 <tr valign="top"><td>
409 <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
410 </h3>
411 </td><td align="right" valign="top"
412 ><span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.run">source&nbsp;code</a></span>&nbsp;
413 </td>
414 </tr></table>
415
416 <p>The Execution of the test script's cases listed in the Test params
417 file will be done here. And Update each test case result. This method
418 will return TRUE if it executed all the test cases successfully, else
419 will retun FALSE</p>
420 <dl class="fields">
421 </dl>
422</td></tr></table>
423</div>
424<a name="cleanup"></a>
425<div>
426<table class="details" border="1" cellpadding="3"
427 cellspacing="0" width="100%" bgcolor="white">
428<tr><td>
429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
430 <tr valign="top"><td>
431 <h3 class="epydoc"><span class="sig"><span class="sig-name">cleanup</span>(<span class="sig-arg">self</span>)</span>
432 </h3>
433 </td><td align="right" valign="top"
434 ><span class="codelink"><a href="TestON.core.teston-pysrc.html#TestON.cleanup">source&nbsp;code</a></span>&nbsp;
435 </td>
436 </tr></table>
437
438 <p>Release all the component handles and the close opened file handles.
439 This will return TRUE if all the component handles and log handles closed
440 properly, else return FALSE</p>
441 <dl class="fields">
442 </dl>
443</td></tr></table>
444</div>
445<br />
446<!-- ==================== NAVIGATION BAR ==================== -->
447<table class="navbar" border="0" width="100%" cellpadding="0"
448 bgcolor="#a0c0ff" cellspacing="0">
449 <tr valign="middle">
450 <!-- Home link -->
451 <th>&nbsp;&nbsp;&nbsp;<a
452 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
453
454 <!-- Tree link -->
455 <th>&nbsp;&nbsp;&nbsp;<a
456 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
457
458 <!-- Index link -->
459 <th>&nbsp;&nbsp;&nbsp;<a
460 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
461
462 <!-- Help link -->
463 <th>&nbsp;&nbsp;&nbsp;<a
464 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
465
466 <th class="navbar" width="100%"></th>
467 </tr>
468</table>
469<table border="0" cellpadding="0" cellspacing="0" width="100%%">
470 <tr>
471 <td align="left" class="footer">
472 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
473 </td>
474 <td align="right" class="footer">
475 <a target="mainFrame" href="http://epydoc.sourceforge.net"
476 >http://epydoc.sourceforge.net</a>
477 </td>
478 </tr>
479</table>
480
481<script type="text/javascript">
482 <!--
483 // Private objects are initially displayed (because if
484 // javascript is turned off then we want them to be
485 // visible); but by default, we want to hide them. So hide
486 // them unless we have a cookie that says to show them.
487 checkCookie();
488 // -->
489</script>
490</body>
491</html>