[#BloombergLP-bsls-AssertTest]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::AssertTest
:relfileprefix: ../../
:mrdocs:

Utility providing methods for negative testing of assertion macros.

== Synopsis

Declared in `<bsls_asserttest.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct AssertTest;
----

== Description

This utility `struct` provides a suite of methods designed for use in conjunction with preprocessor macros during the negative testing of defensive checks using the facilities provided by the `bsls_assert` component. Unlike usual BDE functionality methods in this `struct` provide wide contracts because they need to function without assertion failures during testing, under unforeseen circumstances.

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AssertTest/catchProbe.adoc[`catchProbe`] 
| Return whether a caught assertion failure matches the expected probe.
| xref:BloombergLP/bsls/AssertTest/catchProbeRaw.adoc[`catchProbeRaw`] 
| Return whether a caught assertion matches a raw failure probe.
| xref:BloombergLP/bsls/AssertTest/failTestDriver.adoc[`failTestDriver`]  [.small]#[noreturn]#
| Throw or abort in response to an assertion violation.
| xref:BloombergLP/bsls/AssertTest/failTestDriverByReview.adoc[`failTestDriverByReview`] 
| Throw or abort in response to a review violation.
| xref:BloombergLP/bsls/AssertTest/isValidAssertBuild.adoc[`isValidAssertBuild`] 
| Return whether `specString` is a valid assertion build‐type specifier.
| xref:BloombergLP/bsls/AssertTest/isValidExpected.adoc[`isValidExpected`] 
| Return whether `specChar` is a valid expected‐result specifier.
| xref:BloombergLP/bsls/AssertTest/isValidExpectedLevel.adoc[`isValidExpectedLevel`] 
| Return whether `specChar` is a valid expected assertion level.
| xref:BloombergLP/bsls/AssertTest/tryProbe.adoc[`tryProbe`] 
| Return whether a pass‐probe specification is valid.
| xref:BloombergLP/bsls/AssertTest/tryProbeRaw.adoc[`tryProbeRaw`] 
| Return whether a raw pass‐probe specification is valid.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#