tools/telemetry/telemetry/page/actions/page_action.py

# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

class PageActionNotSupported(Exception):
  pass

class PageActionFailed(Exception):
  pass

class PageAction(object):
  """Represents an action that a user might try to perform to a page."""
  def __init__(self, attributes=None):
    if attributes:
      for k, v in attributes.iteritems():
        setattr(self, k, v)

  def CustomizeBrowserOptions(self, options):
    """Override to add action-specific options to the BrowserOptions
    object."""
    pass

  def WillRunAction(self, page, tab):
    """Override to do action-specific setup before
    Test.WillRunAction is called."""
    pass

  def RunAction(self, page, tab, previous_action):
    raise NotImplementedError()

  def RunsPreviousAction(self):
    """Some actions require some initialization to be performed before the
    previous action. For example, wait for href change needs to record the old
    href before the previous action changes it. Therefore, we allow actions to
    run the previous action. An action that does this should override this to
    return True in order to prevent the previous action from being run twice."""
    return False

  def CleanUp(self, page, tab):
    pass

  def CanBeBound(self):
    """If this class implements BindMeasurementJavaScript, override CanBeBound
    to return True so that a test knows it can bind measurements."""
    return False

  def BindMeasurementJavaScript(
      self, tab, start_js, stop_js):  # pylint: disable=W0613
    """Let this action determine when measurements should start and stop.

    A measurement can call this method to provide the action
    with JavaScript code that starts and stops measurements. The action
    determines when to execute the provided JavaScript code, for more accurate
    timings.

    Args:
      tab: The tab to do everything on.
      start_js: JavaScript code that starts measurements.
      stop_js: JavaScript code that stops measurements.
    """
    raise Exception('This action cannot be bound.')

  def GetTimelineMarkerLabel(self):
    return None