src/build/android/pylib/flakiness_dashboard_results_uploader.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.

"""Uploads the results to the flakiness dashboard server."""

import logging
import os
import shutil
import subprocess
import sys
import tempfile

sys.path.append(os.path.join(sys.path[0], '..', '..', 'third_party',
                             'WebKit', 'Tools', 'Scripts'))
from webkitpy.common.system import executive, filesystem
from webkitpy.layout_tests.layout_package import json_results_generator


# The JSONResultsGenerator gets the filesystem.join operation from the Port
# object. Creating a Port object requires specifying information that only
# makes sense for running WebKit layout tests, so we provide a dummy object
# that contains the fields required by the generator.
class PortDummy(object):
  def __init__(self):
    self._executive = executive.Executive()
    self._filesystem = filesystem.FileSystem()


class JSONResultsGenerator(json_results_generator.JSONResultsGeneratorBase):
  """Writes test results to a JSON file and handles uploading that file to
  the test results server.
  """
  def __init__(self, port, builder_name, build_name, build_number, tmp_folder,
               test_results_map, test_results_server, test_type, master_name):
    super(JSONResultsGenerator, self).__init__(
        port=port,
        builder_name=builder_name,
        build_name=build_name,
        build_number=build_number,
        results_file_base_path=tmp_folder,
        builder_base_url=None,
        test_results_map=test_results_map,
        svn_repositories=(('webkit', 'third_party/WebKit'),
                          ('chrome', '.')),
        test_results_server=test_results_server,
        test_type=test_type,
        master_name=master_name)

  #override
  def _get_modifier_char(self, test_name):
    if test_name not in self._test_results_map:
      return self.__class__.NO_DATA_RESULT

    return self._test_results_map[test_name].modifier

  #override
  def _get_svn_revision(self, in_directory):
    """Returns the git revision for the given directory.

    Args:
      in_directory: The directory where git is to be run.
    """
    git_dir =  self._filesystem.join(os.environ.get('CHROME_SRC'),
                                     in_directory,
                                     '.git')
    if self._filesystem.exists(git_dir):
      # Note: Not thread safe: http://bugs.python.org/issue2320
      output = subprocess.Popen(
          ['git', '--git-dir=%s' % git_dir, 'show-ref', '--head',
           '--hash=10', 'HEAD'],
          stdout=subprocess.PIPE).communicate()[0].strip()
      return output
    return ''


class ResultsUploader(object):
  """Handles uploading buildbot tests results to the flakiness dashboard."""
  def __init__(self, tests_type):
    self._build_number = os.environ.get('BUILDBOT_BUILDNUMBER')
    self._builder_name = os.environ.get('BUILDBOT_BUILDERNAME')
    self._tests_type = tests_type
    self._build_name = 'chromium-android'

    if not self._builder_name:
      raise Exception('You should not be uploading tests results to the server'
                      'from your local machine.')

    buildbot_branch = os.environ.get('BUILDBOT_BRANCH')
    if not buildbot_branch:
      buildbot_branch = 'master'
    self._master_name = '%s-%s' % (self._build_name, buildbot_branch)
    self._test_results_map = {}

  def AddResults(self, test_results):
    conversion_map = [
        (test_results.ok, False,
            json_results_generator.JSONResultsGeneratorBase.PASS_RESULT),
        (test_results.failed, True,
            json_results_generator.JSONResultsGeneratorBase.FAIL_RESULT),
        (test_results.crashed, True,
            "C"),
        (test_results.unknown, True,
            json_results_generator.JSONResultsGeneratorBase.NO_DATA_RESULT),
        ]

    for results_list, failed, modifier in conversion_map:
      for single_test_result in results_list:
        test_result = json_results_generator.TestResult(
            test=single_test_result.name,
            failed=failed,
            elapsed_time=single_test_result.dur / 1000)
        # The WebKit TestResult object sets the modifier it based on test name.
        # Since we don't use the same test naming convention as WebKit the
        # modifier will be wrong, so we need to overwrite it.
        test_result.modifier = modifier

        self._test_results_map[single_test_result.name] = test_result

  def Upload(self, test_results_server):
    if not self._test_results_map:
      return

    tmp_folder = tempfile.mkdtemp()

    try:
      results_generator = JSONResultsGenerator(
          port=PortDummy(),
          builder_name=self._builder_name,
          build_name=self._build_name,
          build_number=self._build_number,
          tmp_folder=tmp_folder,
          test_results_map=self._test_results_map,
          test_results_server=test_results_server,
          test_type=self._tests_type,
          master_name=self._master_name)

      json_files = ["incremental_results.json", "times_ms.json"]
      results_generator.generate_json_output()
      results_generator.generate_times_ms_file()
      results_generator.upload_json_files(json_files)
    except Exception as e:
      logging.error("Uploading results to test server failed: %s." % e);
    finally:
      shutil.rmtree(tmp_folder)


def Upload(flakiness_dashboard_server, test_type, results):
  """Reports test results to the flakiness dashboard for Chrome for Android.

  Args:
    flakiness_dashboard_server: the server to upload the results to.
    test_type: the type of the tests (as displayed by the flakiness dashboard).
    results: test results.
  """
  uploader = ResultsUploader(test_type)
  uploader.AddResults(results)
  uploader.Upload(flakiness_dashboard_server)