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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e7541812f5d6d1f2852b43241757ef7d79382172a1ef6995c40cb9d85d236d3 |
|
MD5 | 9fac12bc5a9053d8334068eee18faa50 |
|
BLAKE2b-256 | 4f72d888f8dff07b7ad46798a07fac80e90756c7e508a4357ad6b8dbf4a1b307 |
Hashes for cppcheck_codequality-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fb90204db616ac78a8cc0a07d1504946c997df42a841e03afce6f54395185bc |
|
MD5 | defd5cc688d8d0d1fa009b3c68b978a1 |
|
BLAKE2b-256 | 708590269fdfd0dc947f1946c04c9c75957f6ed30918926ddb1f7279f463bad0 |