1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.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> <br> 9<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.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/test.py">telemetry/test.py</a></font></td></tr></table> 12 <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> 13# Use of this source code is governed by a BSD-style license that can be<br> 14# found in the LICENSE 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> <br> 19<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 20 21<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 22<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.browser_finder.html">telemetry.core.browser_finder</a><br> 23<a href="telemetry.page.cloud_storage.html">telemetry.page.cloud_storage</a><br> 24<a href="telemetry.core.command_line.html">telemetry.core.command_line</a><br> 25<a href="telemetry.decorators.html">telemetry.decorators</a><br> 26</td><td width="25%" valign=top><a href="logging.html">logging</a><br> 27<a href="optparse.html">optparse</a><br> 28<a href="os.html">os</a><br> 29<a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br> 30</td><td width="25%" valign=top><a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br> 31<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> 32<a href="shutil.html">shutil</a><br> 33<a href="sys.html">sys</a><br> 34</td><td width="25%" valign=top><a href="telemetry.page.test_expectations.html">telemetry.page.test_expectations</a><br> 35<a href="telemetry.core.util.html">telemetry.core.util</a><br> 36<a href="zipfile.html">zipfile</a><br> 37</td></tr></table></td></tr></table><p> 38<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 39<tr bgcolor="#ee77aa"> 40<td colspan=3 valign=bottom> <br> 41<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 42 43<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 44<td width="100%"><dl> 45<dt><font face="helvetica, arial"><a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>(<a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>) 46</font></dt><dd> 47<dl> 48<dt><font face="helvetica, arial"><a href="telemetry.test.html#Test">Test</a> 49</font></dt></dl> 50</dd> 51</dl> 52 <p> 53<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 54<tr bgcolor="#ffc8d8"> 55<td colspan=3 valign=bottom> <br> 56<font color="#000000" face="helvetica, arial"><a name="Test">class <strong>Test</strong></a>(<a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>)</font></td></tr> 57 58<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 59<td colspan=2><tt>Base class for a Telemetry test or benchmark.<br> 60 <br> 61A test packages a PageTest/PageMeasurement and a PageSet together.<br> </tt></td></tr> 62<tr><td> </td> 63<td width="100%"><dl><dt>Method resolution order:</dt> 64<dd><a href="telemetry.test.html#Test">Test</a></dd> 65<dd><a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a></dd> 66<dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd> 67<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 68</dl> 69<hr> 70Methods defined here:<br> 71<dl><dt><a name="Test-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Add browser options that are required by this benchmark.</tt></dd></dl> 72 73<dl><dt><a name="Test-Run"><strong>Run</strong></a>(self, args)</dt><dd><tt>Run this test with the given options.</tt></dd></dl> 74 75<hr> 76Class methods defined here:<br> 77<dl><dt><a name="Test-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> 78 79<dl><dt><a name="Test-CreateExpectations"><strong>CreateExpectations</strong></a>(cls, ps)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Get the expectations this test will run with.<br> 80 <br> 81By default, it will create an empty expectations set. Override to generate<br> 82custom expectations.</tt></dd></dl> 83 84<dl><dt><a name="Test-CreatePageSet"><strong>CreatePageSet</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Get the page set this test will run on.<br> 85 <br> 86By default, it will create a page set from the file at this test's<br> 87page_set attribute. Override to generate a custom page set.</tt></dd></dl> 88 89<dl><dt><a name="Test-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> 90 91<dl><dt><a name="Test-PageTestClass"><strong>PageTestClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Get the PageTest for this <a href="#Test">Test</a>.<br> 92 <br> 93If the <a href="#Test">Test</a> has no PageTest, raises NotImplementedError.</tt></dd></dl> 94 95<dl><dt><a name="Test-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> 96 97<hr> 98Data and other attributes defined here:<br> 99<dl><dt><strong>options</strong> = {}</dl> 100 101<hr> 102Class methods inherited from <a href="telemetry.core.command_line.html#Command">telemetry.core.command_line.Command</a>:<br> 103<dl><dt><a name="Test-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> 104 105<hr> 106Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br> 107<dl><dt><strong>__dict__</strong></dt> 108<dd><tt>dictionary for instance variables (if defined)</tt></dd> 109</dl> 110<dl><dt><strong>__weakref__</strong></dt> 111<dd><tt>list of weak references to the object (if defined)</tt></dd> 112</dl> 113</td></tr></table></td></tr></table><p> 114<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 115<tr bgcolor="#eeaa77"> 116<td colspan=3 valign=bottom> <br> 117<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> 118 119<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> 120<td width="100%"><dl><dt><a name="-AddCommandLineArgs"><strong>AddCommandLineArgs</strong></a>(parser)</dt></dl> 121 <dl><dt><a name="-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</strong></a>(parser, args)</dt></dl> 122</td></tr></table> 123</body></html>