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