src/tools/telemetry/docs/telemetry.page.page_test.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.page.page_test</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>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_test</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/page/page_test.py">telemetry/page/page_test.py</a></font></td></tr></table>
  12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  15 <p>
  16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  17 <tr bgcolor="#aa55cc">
  18 <td colspan=3 valign=bottom>&nbsp;<br>
  19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  20
  21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.actions.all_page_actions.html">telemetry.page.actions.all_page_actions</a><br>
  23 <a href="telemetry.page.gtest_test_results.html">telemetry.page.gtest_test_results</a><br>
  24 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
  25 <a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br>
  26 </td><td width="25%" valign=top><a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results</a><br>
  27 <a href="telemetry.core.util.html">telemetry.core.util</a><br>
  28 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  29 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  30 <tr bgcolor="#ee77aa">
  31 <td colspan=3 valign=bottom>&nbsp;<br>
  32 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  33
  34 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  35 <td width="100%"><dl>
  36 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  37 </font></dt><dd>
  38 <dl>
  39 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">PageTest</a>
  40 </font></dt></dl>
  41 </dd>
  42 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  43 </font></dt><dd>
  44 <dl>
  45 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#Failure">Failure</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="Failure">class <strong>Failure</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
  54
  55 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  56 <td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;that&nbsp;can&nbsp;be&nbsp;thrown&nbsp;from&nbsp;PageMeasurement&nbsp;to&nbsp;indicate&nbsp;an<br>
  57 undesired&nbsp;but&nbsp;designed-for&nbsp;problem.<br>&nbsp;</tt></td></tr>
  58 <tr><td>&nbsp;</td>
  59 <td width="100%"><dl><dt>Method resolution order:</dt>
  60 <dd><a href="telemetry.page.page_test.html#Failure">Failure</a></dd>
  61 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  62 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  63 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  64 </dl>
  65 <hr>
  66 Data descriptors defined here:<br>
  67 <dl><dt><strong>__weakref__</strong></dt>
  68 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  69 </dl>
  70 <hr>
  71 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  72 <dl><dt><a name="Failure-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  73
  74 <hr>
  75 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  76 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#Failure-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  77
  78 <hr>
  79 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  80 <dl><dt><a name="Failure-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  81
  82 <dl><dt><a name="Failure-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  83
  84 <dl><dt><a name="Failure-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  85
  86 <dl><dt><a name="Failure-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  87 &nbsp;<br>
  88 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  89
  90 <dl><dt><a name="Failure-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  91
  92 <dl><dt><a name="Failure-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  93
  94 <dl><dt><a name="Failure-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  95
  96 <dl><dt><a name="Failure-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  97
  98 <dl><dt><a name="Failure-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  99
 100 <dl><dt><a name="Failure-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
 101
 102 <hr>
 103 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 104 <dl><dt><strong>__dict__</strong></dt>
 105 </dl>
 106 <dl><dt><strong>args</strong></dt>
 107 </dl>
 108 <dl><dt><strong>message</strong></dt>
 109 </dl>
 110 </td></tr></table> <p>
 111 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 112 <tr bgcolor="#ffc8d8">
 113 <td colspan=3 valign=bottom>&nbsp;<br>
 114 <font color="#000000" face="helvetica, arial"><a name="PageTest">class <strong>PageTest</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
 115
 116 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 117 <td colspan=2><tt>A&nbsp;class&nbsp;styled&nbsp;on&nbsp;unittest.TestCase&nbsp;for&nbsp;creating&nbsp;page-specific&nbsp;tests.<br>&nbsp;</tt></td></tr>
 118 <tr><td>&nbsp;</td>
 119 <td width="100%">Methods defined here:<br>
 120 <dl><dt><a name="PageTest-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override&nbsp;to&nbsp;expose&nbsp;command-line&nbsp;options&nbsp;for&nbsp;this&nbsp;test.<br>
 121 &nbsp;<br>
 122 The&nbsp;provided&nbsp;parser&nbsp;is&nbsp;an&nbsp;optparse.OptionParser&nbsp;instance&nbsp;and&nbsp;accepts&nbsp;all<br>
 123 normal&nbsp;results.&nbsp;The&nbsp;parsed&nbsp;options&nbsp;are&nbsp;available&nbsp;in&nbsp;Run&nbsp;as<br>
 124 self.<strong>options</strong>.</tt></dd></dl>
 125
 126 <dl><dt><a name="PageTest-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl>
 127
 128 <dl><dt><a name="PageTest-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;if&nbsp;the&nbsp;test&nbsp;can&nbsp;be&nbsp;ran&nbsp;for&nbsp;the&nbsp;given&nbsp;page.</tt></dd></dl>
 129
 130 <dl><dt><a name="PageTest-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nbsp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br>
 131 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp;command-line.</tt></dd></dl>
 132
 133 <dl><dt><a name="PageTest-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;test-specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions&nbsp;<a href="__builtin__.html#object">object</a></tt></dd></dl>
 134
 135 <dl><dt><a name="PageTest-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt><dd><tt>Add&nbsp;options&nbsp;specific&nbsp;to&nbsp;the&nbsp;test&nbsp;and&nbsp;the&nbsp;given&nbsp;page.</tt></dd></dl>
 136
 137 <dl><dt><a name="PageTest-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;right&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;but&nbsp;before<br>
 138 any&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;occurred.</tt></dd></dl>
 139
 140 <dl><dt><a name="PageTest-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
 141
 142 <dl><dt><a name="PageTest-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;page&nbsp;set&nbsp;is&nbsp;completed,&nbsp;but&nbsp;before&nbsp;browser<br>
 143 is&nbsp;torn&nbsp;down.</tt></dd></dl>
 144
 145 <dl><dt><a name="PageTest-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl>
 146
 147 <dl><dt><a name="PageTest-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;specify&nbsp;browser&nbsp;restart&nbsp;after&nbsp;each&nbsp;run.</tt></dd></dl>
 148
 149 <dl><dt><a name="PageTest-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl>
 150
 151 <dl><dt><a name="PageTest-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl>
 152
 153 <dl><dt><a name="PageTest-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;the&nbsp;browser&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl>
 154
 155 <dl><dt><a name="PageTest-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated.</tt></dd></dl>
 156
 157 <dl><dt><a name="PageTest-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
 158
 159 <dl><dt><a name="PageTest-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;set&nbsp;is&nbsp;navigated.</tt></dd></dl>
 160
 161 <dl><dt><a name="PageTest-__init__"><strong>__init__</strong></a>(self, test_method_name, action_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_each_run<font color="#909090">=False</font>, discard_first_result<font color="#909090">=False</font>, clear_cache_before_each_run<font color="#909090">=False</font>)</dt></dl>
 162
 163 <hr>
 164 Data descriptors defined here:<br>
 165 <dl><dt><strong>__dict__</strong></dt>
 166 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 167 </dl>
 168 <dl><dt><strong>__weakref__</strong></dt>
 169 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 170 </dl>
 171 <dl><dt><strong>action_name_to_run</strong></dt>
 172 </dl>
 173 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
 174 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;browser's&nbsp;disk&nbsp;and&nbsp;memory&nbsp;cache&nbsp;will&nbsp;be&nbsp;cleared<br>
 175 before&nbsp;each&nbsp;run.</tt></dd>
 176 </dl>
 177 <dl><dt><strong>discard_first_result</strong></dt>
 178 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
 179 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have&nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br>
 180 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;things&nbsp;up.</tt></dd>
 181 </dl>
 182 <dl><dt><strong>output_format_choices</strong></dt>
 183 <dd><tt>Allowed&nbsp;output&nbsp;formats.&nbsp;The&nbsp;default&nbsp;is&nbsp;the&nbsp;first&nbsp;item&nbsp;in&nbsp;the&nbsp;list.</tt></dd>
 184 </dl>
 185 </td></tr></table></td></tr></table><p>
 186 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 187 <tr bgcolor="#eeaa77">
 188 <td colspan=3 valign=bottom>&nbsp;<br>
 189 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 190
 191 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 192 <td width="100%"><dl><dt><a name="-GetCompoundActionFromPage"><strong>GetCompoundActionFromPage</strong></a>(page, action_name)</dt></dl>
 193 </td></tr></table>
 194 </body></html>