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