UnitTestFrameworkPkg: Update YAML to ignore specific ECC files/errors

[mirror_edk2.git] / UnitTestFrameworkPkg / UnitTestFrameworkPkg.ci.yaml

## @file\r
# CI configuration for UnitTestFrameworkPkg\r
#\r
# Copyright (c) Microsoft Corporation\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
{\r
    ## options defined .pytool/Plugin/LicenseCheck\r
    "LicenseCheck": {\r
        "IgnoreFiles": []\r
    },\r
    "EccCheck": {\r
        ## Exception sample looks like below:\r
        ## "ExceptionList": [\r
        ##     "<ErrorID>", "<KeyWord>"\r
        ## ]\r
        "ExceptionList": [\r
            "9005", "@MRT",\r
            "7007", "_UNIT_TEST_FAILURE_TYPE_STRING"\r
        ],\r
        ## Both file path and directory path are accepted.\r
        "IgnoreFiles": [\r
            "Library/CmockaLib/cmocka",\r
            "Library/UnitTestLib/RunTestsCmocka.c"\r
        ]\r
    },\r
    ## options defined .pytool/Plugin/CompilerPlugin\r
    "CompilerPlugin": {\r
        "DscPath": "UnitTestFrameworkPkg.dsc"\r
    },\r
    ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin\r
    "HostUnitTestCompilerPlugin": {\r
        "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"\r
    },\r
    ## options defined .pytool/Plugin/CharEncodingCheck\r
    "CharEncodingCheck": {\r
        "IgnoreFiles": []\r
    },\r
\r
    ## options defined .pytool/Plugin/DependencyCheck\r
    "DependencyCheck": {\r
        "AcceptableDependencies": [\r
            "MdePkg/MdePkg.dec",\r
            "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"\r
        ],\r
        # For host based unit tests\r
        "AcceptableDependencies-HOST_APPLICATION":[],\r
        # For UEFI shell based apps\r
        "AcceptableDependencies-UEFI_APPLICATION":[\r
            "MdeModulePkg/MdeModulePkg.dec",\r
            "ShellPkg/ShellPkg.dec"\r
        ],\r
        "IgnoreInf": []\r
    },\r
    ## options defined .pytool/Plugin/DscCompleteCheck\r
    "DscCompleteCheck": {\r
        "DscPath": "UnitTestFrameworkPkg.dsc",\r
        "IgnoreInf": []\r
    },\r
    ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck\r
    "HostUnitTestDscCompleteCheck": {\r
        "IgnoreInf": [],\r
        "DscPath": "Test/UnitTestFrameworkPkgHostTest.dsc"\r
    },\r
    ## options defined .pytool/Plugin/GuidCheck\r
    "GuidCheck": {\r
        "IgnoreGuidName": [],\r
        "IgnoreGuidValue": [],\r
        "IgnoreFoldersAndFiles": [],\r
        "IgnoreDuplicates": []\r
    },\r
    ## options defined .pytool/Plugin/LibraryClassCheck\r
    "LibraryClassCheck": {\r
        "IgnoreHeaderFile": []\r
    },\r
\r
    ## options defined .pytool/Plugin/SpellCheck\r
    "SpellCheck": {\r
        "AuditOnly": False,           # Fails test but run in AuditOnly mode to collect log\r
        "IgnoreFiles": [             # use gitignore syntax to ignore errors in matching files\r
            "Library/CmockaLib/cmocka/**/*.*"  # not going to spell check a submodule\r
        ],\r
        "ExtendWords": [             # words to extend to the dictionary for this package\r
            "testcase",\r
            "testsuites",\r
            "cmocka",\r
            "buildmodule",\r
            "criterium",\r
            "pytool",\r
            "pytools",\r
            "NOFAILURE",\r
            "DHAVE", # build flag for cmocka in the INF\r
            "corthon",      # Contact GitHub account in Readme\r
            "mdkinney",     # Contact GitHub account in Readme\r
            "spbrogan"      # Contact GitHub account in Readme\r
        ],\r
        "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore\r
        "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)\r
    }\r
}\r