3 # Copyright 2009, Google Inc.
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
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
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.
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.
32 """Tests the --help flag of Google C++ Testing Framework.
35 gtest_help_test.py --gtest_build_dir=BUILD/DIR
36 # where BUILD/DIR contains the built gtest_help_test_ file.
40 __author__ = 'wan@google.com (Zhanyong Wan)'
44 import gtest_test_utils
47 IS_WINDOWS = os.name == 'nt'
49 PROGRAM_PATH = gtest_test_utils.GetTestExecutablePath('gtest_help_test_')
50 FLAG_PREFIX = '--gtest_'
51 CATCH_EXCEPTIONS_FLAG = FLAG_PREFIX + 'catch_exceptions'
52 DEATH_TEST_STYLE_FLAG = FLAG_PREFIX + 'death_test_style'
53 UNKNOWN_FLAG = FLAG_PREFIX + 'unknown_flag_for_testing'
54 LIST_TESTS_FLAG = FLAG_PREFIX + 'list_tests'
55 INCORRECT_FLAG_VARIANTS = [re.sub('^--', '-', LIST_TESTS_FLAG),
56 re.sub('^--', '/', LIST_TESTS_FLAG),
57 re.sub('_', '-', LIST_TESTS_FLAG)]
58 INTERNAL_FLAG_FOR_TESTING = FLAG_PREFIX + 'internal_flag_for_testing'
60 SUPPORTS_DEATH_TESTS = "DeathTest" in gtest_test_utils.Subprocess(
61 [PROGRAM_PATH, LIST_TESTS_FLAG]).output
63 # The help message must match this regex.
64 HELP_REGEX = re.compile(
65 FLAG_PREFIX + r'list_tests.*' +
66 FLAG_PREFIX + r'filter=.*' +
67 FLAG_PREFIX + r'also_run_disabled_tests.*' +
68 FLAG_PREFIX + r'repeat=.*' +
69 FLAG_PREFIX + r'shuffle.*' +
70 FLAG_PREFIX + r'random_seed=.*' +
71 FLAG_PREFIX + r'color=.*' +
72 FLAG_PREFIX + r'print_time.*' +
73 FLAG_PREFIX + r'output=.*' +
74 FLAG_PREFIX + r'break_on_failure.*' +
75 FLAG_PREFIX + r'throw_on_failure.*',
79 def RunWithFlag(flag):
80 """Runs gtest_help_test_ with the given flag.
83 the exit code and the text output as a tuple.
85 flag: the command-line flag to pass to gtest_help_test_, or None.
89 command = [PROGRAM_PATH]
91 command = [PROGRAM_PATH, flag]
92 child = gtest_test_utils.Subprocess(command)
93 return child.exit_code, child.output
96 class GTestHelpTest(gtest_test_utils.TestCase):
97 """Tests the --help flag and its equivalent forms."""
99 def TestHelpFlag(self, flag):
100 """Verifies correct behavior when help flag is specified.
102 The right message must be printed and the tests must
103 skipped when the given flag is specified.
106 flag: A flag to pass to the binary or None.
109 exit_code, output = RunWithFlag(flag)
110 self.assertEquals(0, exit_code)
111 self.assert_(HELP_REGEX.search(output), output)
113 self.assert_(CATCH_EXCEPTIONS_FLAG in output, output)
115 self.assert_(CATCH_EXCEPTIONS_FLAG not in output, output)
117 if SUPPORTS_DEATH_TESTS and not IS_WINDOWS:
118 self.assert_(DEATH_TEST_STYLE_FLAG in output, output)
120 self.assert_(DEATH_TEST_STYLE_FLAG not in output, output)
122 def TestNonHelpFlag(self, flag):
123 """Verifies correct behavior when no help flag is specified.
125 Verifies that when no help flag is specified, the tests are run
126 and the help message is not printed.
129 flag: A flag to pass to the binary or None.
132 exit_code, output = RunWithFlag(flag)
133 self.assert_(exit_code != 0)
134 self.assert_(not HELP_REGEX.search(output), output)
136 def testPrintsHelpWithFullFlag(self):
137 self.TestHelpFlag('--help')
139 def testPrintsHelpWithShortFlag(self):
140 self.TestHelpFlag('-h')
142 def testPrintsHelpWithQuestionFlag(self):
143 self.TestHelpFlag('-?')
145 def testPrintsHelpWithWindowsStyleQuestionFlag(self):
146 self.TestHelpFlag('/?')
148 def testPrintsHelpWithUnrecognizedGoogleTestFlag(self):
149 self.TestHelpFlag(UNKNOWN_FLAG)
151 def testPrintsHelpWithIncorrectFlagStyle(self):
152 for incorrect_flag in INCORRECT_FLAG_VARIANTS:
153 self.TestHelpFlag(incorrect_flag)
155 def testRunsTestsWithoutHelpFlag(self):
156 """Verifies that when no help flag is specified, the tests are run
157 and the help message is not printed."""
159 self.TestNonHelpFlag(None)
161 def testRunsTestsWithGtestInternalFlag(self):
162 """Verifies that the tests are run and no help message is printed when
163 a flag starting with Google Test prefix and 'internal_' is supplied."""
165 self.TestNonHelpFlag(INTERNAL_FLAG_FOR_TESTING)
168 if __name__ == '__main__':
169 gtest_test_utils.Main()