Convert a CppCheck XML report to a GitLab-compatible Code Quality JSON report.
Project description
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
Credits & Trademarks
CppCheck is an open-source project with a GPL v3.0 license.
"Code Climate" may be a registered trademark of Code Climate, Inc. which provides super-cool free and paid services to the developer community.
"GitLab" is a trademark of GitLab B.V.
All other trademarks belong to their respective owners.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cppcheck-codequality-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba2fae336a836ce5d13625b6f11cc25702c77f68bb888743c7d72306b6043cda |
|
MD5 | 0a60bcfa1a0efe150925a06306e0bf5c |
|
BLAKE2b-256 | 563d6eefae4b2d87de8f03e5ca8656b7bb9ad3ae2fe3775219ca047f6b3fcea5 |
Hashes for cppcheck_codequality-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a7cc018b2c28b7ff05662d955688d47d9322df768a774e3adf97d6fa04060ae |
|
MD5 | aad4f24ddb992dba7543bb0b6efe8f65 |
|
BLAKE2b-256 | 3ab37b4689b656516fde4e445c40e5db289fbbc4ae09e4ad7c96824c49907e81 |