1# Copyright (C) 2010 Google Inc. All rights reserved.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met:
6#
7#     * Redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer.
9#     * Redistributions in binary form must reproduce the above
10# copyright notice, this list of conditions and the following disclaimer
11# in the documentation and/or other materials provided with the
12# distribution.
13#     * Neither the name of Google Inc. nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29import cPickle
30
31from webkitpy.layout_tests.models import test_failures
32
33
34class TestResult(object):
35    """Data object containing the results of a single test."""
36
37    @staticmethod
38    def loads(string):
39        return cPickle.loads(string)
40
41    def __init__(self, test_name, failures=None, test_run_time=None, has_stderr=False, reftest_type=None, pid=None, references=None, device_failed=False, has_repaint_overlay=False):
42        self.test_name = test_name
43        self.failures = failures or []
44        self.test_run_time = test_run_time or 0  # The time taken to execute the test itself.
45        self.has_stderr = has_stderr
46        self.reftest_type = reftest_type or []
47        self.pid = pid
48        self.references = references or []
49        self.device_failed = device_failed
50        self.has_repaint_overlay = has_repaint_overlay
51
52        # FIXME: Setting this in the constructor makes this class hard to mutate.
53        self.type = test_failures.determine_result_type(failures)
54
55        # These are set by the worker, not by the driver, so they are not passed to the constructor.
56        self.worker_name = ''
57        self.shard_name = ''
58        self.total_run_time = 0  # The time taken to run the test plus any references, compute diffs, etc.
59        self.test_number = None
60
61    def __eq__(self, other):
62        return (self.test_name == other.test_name and
63                self.failures == other.failures and
64                self.test_run_time == other.test_run_time)
65
66    def __ne__(self, other):
67        return not (self == other)
68
69    def has_failure_matching_types(self, *failure_classes):
70        for failure in self.failures:
71            if type(failure) in failure_classes:
72                return True
73        return False
74
75    def dumps(self):
76        return cPickle.dumps(self)
77