UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml

   1 ## @file
   2 # CI configuration for UnitTestFrameworkPkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 ##
   7 {
   8     ## options defined .pytool/Plugin/LicenseCheck
   9     "LicenseCheck": {
  10         "IgnoreFiles": []
  11     },
  12     "EccCheck": {
  13         ## Exception sample looks like below:
  14         ## "ExceptionList": [
  15         ##     "<ErrorID>", "<KeyWord>"
  16         ## ]
  17         "ExceptionList": [
  18         ],
  19         ## Both file path and directory path are accepted.
  20         "IgnoreFiles": [
  21             "Library/CmockaLib/cmocka"
  22         ]
  23     },
  24     ## options defined .pytool/Plugin/CompilerPlugin
  25     "CompilerPlugin": {
  26         "DscPath": "UnitTestFrameworkPkg.dsc"
  27     },
  28     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  29     "HostUnitTestCompilerPlugin": {
  30         "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"
  31     },
  32     ## options defined .pytool/Plugin/CharEncodingCheck
  33     "CharEncodingCheck": {
  34         "IgnoreFiles": []
  35     },
  36
  37     ## options defined .pytool/Plugin/DependencyCheck
  38     "DependencyCheck": {
  39         "AcceptableDependencies": [
  40             "MdePkg/MdePkg.dec",
  41             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  42         ],
  43         # For host based unit tests
  44         "AcceptableDependencies-HOST_APPLICATION":[],
  45         # For UEFI shell based apps
  46         "AcceptableDependencies-UEFI_APPLICATION":[
  47             "MdeModulePkg/MdeModulePkg.dec",
  48             "ShellPkg/ShellPkg.dec"
  49         ],
  50         "IgnoreInf": []
  51     },
  52     ## options defined .pytool/Plugin/DscCompleteCheck
  53     "DscCompleteCheck": {
  54         "DscPath": "UnitTestFrameworkPkg.dsc",
  55         "IgnoreInf": []
  56     },
  57     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  58     "HostUnitTestDscCompleteCheck": {
  59         "IgnoreInf": [],
  60         "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"
  61     },
  62     ## options defined .pytool/Plugin/GuidCheck
  63     "GuidCheck": {
  64         "IgnoreGuidName": [],
  65         "IgnoreGuidValue": [],
  66         "IgnoreFoldersAndFiles": [],
  67         "IgnoreDuplicates": []
  68     },
  69     ## options defined .pytool/Plugin/LibraryClassCheck
  70     "LibraryClassCheck": {
  71         "IgnoreHeaderFile": []
  72     },
  73
  74     ## options defined .pytool/Plugin/SpellCheck
  75     "SpellCheck": {
  76         "AuditOnly": False,           # Fails test but run in AuditOnly mode to collect log
  77         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
  78             "Library/CmockaLib/cmocka/**/*.*"  # not going to spell check a submodule
  79         ],
  80         "ExtendWords": [             # words to extend to the dictionary for this package
  81             "testcase",
  82             "testsuites",
  83             "cmocka",
  84             "buildmodule",
  85             "criterium",
  86             "pytool",
  87             "pytools",
  88             "NOFAILURE",
  89             "DHAVE", # build flag for cmocka in the INF
  90             "corthon",      # Contact GitHub account in Readme
  91             "mdkinney",     # Contact GitHub account in Readme
  92             "spbrogan"      # Contact GitHub account in Readme
  93         ],
  94         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  95         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  96     }
  97 }