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
Install with PIP (note the underscore here):
python3 -m pip install -U cppcheck_codequality
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 (note the dash here, instead of underscore):
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. So usage is as follows:
# 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
OR, you could invoke the script directly, as a module, like this:
# Run as a module instead
python3 -m cppcheck_codequality.__main__ --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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 691534d9af18282618a2be5f5226cc6d81130a4b512796d3fb9faa240dd8bfaf |
|
MD5 | 7d70b771c52684380b761901032fd901 |
|
BLAKE2b-256 | 421d4ef6d27de3ccee8dee50ab2cc6a8387c2bb1776f142d688b18f66b5a5ba4 |
Hashes for cppcheck_codequality-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 994f44daa4c6e8d6da621e80815746c871344c0f58318137841af4ec0c3ad295 |
|
MD5 | 46ae3ef613c8bee891cc51a0667adfb7 |
|
BLAKE2b-256 | 5110c1d0a2e6e54b2b1890e378f73e5ffaf70a4d0c5a736cc6b5cb07b947db4f |