Tianocore/edk2.git/UnitTestFrameworkPkg/ReadMe.md, branch dependabot/github_actions/actions/github-script-8

UnitTestFrameworkPkg: Use /MTd and enable Address Sanitizers

2025-01-21T05:02:38+00:00

* Update host based unit test VS20xx builds to use /MTd instead of /MT to enable use of debug libraries for host based unit tests. * Enable /fsanitize=address for host based unit test VS2019 builds * Enable /fsanitize=address for host based unit test VS2022 builds * Enable -fsanitize=address for host based unit test GCC builds * Add UNIT_TESTING_ADDRESS_SANITIZER_ENABLE define that is set to TRUE by default so it is always enabled, but can be set to FALSE to temporarily disable during development/debug of unit tests. * Add address sanitizer information to ReadMe.md Enabling the Address Sanitizer can detect double frees, buffer overflow, buffer underflow, access to invalid addresses, and various exceptions. These can be detected in both the unit test case sources as well as the code under test. Signed-off-by: Michael D Kinney

Update CI to VS2022

2024-12-10T23:42:09+00:00

This PR updates the CI pipelines to use VS2022 instead of VS2019 as that is the latest supported VS toolchain on edk2. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Oliver Smith-Denny

UnitTestFrameworkPkg: Use TianoCore mirror of subhook submodule

2024-11-04T19:56:43+00:00

Change subhook url from https://github.com/Zeex/subhook to https://github.com/tianocore/edk2-subhook because old url is no longer available. Also align .gitmodules file to use consistent LF line endings. Signed-off-by: Michael D Kinney

UnitTestFrameworkPkg/SampleGoogleTest: Use EXPECT_ANY_THROW()

2024-02-14T02:37:16+00:00

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4683 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 Cc: Sean Brogan Signed-off-by: Michael D Kinney Reviewed-by: Michael Kubacki

UnitTestFrameworkPkg/Readme.md: Remove gtest main() limitation

2023-12-03T02:37:26+00:00

As of the previous commit, this limitation is no longer a thing. You can now write gtest unit tests with multiple files and no need for any hack such as #include. Cc: Michael D Kinney Cc: Michael Kubacki Cc: Sean Brogan Signed-off-by: Pedro Falcato Reviewed-by: Cc: Michael D Kinney

UnitTestFrameworkPkg/ReadMe.md: Add gmock documentation

2023-04-10T05:59:02+00:00

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4389 Cc: Sean Brogan Cc: Michael Kubacki Cc: Michael D Kinney Signed-off-by: Chris Johnson Reviewed-by: Michael Kubacki Reviewed-by: Oliver Smith-Denny Reviewed-by: Michael D Kinney

UnitTestFrameworkPkg: Add code coverage support for GCC

2023-01-04T02:06:01+00:00

In order to collect code coverage after running executable file, generate *.gcda and *.gcno file that require by lcov tool to generate code coverage report. Reviewed-by: Michael D Kinney Cc: Sean Brogan Cc: Bret Barkelew Reviewed-by: Michael Kubacki Signed-off-by: Gua Guo

UnitTestFrameworkPkg: Add googletest submodule and GoogleTestLib

2022-11-11T05:46:51+00:00

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4134 Add submodule for googletest and add GoogleTestLib that is required for GoogleTest based unit tests. Add GoogleTest documentation to Readme.md along with a port of the sample unit test to the GoogleTest style. A few typos in Readme.md are also fixed. Cc: Michael Kubacki Cc: Sean Brogan Cc: Andrew Fish Cc: Leif Lindholm Signed-off-by: Michael D Kinney Reviewed-by: Michael Kubacki Acked-by: Leif Lindholm

UnitTestFrameworkPkg/Readme.md: Update documentation for latest features

2020-08-07T18:29:41+00:00

* Add additional documentation about running tests locally * Add a note about XML formatting * Update readme with BaseLib and UNIT_TESTING_DEBUG Cc: Michael D Kinney Cc: Sean Brogan Signed-off-by: Bret Barkelew Reviewed-by: Michael D Kinney Reviewed-by: Sean Brogan

UnitTestFrameworkPkg: Add info to readme about working with UnitTests

2020-06-02T02:45:46+00:00

Cc: Michael D Kinney Cc: Bret Barkelew Signed-off-by: Bret Barkelew Reviewed-by: Michael D Kinney