Track Source Files Excluded from Code Coverage Reports

[kj4ezj]

Change Description

From AUTO-117, Blockchain wishes to collect metrics on what source files are not being reported upon by the code coverage reports. The new metrics collection code references the pipeline.jsonc file to determine which files it should expect coverage reports from, and which files it should ignore in the coverage report. This pull request creates initial versions of these declarations, and also updates some other pipeline.jsonc entries.

Schema

This script looks for a pipeline.jsonc file in the root of the repo in which it is running, filters by pipeline slug, then automagically imports two properties, if they are present:

{
    "eosio-code-coverage":
    {
        "exclude": [ // ignore coverage reports from source filenames matching these PCREs
            "^/build/",
            "^/coverage/",
            "^/.git/",
            "^/libraries/eos-vm/",
            "^/libraries/fc/",
            "^/libraries/wabt/",
            "^/libraries/wasm-jit/",
            "^/node_modules/",
            "^/unittests/"
        ],
        "expect": [ // expect coverage reports from source filenames matching these PCREs
            "[.]c(pp)?([.]in)?$",
            "[.]h(pp)?([.]in)?$"
        ]
    }
}

The script will still work if this file or either one of these properties are missing.

See Also

• AUTO-117 - Coverage report for code coverage report
• auto-events-subscribers pull request 409 - Track Source Files Excluded from Code Coverage Reports
• eos-buildkite-pipelines pull request 110 - Track Source Files Excluded from Code Coverage Reports
• eos
  • Pull Request 9308 - eos:develop
  • Pull Request 9311 - eos:release/2.0.x
  • Pull Request 9312 - eos:release/1.8.x
• Code Coverage Dashboard

Change Type

Select ONE

• Documentation
• Stability bug fix
• Other

CI

• Other - special case

Consensus Changes

• Consensus Changes

None.

API Changes

• API Changes

None.

Documentation Additions

• Documentation Additions

None.