Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 57b5043e7380aaa19925983adaf767f3d2512b76 / . / TestON / Documentation / TestON_Document / TestON.bin.cli.CLI-class.html
blob: 4e44e3a1055fa4e5368f168c0325ef6bbef0b727 [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.bin.cli.CLI</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
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.bin-module.html">Package&nbsp;bin</a> ::
47 <a href="TestON.bin.cli-module.html">Module&nbsp;cli</a> ::
48 Class&nbsp;CLI
49 </span>
50 </td>
51 <td>
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >]&nbsp;|&nbsp;<a href="TestON.bin.cli.CLI-class.html"
59 target="_top">no&nbsp;frames</a>]</span></td></tr>
60 </table>
61 </td>
62 </tr>
63</table>
64<!-- ==================== CLASS DESCRIPTION ==================== -->
65<h1 class="epydoc">Class CLI</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]66<center>
67<center> <map id="class_hierarchy_for_cli" name="class_hierarchy_for_cli">
68<area shape="rect" id="node1" href="TestON.bin.cli.CLI-class.html" title="CLI" alt="" coords="84,118,127,143"/>
69<area shape="rect" id="node2" href="javascript:void(0);" title="cmd.Cmd" alt="" coords="5,62,83,87"/>
70<area shape="rect" id="node3" href="javascript:void(0);" title="threading.Thread" alt="" coords="107,62,225,87"/>
71<area shape="rect" id="node4" href="javascript:void(0);" title="threading._Verbose" alt="" coords="99,6,233,31"/>
72</map>
73 <img src="class_hierarchy_for_cli.gif" alt='' usemap="#class_hierarchy_for_cli" ismap="ismap" class="graph-without-title" />
74</center>
75</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]76<hr />
77<p>command-line interface to execute the test.</p>
78
79<!-- ==================== INSTANCE METHODS ==================== -->
80<a name="section-InstanceMethods"></a>
81<table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83<tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
86 <tr valign="top">
87 <td align="left"><span class="table-header">Instance Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-InstanceMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
92 </tr>
93 </table>
94 </td>
95</tr>
96<tr>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
103 <span class="summary-sig-arg">teston</span>,
104 <span class="summary-sig-arg">stdin</span>=<span class="summary-sig-default">sys.stdin</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]105 This constructor should always be called with keyword arguments.</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]106 <td align="right" valign="top">
107 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.__init__">source&nbsp;code</a></span>
108
109 </td>
110 </tr>
111 </table>
112
113 </td>
114 </tr>
115<tr>
116 <td width="15%" align="right" valign="top" class="summary">
117 <span class="summary-type">&nbsp;</span>
118 </td><td class="summary">
119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
120 <tr>
121 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#emptyline" class="summary-sig-name">emptyline</a>(<span class="summary-sig-arg">self</span>)</span><br />
122 Don't repeat last command when you hit return.</td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.emptyline">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_help" class="summary-sig-name">do_help</a>(<span class="summary-sig-arg">self</span>,
139 <span class="summary-sig-arg">line</span>)</span><br />
140 Describe available CLI commands.</td>
141 <td align="right" valign="top">
142 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_help">source&nbsp;code</a></span>
143
144 </td>
145 </tr>
146 </table>
147
148 </td>
149 </tr>
150<tr>
151 <td width="15%" align="right" valign="top" class="summary">
152 <span class="summary-type">&nbsp;</span>
153 </td><td class="summary">
154 <table width="100%" cellpadding="0" cellspacing="0" border="0">
155 <tr>
156 <td><span class="summary-sig"><a name="do_run"></a><span class="summary-sig-name">do_run</span>(<span class="summary-sig-arg">self</span>,
157 <span class="summary-sig-arg">args</span>)</span><br />
158 run command will execute the test with following optional command
159 line arguments logdir &lt;directory to store logs in&gt; testcases
160 &lt;list of testcases separated by comma or range of testcases
161 separated by hypen&gt; mail &lt;mail-id or list of mail-ids seperated
162 by comma&gt; example 1, to execute the examples specified in the
163 ~/examples diretory.</td>
164 <td align="right" valign="top">
165 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_run">source&nbsp;code</a></span>
166
167 </td>
168 </tr>
169 </table>
170
171 </td>
172 </tr>
173<tr>
174 <td width="15%" align="right" valign="top" class="summary">
175 <span class="summary-type">&nbsp;</span>
176 </td><td class="summary">
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr>
179 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_resume" class="summary-sig-name">do_resume</a>(<span class="summary-sig-arg">self</span>,
180 <span class="summary-sig-arg">line</span>)</span><br />
181 resume command will continue the execution of paused test.</td>
182 <td align="right" valign="top">
183 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_resume">source&nbsp;code</a></span>
184
185 </td>
186 </tr>
187 </table>
188
189 </td>
190 </tr>
191<tr>
192 <td width="15%" align="right" valign="top" class="summary">
193 <span class="summary-type">&nbsp;</span>
194 </td><td class="summary">
195 <table width="100%" cellpadding="0" cellspacing="0" border="0">
196 <tr>
197 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_nextstep" class="summary-sig-name">do_nextstep</a>(<span class="summary-sig-arg">self</span>,
198 <span class="summary-sig-arg">line</span>)</span><br />
199 nextstep will execute the next-step of the paused test and it will
200 pause the test after finishing of step.</td>
201 <td align="right" valign="top">
202 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_nextstep">source&nbsp;code</a></span>
203
204 </td>
205 </tr>
206 </table>
207
208 </td>
209 </tr>
210<tr>
211 <td width="15%" align="right" valign="top" class="summary">
212 <span class="summary-type">&nbsp;</span>
213 </td><td class="summary">
214 <table width="100%" cellpadding="0" cellspacing="0" border="0">
215 <tr>
216 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_dumpvar" class="summary-sig-name">do_dumpvar</a>(<span class="summary-sig-arg">self</span>,
217 <span class="summary-sig-arg">line</span>)</span><br />
218 dumpvar will print all the test data in raw format.</td>
219 <td align="right" valign="top">
220 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_dumpvar">source&nbsp;code</a></span>
221
222 </td>
223 </tr>
224 </table>
225
226 </td>
227 </tr>
228<tr>
229 <td width="15%" align="right" valign="top" class="summary">
230 <span class="summary-type">&nbsp;</span>
231 </td><td class="summary">
232 <table width="100%" cellpadding="0" cellspacing="0" border="0">
233 <tr>
234 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_currentcase" class="summary-sig-name">do_currentcase</a>(<span class="summary-sig-arg">self</span>,
235 <span class="summary-sig-arg">line</span>)</span><br />
236 currentcase will return the current case in the test execution.</td>
237 <td align="right" valign="top">
238 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_currentcase">source&nbsp;code</a></span>
239
240 </td>
241 </tr>
242 </table>
243
244 </td>
245 </tr>
246<tr>
247 <td width="15%" align="right" valign="top" class="summary">
248 <span class="summary-type">&nbsp;</span>
249 </td><td class="summary">
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr>
252 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_currentstep" class="summary-sig-name">do_currentstep</a>(<span class="summary-sig-arg">self</span>,
253 <span class="summary-sig-arg">line</span>)</span><br />
254 currentstep will return the current step in the test execution.</td>
255 <td align="right" valign="top">
256 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_currentstep">source&nbsp;code</a></span>
257
258 </td>
259 </tr>
260 </table>
261
262 </td>
263 </tr>
264<tr>
265 <td width="15%" align="right" valign="top" class="summary">
266 <span class="summary-type">&nbsp;</span>
267 </td><td class="summary">
268 <table width="100%" cellpadding="0" cellspacing="0" border="0">
269 <tr>
270 <td><span class="summary-sig"><a name="do_stop"></a><span class="summary-sig-name">do_stop</span>(<span class="summary-sig-arg">self</span>,
271 <span class="summary-sig-arg">line</span>)</span><br />
272 Will stop the paused test, if any !</td>
273 <td align="right" valign="top">
274 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_stop">source&nbsp;code</a></span>
275
276 </td>
277 </tr>
278 </table>
279
280 </td>
281 </tr>
282<tr>
283 <td width="15%" align="right" valign="top" class="summary">
284 <span class="summary-type">&nbsp;</span>
285 </td><td class="summary">
286 <table width="100%" cellpadding="0" cellspacing="0" border="0">
287 <tr>
288 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_gettest" class="summary-sig-name">do_gettest</a>(<span class="summary-sig-arg">self</span>,
289 <span class="summary-sig-arg">line</span>)</span><br />
290 gettest will return the test name which is under execution or
291 recently executed.</td>
292 <td align="right" valign="top">
293 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_gettest">source&nbsp;code</a></span>
294
295 </td>
296 </tr>
297 </table>
298
299 </td>
300 </tr>
301<tr>
302 <td width="15%" align="right" valign="top" class="summary">
303 <span class="summary-type">&nbsp;</span>
304 </td><td class="summary">
305 <table width="100%" cellpadding="0" cellspacing="0" border="0">
306 <tr>
307 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_showlog" class="summary-sig-name">do_showlog</a>(<span class="summary-sig-arg">self</span>,
308 <span class="summary-sig-arg">line</span>)</span><br />
309 showlog will show the test's Log teston&gt;showlog Last executed
310 test's log is :
311 //home/openflow/TestON/logs/PoxTest_07_Jan_2013_21_42_11/PoxTest_07_Jan_2013_21_42_11.log
312 .....</td>
313 <td align="right" valign="top">
314 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_showlog">source&nbsp;code</a></span>
315
316 </td>
317 </tr>
318 </table>
319
320 </td>
321 </tr>
322<tr>
323 <td width="15%" align="right" valign="top" class="summary">
324 <span class="summary-type">&nbsp;</span>
325 </td><td class="summary">
326 <table width="100%" cellpadding="0" cellspacing="0" border="0">
327 <tr>
328 <td><span class="summary-sig"><a name="parseArgs"></a><span class="summary-sig-name">parseArgs</span>(<span class="summary-sig-arg">self</span>,
329 <span class="summary-sig-arg">args</span>,
330 <span class="summary-sig-arg">options</span>)</span><br />
331 This will parse the command line arguments.</td>
332 <td align="right" valign="top">
333 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.parseArgs">source&nbsp;code</a></span>
334
335 </td>
336 </tr>
337 </table>
338
339 </td>
340 </tr>
341<tr>
342 <td width="15%" align="right" valign="top" class="summary">
343 <span class="summary-type">&nbsp;</span>
344 </td><td class="summary">
345 <table width="100%" cellpadding="0" cellspacing="0" border="0">
346 <tr>
347 <td><span class="summary-sig"><a name="initOptions"></a><span class="summary-sig-name">initOptions</span>(<span class="summary-sig-arg">self</span>,
348 <span class="summary-sig-arg">options</span>)</span><br />
349 This will initialize the commandline options.</td>
350 <td align="right" valign="top">
351 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.initOptions">source&nbsp;code</a></span>
352
353 </td>
354 </tr>
355 </table>
356
357 </td>
358 </tr>
359<tr>
360 <td width="15%" align="right" valign="top" class="summary">
361 <span class="summary-type">&nbsp;</span>
362 </td><td class="summary">
363 <table width="100%" cellpadding="0" cellspacing="0" border="0">
364 <tr>
365 <td><span class="summary-sig"><a name="testcasesInRange"></a><span class="summary-sig-name">testcasesInRange</span>(<span class="summary-sig-arg">self</span>,
366 <span class="summary-sig-arg">index</span>,
367 <span class="summary-sig-arg">option</span>,
368 <span class="summary-sig-arg">args</span>,
369 <span class="summary-sig-arg">options</span>)</span><br />
370 This method will handle testcases list,specified in range [1-10].</td>
371 <td align="right" valign="top">
372 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.testcasesInRange">source&nbsp;code</a></span>
373
374 </td>
375 </tr>
376 </table>
377
378 </td>
379 </tr>
380<tr>
381 <td width="15%" align="right" valign="top" class="summary">
382 <span class="summary-type">&nbsp;</span>
383 </td><td class="summary">
384 <table width="100%" cellpadding="0" cellspacing="0" border="0">
385 <tr>
386 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#cmdloop" class="summary-sig-name">cmdloop</a>(<span class="summary-sig-arg">self</span>,
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]387 <span class="summary-sig-arg">intro</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">TestON is the testing framework \nDeveloped by Paxterra Solut</code><code class="variable-ellipsis">...</code></span>)</span><br />
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]388 Repeatedly issue a prompt, accept input, parse an initial prefix off
389 the received input, and dispatch to action methods, passing them the
390 remainder of the line as argument.</td>
391 <td align="right" valign="top">
392 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.cmdloop">source&nbsp;code</a></span>
393
394 </td>
395 </tr>
396 </table>
397
398 </td>
399 </tr>
400<tr>
401 <td width="15%" align="right" valign="top" class="summary">
402 <span class="summary-type">&nbsp;</span>
403 </td><td class="summary">
404 <table width="100%" cellpadding="0" cellspacing="0" border="0">
405 <tr>
406 <td><span class="summary-sig"><a name="do_echo"></a><span class="summary-sig-name">do_echo</span>(<span class="summary-sig-arg">self</span>,
407 <span class="summary-sig-arg">line</span>)</span><br />
408 Echoing of given input.</td>
409 <td align="right" valign="top">
410 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_echo">source&nbsp;code</a></span>
411
412 </td>
413 </tr>
414 </table>
415
416 </td>
417 </tr>
418<tr>
419 <td width="15%" align="right" valign="top" class="summary">
420 <span class="summary-type">&nbsp;</span>
421 </td><td class="summary">
422 <table width="100%" cellpadding="0" cellspacing="0" border="0">
423 <tr>
424 <td><span class="summary-sig"><a name="do_sh"></a><span class="summary-sig-name">do_sh</span>(<span class="summary-sig-arg">self</span>,
425 <span class="summary-sig-arg">line</span>)</span><br />
426 Run an external shell command sh pwd sh ifconfig etc.</td>
427 <td align="right" valign="top">
428 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_sh">source&nbsp;code</a></span>
429
430 </td>
431 </tr>
432 </table>
433
434 </td>
435 </tr>
436<tr>
437 <td width="15%" align="right" valign="top" class="summary">
438 <span class="summary-type">&nbsp;</span>
439 </td><td class="summary">
440 <table width="100%" cellpadding="0" cellspacing="0" border="0">
441 <tr>
442 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_py" class="summary-sig-name">do_py</a>(<span class="summary-sig-arg">self</span>,
443 <span class="summary-sig-arg">line</span>)</span><br />
444 Evaluate a Python expression.</td>
445 <td align="right" valign="top">
446 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_py">source&nbsp;code</a></span>
447
448 </td>
449 </tr>
450 </table>
451
452 </td>
453 </tr>
454<tr>
455 <td width="15%" align="right" valign="top" class="summary">
456 <span class="summary-type">&nbsp;</span>
457 </td><td class="summary">
458 <table width="100%" cellpadding="0" cellspacing="0" border="0">
459 <tr>
460 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_interpret" class="summary-sig-name">do_interpret</a>(<span class="summary-sig-arg">self</span>,
461 <span class="summary-sig-arg">line</span>)</span><br />
462 interpret will translate the single line openspeak statement to
463 equivalent python script.</td>
464 <td align="right" valign="top">
465 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_interpret">source&nbsp;code</a></span>
466
467 </td>
468 </tr>
469 </table>
470
471 </td>
472 </tr>
473<tr>
474 <td width="15%" align="right" valign="top" class="summary">
475 <span class="summary-type">&nbsp;</span>
476 </td><td class="summary">
477 <table width="100%" cellpadding="0" cellspacing="0" border="0">
478 <tr>
479 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_do" class="summary-sig-name">do_do</a>(<span class="summary-sig-arg">self</span>,
480 <span class="summary-sig-arg">line</span>)</span><br />
481 Do will translate and execute the openspeak statement for the paused
482 test.</td>
483 <td align="right" valign="top">
484 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_do">source&nbsp;code</a></span>
485
486 </td>
487 </tr>
488 </table>
489
490 </td>
491 </tr>
492<tr>
493 <td width="15%" align="right" valign="top" class="summary">
494 <span class="summary-type">&nbsp;</span>
495 </td><td class="summary">
496 <table width="100%" cellpadding="0" cellspacing="0" border="0">
497 <tr>
498 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_compile" class="summary-sig-name">do_compile</a>(<span class="summary-sig-arg">self</span>,
499 <span class="summary-sig-arg">line</span>)</span><br />
500 compile will translate the openspeak (.ospk) file into TestON test
501 script (python).</td>
502 <td align="right" valign="top">
503 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_compile">source&nbsp;code</a></span>
504
505 </td>
506 </tr>
507 </table>
508
509 </td>
510 </tr>
511<tr>
512 <td width="15%" align="right" valign="top" class="summary">
513 <span class="summary-type">&nbsp;</span>
514 </td><td class="summary">
515 <table width="100%" cellpadding="0" cellspacing="0" border="0">
516 <tr>
517 <td><span class="summary-sig"><a name="do_exit"></a><span class="summary-sig-name">do_exit</span>(<span class="summary-sig-arg">self</span>,
518 <span class="summary-sig-arg">_line</span>)</span><br />
519 Exit</td>
520 <td align="right" valign="top">
521 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_exit">source&nbsp;code</a></span>
522
523 </td>
524 </tr>
525 </table>
526
527 </td>
528 </tr>
529<tr>
530 <td width="15%" align="right" valign="top" class="summary">
531 <span class="summary-type">&nbsp;</span>
532 </td><td class="summary">
533 <table width="100%" cellpadding="0" cellspacing="0" border="0">
534 <tr>
535 <td><span class="summary-sig"><a name="do_quit"></a><span class="summary-sig-name">do_quit</span>(<span class="summary-sig-arg">self</span>,
536 <span class="summary-sig-arg">line</span>)</span><br />
537 Exit</td>
538 <td align="right" valign="top">
539 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_quit">source&nbsp;code</a></span>
540
541 </td>
542 </tr>
543 </table>
544
545 </td>
546 </tr>
547<tr>
548 <td width="15%" align="right" valign="top" class="summary">
549 <span class="summary-type">&nbsp;</span>
550 </td><td class="summary">
551 <table width="100%" cellpadding="0" cellspacing="0" border="0">
552 <tr>
553 <td><span class="summary-sig"><a name="do_EOF"></a><span class="summary-sig-name">do_EOF</span>(<span class="summary-sig-arg">self</span>,
554 <span class="summary-sig-arg">line</span>)</span><br />
555 Exit</td>
556 <td align="right" valign="top">
557 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_EOF">source&nbsp;code</a></span>
558
559 </td>
560 </tr>
561 </table>
562
563 </td>
564 </tr>
565<tr>
566 <td width="15%" align="right" valign="top" class="summary">
567 <span class="summary-type">&nbsp;</span>
568 </td><td class="summary">
569 <table width="100%" cellpadding="0" cellspacing="0" border="0">
570 <tr>
571 <td><span class="summary-sig"><a name="isatty"></a><span class="summary-sig-name">isatty</span>(<span class="summary-sig-arg">self</span>)</span><br />
572 Is our standard input a tty?</td>
573 <td align="right" valign="top">
574 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.isatty">source&nbsp;code</a></span>
575
576 </td>
577 </tr>
578 </table>
579
580 </td>
581 </tr>
582<tr>
583 <td width="15%" align="right" valign="top" class="summary">
584 <span class="summary-type">&nbsp;</span>
585 </td><td class="summary">
586 <table width="100%" cellpadding="0" cellspacing="0" border="0">
587 <tr>
588 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_source" class="summary-sig-name">do_source</a>(<span class="summary-sig-arg">self</span>,
589 <span class="summary-sig-arg">line</span>)</span><br />
590 Read shell commands from an input file and execute them sequentially.</td>
591 <td align="right" valign="top">
592 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_source">source&nbsp;code</a></span>
593
594 </td>
595 </tr>
596 </table>
597
598 </td>
599 </tr>
600<tr>
601 <td width="15%" align="right" valign="top" class="summary">
602 <span class="summary-type">&nbsp;</span>
603 </td><td class="summary">
604 <table width="100%" cellpadding="0" cellspacing="0" border="0">
605 <tr>
606 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#do_updatedriver" class="summary-sig-name">do_updatedriver</a>(<span class="summary-sig-arg">self</span>,
607 <span class="summary-sig-arg">line</span>)</span><br />
608 updatedriver will update the given driver name which exists into mentioned config file.</td>
609 <td align="right" valign="top">
610 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_updatedriver">source&nbsp;code</a></span>
611
612 </td>
613 </tr>
614 </table>
615
616 </td>
617 </tr>
618<tr>
619 <td width="15%" align="right" valign="top" class="summary">
620 <span class="summary-type">&nbsp;</span>
621 </td><td class="summary">
622 <table width="100%" cellpadding="0" cellspacing="0" border="0">
623 <tr>
624 <td><span class="summary-sig"><a name="do_time"></a><span class="summary-sig-name">do_time</span>(<span class="summary-sig-arg">self</span>,
625 <span class="summary-sig-arg">line</span>)</span><br />
626 Measure time taken for any command in TestON.</td>
627 <td align="right" valign="top">
628 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_time">source&nbsp;code</a></span>
629
630 </td>
631 </tr>
632 </table>
633
634 </td>
635 </tr>
636<tr>
637 <td width="15%" align="right" valign="top" class="summary">
638 <span class="summary-type">&nbsp;</span>
639 </td><td class="summary">
640 <table width="100%" cellpadding="0" cellspacing="0" border="0">
641 <tr>
642 <td><span class="summary-sig"><a href="TestON.bin.cli.CLI-class.html#default" class="summary-sig-name">default</a>(<span class="summary-sig-arg">self</span>,
643 <span class="summary-sig-arg">line</span>)</span><br />
644 Called on an input line when the command prefix is not recognized.</td>
645 <td align="right" valign="top">
646 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.default">source&nbsp;code</a></span>
647
648 </td>
649 </tr>
650 </table>
651
652 </td>
653 </tr>
654 <tr>
655 <td colspan="2" class="summary">
656 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
657 <code>__repr__</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]658 <code>getName</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]659 <code>isAlive</code>,
660 <code>isDaemon</code>,
661 <code>is_alive</code>,
662 <code>join</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]663 <code>run</code>,
664 <code>setDaemon</code>,
665 <code>setName</code>,
666 <code>start</code>
667 </p>
668 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]669 <code>_reset_internal_locks</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]670 <code>_set_daemon</code>,
671 <code>_set_ident</code>
672 </p></div>
673 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading._Verbose</code></b> (private):
674 <code>_note</code>
675 </p></div>
676 <p class="indent-wrapped-lines"><b>Inherited from <code>cmd.Cmd</code></b>:
677 <code>columnize</code>,
678 <code>complete</code>,
679 <code>complete_help</code>,
680 <code>completedefault</code>,
681 <code>completenames</code>,
682 <code>get_names</code>,
683 <code>onecmd</code>,
684 <code>parseline</code>,
685 <code>postcmd</code>,
686 <code>postloop</code>,
687 <code>precmd</code>,
688 <code>preloop</code>,
689 <code>print_topics</code>
690 </p>
691 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
692 <code>__delattr__</code>,
693 <code>__format__</code>,
694 <code>__getattribute__</code>,
695 <code>__hash__</code>,
696 <code>__new__</code>,
697 <code>__reduce__</code>,
698 <code>__reduce_ex__</code>,
699 <code>__setattr__</code>,
700 <code>__sizeof__</code>,
701 <code>__str__</code>,
702 <code>__subclasshook__</code>
703 </p>
704 </td>
705 </tr>
706</table>
707<!-- ==================== CLASS VARIABLES ==================== -->
708<a name="section-ClassVariables"></a>
709<table class="summary" border="1" cellpadding="3"
710 cellspacing="0" width="100%" bgcolor="white">
711<tr bgcolor="#70b0f0" class="table-header">
712 <td colspan="2" class="table-header">
713 <table border="0" cellpadding="0" cellspacing="0" width="100%">
714 <tr valign="top">
715 <td align="left"><span class="table-header">Class Variables</span></td>
716 <td align="right" valign="top"
717 ><span class="options">[<a href="#section-ClassVariables"
718 class="privatelink" onclick="toggle_private();"
719 >hide private</a>]</span></td>
720 </tr>
721 </table>
722 </td>
723</tr>
724<tr>
725 <td width="15%" align="right" valign="top" class="summary">
726 <span class="summary-type">&nbsp;</span>
727 </td><td class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]728 <a name="prompt"></a><span class="summary-name">prompt</span> = <code title="'teston&gt; '"><code class="variable-quote">'</code><code class="variable-string">teston&gt; </code><code class="variable-quote">'</code></code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]729 </td>
730 </tr>
731<tr>
732 <td width="15%" align="right" valign="top" class="summary">
733 <span class="summary-type">&nbsp;</span>
734 </td><td class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]735 <a name="helpStr"></a><span class="summary-name">helpStr</span> = <code title="' teston help'"><code class="variable-quote">'</code><code class="variable-string"> teston help</code><code class="variable-quote">'</code></code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]736 </td>
737 </tr>
738 <tr>
739 <td colspan="2" class="summary">
740 <p class="indent-wrapped-lines"><b>Inherited from <code>cmd.Cmd</code></b>:
741 <code>doc_header</code>,
742 <code>doc_leader</code>,
743 <code>identchars</code>,
744 <code>intro</code>,
745 <code>lastcmd</code>,
746 <code>misc_header</code>,
747 <code>nohelp</code>,
748 <code>ruler</code>,
749 <code>undoc_header</code>,
750 <code>use_rawinput</code>
751 </p>
752 </td>
753 </tr>
754</table>
755<!-- ==================== PROPERTIES ==================== -->
756<a name="section-Properties"></a>
757<table class="summary" border="1" cellpadding="3"
758 cellspacing="0" width="100%" bgcolor="white">
759<tr bgcolor="#70b0f0" class="table-header">
760 <td colspan="2" class="table-header">
761 <table border="0" cellpadding="0" cellspacing="0" width="100%">
762 <tr valign="top">
763 <td align="left"><span class="table-header">Properties</span></td>
764 <td align="right" valign="top"
765 ><span class="options">[<a href="#section-Properties"
766 class="privatelink" onclick="toggle_private();"
767 >hide private</a>]</span></td>
768 </tr>
769 </table>
770 </td>
771</tr>
772 <tr>
773 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]774 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
775 <code>daemon</code>,
776 <code>ident</code>,
777 <code>name</code>
778 </p>
779 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
780 <code>_block</code>
781 </p></div>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]782 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
783 <code>__class__</code>
784 </p>
785 </td>
786 </tr>
787</table>
788<!-- ==================== METHOD DETAILS ==================== -->
789<a name="section-MethodDetails"></a>
790<table class="details" border="1" cellpadding="3"
791 cellspacing="0" width="100%" bgcolor="white">
792<tr bgcolor="#70b0f0" class="table-header">
793 <td colspan="2" class="table-header">
794 <table border="0" cellpadding="0" cellspacing="0" width="100%">
795 <tr valign="top">
796 <td align="left"><span class="table-header">Method Details</span></td>
797 <td align="right" valign="top"
798 ><span class="options">[<a href="#section-MethodDetails"
799 class="privatelink" onclick="toggle_private();"
800 >hide private</a>]</span></td>
801 </tr>
802 </table>
803 </td>
804</tr>
805</table>
806<a name="__init__"></a>
807<div>
808<table class="details" border="1" cellpadding="3"
809 cellspacing="0" width="100%" bgcolor="white">
810<tr><td>
811 <table width="100%" cellpadding="0" cellspacing="0" border="0">
812 <tr valign="top"><td>
813 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
814 <span class="sig-arg">teston</span>,
815 <span class="sig-arg">stdin</span>=<span class="sig-default">sys.stdin</span>)</span>
816 <br /><em class="fname">(Constructor)</em>
817 </h3>
818 </td><td align="right" valign="top"
819 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.__init__">source&nbsp;code</a></span>&nbsp;
820 </td>
821 </tr></table>
822
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]823 <p>This constructor should always be called with keyword arguments.
824 Arguments are:</p>
825 <p>*group* should be None; reserved for future extension when a
826 ThreadGroup class is implemented.</p>
827 <p>*target* is the callable object to be invoked by the run() method.
828 Defaults to None, meaning nothing is called.</p>
829 <p>*name* is the thread name. By default, a unique name is constructed of
830 the form &quot;Thread-N&quot; where N is a small decimal number.</p>
831 <p>*args* is the argument tuple for the target invocation. Defaults to
832 ().</p>
833 <p>*kwargs* is a dictionary of keyword arguments for the target
834 invocation. Defaults to {}.</p>
835 <p>If a subclass overrides the constructor, it must make sure to invoke
836 the base class constructor (Thread.__init__()) before doing anything else
837 to the thread.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]838 <dl class="fields">
839 <dt>Overrides:
840 object.__init__
841 <dd><em class="note">(inherited documentation)</em></dd>
842 </dt>
843 </dl>
844</td></tr></table>
845</div>
846<a name="emptyline"></a>
847<div>
848<table class="details" border="1" cellpadding="3"
849 cellspacing="0" width="100%" bgcolor="white">
850<tr><td>
851 <table width="100%" cellpadding="0" cellspacing="0" border="0">
852 <tr valign="top"><td>
853 <h3 class="epydoc"><span class="sig"><span class="sig-name">emptyline</span>(<span class="sig-arg">self</span>)</span>
854 </h3>
855 </td><td align="right" valign="top"
856 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.emptyline">source&nbsp;code</a></span>&nbsp;
857 </td>
858 </tr></table>
859
860 <p>Don't repeat last command when you hit return.</p>
861 <dl class="fields">
862 <dt>Overrides:
863 cmd.Cmd.emptyline
864 </dt>
865 </dl>
866</td></tr></table>
867</div>
868<a name="do_help"></a>
869<div>
870<table class="details" border="1" cellpadding="3"
871 cellspacing="0" width="100%" bgcolor="white">
872<tr><td>
873 <table width="100%" cellpadding="0" cellspacing="0" border="0">
874 <tr valign="top"><td>
875 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_help</span>(<span class="sig-arg">self</span>,
876 <span class="sig-arg">line</span>)</span>
877 </h3>
878 </td><td align="right" valign="top"
879 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_help">source&nbsp;code</a></span>&nbsp;
880 </td>
881 </tr></table>
882
883 <p>Describe available CLI commands.</p>
884 <dl class="fields">
885 <dt>Overrides:
886 cmd.Cmd.do_help
887 </dt>
888 </dl>
889</td></tr></table>
890</div>
891<a name="do_resume"></a>
892<div>
893<table class="details" border="1" cellpadding="3"
894 cellspacing="0" width="100%" bgcolor="white">
895<tr><td>
896 <table width="100%" cellpadding="0" cellspacing="0" border="0">
897 <tr valign="top"><td>
898 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_resume</span>(<span class="sig-arg">self</span>,
899 <span class="sig-arg">line</span>)</span>
900 </h3>
901 </td><td align="right" valign="top"
902 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_resume">source&nbsp;code</a></span>&nbsp;
903 </td>
904 </tr></table>
905
906 <p>resume command will continue the execution of paused test.
907 teston&gt;resume [2013-01-07 23:03:44.640723] [PoxTest] [STEP] 1.1:
908 Checking the host reachability using pingHost 2013-01-07 23:03:44,858 -
909 PoxTest - INFO - Expected Prompt Found ....</p>
910 <dl class="fields">
911 </dl>
912</td></tr></table>
913</div>
914<a name="do_nextstep"></a>
915<div>
916<table class="details" border="1" cellpadding="3"
917 cellspacing="0" width="100%" bgcolor="white">
918<tr><td>
919 <table width="100%" cellpadding="0" cellspacing="0" border="0">
920 <tr valign="top"><td>
921 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_nextstep</span>(<span class="sig-arg">self</span>,
922 <span class="sig-arg">line</span>)</span>
923 </h3>
924 </td><td align="right" valign="top"
925 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_nextstep">source&nbsp;code</a></span>&nbsp;
926 </td>
927 </tr></table>
928
929 <p>nextstep will execute the next-step of the paused test and it will
930 pause the test after finishing of step.</p>
931 <p>teston&gt; nextstep Will pause the test's execution, after completion
932 of this step.....</p>
933 <p>teston&gt; [2013-01-07 21:24:26.286601] [PoxTest] [STEP] 1.8:
934 Checking the host reachability using pingHost 2013-01-07 21:24:26,455 -
935 PoxTest - INFO - Expected Prompt Found ..... teston&gt;</p>
936 <dl class="fields">
937 </dl>
938</td></tr></table>
939</div>
940<a name="do_dumpvar"></a>
941<div>
942<table class="details" border="1" cellpadding="3"
943 cellspacing="0" width="100%" bgcolor="white">
944<tr><td>
945 <table width="100%" cellpadding="0" cellspacing="0" border="0">
946 <tr valign="top"><td>
947 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_dumpvar</span>(<span class="sig-arg">self</span>,
948 <span class="sig-arg">line</span>)</span>
949 </h3>
950 </td><td align="right" valign="top"
951 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_dumpvar">source&nbsp;code</a></span>&nbsp;
952 </td>
953 </tr></table>
954
955 <p>dumpvar will print all the test data in raw format. usgae :
956 teston&gt;dumpvar main Here 'main' will be the test object.</p>
957 <p>teston&gt;dumpvar params here 'params' will be the parameters
958 specified in the params file.</p>
959 <p>teston&gt;dumpvar topology here 'topology' will be topology
960 specification of the test specified in topo file.</p>
961 <dl class="fields">
962 </dl>
963</td></tr></table>
964</div>
965<a name="do_currentcase"></a>
966<div>
967<table class="details" border="1" cellpadding="3"
968 cellspacing="0" width="100%" bgcolor="white">
969<tr><td>
970 <table width="100%" cellpadding="0" cellspacing="0" border="0">
971 <tr valign="top"><td>
972 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_currentcase</span>(<span class="sig-arg">self</span>,
973 <span class="sig-arg">line</span>)</span>
974 </h3>
975 </td><td align="right" valign="top"
976 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_currentcase">source&nbsp;code</a></span>&nbsp;
977 </td>
978 </tr></table>
979
980 <p>currentcase will return the current case in the test execution.</p>
981 <p>teston&gt;currentcase Currently executing test case is: 2</p>
982 <dl class="fields">
983 </dl>
984</td></tr></table>
985</div>
986<a name="do_currentstep"></a>
987<div>
988<table class="details" border="1" cellpadding="3"
989 cellspacing="0" width="100%" bgcolor="white">
990<tr><td>
991 <table width="100%" cellpadding="0" cellspacing="0" border="0">
992 <tr valign="top"><td>
993 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_currentstep</span>(<span class="sig-arg">self</span>,
994 <span class="sig-arg">line</span>)</span>
995 </h3>
996 </td><td align="right" valign="top"
997 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_currentstep">source&nbsp;code</a></span>&nbsp;
998 </td>
999 </tr></table>
1000
1001 <p>currentstep will return the current step in the test execution.</p>
1002 <p>teston&gt;currentstep Currently executing test step is: 2.3</p>
1003 <dl class="fields">
1004 </dl>
1005</td></tr></table>
1006</div>
1007<a name="do_gettest"></a>
1008<div>
1009<table class="details" border="1" cellpadding="3"
1010 cellspacing="0" width="100%" bgcolor="white">
1011<tr><td>
1012 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1013 <tr valign="top"><td>
1014 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_gettest</span>(<span class="sig-arg">self</span>,
1015 <span class="sig-arg">line</span>)</span>
1016 </h3>
1017 </td><td align="right" valign="top"
1018 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_gettest">source&nbsp;code</a></span>&nbsp;
1019 </td>
1020 </tr></table>
1021
1022 <p>gettest will return the test name which is under execution or recently
1023 executed.</p>
1024 <p>Test under execution: teston&gt;gettest Currently executing Test is:
1025 PoxTest</p>
1026 <p>Test recently executed: Recently executed test is: MininetTest</p>
1027 <dl class="fields">
1028 </dl>
1029</td></tr></table>
1030</div>
1031<a name="do_showlog"></a>
1032<div>
1033<table class="details" border="1" cellpadding="3"
1034 cellspacing="0" width="100%" bgcolor="white">
1035<tr><td>
1036 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1037 <tr valign="top"><td>
1038 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_showlog</span>(<span class="sig-arg">self</span>,
1039 <span class="sig-arg">line</span>)</span>
1040 </h3>
1041 </td><td align="right" valign="top"
1042 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_showlog">source&nbsp;code</a></span>&nbsp;
1043 </td>
1044 </tr></table>
1045
1046 <p>showlog will show the test's Log teston&gt;showlog Last executed
1047 test's log is :
1048 //home/openflow/TestON/logs/PoxTest_07_Jan_2013_21_42_11/PoxTest_07_Jan_2013_21_42_11.log
1049 ..... teston&gt;showlog Currently executing Test's log is:
1050 /home/openflow/TestON/logs/PoxTest_07_Jan_2013_21_46_58/PoxTest_07_Jan_2013_21_46_58.log
1051 .....</p>
1052 <dl class="fields">
1053 </dl>
1054</td></tr></table>
1055</div>
1056<a name="cmdloop"></a>
1057<div>
1058<table class="details" border="1" cellpadding="3"
1059 cellspacing="0" width="100%" bgcolor="white">
1060<tr><td>
1061 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1062 <tr valign="top"><td>
1063 <h3 class="epydoc"><span class="sig"><span class="sig-name">cmdloop</span>(<span class="sig-arg">self</span>,
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1064 <span class="sig-arg">intro</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">TestON is the testing framework \nDeveloped by Paxterra Solut</code><code class="variable-ellipsis">...</code></span>)</span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1065 </h3>
1066 </td><td align="right" valign="top"
1067 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.cmdloop">source&nbsp;code</a></span>&nbsp;
1068 </td>
1069 </tr></table>
1070
1071 <p>Repeatedly issue a prompt, accept input, parse an initial prefix off
1072 the received input, and dispatch to action methods, passing them the
1073 remainder of the line as argument.</p>
1074 <dl class="fields">
1075 <dt>Overrides:
1076 cmd.Cmd.cmdloop
1077 <dd><em class="note">(inherited documentation)</em></dd>
1078 </dt>
1079 </dl>
1080</td></tr></table>
1081</div>
1082<a name="do_py"></a>
1083<div>
1084<table class="details" border="1" cellpadding="3"
1085 cellspacing="0" width="100%" bgcolor="white">
1086<tr><td>
1087 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1088 <tr valign="top"><td>
1089 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_py</span>(<span class="sig-arg">self</span>,
1090 <span class="sig-arg">line</span>)</span>
1091 </h3>
1092 </td><td align="right" valign="top"
1093 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_py">source&nbsp;code</a></span>&nbsp;
1094 </td>
1095 </tr></table>
1096
1097 <p>Evaluate a Python expression.</p>
1098 <p>py main.log.info(&quot;Sample Log Information&quot;) 2013-01-07
1099 12:07:26,804 - PoxTest - INFO - Sample Log Information</p>
1100 <dl class="fields">
1101 </dl>
1102</td></tr></table>
1103</div>
1104<a name="do_interpret"></a>
1105<div>
1106<table class="details" border="1" cellpadding="3"
1107 cellspacing="0" width="100%" bgcolor="white">
1108<tr><td>
1109 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1110 <tr valign="top"><td>
1111 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_interpret</span>(<span class="sig-arg">self</span>,
1112 <span class="sig-arg">line</span>)</span>
1113 </h3>
1114 </td><td align="right" valign="top"
1115 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_interpret">source&nbsp;code</a></span>&nbsp;
1116 </td>
1117 </tr></table>
1118
1119 <p>interpret will translate the single line openspeak statement to
1120 equivalent python script.</p>
1121 <p>teston&gt; interpret ASSERT result EQUALS main.TRUE ONPASS &quot;Ping
1122 executed successfully&quot; ONFAIL &quot;Ping failed&quot;
1123 utilities.assert_equals(expect=main.TRUE,actual=result,onpass=&quot;Ping
1124 executed successfully&quot;,onfail=&quot;Ping failed&quot;)</p>
1125 <dl class="fields">
1126 </dl>
1127</td></tr></table>
1128</div>
1129<a name="do_do"></a>
1130<div>
1131<table class="details" border="1" cellpadding="3"
1132 cellspacing="0" width="100%" bgcolor="white">
1133<tr><td>
1134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1135 <tr valign="top"><td>
1136 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_do</span>(<span class="sig-arg">self</span>,
1137 <span class="sig-arg">line</span>)</span>
1138 </h3>
1139 </td><td align="right" valign="top"
1140 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_do">source&nbsp;code</a></span>&nbsp;
1141 </td>
1142 </tr></table>
1143
1144 <p>Do will translate and execute the openspeak statement for the paused
1145 test. do &lt;OpenSpeak statement&gt;</p>
1146 <dl class="fields">
1147 </dl>
1148</td></tr></table>
1149</div>
1150<a name="do_compile"></a>
1151<div>
1152<table class="details" border="1" cellpadding="3"
1153 cellspacing="0" width="100%" bgcolor="white">
1154<tr><td>
1155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1156 <tr valign="top"><td>
1157 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_compile</span>(<span class="sig-arg">self</span>,
1158 <span class="sig-arg">line</span>)</span>
1159 </h3>
1160 </td><td align="right" valign="top"
1161 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_compile">source&nbsp;code</a></span>&nbsp;
1162 </td>
1163 </tr></table>
1164
1165 <p>compile will translate the openspeak (.ospk) file into TestON test
1166 script (python). It will receive the openspeak file path as input and
1167 will generate equivalent test-script file in the same directory.</p>
1168 <p>usage: ----- teston&gt;compile /home/openflow/TestON/PoxTest.ospk</p>
1169 <p>Auto-generated test-script file is
1170 /home/openflow/TestON/PoxTest.py</p>
1171 <dl class="fields">
1172 </dl>
1173</td></tr></table>
1174</div>
1175<a name="do_source"></a>
1176<div>
1177<table class="details" border="1" cellpadding="3"
1178 cellspacing="0" width="100%" bgcolor="white">
1179<tr><td>
1180 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1181 <tr valign="top"><td>
1182 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_source</span>(<span class="sig-arg">self</span>,
1183 <span class="sig-arg">line</span>)</span>
1184 </h3>
1185 </td><td align="right" valign="top"
1186 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_source">source&nbsp;code</a></span>&nbsp;
1187 </td>
1188 </tr></table>
1189
1190 <pre class="literalblock">
1191
1192Read shell commands from an input file and execute them sequentially.
1193cmdsource.txt :
1194
1195&quot;pwd
1196 ls &quot;
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1197
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1198teston&gt;source /home/openflow/cmdsource.txt
1199/home/openflow/TestON/bin/
1200cli.py __init__.py
1201
1202</pre>
1203 <dl class="fields">
1204 </dl>
1205</td></tr></table>
1206</div>
1207<a name="do_updatedriver"></a>
1208<div>
1209<table class="details" border="1" cellpadding="3"
1210 cellspacing="0" width="100%" bgcolor="white">
1211<tr><td>
1212 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1213 <tr valign="top"><td>
1214 <h3 class="epydoc"><span class="sig"><span class="sig-name">do_updatedriver</span>(<span class="sig-arg">self</span>,
1215 <span class="sig-arg">line</span>)</span>
1216 </h3>
1217 </td><td align="right" valign="top"
1218 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.do_updatedriver">source&nbsp;code</a></span>&nbsp;
1219 </td>
1220 </tr></table>
1221
1222 <pre class="literalblock">
1223
1224updatedriver will update the given driver name which exists into mentioned config file.
1225It will receive two optional arguments :
1226
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]12271. Config File Path
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]12282. Drivers List to be updated.
1229
1230Default : config file = &quot;~/TestON/config/updatedriver&quot; ,
1231 Driver List = all drivers specified in config file .
1232
1233</pre>
1234 <dl class="fields">
1235 </dl>
1236</td></tr></table>
1237</div>
1238<a name="default"></a>
1239<div>
1240<table class="details" border="1" cellpadding="3"
1241 cellspacing="0" width="100%" bgcolor="white">
1242<tr><td>
1243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1244 <tr valign="top"><td>
1245 <h3 class="epydoc"><span class="sig"><span class="sig-name">default</span>(<span class="sig-arg">self</span>,
1246 <span class="sig-arg">line</span>)</span>
1247 </h3>
1248 </td><td align="right" valign="top"
1249 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#CLI.default">source&nbsp;code</a></span>&nbsp;
1250 </td>
1251 </tr></table>
1252
1253 <p>Called on an input line when the command prefix is not recognized.</p>
1254 <dl class="fields">
1255 <dt>Overrides:
1256 cmd.Cmd.default
1257 </dt>
1258 </dl>
1259</td></tr></table>
1260</div>
1261<br />
1262<!-- ==================== NAVIGATION BAR ==================== -->
1263<table class="navbar" border="0" width="100%" cellpadding="0"
1264 bgcolor="#a0c0ff" cellspacing="0">
1265 <tr valign="middle">
1266 <!-- Home link -->
1267 <th>&nbsp;&nbsp;&nbsp;<a
1268 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1269
1270 <!-- Tree link -->
1271 <th>&nbsp;&nbsp;&nbsp;<a
1272 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1273
1274 <!-- Index link -->
1275 <th>&nbsp;&nbsp;&nbsp;<a
1276 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1277
1278 <!-- Help link -->
1279 <th>&nbsp;&nbsp;&nbsp;<a
1280 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1281
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1282 <!-- Project homepage -->
1283 <th class="navbar" align="right" width="100%">
1284 <table border="0" cellpadding="0" cellspacing="0">
1285 <tr><th class="navbar" align="center"
1286 >TestON</th>
1287 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1288 </tr>
1289</table>
1290<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1291 <tr>
1292 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1293 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1294 </td>
1295 <td align="right" class="footer">
1296 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1297 >http://epydoc.sourceforge.net</a>
1298 </td>
1299 </tr>
1300</table>
1301
1302<script type="text/javascript">
1303 <!--
1304 // Private objects are initially displayed (because if
1305 // javascript is turned off then we want them to be
1306 // visible); but by default, we want to hide them. So hide
1307 // them unless we have a cookie that says to show them.
1308 checkCookie();
1309 // -->
1310</script>
1311</body>
1312</html>