3 # Copyright 2005 Google Inc. All Rights Reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above
12 # copyright notice, this list of conditions and the following disclaimer
13 # in the documentation and/or other materials provided with the
15 # * Neither the name of Google Inc. nor the names of its
16 # contributors may be used to endorse or promote products derived from
17 # this software without specific prior written permission.
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 """Unit test for Google Test test filters.
33 A user can specify which test(s) in a Google Test program to run via either
34 the GTEST_FILTER environment variable or the --gtest_filter flag.
35 This script tests such functionality by invoking
36 googletest-filter-unittest_ (a program written with Google Test) with different
37 environments and command line flags.
39 Note that test sharding may also influence which tests are filtered. Therefore,
40 we test that here also.
47 import gtest_test_utils
51 # Checks if this platform can pass empty environment variables to child
52 # processes. We set an env variable to an empty string and invoke a python
53 # script in a subprocess to print whether the variable is STILL in
54 # os.environ. We then use 'eval' to parse the child's output so that an
55 # exception is thrown if the input is anything other than 'True' nor 'False'.
56 CAN_PASS_EMPTY_ENV = False
58 os.environ['EMPTY_VAR'] = ''
59 child = gtest_test_utils.Subprocess(
60 [sys.executable, '-c', 'import os; print \'EMPTY_VAR\' in os.environ'])
61 CAN_PASS_EMPTY_ENV = eval(child.output)
64 # Check if this platform can unset environment variables in child processes.
65 # We set an env variable to a non-empty string, unset it, and invoke
66 # a python script in a subprocess to print whether the variable
67 # is NO LONGER in os.environ.
68 # We use 'eval' to parse the child's output so that an exception
69 # is thrown if the input is neither 'True' nor 'False'.
72 os.environ['UNSET_VAR'] = 'X'
73 del os.environ['UNSET_VAR']
74 child = gtest_test_utils.Subprocess(
75 [sys.executable, '-c', 'import os; print \'UNSET_VAR\' not in os.environ'
77 CAN_UNSET_ENV = eval(child.output)
80 # Checks if we should test with an empty filter. This doesn't
81 # make sense on platforms that cannot pass empty env variables (Win32)
82 # and on platforms that cannot unset variables (since we cannot tell
83 # the difference between "" and NULL -- Borland and Solaris < 5.10)
84 CAN_TEST_EMPTY_FILTER = (CAN_PASS_EMPTY_ENV and CAN_UNSET_ENV)
87 # The environment variable for specifying the test filters.
88 FILTER_ENV_VAR = 'GTEST_FILTER'
90 # The environment variables for test sharding.
91 TOTAL_SHARDS_ENV_VAR = 'GTEST_TOTAL_SHARDS'
92 SHARD_INDEX_ENV_VAR = 'GTEST_SHARD_INDEX'
93 SHARD_STATUS_FILE_ENV_VAR = 'GTEST_SHARD_STATUS_FILE'
95 # The command line flag for specifying the test filters.
96 FILTER_FLAG = 'gtest_filter'
98 # The command line flag for including disabled tests.
99 ALSO_RUN_DISABLED_TESTS_FLAG = 'gtest_also_run_disabled_tests'
101 # Command to run the googletest-filter-unittest_ program.
102 COMMAND = gtest_test_utils.GetTestExecutablePath('googletest-filter-unittest_')
104 # Regex for determining whether parameterized tests are enabled in the binary.
105 PARAM_TEST_REGEX = re.compile(r'/ParamTest')
107 # Regex for parsing test case names from Google Test's output.
108 TEST_CASE_REGEX = re.compile(r'^\[\-+\] \d+ tests? from (\w+(/\w+)?)')
110 # Regex for parsing test names from Google Test's output.
111 TEST_REGEX = re.compile(r'^\[\s*RUN\s*\].*\.(\w+(/\w+)?)')
113 # The command line flag to tell Google Test to output the list of tests it
115 LIST_TESTS_FLAG = '--gtest_list_tests'
117 # Indicates whether Google Test supports death tests.
118 SUPPORTS_DEATH_TESTS = 'HasDeathTest' in gtest_test_utils.Subprocess(
119 [COMMAND, LIST_TESTS_FLAG]).output
121 # Full names of all tests in googletest-filter-unittests_.
123 'SeqP/ParamTest.TestX/0',
124 'SeqP/ParamTest.TestX/1',
125 'SeqP/ParamTest.TestY/0',
126 'SeqP/ParamTest.TestY/1',
127 'SeqQ/ParamTest.TestX/0',
128 'SeqQ/ParamTest.TestX/1',
129 'SeqQ/ParamTest.TestY/0',
130 'SeqQ/ParamTest.TestY/1',
134 'BarTest.DISABLED_TestFour',
135 'BarTest.DISABLED_TestFive',
136 'BazTest.DISABLED_TestC',
137 'DISABLED_FoobarTest.Test1',
138 'DISABLED_FoobarTest.DISABLED_Test2',
139 'DISABLED_FoobarbazTest.TestA',
142 if SUPPORTS_DEATH_TESTS:
144 'HasDeathTest.Test1',
145 'HasDeathTest.Test2',
150 # All the non-disabled tests.
162 ] + DEATH_TESTS + PARAM_TESTS
164 param_tests_present = None
168 environ = os.environ.copy()
171 def SetEnvVar(env_var, value):
172 """Sets the env variable to 'value'; unsets it when 'value' is None."""
174 if value is not None:
175 environ[env_var] = value
176 elif env_var in environ:
180 def RunAndReturnOutput(args = None):
181 """Runs the test program and returns its output."""
183 return gtest_test_utils.Subprocess([COMMAND] + (args or []),
187 def RunAndExtractTestList(args = None):
188 """Runs the test program and returns its exit code and a list of tests run."""
190 p = gtest_test_utils.Subprocess([COMMAND] + (args or []), env=environ)
194 for line in p.output.split('\n'):
195 match = TEST_CASE_REGEX.match(line)
196 if match is not None:
197 test_case = match.group(1)
199 match = TEST_REGEX.match(line)
200 if match is not None:
201 test = match.group(1)
202 tests_run.append(test_case + '.' + test)
203 return (tests_run, p.exit_code)
206 def InvokeWithModifiedEnv(extra_env, function, *args, **kwargs):
207 """Runs the given function and arguments in a modified environment."""
209 original_env = environ.copy()
210 environ.update(extra_env)
211 return function(*args, **kwargs)
214 environ.update(original_env)
217 def RunWithSharding(total_shards, shard_index, command):
218 """Runs a test program shard and returns exit code and a list of tests run."""
220 extra_env = {SHARD_INDEX_ENV_VAR: str(shard_index),
221 TOTAL_SHARDS_ENV_VAR: str(total_shards)}
222 return InvokeWithModifiedEnv(extra_env, RunAndExtractTestList, command)
227 class GTestFilterUnitTest(gtest_test_utils.TestCase):
228 """Tests the env variable or the command line flag to filter tests."""
232 def AssertSetEqual(self, lhs, rhs):
233 """Asserts that two sets are equal."""
236 self.assert_(elem in rhs, '%s in %s' % (elem, rhs))
239 self.assert_(elem in lhs, '%s in %s' % (elem, lhs))
241 def AssertPartitionIsValid(self, set_var, list_of_sets):
242 """Asserts that list_of_sets is a valid partition of set_var."""
245 for slice_var in list_of_sets:
246 full_partition.extend(slice_var)
247 self.assertEqual(len(set_var), len(full_partition))
248 self.assertEqual(sets.Set(set_var), sets.Set(full_partition))
250 def AdjustForParameterizedTests(self, tests_to_run):
251 """Adjust tests_to_run in case value parameterized tests are disabled."""
253 global param_tests_present
254 if not param_tests_present:
255 return list(sets.Set(tests_to_run) - sets.Set(PARAM_TESTS))
259 def RunAndVerify(self, gtest_filter, tests_to_run):
260 """Checks that the binary runs correct set of tests for a given filter."""
262 tests_to_run = self.AdjustForParameterizedTests(tests_to_run)
264 # First, tests using the environment variable.
266 # Windows removes empty variables from the environment when passing it
267 # to a new process. This means it is impossible to pass an empty filter
268 # into a process using the environment variable. However, we can still
269 # test the case when the variable is not supplied (i.e., gtest_filter is
271 # pylint: disable-msg=C6403
272 if CAN_TEST_EMPTY_FILTER or gtest_filter != '':
273 SetEnvVar(FILTER_ENV_VAR, gtest_filter)
274 tests_run = RunAndExtractTestList()[0]
275 SetEnvVar(FILTER_ENV_VAR, None)
276 self.AssertSetEqual(tests_run, tests_to_run)
277 # pylint: enable-msg=C6403
279 # Next, tests using the command line flag.
281 if gtest_filter is None:
284 args = ['--%s=%s' % (FILTER_FLAG, gtest_filter)]
286 tests_run = RunAndExtractTestList(args)[0]
287 self.AssertSetEqual(tests_run, tests_to_run)
289 def RunAndVerifyWithSharding(self, gtest_filter, total_shards, tests_to_run,
290 args=None, check_exit_0=False):
291 """Checks that binary runs correct tests for the given filter and shard.
293 Runs all shards of googletest-filter-unittest_ with the given filter, and
294 verifies that the right set of tests were run. The union of tests run
295 on each shard should be identical to tests_to_run, without duplicates.
299 gtest_filter: A filter to apply to the tests.
300 total_shards: A total number of shards to split test run into.
301 tests_to_run: A set of tests expected to run.
302 args : Arguments to pass to the to the test binary.
303 check_exit_0: When set to a true value, make sure that all shards
307 tests_to_run = self.AdjustForParameterizedTests(tests_to_run)
309 # Windows removes empty variables from the environment when passing it
310 # to a new process. This means it is impossible to pass an empty filter
311 # into a process using the environment variable. However, we can still
312 # test the case when the variable is not supplied (i.e., gtest_filter is
314 # pylint: disable-msg=C6403
315 if CAN_TEST_EMPTY_FILTER or gtest_filter != '':
316 SetEnvVar(FILTER_ENV_VAR, gtest_filter)
318 for i in range(0, total_shards):
319 (tests_run, exit_code) = RunWithSharding(total_shards, i, args)
321 self.assertEqual(0, exit_code)
322 partition.append(tests_run)
324 self.AssertPartitionIsValid(tests_to_run, partition)
325 SetEnvVar(FILTER_ENV_VAR, None)
326 # pylint: enable-msg=C6403
328 def RunAndVerifyAllowingDisabled(self, gtest_filter, tests_to_run):
329 """Checks that the binary runs correct set of tests for the given filter.
331 Runs googletest-filter-unittest_ with the given filter, and enables
332 disabled tests. Verifies that the right set of tests were run.
335 gtest_filter: A filter to apply to the tests.
336 tests_to_run: A set of tests expected to run.
339 tests_to_run = self.AdjustForParameterizedTests(tests_to_run)
341 # Construct the command line.
342 args = ['--%s' % ALSO_RUN_DISABLED_TESTS_FLAG]
343 if gtest_filter is not None:
344 args.append('--%s=%s' % (FILTER_FLAG, gtest_filter))
346 tests_run = RunAndExtractTestList(args)[0]
347 self.AssertSetEqual(tests_run, tests_to_run)
350 """Sets up test case.
352 Determines whether value-parameterized tests are enabled in the binary and
353 sets the flags accordingly.
356 global param_tests_present
357 if param_tests_present is None:
358 param_tests_present = PARAM_TEST_REGEX.search(
359 RunAndReturnOutput()) is not None
361 def testDefaultBehavior(self):
362 """Tests the behavior of not specifying the filter."""
364 self.RunAndVerify(None, ACTIVE_TESTS)
366 def testDefaultBehaviorWithShards(self):
367 """Tests the behavior without the filter, with sharding enabled."""
369 self.RunAndVerifyWithSharding(None, 1, ACTIVE_TESTS)
370 self.RunAndVerifyWithSharding(None, 2, ACTIVE_TESTS)
371 self.RunAndVerifyWithSharding(None, len(ACTIVE_TESTS) - 1, ACTIVE_TESTS)
372 self.RunAndVerifyWithSharding(None, len(ACTIVE_TESTS), ACTIVE_TESTS)
373 self.RunAndVerifyWithSharding(None, len(ACTIVE_TESTS) + 1, ACTIVE_TESTS)
375 def testEmptyFilter(self):
376 """Tests an empty filter."""
378 self.RunAndVerify('', [])
379 self.RunAndVerifyWithSharding('', 1, [])
380 self.RunAndVerifyWithSharding('', 2, [])
382 def testBadFilter(self):
383 """Tests a filter that matches nothing."""
385 self.RunAndVerify('BadFilter', [])
386 self.RunAndVerifyAllowingDisabled('BadFilter', [])
388 def testFullName(self):
389 """Tests filtering by full name."""
391 self.RunAndVerify('FooTest.Xyz', ['FooTest.Xyz'])
392 self.RunAndVerifyAllowingDisabled('FooTest.Xyz', ['FooTest.Xyz'])
393 self.RunAndVerifyWithSharding('FooTest.Xyz', 5, ['FooTest.Xyz'])
395 def testUniversalFilters(self):
396 """Tests filters that match everything."""
398 self.RunAndVerify('*', ACTIVE_TESTS)
399 self.RunAndVerify('*.*', ACTIVE_TESTS)
400 self.RunAndVerifyWithSharding('*.*', len(ACTIVE_TESTS) - 3, ACTIVE_TESTS)
401 self.RunAndVerifyAllowingDisabled('*', ACTIVE_TESTS + DISABLED_TESTS)
402 self.RunAndVerifyAllowingDisabled('*.*', ACTIVE_TESTS + DISABLED_TESTS)
404 def testFilterByTestCase(self):
405 """Tests filtering by test case name."""
407 self.RunAndVerify('FooTest.*', ['FooTest.Abc', 'FooTest.Xyz'])
409 BAZ_TESTS = ['BazTest.TestOne', 'BazTest.TestA', 'BazTest.TestB']
410 self.RunAndVerify('BazTest.*', BAZ_TESTS)
411 self.RunAndVerifyAllowingDisabled('BazTest.*',
412 BAZ_TESTS + ['BazTest.DISABLED_TestC'])
414 def testFilterByTest(self):
415 """Tests filtering by test name."""
417 self.RunAndVerify('*.TestOne', ['BarTest.TestOne', 'BazTest.TestOne'])
419 def testFilterDisabledTests(self):
420 """Select only the disabled tests to run."""
422 self.RunAndVerify('DISABLED_FoobarTest.Test1', [])
423 self.RunAndVerifyAllowingDisabled('DISABLED_FoobarTest.Test1',
424 ['DISABLED_FoobarTest.Test1'])
426 self.RunAndVerify('*DISABLED_*', [])
427 self.RunAndVerifyAllowingDisabled('*DISABLED_*', DISABLED_TESTS)
429 self.RunAndVerify('*.DISABLED_*', [])
430 self.RunAndVerifyAllowingDisabled('*.DISABLED_*', [
431 'BarTest.DISABLED_TestFour',
432 'BarTest.DISABLED_TestFive',
433 'BazTest.DISABLED_TestC',
434 'DISABLED_FoobarTest.DISABLED_Test2',
437 self.RunAndVerify('DISABLED_*', [])
438 self.RunAndVerifyAllowingDisabled('DISABLED_*', [
439 'DISABLED_FoobarTest.Test1',
440 'DISABLED_FoobarTest.DISABLED_Test2',
441 'DISABLED_FoobarbazTest.TestA',
444 def testWildcardInTestCaseName(self):
445 """Tests using wildcard in the test case name."""
447 self.RunAndVerify('*a*.*', [
454 'BazTest.TestB', ] + DEATH_TESTS + PARAM_TESTS)
456 def testWildcardInTestName(self):
457 """Tests using wildcard in the test name."""
459 self.RunAndVerify('*.*A*', ['FooTest.Abc', 'BazTest.TestA'])
461 def testFilterWithoutDot(self):
462 """Tests a filter that has no '.' in it."""
464 self.RunAndVerify('*z*', [
472 def testTwoPatterns(self):
473 """Tests filters that consist of two patterns."""
475 self.RunAndVerify('Foo*.*:*A*', [
482 # An empty pattern + a non-empty one
483 self.RunAndVerify(':*A*', ['FooTest.Abc', 'BazTest.TestA'])
485 def testThreePatterns(self):
486 """Tests filters that consist of three patterns."""
488 self.RunAndVerify('*oo*:*A*:*One', [
498 # The 2nd pattern is empty.
499 self.RunAndVerify('*oo*::*One', [
508 # The last 2 patterns are empty.
509 self.RunAndVerify('*oo*::', [
514 def testNegativeFilters(self):
515 self.RunAndVerify('*-BazTest.TestOne', [
525 ] + DEATH_TESTS + PARAM_TESTS)
527 self.RunAndVerify('*-FooTest.Abc:BazTest.*', [
533 ] + DEATH_TESTS + PARAM_TESTS)
535 self.RunAndVerify('BarTest.*-BarTest.TestOne', [
540 # Tests without leading '*'.
541 self.RunAndVerify('-FooTest.Abc:FooTest.Xyz:BazTest.*', [
545 ] + DEATH_TESTS + PARAM_TESTS)
547 # Value parameterized tests.
548 self.RunAndVerify('*/*', PARAM_TESTS)
550 # Value parameterized tests filtering by the sequence name.
551 self.RunAndVerify('SeqP/*', [
552 'SeqP/ParamTest.TestX/0',
553 'SeqP/ParamTest.TestX/1',
554 'SeqP/ParamTest.TestY/0',
555 'SeqP/ParamTest.TestY/1',
558 # Value parameterized tests filtering by the test name.
559 self.RunAndVerify('*/0', [
560 'SeqP/ParamTest.TestX/0',
561 'SeqP/ParamTest.TestY/0',
562 'SeqQ/ParamTest.TestX/0',
563 'SeqQ/ParamTest.TestY/0',
566 def testFlagOverridesEnvVar(self):
567 """Tests that the filter flag overrides the filtering env. variable."""
569 SetEnvVar(FILTER_ENV_VAR, 'Foo*')
570 args = ['--%s=%s' % (FILTER_FLAG, '*One')]
571 tests_run = RunAndExtractTestList(args)[0]
572 SetEnvVar(FILTER_ENV_VAR, None)
574 self.AssertSetEqual(tests_run, ['BarTest.TestOne', 'BazTest.TestOne'])
576 def testShardStatusFileIsCreated(self):
577 """Tests that the shard file is created if specified in the environment."""
579 shard_status_file = os.path.join(gtest_test_utils.GetTempDir(),
581 self.assert_(not os.path.exists(shard_status_file))
583 extra_env = {SHARD_STATUS_FILE_ENV_VAR: shard_status_file}
585 InvokeWithModifiedEnv(extra_env, RunAndReturnOutput)
587 self.assert_(os.path.exists(shard_status_file))
588 os.remove(shard_status_file)
590 def testShardStatusFileIsCreatedWithListTests(self):
591 """Tests that the shard file is created with the "list_tests" flag."""
593 shard_status_file = os.path.join(gtest_test_utils.GetTempDir(),
594 'shard_status_file2')
595 self.assert_(not os.path.exists(shard_status_file))
597 extra_env = {SHARD_STATUS_FILE_ENV_VAR: shard_status_file}
599 output = InvokeWithModifiedEnv(extra_env,
603 # This assertion ensures that Google Test enumerated the tests as
604 # opposed to running them.
605 self.assert_('[==========]' not in output,
606 'Unexpected output during test enumeration.\n'
607 'Please ensure that LIST_TESTS_FLAG is assigned the\n'
608 'correct flag value for listing Google Test tests.')
610 self.assert_(os.path.exists(shard_status_file))
611 os.remove(shard_status_file)
613 if SUPPORTS_DEATH_TESTS:
614 def testShardingWorksWithDeathTests(self):
615 """Tests integration with death tests and sharding."""
617 gtest_filter = 'HasDeathTest.*:SeqP/*'
619 'HasDeathTest.Test1',
620 'HasDeathTest.Test2',
622 'SeqP/ParamTest.TestX/0',
623 'SeqP/ParamTest.TestX/1',
624 'SeqP/ParamTest.TestY/0',
625 'SeqP/ParamTest.TestY/1',
628 for flag in ['--gtest_death_test_style=threadsafe',
629 '--gtest_death_test_style=fast']:
630 self.RunAndVerifyWithSharding(gtest_filter, 3, expected_tests,
631 check_exit_0=True, args=[flag])
632 self.RunAndVerifyWithSharding(gtest_filter, 5, expected_tests,
633 check_exit_0=True, args=[flag])
635 if __name__ == '__main__':
636 gtest_test_utils.Main()