Skip to content

Commit

Permalink
Remove UefiBootServicesTableLib from inclusion file (#354)
Browse files Browse the repository at this point in the history
# Preface

Please ensure you have read the [contribution
docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior
to submitting the pull request. In particular,
[pull request
guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices).

## Description

The inclusion file change will potentially change the library linkage of
`UefiBootServicesTableLib`, which could be an incompatible instance
compared to the existing consumers.

This change temporarily removes this inclusion until all unit tests from
the consumers migrated their unit tests to the common implementation.

For each item, place an "x" in between `[` and `]` if true. Example:
`[x]`.
_(you can also check items in the GitHub UI)_

- [x] 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

This was tested on consumer packages that uses
`UefiBootServicesTableLib`.

## Integration Instructions

For packages uses
`UefiBootServicesTableLib|UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.inf`
for unit tests, one needs to update the host test dsc to include the
entry. Otherwise, no changes needed.
  • Loading branch information
kuqin12 authored and kenlautner committed Apr 28, 2023
1 parent cf9c390 commit e039022
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
UnitTestLib|UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLibCmocka.inf
DebugLib|UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.inf
MemoryAllocationLib|UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.inf
UefiBootServicesTableLib|UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.inf
# MU_CHANGE [BEGIN] - Disable UefiBootServicesTableLib until all unit tests converge to this common instance
# UefiBootServicesTableLib|UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.inf
# MU_CHANGE [BEGIN] - Disable UefiBootServicesTableLib until all unit tests converge to this common instance

[BuildOptions]
# MU_CHANGE [BEGIN] - Add build flag to detect when building host-based unit tests
Expand Down

0 comments on commit e039022

Please sign in to comment.