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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e103a113a7fa24443fd99336cc4938dcc7d4b2567216c9b46cecc21d054818c0 |
|
MD5 | 1c24bdf7d30259aaa73db74af7ef083b |
|
BLAKE2b-256 | 630114f50fe018bf2c66ab58926809f7acf8d8e7653918a20948bb9945bc4fed |
Hashes for cppcheck_codequality-1.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b2edb8e97669f01e275bca225c08c2e933f11c6f3b897d45f7aa80832b44ef0 |
|
MD5 | ea293e64035be01447156cd26fad0a0a |
|
BLAKE2b-256 | 8b111482a35714a52e129eab1b0690e507276eee91bdd3dffed9862778bd5989 |