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