audk/.pytool/Plugin/HostUnitTestDscCompleteCheck
Joey Vagedes 7f5c24ad35 .pytool: Integration of edk2-pytools
Performs Integration instructions necessary to upgrade edk2-pytool-library
to 0.19.3 and edk2-pytool-extensions to 0.25.1. This includes resolving
deprecation warnings in the UncrustifyCheck plugin, and Updating the
HostUnitTestDscCompleteCheck plguin to account for a change such that inf's
that do not filter the LIBRARY_CLASS define to certain types, are assumed
to also support HOST_APPLICATION.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Joey Vagedes <joeyvagedes@gmail.com>
Message-Id: <20231027151551.1043941-2-joeyvagedes@microsoft.com>
Reviewed-by: Rebecca Cran <rebecca@os.amperecomputing.com>
Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>
2023-10-28 14:59:29 +00:00
..
HostUnitTestDscCompleteCheck.py .pytool: Integration of edk2-pytools 2023-10-28 14:59:29 +00:00
HostUnitTestDscCompleteCheck_plug_in.yaml .pytool: Add CI support for host based unit tests with results 2020-02-07 19:18:53 +00:00
Readme.md .pytool: Add CI support for host based unit tests with results 2020-02-07 19:18:53 +00:00

Readme.md

Host Unit Test Dsc Complete Check Plugin

This CiBuildPlugin scans all INF files from a package for those related to host based unit tests confirms they are listed in the unit test DSC file for the package. The test considers it an error if any INF meeting the requirements does not appear in the Components section of the unit test DSC. This is critical because much of the CI infrastructure assumes that modules will be listed in the DSC and compiled.

This test will only require INFs in the following cases:

  1. When MODULE_TYPE = HOST_APPLICATION
  2. When a Library instance supports the HOST_APPLICATION environment

Configuration

The plugin has a few configuration options to support the UEFI codebase.

"HostUnitTestDscCompleteCheck": {
    "DscPath": "", # Path to Host based unit test DSC file
    "IgnoreInf": []  # Ignore INF if found in filesystem but not dsc
}

DscPath

Path to DSC to consider platform dsc

IgnoreInf

Ignore error if Inf file is not listed in DSC file