Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 016dce254e4c4a3b478dd177a366cef9d7766e06 / . / TestON / Documentation / TestON_Document / TestON.bin.cli-module.html
blob: 4f339eee7de44a121ec7943520088b27e5cf206a [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
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 Module&nbsp;cli
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="TestON.bin.cli-module.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57</table>
58<!-- ==================== MODULE DESCRIPTION ==================== -->
59<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>
60<p>Created on 20-Dec-2012</p>
61
62<hr />
63<div class="fields"> <p><strong>Author:</strong>
64 Anil Kumar (anilkumar.s@paxterrasolutions.com)
65 <p>cli will provide the CLI shell for teston framework.</p>
66 </p>
67</div><!-- ==================== CLASSES ==================== -->
68<a name="section-Classes"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Classes</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Classes"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <a href="TestON.bin.cli.CLI-class.html" class="summary-name">CLI</a><br />
89 command-line interface to execute the test.
90 </td>
91 </tr>
92<tr>
93 <td width="15%" align="right" valign="top" class="summary">
94 <span class="summary-type">&nbsp;</span>
95 </td><td class="summary">
96 <a href="TestON.bin.cli.TestThread-class.html" class="summary-name">TestThread</a><br />
97 TestThread class will handle the test execution and will communicate
98 with the thread in the do_run.
99 </td>
100 </tr>
101</table>
102<!-- ==================== FUNCTIONS ==================== -->
103<a name="section-Functions"></a>
104<table class="summary" border="1" cellpadding="3"
105 cellspacing="0" width="100%" bgcolor="white">
106<tr bgcolor="#70b0f0" class="table-header">
107 <td colspan="2" class="table-header">
108 <table border="0" cellpadding="0" cellspacing="0" width="100%">
109 <tr valign="top">
110 <td align="left"><span class="table-header">Functions</span></td>
111 <td align="right" valign="top"
112 ><span class="options">[<a href="#section-Functions"
113 class="privatelink" onclick="toggle_private();"
114 >hide private</a>]</span></td>
115 </tr>
116 </table>
117 </td>
118</tr>
119<tr>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <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 />
126 Simply, print the message in console</td>
127 <td align="right" valign="top">
128 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#output">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136<tr>
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type">&nbsp;</span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
141 <tr>
142 <td><span class="summary-sig"><a name="error"></a><span class="summary-sig-name">error</span>(<span class="summary-sig-arg">msg</span>)</span><br />
143 print the error message.</td>
144 <td align="right" valign="top">
145 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#error">source&nbsp;code</a></span>
146
147 </td>
148 </tr>
149 </table>
150
151 </td>
152 </tr>
153<tr>
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type">&nbsp;</span>
156 </td><td class="summary">
157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
158 <tr>
159 <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 />
160 This will facilitates the converting of the dictionary to the object.</td>
161 <td align="right" valign="top">
162 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#dictToObj">source&nbsp;code</a></span>
163
164 </td>
165 </tr>
166 </table>
167
168 </td>
169 </tr>
170</table>
171<!-- ==================== VARIABLES ==================== -->
172<a name="section-Variables"></a>
173<table class="summary" border="1" cellpadding="3"
174 cellspacing="0" width="100%" bgcolor="white">
175<tr bgcolor="#70b0f0" class="table-header">
176 <td colspan="2" class="table-header">
177 <table border="0" cellpadding="0" cellspacing="0" width="100%">
178 <tr valign="top">
179 <td align="left"><span class="table-header">Variables</span></td>
180 <td align="right" valign="top"
181 ><span class="options">[<a href="#section-Variables"
182 class="privatelink" onclick="toggle_private();"
183 >hide private</a>]</span></td>
184 </tr>
185 </table>
186 </td>
187</tr>
188<tr>
189 <td width="15%" align="right" valign="top" class="summary">
190 <span class="summary-type">&nbsp;</span>
191 </td><td class="summary">
192 <a name="dump"></a><span class="summary-name">dump</span> = <code title="pprint.PrettyPrinter(indent= 4)">pprint.PrettyPrinter(indent= 4)</code>
193 </td>
194 </tr>
195<tr>
196 <td width="15%" align="right" valign="top" class="summary">
197 <span class="summary-type">&nbsp;</span>
198 </td><td class="summary">
199 <a href="TestON.bin.cli-module.html#introduction" class="summary-name">introduction</a> = <code title="&quot;TestON is the testing framework \nDeveloped by Paxterra Solutions (ww\
200w.paxterrasolutions.com)&quot;">&quot;TestON is the testing framework \nDeveloped by<code class="variable-ellipsis">...</code></code>
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="path"></a><span class="summary-name">path</span> = <code title="re.sub(&quot;teston$&quot;, &quot;&quot;, os.getcwd())">re.sub(&quot;teston$&quot;, &quot;&quot;, os.getcwd())</code>
208 </td>
209 </tr>
210</table>
211<!-- ==================== FUNCTION DETAILS ==================== -->
212<a name="section-FunctionDetails"></a>
213<table class="details" border="1" cellpadding="3"
214 cellspacing="0" width="100%" bgcolor="white">
215<tr bgcolor="#70b0f0" class="table-header">
216 <td colspan="2" class="table-header">
217 <table border="0" cellpadding="0" cellspacing="0" width="100%">
218 <tr valign="top">
219 <td align="left"><span class="table-header">Function Details</span></td>
220 <td align="right" valign="top"
221 ><span class="options">[<a href="#section-FunctionDetails"
222 class="privatelink" onclick="toggle_private();"
223 >hide private</a>]</span></td>
224 </tr>
225 </table>
226 </td>
227</tr>
228</table>
229<a name="dictToObj"></a>
230<div>
231<table class="details" border="1" cellpadding="3"
232 cellspacing="0" width="100%" bgcolor="white">
233<tr><td>
234 <table width="100%" cellpadding="0" cellspacing="0" border="0">
235 <tr valign="top"><td>
236 <h3 class="epydoc"><span class="sig"><span class="sig-name">dictToObj</span>(<span class="sig-arg">dictionary</span>)</span>
237 </h3>
238 </td><td align="right" valign="top"
239 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#dictToObj">source&nbsp;code</a></span>&nbsp;
240 </td>
241 </tr></table>
242
243 <p>This will facilitates the converting of the dictionary to the object.
244 This method will help to send options as object format to the test.</p>
245 <dl class="fields">
246 </dl>
247</td></tr></table>
248</div>
249<br />
250<!-- ==================== VARIABLES DETAILS ==================== -->
251<a name="section-VariablesDetails"></a>
252<table class="details" border="1" cellpadding="3"
253 cellspacing="0" width="100%" bgcolor="white">
254<tr bgcolor="#70b0f0" class="table-header">
255 <td colspan="2" class="table-header">
256 <table border="0" cellpadding="0" cellspacing="0" width="100%">
257 <tr valign="top">
258 <td align="left"><span class="table-header">Variables Details</span></td>
259 <td align="right" valign="top"
260 ><span class="options">[<a href="#section-VariablesDetails"
261 class="privatelink" onclick="toggle_private();"
262 >hide private</a>]</span></td>
263 </tr>
264 </table>
265 </td>
266</tr>
267</table>
268<a name="introduction"></a>
269<div>
270<table class="details" border="1" cellpadding="3"
271 cellspacing="0" width="100%" bgcolor="white">
272<tr><td>
273 <h3 class="epydoc">introduction</h3>
274
275 <dl class="fields">
276 </dl>
277 <dl class="fields">
278 <dt>Value:</dt>
279 <dd><table><tr><td><pre class="variable">
280&quot;TestON is the testing framework \nDeveloped by Paxterra Solutions (ww<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
281w.paxterrasolutions.com)&quot;
282</pre></td></tr></table>
283</dd>
284 </dl>
285</td></tr></table>
286</div>
287<br />
288<!-- ==================== NAVIGATION BAR ==================== -->
289<table class="navbar" border="0" width="100%" cellpadding="0"
290 bgcolor="#a0c0ff" cellspacing="0">
291 <tr valign="middle">
292 <!-- Home link -->
293 <th>&nbsp;&nbsp;&nbsp;<a
294 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
295
296 <!-- Tree link -->
297 <th>&nbsp;&nbsp;&nbsp;<a
298 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
299
300 <!-- Index link -->
301 <th>&nbsp;&nbsp;&nbsp;<a
302 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
303
304 <!-- Help link -->
305 <th>&nbsp;&nbsp;&nbsp;<a
306 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
307
308 <th class="navbar" width="100%"></th>
309 </tr>
310</table>
311<table border="0" cellpadding="0" cellspacing="0" width="100%%">
312 <tr>
313 <td align="left" class="footer">
314 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
315 </td>
316 <td align="right" class="footer">
317 <a target="mainFrame" href="http://epydoc.sourceforge.net"
318 >http://epydoc.sourceforge.net</a>
319 </td>
320 </tr>
321</table>
322
323<script type="text/javascript">
324 <!--
325 // Private objects are initially displayed (because if
326 // javascript is turned off then we want them to be
327 // visible); but by default, we want to hide them. So hide
328 // them unless we have a cookie that says to show them.
329 checkCookie();
330 // -->
331</script>
332</body>
333</html>