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         ],
  29         ## Both file path and directory path are accepted.
  30         "IgnoreFiles": [
  31             "Library/OpensslLib/openssl",
  32             "Library/Include/openssl",
  33             "Library/Include/crypto",
  34             # The unit testing folder is not to be checked
  35             "Test/UnitTest",
  36             # This has OpenSSL interfaces that aren't UEFI spec compliant
  37             "Library/BaseCryptLib/SysCall",
  38             # This has OpenSSL interfaces that aren't UEFI spec compliant
  39             "Library/OpensslLib/rand_pool.c",
  40             # This has OpenSSL interfaces that aren't UEFI spec compliant
  41             "Library/Include/CrtLibSupport.h",
  42             # This has OpenSSL interfaces that aren't UEFI spec compliant
  43             "Library/BaseCryptLib/Hash/CryptParallelHash.h",
  44             "Library/Include/fcntl.h",
  45             # These directories contain auto-generated OpenSSL content
  46             "Library/OpensslLib",
  47             "Library/IntrinsicLib",
  48             "Library/BaseCryptLib/Pk/CryptPkcs7VerifyBase.c"
  49         ]
  50     },
  51     "CompilerPlugin": {
  52         "DscPath": "CryptoPkg.dsc"
  53     },
  54     ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
  55     "HostUnitTestCompilerPlugin": {
  56         "DscPath": "Test/CryptoPkgHostUnitTest.dsc"
  57     },
  58     "CharEncodingCheck": {
  59         "IgnoreFiles": []
  60     },
  61     "DependencyCheck": {
  62         "AcceptableDependencies": [
  63             "MdePkg/MdePkg.dec",
  64             "MdeModulePkg/MdeModulePkg.dec",
  65             "CryptoPkg/CryptoPkg.dec",
  66         ],
  67         # For host based unit tests
  68         "AcceptableDependencies-HOST_APPLICATION":[],
  69         # For UEFI shell based apps
  70         "AcceptableDependencies-UEFI_APPLICATION":[],
  71         "IgnoreInf": []
  72     },
  73     "DscCompleteCheck": {
  74         "DscPath": "CryptoPkg.dsc",
  75         "IgnoreInf": [
  76             # These are alternatives to OpensslLib.inf
  77             "CryptoPkg/Library/OpensslLib/OpensslLibIa32.inf",
  78             "CryptoPkg/Library/OpensslLib/OpensslLibIa32Gcc.inf",
  79             "CryptoPkg/Library/OpensslLib/OpensslLibX64.inf",
  80             "CryptoPkg/Library/OpensslLib/OpensslLibX64Gcc.inf"
  81         ]
  82     },
  83     "GuidCheck": {
  84         "IgnoreGuidName": [],
  85         "IgnoreGuidValue": [],
  86         "IgnoreFoldersAndFiles": []
  87     },
  88     "LibraryClassCheck": {
  89         "IgnoreHeaderFile": []
  90     },
  91
  92     ## options defined ci/Plugin/SpellCheck
  93     "SpellCheck": {
  94         "skip": True,
  95         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
  96         "ExtendWords": [],           # words to extend to the dictionary for this package
  97         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
  98         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
  99     },
 100
 101     # options defined in .pytool/Plugin/UncrustifyCheck
 102     "UncrustifyCheck": {
 103         "IgnoreFiles": [
 104             "opensslconf.h",
 105             "dso_conf.h",
 106             "opensslconf_generated.h"
 107         ]
 108     }
 109 }