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