1#!/usr/bin/env python
2#
3# Copyright 2008, Google Inc.
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met:
9#
10#     * Redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer.
12#     * Redistributions in binary form must reproduce the above
13# copyright notice, this list of conditions and the following disclaimer
14# in the documentation and/or other materials provided with the
15# distribution.
16#     * Neither the name of Google Inc. nor the names of its
17# contributors may be used to endorse or promote products derived from
18# this software without specific prior written permission.
19#
20# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32"""Tests the text output of Google C++ Testing and Mocking Framework.
33
34To update the golden file:
35googletest_output_test.py --build_dir=BUILD/DIR --gengolden
36where BUILD/DIR contains the built googletest-output-test_ file.
37googletest_output_test.py --gengolden
38googletest_output_test.py
39"""
40
41import difflib
42import os
43import re
44import sys
45import gtest_test_utils
46
47
48# The flag for generating the golden file
49GENGOLDEN_FLAG = '--gengolden'
50CATCH_EXCEPTIONS_ENV_VAR_NAME = 'GTEST_CATCH_EXCEPTIONS'
51
52# The flag indicating stacktraces are not supported
53NO_STACKTRACE_SUPPORT_FLAG = '--no_stacktrace_support'
54
55IS_LINUX = os.name == 'posix' and os.uname()[0] == 'Linux'
56IS_WINDOWS = os.name == 'nt'
57
58# FIXME: remove the _lin suffix.
59GOLDEN_NAME = 'googletest-output-test-golden-lin.txt'
60
61PROGRAM_PATH = gtest_test_utils.GetTestExecutablePath('googletest-output-test_')
62
63# At least one command we exercise must not have the
64# 'internal_skip_environment_and_ad_hoc_tests' argument.
65COMMAND_LIST_TESTS = ({}, [PROGRAM_PATH, '--gtest_list_tests'])
66COMMAND_WITH_COLOR = ({}, [PROGRAM_PATH, '--gtest_color=yes'])
67COMMAND_WITH_TIME = ({}, [PROGRAM_PATH,
68                          '--gtest_print_time',
69                          'internal_skip_environment_and_ad_hoc_tests',
70                          '--gtest_filter=FatalFailureTest.*:LoggingTest.*'])
71COMMAND_WITH_DISABLED = (
72    {}, [PROGRAM_PATH,
73         '--gtest_also_run_disabled_tests',
74         'internal_skip_environment_and_ad_hoc_tests',
75         '--gtest_filter=*DISABLED_*'])
76COMMAND_WITH_SHARDING = (
77    {'GTEST_SHARD_INDEX': '1', 'GTEST_TOTAL_SHARDS': '2'},
78    [PROGRAM_PATH,
79     'internal_skip_environment_and_ad_hoc_tests',
80     '--gtest_filter=PassingTest.*'])
81
82GOLDEN_PATH = os.path.join(gtest_test_utils.GetSourceDir(), GOLDEN_NAME)
83
84
85def ToUnixLineEnding(s):
86  """Changes all Windows/Mac line endings in s to UNIX line endings."""
87
88  return s.replace('\r\n', '\n').replace('\r', '\n')
89
90
91def RemoveLocations(test_output):
92  """Removes all file location info from a Google Test program's output.
93
94  Args:
95       test_output:  the output of a Google Test program.
96
97  Returns:
98       output with all file location info (in the form of
99       'DIRECTORY/FILE_NAME:LINE_NUMBER: 'or
100       'DIRECTORY\\FILE_NAME(LINE_NUMBER): ') replaced by
101       'FILE_NAME:#: '.
102  """
103
104  return re.sub(r'.*[/\\]((googletest-output-test_|gtest).cc)(\:\d+|\(\d+\))\: ',
105                r'\1:#: ', test_output)
106
107
108def RemoveStackTraceDetails(output):
109  """Removes all stack traces from a Google Test program's output."""
110
111  # *? means "find the shortest string that matches".
112  return re.sub(r'Stack trace:(.|\n)*?\n\n',
113                'Stack trace: (omitted)\n\n', output)
114
115
116def RemoveStackTraces(output):
117  """Removes all traces of stack traces from a Google Test program's output."""
118
119  # *? means "find the shortest string that matches".
120  return re.sub(r'Stack trace:(.|\n)*?\n\n', '', output)
121
122
123def RemoveTime(output):
124  """Removes all time information from a Google Test program's output."""
125
126  return re.sub(r'\(\d+ ms', '(? ms', output)
127
128
129def RemoveTypeInfoDetails(test_output):
130  """Removes compiler-specific type info from Google Test program's output.
131
132  Args:
133       test_output:  the output of a Google Test program.
134
135  Returns:
136       output with type information normalized to canonical form.
137  """
138
139  # some compilers output the name of type 'unsigned int' as 'unsigned'
140  return re.sub(r'unsigned int', 'unsigned', test_output)
141
142
143def NormalizeToCurrentPlatform(test_output):
144  """Normalizes platform specific output details for easier comparison."""
145
146  if IS_WINDOWS:
147    # Removes the color information that is not present on Windows.
148    test_output = re.sub('\x1b\\[(0;3\d)?m', '', test_output)
149    # Changes failure message headers into the Windows format.
150    test_output = re.sub(r': Failure\n', r': error: ', test_output)
151    # Changes file(line_number) to file:line_number.
152    test_output = re.sub(r'((\w|\.)+)\((\d+)\):', r'\1:\3:', test_output)
153
154  return test_output
155
156
157def RemoveTestCounts(output):
158  """Removes test counts from a Google Test program's output."""
159
160  output = re.sub(r'\d+ tests?, listed below',
161                  '? tests, listed below', output)
162  output = re.sub(r'\d+ FAILED TESTS',
163                  '? FAILED TESTS', output)
164  output = re.sub(r'\d+ tests? from \d+ test cases?',
165                  '? tests from ? test cases', output)
166  output = re.sub(r'\d+ tests? from ([a-zA-Z_])',
167                  r'? tests from \1', output)
168  return re.sub(r'\d+ tests?\.', '? tests.', output)
169
170
171def RemoveMatchingTests(test_output, pattern):
172  """Removes output of specified tests from a Google Test program's output.
173
174  This function strips not only the beginning and the end of a test but also
175  all output in between.
176
177  Args:
178    test_output:       A string containing the test output.
179    pattern:           A regex string that matches names of test cases or
180                       tests to remove.
181
182  Returns:
183    Contents of test_output with tests whose names match pattern removed.
184  """
185
186  test_output = re.sub(
187      r'.*\[ RUN      \] .*%s(.|\n)*?\[(  FAILED  |       OK )\] .*%s.*\n' % (
188          pattern, pattern),
189      '',
190      test_output)
191  return re.sub(r'.*%s.*\n' % pattern, '', test_output)
192
193
194def NormalizeOutput(output):
195  """Normalizes output (the output of googletest-output-test_.exe)."""
196
197  output = ToUnixLineEnding(output)
198  output = RemoveLocations(output)
199  output = RemoveStackTraceDetails(output)
200  output = RemoveTime(output)
201  return output
202
203
204def GetShellCommandOutput(env_cmd):
205  """Runs a command in a sub-process, and returns its output in a string.
206
207  Args:
208    env_cmd: The shell command. A 2-tuple where element 0 is a dict of extra
209             environment variables to set, and element 1 is a string with
210             the command and any flags.
211
212  Returns:
213    A string with the command's combined standard and diagnostic output.
214  """
215
216  # Spawns cmd in a sub-process, and gets its standard I/O file objects.
217  # Set and save the environment properly.
218  environ = os.environ.copy()
219  environ.update(env_cmd[0])
220  p = gtest_test_utils.Subprocess(env_cmd[1], env=environ)
221
222  return p.output
223
224
225def GetCommandOutput(env_cmd):
226  """Runs a command and returns its output with all file location
227  info stripped off.
228
229  Args:
230    env_cmd:  The shell command. A 2-tuple where element 0 is a dict of extra
231              environment variables to set, and element 1 is a string with
232              the command and any flags.
233  """
234
235  # Disables exception pop-ups on Windows.
236  environ, cmdline = env_cmd
237  environ = dict(environ)  # Ensures we are modifying a copy.
238  environ[CATCH_EXCEPTIONS_ENV_VAR_NAME] = '1'
239  return NormalizeOutput(GetShellCommandOutput((environ, cmdline)))
240
241
242def GetOutputOfAllCommands():
243  """Returns concatenated output from several representative commands."""
244
245  return (GetCommandOutput(COMMAND_WITH_COLOR) +
246          GetCommandOutput(COMMAND_WITH_TIME) +
247          GetCommandOutput(COMMAND_WITH_DISABLED) +
248          GetCommandOutput(COMMAND_WITH_SHARDING))
249
250
251test_list = GetShellCommandOutput(COMMAND_LIST_TESTS)
252SUPPORTS_DEATH_TESTS = 'DeathTest' in test_list
253SUPPORTS_TYPED_TESTS = 'TypedTest' in test_list
254SUPPORTS_THREADS = 'ExpectFailureWithThreadsTest' in test_list
255SUPPORTS_STACK_TRACES = NO_STACKTRACE_SUPPORT_FLAG not in sys.argv
256
257CAN_GENERATE_GOLDEN_FILE = (SUPPORTS_DEATH_TESTS and
258                            SUPPORTS_TYPED_TESTS and
259                            SUPPORTS_THREADS and
260                            SUPPORTS_STACK_TRACES)
261
262class GTestOutputTest(gtest_test_utils.TestCase):
263  def RemoveUnsupportedTests(self, test_output):
264    if not SUPPORTS_DEATH_TESTS:
265      test_output = RemoveMatchingTests(test_output, 'DeathTest')
266    if not SUPPORTS_TYPED_TESTS:
267      test_output = RemoveMatchingTests(test_output, 'TypedTest')
268      test_output = RemoveMatchingTests(test_output, 'TypedDeathTest')
269      test_output = RemoveMatchingTests(test_output, 'TypeParamDeathTest')
270    if not SUPPORTS_THREADS:
271      test_output = RemoveMatchingTests(test_output,
272                                        'ExpectFailureWithThreadsTest')
273      test_output = RemoveMatchingTests(test_output,
274                                        'ScopedFakeTestPartResultReporterTest')
275      test_output = RemoveMatchingTests(test_output,
276                                        'WorksConcurrently')
277    if not SUPPORTS_STACK_TRACES:
278      test_output = RemoveStackTraces(test_output)
279
280    return test_output
281
282  def testOutput(self):
283    output = GetOutputOfAllCommands()
284
285    golden_file = open(GOLDEN_PATH, 'rb')
286    # A mis-configured source control system can cause \r appear in EOL
287    # sequences when we read the golden file irrespective of an operating
288    # system used. Therefore, we need to strip those \r's from newlines
289    # unconditionally.
290    golden = ToUnixLineEnding(golden_file.read())
291    golden_file.close()
292
293    # We want the test to pass regardless of certain features being
294    # supported or not.
295
296    # We still have to remove type name specifics in all cases.
297    normalized_actual = RemoveTypeInfoDetails(output)
298    normalized_golden = RemoveTypeInfoDetails(golden)
299
300    if CAN_GENERATE_GOLDEN_FILE:
301      self.assertEqual(normalized_golden, normalized_actual,
302                       '\n'.join(difflib.unified_diff(
303                           normalized_golden.split('\n'),
304                           normalized_actual.split('\n'),
305                           'golden', 'actual')))
306    else:
307      normalized_actual = NormalizeToCurrentPlatform(
308          RemoveTestCounts(normalized_actual))
309      normalized_golden = NormalizeToCurrentPlatform(
310          RemoveTestCounts(self.RemoveUnsupportedTests(normalized_golden)))
311
312      # This code is very handy when debugging golden file differences:
313      if os.getenv('DEBUG_GTEST_OUTPUT_TEST'):
314        open(os.path.join(
315            gtest_test_utils.GetSourceDir(),
316            '_googletest-output-test_normalized_actual.txt'), 'wb').write(
317                normalized_actual)
318        open(os.path.join(
319            gtest_test_utils.GetSourceDir(),
320            '_googletest-output-test_normalized_golden.txt'), 'wb').write(
321                normalized_golden)
322
323      self.assertEqual(normalized_golden, normalized_actual)
324
325
326if __name__ == '__main__':
327  if NO_STACKTRACE_SUPPORT_FLAG in sys.argv:
328    # unittest.main() can't handle unknown flags
329    sys.argv.remove(NO_STACKTRACE_SUPPORT_FLAG)
330
331  if GENGOLDEN_FLAG in sys.argv:
332    if CAN_GENERATE_GOLDEN_FILE:
333      output = GetOutputOfAllCommands()
334      golden_file = open(GOLDEN_PATH, 'wb')
335      golden_file.write(output)
336      golden_file.close()
337    else:
338      message = (
339          """Unable to write a golden file when compiled in an environment
340that does not support all the required features (death tests,
341typed tests, stack traces, and multiple threads).
342Please build this test and generate the golden file using Blaze on Linux.""")
343
344      sys.stderr.write(message)
345      sys.exit(1)
346  else:
347    gtest_test_utils.Main()
348