bsls_fuzztest_testutil.h

Go to the documentation of this file.

/// @file bsls_fuzztest_testutil.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bsls_fuzztest_testutil.h                                           -*-C++-*-
#ifndef INCLUDED_BSLS_FUZZTEST_TESTUTIL
#define INCLUDED_BSLS_FUZZTEST_TESTUTIL
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bsls_fuzztest_testutil bsls_fuzztest_testutil
/// @brief  Provide utilities for `bsls_fuzztest` component.
/// @addtogroup bsl
/// @{
/// @addtogroup bsls
/// @{
/// @addtogroup bsls_fuzztest_testutil
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bsls_fuzztest_testutil-purpose"> Purpose</a>
/// * <a href="#bsls_fuzztest_testutil-description"> Description </a>
///   * <a href="#bsls_fuzztest_testutil-usage"> Usage </a>
///     * <a href="#bsls_fuzztest_testutil-example-basic-usage-of-functions"> Example: Basic Usage of Functions </a>
///
/// # Purpose {#bsls_fuzztest_testutil-purpose}
/// Provide utilities for @ref bsls_fuzztest  component.
///
/// # Description {#bsls_fuzztest_testutil-description}
/// The @ref bsls_fuzztest_testutil  component provides utilities to
/// facilitate testing the @ref bsls_fuzztest  component.
///
/// ## Usage {#bsls_fuzztest_testutil-usage}
///
///
/// This section illustrates intended use of this component.
///
/// ### Example: Basic Usage of Functions {#bsls_fuzztest_testutil-example-basic-usage-of-functions}
///
///
/// First, we install an `AssertTestHandlerGuard` to catch the violation.
/// @code
///  bsls::AssertTestHandlerGuard g;
/// @endcode
/// Then, we trigger an `AssertViolation` by calling `triggerAssert` inside
/// `ASSERT_FAIL` and verify that a violation occurs as expected.
/// @code
///  ASSERT_FAIL(bsls::FuzzTest_TestUtil::triggerAssert());
/// @endcode
/// Next, we trigger a `ReviewViolation` by calling `triggerReview` inside
/// `ASSERT_FAIL` and verify that a violation occurs as expected.
/// @code
///  ASSERT_FAIL(bsls::FuzzTest_TestUtil::triggerReview());
/// @endcode
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bsls
 * @{
 */
/** @addtogroup bsls_fuzztest_testutil
 * @{
 */
 
#include <bsls_assert.h>
#include <bsls_review.h>
 
 
namespace bsls {
 
                      // =======================
                      // class FuzzTest_TestUtil
                      // =======================
 
/// This utility class provides sample functions to demonstrate an
/// `AssertViolation` or a `ReviewViolation` originating from a different
/// component to facilitate testing of @ref bsls_fuzztest  component.
///
/// See @ref bsls_fuzztest_testutil 
struct FuzzTest_TestUtil {
 
  public:
    // CLASS METHODS
 
    /// Trigger an `AssertViolation` by calling `BSLS_ASSERT_INVOKE`.
    static void triggerAssert();
 
    /// Trigger a `ReviewViolation` by calling `BSLS_REVIEW_INVOKE`.
    static void triggerReview();
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2024 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */