cppcheck-codequality

cppcheck-codequality

 

       

About

I wanted reports from CppCheck to appear in GitLab Merge Requests as Code Quality reports, which is a JSON file defined by the Code Climate team/service.

That's all this does: convert CppCheck XML to Code Climate JSON.

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:

cppcheck-codequality --help

CppCheck already has a script to convert its XML report to HTML for easy human reading. See "Chapter 11 HTML Report" in the CppCheck Manual

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

# Generate CppCheck report as XML
cppcheck --xml --enable=warning,style,performance ./my_src_dir/ 2> cppcheck_out.xml
# Convert to a Code Climate JSON report
cppcheck-codequality --input-file cppcheck_out.xml --output-file cppcheck.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 cppcheck_codequality --input-file=cppcheck_out.xml --output-file=cppcheck.json

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

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

Contributing

• Format with black
• Check with pylint
• Run tests
• Signoff commits (git commit -s) to indicate you agree to Developer Certificate of Origin (DCO) Version 1.1 https://developercertificate.org/
• Create a GitLab merge request and I'll take a look!

Details

Setup development environment.

sudo apt install pipx
pipx install poetry
poetry install
source ./venv/bin/activate

Format

black ./

Use Tox to run tests in all python environments available on your system.

poetry run tox -e clean
poetry run tox

Credits & Trademarks

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

• http://cppcheck.sourceforge.net
• https://github.com/danmar/cppcheck

"Code Climate" may be a registered trademark of Code Climate, Inc. which provides super-cool free and paid services to the developer community.

• https://codeclimate.com
• https://github.com/codeclimate

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

• https://gitlab.com
• https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html

All other trademarks belong to their respective owners.