| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module telemetry.story.shared_state</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.story.html"><font color="#ffffff">story</font></a>.shared_state</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/story/shared_state.py">telemetry/story/shared_state.py</a></font></td></tr></table> |
| <p><tt># Copyright 2014 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="#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="__builtin__.html#object">__builtin__.object</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="telemetry.story.shared_state.html#SharedState">SharedState</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="SharedState">class <strong>SharedState</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class that manages the test state across multiple stories.<br> |
| It's styled on unittest.TestCase for handling test setup & teardown logic.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="SharedState-CanRunStory"><strong>CanRunStory</strong></a>(self, story)</dt><dd><tt>Indicate whether the story can be run in the current configuration.<br> |
| This is called after WillRunStory and before RunStory. Return True<br> |
| if the story should be run, and False if it should be skipped.<br> |
| Most subclasses will probably want to override this to always<br> |
| return True.<br> |
| Args:<br> |
| story: a story.Story instance.</tt></dd></dl> |
| |
| <dl><dt><a name="SharedState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt><dd><tt>Override to do any action after running each of all stories that<br> |
| share this same state.<br> |
| This method is styled on unittest.TestCase.tearDown.</tt></dd></dl> |
| |
| <dl><dt><a name="SharedState-RunStory"><strong>RunStory</strong></a>(self, results)</dt><dd><tt>Override to do any action before running each one of all stories<br> |
| that share this same state.<br> |
| This method is styled on unittest.TestCase.run.</tt></dd></dl> |
| |
| <dl><dt><a name="SharedState-TearDownState"><strong>TearDownState</strong></a>(self)</dt><dd><tt>Override to do any action after running multiple stories that<br> |
| share this same state.<br> |
| This method is styled on unittest.TestCase.tearDownClass.</tt></dd></dl> |
| |
| <dl><dt><a name="SharedState-WillRunStory"><strong>WillRunStory</strong></a>(self, story)</dt><dd><tt>Override to do any action before running each one of all stories<br> |
| that share this same state.<br> |
| This method is styled on unittest.TestCase.setUp.</tt></dd></dl> |
| |
| <dl><dt><a name="SharedState-__init__"><strong>__init__</strong></a>(self, test, options, story_set)</dt><dd><tt>This method is styled on unittest.TestCase.setUpClass.<br> |
| Override to do any action before running stories that<br> |
| share this same state.<br> |
| Args:<br> |
| test: a page_test.PageTest or story_test.StoryTest instance.<br> |
| options: a BrowserFinderOptions instance that contains command line<br> |
| options.<br> |
| story_set: a story.StorySet instance.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<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>platform</strong></dt> |
| <dd><tt>Override to return the platform which stories that share this same<br> |
| state will be run on.</tt></dd> |
| </dl> |
| </td></tr></table></td></tr></table> |
| </body></html> |
