|
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>ats3.Ats3TestPlan</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 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="ats3-module.html">Package ats3</a> :: |
|
38 Class Ats3TestPlan |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="ats3.Ats3TestPlan-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class Ats3TestPlan</h1><span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <strong class="uidshort">Ats3TestPlan</strong> |
|
60 </pre> |
|
61 |
|
62 <hr /> |
|
63 <p>Tells ATS3 server what to test and how.</p> |
|
64 <p>The ATS3 test plan from which the test.xml file can be written. The test |
|
65 plan captures all the data related to a test run: flashing, installation |
|
66 of data files and configuration files, test cases, and the notifications.</p><br /><br /> |
|
67 |
|
68 <!-- ==================== INSTANCE METHODS ==================== --> |
|
69 <a name="section-InstanceMethods"></a> |
|
70 <table class="summary" border="1" cellpadding="3" |
|
71 cellspacing="0" width="100%" bgcolor="white"> |
|
72 <tr bgcolor="#70b0f0" class="table-header"> |
|
73 <td colspan="2" class="table-header"> |
|
74 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
75 <tr valign="top"> |
|
76 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
77 <td align="right" valign="top" |
|
78 ><span class="options">[<a href="#section-InstanceMethods" |
|
79 class="privatelink" onclick="toggle_private();" |
|
80 >hide private</a>]</span></td> |
|
81 </tr> |
|
82 </table> |
|
83 </td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td width="15%" align="right" valign="top" class="summary"> |
|
87 <span class="summary-type"> </span> |
|
88 </td><td class="summary"> |
|
89 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
90 <tr> |
|
91 <td><span class="summary-sig"><a href="ats3.Ats3TestPlan-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
92 <span class="summary-sig-arg">config</span>)</span><br /> |
|
93 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
94 <td align="right" valign="top"> |
|
95 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.__init__">source code</a></span> |
|
96 |
|
97 </td> |
|
98 </tr> |
|
99 </table> |
|
100 |
|
101 </td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td width="15%" align="right" valign="top" class="summary"> |
|
105 <span class="summary-type"> </span> |
|
106 </td><td class="summary"> |
|
107 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
108 <tr> |
|
109 <td><span class="summary-sig"><a name="to_bool"></a><span class="summary-sig-name">to_bool</span>(<span class="summary-sig-arg">self</span>, |
|
110 <span class="summary-sig-arg">param</span>)</span></td> |
|
111 <td align="right" valign="top"> |
|
112 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.to_bool">source code</a></span> |
|
113 |
|
114 </td> |
|
115 </tr> |
|
116 </table> |
|
117 |
|
118 </td> |
|
119 </tr> |
|
120 <tr> |
|
121 <td width="15%" align="right" valign="top" class="summary"> |
|
122 <span class="summary-type"> </span> |
|
123 </td><td class="summary"> |
|
124 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
125 <tr> |
|
126 <td><span class="summary-sig"><a name="insert_set"></a><span class="summary-sig-name">insert_set</span>(<span class="summary-sig-arg">self</span>, |
|
127 <span class="summary-sig-arg">data_files</span>=<span class="summary-sig-default">None</span>, |
|
128 <span class="summary-sig-arg">config_files</span>=<span class="summary-sig-default">None</span>, |
|
129 <span class="summary-sig-arg">engine_ini_file</span>=<span class="summary-sig-default">None</span>, |
|
130 <span class="summary-sig-arg">image_files</span>=<span class="summary-sig-default">None</span>, |
|
131 <span class="summary-sig-arg">sis_files</span>=<span class="summary-sig-default">None</span>, |
|
132 <span class="summary-sig-arg">testmodule_files</span>=<span class="summary-sig-default">None</span>, |
|
133 <span class="summary-sig-arg">test_timeout</span>=<span class="summary-sig-default">None</span>, |
|
134 <span class="summary-sig-arg">eunitexerunner_flags</span>=<span class="summary-sig-default">None</span>, |
|
135 <span class="summary-sig-arg">test_harness</span>=<span class="summary-sig-default">None</span>, |
|
136 <span class="summary-sig-arg">src_dst</span>=<span class="summary-sig-default">None</span>, |
|
137 <span class="summary-sig-arg">pmd_files</span>=<span class="summary-sig-default">None</span>, |
|
138 <span class="summary-sig-arg">trace_activation_files</span>=<span class="summary-sig-default">None</span>, |
|
139 <span class="summary-sig-arg">custom_dir</span>=<span class="summary-sig-default">None</span>, |
|
140 <span class="summary-sig-arg">component_path</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
141 Insert a test set into the test plan.</td> |
|
142 <td align="right" valign="top"> |
|
143 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.insert_set">source 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"> </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="set_plan_harness"></a><span class="summary-sig-name">set_plan_harness</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
158 setting up test harness for a plan</td> |
|
159 <td align="right" valign="top"> |
|
160 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.set_plan_harness">source 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"> </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="ats3.Ats3TestPlan-class.html#post_actions" class="summary-sig-name">post_actions</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
175 ATS3 post actions.</td> |
|
176 <td align="right" valign="top"> |
|
177 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.post_actions">source code</a></span> |
|
178 |
|
179 </td> |
|
180 </tr> |
|
181 </table> |
|
182 |
|
183 </td> |
|
184 </tr> |
|
185 <tr> |
|
186 <td width="15%" align="right" valign="top" class="summary"> |
|
187 <span class="summary-type"> </span> |
|
188 </td><td class="summary"> |
|
189 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
190 <tr> |
|
191 <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>, |
|
192 <span class="summary-sig-arg">key</span>)</span></td> |
|
193 <td align="right" valign="top"> |
|
194 <span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.__getitem__">source code</a></span> |
|
195 |
|
196 </td> |
|
197 </tr> |
|
198 </table> |
|
199 |
|
200 </td> |
|
201 </tr> |
|
202 <tr> |
|
203 <td colspan="2" class="summary"> |
|
204 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
205 <code>__delattr__</code>, |
|
206 <code>__getattribute__</code>, |
|
207 <code>__hash__</code>, |
|
208 <code>__new__</code>, |
|
209 <code>__reduce__</code>, |
|
210 <code>__reduce_ex__</code>, |
|
211 <code>__repr__</code>, |
|
212 <code>__setattr__</code>, |
|
213 <code>__str__</code> |
|
214 </p> |
|
215 </td> |
|
216 </tr> |
|
217 </table> |
|
218 <!-- ==================== CLASS VARIABLES ==================== --> |
|
219 <a name="section-ClassVariables"></a> |
|
220 <table class="summary" border="1" cellpadding="3" |
|
221 cellspacing="0" width="100%" bgcolor="white"> |
|
222 <tr bgcolor="#70b0f0" class="table-header"> |
|
223 <td colspan="2" class="table-header"> |
|
224 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
225 <tr valign="top"> |
|
226 <td align="left"><span class="table-header">Class Variables</span></td> |
|
227 <td align="right" valign="top" |
|
228 ><span class="options">[<a href="#section-ClassVariables" |
|
229 class="privatelink" onclick="toggle_private();" |
|
230 >hide private</a>]</span></td> |
|
231 </tr> |
|
232 </table> |
|
233 </td> |
|
234 </tr> |
|
235 <tr> |
|
236 <td width="15%" align="right" valign="top" class="summary"> |
|
237 <span class="summary-type"> </span> |
|
238 </td><td class="summary"> |
|
239 <a href="ats3.Ats3TestPlan-class.html#EMAIL_SUBJECT" class="summary-name">EMAIL_SUBJECT</a> = <code title="u"ATS3 report for §RUN_NAME§ §RUN_START_DATE§ " u"§RUN_START_TIME§"">u"ATS3 report for §RUN_NAME§ §RUN_START_DATE§ <code class="variable-ellipsis">...</code></code> |
|
240 </td> |
|
241 </tr> |
|
242 <tr> |
|
243 <td width="15%" align="right" valign="top" class="summary"> |
|
244 <span class="summary-type"> </span> |
|
245 </td><td class="summary"> |
|
246 <a href="ats3.Ats3TestPlan-class.html#REPORT_PATH" class="summary-name">REPORT_PATH</a> = <code title="u"§RUN_NAME§"+ os.sep+ u"§RUN_START_DATE§_§RUN_START_TIME§"">u"§RUN_NAME§"+ os.sep+ u"§RUN_START_DATE§_§RUN_S<code class="variable-ellipsis">...</code></code> |
|
247 </td> |
|
248 </tr> |
|
249 </table> |
|
250 <!-- ==================== PROPERTIES ==================== --> |
|
251 <a name="section-Properties"></a> |
|
252 <table class="summary" 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">Properties</span></td> |
|
259 <td align="right" valign="top" |
|
260 ><span class="options">[<a href="#section-Properties" |
|
261 class="privatelink" onclick="toggle_private();" |
|
262 >hide private</a>]</span></td> |
|
263 </tr> |
|
264 </table> |
|
265 </td> |
|
266 </tr> |
|
267 <tr> |
|
268 <td colspan="2" class="summary"> |
|
269 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
270 <code>__class__</code> |
|
271 </p> |
|
272 </td> |
|
273 </tr> |
|
274 </table> |
|
275 <!-- ==================== METHOD DETAILS ==================== --> |
|
276 <a name="section-MethodDetails"></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">Method Details</span></td> |
|
284 <td align="right" valign="top" |
|
285 ><span class="options">[<a href="#section-MethodDetails" |
|
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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>, |
|
301 <span class="sig-arg">config</span>)</span> |
|
302 <br /><em class="fname">(Constructor)</em> |
|
303 </h3> |
|
304 </td><td align="right" valign="top" |
|
305 ><span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.__init__">source code</a></span> |
|
306 </td> |
|
307 </table> |
|
308 |
|
309 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
310 <dl class="fields"> |
|
311 <dt>Overrides: |
|
312 object.__init__ |
|
313 <dd><em class="note">(inherited documentation)</em></dd> |
|
314 </dt> |
|
315 </dl> |
|
316 </td></tr></table> |
|
317 </div> |
|
318 <a name="post_actions"></a> |
|
319 <div> |
|
320 <table class="details" border="1" cellpadding="3" |
|
321 cellspacing="0" width="100%" bgcolor="white"> |
|
322 <tr><td> |
|
323 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
324 <tr valign="top"><td> |
|
325 <h3 class="epydoc"><span class="sig"><span class="sig-name">post_actions</span>(<span class="sig-arg">self</span>)</span> |
|
326 </h3> |
|
327 </td><td align="right" valign="top" |
|
328 ><span class="codelink"><a href="ats3-pysrc.html#Ats3TestPlan.post_actions">source code</a></span> |
|
329 </td> |
|
330 </table> |
|
331 |
|
332 ATS3 post actions. |
|
333 <dl class="fields"> |
|
334 <dt>Decorators:</dt> |
|
335 <dd><ul class="nomargin-top"> |
|
336 <li><code>@property</code></li> |
|
337 </ul></dd> |
|
338 </dl> |
|
339 </td></tr></table> |
|
340 </div> |
|
341 <br /> |
|
342 <!-- ==================== CLASS VARIABLE DETAILS ==================== --> |
|
343 <a name="section-ClassVariableDetails"></a> |
|
344 <table class="details" border="1" cellpadding="3" |
|
345 cellspacing="0" width="100%" bgcolor="white"> |
|
346 <tr bgcolor="#70b0f0" class="table-header"> |
|
347 <td colspan="2" class="table-header"> |
|
348 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
349 <tr valign="top"> |
|
350 <td align="left"><span class="table-header">Class Variable Details</span></td> |
|
351 <td align="right" valign="top" |
|
352 ><span class="options">[<a href="#section-ClassVariableDetails" |
|
353 class="privatelink" onclick="toggle_private();" |
|
354 >hide private</a>]</span></td> |
|
355 </tr> |
|
356 </table> |
|
357 </td> |
|
358 </tr> |
|
359 </table> |
|
360 <a name="EMAIL_SUBJECT"></a> |
|
361 <div> |
|
362 <table class="details" border="1" cellpadding="3" |
|
363 cellspacing="0" width="100%" bgcolor="white"> |
|
364 <tr><td> |
|
365 <h3 class="epydoc">EMAIL_SUBJECT</h3> |
|
366 |
|
367 <dl class="fields"> |
|
368 </dl> |
|
369 <dl class="fields"> |
|
370 <dt>Value:</dt> |
|
371 <dd><table><tr><td><pre class="variable"> |
|
372 u"ATS3 report for §RUN_NAME§ §RUN_START_DATE§ " u"§RUN_START_TIME§" |
|
373 </pre></td></tr></table> |
|
374 </dd> |
|
375 </dl> |
|
376 </td></tr></table> |
|
377 </div> |
|
378 <a name="REPORT_PATH"></a> |
|
379 <div> |
|
380 <table class="details" border="1" cellpadding="3" |
|
381 cellspacing="0" width="100%" bgcolor="white"> |
|
382 <tr><td> |
|
383 <h3 class="epydoc">REPORT_PATH</h3> |
|
384 |
|
385 <dl class="fields"> |
|
386 </dl> |
|
387 <dl class="fields"> |
|
388 <dt>Value:</dt> |
|
389 <dd><table><tr><td><pre class="variable"> |
|
390 u"§RUN_NAME§"+ os.sep+ u"§RUN_START_DATE§_§RUN_START_TIME§" |
|
391 </pre></td></tr></table> |
|
392 </dd> |
|
393 </dl> |
|
394 </td></tr></table> |
|
395 </div> |
|
396 <br /> |
|
397 <!-- ==================== NAVIGATION BAR ==================== --> |
|
398 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
399 bgcolor="#a0c0ff" cellspacing="0"> |
|
400 <tr valign="middle"> |
|
401 |
|
402 <!-- Tree link --> |
|
403 <th> <a |
|
404 href="module-tree.html">Trees</a> </th> |
|
405 |
|
406 <!-- Index link --> |
|
407 <th> <a |
|
408 href="identifier-index.html">Indices</a> </th> |
|
409 |
|
410 <!-- Help link --> |
|
411 <th> <a |
|
412 href="help.html">Help</a> </th> |
|
413 |
|
414 <th class="navbar" width="100%"></th> |
|
415 </tr> |
|
416 </table> |
|
417 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
418 <tr> |
|
419 <td align="left" class="footer"> |
|
420 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
421 </td> |
|
422 <td align="right" class="footer"> |
|
423 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
424 </td> |
|
425 </tr> |
|
426 </table> |
|
427 |
|
428 <script type="text/javascript"> |
|
429 <!-- |
|
430 // Private objects are initially displayed (because if |
|
431 // javascript is turned off then we want them to be |
|
432 // visible); but by default, we want to hide them. So hide |
|
433 // them unless we have a cookie that says to show them. |
|
434 checkCookie() |
|
435 // --> |
|
436 </script> |
|
437 |
|
438 </body> |
|
439 </html> |