Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Host Based Unit Test updates #837

Merged
merged 4 commits into from
Jun 27, 2024

Conversation

Javagedes
Copy link
Contributor

@Javagedes Javagedes commented May 1, 2024

Description

Updates the host-based unit test runner to fail if a unit test executable returns successfully, but has no test results, or if a test suite generated from a unit test executable does not contain any tests.

The issues above indicate configuration errors in the unit test source code itself and indicates to the developer that changes to the unit test need to be made.

Updates the README.md file for the UnitTestFrameworkPkg to correct inaccurate information regarding code coverage and provide information on how to consolidate and generate unit test html reports.

  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

N/A

Integration Instructions

If any host based unit tests were written incorrectly, and there exists a test with no test suites, or a test suite with no tests, The host based unit test runner will now fail. These tests will need to be corrected.

@github-actions github-actions bot added language:python Pull requests that update Python code impact:breaking-change Requires integration attention impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation labels May 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 1.35%. Comparing base (884e654) to head (960e4e4).

Additional details and impacted files
@@               Coverage Diff               @@
##           release/202311     #837   +/-   ##
===============================================
  Coverage            1.35%    1.35%           
===============================================
  Files                1304     1304           
  Lines              333790   333790           
  Branches             5103     5103           
===============================================
  Hits                 4512     4512           
  Misses             329195   329195           
  Partials               83       83           
Flag Coverage Δ
MdeModulePkg 0.68% <ø> (ø)
MdePkg 5.40% <ø> (ø)
NetworkPkg 0.55% <ø> (ø)
PolicyServicePkg 30.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Javagedes Javagedes force-pushed the unittest-updates branch 2 times, most recently from c3789a4 to 0096329 Compare May 2, 2024 14:52
Updates the host based unit test runner to fail if a unit test
executable returns successfully, but has no test results, or if a test
suite generated from a unit test executable does not contain any tests.

The issues above indicate configuration errors in the unit test source
code itself and indicates to the developer that changes to the unit test
need to be made.

Updates the README.md file for the UnitTestFrameworkPkg to correct
inaccurate information regarding Code Coverage, and provide information
on how to consolidate and generate unit test html reports.
@Javagedes Javagedes merged commit fd8a097 into microsoft:release/202311 Jun 27, 2024
37 checks passed
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jul 13, 2024
Introduces 17 new commits in [MU_BASECORE](https://github.com/microsoft/mu_basecore.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3a55a400815a25a25a9aa657e99c95edf750188e">3a55a4</a> [CHERRY-PICK] [Release/202311] UnitTestFrameworkPkg: Fix Google Test components with multiple files (<a href="https://github.com/microsoft/mu_basecore/pull/891">#891</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1475a86d1603236e0c1da7d22d37021c8dc7bf91">1475a8</a> [CHERRY-PICK] [RELEASE/202311] Pulling PixieFail changes from EDK2 for CVE-2023-45237 and CVE-2023-45236 (<a href="https://github.com/microsoft/mu_basecore/pull/897">#897</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/23c33e211ef80511d161d3804ffe5ff4b00c652d">23c33e</a> BaseTools/Plugin/HostBasedUnitTestRunner: Fix invalid escape in HostBasedUnitTest.py (<a href="https://github.com/microsoft/mu_basecore/pull/899">#899</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f598b780f7ae52d90422750214e2450fa24d4ded">f598b7</a> [CHERRY-PICK] UefiCpuPkg:fix issue when splitting paging entry (<a href="https://github.com/microsoft/mu_basecore/pull/909">#909</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/bbbff00dc39a67dc1e44aa0ce392d460b12f66b9">bbbff0</a> Change CpuDeadLoops to panic calls in PiSmmCpuDxeSmm.c (<a href="https://github.com/microsoft/mu_basecore/pull/892">#892</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3ab77179e0d08269b155392c44e2f14724114e4e">3ab771</a> Added mock functions for UefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/87b10e679399232d60fefdd6515812bd74571b6d">87b10e</a> Added mock functions for PciExpressLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/5a22ca63d43d7fa162a3adcfbc8d7eb3ffff3c60">5a22ca</a> Added mock functions for TimerLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/86dc06813bc2e1bbd59f06f52b3c97fb722718c0">86dc06</a> pip: update edk2-pytool-library requirement from ~=0.21.6 to ~=0.21.7 (<a href="https://github.com/microsoft/mu_basecore/pull/906">#906</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e6d01390794aa0505d0659bc484f4d2fdba1e5d4">e6d013</a> pip: update edk2-pytool-extensions requirement from ~=0.27.5 to ~=0.27.6 (<a href="https://github.com/microsoft/mu_basecore/pull/907">#907</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f9c86cda20d912e2ae6cce5e6daeae01ed6e8b52">f9c86c</a> pip: update edk2-pytool-library requirement from ~=0.21.7 to ~=0.21.8 (<a href="https://github.com/microsoft/mu_basecore/pull/966">#966</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/884e654b29d3611f976d5b9629ae9af920532dd3">884e65</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_basecore/pull/982">#982</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/fd8a09795aa2ea2a091906efb92124eb85d49e05">fd8a09</a> Host Based Unit Test updates (<a href="https://github.com/microsoft/mu_basecore/pull/837">#837</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/307dc02e66899fd9be316a2143783b261375b884">307dc0</a> GitHub Action: Bump robinraju/release-downloader from 1.10 to 1.11 (<a href="https://github.com/microsoft/mu_basecore/pull/1016">#1016</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/57770989fcac90b6e4046f5cd9a692afea1f318f">577709</a> pip: update edk2-pytool-extensions requirement from ~=0.27.6 to ~=0.27.8 (<a href="https://github.com/microsoft/mu_basecore/pull/1028">#1028</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7cf3382ebaf5b5b5a2487d7d13e910c1c7dac233">7cf338</a> pip: update edk2-pytool-extensions requirement from ~=0.27.8 to ~=0.27.9 (<a href="https://github.com/microsoft/mu_basecore/pull/1033">#1033</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/90adf2bc49197314f6d8b2bb40d63d4c5c503065">90adf2</a> BaseTools/Plugin/RustEnvironmentCheck: Use pytools Rust helpers (<a href="https://github.com/microsoft/mu_basecore/pull/1037">#1037</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jul 14, 2024
Introduces 18 new commits in [MU_BASECORE](https://github.com/microsoft/mu_basecore.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3a55a400815a25a25a9aa657e99c95edf750188e">3a55a4</a> [CHERRY-PICK] [Release/202311] UnitTestFrameworkPkg: Fix Google Test components with multiple files (<a href="https://github.com/microsoft/mu_basecore/pull/891">#891</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1475a86d1603236e0c1da7d22d37021c8dc7bf91">1475a8</a> [CHERRY-PICK] [RELEASE/202311] Pulling PixieFail changes from EDK2 for CVE-2023-45237 and CVE-2023-45236 (<a href="https://github.com/microsoft/mu_basecore/pull/897">#897</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/23c33e211ef80511d161d3804ffe5ff4b00c652d">23c33e</a> BaseTools/Plugin/HostBasedUnitTestRunner: Fix invalid escape in HostBasedUnitTest.py (<a href="https://github.com/microsoft/mu_basecore/pull/899">#899</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f598b780f7ae52d90422750214e2450fa24d4ded">f598b7</a> [CHERRY-PICK] UefiCpuPkg:fix issue when splitting paging entry (<a href="https://github.com/microsoft/mu_basecore/pull/909">#909</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/bbbff00dc39a67dc1e44aa0ce392d460b12f66b9">bbbff0</a> Change CpuDeadLoops to panic calls in PiSmmCpuDxeSmm.c (<a href="https://github.com/microsoft/mu_basecore/pull/892">#892</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3ab77179e0d08269b155392c44e2f14724114e4e">3ab771</a> Added mock functions for UefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/87b10e679399232d60fefdd6515812bd74571b6d">87b10e</a> Added mock functions for PciExpressLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/5a22ca63d43d7fa162a3adcfbc8d7eb3ffff3c60">5a22ca</a> Added mock functions for TimerLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/86dc06813bc2e1bbd59f06f52b3c97fb722718c0">86dc06</a> pip: update edk2-pytool-library requirement from ~=0.21.6 to ~=0.21.7 (<a href="https://github.com/microsoft/mu_basecore/pull/906">#906</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e6d01390794aa0505d0659bc484f4d2fdba1e5d4">e6d013</a> pip: update edk2-pytool-extensions requirement from ~=0.27.5 to ~=0.27.6 (<a href="https://github.com/microsoft/mu_basecore/pull/907">#907</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f9c86cda20d912e2ae6cce5e6daeae01ed6e8b52">f9c86c</a> pip: update edk2-pytool-library requirement from ~=0.21.7 to ~=0.21.8 (<a href="https://github.com/microsoft/mu_basecore/pull/966">#966</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/884e654b29d3611f976d5b9629ae9af920532dd3">884e65</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_basecore/pull/982">#982</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/fd8a09795aa2ea2a091906efb92124eb85d49e05">fd8a09</a> Host Based Unit Test updates (<a href="https://github.com/microsoft/mu_basecore/pull/837">#837</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/307dc02e66899fd9be316a2143783b261375b884">307dc0</a> GitHub Action: Bump robinraju/release-downloader from 1.10 to 1.11 (<a href="https://github.com/microsoft/mu_basecore/pull/1016">#1016</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/57770989fcac90b6e4046f5cd9a692afea1f318f">577709</a> pip: update edk2-pytool-extensions requirement from ~=0.27.6 to ~=0.27.8 (<a href="https://github.com/microsoft/mu_basecore/pull/1028">#1028</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7cf3382ebaf5b5b5a2487d7d13e910c1c7dac233">7cf338</a> pip: update edk2-pytool-extensions requirement from ~=0.27.8 to ~=0.27.9 (<a href="https://github.com/microsoft/mu_basecore/pull/1033">#1033</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/90adf2bc49197314f6d8b2bb40d63d4c5c503065">90adf2</a> BaseTools/Plugin/RustEnvironmentCheck: Use pytools Rust helpers (<a href="https://github.com/microsoft/mu_basecore/pull/1037">#1037</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1cbfaf1fbc6ef94deba8654afcf2b57104743f4e">1cbfaf</a> MdeModulePkg: Compatibility Mode: Only Remap System Memory Regions</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jul 17, 2024
Introduces 20 new commits in [MU_BASECORE](https://github.com/microsoft/mu_basecore.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3a55a400815a25a25a9aa657e99c95edf750188e">3a55a4</a> [CHERRY-PICK] [Release/202311] UnitTestFrameworkPkg: Fix Google Test components with multiple files (<a href="https://github.com/microsoft/mu_basecore/pull/891">#891</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1475a86d1603236e0c1da7d22d37021c8dc7bf91">1475a8</a> [CHERRY-PICK] [RELEASE/202311] Pulling PixieFail changes from EDK2 for CVE-2023-45237 and CVE-2023-45236 (<a href="https://github.com/microsoft/mu_basecore/pull/897">#897</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/23c33e211ef80511d161d3804ffe5ff4b00c652d">23c33e</a> BaseTools/Plugin/HostBasedUnitTestRunner: Fix invalid escape in HostBasedUnitTest.py (<a href="https://github.com/microsoft/mu_basecore/pull/899">#899</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f598b780f7ae52d90422750214e2450fa24d4ded">f598b7</a> [CHERRY-PICK] UefiCpuPkg:fix issue when splitting paging entry (<a href="https://github.com/microsoft/mu_basecore/pull/909">#909</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/bbbff00dc39a67dc1e44aa0ce392d460b12f66b9">bbbff0</a> Change CpuDeadLoops to panic calls in PiSmmCpuDxeSmm.c (<a href="https://github.com/microsoft/mu_basecore/pull/892">#892</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3ab77179e0d08269b155392c44e2f14724114e4e">3ab771</a> Added mock functions for UefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/87b10e679399232d60fefdd6515812bd74571b6d">87b10e</a> Added mock functions for PciExpressLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/5a22ca63d43d7fa162a3adcfbc8d7eb3ffff3c60">5a22ca</a> Added mock functions for TimerLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/86dc06813bc2e1bbd59f06f52b3c97fb722718c0">86dc06</a> pip: update edk2-pytool-library requirement from ~=0.21.6 to ~=0.21.7 (<a href="https://github.com/microsoft/mu_basecore/pull/906">#906</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e6d01390794aa0505d0659bc484f4d2fdba1e5d4">e6d013</a> pip: update edk2-pytool-extensions requirement from ~=0.27.5 to ~=0.27.6 (<a href="https://github.com/microsoft/mu_basecore/pull/907">#907</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f9c86cda20d912e2ae6cce5e6daeae01ed6e8b52">f9c86c</a> pip: update edk2-pytool-library requirement from ~=0.21.7 to ~=0.21.8 (<a href="https://github.com/microsoft/mu_basecore/pull/966">#966</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/884e654b29d3611f976d5b9629ae9af920532dd3">884e65</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_basecore/pull/982">#982</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/fd8a09795aa2ea2a091906efb92124eb85d49e05">fd8a09</a> Host Based Unit Test updates (<a href="https://github.com/microsoft/mu_basecore/pull/837">#837</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/307dc02e66899fd9be316a2143783b261375b884">307dc0</a> GitHub Action: Bump robinraju/release-downloader from 1.10 to 1.11 (<a href="https://github.com/microsoft/mu_basecore/pull/1016">#1016</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/57770989fcac90b6e4046f5cd9a692afea1f318f">577709</a> pip: update edk2-pytool-extensions requirement from ~=0.27.6 to ~=0.27.8 (<a href="https://github.com/microsoft/mu_basecore/pull/1028">#1028</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7cf3382ebaf5b5b5a2487d7d13e910c1c7dac233">7cf338</a> pip: update edk2-pytool-extensions requirement from ~=0.27.8 to ~=0.27.9 (<a href="https://github.com/microsoft/mu_basecore/pull/1033">#1033</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/90adf2bc49197314f6d8b2bb40d63d4c5c503065">90adf2</a> BaseTools/Plugin/RustEnvironmentCheck: Use pytools Rust helpers (<a href="https://github.com/microsoft/mu_basecore/pull/1037">#1037</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1cbfaf1fbc6ef94deba8654afcf2b57104743f4e">1cbfaf</a> MdeModulePkg: Compatibility Mode: Only Remap System Memory Regions</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e1eb585136e2689ce7f6fa8a569ea1e331666f33">e1eb58</a> Revert `NO_ABSOLUTE_RELOCS_IN_TEXT` MU change for GCC (<a href="https://github.com/microsoft/mu_basecore/pull/1040">#1040</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/a9612223c13b05682855801c2593c44ff347c0f4">a96122</a> BaseTools/HostBasedUnitTestRunner: Promote Unittest error to CI fail.</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
apop5 referenced this pull request in microsoft/mu_tiano_platforms Jul 22, 2024
Introduces 20 new commits in [MU_BASECORE](https://github.com/microsoft/mu_basecore.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3a55a400815a25a25a9aa657e99c95edf750188e">3a55a4</a> [CHERRY-PICK] [Release/202311] UnitTestFrameworkPkg: Fix Google Test components with multiple files (<a href="https://github.com/microsoft/mu_basecore/pull/891">#891</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1475a86d1603236e0c1da7d22d37021c8dc7bf91">1475a8</a> [CHERRY-PICK] [RELEASE/202311] Pulling PixieFail changes from EDK2 for CVE-2023-45237 and CVE-2023-45236 (<a href="https://github.com/microsoft/mu_basecore/pull/897">#897</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/23c33e211ef80511d161d3804ffe5ff4b00c652d">23c33e</a> BaseTools/Plugin/HostBasedUnitTestRunner: Fix invalid escape in HostBasedUnitTest.py (<a href="https://github.com/microsoft/mu_basecore/pull/899">#899</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f598b780f7ae52d90422750214e2450fa24d4ded">f598b7</a> [CHERRY-PICK] UefiCpuPkg:fix issue when splitting paging entry (<a href="https://github.com/microsoft/mu_basecore/pull/909">#909</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/bbbff00dc39a67dc1e44aa0ce392d460b12f66b9">bbbff0</a> Change CpuDeadLoops to panic calls in PiSmmCpuDxeSmm.c (<a href="https://github.com/microsoft/mu_basecore/pull/892">#892</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3ab77179e0d08269b155392c44e2f14724114e4e">3ab771</a> Added mock functions for UefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/87b10e679399232d60fefdd6515812bd74571b6d">87b10e</a> Added mock functions for PciExpressLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/5a22ca63d43d7fa162a3adcfbc8d7eb3ffff3c60">5a22ca</a> Added mock functions for TimerLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/86dc06813bc2e1bbd59f06f52b3c97fb722718c0">86dc06</a> pip: update edk2-pytool-library requirement from ~=0.21.6 to ~=0.21.7 (<a href="https://github.com/microsoft/mu_basecore/pull/906">#906</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e6d01390794aa0505d0659bc484f4d2fdba1e5d4">e6d013</a> pip: update edk2-pytool-extensions requirement from ~=0.27.5 to ~=0.27.6 (<a href="https://github.com/microsoft/mu_basecore/pull/907">#907</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f9c86cda20d912e2ae6cce5e6daeae01ed6e8b52">f9c86c</a> pip: update edk2-pytool-library requirement from ~=0.21.7 to ~=0.21.8 (<a href="https://github.com/microsoft/mu_basecore/pull/966">#966</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/884e654b29d3611f976d5b9629ae9af920532dd3">884e65</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_basecore/pull/982">#982</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/fd8a09795aa2ea2a091906efb92124eb85d49e05">fd8a09</a> Host Based Unit Test updates (<a href="https://github.com/microsoft/mu_basecore/pull/837">#837</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/307dc02e66899fd9be316a2143783b261375b884">307dc0</a> GitHub Action: Bump robinraju/release-downloader from 1.10 to 1.11 (<a href="https://github.com/microsoft/mu_basecore/pull/1016">#1016</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/57770989fcac90b6e4046f5cd9a692afea1f318f">577709</a> pip: update edk2-pytool-extensions requirement from ~=0.27.6 to ~=0.27.8 (<a href="https://github.com/microsoft/mu_basecore/pull/1028">#1028</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7cf3382ebaf5b5b5a2487d7d13e910c1c7dac233">7cf338</a> pip: update edk2-pytool-extensions requirement from ~=0.27.8 to ~=0.27.9 (<a href="https://github.com/microsoft/mu_basecore/pull/1033">#1033</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/90adf2bc49197314f6d8b2bb40d63d4c5c503065">90adf2</a> BaseTools/Plugin/RustEnvironmentCheck: Use pytools Rust helpers (<a href="https://github.com/microsoft/mu_basecore/pull/1037">#1037</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1cbfaf1fbc6ef94deba8654afcf2b57104743f4e">1cbfaf</a> MdeModulePkg: Compatibility Mode: Only Remap System Memory Regions</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e1eb585136e2689ce7f6fa8a569ea1e331666f33">e1eb58</a> Revert `NO_ABSOLUTE_RELOCS_IN_TEXT` MU change for GCC (<a href="https://github.com/microsoft/mu_basecore/pull/1040">#1040</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/a9612223c13b05682855801c2593c44ff347c0f4">a96122</a> BaseTools/HostBasedUnitTestRunner: Promote Unittest error to CI fail.</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jul 30, 2024
Introduces 27 new commits in [MU_BASECORE](https://github.com/microsoft/mu_basecore.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3a55a400815a25a25a9aa657e99c95edf750188e">3a55a4</a> [CHERRY-PICK] [Release/202311] UnitTestFrameworkPkg: Fix Google Test components with multiple files (<a href="https://github.com/microsoft/mu_basecore/pull/891">#891</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1475a86d1603236e0c1da7d22d37021c8dc7bf91">1475a8</a> [CHERRY-PICK] [RELEASE/202311] Pulling PixieFail changes from EDK2 for CVE-2023-45237 and CVE-2023-45236 (<a href="https://github.com/microsoft/mu_basecore/pull/897">#897</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/23c33e211ef80511d161d3804ffe5ff4b00c652d">23c33e</a> BaseTools/Plugin/HostBasedUnitTestRunner: Fix invalid escape in HostBasedUnitTest.py (<a href="https://github.com/microsoft/mu_basecore/pull/899">#899</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f598b780f7ae52d90422750214e2450fa24d4ded">f598b7</a> [CHERRY-PICK] UefiCpuPkg:fix issue when splitting paging entry (<a href="https://github.com/microsoft/mu_basecore/pull/909">#909</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/bbbff00dc39a67dc1e44aa0ce392d460b12f66b9">bbbff0</a> Change CpuDeadLoops to panic calls in PiSmmCpuDxeSmm.c (<a href="https://github.com/microsoft/mu_basecore/pull/892">#892</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/3ab77179e0d08269b155392c44e2f14724114e4e">3ab771</a> Added mock functions for UefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/87b10e679399232d60fefdd6515812bd74571b6d">87b10e</a> Added mock functions for PciExpressLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/5a22ca63d43d7fa162a3adcfbc8d7eb3ffff3c60">5a22ca</a> Added mock functions for TimerLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/86dc06813bc2e1bbd59f06f52b3c97fb722718c0">86dc06</a> pip: update edk2-pytool-library requirement from ~=0.21.6 to ~=0.21.7 (<a href="https://github.com/microsoft/mu_basecore/pull/906">#906</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e6d01390794aa0505d0659bc484f4d2fdba1e5d4">e6d013</a> pip: update edk2-pytool-extensions requirement from ~=0.27.5 to ~=0.27.6 (<a href="https://github.com/microsoft/mu_basecore/pull/907">#907</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/f9c86cda20d912e2ae6cce5e6daeae01ed6e8b52">f9c86c</a> pip: update edk2-pytool-library requirement from ~=0.21.7 to ~=0.21.8 (<a href="https://github.com/microsoft/mu_basecore/pull/966">#966</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/884e654b29d3611f976d5b9629ae9af920532dd3">884e65</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_basecore/pull/982">#982</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/fd8a09795aa2ea2a091906efb92124eb85d49e05">fd8a09</a> Host Based Unit Test updates (<a href="https://github.com/microsoft/mu_basecore/pull/837">#837</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/307dc02e66899fd9be316a2143783b261375b884">307dc0</a> GitHub Action: Bump robinraju/release-downloader from 1.10 to 1.11 (<a href="https://github.com/microsoft/mu_basecore/pull/1016">#1016</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/57770989fcac90b6e4046f5cd9a692afea1f318f">577709</a> pip: update edk2-pytool-extensions requirement from ~=0.27.6 to ~=0.27.8 (<a href="https://github.com/microsoft/mu_basecore/pull/1028">#1028</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7cf3382ebaf5b5b5a2487d7d13e910c1c7dac233">7cf338</a> pip: update edk2-pytool-extensions requirement from ~=0.27.8 to ~=0.27.9 (<a href="https://github.com/microsoft/mu_basecore/pull/1033">#1033</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/90adf2bc49197314f6d8b2bb40d63d4c5c503065">90adf2</a> BaseTools/Plugin/RustEnvironmentCheck: Use pytools Rust helpers (<a href="https://github.com/microsoft/mu_basecore/pull/1037">#1037</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/1cbfaf1fbc6ef94deba8654afcf2b57104743f4e">1cbfaf</a> MdeModulePkg: Compatibility Mode: Only Remap System Memory Regions</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/e1eb585136e2689ce7f6fa8a569ea1e331666f33">e1eb58</a> Revert `NO_ABSOLUTE_RELOCS_IN_TEXT` MU change for GCC (<a href="https://github.com/microsoft/mu_basecore/pull/1040">#1040</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/a9612223c13b05682855801c2593c44ff347c0f4">a96122</a> BaseTools/HostBasedUnitTestRunner: Promote Unittest error to CI fail.</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/285f5d8f31ab92156354758fb31e29288f65525d">285f5d</a> Repo File Sync: .sync/rust_config/rustfmt.toml: Use Rust default of 4 space indentation (<a href="https://github.com/microsoft/mu_basecore/pull/1058">#1058</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/c41e6949328e58241970902dc73f62cb12d685ac">c41e69</a> Added mock functions on UefiLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/be93190390309b3d7319a395636f9a2664954acb">be9319</a> Added MockUefiDevicePathLib and gBS_AllocatePool under MockUefiBootServicesTableLib</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/d9c18c384889d0c445865f96ac660f6abee6115f">d9c18c</a> Added the right copyright info (Intel and Microsoft) on all MockUefiDevicePathLib files</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/cf915a50dbb79d11663fbe254d94d1b39496e057">cf915a</a> BaseTools/codeql: Update to CodeQL 2.18.1 (<a href="https://github.com/microsoft/mu_basecore/pull/1072">#1072</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/856d8a412308b852e53254c10edd0f098933aa8f">856d8a</a> Update BaseCryptLib tests to reference the PCDs before running (<a href="https://github.com/microsoft/mu_basecore/pull/1034">#1034</a>)</li>
<li><a href="https://github.com/microsoft/mu_basecore/commit/7a2272c02884ebb49283b5520dbddf8085dd1295">7a2272</a> Add deprecation warning support to OverrideValidation plugin (<a href="https://github.com/microsoft/mu_basecore/pull/742">#742</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
os-d pushed a commit to os-d/mu_basecore that referenced this pull request Aug 23, 2024
## Description

Updates the host-based unit test runner to fail if a unit test
executable returns successfully, but has no test results, or if a test
suite generated from a unit test executable does not contain any tests.

The issues above indicate configuration errors in the unit test source
code itself and indicates to the developer that changes to the unit test
need to be made.

Updates the README.md file for the UnitTestFrameworkPkg to correct
inaccurate information regarding code coverage and provide information
on how to consolidate and generate unit test html reports.

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [x] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [x] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

N/A

## Integration Instructions

If any host based unit tests were written incorrectly, and there exists
a test with no test suites, or a test suite with no tests, The host
based unit test runner will now fail. These tests will need to be
corrected.

---------

Signed-off-by: Joey Vagedes <[email protected]>
os-d pushed a commit that referenced this pull request Aug 24, 2024
## Description

Updates the host-based unit test runner to fail if a unit test
executable returns successfully, but has no test results, or if a test
suite generated from a unit test executable does not contain any tests.

The issues above indicate configuration errors in the unit test source
code itself and indicates to the developer that changes to the unit test
need to be made.

Updates the README.md file for the UnitTestFrameworkPkg to correct
inaccurate information regarding code coverage and provide information
on how to consolidate and generate unit test html reports.

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [x] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [x] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

N/A

## Integration Instructions

If any host based unit tests were written incorrectly, and there exists
a test with no test suites, or a test suite with no tests, The host
based unit test runner will now fail. These tests will need to be
corrected.

---------

Signed-off-by: Joey Vagedes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:breaking-change Requires integration attention impact:non-functional Does not have a functional impact language:python Pull requests that update Python code type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants