gtest_xml_test_utils.py 8.63 KB
Newer Older
shiqian's avatar
shiqian committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#!/usr/bin/env python
#
# Copyright 2006, Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
#     * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Unit test utilities for gtest_xml_output"""

__author__ = 'eefacm@gmail.com (Sean Mcafee)'

import re
from xml.dom import minidom, Node

39
40
41
import gtest_test_utils


42
43
GTEST_OUTPUT_FLAG         = '--gtest_output'
GTEST_DEFAULT_OUTPUT_FILE = 'test_detail.xml'
shiqian's avatar
shiqian committed
44

45
class GTestXMLTestCase(gtest_test_utils.TestCase):
shiqian's avatar
shiqian committed
46
47
48
49
50
  """
  Base class for tests of Google Test's XML output functionality.
  """


shiqian's avatar
shiqian committed
51
  def AssertEquivalentNodes(self, expected_node, actual_node):
shiqian's avatar
shiqian committed
52
    """
shiqian's avatar
shiqian committed
53
54
55
56
57
58
59
60
    Asserts that actual_node (a DOM node object) is equivalent to
    expected_node (another DOM node object), in that either both of
    them are CDATA nodes and have the same value, or both are DOM
    elements and actual_node meets all of the following conditions:

    *  It has the same tag name as expected_node.
    *  It has the same set of attributes as expected_node, each with
       the same value as the corresponding attribute of expected_node.
61
62
63
       Exceptions are any attribute named "time", which needs only be
       convertible to a floating-point number and any attribute named
       "type_param" which only has to be non-empty.
shiqian's avatar
shiqian committed
64
65
66
67
    *  It has an equivalent set of child nodes (including elements and
       CDATA sections) as expected_node.  Note that we ignore the
       order of the children as they are not guaranteed to be in any
       particular order.
shiqian's avatar
shiqian committed
68
69
    """

shiqian's avatar
shiqian committed
70
71
72
73
74
75
76
77
78
79
80
    if expected_node.nodeType == Node.CDATA_SECTION_NODE:
      self.assertEquals(Node.CDATA_SECTION_NODE, actual_node.nodeType)
      self.assertEquals(expected_node.nodeValue, actual_node.nodeValue)
      return

    self.assertEquals(Node.ELEMENT_NODE, actual_node.nodeType)
    self.assertEquals(Node.ELEMENT_NODE, expected_node.nodeType)
    self.assertEquals(expected_node.tagName, actual_node.tagName)

    expected_attributes = expected_node.attributes
    actual_attributes   = actual_node  .attributes
81
82
    self.assertEquals(
        expected_attributes.length, actual_attributes.length,
83
84
85
        'attribute numbers differ in element %s:\nExpected: %r\nActual: %r' % (
            actual_node.tagName, expected_attributes.keys(),
            actual_attributes.keys()))
shiqian's avatar
shiqian committed
86
87
88
    for i in range(expected_attributes.length):
      expected_attr = expected_attributes.item(i)
      actual_attr   = actual_attributes.get(expected_attr.name)
89
90
      self.assert_(
          actual_attr is not None,
91
          'expected attribute %s not found in element %s' %
92
93
          (expected_attr.name, actual_node.tagName))
      self.assertEquals(expected_attr.value, actual_attr.value,
94
                        ' values of attribute %s in element %s differ' %
95
                        (expected_attr.name, actual_node.tagName))
shiqian's avatar
shiqian committed
96

shiqian's avatar
shiqian committed
97
98
    expected_children = self._GetChildren(expected_node)
    actual_children = self._GetChildren(actual_node)
99
100
    self.assertEquals(
        len(expected_children), len(actual_children),
101
        'number of child elements differ in element ' + actual_node.tagName)
shiqian's avatar
shiqian committed
102
103
    for child_id, child in expected_children.iteritems():
      self.assert_(child_id in actual_children,
104
105
                   '<%s> is not in <%s> (in element %s)' %
                   (child_id, actual_children, actual_node.tagName))
shiqian's avatar
shiqian committed
106
      self.AssertEquivalentNodes(child, actual_children[child_id])
shiqian's avatar
shiqian committed
107
108

  identifying_attribute = {
109
110
111
112
    'testsuites': 'name',
    'testsuite': 'name',
    'testcase':  'name',
    'failure':   'message',
shiqian's avatar
shiqian committed
113
114
    }

shiqian's avatar
shiqian committed
115
  def _GetChildren(self, element):
shiqian's avatar
shiqian committed
116
    """
shiqian's avatar
shiqian committed
117
118
    Fetches all of the child nodes of element, a DOM Element object.
    Returns them as the values of a dictionary keyed by the IDs of the
119
120
121
122
123
124
125
    children.  For <testsuites>, <testsuite> and <testcase> elements, the ID
    is the value of their "name" attribute; for <failure> elements, it is
    the value of the "message" attribute; CDATA sections and non-whitespace
    text nodes are concatenated into a single CDATA section with ID
    "detail".  An exception is raised if any element other than the above
    four is encountered, if two child elements with the same identifying
    attributes are encountered, or if any other type of node is encountered.
shiqian's avatar
shiqian committed
126
    """
shiqian's avatar
shiqian committed
127

shiqian's avatar
shiqian committed
128
129
130
131
    children = {}
    for child in element.childNodes:
      if child.nodeType == Node.ELEMENT_NODE:
        self.assert_(child.tagName in self.identifying_attribute,
132
                     'Encountered unknown element <%s>' % child.tagName)
shiqian's avatar
shiqian committed
133
134
135
        childID = child.getAttribute(self.identifying_attribute[child.tagName])
        self.assert_(childID not in children)
        children[childID] = child
136
      elif child.nodeType in [Node.TEXT_NODE, Node.CDATA_SECTION_NODE]:
137
        if 'detail' not in children:
138
139
          if (child.nodeType == Node.CDATA_SECTION_NODE or
              not child.nodeValue.isspace()):
140
            children['detail'] = child.ownerDocument.createCDATASection(
141
142
                child.nodeValue)
        else:
143
          children['detail'].nodeValue += child.nodeValue
shiqian's avatar
shiqian committed
144
      else:
145
        self.fail('Encountered unexpected node type %d' % child.nodeType)
shiqian's avatar
shiqian committed
146
147
    return children

shiqian's avatar
shiqian committed
148
  def NormalizeXml(self, element):
shiqian's avatar
shiqian committed
149
150
151
152
    """
    Normalizes Google Test's XML output to eliminate references to transient
    information that may change from run to run.

153
154
155
    *  The "time" attribute of <testsuites>, <testsuite> and <testcase>
       elements is replaced with a single asterisk, if it contains
       only digit characters.
156
157
    *  The "timestamp" attribute of <testsuites> elements is replaced with a
       single asterisk, if it contains a valid ISO8601 datetime value.
158
159
160
    *  The "type_param" attribute of <testcase> elements is replaced with a
       single asterisk (if it sn non-empty) as it is the type name returned
       by the compiler and is platform dependent.
161
162
163
    *  The line info reported in the first line of the "message"
       attribute and CDATA section of <failure> elements is replaced with the
       file's basename and a single asterisk for the line number.
shiqian's avatar
shiqian committed
164
    *  The directory names in file paths are removed.
shiqian's avatar
shiqian committed
165
    *  The stack traces are removed.
shiqian's avatar
shiqian committed
166
    """
shiqian's avatar
shiqian committed
167

168
169
170
171
172
173
174
175
    if element.tagName == 'testsuites':
      timestamp = element.getAttributeNode('timestamp')
      timestamp.value = re.sub(r'^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d$',
                               '*', timestamp.value)
    if element.tagName in ('testsuites', 'testsuite', 'testcase'):
      time = element.getAttributeNode('time')
      time.value = re.sub(r'^\d+(\.\d+)?$', '*', time.value)
      type_param = element.getAttributeNode('type_param')
176
      if type_param and type_param.value:
177
178
        type_param.value = '*'
    elif element.tagName == 'failure':
179
180
181
182
      source_line_pat = r'^.*[/\\](.*:)\d+\n'
      # Replaces the source line information with a normalized form.
      message = element.getAttributeNode('message')
      message.value = re.sub(source_line_pat, '\\1*\n', message.value)
shiqian's avatar
shiqian committed
183
184
      for child in element.childNodes:
        if child.nodeType == Node.CDATA_SECTION_NODE:
185
186
          # Replaces the source line information with a normalized form.
          cdata = re.sub(source_line_pat, '\\1*\n', child.nodeValue)
shiqian's avatar
shiqian committed
187
          # Removes the actual stack trace.
188
189
          child.nodeValue = re.sub(r'\nStack trace:\n(.|\n)*',
                                   '', cdata)
shiqian's avatar
shiqian committed
190
191
    for child in element.childNodes:
      if child.nodeType == Node.ELEMENT_NODE:
shiqian's avatar
shiqian committed
192
        self.NormalizeXml(child)