gtest_xml_test_utils.py 9 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
# 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"""

import re
33
from xml.dom import minidom, Node
Gennadiy Civil's avatar
 
Gennadiy Civil committed
34
import gtest_test_utils
35

36
GTEST_DEFAULT_OUTPUT_FILE = 'test_detail.xml'
shiqian's avatar
shiqian committed
37

38
class GTestXMLTestCase(gtest_test_utils.TestCase):
shiqian's avatar
shiqian committed
39
40
41
42
43
  """
  Base class for tests of Google Test's XML output functionality.
  """


shiqian's avatar
shiqian committed
44
  def AssertEquivalentNodes(self, expected_node, actual_node):
shiqian's avatar
shiqian committed
45
    """
shiqian's avatar
shiqian committed
46
47
48
49
50
51
52
53
    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.
54
55
56
       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
57
58
59
60
    *  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
61
62
    """

shiqian's avatar
shiqian committed
63
64
65
66
67
68
69
70
71
72
73
    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
74
75
    self.assertEquals(
        expected_attributes.length, actual_attributes.length,
76
77
78
        'attribute numbers differ in element %s:\nExpected: %r\nActual: %r' % (
            actual_node.tagName, expected_attributes.keys(),
            actual_attributes.keys()))
shiqian's avatar
shiqian committed
79
80
81
    for i in range(expected_attributes.length):
      expected_attr = expected_attributes.item(i)
      actual_attr   = actual_attributes.get(expected_attr.name)
82
83
      self.assert_(
          actual_attr is not None,
84
          'expected attribute %s not found in element %s' %
85
          (expected_attr.name, actual_node.tagName))
86
87
88
89
90
      self.assertEquals(
          expected_attr.value, actual_attr.value,
          ' values of attribute %s in element %s differ: %s vs %s' %
          (expected_attr.name, actual_node.tagName,
           expected_attr.value, actual_attr.value))
shiqian's avatar
shiqian committed
91

shiqian's avatar
shiqian committed
92
93
    expected_children = self._GetChildren(expected_node)
    actual_children = self._GetChildren(actual_node)
94
95
    self.assertEquals(
        len(expected_children), len(actual_children),
96
        'number of child elements differ in element ' + actual_node.tagName)
Peter Levine's avatar
Peter Levine committed
97
    for child_id, child in expected_children.items():
shiqian's avatar
shiqian committed
98
      self.assert_(child_id in actual_children,
99
100
                   '<%s> is not in <%s> (in element %s)' %
                   (child_id, actual_children, actual_node.tagName))
shiqian's avatar
shiqian committed
101
      self.AssertEquivalentNodes(child, actual_children[child_id])
shiqian's avatar
shiqian committed
102
103

  identifying_attribute = {
Gennadiy Civil's avatar
Gennadiy Civil committed
104
105
106
107
108
109
      'testsuites': 'name',
      'testsuite': 'name',
      'testcase': 'name',
      'failure': 'message',
      'property': 'name',
  }
shiqian's avatar
shiqian committed
110

shiqian's avatar
shiqian committed
111
  def _GetChildren(self, element):
shiqian's avatar
shiqian committed
112
    """
shiqian's avatar
shiqian committed
113
114
    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
Gennadiy Civil's avatar
Gennadiy Civil committed
115
116
117
118
119
    children.  For <testsuites>, <testsuite>, <testcase>, and <property>
    elements, the ID is the value of their "name" attribute; for <failure>
    elements, it is the value of the "message" attribute; for <properties>
    elements, it is the value of their parent's "name" attribute plus the
    literal string "properties"; CDATA sections and non-whitespace
120
121
122
123
    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
124
    """
shiqian's avatar
shiqian committed
125

shiqian's avatar
shiqian committed
126
127
128
    children = {}
    for child in element.childNodes:
      if child.nodeType == Node.ELEMENT_NODE:
Gennadiy Civil's avatar
Gennadiy Civil committed
129
130
131
132
133
134
135
136
137
138
139
        if child.tagName == 'properties':
          self.assert_(child.parentNode is not None,
                       'Encountered <properties> element without a parent')
          child_id = child.parentNode.getAttribute('name') + '-properties'
        else:
          self.assert_(child.tagName in self.identifying_attribute,
                       'Encountered unknown element <%s>' % child.tagName)
          child_id = child.getAttribute(
              self.identifying_attribute[child.tagName])
        self.assert_(child_id not in children)
        children[child_id] = child
140
      elif child.nodeType in [Node.TEXT_NODE, Node.CDATA_SECTION_NODE]:
141
        if 'detail' not in children:
142
143
          if (child.nodeType == Node.CDATA_SECTION_NODE or
              not child.nodeValue.isspace()):
144
            children['detail'] = child.ownerDocument.createCDATASection(
145
146
                child.nodeValue)
        else:
147
          children['detail'].nodeValue += child.nodeValue
shiqian's avatar
shiqian committed
148
      else:
149
        self.fail('Encountered unexpected node type %d' % child.nodeType)
shiqian's avatar
shiqian committed
150
151
    return children

shiqian's avatar
shiqian committed
152
  def NormalizeXml(self, element):
shiqian's avatar
shiqian committed
153
154
155
156
    """
    Normalizes Google Test's XML output to eliminate references to transient
    information that may change from run to run.

157
158
159
    *  The "time" attribute of <testsuites>, <testsuite> and <testcase>
       elements is replaced with a single asterisk, if it contains
       only digit characters.
160
161
    *  The "timestamp" attribute of <testsuites> elements is replaced with a
       single asterisk, if it contains a valid ISO8601 datetime value.
162
163
164
    *  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.
165
166
167
    *  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
168
    *  The directory names in file paths are removed.
shiqian's avatar
shiqian committed
169
    *  The stack traces are removed.
shiqian's avatar
shiqian committed
170
    """
shiqian's avatar
shiqian committed
171

172
173
174
175
176
177
178
179
    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')
180
      if type_param and type_param.value:
181
182
        type_param.value = '*'
    elif element.tagName == 'failure':
183
184
185
186
      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
187
188
      for child in element.childNodes:
        if child.nodeType == Node.CDATA_SECTION_NODE:
189
190
          # Replaces the source line information with a normalized form.
          cdata = re.sub(source_line_pat, '\\1*\n', child.nodeValue)
shiqian's avatar
shiqian committed
191
          # Removes the actual stack trace.
192
193
          child.nodeValue = re.sub(r'Stack trace:\n(.|\n)*',
                                   'Stack trace:\n*', cdata)
shiqian's avatar
shiqian committed
194
195
    for child in element.childNodes:
      if child.nodeType == Node.ELEMENT_NODE:
shiqian's avatar
shiqian committed
196
        self.NormalizeXml(child)