Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a1cdd89614292d9758aeb97acf8b9ae1cf4526a3 / . / TestON / Documentation / TestON_Document / TestON.bin.cli-module.html
blob: 7dff3fd2ceead2a05caa18d8e07dcfc12a7374a4 [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</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 Module&nbsp;cli
48 </span>
49 </td>
50 <td>
51 <table cellpadding="0" cellspacing="0">
52 <!-- hide/show private -->
53 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
55 <tr><td align="right"><span class="options"
56 >[<a href="frames.html" target="_top">frames</a
57 >]&nbsp;|&nbsp;<a href="TestON.bin.cli-module.html"
58 target="_top">no&nbsp;frames</a>]</span></td></tr>
59 </table>
60 </td>
61 </tr>
62</table>
63<!-- ==================== MODULE DESCRIPTION ==================== -->
64<h1 class="epydoc">Module cli</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.cli-pysrc.html">source&nbsp;code</a></span></p>
65<p>Created on 20-Dec-2012</p>
66
67<hr />
68<div class="fields"> <p><strong>Author:</strong>
69 Anil Kumar (anilkumar.s@paxterrasolutions.com)
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]70 <p>TestON is free software: you can redistribute it and/or modify
71 it under the terms of the GNU General Public License as published
72 by the Free Software Foundation, either version 2 of the License,
73 or (at your option) any later version.</p>
74 <p>TestON is distributed in the hope that it will be useful, but
75 WITHOUT ANY WARRANTY; without even the implied warranty of
76 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
77 General Public License for more details.</p>
78 <p>You should have received a copy of the GNU General Public
79 License along with TestON. If not, see
80 &lt;http://www.gnu.org/licenses/&gt;.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]81 </p>
82</div><!-- ==================== CLASSES ==================== -->
83<a name="section-Classes"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Classes</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-Classes"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <a href="TestON.bin.cli.CLI-class.html" class="summary-name">CLI</a><br />
104 command-line interface to execute the test.
105 </td>
106 </tr>
107<tr>
108 <td width="15%" align="right" valign="top" class="summary">
109 <span class="summary-type">&nbsp;</span>
110 </td><td class="summary">
111 <a href="TestON.bin.cli.TestThread-class.html" class="summary-name">TestThread</a><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]112 TestThread class will handle the test execution and will
113 communicate with the thread in the do_run.
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]114 </td>
115 </tr>
116</table>
117<!-- ==================== FUNCTIONS ==================== -->
118<a name="section-Functions"></a>
119<table class="summary" border="1" cellpadding="3"
120 cellspacing="0" width="100%" bgcolor="white">
121<tr bgcolor="#70b0f0" class="table-header">
122 <td colspan="2" class="table-header">
123 <table border="0" cellpadding="0" cellspacing="0" width="100%">
124 <tr valign="top">
125 <td align="left"><span class="table-header">Functions</span></td>
126 <td align="right" valign="top"
127 ><span class="options">[<a href="#section-Functions"
128 class="privatelink" onclick="toggle_private();"
129 >hide private</a>]</span></td>
130 </tr>
131 </table>
132 </td>
133</tr>
134<tr>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td><span class="summary-sig"><a name="output"></a><span class="summary-sig-name">output</span>(<span class="summary-sig-arg">msg</span>)</span><br />
141 Simply, print the message in console</td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#output">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a name="error"></a><span class="summary-sig-name">error</span>(<span class="summary-sig-arg">msg</span>)</span><br />
158 print the error message.</td>
159 <td align="right" valign="top">
160 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#error">source&nbsp;code</a></span>
161
162 </td>
163 </tr>
164 </table>
165
166 </td>
167 </tr>
168<tr>
169 <td width="15%" align="right" valign="top" class="summary">
170 <span class="summary-type">&nbsp;</span>
171 </td><td class="summary">
172 <table width="100%" cellpadding="0" cellspacing="0" border="0">
173 <tr>
174 <td><span class="summary-sig"><a href="TestON.bin.cli-module.html#dictToObj" class="summary-sig-name">dictToObj</a>(<span class="summary-sig-arg">dictionary</span>)</span><br />
175 This will facilitates the converting of the dictionary to the object.</td>
176 <td align="right" valign="top">
177 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#dictToObj">source&nbsp;code</a></span>
178
179 </td>
180 </tr>
181 </table>
182
183 </td>
184 </tr>
185</table>
186<!-- ==================== VARIABLES ==================== -->
187<a name="section-Variables"></a>
188<table class="summary" border="1" cellpadding="3"
189 cellspacing="0" width="100%" bgcolor="white">
190<tr bgcolor="#70b0f0" class="table-header">
191 <td colspan="2" class="table-header">
192 <table border="0" cellpadding="0" cellspacing="0" width="100%">
193 <tr valign="top">
194 <td align="left"><span class="table-header">Variables</span></td>
195 <td align="right" valign="top"
196 ><span class="options">[<a href="#section-Variables"
197 class="privatelink" onclick="toggle_private();"
198 >hide private</a>]</span></td>
199 </tr>
200 </table>
201 </td>
202</tr>
203<tr>
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type">&nbsp;</span>
206 </td><td class="summary">
207 <a name="dump"></a><span class="summary-name">dump</span> = <code title="pprint.PrettyPrinter(indent= 4)">pprint.PrettyPrinter(indent= 4)</code>
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">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]214 <a href="TestON.bin.cli-module.html#introduction" class="summary-name">introduction</a> = <code title="'''TestON is the testing framework
215Developed by Paxterra Solutions (www.paxterrasolutions.com)'''"><code class="variable-quote">'</code><code class="variable-string">TestON is the testing framework \nDeveloped by</code><code class="variable-ellipsis">...</code></code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]216 </td>
217 </tr>
218<tr>
219 <td width="15%" align="right" valign="top" class="summary">
220 <span class="summary-type">&nbsp;</span>
221 </td><td class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]222 <a name="path"></a><span class="summary-name">path</span> = <code title="'/home/admin/OnosSystemTest/TestON/'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/</code><code class="variable-quote">'</code></code>
223 </td>
224 </tr>
225<tr>
226 <td width="15%" align="right" valign="top" class="summary">
227 <span class="summary-type">&nbsp;</span>
228 </td><td class="summary">
229 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'TestON.bin'"><code class="variable-quote">'</code><code class="variable-string">TestON.bin</code><code class="variable-quote">'</code></code>
230 </td>
231 </tr>
232<tr>
233 <td width="15%" align="right" valign="top" class="summary">
234 <span class="summary-type">&nbsp;</span>
235 </td><td class="summary">
236 <a name="config_path"></a><span class="summary-name">config_path</span> = <code title="'/home/admin/OnosSystemTest/TestON/config/'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/config/</code><code class="variable-quote">'</code></code>
237 </td>
238 </tr>
239<tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <a name="core_path"></a><span class="summary-name">core_path</span> = <code title="'/home/admin/OnosSystemTest/TestON/core'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/core</code><code class="variable-quote">'</code></code>
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 <a name="drivers_path"></a><span class="summary-name">drivers_path</span> = <code title="'/home/admin/OnosSystemTest/TestON/drivers/'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/drivers/</code><code class="variable-quote">'</code></code>
251 </td>
252 </tr>
253<tr>
254 <td width="15%" align="right" valign="top" class="summary">
255 <span class="summary-type">&nbsp;</span>
256 </td><td class="summary">
257 <a name="location"></a><span class="summary-name">location</span> = <code title="'/home/admin/OnosSystemTest/TestON/core'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/core</code><code class="variable-quote">'</code></code>
258 </td>
259 </tr>
260<tr>
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type">&nbsp;</span>
263 </td><td class="summary">
264 <a name="logs_path"></a><span class="summary-name">logs_path</span> = <code title="'/home/admin/OnosSystemTest/TestON/logs/'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/logs/</code><code class="variable-quote">'</code></code>
265 </td>
266 </tr>
267<tr>
268 <td width="15%" align="right" valign="top" class="summary">
269 <span class="summary-type">&nbsp;</span>
270 </td><td class="summary">
271 <a name="tests_path"></a><span class="summary-name">tests_path</span> = <code title="'/home/admin/OnosSystemTest/TestON/tests'"><code class="variable-quote">'</code><code class="variable-string">/home/admin/OnosSystemTest/TestON/tests</code><code class="variable-quote">'</code></code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]272 </td>
273 </tr>
274</table>
275<!-- ==================== FUNCTION DETAILS ==================== -->
276<a name="section-FunctionDetails"></a>
277<table class="details" border="1" cellpadding="3"
278 cellspacing="0" width="100%" bgcolor="white">
279<tr bgcolor="#70b0f0" class="table-header">
280 <td colspan="2" class="table-header">
281 <table border="0" cellpadding="0" cellspacing="0" width="100%">
282 <tr valign="top">
283 <td align="left"><span class="table-header">Function Details</span></td>
284 <td align="right" valign="top"
285 ><span class="options">[<a href="#section-FunctionDetails"
286 class="privatelink" onclick="toggle_private();"
287 >hide private</a>]</span></td>
288 </tr>
289 </table>
290 </td>
291</tr>
292</table>
293<a name="dictToObj"></a>
294<div>
295<table class="details" border="1" cellpadding="3"
296 cellspacing="0" width="100%" bgcolor="white">
297<tr><td>
298 <table width="100%" cellpadding="0" cellspacing="0" border="0">
299 <tr valign="top"><td>
300 <h3 class="epydoc"><span class="sig"><span class="sig-name">dictToObj</span>(<span class="sig-arg">dictionary</span>)</span>
301 </h3>
302 </td><td align="right" valign="top"
303 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#dictToObj">source&nbsp;code</a></span>&nbsp;
304 </td>
305 </tr></table>
306
307 <p>This will facilitates the converting of the dictionary to the object.
308 This method will help to send options as object format to the test.</p>
309 <dl class="fields">
310 </dl>
311</td></tr></table>
312</div>
313<br />
314<!-- ==================== VARIABLES DETAILS ==================== -->
315<a name="section-VariablesDetails"></a>
316<table class="details" border="1" cellpadding="3"
317 cellspacing="0" width="100%" bgcolor="white">
318<tr bgcolor="#70b0f0" class="table-header">
319 <td colspan="2" class="table-header">
320 <table border="0" cellpadding="0" cellspacing="0" width="100%">
321 <tr valign="top">
322 <td align="left"><span class="table-header">Variables Details</span></td>
323 <td align="right" valign="top"
324 ><span class="options">[<a href="#section-VariablesDetails"
325 class="privatelink" onclick="toggle_private();"
326 >hide private</a>]</span></td>
327 </tr>
328 </table>
329 </td>
330</tr>
331</table>
332<a name="introduction"></a>
333<div>
334<table class="details" border="1" cellpadding="3"
335 cellspacing="0" width="100%" bgcolor="white">
336<tr><td>
337 <h3 class="epydoc">introduction</h3>
338
339 <dl class="fields">
340 </dl>
341 <dl class="fields">
342 <dt>Value:</dt>
343 <dd><table><tr><td><pre class="variable">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]344<code class="variable-quote">'''</code><code class="variable-string">TestON is the testing framework </code>
345<code class="variable-string">Developed by Paxterra Solutions (www.paxterrasolutions.com)</code><code class="variable-quote">'''</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]346</pre></td></tr></table>
347</dd>
348 </dl>
349</td></tr></table>
350</div>
351<br />
352<!-- ==================== NAVIGATION BAR ==================== -->
353<table class="navbar" border="0" width="100%" cellpadding="0"
354 bgcolor="#a0c0ff" cellspacing="0">
355 <tr valign="middle">
356 <!-- Home link -->
357 <th>&nbsp;&nbsp;&nbsp;<a
358 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
359
360 <!-- Tree link -->
361 <th>&nbsp;&nbsp;&nbsp;<a
362 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
363
364 <!-- Index link -->
365 <th>&nbsp;&nbsp;&nbsp;<a
366 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
367
368 <!-- Help link -->
369 <th>&nbsp;&nbsp;&nbsp;<a
370 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
371
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]372 <!-- Project homepage -->
373 <th class="navbar" align="right" width="100%">
374 <table border="0" cellpadding="0" cellspacing="0">
375 <tr><th class="navbar" align="center"
376 >TestON</th>
377 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]378 </tr>
379</table>
380<table border="0" cellpadding="0" cellspacing="0" width="100%%">
381 <tr>
382 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]383 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]384 </td>
385 <td align="right" class="footer">
386 <a target="mainFrame" href="http://epydoc.sourceforge.net"
387 >http://epydoc.sourceforge.net</a>
388 </td>
389 </tr>
390</table>
391
392<script type="text/javascript">
393 <!--
394 // Private objects are initially displayed (because if
395 // javascript is turned off then we want them to be
396 // visible); but by default, we want to hide them. So hide
397 // them unless we have a cookie that says to show them.
398 checkCookie();
399 // -->
400</script>
401</body>
402</html>