Home | History | Annotate | Download | only in docs
      1 
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      3 <html><head><title>Python: module telemetry.test_runner</title>
      4 </head><body bgcolor="#f0f0f8">
      5 
      6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
      7 <tr bgcolor="#7799ee">
      8 <td valign=bottom>&nbsp;<br>
      9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.test_runner</strong></big></big></font></td
     10 ><td align=right valign=bottom
     11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/test_runner.py">telemetry/test_runner.py</a></font></td></tr></table>
     12     <p><tt>Parses&nbsp;the&nbsp;command&nbsp;line,&nbsp;discovers&nbsp;the&nbsp;appropriate&nbsp;tests,&nbsp;and&nbsp;runs&nbsp;them.<br>
     13 &nbsp;<br>
     14 Handles&nbsp;test&nbsp;configuration,&nbsp;but&nbsp;all&nbsp;the&nbsp;logic&nbsp;for<br>
     15 actually&nbsp;running&nbsp;the&nbsp;test&nbsp;is&nbsp;in&nbsp;Test&nbsp;and&nbsp;PageRunner.</tt></p>
     16 <p>
     17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     18 <tr bgcolor="#aa55cc">
     19 <td colspan=3 valign=bottom>&nbsp;<br>
     20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
     21     
     22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.browser_options.html">telemetry.core.browser_options</a><br>
     24 <a href="telemetry.test.html">telemetry.test</a><br>
     25 <a href="copy.html">copy</a><br>
     26 </td><td width="25%" valign=top><a href="telemetry.core.discover.html">telemetry.core.discover</a><br>
     27 <a href="inspect.html">inspect</a><br>
     28 <a href="json.html">json</a><br>
     29 </td><td width="25%" valign=top><a href="optparse.html">optparse</a><br>
     30 <a href="os.html">os</a><br>
     31 <a href="sys.html">sys</a><br>
     32 </td><td width="25%" valign=top><a href="telemetry.test.html">telemetry.test</a><br>
     33 </td></tr></table></td></tr></table><p>
     34 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     35 <tr bgcolor="#ee77aa">
     36 <td colspan=3 valign=bottom>&nbsp;<br>
     37 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     38     
     39 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     40 <td width="100%"><dl>
     41 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
     42 </font></dt><dd>
     43 <dl>
     44 <dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#Command">Command</a>
     45 </font></dt><dd>
     46 <dl>
     47 <dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#Help">Help</a>
     48 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#List">List</a>
     49 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#Run">Run</a>
     50 </font></dt></dl>
     51 </dd>
     52 </dl>
     53 </dd>
     54 </dl>
     55  <p>
     56 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     57 <tr bgcolor="#ffc8d8">
     58 <td colspan=3 valign=bottom>&nbsp;<br>
     59 <font color="#000000" face="helvetica, arial"><a name="Command">class <strong>Command</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
     60     
     61 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     62 <td width="100%">Methods defined here:<br>
     63 <dl><dt><a name="Command-AddParserOptions"><strong>AddParserOptions</strong></a>(self, parser)</dt></dl>
     64 
     65 <dl><dt><a name="Command-CreateParser"><strong>CreateParser</strong></a>(self)</dt></dl>
     66 
     67 <dl><dt><a name="Command-Run"><strong>Run</strong></a>(self, options, args)</dt></dl>
     68 
     69 <dl><dt><a name="Command-ValidateCommandLine"><strong>ValidateCommandLine</strong></a>(self, parser, options, args)</dt></dl>
     70 
     71 <hr>
     72 Data descriptors defined here:<br>
     73 <dl><dt><strong>__dict__</strong></dt>
     74 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
     75 </dl>
     76 <dl><dt><strong>__weakref__</strong></dt>
     77 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
     78 </dl>
     79 <dl><dt><strong>description</strong></dt>
     80 </dl>
     81 <dl><dt><strong>name</strong></dt>
     82 </dl>
     83 <hr>
     84 Data and other attributes defined here:<br>
     85 <dl><dt><strong>usage</strong> = ''</dl>
     86 
     87 </td></tr></table> <p>
     88 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     89 <tr bgcolor="#ffc8d8">
     90 <td colspan=3 valign=bottom>&nbsp;<br>
     91 <font color="#000000" face="helvetica, arial"><a name="Help">class <strong>Help</strong></a>(<a href="telemetry.test_runner.html#Command">Command</a>)</font></td></tr>
     92     
     93 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
     94 <td colspan=2><tt>Display&nbsp;help&nbsp;information<br>&nbsp;</tt></td></tr>
     95 <tr><td>&nbsp;</td>
     96 <td width="100%"><dl><dt>Method resolution order:</dt>
     97 <dd><a href="telemetry.test_runner.html#Help">Help</a></dd>
     98 <dd><a href="telemetry.test_runner.html#Command">Command</a></dd>
     99 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
    100 </dl>
    101 <hr>
    102 Methods defined here:<br>
    103 <dl><dt><a name="Help-Run"><strong>Run</strong></a>(self, options, args)</dt></dl>
    104 
    105 <hr>
    106 Methods inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    107 <dl><dt><a name="Help-AddParserOptions"><strong>AddParserOptions</strong></a>(self, parser)</dt></dl>
    108 
    109 <dl><dt><a name="Help-CreateParser"><strong>CreateParser</strong></a>(self)</dt></dl>
    110 
    111 <dl><dt><a name="Help-ValidateCommandLine"><strong>ValidateCommandLine</strong></a>(self, parser, options, args)</dt></dl>
    112 
    113 <hr>
    114 Data descriptors inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    115 <dl><dt><strong>__dict__</strong></dt>
    116 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    117 </dl>
    118 <dl><dt><strong>__weakref__</strong></dt>
    119 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    120 </dl>
    121 <dl><dt><strong>description</strong></dt>
    122 </dl>
    123 <dl><dt><strong>name</strong></dt>
    124 </dl>
    125 <hr>
    126 Data and other attributes inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    127 <dl><dt><strong>usage</strong> = ''</dl>
    128 
    129 </td></tr></table> <p>
    130 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    131 <tr bgcolor="#ffc8d8">
    132 <td colspan=3 valign=bottom>&nbsp;<br>
    133 <font color="#000000" face="helvetica, arial"><a name="List">class <strong>List</strong></a>(<a href="telemetry.test_runner.html#Command">Command</a>)</font></td></tr>
    134     
    135 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    136 <td colspan=2><tt>Lists&nbsp;the&nbsp;available&nbsp;tests<br>&nbsp;</tt></td></tr>
    137 <tr><td>&nbsp;</td>
    138 <td width="100%"><dl><dt>Method resolution order:</dt>
    139 <dd><a href="telemetry.test_runner.html#List">List</a></dd>
    140 <dd><a href="telemetry.test_runner.html#Command">Command</a></dd>
    141 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
    142 </dl>
    143 <hr>
    144 Methods defined here:<br>
    145 <dl><dt><a name="List-AddParserOptions"><strong>AddParserOptions</strong></a>(self, parser)</dt></dl>
    146 
    147 <dl><dt><a name="List-Run"><strong>Run</strong></a>(self, options, args)</dt></dl>
    148 
    149 <hr>
    150 Methods inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    151 <dl><dt><a name="List-CreateParser"><strong>CreateParser</strong></a>(self)</dt></dl>
    152 
    153 <dl><dt><a name="List-ValidateCommandLine"><strong>ValidateCommandLine</strong></a>(self, parser, options, args)</dt></dl>
    154 
    155 <hr>
    156 Data descriptors inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    157 <dl><dt><strong>__dict__</strong></dt>
    158 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    159 </dl>
    160 <dl><dt><strong>__weakref__</strong></dt>
    161 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    162 </dl>
    163 <dl><dt><strong>description</strong></dt>
    164 </dl>
    165 <dl><dt><strong>name</strong></dt>
    166 </dl>
    167 <hr>
    168 Data and other attributes inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    169 <dl><dt><strong>usage</strong> = ''</dl>
    170 
    171 </td></tr></table> <p>
    172 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    173 <tr bgcolor="#ffc8d8">
    174 <td colspan=3 valign=bottom>&nbsp;<br>
    175 <font color="#000000" face="helvetica, arial"><a name="Run">class <strong>Run</strong></a>(<a href="telemetry.test_runner.html#Command">Command</a>)</font></td></tr>
    176     
    177 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    178 <td colspan=2><tt><a href="#Run">Run</a>&nbsp;one&nbsp;or&nbsp;more&nbsp;tests<br>&nbsp;</tt></td></tr>
    179 <tr><td>&nbsp;</td>
    180 <td width="100%"><dl><dt>Method resolution order:</dt>
    181 <dd><a href="telemetry.test_runner.html#Run">Run</a></dd>
    182 <dd><a href="telemetry.test_runner.html#Command">Command</a></dd>
    183 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
    184 </dl>
    185 <hr>
    186 Methods defined here:<br>
    187 <dl><dt><a name="Run-CreateParser"><strong>CreateParser</strong></a>(self)</dt></dl>
    188 
    189 <dl><dt><a name="Run-Run"><strong>Run</strong></a>(self, options, args)</dt></dl>
    190 
    191 <dl><dt><a name="Run-ValidateCommandLine"><strong>ValidateCommandLine</strong></a>(self, parser, options, args)</dt></dl>
    192 
    193 <hr>
    194 Data and other attributes defined here:<br>
    195 <dl><dt><strong>usage</strong> = 'test_name [...] [&lt;args&gt;]'</dl>
    196 
    197 <hr>
    198 Methods inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    199 <dl><dt><a name="Run-AddParserOptions"><strong>AddParserOptions</strong></a>(self, parser)</dt></dl>
    200 
    201 <hr>
    202 Data descriptors inherited from <a href="telemetry.test_runner.html#Command">Command</a>:<br>
    203 <dl><dt><strong>__dict__</strong></dt>
    204 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    205 </dl>
    206 <dl><dt><strong>__weakref__</strong></dt>
    207 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    208 </dl>
    209 <dl><dt><strong>description</strong></dt>
    210 </dl>
    211 <dl><dt><strong>name</strong></dt>
    212 </dl>
    213 </td></tr></table></td></tr></table><p>
    214 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    215 <tr bgcolor="#eeaa77">
    216 <td colspan=3 valign=bottom>&nbsp;<br>
    217 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    218     
    219 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    220 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>()</dt></dl>
    221 </td></tr></table><p>
    222 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    223 <tr bgcolor="#55aa55">
    224 <td colspan=3 valign=bottom>&nbsp;<br>
    225 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    226     
    227 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    228 <td width="100%"><strong>COMMANDS</strong> = [&lt;telemetry.test_runner.Help object&gt;, &lt;telemetry.test_runner.List object&gt;, &lt;telemetry.test_runner.Run object&gt;]</td></tr></table>
    229 </body></html>