#!/usr/bin/env python

#

# Copyright 2010 Google Inc.  All Rights Reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

#

#     * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

#     * Redistributions in binary form must reproduce the above

# copyright notice, this list of conditions and the following disclaimer

# in the documentation and/or other materials provided with the

# distribution.

#     * Neither the name of Google Inc. nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

#

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Tests Google Test's exception catching behavior.

This script invokes gtest_catch_exceptions_test_ and

gtest_catch_exceptions_ex_test_ (programs written with

Google Test) and verifies their output.

"""

__author__ = 'vladl@google.com (Vlad Losev)'

import os

import gtest_test_utils

# Constants.

FLAG_PREFIX = '--gtest_'

LIST_TESTS_FLAG = FLAG_PREFIX + 'list_tests'

NO_CATCH_EXCEPTIONS_FLAG = FLAG_PREFIX + 'catch_exceptions=0'

FILTER_FLAG = FLAG_PREFIX + 'filter'

# Path to the gtest_catch_exceptions_ex_test_ binary, compiled with

# exceptions enabled.

EX_EXE_PATH = gtest_test_utils.GetTestExecutablePath(

    'gtest_catch_exceptions_ex_test_')

# Path to the gtest_catch_exceptions_test_ binary, compiled with

# exceptions disabled.

EXE_PATH = gtest_test_utils.GetTestExecutablePath(

    'gtest_catch_exceptions_no_ex_test_')

environ = gtest_test_utils.environ

SetEnvVar = gtest_test_utils.SetEnvVar

# Tests in this file run a Google-Test-based test program and expect it

# to terminate prematurely.  Therefore they are incompatible with

# the premature-exit-file protocol by design.  Unset the

# premature-exit filepath to prevent Google Test from creating

# the file.

SetEnvVar(gtest_test_utils.PREMATURE_EXIT_FILE_ENV_VAR, None)

TEST_LIST = gtest_test_utils.Subprocess(

    [EXE_PATH, LIST_TESTS_FLAG], env=environ).output

SUPPORTS_SEH_EXCEPTIONS = 'ThrowsSehException' in TEST_LIST

if SUPPORTS_SEH_EXCEPTIONS:

  BINARY_OUTPUT = gtest_test_utils.Subprocess([EXE_PATH], env=environ).output

EX_BINARY_OUTPUT = gtest_test_utils.Subprocess(

    [EX_EXE_PATH], env=environ).output

# The tests.

if SUPPORTS_SEH_EXCEPTIONS:

  # pylint:disable-msg=C6302

  class CatchSehExceptionsTest(gtest_test_utils.TestCase):

    """Tests exception-catching behavior."""

    def TestSehExceptions(self, test_output):

      self.assert_('SEH exception with code 0x2a thrown '

                   'in the test fixture\'s constructor'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown '

                   'in the test fixture\'s destructor'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown in SetUpTestCase()'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown in TearDownTestCase()'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown in SetUp()'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown in TearDown()'

                   in test_output)

      self.assert_('SEH exception with code 0x2a thrown in the test body'

                   in test_output)

    def testCatchesSehExceptionsWithCxxExceptionsEnabled(self):

      self.TestSehExceptions(EX_BINARY_OUTPUT)

    def testCatchesSehExceptionsWithCxxExceptionsDisabled(self):

      self.TestSehExceptions(BINARY_OUTPUT)

class CatchCxxExceptionsTest(gtest_test_utils.TestCase):

  """Tests C++ exception-catching behavior.

     Tests in this test case verify that:

     * C++ exceptions are caught and logged as C++ (not SEH) exceptions

     * Exception thrown affect the remainder of the test work flow in the

       expected manner.

  """

  def testCatchesCxxExceptionsInFixtureConstructor(self):

    self.assert_('C++ exception with description '

                 '"Standard C++ exception" thrown '

                 'in the test fixture\'s constructor'

                 in EX_BINARY_OUTPUT)

    self.assert_('unexpected' not in EX_BINARY_OUTPUT,

                 'This failure belongs in this test only if '

                 '"CxxExceptionInConstructorTest" (no quotes) '

                 'appears on the same line as words "called unexpectedly"')

  if ('CxxExceptionInDestructorTest.ThrowsExceptionInDestructor' in

      EX_BINARY_OUTPUT):

    def testCatchesCxxExceptionsInFixtureDestructor(self):

      self.assert_('C++ exception with description '

                   '"Standard C++ exception" thrown '

                   'in the test fixture\'s destructor'

                   in EX_BINARY_OUTPUT)

      self.assert_('CxxExceptionInDestructorTest::TearDownTestCase() '

                   'called as expected.'

                   in EX_BINARY_OUTPUT)

  def testCatchesCxxExceptionsInSetUpTestCase(self):

    self.assert_('C++ exception with description "Standard C++ exception"'

                 ' thrown in SetUpTestCase()'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInConstructorTest::TearDownTestCase() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTestCaseTest constructor '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTestCaseTest destructor '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTestCaseTest::SetUp() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTestCaseTest::TearDown() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTestCaseTest test body '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

  def testCatchesCxxExceptionsInTearDownTestCase(self):

    self.assert_('C++ exception with description "Standard C++ exception"'

                 ' thrown in TearDownTestCase()'

                 in EX_BINARY_OUTPUT)

  def testCatchesCxxExceptionsInSetUp(self):

    self.assert_('C++ exception with description "Standard C++ exception"'

                 ' thrown in SetUp()'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTest::TearDownTestCase() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTest destructor '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInSetUpTest::TearDown() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('unexpected' not in EX_BINARY_OUTPUT,

                 'This failure belongs in this test only if '

                 '"CxxExceptionInSetUpTest" (no quotes) '

                 'appears on the same line as words "called unexpectedly"')

  def testCatchesCxxExceptionsInTearDown(self):

    self.assert_('C++ exception with description "Standard C++ exception"'

                 ' thrown in TearDown()'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInTearDownTest::TearDownTestCase() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInTearDownTest destructor '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

  def testCatchesCxxExceptionsInTestBody(self):

    self.assert_('C++ exception with description "Standard C++ exception"'

                 ' thrown in the test body'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInTestBodyTest::TearDownTestCase() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInTestBodyTest destructor '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

    self.assert_('CxxExceptionInTestBodyTest::TearDown() '

                 'called as expected.'

                 in EX_BINARY_OUTPUT)

  def testCatchesNonStdCxxExceptions(self):

    self.assert_('Unknown C++ exception thrown in the test body'

                 in EX_BINARY_OUTPUT)

  def testUnhandledCxxExceptionsAbortTheProgram(self):

    # Filters out SEH exception tests on Windows. Unhandled SEH exceptions

    # cause tests to show pop-up windows there.

    FITLER_OUT_SEH_TESTS_FLAG = FILTER_FLAG + '=-*Seh*'

    # By default, Google Test doesn't catch the exceptions.

    uncaught_exceptions_ex_binary_output = gtest_test_utils.Subprocess(

        [EX_EXE_PATH,

         NO_CATCH_EXCEPTIONS_FLAG,

         FITLER_OUT_SEH_TESTS_FLAG],

        env=environ).output

    self.assert_('Unhandled C++ exception terminating the program'

                 in uncaught_exceptions_ex_binary_output)

    self.assert_('unexpected' not in uncaught_exceptions_ex_binary_output)

if __name__ == '__main__':

  gtest_test_utils.Main()