]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | #!/usr/bin/env python |
2 | # | |
3 | # Copyright 2009, 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 | ||
9f95a23c | 32 | """Tests the --help flag of Google C++ Testing and Mocking Framework. |
7c673cae FG |
33 | |
34 | SYNOPSIS | |
35 | gtest_help_test.py --build_dir=BUILD/DIR | |
36 | # where BUILD/DIR contains the built gtest_help_test_ file. | |
37 | gtest_help_test.py | |
38 | """ | |
39 | ||
7c673cae FG |
40 | import os |
41 | import re | |
42 | import gtest_test_utils | |
43 | ||
44 | ||
45 | IS_LINUX = os.name == 'posix' and os.uname()[0] == 'Linux' | |
46 | IS_WINDOWS = os.name == 'nt' | |
47 | ||
48 | PROGRAM_PATH = gtest_test_utils.GetTestExecutablePath('gtest_help_test_') | |
49 | FLAG_PREFIX = '--gtest_' | |
50 | DEATH_TEST_STYLE_FLAG = FLAG_PREFIX + 'death_test_style' | |
51 | STREAM_RESULT_TO_FLAG = FLAG_PREFIX + 'stream_result_to' | |
52 | UNKNOWN_FLAG = FLAG_PREFIX + 'unknown_flag_for_testing' | |
53 | LIST_TESTS_FLAG = FLAG_PREFIX + 'list_tests' | |
54 | INCORRECT_FLAG_VARIANTS = [re.sub('^--', '-', LIST_TESTS_FLAG), | |
55 | re.sub('^--', '/', LIST_TESTS_FLAG), | |
56 | re.sub('_', '-', LIST_TESTS_FLAG)] | |
57 | INTERNAL_FLAG_FOR_TESTING = FLAG_PREFIX + 'internal_flag_for_testing' | |
58 | ||
59 | SUPPORTS_DEATH_TESTS = "DeathTest" in gtest_test_utils.Subprocess( | |
60 | [PROGRAM_PATH, LIST_TESTS_FLAG]).output | |
61 | ||
62 | # The help message must match this regex. | |
63 | HELP_REGEX = re.compile( | |
64 | FLAG_PREFIX + r'list_tests.*' + | |
65 | FLAG_PREFIX + r'filter=.*' + | |
66 | FLAG_PREFIX + r'also_run_disabled_tests.*' + | |
67 | FLAG_PREFIX + r'repeat=.*' + | |
68 | FLAG_PREFIX + r'shuffle.*' + | |
69 | FLAG_PREFIX + r'random_seed=.*' + | |
70 | FLAG_PREFIX + r'color=.*' + | |
71 | FLAG_PREFIX + r'print_time.*' + | |
72 | FLAG_PREFIX + r'output=.*' + | |
73 | FLAG_PREFIX + r'break_on_failure.*' + | |
74 | FLAG_PREFIX + r'throw_on_failure.*' + | |
75 | FLAG_PREFIX + r'catch_exceptions=0.*', | |
76 | re.DOTALL) | |
77 | ||
78 | ||
79 | def RunWithFlag(flag): | |
80 | """Runs gtest_help_test_ with the given flag. | |
81 | ||
82 | Returns: | |
83 | the exit code and the text output as a tuple. | |
84 | Args: | |
85 | flag: the command-line flag to pass to gtest_help_test_, or None. | |
86 | """ | |
87 | ||
88 | if flag is None: | |
89 | command = [PROGRAM_PATH] | |
90 | else: | |
91 | command = [PROGRAM_PATH, flag] | |
92 | child = gtest_test_utils.Subprocess(command) | |
93 | return child.exit_code, child.output | |
94 | ||
95 | ||
96 | class GTestHelpTest(gtest_test_utils.TestCase): | |
97 | """Tests the --help flag and its equivalent forms.""" | |
98 | ||
99 | def TestHelpFlag(self, flag): | |
100 | """Verifies correct behavior when help flag is specified. | |
101 | ||
102 | The right message must be printed and the tests must | |
103 | skipped when the given flag is specified. | |
104 | ||
105 | Args: | |
106 | flag: A flag to pass to the binary or None. | |
107 | """ | |
108 | ||
109 | exit_code, output = RunWithFlag(flag) | |
110 | self.assertEquals(0, exit_code) | |
111 | self.assert_(HELP_REGEX.search(output), output) | |
112 | ||
113 | if IS_LINUX: | |
114 | self.assert_(STREAM_RESULT_TO_FLAG in output, output) | |
115 | else: | |
116 | self.assert_(STREAM_RESULT_TO_FLAG not in output, output) | |
117 | ||
118 | if SUPPORTS_DEATH_TESTS and not IS_WINDOWS: | |
119 | self.assert_(DEATH_TEST_STYLE_FLAG in output, output) | |
120 | else: | |
121 | self.assert_(DEATH_TEST_STYLE_FLAG not in output, output) | |
122 | ||
123 | def TestNonHelpFlag(self, flag): | |
124 | """Verifies correct behavior when no help flag is specified. | |
125 | ||
126 | Verifies that when no help flag is specified, the tests are run | |
127 | and the help message is not printed. | |
128 | ||
129 | Args: | |
130 | flag: A flag to pass to the binary or None. | |
131 | """ | |
132 | ||
133 | exit_code, output = RunWithFlag(flag) | |
134 | self.assert_(exit_code != 0) | |
135 | self.assert_(not HELP_REGEX.search(output), output) | |
136 | ||
137 | def testPrintsHelpWithFullFlag(self): | |
138 | self.TestHelpFlag('--help') | |
139 | ||
140 | def testPrintsHelpWithShortFlag(self): | |
141 | self.TestHelpFlag('-h') | |
142 | ||
143 | def testPrintsHelpWithQuestionFlag(self): | |
144 | self.TestHelpFlag('-?') | |
145 | ||
146 | def testPrintsHelpWithWindowsStyleQuestionFlag(self): | |
147 | self.TestHelpFlag('/?') | |
148 | ||
149 | def testPrintsHelpWithUnrecognizedGoogleTestFlag(self): | |
150 | self.TestHelpFlag(UNKNOWN_FLAG) | |
151 | ||
152 | def testPrintsHelpWithIncorrectFlagStyle(self): | |
153 | for incorrect_flag in INCORRECT_FLAG_VARIANTS: | |
154 | self.TestHelpFlag(incorrect_flag) | |
155 | ||
156 | def testRunsTestsWithoutHelpFlag(self): | |
157 | """Verifies that when no help flag is specified, the tests are run | |
158 | and the help message is not printed.""" | |
159 | ||
160 | self.TestNonHelpFlag(None) | |
161 | ||
162 | def testRunsTestsWithGtestInternalFlag(self): | |
163 | """Verifies that the tests are run and no help message is printed when | |
164 | a flag starting with Google Test prefix and 'internal_' is supplied.""" | |
165 | ||
166 | self.TestNonHelpFlag(INTERNAL_FLAG_FOR_TESTING) | |
167 | ||
168 | ||
169 | if __name__ == '__main__': | |
170 | gtest_test_utils.Main() |