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.core.command_line.html">telemetry.core.command_line</a><br>
     25 <a href="telemetry.core.discover.html">telemetry.core.discover</a><br>
     26 </td><td width="25%" valign=top><a href="inspect.html">inspect</a><br>
     27 <a href="json.html">json</a><br>
     28 <a href="os.html">os</a><br>
     29 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
     30 <a href="telemetry.test.html">telemetry.test</a><br>
     31 <a href="telemetry.core.util.html">telemetry.core.util</a><br>
     32 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
     33 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     34 <tr bgcolor="#ee77aa">
     35 <td colspan=3 valign=bottom>&nbsp;<br>
     36 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     37     
     38 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     39 <td width="100%"><dl>
     40 <dt><font face="helvetica, arial"><a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>(<a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>)
     41 </font></dt><dd>
     42 <dl>
     43 <dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#Help">Help</a>
     44 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#List">List</a>
     45 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.test_runner.html#Run">Run</a>
     46 </font></dt></dl>
     47 </dd>
     48 </dl>
     49  <p>
     50 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     51 <tr bgcolor="#ffc8d8">
     52 <td colspan=3 valign=bottom>&nbsp;<br>
     53 <font color="#000000" face="helvetica, arial"><a name="Help">class <strong>Help</strong></a>(<a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>)</font></td></tr>
     54     
     55 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
     56 <td colspan=2><tt>Display&nbsp;help&nbsp;information<br>&nbsp;</tt></td></tr>
     57 <tr><td>&nbsp;</td>
     58 <td width="100%"><dl><dt>Method resolution order:</dt>
     59 <dd><a href="telemetry.test_runner.html#Help">Help</a></dd>
     60 <dd><a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a></dd>
     61 <dd><a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a></dd>
     62 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd>
     63 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
     64 </dl>
     65 <hr>
     66 Methods defined here:<br>
     67 <dl><dt><a name="Help-Run"><strong>Run</strong></a>(self, args)</dt></dl>
     68 
     69 <hr>
     70 Class methods inherited from <a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>:<br>
     71 <dl><dt><a name="Help-CreateParser"><strong>CreateParser</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
     72 
     73 <hr>
     74 Data and other attributes inherited from <a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>:<br>
     75 <dl><dt><strong>usage</strong> = ''</dl>
     76 
     77 <hr>
     78 Class methods inherited from <a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>:<br>
     79 <dl><dt><a name="Help-Description"><strong>Description</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
     80 
     81 <dl><dt><a name="Help-Name"><strong>Name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
     82 
     83 <hr>
     84 Class methods inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
     85 <dl><dt><a name="Help-AddCommandLineArgs"><strong>AddCommandLineArgs</strong></a>(cls, parser)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Override&nbsp;to&nbsp;accept&nbsp;custom&nbsp;command-line&nbsp;arguments.</tt></dd></dl>
     86 
     87 <dl><dt><a name="Help-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</strong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Override&nbsp;to&nbsp;process&nbsp;command-line&nbsp;arguments.<br>
     88 &nbsp;<br>
     89 We&nbsp;pass&nbsp;in&nbsp;parser&nbsp;so&nbsp;we&nbsp;can&nbsp;call&nbsp;parser.error().</tt></dd></dl>
     90 
     91 <hr>
     92 Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
     93 <dl><dt><strong>__dict__</strong></dt>
     94 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
     95 </dl>
     96 <dl><dt><strong>__weakref__</strong></dt>
     97 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
     98 </dl>
     99 </td></tr></table> <p>
    100 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    101 <tr bgcolor="#ffc8d8">
    102 <td colspan=3 valign=bottom>&nbsp;<br>
    103 <font color="#000000" face="helvetica, arial"><a name="List">class <strong>List</strong></a>(<a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>)</font></td></tr>
    104     
    105 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    106 <td colspan=2><tt>Lists&nbsp;the&nbsp;available&nbsp;tests<br>&nbsp;</tt></td></tr>
    107 <tr><td>&nbsp;</td>
    108 <td width="100%"><dl><dt>Method resolution order:</dt>
    109 <dd><a href="telemetry.test_runner.html#List">List</a></dd>
    110 <dd><a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a></dd>
    111 <dd><a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a></dd>
    112 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd>
    113 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
    114 </dl>
    115 <hr>
    116 Methods defined here:<br>
    117 <dl><dt><a name="List-Run"><strong>Run</strong></a>(self, args)</dt></dl>
    118 
    119 <hr>
    120 Class methods defined here:<br>
    121 <dl><dt><a name="List-AddCommandLineArgs"><strong>AddCommandLineArgs</strong></a>(cls, parser)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    122 
    123 <dl><dt><a name="List-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</strong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    124 
    125 <hr>
    126 Data and other attributes defined here:<br>
    127 <dl><dt><strong>usage</strong> = '[test_name] [&lt;options&gt;]'</dl>
    128 
    129 <hr>
    130 Class methods inherited from <a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>:<br>
    131 <dl><dt><a name="List-CreateParser"><strong>CreateParser</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    132 
    133 <hr>
    134 Class methods inherited from <a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>:<br>
    135 <dl><dt><a name="List-Description"><strong>Description</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    136 
    137 <dl><dt><a name="List-Name"><strong>Name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    138 
    139 <hr>
    140 Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
    141 <dl><dt><strong>__dict__</strong></dt>
    142 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    143 </dl>
    144 <dl><dt><strong>__weakref__</strong></dt>
    145 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    146 </dl>
    147 </td></tr></table> <p>
    148 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    149 <tr bgcolor="#ffc8d8">
    150 <td colspan=3 valign=bottom>&nbsp;<br>
    151 <font color="#000000" face="helvetica, arial"><a name="Run">class <strong>Run</strong></a>(<a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a>)</font></td></tr>
    152     
    153 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    154 <td colspan=2><tt><a href="#Run">Run</a>&nbsp;one&nbsp;or&nbsp;more&nbsp;tests<br>&nbsp;</tt></td></tr>
    155 <tr><td>&nbsp;</td>
    156 <td width="100%"><dl><dt>Method resolution order:</dt>
    157 <dd><a href="telemetry.test_runner.html#Run">Run</a></dd>
    158 <dd><a href="telemetry.core.command_line.html#OptparseCommand">telemetry.core.command_line.OptparseCommand</a></dd>
    159 <dd><a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a></dd>
    160 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd>
    161 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
    162 </dl>
    163 <hr>
    164 Methods defined here:<br>
    165 <dl><dt><a name="Run-Run"><strong>Run</strong></a>(self, args)</dt></dl>
    166 
    167 <hr>
    168 Class methods defined here:<br>
    169 <dl><dt><a name="Run-AddCommandLineArgs"><strong>AddCommandLineArgs</strong></a>(cls, parser)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    170 
    171 <dl><dt><a name="Run-CreateParser"><strong>CreateParser</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    172 
    173 <dl><dt><a name="Run-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</strong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    174 
    175 <hr>
    176 Data and other attributes defined here:<br>
    177 <dl><dt><strong>usage</strong> = 'test_name [&lt;options&gt;]'</dl>
    178 
    179 <hr>
    180 Class methods inherited from <a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>:<br>
    181 <dl><dt><a name="Run-Description"><strong>Description</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    182 
    183 <dl><dt><a name="Run-Name"><strong>Name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
    184 
    185 <hr>
    186 Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
    187 <dl><dt><strong>__dict__</strong></dt>
    188 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    189 </dl>
    190 <dl><dt><strong>__weakref__</strong></dt>
    191 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    192 </dl>
    193 </td></tr></table></td></tr></table><p>
    194 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    195 <tr bgcolor="#eeaa77">
    196 <td colspan=3 valign=bottom>&nbsp;<br>
    197 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    198     
    199 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    200 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>()</dt></dl>
    201 </td></tr></table><p>
    202 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    203 <tr bgcolor="#55aa55">
    204 <td colspan=3 valign=bottom>&nbsp;<br>
    205 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    206     
    207 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    208 <td width="100%"><strong>test_aliases</strong> = {}</td></tr></table>
    209 </body></html>