forked from Ericsson/codechecker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNewFeatures.vue
More file actions
2065 lines (1899 loc) · 82.1 KB
/
NewFeatures.vue
File metadata and controls
2065 lines (1899 loc) · 82.1 KB
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<template>
<!-- eslint-disable max-len -->
<v-container fluid>
<v-timeline align-top>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.22.2"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.22.2 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Support for Ubuntu 22.04
</template>
CodeChecker failed to build on Ubuntu 22.04 in its previous release
because of two issues: some of our dependencies broke with the
release of python3.9, and we didn't support GNU Make-s new way of
creating build jobs. These issues are all fixed now, so CodeChecker
should work with the latest version of python and GNU Make!
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
<new-release-item color="green lighten-1">
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.22.1"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.22.1 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Bugfix, related to CodeChecker server
</template>
CodeChecker webapp was crashing when using the component filter,
which has been fixed in this release.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.22.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.22.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Further enhancements to speed up the store procedure
</template>
After another round of optimizations, CodeChecker store is ~2 times
faster than in v6.21.0. Combined with the previous release, storing
may be as much as 4 times faster than v6.20.0., with larger result
directories seeing a greater degree of improvement.
<br>
This should allow those that use CodeChecker in CI loops to see
fewer timeouts due to long storages, or lower timeout tresholds
significantly.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Multiroot analysis
</template>
CodeChecker now supports an analysis mode where for each source
file, it tries to find the closest compile_commands.json file up in
the directory hierarchy starting from the source file.
If your project is structured such that multiple folders act as
their own root folder (hence the name multiroot), CodeChecker
should be able to support that out of the box. clangd and
clang-tidy already works this way.
<br>
This feature also affects the CodeChecker Visual Studio Code
plugin, where analysis will be done on multiroot projects as well.
<br>
Previously the input of analysis must have been a compilation
database JSON file. This PR supports the following new CodeChecker
analyze invocations, as long as a corresponding compilation
database file is found:
<pre>
# Analyze a single file.
CodeChecker analyze analyze.cpp -o reports
# Analyze all source files under a directory.
CodeChecker analyze my_project -o reports
</pre>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Support report annotations and add dynamic analyzer related annotations
</template>
Unlike for static analyzers, the time of the detection can be a
crucial piece of information, as a report may be a result of
another preceding report. Users that record the timestamp of the
detection and store it in CodeChecker under the new 'Timestamp'
field will be able to sort reports by it. CodeChecker now also
supports the 'Testsuite' field.
You can read more about this feature in its PR:
<a href="https://github.com/Ericsson/codechecker/pull/3849" target="_blank">#3849</a>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Removed deprecated flags, turn missing checker warnings to errors
<v-alert dense outlined type="error" class="py-0 ma-0 ml-2">
Backward incompatible change!
</v-alert>
</template>
Removed <code>CodeChecker checkers --only-enabled</code>, use
<code>CodeChecker checkers --details</code> instead.
<br>
Removed <code>CodeChecker checkers --only-disabled</code>, use
<code>CodeChecker checkers --details</code> instead.
<br>
Removed <code>CodeChecker cmd diff --suppressed</code> and <code>CodeChecker cmd diff -s</code>, use
<code>CodeChecker cmd diff --review-status [REVIEW_STATUS [REVIEW_STATUS ...]]</code> instead.
<br>
Removed <code>CodeChecker cmd diff --filter</code>, use
<code>CodeChecker cmd diff --review-status false_positive</code> instead.
<br>
Removed <code>CodeChecker cmd sum --disable-unique</code>, use
<code>CodeChecker cmd sum --uniqueing'</code> instead.
<br>
Removed <code>CodeChecker analyze --tidy-config</code>, use
<code>CodeChecker analyze --analyzer-config'</code> instead.
<br>
Incorrect checker names now emit errors instead of errors, but if
necessary, the old behaviour can be restored with
<code>--no-missing-checker-error</code>.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
<new-release-item color="green lighten-1">
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.21.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.21.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Support Roslynator in the report-converter
</template>
The <a href="https://github.com/JosefPihrt/Roslynator" target="_blank">Roslynator</a>
project contains several analyzers for C# built on top of Microsoft
Roslyn. CodeChecker now supports the visualization of these C#
anlaysis results. It also provides a
<a href="https://github.com/JosefPihrt/Roslynator#roslynator-command-line-tool-" target="_blank">.NET tool</a>
for running Roslyn code analysis from the command line. It is not
limited to Microsoft and Roslynator analyzers, it supports any
Roslyn anaylzer. It can also report MSBuild compiler diagnostics.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Optimizations to <code>CodeChecker store</code> and
<code>CodeChecker cmd diff</code>
</template>
After a round of optimizations on <code>CodeChecker store</code>,
we expect it to be 2x faster in certain cases (especially for
larger projects)!
For runs with a lot of reports, <code>CodeChecker cmd diff</code>
should be faster as well.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.20.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.20.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Cppcheck support in CodeChecker
</template>
<code>CodeChecker analyze</code> sub-command was originally designed
to drive ClangSA and ClangTidy analyzers. Now it has been extended
with Cppcheck support
The output of the <code>CodeChecker version -o json</code> command
wasn't a valid JSON format. From this release CodeChecker will
provide a valid JSON output for this command.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Change review status handling
</template>
<p>
Review status is a categorization of reports by the developers.
They can indicate whether a report is false-positive, confirmed,
intentional, etc. These markings were bound to a report hash, so
different reports sharing the same hash were attached the same
review status. The problem with this approach was that review
status comments written in the source code could have swapped
review statuses back and forth if different review status was
attached to the same bug in different runs.
</p>
<p>
In this release a review status is attached to each report
individually, so a review status given in source code comment
doesn't affect reports with the same hash in other runs.
</p>
<p>
Review status can still be set via GUI. This works like an e-mail
rule: when a new report appears with the given hash, the review
status will be applied automatically.
</p>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Filter by files anywhere on bugpath
</template>
At file and source component filters reports can be selected where the
bug path ends in those files or source components. In this release
these file filters can be applied to any point of the bug path.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
<new-release-item color="green lighten-1">
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.19.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.19.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Fix JSON format of CodeChecker version subcommand
<v-alert dense outlined type="error" class="py-0 ma-0 ml-2">
Backward incompatible change!
</v-alert>
</template>
The output of the <code>CodeChecker version -o json</code> command
wasn't a valid JSON format. From this release CodeChecker will
provide a valid JSON output for this command.
For more information see the
<a href="https://github.com/Ericsson/codechecker/blob/master/docs/web/user_guide.md#json-format" target="_blank">documentation</a>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Not allowing disabling modeling checkers in ClangSA
<v-alert dense outlined type="error" class="py-0 ma-0 ml-2">
Backward incompatible change!
</v-alert>
</template>
When a Clang Static Analyzer checker is disabled in CodeChecker,
clang is invoked with the <code>analyzer-disable-checker</code>
flag. This allows the user disabling core modeling checkers such
as <i>unix.DynamicMemoryModeling</i>. This causes malfunctioning of
depending checkers.
From this release modeling and debug checkers (listed with
<code>clang -cc1 -analyzer-checker-help-developer</code>) will not
be listed and cannot be disabled through CodeChecker with the
<code>--enable</code> and <code>--disable</code> flags.
They can be enabled/disabled through the Clang Static Analyzer
specific <code>--saargs</code> flag only.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Add --print-steps option to <code>CodeChecker cmd diff</code> command
</template>
Without bug steps it is hard to understood the problem by a
programmer. With this commit we will introduce a new option for the
<code>CodeChecker cmd diff</code> command which can be used to
print bug steps similar what we are doing at the
<code>CodeChecker parse</code> command. This patch also solve the
problem to print bug steps in <i>HTML</i> files for reports which
comes from a <i>CodeChecker server</i>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Support YAML CodeChecker configuration files
</template>
Multiple subcommands have a <b>--config</b> option which allow the
configuration from an explicit configuration file. The parameters
in the config file will be emplaced as command line arguments.
Previously we supported only JSON format but the limitation of this
format is that we can't add comments in this file for example why
we enabled/disabled a checker, why an option is important etc.
From this release we will also support <b>YAML</b> format:
<pre>
analyzer:
# Enable/disable checkers.
- --enable=core.DivideZero
</pre>
For more information see the
<a href="https://github.com/Ericsson/codechecker/blob/master/docs/config_file.md#yaml" target="_blank">documentation</a>.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.18.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.18.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
<v-alert dense outlined type="error">
Backward incompatible CLI change!
</v-alert>
</template>
The <i>JSON</i> output of the CodeChecker parse command was not
stable enough and the structure was very similar to the plist
structure. Our plan is to support reading/parsing/storing of
multiple analyzer output types not only plist but for example
<a href="http://docs.oasis-open.org/sarif/sarif/v2.0/csprd01/sarif-v2.0-csprd01.html" target="_blank">sarif</a>
format as well. For this reason we changed the format of the
JSON output of the <i>CodeChecker parse</i> and
<i>CodeChecker cmd diff</i> commands. For more information
<a href="https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md" target="_blank">see</a>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Get access controls
</template>
Create a new global role (<code>PERMISSION_VIEW</code>) which will
be used to allow the users to fetch access control information from
a running <i>CodeChecker server</i> by using the
<code>CodeChecker cmd permissions</code> subcommand.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
<new-release-item color="green lighten-1">
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.17.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.17.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Git blame integration
</template>
<v-row>
<v-col cols="8">
With this feature it will be possible for a developer to check
who modified the source line last where a CodeChecker error
appears.
<ul>
<li>
If the project which was analyzed is a git repository
<code>CodeChecker store</code> command will store blame
information for every source files which are not stored
yet.
</li>
<li>
The GUI will have a button on the report detail view to
show blame information alongside the source file.
</li>
<li>
Hovering the mouse over a blame line, commit details will
be shown in a pop-up window. Clicking on the hash will jump
to the remote url of the repository and shows the commit
which related to a blame line.
</li>
</ul>
</v-col>
<v-col>
<img
src="@/assets/userguide/images/new_features/6.17.0/git_blame.png"
alt="Git blame"
width="100%"
>
</v-col>
</v-row>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Cleanup plans
</template>
<v-row>
<v-col cols="8">
Cleanup plans can be used to track progress of reports in your
product. The conception is similar to the
<i>Github Milestones</i>.
You can do the following:
<ul>
<li>
<strong>Managing cleanup plans</strong>: you can create
cleanup plans by clicking on the pencil icon at the
<i>Cleanup plan </i> filter on the <i>Reports page</i>. A
pop-up window will be opened where you can add, edit, close
or remove existing cleanup plans.
</li>
<li>
<strong>Add reports to a cleanup plan</strong>: you can add
multiple reports to a cleanup plan on the
<i>Reports page</i> or on the <i>Report detail page</i> by
clicking to the <i>Set cleanup plan</i> button and
selecting a cleanup plan.
<i>Note</i>: you can remove reports from a cleanup plan the
same way by clicking on the cleanup plan name.
</li>
<li>
<strong>Filter reports by cleanup plans</strong>: you can
filter reports by a cleanup plan by using the
<i>Cleanup plan filter</i> on the <i>Reports page</i>.
Using this filter with other filters
(<i>Detection status</i>, <i>Review status</i> etc.) you
will be able to filter active / resolved reports in your
cleanup plan.
</li>
</ul>
</v-col>
<v-col>
<img
src="@/assets/userguide/images/reports/list_of_cleanup_plans.png"
alt="List of cleanup plans"
width="100%"
>
<img
src="@/assets/userguide/images/reports/assign_reports_to_cleanup_plan.png"
alt="Add reports to cleanup plans"
width="100%"
>
</v-col>
</v-row>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Local diff workflow support
</template>
If you want to use CodeChecker in your project but you don't want
to run a CodeChecker server and to fix every reports found by
CodeChecker for the first time (legacy findings) with this
feature you can do the following:
<ul>
<li>
Analyze your project to a report directory as usual
(e.g.: <i>./reports</i>).
</li>
<li>
Create a <i>baseline file</i> from the reports which contains
the legacy findings:
<code>CodeChecker parse ./reports -e baseline -o reports.baseline</code>.
<i>Note</i>: it is recommended to store this baseline file
(<i>reports.baseline</i>) in your repository.
</li>
<li>
On source code changes after your project is re-analyzed use
the <code>CodeChecker diff</code> command to get the new
reports:
<code>CodeChecker cmd diff -b ./reports.baseline -n ./reports --new</code>
</li>
<li>
On configuration changes (new checkers / options are enabled /
disabled, new CodeChecker / clang version is used, etc.)
re-generate the baseline file (step 1-2).
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
LeakSanitizer Parser
</template>
The <i>report-converter</i> tool is extended with LeakSanitizer
which is a run-time memory leak detector for C programs.
<pre>
# Compile your program.
clang -fsanitize=address -g lsan.c
# Run your program and redirect the output to a file.
ASAN_OPTIONS=detect_leaks=1 ./a.out > lsan.output 2>&1
# Generate plist files from the output.
report-converter -t lsan -o ./lsan_results lsan.output
# Store reports.
CodeChecker store ./lsan_results -n lsan
</pre>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Checker label
</template>
Previously the properties of checkers (<i>severity</i>,
<i>profile</i>, <i>guideline</i>) are read from several JSON files.
The goal was to handle all these and future properties of checkers
in a common manner. This new solution uses labels which can be
added to checkers.
The collection of labels is found in <i>config/labels</i>
directory. The goal of these labels is that you can enable or
disable checkers by these labels.
<pre>
# List checkers in "sensitive" profile.
CodeChecker checkers --label profile:sensitive
# List checkers in "HIGH" severity.
CodeChecker checkers --label severity:HIGH
# List checkers covering str34-c SEI-CERT rule.
CodeChecker checkers --label sei-cert:str-34-c
# List checkers covering all SEI-CERT rules.
CodeChecker checkers --label guideline:sei-cert
# List available profiles, guidelines and severities.
CodeChecker checkers --profile
CodeChecker checkers --guideline
CodeChecker checkers --severity
# List labels and their available values.
CodeChecker checkers --label
CodeChecker checkers --label severity
# Enable HIGH checkers during analysis.
CodeChecker analyze \
./compile_commands.json \
-o ./reports
-e severity:HIGH
</pre>
Note: with this new feature we also added severity levels for
<i>pylint</i> and <i>cppcheck</i> analyzers.
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.16.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.16.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
PyPI package support
</template>
<i>PyPI</i> is the most commonly used central repository for Python
packages. For this reason from this release we will provide an
official
<a href="https://pypi.org/project/codechecker/" target="_blank">
PyPI package
</a> for CodeChecker. This PyPi package can be easily installed on
both <i>Unix</i> and <i>Windows</i> based systems easily by using
the pip command: <code>pip install codechecker</code>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Add compilation database generator for Bazel
</template>
CodeChecker was extended with a tool that can capture compilation
database of a <b>Bazel</b> built product without actually
performing compilation. For more information
<a href="https://github.com/Ericsson/codechecker/blob/master/docs/tools/bazel.md">see</a>.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Exporter/importer command for CodeChecker cmd
</template>
New command line options are introduced
(<code>CodeChecker cmd export</code> and
<code>CodeChecker cmd import</code>) which can be used to export
comments and review status for a particular run in a JSON based
format from a running CodeChecker server and import it to another
server.
<pre>
# Export data from one server.
CodeChecker cmd export \
-n myrun \
--url https://first-server.codechecker.com:443 \
2>/dev/null | python -m json.tool > myrun_export.json
# Import data to another server.
CodeChecker cmd import \
-i myrun_export.json \
--url https://second-server.codechecker.com:443
</pre>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Sparse and Cpplint analyzers support
</template>
The <i>report-converter</i> tool was extend with two more
analyzers:
<ul>
<li>
Sparse which is a semantic checker for C programs; it can be
used to find a number of potential problems with kernel code.
</li>
<li>
CppLint which is a lint-like tool which checks C++ code
against Google C++ Style Guide.
</li>
</ul>
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
<new-release-item color="green lighten-1">
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.15.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.15.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
Web UI
</template>
<ul>
<li>
There is a brand new
<strong>Product Statistics Overview</strong> page
with the information about the recently introduced or resolved
reports or about the distribution of the reports in the
product.
</li>
<li>
The <strong>Run History</strong> list was moved from a separate
tab to an <strong>expandable list</strong> under each run at
the run list. This makes easier to find the relevant run
history entries for each run.
</li>
<li>
New <strong>Report Info Button</strong> to show more
information about a report at the report details page
(run name, detection/fix date ...).
</li>
<li>
Source components can be used to create and save file path
filters with a name to show results only from those parts
of the analyzed project. With the newly introduced
<strong>Other component</strong> every report which does not
belong to any other component can be filtered.
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Command line interface (CLI)
</template>
<ul>
<li>
<strong>New exit status</strong> numbers for the CodeChecker
analyze and check commands for better <i>CI integration</i>:
<ul>
<li>
0 - Successful analysis and no new reports
</li>
<li>
1 - CodeChecker error
</li>
<li>
2 - At least one report emitted by an analyzer and there
is no analyzer failure
</li>
<li>
3 - Analysis of at least one translation unit failed
</li>
</ul>
</li>
<li>
<strong>Gerrit output</strong> format is available
<strong>for the parse subcommand</strong>.
This output format was only available for the CodeChecker
cmd diff command in the previous releases. With this change
the parse command can be used for the gerrit integration
too.<br>
<code>CodeChecker parse analyzer_reports -e gerrit</code>
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Report storage support for new source code analyzers
</template>
<ul>
<li>
Report conversion and storage support is available for multiple
new source code analyzer tools (<strong>Coccinelle</strong>,
<strong>Smatch</strong>, <strong>Kernel-Doc</strong>). The
<a
href="https://github.com/Ericsson/codechecker/tree/master/tools/report-converter"
target="_blank"
>
report-converter
</a> tool can be used to convert the output of these analyzers
to a format which can be stored to the web server or processed
by other CodeChecker commands (parse, cmd diff ...).
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Changes
</template>
<ul>
<li>
Open reports date filter was renamed to
<i>"Outstanding reports on a given date"</i> on the web UI.<br>
Also a new <code>--outstanding-reports-date</code> CLI filter
argument was introduced as a filter option.
</li>
<li>
Less code styling related checker groups are enabled by
<code>--enable-all</code> flag.
The <code>--enable-all</code> flag enabled a lot of style
checkers which could generate a lot of styling reports.
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Further improvements worth mentioning
</template>
<ul>
<li>
Allow users to overwrite location of the session file.
</li>
<li>
Show how many filter items are visible at the filter tool tip
if there are more items.
</li>
<li>
Show selected filter items at Review status filter.
</li>
<li>
Improve component statistics page load performance
</li>
<li>
Enable search and highlight occurrences of the selected text
at the source code view
</li>
<li>
Set analyzer name for clang-diagnostic checkers when the
reports are stored.
</li>
<li>
Reintroduce skipfile script for gerrit integration to be able
to analyze only the changed files.
</li>
<li>
New severity levels for
cppcoreguidelines-prefer-member-initializer,
altera-struct-pack-align and
bugprone-redundant-branch-condition checkers.
</li>
</ul>
</new-feature-item>
</new-release-item>
</v-timeline-item>
<v-timeline-item fill-dot icon="mdi-star">
<new-release-item>
<template v-slot:title>
<a
href="https://github.com/Ericsson/codechecker/releases/tag/v6.14.0"
target="_blank"
class="white--text"
>
Highlights of CodeChecker 6.14.0 release
</a>
</template>
<new-feature-item>
<template v-slot:title>
New statistics page in the Web UI
</template>
The statistics page got a new design with a lot of new features:
<ul>
<li>
Statistics shown in separate tabs instead of one page for
better visibility.
</li>
<li>
New, component statistics page, where reports are distributed
per statistics, components can represent a part of a repository
(directory, files).
</li>
<li>
Statistics comparison mode: you will be able compare the report
statistics of two different analysis runs or time snapshot
</li>
<li>
Diff and review status filters are available on the statistics
page.
</li>
</ul>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Redesigned date selectors for the web UI filter and CLI
</template>
You will be able to list the open reports of your project for any
date. Open reports at a date are which were <i>DETECTED BEFORE</i>
the given date and <i>NOT FIXED BEFORE</i> the given date.<br>
From the CLI the open reports can be queried like this:<br>
<code>CodeChecker cmd results --open-reports-date 2020:09:11:12:20 --url ...</code>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Remember filters when navigate between pages
</template>
Filters are remembered during navigating between the pages. The
report list and statistics related filters are saved separately.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Show analyzer name alongside the reports
</template>
Analysis results from multiple static analyzers can be stored to
the database, with this change for each report the analyzer name
can be viewed which produced the result.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Always show similar reports
</template>
Reports with the same hash can be seen in a drop down list for
each report without uniqueing.
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Enable and disable checker profiles and guidelines
(like <i>sei-cert</i>) in the analyzer CLI.
</template>
There is a new syntax extended with guideline support which can be
used to enable checker sets. With the new syntax the checkers,
profiles and guideline can be enabled or disabled even if there is
a conflict in their name. The arguments may start with
<i>profile:</i> of <i>guideline:</i> prefix which makes the choice
explicit. Without prefix it means a profile name, a guideline
name or a checker group/name in this priority order.<br>
<code>
CodeChecker analyze -o reports -e profile:sensitive -e guideline:sei-cert compile_command.json
</code><br><br>
Use these commands to list the available profiles:<br>
<code>CodeChecker checkers --profile list</code><br>
or guidelines:<br>
<code>CodeChecker checkers --guideline</code>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
New report converter for Markdownlint results
</template>
The reports from Markdownlint can be converted and stored to the
report serve like this:
<pre>
# Run Markdownlint.
mdl /path/to/your/project > ./mdl_reports.out
# Use 'report-converter' to create a CodeChecker report directory from the
# analyzer result of Markdownlint.
report-converter -t mdl -o ./codechecker_mdl_reports ./mdl_reports.out
# Store Markdownlint reports with CodeChecker.
CodeChecker store ./codechecker_mdl_reports -n mdl
</pre>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
The codechecker config file was extended with a parse section
which can be used by the parse subcommand.
</template>
It can be used to set the path prefixes in the CodeChecker config
file which should be trimmed by the parse subcommand when the
reports are printed:<br>
<pre>
{
"parse": [
"--trim-path-prefix",
"/$HOME/workspace"
]
}
</pre><br>
The config file for the parse command can be set like this:
<code>CodeChecker parse report --config codechecker_cfg.json</code>
</new-feature-item>
<new-feature-item>
<template v-slot:title>
Environment variables can be used in the CodeChecker config file
</template>
Environment variables can be used in the CodeChecker config file,
they will be expanded automatically:
<pre>
{
"analyzer": [
"--skip=$HOME/project/skip.txt"
]
}