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             "9005", "@MRT",
  19             "7007", "_UNIT_TEST_FAILURE_TYPE_STRING"
  20         ],
  21         ## Both file path and directory path are accepted.
  22         "IgnoreFiles": [
  23             "Library/CmockaLib/cmocka",
  24             "Library/UnitTestLib/RunTestsCmocka.c"
  25         ]
  26     },
  27     ## options defined .pytool/Plugin/CompilerPlugin
  28     "CompilerPlugin": {
  29         "DscPath": "UnitTestFrameworkPkg.dsc"
  30     },
  31     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  32     "HostUnitTestCompilerPlugin": {
  33         "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"
  34     },
  35     ## options defined .pytool/Plugin/CharEncodingCheck
  36     "CharEncodingCheck": {
  37         "IgnoreFiles": []
  38     },
  39
  40     ## options defined .pytool/Plugin/DependencyCheck
  41     "DependencyCheck": {
  42         "AcceptableDependencies": [
  43             "MdePkg/MdePkg.dec",
  44             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  45         ],
  46         # For host based unit tests
  47         "AcceptableDependencies-HOST_APPLICATION":[],
  48         # For UEFI shell based apps
  49         "AcceptableDependencies-UEFI_APPLICATION":[
  50             "MdeModulePkg/MdeModulePkg.dec",
  51             "ShellPkg/ShellPkg.dec"
  52         ],
  53         "IgnoreInf": []
  54     },
  55     ## options defined .pytool/Plugin/DscCompleteCheck
  56     "DscCompleteCheck": {
  57         "DscPath": "UnitTestFrameworkPkg.dsc",
  58         "IgnoreInf": []
  59     },
  60     ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
  61     "HostUnitTestDscCompleteCheck": {
  62         "IgnoreInf": [],
  63         "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"
  64     },
  65     ## options defined .pytool/Plugin/GuidCheck
  66     "GuidCheck": {
  67         "IgnoreGuidName": [],
  68         "IgnoreGuidValue": [],
  69         "IgnoreFoldersAndFiles": [],
  70         "IgnoreDuplicates": []
  71     },
  72     ## options defined .pytool/Plugin/LibraryClassCheck
  73     "LibraryClassCheck": {
  74         "IgnoreHeaderFile": []
  75     },
  76
  77     ## options defined .pytool/Plugin/SpellCheck
  78     "SpellCheck": {
  79         "AuditOnly": False,           # Fails test but run in AuditOnly mode to collect log
  80         "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files
  81             "Library/CmockaLib/cmocka/**/*.*",  # not going to spell check a submodule
  82             "Library/GoogleTestLib/googletest/**/*.*"  # not going to spell check a submodule
  83         ],
  84         "ExtendWords": [             # words to extend to the dictionary for this package
  85             "testcase",
  86             "testsuites",
  87             "cmocka",
  88             "buildmodule",
  89             "criterium",
  90             "pytool",
  91             "pytools",
  92             "NOFAILURE",
  93             "cmockery",
  94             "cobertura",
  95             "DHAVE", # build flag for cmocka in the INF
  96             "gtest", # file name in GoogleTestLib.inf
  97             "corthon",      # Contact GitHub account in Readme
  98             "mdkinney",     # Contact GitHub account in Readme
  99             "spbrogan"      # Contact GitHub account in Readme
 100         ],
 101         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
 102         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
 103     }
 104 }