1# Copyright 2013 The Chromium Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""Runs host-driven tests on a particular device."""
6
7import logging
8import sys
9import time
10import traceback
11
12from pylib.base import base_test_result
13from pylib.base import base_test_runner
14from pylib.host_driven import test_case
15from pylib.instrumentation import test_result
16
17
18class HostDrivenExceptionTestResult(test_result.InstrumentationTestResult):
19  """Test result corresponding to a python exception in a host-driven test."""
20
21  def __init__(self, test_name, start_date_ms, exc_info):
22    """Constructs a HostDrivenExceptionTestResult object.
23
24    Args:
25      test_name: name of the test which raised an exception.
26      start_date_ms: the starting time for the test.
27      exc_info: exception info, ostensibly from sys.exc_info().
28    """
29    exc_type, exc_value, exc_traceback = exc_info
30    trace_info = ''.join(traceback.format_exception(exc_type, exc_value,
31                                                    exc_traceback))
32    log_msg = 'Exception:\n' + trace_info
33    duration_ms = (int(time.time()) * 1000) - start_date_ms
34
35    super(HostDrivenExceptionTestResult, self).__init__(
36        test_name,
37        base_test_result.ResultType.FAIL,
38        start_date_ms,
39        duration_ms,
40        log=str(exc_type) + ' ' + log_msg)
41
42
43class HostDrivenTestRunner(base_test_runner.BaseTestRunner):
44  """Orchestrates running a set of host-driven tests.
45
46  Any Python exceptions in the tests are caught and translated into a failed
47  result, rather than being re-raised on the main thread.
48  """
49
50  #override
51  def __init__(self, device, shard_index, tool, push_deps,
52               cleanup_test_files):
53    """Creates a new HostDrivenTestRunner.
54
55    Args:
56      device: Attached android device.
57      shard_index: Shard index.
58      tool: Name of the Valgrind tool.
59      push_deps: If True, push all dependencies to the device.
60      cleanup_test_files: Whether or not to cleanup test files on device.
61    """
62
63    super(HostDrivenTestRunner, self).__init__(device, tool, push_deps,
64                                               cleanup_test_files)
65
66    # The shard index affords the ability to create unique port numbers (e.g.
67    # DEFAULT_PORT + shard_index) if the test so wishes.
68    self.shard_index = shard_index
69
70  #override
71  def RunTest(self, test):
72    """Sets up and runs a test case.
73
74    Args:
75      test: An object which is ostensibly a subclass of HostDrivenTestCase.
76
77    Returns:
78      A TestRunResults object which contains the result produced by the test
79      and, in the case of a failure, the test that should be retried.
80    """
81
82    assert isinstance(test, test_case.HostDrivenTestCase)
83
84    start_date_ms = int(time.time()) * 1000
85    exception_raised = False
86
87    try:
88      test.SetUp(str(self.device), self.shard_index,
89                 self._push_deps, self._cleanup_test_files)
90    except Exception:
91      logging.exception(
92          'Caught exception while trying to run SetUp() for test: ' +
93          test.tagged_name)
94      # Tests whose SetUp() method has failed are likely to fail, or at least
95      # yield invalid results.
96      exc_info = sys.exc_info()
97      results = base_test_result.TestRunResults()
98      results.AddResult(HostDrivenExceptionTestResult(
99          test.tagged_name, start_date_ms, exc_info))
100      return results, test
101
102    try:
103      results = test.Run()
104    except Exception:
105      # Setting this lets TearDown() avoid stomping on our stack trace from
106      # Run() should TearDown() also raise an exception.
107      exception_raised = True
108      logging.exception('Caught exception while trying to run test: ' +
109                        test.tagged_name)
110      exc_info = sys.exc_info()
111      results = base_test_result.TestRunResults()
112      results.AddResult(HostDrivenExceptionTestResult(
113          test.tagged_name, start_date_ms, exc_info))
114
115    try:
116      test.TearDown()
117    except Exception:
118      logging.exception(
119          'Caught exception while trying run TearDown() for test: ' +
120          test.tagged_name)
121      if not exception_raised:
122        # Don't stomp the error during the test if TearDown blows up. This is a
123        # trade-off: if the test fails, this will mask any problem with TearDown
124        # until the test is fixed.
125        exc_info = sys.exc_info()
126        results = base_test_result.TestRunResults()
127        results.AddResult(HostDrivenExceptionTestResult(
128            test.tagged_name, start_date_ms, exc_info))
129
130    if not results.DidRunPass():
131      return results, test
132    else:
133      return results, None
134