fatal_test.FatalTests Class Reference

Inheritance diagram for fatal_test.FatalTests:

Public Member Functions
def	setUp (self)
def	run_helper (self, args, kwargs)
def	run_helper_nochecks (self, args, kwargs)
def	is_debug_build (self)
def	get_crash_regex (self, msg=b"test program crashing!", glog=True)
def	test_no_crash (self)
def	test_async (self)
def	test_immediate (self)
def	test_none (self)
def	test_other_category (self)
def	test_static_init (self)
def	test_static_destruction (self)
def	test_fatal_xlog_if (self)
def	test_dfatal_xlog_if (self)
def	test_xcheck (self)
def	test_xcheck_nomsg (self)
def	test_xdcheck (self)

Public Attributes
	helper

Detailed Description

Definition at line 24 of file fatal_test.py.

Member Function Documentation

def fatal_test.FatalTests.get_crash_regex	(		self,
			msg = b"test program crashing!",
			glog = True
	)

Definition at line 74 of file fatal_test.py.

Referenced by fatal_test.FatalTests.test_async(), fatal_test.FatalTests.test_dfatal_xlog_if(), fatal_test.FatalTests.test_fatal_xlog_if(), fatal_test.FatalTests.test_immediate(), fatal_test.FatalTests.test_none(), fatal_test.FatalTests.test_static_init(), fatal_test.FatalTests.test_xcheck(), fatal_test.FatalTests.test_xcheck_nomsg(), and fatal_test.FatalTests.test_xdcheck().

    def get_crash_regex(self, msg=b"test program crashing!", glog=True):
        if glog:
            prefix = br"^F[0-9]{4} .* FatalHelper.cpp:[0-9]+\] "
        else:
            prefix = br"^FATAL:.*FatalHelper.cpp:[0-9]+: "
        regex = prefix + re.escape(msg) + b"$"
        return re.compile(regex, re.MULTILINE)

def fatal_test.FatalTests.is_debug_build

(

self

)

Definition at line 63 of file fatal_test.py.

References EgressStateMachineFixture.fail(), IngressStateMachineFixture.fail(), wangle::LineBasedFrameDecoder.fail(), proxygen::ZlibServerFilter.fail(), folly::AsyncSocket::WriteRequest.fail(), folly::AsyncSocket.fail(), folly.format(), and fatal_test.FatalTests.run_helper_nochecks().

Referenced by fatal_test.FatalTests.test_dfatal_xlog_if(), and fatal_test.FatalTests.test_xdcheck().

    def is_debug_build(self):
        returncode, out, err = self.run_helper_nochecks("--check_debug")
        self.assertEqual(b"", err)
        self.assertEqual(0, returncode)
        if out.strip() == b"DEBUG=1":
            return True
        elif out.strip() == b"DEBUG=0":
            return False
        else:
            self.fail("unexpected output from --check_debug: {}".format(out))

def fatal_test.FatalTests.run_helper	(		self,
			args,
			kwargs
	)

Run the helper and verify it crashes.

Check that it crashes with SIGABRT and prints nothing on stdout.
Returns the data printed to stderr.

Definition at line 35 of file fatal_test.py.

References fatal_test.FatalTests.run_helper_nochecks().

Referenced by fatal_test.FatalTests.test_async(), fatal_test.FatalTests.test_fatal_xlog_if(), fatal_test.FatalTests.test_immediate(), fatal_test.FatalTests.test_none(), fatal_test.FatalTests.test_other_category(), fatal_test.FatalTests.test_static_destruction(), fatal_test.FatalTests.test_static_init(), fatal_test.FatalTests.test_xcheck(), and fatal_test.FatalTests.test_xcheck_nomsg().

    def run_helper(self, *args, **kwargs):
        """Run the helper and verify it crashes.

        Check that it crashes with SIGABRT and prints nothing on stdout.
        Returns the data printed to stderr.
        """
        returncode, out, err = self.run_helper_nochecks(*args, **kwargs)
        self.assertEqual(returncode, -signal.SIGABRT)
        self.assertEqual(out, b"")
        return err

def fatal_test.FatalTests.run_helper_nochecks	(		self,
			args,
			kwargs
	)

Run the helper.

Returns a tuple of [returncode, stdout_output, stderr_output]

Definition at line 46 of file fatal_test.py.

References fatal_test.FatalTests.helper, and bm.list.

Referenced by fatal_test.FatalTests.is_debug_build(), fatal_test.FatalTests.run_helper(), fatal_test.FatalTests.test_dfatal_xlog_if(), fatal_test.FatalTests.test_no_crash(), and fatal_test.FatalTests.test_xdcheck().

    def run_helper_nochecks(self, *args, **kwargs):
        """Run the helper.

        Returns a tuple of [returncode, stdout_output, stderr_output]
        """
        env = kwargs.pop("env", None)
        if kwargs:
            raise TypeError("unexpected keyword arguments: %r" % (list(kwargs.keys())))

        cmd = [self.helper]
        cmd.extend(args)
        p = subprocess.Popen(
            cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env
        )
        out, err = p.communicate()
        return p.returncode, out, err

def fatal_test.FatalTests.setUp

(

self

)

Definition at line 25 of file fatal_test.py.

    def setUp(self):
        fatal_helper_env = os.environ.get("FOLLY_FATAL_HELPER")
        if fatal_helper_env:
            self.helper = fatal_helper_env
        else:
            build_dir = os.path.join(os.getcwd(), "buck-out", "gen")
            self.helper = os.path.join(
                build_dir, "folly", "logging", "test", "fatal_helper"
            )

def fatal_test.FatalTests.test_async

(

self

)

Definition at line 90 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_async(self):
        handler_setings = "default=stream:stream=stderr,async=true"
        err = self.run_helper("--logging=;" + handler_setings)
        self.assertRegex(err, self.get_crash_regex())

def fatal_test.FatalTests.test_dfatal_xlog_if

(

self

)

Definition at line 139 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), fatal_test.FatalTests.is_debug_build(), and fatal_test.FatalTests.run_helper_nochecks().

    def test_dfatal_xlog_if(self):
        returncode, out, err = self.run_helper_nochecks(
            "--fail_dfatal_xlog_if", "--crash=no"
        )
        # The "--fail_dfatal_xlog_if" message should be logged regardless of which build
        # type we are using.  However, in debug builds it will not trigger a crash.
        self.assertRegex(err, self.get_crash_regex(b"--fail_dfatal_xlog_if specified!"))
        self.assertEqual(b"", out)
        if self.is_debug_build():
            self.assertEqual(-signal.SIGABRT, returncode)
        else:
            self.assertEqual(0, returncode)

def fatal_test.FatalTests.test_fatal_xlog_if

(

self

)

Definition at line 133 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_fatal_xlog_if(self):
        # Specify --crash=no to ensure that the XLOG_IF() check is actually what
        # triggers the crash.
        err = self.run_helper("--fail_fatal_xlog_if", "--crash=no")
        self.assertRegex(err, self.get_crash_regex(b"--fail_fatal_xlog_if specified!"))

def fatal_test.FatalTests.test_immediate

(

self

)

Definition at line 95 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_immediate(self):
        handler_setings = "default=stream:stream=stderr,async=false"
        err = self.run_helper("--logging=;" + handler_setings)
        self.assertRegex(err, self.get_crash_regex())

def fatal_test.FatalTests.test_no_crash

(

self

)

Definition at line 82 of file fatal_test.py.

References fatal_test.FatalTests.run_helper_nochecks().

    def test_no_crash(self):
        # Simple sanity check that the program runs without
        # crashing when requested
        returncode, out, err = self.run_helper_nochecks("--crash=no")
        self.assertEqual(0, returncode)
        self.assertEqual(b"", out)
        self.assertEqual(b"", err)

def fatal_test.FatalTests.test_none

(

self

)

Definition at line 100 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_none(self):
        # The fatal message should be printed directly to stderr when there
        # are no logging handlers configured.
        err = self.run_helper("--logging=ERR:")
        self.assertRegex(err, self.get_crash_regex(glog=False))

def fatal_test.FatalTests.test_other_category

(

self

)

Definition at line 106 of file fatal_test.py.

References fatal_test.FatalTests.run_helper().

    def test_other_category(self):
        err = self.run_helper("--category=foo.bar", "--logging", ".=FATAL")
        regex = re.compile(
            br"^F[0-9]{4} .* FatalHelper.cpp:[0-9]+\] "
            br"crashing to category foo\.bar$",
            re.MULTILINE,
        )
        self.assertRegex(err, regex)

def fatal_test.FatalTests.test_static_destruction

(

self

)

Definition at line 120 of file fatal_test.py.

References fatal_test.FatalTests.run_helper().

    def test_static_destruction(self):
        err = self.run_helper("--crash=no", env={"CRASH_DURING_INIT": "shutdown"})
        # When crashing during static destruction we may or may not see a
        # glog-formatted message.  This depends on whether the crashing
        # destructor runs before or after the code that uninstalls the log
        # handlers, and it is valid for that to occur in either order.
        regex = re.compile(
            br"^(FATAL|C[0-9]{4}).*FatalHelper.cpp:.* "
            br"crashing during static destruction$",
            re.MULTILINE,
        )
        self.assertRegex(err, regex)

def fatal_test.FatalTests.test_static_init

(

self

)

Definition at line 115 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_static_init(self):
        err = self.run_helper(env={"CRASH_DURING_INIT": "1"})
        regex = self.get_crash_regex(br"crashing during static initialization")
        self.assertRegex(err, regex)

def fatal_test.FatalTests.test_xcheck

(

self

)

Definition at line 152 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_xcheck(self):
        # Specify --crash=no to ensure that the XCHECK() is actually what triggers the
        # crash.
        err = self.run_helper("--fail_xcheck", "--crash=no")
        self.assertRegex(
            err,
            self.get_crash_regex(
                b"Check failed: !FLAGS_fail_xcheck : --fail_xcheck specified!"
            ),
        )

def fatal_test.FatalTests.test_xcheck_nomsg

(

self

)

Definition at line 163 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), and fatal_test.FatalTests.run_helper().

    def test_xcheck_nomsg(self):
        err = self.run_helper("--fail_xcheck_nomsg", "--crash=no")
        self.assertRegex(
            err, self.get_crash_regex(b"Check failed: !FLAGS_fail_xcheck_nomsg ")
        )

def fatal_test.FatalTests.test_xdcheck

(

self

)

Definition at line 169 of file fatal_test.py.

References fatal_test.FatalTests.get_crash_regex(), fatal_test.FatalTests.is_debug_build(), and fatal_test.FatalTests.run_helper_nochecks().

    def test_xdcheck(self):
        returncode, out, err = self.run_helper_nochecks("--fail_xdcheck", "--crash=no")
        self.assertEqual(b"", out)
        if self.is_debug_build():
            self.assertRegex(
                err,
                self.get_crash_regex(
                    b"Check failed: !FLAGS_fail_xdcheck : --fail_xdcheck specified!"
                ),
            )
            self.assertEqual(-signal.SIGABRT, returncode)
        else:
            self.assertEqual(b"", err)
            self.assertEqual(0, returncode)

Member Data Documentation

fatal_test.FatalTests.helper

Definition at line 28 of file fatal_test.py.

Referenced by fatal_test.FatalTests.run_helper_nochecks().

---

The documentation for this class was generated from the following file:

• proxygen/folly/folly/logging/test/fatal_test.py