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