| 1 | # Host Unit Test Dsc Complete Check Plugin
|
|---|
| 2 |
|
|---|
| 3 | This CiBuildPlugin scans all INF files from a package for those related to host
|
|---|
| 4 | based unit tests confirms they are listed in the unit test DSC file for the package.
|
|---|
| 5 | The test considers it an error if any INF meeting the requirements does not appear
|
|---|
| 6 | in the `Components` section of the unit test DSC. This is critical because
|
|---|
| 7 | much of the CI infrastructure assumes that modules will be listed in the DSC
|
|---|
| 8 | and compiled.
|
|---|
| 9 |
|
|---|
| 10 | This test will only require INFs in the following cases:
|
|---|
| 11 |
|
|---|
| 12 | 1. When MODULE_TYPE = HOST_APPLICATION
|
|---|
| 13 | 2. When a Library instance supports the HOST_APPLICATION environment
|
|---|
| 14 |
|
|---|
| 15 | ## Configuration
|
|---|
| 16 |
|
|---|
| 17 | The plugin has a few configuration options to support the UEFI codebase.
|
|---|
| 18 |
|
|---|
| 19 | ``` yaml
|
|---|
| 20 | "HostUnitTestDscCompleteCheck": {
|
|---|
| 21 | "DscPath": "", # Path to Host based unit test DSC file
|
|---|
| 22 | "IgnoreInf": [] # Ignore INF if found in filesystem but not dsc
|
|---|
| 23 | }
|
|---|
| 24 | ```
|
|---|
| 25 |
|
|---|
| 26 | ### DscPath
|
|---|
| 27 |
|
|---|
| 28 | Path to DSC to consider platform dsc
|
|---|
| 29 |
|
|---|
| 30 | ### IgnoreInf
|
|---|
| 31 |
|
|---|
| 32 | Ignore error if Inf file is not listed in DSC file
|
|---|
