SecurityPkg/SecurityPkg.ci.yaml

   1 ## @file
   2 # CI configuration for SecurityPkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6 # SPDX-License-Identifier: BSD-2-Clause-Patent
   7 ##
   8 {
   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         ]
  22     },
  23     "CompilerPlugin": {
  24         "DscPath": "SecurityPkg.dsc"
  25     },
  26     "CharEncodingCheck": {
  27         "IgnoreFiles": []
  28     },
  29     "DependencyCheck": {
  30         "AcceptableDependencies": [
  31             "MdePkg/MdePkg.dec",
  32             "MdeModulePkg/MdeModulePkg.dec",
  33             "SecurityPkg/SecurityPkg.dec",
  34             "StandaloneMmPkg/StandaloneMmPkg.dec",
  35             "CryptoPkg/CryptoPkg.dec"
  36         ],
  37         # For host based unit tests
  38         "AcceptableDependencies-HOST_APPLICATION":[],
  39         # For UEFI shell based apps
  40         "AcceptableDependencies-UEFI_APPLICATION":[],
  41         "IgnoreInf": []
  42     },
  43     "DscCompleteCheck": {
  44         "DscPath": "SecurityPkg.dsc",
  45         "IgnoreInf": []
  46     },
  47     "GuidCheck": {
  48         "IgnoreGuidName": [],
  49         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
  50         "IgnoreFoldersAndFiles": [],
  51         "IgnoreDuplicates": [
  52             "Tpm2InstanceLibDTpm=gEfiTpmDeviceInstanceTpm20DtpmGuid", #  by design
  53         ]
  54     },
  55     "LibraryClassCheck": {
  56         "IgnoreHeaderFile": []
  57     },
  58
  59     ## options defined ci/Plugin/SpellCheck
  60     "SpellCheck": {
  61         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
  62         "ExtendWords": [             # words to extend to the dictionary for this package
  63             "shortformed", # tpm acpi
  64             "autodetect",
  65             "blocksid",
  66             "comid",
  67             "cpinsidpin", #OpalSScV2
  68             "ecdsa", # TPM
  69             "ecschnorr", # TPM
  70             "eisaid", # ACPI
  71             "harddisk",
  72             "hashall",
  73             "hashto",
  74             "kek's",
  75             "lfanew", # PE/COFF
  76             "pcrindex",
  77             "pkglength",
  78             "ppuser",
  79             "preos",
  80             "stclear",
  81             "toctou",
  82             "tpm's",
  83             "tpmcmdbuflength",
  84             "tpmcommlib",
  85             "tpmnvvaluelength",
  86             "wrlocked",
  87             "xored"
  88         ],
  89         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  90         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  91     },
  92
  93     "Defines": {
  94         "BLD_*_CONTINUOUS_INTEGRATION": "TRUE",
  95     }
  96 }