174c8f0bfa61561884552b4708a885cefb9917c3azhanyong.wan#!/usr/bin/env python 2baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# 3baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# Copyright 2009, Google Inc. 4baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# All rights reserved. 5baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# 6baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# Redistribution and use in source and binary forms, with or without 7baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# modification, are permitted provided that the following conditions are 8baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# met: 9baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# 10baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# * Redistributions of source code must retain the above copyright 11baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# notice, this list of conditions and the following disclaimer. 12baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# * Redistributions in binary form must reproduce the above 13baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# copyright notice, this list of conditions and the following disclaimer 14baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# in the documentation and/or other materials provided with the 15baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# distribution. 16baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# * Neither the name of Google Inc. nor the names of its 17baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# contributors may be used to endorse or promote products derived from 18baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# this software without specific prior written permission. 19baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# 20baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 32baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan"""Tests the --help flag of Google C++ Testing Framework. 33baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 34baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanSYNOPSIS 35362a0cf9aff37610628d15037bf794a2e54de78dvladlosev gtest_help_test.py --build_dir=BUILD/DIR 36baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan # where BUILD/DIR contains the built gtest_help_test_ file. 37baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan gtest_help_test.py 38baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan""" 39baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 40baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan__author__ = 'wan@google.com (Zhanyong Wan)' 41baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 42baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanimport os 43baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanimport re 446d63ee6720540cadb8919037c5d41a6413cc9101zhanyong.wanimport gtest_test_utils 45baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 46baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 47c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wanIS_LINUX = os.name == 'posix' and os.uname()[0] == 'Linux' 48baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanIS_WINDOWS = os.name == 'nt' 49baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 50767998dfadaf87c1193d51cf5847a7f147c6e1f7zhanyong.wanPROGRAM_PATH = gtest_test_utils.GetTestExecutablePath('gtest_help_test_') 51baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanFLAG_PREFIX = '--gtest_' 52a49bf25b24dd239a9da88e783f037d817a6287b0zhanyong.wanDEATH_TEST_STYLE_FLAG = FLAG_PREFIX + 'death_test_style' 53c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wanSTREAM_RESULT_TO_FLAG = FLAG_PREFIX + 'stream_result_to' 548cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosevUNKNOWN_FLAG = FLAG_PREFIX + 'unknown_flag_for_testing' 55a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosevLIST_TESTS_FLAG = FLAG_PREFIX + 'list_tests' 56a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosevINCORRECT_FLAG_VARIANTS = [re.sub('^--', '-', LIST_TESTS_FLAG), 57a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev re.sub('^--', '/', LIST_TESTS_FLAG), 58a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev re.sub('_', '-', LIST_TESTS_FLAG)] 598cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosevINTERNAL_FLAG_FOR_TESTING = FLAG_PREFIX + 'internal_flag_for_testing' 60baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 61a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosevSUPPORTS_DEATH_TESTS = "DeathTest" in gtest_test_utils.Subprocess( 62a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev [PROGRAM_PATH, LIST_TESTS_FLAG]).output 63a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev 64baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan# The help message must match this regex. 65baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanHELP_REGEX = re.compile( 66baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'list_tests.*' + 67baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'filter=.*' + 68baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'also_run_disabled_tests.*' + 69baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'repeat=.*' + 709b9794ffb9cfafb94f5def851f76b9a104fcb891zhanyong.wan FLAG_PREFIX + r'shuffle.*' + 719b9794ffb9cfafb94f5def851f76b9a104fcb891zhanyong.wan FLAG_PREFIX + r'random_seed=.*' + 72baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'color=.*' + 73baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'print_time.*' + 74baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'output=.*' + 75baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan FLAG_PREFIX + r'break_on_failure.*' + 76c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wan FLAG_PREFIX + r'throw_on_failure.*' + 77480f1c2878a043af55c5adfc4ed82a6b8a2aae03vladlosev FLAG_PREFIX + r'catch_exceptions=0.*', 78baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan re.DOTALL) 79baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 80baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 81baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wandef RunWithFlag(flag): 82baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan """Runs gtest_help_test_ with the given flag. 83baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 84baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan Returns: 85baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan the exit code and the text output as a tuple. 86baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan Args: 87baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan flag: the command-line flag to pass to gtest_help_test_, or None. 88baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan """ 89baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 90baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan if flag is None: 91baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan command = [PROGRAM_PATH] 92baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan else: 93baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan command = [PROGRAM_PATH, flag] 94baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan child = gtest_test_utils.Subprocess(command) 95baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan return child.exit_code, child.output 96baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 97baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 986d63ee6720540cadb8919037c5d41a6413cc9101zhanyong.wanclass GTestHelpTest(gtest_test_utils.TestCase): 99baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan """Tests the --help flag and its equivalent forms.""" 100baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 101baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def TestHelpFlag(self, flag): 1028cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev """Verifies correct behavior when help flag is specified. 1038cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1048cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev The right message must be printed and the tests must 1058cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev skipped when the given flag is specified. 1068cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1078cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev Args: 1088cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev flag: A flag to pass to the binary or None. 1098cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev """ 110baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 111baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan exit_code, output = RunWithFlag(flag) 112baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.assertEquals(0, exit_code) 113baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.assert_(HELP_REGEX.search(output), output) 114c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wan 115c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wan if IS_LINUX: 116c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wan self.assert_(STREAM_RESULT_TO_FLAG in output, output) 117baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan else: 118c95489ee7dd54fc6a2cd1d3e890c330718ead714zhanyong.wan self.assert_(STREAM_RESULT_TO_FLAG not in output, output) 119a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev 120a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev if SUPPORTS_DEATH_TESTS and not IS_WINDOWS: 121a49bf25b24dd239a9da88e783f037d817a6287b0zhanyong.wan self.assert_(DEATH_TEST_STYLE_FLAG in output, output) 122a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev else: 123a232a5cee9c506514ba88d551aa4c0a11d2f3c4bvladlosev self.assert_(DEATH_TEST_STYLE_FLAG not in output, output) 124baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 1258cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev def TestNonHelpFlag(self, flag): 1268cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev """Verifies correct behavior when no help flag is specified. 1278cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1288cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev Verifies that when no help flag is specified, the tests are run 1298cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev and the help message is not printed. 1308cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1318cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev Args: 1328cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev flag: A flag to pass to the binary or None. 1338cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev """ 1348cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1358cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev exit_code, output = RunWithFlag(flag) 1368cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.assert_(exit_code != 0) 1378cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.assert_(not HELP_REGEX.search(output), output) 1388cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 139baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def testPrintsHelpWithFullFlag(self): 140baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.TestHelpFlag('--help') 141baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 142baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def testPrintsHelpWithShortFlag(self): 143baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.TestHelpFlag('-h') 144baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 145baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def testPrintsHelpWithQuestionFlag(self): 146baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.TestHelpFlag('-?') 147baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 148baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def testPrintsHelpWithWindowsStyleQuestionFlag(self): 149baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan self.TestHelpFlag('/?') 150baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 1518cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev def testPrintsHelpWithUnrecognizedGoogleTestFlag(self): 1528cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.TestHelpFlag(UNKNOWN_FLAG) 1538cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1548cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev def testPrintsHelpWithIncorrectFlagStyle(self): 1558cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev for incorrect_flag in INCORRECT_FLAG_VARIANTS: 1568cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.TestHelpFlag(incorrect_flag) 1578cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 158baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan def testRunsTestsWithoutHelpFlag(self): 159baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan """Verifies that when no help flag is specified, the tests are run 160baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan and the help message is not printed.""" 161baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 1628cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.TestNonHelpFlag(None) 1638cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1648cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev def testRunsTestsWithGtestInternalFlag(self): 1658cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev """Verifies that the tests are run and no help message is printed when 1668cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev a flag starting with Google Test prefix and 'internal_' is supplied.""" 1678cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev 1688cfe730f74068ec8b90ba6a8885019bbe5fe6b13vladlosev self.TestNonHelpFlag(INTERNAL_FLAG_FOR_TESTING) 169baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 170baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan 171baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wanif __name__ == '__main__': 172baa766af2a71363fb1ccf8de5de444c4a88f0e61zhanyong.wan gtest_test_utils.Main() 173