Re: [edk2-devel] [edk2-stable202402][Patch V3 6/7] UnitTestFrameworkPkg/SampleGoogleTest: Use EXPECT_ANY_THROW()

["Michael Kubacki" <mikuback@linux.microsoft.com>]

Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>

On 2/9/2024 3:32 PM, Michael D Kinney wrote:
> Update GoogleTest samples to use EXPECT_ANY_THROW() instead
> of ASSERT_DEATH(). ASSERT_DEATH() is a very slow method to
> detect an expected ASSERT() condition. Throwing an exception
> from ASSERT() and using EXPECT_ANY_THROW() is several orders
> of magnitude faster.
> 
> Update GoogleTest sample with example of using EXPECT_THROW()
> and EXPECT_THAT() to check for more specific ASSERT() conditions
> that allow unit test cases to test functions that contain
> more than one ASSERT() statement and verify that the expected
> ASSERT() is the one that was actually triggered.
> 
> Update library mappings so target-based unit tests use
> UnitTestDebugAssertLib.inf and host-based unit tests use
> UnitTestDebugAssertLibHost.inf
> 
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
>   UnitTestFrameworkPkg/ReadMe.md                |  2 +-
>   .../SampleGoogleTest/SampleGoogleTest.cpp     | 36 ++++++++++++++++---
>   2 files changed, 32 insertions(+), 6 deletions(-)
> 
> diff --git a/UnitTestFrameworkPkg/ReadMe.md b/UnitTestFrameworkPkg/ReadMe.md
> index d6a3e0c15a2b..d28cb5cb0a5d 100644
> --- a/UnitTestFrameworkPkg/ReadMe.md
> +++ b/UnitTestFrameworkPkg/ReadMe.md
> @@ -59,7 +59,7 @@ reviewed. The paths to the SecureBootVariableLib unit tests are:
>   | Unit Test Source Language   |     C     |    C++     |
>   | Register Test Suite         |    YES    |    Auto    |
>   | Register Test Case          |    YES    |    Auto    |
> -| Death/Expected Assert Tests |    YES    |    YES     |
> +| Expected Assert Tests       |    YES    |    YES     |
>   | Setup/Teardown Hooks        |    YES    |    YES     |
>   | Value-Parameterized Tests   |    NO     |    YES     |
>   | Typed Tests                 |    NO     |    YES     |
> diff --git a/UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp b/UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp
> index 94cbf2cf0b3c..2c2765e1e5ab 100644
> --- a/UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp
> +++ b/UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp
> @@ -7,7 +7,7 @@
>   
>   **/
>   
> -#include <gtest/gtest.h>
> +#include <Library/GoogleTestLib.h>
>   extern "C" {
>     #include <Uefi.h>
>     #include <Library/BaseLib.h>
> @@ -229,7 +229,7 @@ TEST_P (MacroTestsAssertsEnabledDisabled, MacroExpectNoAssertFailure) {
>   }
>   
>   /**
> -  Sample unit test using the ASSERT_DEATH() macro to test expected ASSERT()s.
> +  Sample unit test using the EXPECT_ANY_THROW() macro to test expected ASSERT()s.
>   **/
>   TEST_P (MacroTestsAssertsEnabledDisabled, MacroExpectAssertFailure) {
>     //
> @@ -242,14 +242,35 @@ TEST_P (MacroTestsAssertsEnabledDisabled, MacroExpectAssertFailure) {
>     //
>     // This test passes because it directly triggers an ASSERT().
>     //
> -  ASSERT_DEATH (ASSERT (FALSE), "");
> +  EXPECT_ANY_THROW (ASSERT (FALSE));
>   
>     //
>     // This test passes because DecimalToBcd() generates an ASSERT() if the
>     // value passed in is >= 100.  The expected ASSERT() is caught by the unit
> -  // test framework and ASSERT_DEATH() returns without an error.
> +  // test framework and EXPECT_ANY_THROW() returns without an error.
>     //
> -  ASSERT_DEATH (DecimalToBcd8 (101), "");
> +  EXPECT_ANY_THROW (DecimalToBcd8 (101));
> +
> +  //
> +  // This test passes because DecimalToBcd() generates an ASSERT() if the
> +  // value passed in is >= 100.  The expected ASSERT() is caught by the unit
> +  // test framework and throws the C++ exception of type std::runtime_error.
> +  // EXPECT_THROW() returns without an error.
> +  //
> +  EXPECT_THROW (DecimalToBcd8 (101), std::runtime_error);
> +
> +  //
> +  // This test passes because DecimalToBcd() generates an ASSERT() if the
> +  // value passed in is >= 100.  The expected ASSERT() is caught by the unit
> +  // test framework and throws the C++ exception of type std::runtime_error with
> +  // a message that includes the filename, linenumber, and the expression that
> +  // triggered the ASSERT().
> +  //
> +  // EXPECT_THROW_MESSAGE() calls DecimalToBcd() expecting DecimalToBds() to
> +  // throw a C++ exception of type std::runtime_error with a message that
> +  // includes the expression of "Value < 100" that triggered the ASSERT().
> +  //
> +  EXPECT_THROW_MESSAGE (DecimalToBcd8 (101), "Value < 100");
>   }
>   
>   INSTANTIATE_TEST_SUITE_P (
> @@ -266,6 +287,11 @@ TEST (MacroTestsMessages, MacroTraceMessage) {
>     // Example of logging.
>     //
>     SCOPED_TRACE ("SCOPED_TRACE message\n");
> +
> +  //
> +  // Always pass
> +  //
> +  ASSERT_TRUE (TRUE);
>   }
>   
>   int


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115358): https://edk2.groups.io/g/devel/message/115358
Mute This Topic: https://groups.io/mt/104267261/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-