catapult/telemetry/telemetry/value/failure.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.

import sys
import traceback

from telemetry import value as value_module


class FailureValue(value_module.Value):

  def __init__(self, page, exc_info, description=None, tir_label=None,
               grouping_keys=None):
    """A value representing a failure when running the page.

    Args:
      page: The page where this failure occurs.
      exc_info: The exception info (sys.exc_info()) corresponding to
          this failure.
    """
    exc_type = exc_info[0].__name__
    super(FailureValue, self).__init__(page, exc_type, '', True, description,
                                       tir_label, grouping_keys)
    self._exc_info = exc_info

  @classmethod
  def FromMessage(cls, page, message):
    """Creates a failure value for a given string message.

    Args:
      page: The page where this failure occurs.
      message: A string message describing the failure.
    """
    exc_info = cls._GetExcInfoFromMessage(message)
    return FailureValue(page, exc_info)

  @staticmethod
  def _GetExcInfoFromMessage(message):
    try:
      raise Exception(message)
    except Exception:
      return sys.exc_info()

  def __repr__(self):
    if self.page:
      page_name = self.page.display_name
    else:
      page_name = 'None'
    return 'FailureValue(%s, %s)' % (
        page_name, GetStringFromExcInfo(self._exc_info))

  @property
  def exc_info(self):
    return self._exc_info

  def GetBuildbotDataType(self, output_context):
    return None

  def GetBuildbotValue(self):
    return None

  def GetChartAndTraceNameForPerPageResult(self):
    return None

  def GetRepresentativeNumber(self):
    return None

  def GetRepresentativeString(self):
    return None

  @staticmethod
  def GetJSONTypeName():
    return 'failure'

  def AsDict(self):
    d = super(FailureValue, self).AsDict()
    d['value'] = GetStringFromExcInfo(self.exc_info)
    return d

  @staticmethod
  def FromDict(value_dict, page_dict):
    kwargs = value_module.Value.GetConstructorKwArgs(value_dict, page_dict)
    del kwargs['name']
    del kwargs['units']
    if 'important' in kwargs:
      del kwargs['important']
    kwargs['exc_info'] = FailureValue._GetExcInfoFromMessage(
        value_dict['value'])

    return FailureValue(**kwargs)

  @classmethod
  def MergeLikeValuesFromSamePage(cls, values):
    assert False, 'Should not be called.'

  @classmethod
  def MergeLikeValuesFromDifferentPages(cls, values):
    assert False, 'Should not be called.'

def GetStringFromExcInfo(exc_info):
  return ''.join(traceback.format_exception(*exc_info))