gmock_output_test.py revision 13481
113481Sgiacomo.travaglini@arm.com#!/usr/bin/env python 213481Sgiacomo.travaglini@arm.com# 313481Sgiacomo.travaglini@arm.com# Copyright 2008, Google Inc. 413481Sgiacomo.travaglini@arm.com# All rights reserved. 513481Sgiacomo.travaglini@arm.com# 613481Sgiacomo.travaglini@arm.com# Redistribution and use in source and binary forms, with or without 713481Sgiacomo.travaglini@arm.com# modification, are permitted provided that the following conditions are 813481Sgiacomo.travaglini@arm.com# met: 913481Sgiacomo.travaglini@arm.com# 1013481Sgiacomo.travaglini@arm.com# * Redistributions of source code must retain the above copyright 1113481Sgiacomo.travaglini@arm.com# notice, this list of conditions and the following disclaimer. 1213481Sgiacomo.travaglini@arm.com# * Redistributions in binary form must reproduce the above 1313481Sgiacomo.travaglini@arm.com# copyright notice, this list of conditions and the following disclaimer 1413481Sgiacomo.travaglini@arm.com# in the documentation and/or other materials provided with the 1513481Sgiacomo.travaglini@arm.com# distribution. 1613481Sgiacomo.travaglini@arm.com# * Neither the name of Google Inc. nor the names of its 1713481Sgiacomo.travaglini@arm.com# contributors may be used to endorse or promote products derived from 1813481Sgiacomo.travaglini@arm.com# this software without specific prior written permission. 1913481Sgiacomo.travaglini@arm.com# 2013481Sgiacomo.travaglini@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2113481Sgiacomo.travaglini@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2213481Sgiacomo.travaglini@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2313481Sgiacomo.travaglini@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2413481Sgiacomo.travaglini@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2513481Sgiacomo.travaglini@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2613481Sgiacomo.travaglini@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2713481Sgiacomo.travaglini@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2813481Sgiacomo.travaglini@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2913481Sgiacomo.travaglini@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3013481Sgiacomo.travaglini@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3113481Sgiacomo.travaglini@arm.com 3213481Sgiacomo.travaglini@arm.com"""Tests the text output of Google C++ Mocking Framework. 3313481Sgiacomo.travaglini@arm.com 3413481Sgiacomo.travaglini@arm.comSYNOPSIS 3513481Sgiacomo.travaglini@arm.com gmock_output_test.py --build_dir=BUILD/DIR --gengolden 3613481Sgiacomo.travaglini@arm.com # where BUILD/DIR contains the built gmock_output_test_ file. 3713481Sgiacomo.travaglini@arm.com gmock_output_test.py --gengolden 3813481Sgiacomo.travaglini@arm.com gmock_output_test.py 3913481Sgiacomo.travaglini@arm.com""" 4013481Sgiacomo.travaglini@arm.com 4113481Sgiacomo.travaglini@arm.com__author__ = 'wan@google.com (Zhanyong Wan)' 4213481Sgiacomo.travaglini@arm.com 4313481Sgiacomo.travaglini@arm.comimport os 4413481Sgiacomo.travaglini@arm.comimport re 4513481Sgiacomo.travaglini@arm.comimport sys 4613481Sgiacomo.travaglini@arm.com 4713481Sgiacomo.travaglini@arm.comimport gmock_test_utils 4813481Sgiacomo.travaglini@arm.com 4913481Sgiacomo.travaglini@arm.com 5013481Sgiacomo.travaglini@arm.com# The flag for generating the golden file 5113481Sgiacomo.travaglini@arm.comGENGOLDEN_FLAG = '--gengolden' 5213481Sgiacomo.travaglini@arm.com 5313481Sgiacomo.travaglini@arm.comPROGRAM_PATH = gmock_test_utils.GetTestExecutablePath('gmock_output_test_') 5413481Sgiacomo.travaglini@arm.comCOMMAND = [PROGRAM_PATH, '--gtest_stack_trace_depth=0', '--gtest_print_time=0'] 5513481Sgiacomo.travaglini@arm.comGOLDEN_NAME = 'gmock_output_test_golden.txt' 5613481Sgiacomo.travaglini@arm.comGOLDEN_PATH = os.path.join(gmock_test_utils.GetSourceDir(), GOLDEN_NAME) 5713481Sgiacomo.travaglini@arm.com 5813481Sgiacomo.travaglini@arm.com 5913481Sgiacomo.travaglini@arm.comdef ToUnixLineEnding(s): 6013481Sgiacomo.travaglini@arm.com """Changes all Windows/Mac line endings in s to UNIX line endings.""" 6113481Sgiacomo.travaglini@arm.com 6213481Sgiacomo.travaglini@arm.com return s.replace('\r\n', '\n').replace('\r', '\n') 6313481Sgiacomo.travaglini@arm.com 6413481Sgiacomo.travaglini@arm.com 6513481Sgiacomo.travaglini@arm.comdef RemoveReportHeaderAndFooter(output): 6613481Sgiacomo.travaglini@arm.com """Removes Google Test result report's header and footer from the output.""" 6713481Sgiacomo.travaglini@arm.com 6813481Sgiacomo.travaglini@arm.com output = re.sub(r'.*gtest_main.*\n', '', output) 6913481Sgiacomo.travaglini@arm.com output = re.sub(r'\[.*\d+ tests.*\n', '', output) 7013481Sgiacomo.travaglini@arm.com output = re.sub(r'\[.* test environment .*\n', '', output) 7113481Sgiacomo.travaglini@arm.com output = re.sub(r'\[=+\] \d+ tests .* ran.*', '', output) 7213481Sgiacomo.travaglini@arm.com output = re.sub(r'.* FAILED TESTS\n', '', output) 7313481Sgiacomo.travaglini@arm.com return output 7413481Sgiacomo.travaglini@arm.com 7513481Sgiacomo.travaglini@arm.com 7613481Sgiacomo.travaglini@arm.comdef RemoveLocations(output): 7713481Sgiacomo.travaglini@arm.com """Removes all file location info from a Google Test program's output. 7813481Sgiacomo.travaglini@arm.com 7913481Sgiacomo.travaglini@arm.com Args: 8013481Sgiacomo.travaglini@arm.com output: the output of a Google Test program. 8113481Sgiacomo.travaglini@arm.com 8213481Sgiacomo.travaglini@arm.com Returns: 8313481Sgiacomo.travaglini@arm.com output with all file location info (in the form of 8413481Sgiacomo.travaglini@arm.com 'DIRECTORY/FILE_NAME:LINE_NUMBER: 'or 8513481Sgiacomo.travaglini@arm.com 'DIRECTORY\\FILE_NAME(LINE_NUMBER): ') replaced by 8613481Sgiacomo.travaglini@arm.com 'FILE:#: '. 8713481Sgiacomo.travaglini@arm.com """ 8813481Sgiacomo.travaglini@arm.com 8913481Sgiacomo.travaglini@arm.com return re.sub(r'.*[/\\](.+)(\:\d+|\(\d+\))\:', 'FILE:#:', output) 9013481Sgiacomo.travaglini@arm.com 9113481Sgiacomo.travaglini@arm.com 9213481Sgiacomo.travaglini@arm.comdef NormalizeErrorMarker(output): 9313481Sgiacomo.travaglini@arm.com """Normalizes the error marker, which is different on Windows vs on Linux.""" 9413481Sgiacomo.travaglini@arm.com 9513481Sgiacomo.travaglini@arm.com return re.sub(r' error: ', ' Failure\n', output) 9613481Sgiacomo.travaglini@arm.com 9713481Sgiacomo.travaglini@arm.com 9813481Sgiacomo.travaglini@arm.comdef RemoveMemoryAddresses(output): 9913481Sgiacomo.travaglini@arm.com """Removes memory addresses from the test output.""" 10013481Sgiacomo.travaglini@arm.com 10113481Sgiacomo.travaglini@arm.com return re.sub(r'@\w+', '@0x#', output) 10213481Sgiacomo.travaglini@arm.com 10313481Sgiacomo.travaglini@arm.com 10413481Sgiacomo.travaglini@arm.comdef RemoveTestNamesOfLeakedMocks(output): 10513481Sgiacomo.travaglini@arm.com """Removes the test names of leaked mock objects from the test output.""" 10613481Sgiacomo.travaglini@arm.com 10713481Sgiacomo.travaglini@arm.com return re.sub(r'\(used in test .+\) ', '', output) 10813481Sgiacomo.travaglini@arm.com 10913481Sgiacomo.travaglini@arm.com 11013481Sgiacomo.travaglini@arm.comdef GetLeakyTests(output): 11113481Sgiacomo.travaglini@arm.com """Returns a list of test names that leak mock objects.""" 11213481Sgiacomo.travaglini@arm.com 11313481Sgiacomo.travaglini@arm.com # findall() returns a list of all matches of the regex in output. 11413481Sgiacomo.travaglini@arm.com # For example, if '(used in test FooTest.Bar)' is in output, the 11513481Sgiacomo.travaglini@arm.com # list will contain 'FooTest.Bar'. 11613481Sgiacomo.travaglini@arm.com return re.findall(r'\(used in test (.+)\)', output) 11713481Sgiacomo.travaglini@arm.com 11813481Sgiacomo.travaglini@arm.com 11913481Sgiacomo.travaglini@arm.comdef GetNormalizedOutputAndLeakyTests(output): 12013481Sgiacomo.travaglini@arm.com """Normalizes the output of gmock_output_test_. 12113481Sgiacomo.travaglini@arm.com 12213481Sgiacomo.travaglini@arm.com Args: 12313481Sgiacomo.travaglini@arm.com output: The test output. 12413481Sgiacomo.travaglini@arm.com 12513481Sgiacomo.travaglini@arm.com Returns: 12613481Sgiacomo.travaglini@arm.com A tuple (the normalized test output, the list of test names that have 12713481Sgiacomo.travaglini@arm.com leaked mocks). 12813481Sgiacomo.travaglini@arm.com """ 12913481Sgiacomo.travaglini@arm.com 13013481Sgiacomo.travaglini@arm.com output = ToUnixLineEnding(output) 13113481Sgiacomo.travaglini@arm.com output = RemoveReportHeaderAndFooter(output) 13213481Sgiacomo.travaglini@arm.com output = NormalizeErrorMarker(output) 13313481Sgiacomo.travaglini@arm.com output = RemoveLocations(output) 13413481Sgiacomo.travaglini@arm.com output = RemoveMemoryAddresses(output) 13513481Sgiacomo.travaglini@arm.com return (RemoveTestNamesOfLeakedMocks(output), GetLeakyTests(output)) 13613481Sgiacomo.travaglini@arm.com 13713481Sgiacomo.travaglini@arm.com 13813481Sgiacomo.travaglini@arm.comdef GetShellCommandOutput(cmd): 13913481Sgiacomo.travaglini@arm.com """Runs a command in a sub-process, and returns its STDOUT in a string.""" 14013481Sgiacomo.travaglini@arm.com 14113481Sgiacomo.travaglini@arm.com return gmock_test_utils.Subprocess(cmd, capture_stderr=False).output 14213481Sgiacomo.travaglini@arm.com 14313481Sgiacomo.travaglini@arm.com 14413481Sgiacomo.travaglini@arm.comdef GetNormalizedCommandOutputAndLeakyTests(cmd): 14513481Sgiacomo.travaglini@arm.com """Runs a command and returns its normalized output and a list of leaky tests. 14613481Sgiacomo.travaglini@arm.com 14713481Sgiacomo.travaglini@arm.com Args: 14813481Sgiacomo.travaglini@arm.com cmd: the shell command. 14913481Sgiacomo.travaglini@arm.com """ 15013481Sgiacomo.travaglini@arm.com 15113481Sgiacomo.travaglini@arm.com # Disables exception pop-ups on Windows. 15213481Sgiacomo.travaglini@arm.com os.environ['GTEST_CATCH_EXCEPTIONS'] = '1' 15313481Sgiacomo.travaglini@arm.com return GetNormalizedOutputAndLeakyTests(GetShellCommandOutput(cmd)) 15413481Sgiacomo.travaglini@arm.com 15513481Sgiacomo.travaglini@arm.com 15613481Sgiacomo.travaglini@arm.comclass GMockOutputTest(gmock_test_utils.TestCase): 15713481Sgiacomo.travaglini@arm.com def testOutput(self): 15813481Sgiacomo.travaglini@arm.com (output, leaky_tests) = GetNormalizedCommandOutputAndLeakyTests(COMMAND) 15913481Sgiacomo.travaglini@arm.com golden_file = open(GOLDEN_PATH, 'rb') 16013481Sgiacomo.travaglini@arm.com golden = golden_file.read() 16113481Sgiacomo.travaglini@arm.com golden_file.close() 16213481Sgiacomo.travaglini@arm.com 16313481Sgiacomo.travaglini@arm.com # The normalized output should match the golden file. 16413481Sgiacomo.travaglini@arm.com self.assertEquals(golden, output) 16513481Sgiacomo.travaglini@arm.com 16613481Sgiacomo.travaglini@arm.com # The raw output should contain 2 leaked mock object errors for 16713481Sgiacomo.travaglini@arm.com # test GMockOutputTest.CatchesLeakedMocks. 16813481Sgiacomo.travaglini@arm.com self.assertEquals(['GMockOutputTest.CatchesLeakedMocks', 16913481Sgiacomo.travaglini@arm.com 'GMockOutputTest.CatchesLeakedMocks'], 17013481Sgiacomo.travaglini@arm.com leaky_tests) 17113481Sgiacomo.travaglini@arm.com 17213481Sgiacomo.travaglini@arm.com 17313481Sgiacomo.travaglini@arm.comif __name__ == '__main__': 17413481Sgiacomo.travaglini@arm.com if sys.argv[1:] == [GENGOLDEN_FLAG]: 17513481Sgiacomo.travaglini@arm.com (output, _) = GetNormalizedCommandOutputAndLeakyTests(COMMAND) 17613481Sgiacomo.travaglini@arm.com golden_file = open(GOLDEN_PATH, 'wb') 17713481Sgiacomo.travaglini@arm.com golden_file.write(output) 17813481Sgiacomo.travaglini@arm.com golden_file.close() 17913481Sgiacomo.travaglini@arm.com else: 18013481Sgiacomo.travaglini@arm.com gmock_test_utils.Main() 181