diff options
Diffstat (limited to 'catapult/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html')
-rw-r--r-- | catapult/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/catapult/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html b/catapult/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html new file mode 100644 index 00000000..e3cbb383 --- /dev/null +++ b/catapult/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html @@ -0,0 +1,136 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.web_perf.timeline_based_page_test</title> +<meta charset="utf-8"> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.web_perf.html"><font color="#ffffff">web_perf</font></a>.timeline_based_page_test</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/web_perf/timeline_based_page_test.py">telemetry/web_perf/timeline_based_page_test.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2015 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> + +<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> +<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.web_perf.timeline_based_page_test.html#TimelineBasedPageTest">TimelineBasedPageTest</a> +</font></dt></dl> +</dd> +</dl> + <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TimelineBasedPageTest">class <strong>TimelineBasedPageTest</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Page test that collects metrics with TimelineBasedMeasurement.<br> + <br> +WillRunStory(), Measure() and DidRunStory() are all done in story_runner<br> +explicitly. We still need this wrapper around <a href="telemetry.page.page_test.html#PageTest">PageTest</a> because it executes<br> +some browser related functions in the parent class, which is needed by<br> +Timeline Based Measurement benchmarks. This class will be removed after<br> +page_test's hooks are fully removed.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.web_perf.timeline_based_page_test.html#TimelineBasedPageTest">TimelineBasedPageTest</a></dd> +<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="TimelineBasedPageTest-ValidateAndMeasurePage"><strong>ValidateAndMeasurePage</strong></a>(self, page, tab, results)</dt><dd><tt>Collect all possible metrics and added them to results.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-__init__"><strong>__init__</strong></a>(self, tbm)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>measurement</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><a name="TimelineBasedPageTest-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated and after<br> +all waiting for completion has occurred.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-DidRunPage"><strong>DidRunPage</strong></a>(self, platform)</dt><dd><tt>Called after the test run method was run, even if it failed.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-DidStartBrowser"><strong>DidStartBrowser</strong></a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-RestartBrowserBeforeEachPage"><strong>RestartBrowserBeforeEachPage</strong></a>(self)</dt><dd><tt>Should the browser be restarted for the page?<br> + <br> +This returns true if the test needs to unconditionally restart the<br> +browser for each page. It may be called before the browser is started.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, page, tab)</dt><dd><tt>Navigates the tab to the page URL attribute.<br> + <br> +Runs the 'navigate_steps' page attribute as a compound action.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-SetOptions"><strong>SetOptions</strong></a>(self, options)</dt><dd><tt>Sets the BrowserFinderOptions instance to use.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-StopBrowserAfterPage"><strong>StopBrowserAfterPage</strong></a>(self, browser, page)</dt><dd><tt>Should the browser be stopped after the page is run?<br> + <br> +This is called after a page is run to decide whether the browser needs to<br> +be stopped to clean up its state. If it is stopped, then it will be<br> +restarted to run the next page.<br> + <br> +A test that overrides this can look at both the page and the browser to<br> +decide whether it needs to stop the browser.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-TabForPage"><strong>TabForPage</strong></a>(self, page, browser)</dt><dd><tt>Override to select a different tab for the page. For instance, to<br> +create a new tab for every page, return browser.tabs.New().</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated, notably Telemetry<br> +will already have performed the following operations on the browser before<br> +calling this function:<br> +* Ensure only one tab is open.<br> +* Call WaitForDocumentReadyStateToComplete on the tab.</tt></dd></dl> + +<dl><dt><a name="TimelineBasedPageTest-WillStartBrowser"><strong>WillStartBrowser</strong></a>(self, platform)</dt><dd><tt>Override to manipulate the browser environment before it launches.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>clear_cache_before_each_run</strong></dt> +<dd><tt>When set to True, the browser's disk and memory cache will be cleared<br> +before each run.</tt></dd> +</dl> +<dl><dt><strong>close_tabs_before_run</strong></dt> +<dd><tt>When set to True, all tabs are closed before running the test for the<br> +first time.</tt></dd> +</dl> +<dl><dt><strong>is_multi_tab_test</strong></dt> +<dd><tt>Returns True if the test opens multiple tabs.<br> + <br> +If the test overrides TabForPage, it is deemed a multi-tab test.<br> +Multi-tab tests do not retry after tab or browser crashes, whereas,<br> +single-tab tests too. That is because the state of multi-tab tests<br> +(e.g., how many tabs are open, etc.) is unknown after crashes.</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file |