valgrind-codequality

About

I wanted reports from Valgrind to appear in GitLab Merge Requests as Code Quality reports, which is a JSON file defined by the Code Quality's GitLab.

That's all this does: convert Valgrind XML report to Code Quality JSON.

Contributions are welcome.

Usage

It is primarily used as a console script. As such, ensure you have Python 3's "scripts" directory in your PATH variable. For example, on Linux, that might be $HOME/.local/bin.

To test, try the --help or --version flags:

valgrind-codequality --help

This script follows that example and provides similar command-line options. A typical workflow might look like this:

# Generate valgrind report as XML
valgrind --tool=memcheck --leak-check=full --show-leak-kinds=all --track-origins=yes --verbose --xml=yes --xml-file=valgrind_out.xml your_exe
# Convert to a Code Climate JSON report
valgrind-codequality --input-file valgrind_out.xml --output-file valgrind.json

If you wanted, you could invoke the script directly as a module, like this:

# Run as a module instead (note the underscore in the module name here)
python -m valgrind_codequality --input-file=valgrind_out.xml --output-file=valgrind.json

Now, in your GitLab CI script, upload this file as a Code Quality report.

my-code-quality:
  script:
    - [...]
  artifacts:
    reports:
      codequality: valgrind.json

Contributing

• Format with black
• Check with pylint

Credits & Trademarks

valgrind is an open-source project with a GPL v3.0 license.

• https://valgrind.org/

"GitLab" is a trademark of GitLab B.V.

• https://gitlab.com
• https://docs.gitlab.com/ci/testing/code_quality/#import-code-quality-results-from-a-cicd-job

All other trademarks belong to their respective owners.