Home | History | Annotate | Download | only in objects 
      1 # Copyright 2012 the V8 project authors. All rights reserved.
      2 # Redistribution and use in source and binary forms, with or without
      3 # modification, are permitted provided that the following conditions are
      4 # met:
      5 #
      6 #     * Redistributions of source code must retain the above copyright
      7 #       notice, this list of conditions and the following disclaimer.
      8 #     * Redistributions in binary form must reproduce the above
      9 #       copyright notice, this list of conditions and the following
     10 #       disclaimer in the documentation and/or other materials provided
     11 #       with the distribution.
     12 #     * Neither the name of Google Inc. nor the names of its
     13 #       contributors may be used to endorse or promote products derived
     14 #       from this software without specific prior written permission.
     15 #
     16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 
     28 
     29 from . import output
     30 
     31 class TestCase(object):
     32   def __init__(self, suite, path, variant=None, flags=None,
     33                override_shell=None):
     34     self.suite = suite        # TestSuite object
     35     self.path = path          # string, e.g. 'div-mod', 'test-api/foo'
     36     self.flags = flags or []  # list of strings, flags specific to this test
     37     self.variant = variant    # name of the used testing variant
     38     self.override_shell = override_shell
     39     self.outcomes = frozenset([])
     40     self.output = None
     41     self.id = None  # int, used to map result back to TestCase instance
     42     self.duration = None  # assigned during execution
     43     self.run = 1  # The nth time this test is executed.
     44 
     45   def CopyAddingFlags(self, variant, flags):
     46     copy = TestCase(self.suite, self.path, variant, self.flags + flags,
     47                     self.override_shell)
     48     copy.outcomes = self.outcomes
     49     return copy
     50 
     51   def PackTask(self):
     52     """
     53     Extracts those parts of this object that are required to run the test
     54     and returns them as a JSON serializable object.
     55     """
     56     assert self.id is not None
     57     return [self.suitename(), self.path, self.variant, self.flags,
     58             self.override_shell, list(self.outcomes or []),
     59             self.id]
     60 
     61   @staticmethod
     62   def UnpackTask(task):
     63     """Creates a new TestCase object based on packed task data."""
     64     # For the order of the fields, refer to PackTask() above.
     65     test = TestCase(str(task[0]), task[1], task[2], task[3], task[4])
     66     test.outcomes = frozenset(task[5])
     67     test.id = task[6]
     68     test.run = 1
     69     return test
     70 
     71   def SetSuiteObject(self, suites):
     72     self.suite = suites[self.suite]
     73 
     74   def PackResult(self):
     75     """Serializes the output of the TestCase after it has run."""
     76     self.suite.StripOutputForTransmit(self)
     77     return [self.id, self.output.Pack(), self.duration]
     78 
     79   def MergeResult(self, result):
     80     """Applies the contents of a Result to this object."""
     81     assert result[0] == self.id
     82     self.output = output.Output.Unpack(result[1])
     83     self.duration = result[2]
     84 
     85   def suitename(self):
     86     return self.suite.name
     87 
     88   def GetLabel(self):
     89     return self.suitename() + "/" + self.suite.CommonTestName(self)
     90 
     91   def shell(self):
     92     if self.override_shell:
     93       return self.override_shell
     94     return self.suite.shell()
     95 
     96   def __getstate__(self):
     97     """Representation to pickle test cases.
     98 
     99     The original suite won't be sent beyond process boundaries. Instead
    100     send the name only and retrieve a process-local suite later.
    101     """
    102     return dict(self.__dict__, suite=self.suite.name)
    103 
    104   def __cmp__(self, other):
    105     # Make sure that test cases are sorted correctly if sorted without
    106     # key function. But using a key function is preferred for speed.
    107     return cmp(
    108         (self.suite.name, self.path, self.flags),
    109         (other.suite.name, other.path, other.flags),
    110     )
    111 
    112   def __str__(self):
    113     return "[%s/%s  %s]" % (self.suite.name, self.path, self.flags)
    114