gtest_test_utils Namespace Reference

Classes
class	Subprocess

Functions
def	SetEnvVar (env_var, value)
def	GetFlag (flag)
def	GetSourceDir ()
def	GetBuildDir ()
def	GetTempDir ()
def	GetTestExecutablePath (executable_name, build_dir=None)
def	GetExitStatus (exit_code)
def	Main ()

Variables
string	IS_WINDOWS = 'nt'
string	IS_CYGWIN = 'posix' and 'CYGWIN' in os.uname()[0]
string	IS_OS2 = 'os2'
string	GTEST_OUTPUT_VAR_NAME = 'GTEST_OUTPUT'
string	PREMATURE_EXIT_FILE_ENV_VAR = 'TEST_PREMATURE_EXIT_FILE'
	environ = os.environ.copy()
	TestCase = _test_module.TestCase

Function Documentation

GetBuildDir()

def gtest_test_utils.GetBuildDir

(

)

Returns the absolute path of the directory where the test binaries are.

Definition at line 129 of file gtest_test_utils.py.

def GetBuildDir():
  """Returns the absolute path of the directory where the test binaries are."""
 
  return os.path.abspath(GetFlag('build_dir'))
 
 

GetExitStatus()

def gtest_test_utils.GetExitStatus

(

exit_code

)

Returns the argument to exit(), or -1 if exit() wasn't called.

Args:
  exit_code: the result value of os.system(command).

Definition at line 182 of file gtest_test_utils.py.

def GetExitStatus(exit_code):
  """Returns the argument to exit(), or -1 if exit() wasn't called.
 
  Args:
    exit_code: the result value of os.system(command).
  """
 
  if os.name == 'nt':
    # On Windows, os.WEXITSTATUS() doesn't work and os.system() returns
    # the argument to exit() directly.
    return exit_code
  else:
    # On Unix, os.WEXITSTATUS() must be used to extract the exit status
    # from the result of os.system().
    if os.WIFEXITED(exit_code):
      return os.WEXITSTATUS(exit_code)
    else:
      return -1
 
 

GetFlag()

def gtest_test_utils.GetFlag

(

flag

)

Returns the value of the given flag.

Definition at line 112 of file gtest_test_utils.py.

def GetFlag(flag):
  """Returns the value of the given flag."""
 
  # In case GetFlag() is called before Main(), we always call
  # _ParseAndStripGTestFlags() here to make sure the --gtest_* flags
  # are parsed.
  _ParseAndStripGTestFlags(sys.argv)
 
  return _flag_map[flag]
 
 

GetSourceDir()

def gtest_test_utils.GetSourceDir

(

)

Returns the absolute path of the directory where the .py files are.

Definition at line 123 of file gtest_test_utils.py.

def GetSourceDir():
  """Returns the absolute path of the directory where the .py files are."""
 
  return os.path.abspath(GetFlag('source_dir'))
 
 

GetTempDir()

def gtest_test_utils.GetTempDir

(

)

Definition at line 144 of file gtest_test_utils.py.

def GetTempDir():
  global _temp_dir
  if not _temp_dir:
    _temp_dir = tempfile.mkdtemp()
  return _temp_dir
 
 

GetTestExecutablePath()

def gtest_test_utils.GetTestExecutablePath	(		executable_name,
			build_dir = None
	)

Returns the absolute path of the test binary given its name.

The function will print a message and abort the program if the resulting file
doesn't exist.

Args:
  executable_name: name of the test binary that the test script runs.
  build_dir:       directory where to look for executables, by default
                   the result of GetBuildDir().

Returns:
  The absolute path of the test binary.

Definition at line 151 of file gtest_test_utils.py.

def GetTestExecutablePath(executable_name, build_dir=None):
  """Returns the absolute path of the test binary given its name.
 
  The function will print a message and abort the program if the resulting file
  doesn't exist.
 
  Args:
    executable_name: name of the test binary that the test script runs.
    build_dir:       directory where to look for executables, by default
                     the result of GetBuildDir().
 
  Returns:
    The absolute path of the test binary.
  """
 
  path = os.path.abspath(os.path.join(build_dir or GetBuildDir(),
                                      executable_name))
  if (IS_WINDOWS or IS_CYGWIN or IS_OS2) and not path.endswith('.exe'):
    path += '.exe'
 
  if not os.path.exists(path):
    message = (
        'Unable to find the test binary "%s". Please make sure to provide\n'
        'a path to the binary via the --build_dir flag or the BUILD_DIR\n'
        'environment variable.' % path)
    print >> sys.stderr, message
    sys.exit(1)
 
  return path
 
 

Main()

def gtest_test_utils.Main

(

)

Runs the unit test.

Definition at line 300 of file gtest_test_utils.py.

def Main():
  """Runs the unit test."""
 
  # We must call _ParseAndStripGTestFlags() before calling
  # unittest.main().  Otherwise the latter will be confused by the
  # --gtest_* flags.
  _ParseAndStripGTestFlags(sys.argv)
  # The tested binaries should not be writing XML output files unless the
  # script explicitly instructs them to.
  if GTEST_OUTPUT_VAR_NAME in os.environ:
    del os.environ[GTEST_OUTPUT_VAR_NAME]
 
  _test_module.main()

SetEnvVar()

def gtest_test_utils.SetEnvVar	(		env_var,
			value
	)

Sets/unsets an environment variable to a given value.

Definition at line 62 of file gtest_test_utils.py.

def SetEnvVar(env_var, value):
  """Sets/unsets an environment variable to a given value."""
 
  if value is not None:
    environ[env_var] = value
  elif env_var in environ:
    del environ[env_var]
 
 
# Here we expose a class from a particular module, depending on the
# environment. The comment suppresses the 'Invalid variable name' lint
# complaint.

Variable Documentation

environ

gtest_test_utils.environ = os.environ.copy()

Definition at line 59 of file gtest_test_utils.py.

GTEST_OUTPUT_VAR_NAME

string gtest_test_utils.GTEST_OUTPUT_VAR_NAME = 'GTEST_OUTPUT'

Definition at line 54 of file gtest_test_utils.py.

IS_CYGWIN

string gtest_test_utils.IS_CYGWIN = 'posix' and 'CYGWIN' in os.uname()[0]

Definition at line 38 of file gtest_test_utils.py.

IS_OS2

string gtest_test_utils.IS_OS2 = 'os2'

Definition at line 39 of file gtest_test_utils.py.

IS_WINDOWS

string gtest_test_utils.IS_WINDOWS = 'nt'

Definition at line 37 of file gtest_test_utils.py.

PREMATURE_EXIT_FILE_ENV_VAR

string gtest_test_utils.PREMATURE_EXIT_FILE_ENV_VAR = 'TEST_PREMATURE_EXIT_FILE'

Definition at line 57 of file gtest_test_utils.py.

TestCase

gtest_test_utils.TestCase = _test_module.TestCase

Definition at line 74 of file gtest_test_utils.py.