CryptoPkg/CryptoPkg.ci.yaml

   1 ## @file
   2 # CI configuration for CryptoPkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020 - 2022, Intel Corporation. All rights reserved.<BR>
   6 # SPDX-License-Identifier: BSD-2-Clause-Patent
   7 ##
   8 {
   9     "LicenseCheck": {
  10         "IgnoreFiles": [
  11             # These directories contain auto-generated OpenSSL content
  12             "Library/OpensslLib/IA32",
  13             "Library/OpensslLib/IA32Gcc",
  14             "Library/OpensslLib/X64",
  15             "Library/OpensslLib/X64Gcc",
  16             "Library/Include/openssl"
  17         ]
  18     },
  19     "EccCheck": {
  20         ## Exception sample looks like below:
  21         ## "ExceptionList": [
  22         ##     "<ErrorID>", "<KeyWord>"
  23         ## ]
  24         "ExceptionList": [
  25             "8001", "IsLeap",
  26             "8001", "OBJ_get0_data",
  27             "8001", "OBJ_length",
  28             "5005", "X509PopCertificate"
  29         ],
  30         ## Both file path and directory path are accepted.
  31         "IgnoreFiles": [
  32             "Library/OpensslLib/openssl",
  33             "Library/Include/openssl",
  34             "Library/Include/crypto",
  35             # The unit testing folder is not to be checked
  36             "Test/UnitTest",
  37             # This has OpenSSL interfaces that aren't UEFI spec compliant
  38             "Library/BaseCryptLib/SysCall",
  39             # This has OpenSSL interfaces that aren't UEFI spec compliant
  40             "Library/OpensslLib/rand_pool.c",
  41             # This has OpenSSL interfaces that aren't UEFI spec compliant
  42             "Library/Include/CrtLibSupport.h",
  43             # This has OpenSSL interfaces that aren't UEFI spec compliant
  44             "Library/BaseCryptLib/Hash/CryptParallelHash.h",
  45             "Library/Include/fcntl.h",
  46             # These directories contain auto-generated OpenSSL content
  47             "Library/OpensslLib",
  48             "Library/IntrinsicLib",
  49             "Library/BaseCryptLib/Pk/CryptPkcs7VerifyBase.c"
  50         ]
  51     },
  52     "CompilerPlugin": {
  53         "DscPath": "CryptoPkg.dsc"
  54     },
  55     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  56     "HostUnitTestCompilerPlugin": {
  57         "DscPath": "Test/CryptoPkgHostUnitTest.dsc"
  58     },
  59     "CharEncodingCheck": {
  60         "IgnoreFiles": []
  61     },
  62     "DependencyCheck": {
  63         "AcceptableDependencies": [
  64             "MdePkg/MdePkg.dec",
  65             "MdeModulePkg/MdeModulePkg.dec",
  66             "CryptoPkg/CryptoPkg.dec",
  67         ],
  68         # For host based unit tests
  69         "AcceptableDependencies-HOST_APPLICATION":[],
  70         # For UEFI shell based apps
  71         "AcceptableDependencies-UEFI_APPLICATION":[],
  72         "IgnoreInf": []
  73     },
  74     "DscCompleteCheck": {
  75         "DscPath": "CryptoPkg.dsc",
  76         "IgnoreInf": []
  77     },
  78     "GuidCheck": {
  79         "IgnoreGuidName": [],
  80         "IgnoreGuidValue": [],
  81         "IgnoreFoldersAndFiles": []
  82     },
  83     "LibraryClassCheck": {
  84         "IgnoreHeaderFile": []
  85     },
  86
  87     ## options defined ci/Plugin/SpellCheck
  88     "SpellCheck": {
  89         "skip": True,
  90         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  91         "ExtendWords": [],           # words to extend to the dictionary for this package
  92         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  93         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  94     },
  95
  96     # options defined in .pytool/Plugin/UncrustifyCheck
  97     "UncrustifyCheck": {
  98         "IgnoreFiles": [
  99             "opensslconf.h",
 100             "dso_conf.h",
 101             "opensslconf_generated.h"
 102         ]
 103     }
 104 }