1 # Copyright 2006, Google Inc.
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
8 # * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 # * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
14 # * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 """Unit test utilities for Google C++ Testing and Mocking Framework."""
31 # Suppresses the 'Import not at the top of the file' lint complaint.
32 # pylint: disable-msg=C6204
37 IS_WINDOWS = os.name == 'nt'
38 IS_CYGWIN = os.name == 'posix' and 'CYGWIN' in os.uname()[0]
43 import unittest as _test_module
47 _SUBPROCESS_MODULE_AVAILABLE = True
50 _SUBPROCESS_MODULE_AVAILABLE = False
51 # pylint: enable-msg=C6204
53 GTEST_OUTPUT_VAR_NAME = 'GTEST_OUTPUT'
55 # The environment variable for specifying the path to the premature-exit file.
56 PREMATURE_EXIT_FILE_ENV_VAR = 'TEST_PREMATURE_EXIT_FILE'
58 environ = os.environ.copy()
61 def SetEnvVar(env_var, value):
62 """Sets/unsets an environment variable to a given value."""
65 environ[env_var] = value
66 elif env_var in environ:
70 # Here we expose a class from a particular module, depending on the
71 # environment. The comment suppresses the 'Invalid variable name' lint
73 TestCase = _test_module.TestCase # pylint: disable=C6409
75 # Initially maps a flag to its default value. After
76 # _ParseAndStripGTestFlags() is called, maps a flag to its actual value.
77 _flag_map = {'source_dir': os.path.dirname(sys.argv[0]),
78 'build_dir': os.path.dirname(sys.argv[0])}
79 _gtest_flags_are_parsed = False
82 def _ParseAndStripGTestFlags(argv):
83 """Parses and strips Google Test flags from argv. This is idempotent."""
85 # Suppresses the lint complaint about a global variable since we need it
86 # here to maintain module-wide state.
87 global _gtest_flags_are_parsed # pylint: disable=W0603
88 if _gtest_flags_are_parsed:
91 _gtest_flags_are_parsed = True
92 for flag in _flag_map:
93 # The environment variable overrides the default value.
94 if flag.upper() in os.environ:
95 _flag_map[flag] = os.environ[flag.upper()]
97 # The command line flag overrides the environment variable.
98 i = 1 # Skips the program name.
100 prefix = '--' + flag + '='
101 if argv[i].startswith(prefix):
102 _flag_map[flag] = argv[i][len(prefix):]
106 # We don't increment i in case we just found a --gtest_* flag
107 # and removed it from argv.
112 """Returns the value of the given flag."""
114 # In case GetFlag() is called before Main(), we always call
115 # _ParseAndStripGTestFlags() here to make sure the --gtest_* flags
117 _ParseAndStripGTestFlags(sys.argv)
119 return _flag_map[flag]
123 """Returns the absolute path of the directory where the .py files are."""
125 return os.path.abspath(GetFlag('source_dir'))
129 """Returns the absolute path of the directory where the test binaries are."""
131 return os.path.abspath(GetFlag('build_dir'))
136 def _RemoveTempDir():
138 shutil.rmtree(_temp_dir, ignore_errors=True)
140 atexit.register(_RemoveTempDir)
146 _temp_dir = tempfile.mkdtemp()
150 def GetTestExecutablePath(executable_name, build_dir=None):
151 """Returns the absolute path of the test binary given its name.
153 The function will print a message and abort the program if the resulting file
157 executable_name: name of the test binary that the test script runs.
158 build_dir: directory where to look for executables, by default
159 the result of GetBuildDir().
162 The absolute path of the test binary.
165 path = os.path.abspath(os.path.join(build_dir or GetBuildDir(),
167 if (IS_WINDOWS or IS_CYGWIN) and not path.endswith('.exe'):
170 if not os.path.exists(path):
172 'Unable to find the test binary "%s". Please make sure to provide\n'
173 'a path to the binary via the --build_dir flag or the BUILD_DIR\n'
174 'environment variable.' % path)
175 print >> sys.stderr, message
181 def GetExitStatus(exit_code):
182 """Returns the argument to exit(), or -1 if exit() wasn't called.
185 exit_code: the result value of os.system(command).
189 # On Windows, os.WEXITSTATUS() doesn't work and os.system() returns
190 # the argument to exit() directly.
193 # On Unix, os.WEXITSTATUS() must be used to extract the exit status
194 # from the result of os.system().
195 if os.WIFEXITED(exit_code):
196 return os.WEXITSTATUS(exit_code)
202 def __init__(self, command, working_dir=None, capture_stderr=True, env=None):
203 """Changes into a specified directory, if provided, and executes a command.
205 Restores the old directory afterwards.
208 command: The command to run, in the form of sys.argv.
209 working_dir: The directory to change into.
210 capture_stderr: Determines whether to capture stderr in the output member
212 env: Dictionary with environment to pass to the subprocess.
215 An object that represents outcome of the executed process. It has the
216 following attributes:
217 terminated_by_signal True iff the child process has been terminated
219 signal Sygnal that terminated the child process.
220 exited True iff the child process exited normally.
221 exit_code The code with which the child process exited.
222 output Child process's stdout and stderr output
223 combined in a string.
226 # The subprocess module is the preferrable way of running programs
227 # since it is available and behaves consistently on all platforms,
228 # including Windows. But it is only available starting in python 2.4.
229 # In earlier python versions, we revert to the popen2 module, which is
230 # available in python 2.0 and later but doesn't provide required
231 # functionality (Popen4) under Windows. This allows us to support Mac
232 # OS X 10.4 Tiger, which has python 2.3 installed.
233 if _SUBPROCESS_MODULE_AVAILABLE:
235 stderr = subprocess.STDOUT
237 stderr = subprocess.PIPE
239 p = subprocess.Popen(command,
240 stdout=subprocess.PIPE, stderr=stderr,
241 cwd=working_dir, universal_newlines=True, env=env)
242 # communicate returns a tuple with the file object for the child's
244 self.output = p.communicate()[0]
245 self._return_code = p.returncode
247 old_dir = os.getcwd()
249 def _ReplaceEnvDict(dest, src):
250 # Changes made by os.environ.clear are not inheritable by child
251 # processes until Python 2.6. To produce inheritable changes we have
252 # to delete environment items with the del statement.
253 for key in dest.keys():
257 # When 'env' is not None, backup the environment variables and replace
258 # them with the passed 'env'. When 'env' is None, we simply use the
259 # current 'os.environ' for compatibility with the subprocess.Popen
260 # semantics used above.
262 old_environ = os.environ.copy()
263 _ReplaceEnvDict(os.environ, env)
266 if working_dir is not None:
267 os.chdir(working_dir)
269 p = popen2.Popen4(command)
271 p = popen2.Popen3(command)
273 self.output = p.fromchild.read()
278 # Restore the old environment variables
279 # if they were replaced.
281 _ReplaceEnvDict(os.environ, old_environ)
283 # Converts ret_code to match the semantics of
284 # subprocess.Popen.returncode.
285 if os.WIFSIGNALED(ret_code):
286 self._return_code = -os.WTERMSIG(ret_code)
287 else: # os.WIFEXITED(ret_code) should return True here.
288 self._return_code = os.WEXITSTATUS(ret_code)
290 if self._return_code < 0:
291 self.terminated_by_signal = True
293 self.signal = -self._return_code
295 self.terminated_by_signal = False
297 self.exit_code = self._return_code
301 """Runs the unit test."""
303 # We must call _ParseAndStripGTestFlags() before calling
304 # unittest.main(). Otherwise the latter will be confused by the
306 _ParseAndStripGTestFlags(sys.argv)
307 # The tested binaries should not be writing XML output files unless the
308 # script explicitly instructs them to.
309 # FIXME: Move this into Subprocess when we implement
310 # passing environment into it as a parameter.
311 if GTEST_OUTPUT_VAR_NAME in os.environ:
312 del os.environ[GTEST_OUTPUT_VAR_NAME]