xref: /external/chromium_org/tools/telemetry/telemetry/results/progress_reporter.py

# Copyright 2014 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 ProgressReporter(object):
  """A class that reports progress of a benchmark.

  The reporter produces output whenever a significant event happens
  during the progress of a benchmark, including (but not limited to):
  when a page run is started, when a page run finished, any failures
  during a page run.

  The default implementation outputs nothing.
  """

  def DidAddValue(self, value):
    pass

  def WillRunPage(self, page_test_results):
    pass

  def DidRunPage(self, page_test_results):
    pass

  def WillAttemptPageRun(self, page_test_results, attempt_count, max_attempts):
    """
    Args:
      attempt_count: The current attempt number, start at 1
          (attempt_count == 1 for the first attempt, 2 for second
          attempt, and so on).
      max_attempts: Maximum number of page run attempts before failing.
    """
    pass

  def DidFinishAllTests(self, page_test_results):
    pass