1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
%global _empty_manifest_terminate_build 0
Name: python-cppcheck-codequality
Version: 1.3.1
Release: 1
Summary: Convert a CppCheck XML report to a GitLab-compatible Code Quality JSON report.
License: MIT
URL: https://gitlab.com/ahogen/cppcheck-codequality
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/63/01/14f50fe018bf2c66ab58926809f7acf8d8e7653918a20948bb9945bc4fed/cppcheck-codequality-1.3.1.tar.gz
BuildArch: noarch
Requires: python3-xmltodict
%description
# cppcheck-codequality
[](https://pypi.python.org/pypi/cppcheck-codequality/)
[](https://pypi.org/project/cppcheck-codequality/)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/issues)
## About
I wanted reports from CppCheck to appear in GitLab Merge Requests as [Code
Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool),
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:
```bash
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](http://cppcheck.sourceforge.net/manual.pdf)
This script follows that example and provides similar command-line options.
A typical workflow might look like this:
```bash
# 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:
```bash
# 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](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportscodequality)
as a Code Quality report.
```yaml
my-code-quality:
script:
- [...]
artifacts:
reports:
codequality: cppcheck.json
```
### Contributing
* Sign the contributor agreement (coming soon)
* Format with [black](https://pypi.org/project/black/)
* Check with [pylint](https://pypi.org/project/pylint/)
### 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.
%package -n python3-cppcheck-codequality
Summary: Convert a CppCheck XML report to a GitLab-compatible Code Quality JSON report.
Provides: python-cppcheck-codequality
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-cppcheck-codequality
# cppcheck-codequality
[](https://pypi.python.org/pypi/cppcheck-codequality/)
[](https://pypi.org/project/cppcheck-codequality/)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/issues)
## About
I wanted reports from CppCheck to appear in GitLab Merge Requests as [Code
Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool),
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:
```bash
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](http://cppcheck.sourceforge.net/manual.pdf)
This script follows that example and provides similar command-line options.
A typical workflow might look like this:
```bash
# 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:
```bash
# 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](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportscodequality)
as a Code Quality report.
```yaml
my-code-quality:
script:
- [...]
artifacts:
reports:
codequality: cppcheck.json
```
### Contributing
* Sign the contributor agreement (coming soon)
* Format with [black](https://pypi.org/project/black/)
* Check with [pylint](https://pypi.org/project/pylint/)
### 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.
%package help
Summary: Development documents and examples for cppcheck-codequality
Provides: python3-cppcheck-codequality-doc
%description help
# cppcheck-codequality
[](https://pypi.python.org/pypi/cppcheck-codequality/)
[](https://pypi.org/project/cppcheck-codequality/)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/pipelines?scope=branches)
[](https://gitlab.com/ahogen/cppcheck-codequality/-/issues)
## About
I wanted reports from CppCheck to appear in GitLab Merge Requests as [Code
Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool),
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:
```bash
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](http://cppcheck.sourceforge.net/manual.pdf)
This script follows that example and provides similar command-line options.
A typical workflow might look like this:
```bash
# 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:
```bash
# 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](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportscodequality)
as a Code Quality report.
```yaml
my-code-quality:
script:
- [...]
artifacts:
reports:
codequality: cppcheck.json
```
### Contributing
* Sign the contributor agreement (coming soon)
* Format with [black](https://pypi.org/project/black/)
* Check with [pylint](https://pypi.org/project/pylint/)
### 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.
%prep
%autosetup -n cppcheck-codequality-1.3.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-cppcheck-codequality -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.3.1-1
- Package Spec generated
|
