googletest/test/googletest-throw-on-failure-test.py

   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 Google Test's throw-on-failure mode with exceptions disabled.
  33
  34 This script invokes googletest-throw-on-failure-test_ (a program written with
  35 Google Test) with different environments and command line flags.
  36 """
  37
  38 import os
  39 from googletest.test import gtest_test_utils
  40
  41
  42 # Constants.
  43
  44 # The command line flag for enabling/disabling the throw-on-failure mode.
  45 THROW_ON_FAILURE = 'gtest_throw_on_failure'
  46
  47 # Path to the googletest-throw-on-failure-test_ program, compiled with
  48 # exceptions disabled.
  49 EXE_PATH = gtest_test_utils.GetTestExecutablePath(
  50     'googletest-throw-on-failure-test_')
  51
  52
  53 # Utilities.
  54
  55
  56 def SetEnvVar(env_var, value):
  57   """Sets an environment variable to a given value; unsets it when the
  58   given value is None.
  59   """
  60
  61   env_var = env_var.upper()
  62   if value is not None:
  63     os.environ[env_var] = value
  64   elif env_var in os.environ:
  65     del os.environ[env_var]
  66
  67
  68 def Run(command):
  69   """Runs a command; returns True/False if its exit code is/isn't 0."""
  70
  71   print('Running "%s". . .' % ' '.join(command))
  72   p = gtest_test_utils.Subprocess(command)
  73   return p.exited and p.exit_code == 0
  74
  75
  76 # The tests.
  77 class ThrowOnFailureTest(gtest_test_utils.TestCase):
  78   """Tests the throw-on-failure mode."""
  79
  80   def RunAndVerify(self, env_var_value, flag_value, should_fail):
  81     """Runs googletest-throw-on-failure-test_ and verifies that it does
  82     (or does not) exit with a non-zero code.
  83
  84     Args:
  85       env_var_value:    value of the GTEST_BREAK_ON_FAILURE environment
  86                         variable; None if the variable should be unset.
  87       flag_value:       value of the --gtest_break_on_failure flag;
  88                         None if the flag should not be present.
  89       should_fail:      True if and only if the program is expected to fail.
  90     """
  91
  92     SetEnvVar(THROW_ON_FAILURE, env_var_value)
  93
  94     if env_var_value is None:
  95       env_var_value_msg = ' is not set'
  96     else:
  97       env_var_value_msg = '=' + env_var_value
  98
  99     if flag_value is None:
 100       flag = ''
 101     elif flag_value == '0':
 102       flag = '--%s=0' % THROW_ON_FAILURE
 103     else:
 104       flag = '--%s' % THROW_ON_FAILURE
 105
 106     command = [EXE_PATH]
 107     if flag:
 108       command.append(flag)
 109
 110     if should_fail:
 111       should_or_not = 'should'
 112     else:
 113       should_or_not = 'should not'
 114
 115     failed = not Run(command)
 116
 117     SetEnvVar(THROW_ON_FAILURE, None)
 118
 119     msg = ('when %s%s, an assertion failure in "%s" %s cause a non-zero '
 120            'exit code.' %
 121            (THROW_ON_FAILURE, env_var_value_msg, ' '.join(command),
 122             should_or_not))
 123     self.assert_(failed == should_fail, msg)
 124
 125   def testDefaultBehavior(self):
 126     """Tests the behavior of the default mode."""
 127
 128     self.RunAndVerify(env_var_value=None, flag_value=None, should_fail=False)
 129
 130   def testThrowOnFailureEnvVar(self):
 131     """Tests using the GTEST_THROW_ON_FAILURE environment variable."""
 132
 133     self.RunAndVerify(env_var_value='0',
 134                       flag_value=None,
 135                       should_fail=False)
 136     self.RunAndVerify(env_var_value='1',
 137                       flag_value=None,
 138                       should_fail=True)
 139
 140   def testThrowOnFailureFlag(self):
 141     """Tests using the --gtest_throw_on_failure flag."""
 142
 143     self.RunAndVerify(env_var_value=None,
 144                       flag_value='0',
 145                       should_fail=False)
 146     self.RunAndVerify(env_var_value=None,
 147                       flag_value='1',
 148                       should_fail=True)
 149
 150   def testThrowOnFailureFlagOverridesEnvVar(self):
 151     """Tests that --gtest_throw_on_failure overrides GTEST_THROW_ON_FAILURE."""
 152
 153     self.RunAndVerify(env_var_value='0',
 154                       flag_value='0',
 155                       should_fail=False)
 156     self.RunAndVerify(env_var_value='0',
 157                       flag_value='1',
 158                       should_fail=True)
 159     self.RunAndVerify(env_var_value='1',
 160                       flag_value='0',
 161                       should_fail=False)
 162     self.RunAndVerify(env_var_value='1',
 163                       flag_value='1',
 164                       should_fail=True)
 165
 166
 167 if __name__ == '__main__':
 168   gtest_test_utils.Main()