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