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

Add deprecation warning support to OverrideValidation plugin #742

Conversation

NishanthSanjeevi
Copy link
Contributor

@NishanthSanjeevi NishanthSanjeevi commented Feb 16, 2024

Description

Added deprecation warning support to the existing Override validation plugin/tool.

  • Impacts functionality?
    • Functionality - All libraries/drivers that are no longer used should add a Deprecation warning
  • Impacts security?
    • Security - N/A
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior? No
  • Includes tests? No
  • Includes documentation? Added documentation for how to use the Deprecation warnings module

How This Was Tested

Added the Deprecation warnings to the INFs and a warning was thrown when a deprecated module was part of the DSC

Integration Instructions

N/A

@github-actions github-actions bot added language:python Pull requests that update Python code impact:non-functional Does not have a functional impact labels Feb 16, 2024
@NishanthSanjeevi NishanthSanjeevi changed the title Add deprecation warning plugin Add deprecation warning support to OverrideValidation plugin Feb 16, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 1.35%. Comparing base (856d8a4) to head (161643d).

Additional details and impacted files
@@               Coverage Diff               @@
##           release/202311     #742   +/-   ##
===============================================
  Coverage            1.35%    1.35%           
===============================================
  Files                1304     1304           
  Lines              333854   333854           
  Branches             5103     5103           
===============================================
  Hits                 4512     4512           
  Misses             329259   329259           
  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.

@NishanthSanjeevi NishanthSanjeevi marked this pull request as ready for review February 24, 2024 23:30
@NishanthSanjeevi NishanthSanjeevi force-pushed the personal/nishanth/deprecation_warning branch 2 times, most recently from a6cdf12 to 7cdd4ef Compare May 7, 2024 13:09
@makubacki
Copy link
Member

@NishanthSanjeevi, please resolve the final open conversations and we can proceed to merging the PR.

@Javagedes Javagedes force-pushed the personal/nishanth/deprecation_warning branch 2 times, most recently from 7b11763 to c9ee34d Compare July 24, 2024 14:49
@Javagedes
Copy link
Contributor

Hi @NishanthSanjeevi, it looks like changes to the readme are causing MarkdownLint to fail it's CI check. Please review and resolve. Thanks!

@Javagedes Javagedes force-pushed the personal/nishanth/deprecation_warning branch from 3e11da9 to 161643d Compare July 29, 2024 15:43
@Javagedes Javagedes enabled auto-merge (squash) July 29, 2024 15:43
@Javagedes Javagedes merged commit 7a2272c into microsoft:release/202311 Jul 29, 2024
37 checks passed
ProjectMuBot added a commit to microsoft/mu_tiano_platforms that referenced this pull request 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
…ft#742)

Added deprecation warning support to the existing Override validation
plugin/tool.

- [ ] Impacts functionality?
- **Functionality** - All libraries/drivers that are no longer used
should add a Deprecation warning
- [ ] Impacts security?
  - **Security** - N/A
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior? No
- [ ] Includes tests? No
- [ ] Includes documentation? Added documentation for how to use the
Deprecation warnings module

Added the Deprecation warnings to the INFs and a warning was thrown when
a deprecated module was part of the DSC

N/A
os-d pushed a commit that referenced this pull request Aug 24, 2024
Added deprecation warning support to the existing Override validation
plugin/tool.

- [ ] Impacts functionality?
- **Functionality** - All libraries/drivers that are no longer used
should add a Deprecation warning
- [ ] Impacts security?
  - **Security** - N/A
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior? No
- [ ] Includes tests? No
- [ ] Includes documentation? Added documentation for how to use the
Deprecation warnings module

Added the Deprecation warnings to the INFs and a warning was thrown when
a deprecated module was part of the DSC

N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact language:python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants