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