Releases: Ericsson/codechecker
v6.23.0-rc1
🌟 Highlights
GCC Static Analyzer support
We are happy to announce that CodeChecker added native support for the GCC Static Analyzer! This analyzer checks code in the C family of languages, but its latest release at the time of writing is still best used only on C code. Despite it being a bit immature for C++, we did some internal surveys where the GCC Static Analyzer seemed to be promising.
We expect this analyzer to be slower than clang-tidy, but faster than the Clang Static Analyzer. You can enable it by adding --analyzers gcc
to your CodeChecker check
or CodeChecker analyze
commands. For further configuration, check out the GCC Static Analyzer configuration page.
GNU GCC 13.0.0. (the minimum version we support) can be tricky to obtain and to make CodeChecker use it, as CodeChecker looks for the g++
binary, not g++-13
. As a workaround, you can set the environmental variable CC_ANALYZER_BIN
which will make CodeChecker use the given analyzer path (e.g. CC_ANALYZER_BIN="gcc:/usr/bin/g++-13"
). You can use CodeChecker analyzers
to check whether you have the correct binary configured.
You can enable gcc checkers by explicitly mentioning them at the analyze command e.g.
CodeChecker analyze -e gcc
gcc checkers are only added to the exterme profile. After evaluation, some checkers may be added to other profiles too.
Under the same breath, we added partial support for the SARIF file format (as opposed to using plists) to report-converter
, with greater support planned for future releases.
Review status config file
In previous CodeChecker versions, you could set the review status of a report using two methods: using in-source comments, or setting a review status rule in the GUI. The former sets the specific report's review status, the latter sets all matching reports' review status.
This release introduces a third way, a review status config file! One of the motivations behind this is that we wanted to have a way to set review statuses on reports in specific directories (which was not possible on the GUI). CodeChecker uses a YAML config file that can be set during analysis:
# review_status.yaml
- filepath_filter: /path/to/project/test/*
checker_filter: core.DivideZero
message: Division by zero in test files is automatically intentional.
review_status: intentional
- filepath_filter: /path/to/project/important/module/*
message: All reports in this module should be investigated.
review_status: confirmed
- filepath_filter: "*/project/test/*"
message: If a filter starts with asterix, then it should be quoted due to YAML format.
review_status: suppress
- report_hash_filter: b85851b34789e35c6acfa1a4aaf65382
message: This report is false positive.
review_status: false_positive
This is how you can use this config file for an analysis:
CodeChecker analyze compile_commands.json --review-status-config review_status.yaml -o reports
The config file allows for a great variety of ways to match a report and set its review status. For further details see this documentation.
Enable/disable status of checkers
In previous CodeChecker versions, when you ran an analysis, we assigned three states to every checker: it's either enabled, disabled, or neither (unknown). We kept the third state around to give some leeway for the analyzers to decide which checkers to enable or disable, usually to manage their checker dependencies. We now see that this behavior can be (and usually is) confusing, party because it's hard to tell which checkers were actually enabled.
In this release the unknown status has been eliminated, and we deal with dependencies using other means. Moving on, CodeChecker will enable only those checkers that are either present in the default profile (see CodeChecker checkers --profile default
) or enabled using the --enable
argument.
Major fixes to run/tag comparisons (diff)
Following a thorough survey, we identified numerous areas to improve on our run/tag comparisons. We landed several patches to improve the results of diffs both on the CLI and the web GUI (which should be almost always identical). Despite that this feature has the appearance of a simple set operation, diff is a powerful tool that can express a lot of properties on the state of your codebase, and has a few intricacies. For this reason, we also greatly improved our docs around it.
Web GUI improvements
We landed several patches to improve the readability and usability of the GUI, with more improvements to come in later releases! The currently selected event's visual highlight pops a little more now in the report view, and we no longer show unused columns in the run view.
In this image, you can see how much the selected event "pops" after this release, and also, how other events' opacity was a lowered a bit, which allows arrows to be seen through them.
Report limit for storing to the server
Especially in the case of clang-tidy, we have observed some unreasonable number of reports by certain checkers. In some instances, we saw hundreds of thousands (!) of reports reported by some individual checkers, and its more than unlikely that anyone will inspect these reports individually (you probably got the message about using parantheses around macros after the first 15 000 reports).
We found that these checkers were usually enabled by mistake, and put unnecessary strain both on the storage of results to the server, and on the database once stored. Moving forward, CodeChecker servers will reject stores of runs that have more than 500 000 reports. This limit is a default value that you can change or even set to unlimited. Our intent is not to discourage legitemately huge stores, only those that are whose size is likely this large by mistake.
When creating a new product called My product
at endpoint myproduct
, you can set the report limit from the CLI with the following invocation:
CodeChecker cmd products add -n "My product" --report-limit 1000000 myproduct
For an already existing product, you can change the limit by clicking the pencil at the products page:
❗ Backward incompatible changes
Clang warnings must be referred to as clang-diagnostic-<warning-name>
(instead of W<warning-name>
)
After analysis, reports from clang compiler warnings (well before this release) were attributed to clang-diagnostic-<warning-name>
instead of -W<warning-name>
that is usually given to the compiler to enable <warning-name>
. We did this so that warnings from different compilers could be differentiated. However, you could only enable <warning-name>
as a checker by referencing it as W<warning-name>
. In this release, we fixed this inconsistency.
Moving forward, you can enable a clang warning with the following syntax:
CodeChecker analyzer -e clang-diagnostic-deprecated-copy
instead of
CodeChecker analyze -e Wdeprecated-copy
which is no longer supported. You can list all clang-diagnostics with the CodeChecker checkers
command.
--all
and --details
were deprecated for CodeChecker analyzers
With the introduction of the GCC Static Analyzer, we think that the --all
flag was more confusing than useful -- its a reasonable assumption that any system will have a version of GCC available. The default behaviour prior to this release was to only list analyzers that were available for analysis: the binary was found, met the version criteria, and was functional. The --all
flag listed all supported analyzers, even if they were not available. We changed the default behaviour to always list all supported checkers, and --all
is ignored. We emit helpful warnings for analyzers that CodeChecker supports, but can't analyze with.
--details
could be used to print additional version information of the binary, but we didn't feel like it provided any value above what the non-detailed query gave, and it was impossible to pretty print. After this release, this flag will also be ignored.
🐛 Analyzer improvements
- [fix] Recognize -pthread for gcc compile commands #3969
- [bugfix] Allow the disabling of statisticsbased checkers #3972
- [bugfix] Include platform to
ldlogger.so
path #3976 - [analyzer] Ignore another unknown gcc options #4028
- [report-converter] Support sarif format and Gcc analyzer #4011
- Gcc analyzer native support #4030
- [clang-tidy] Fix Clang tidy checker option output https://github.com/Ericsson/cod...
v6.22.2
🌟 Highlights
Support for Ubuntu 22.04
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!
🐛 Analyzer improvements
- Ignore some gcc flags (
-fno-lifetime-dse
#3913,-Wno-error
,-fprofile
#3937, #3941)- We do these kinds of patches reguarly when a gcc flag is not supported by our main analyzer, clang.
- Disable cppcheck-preprocessorErrorDirective explicitly #3902
- Cppcheck analyzer results compilation errors due to less granular configuration of the build environment. This results too many false-positive reports, so this checker is disabled by default.
- Fix exception in Spotbugs report-converter (
report-converter
crashed whenSourceLine
has nosource_path
attribute) #3917 - Fix crash when an assembler command is analyzed #3914
- Logger-related changes
- Recognize and capture
linux_spawn
alongsideexec*
calls in the logger #3930 - Use absolute path to
logger.so
inLD_PRELOAD
#3919- CodeChecker logger is using the
LD_PRELOAD
environment variable whereldlogger.so
was set with a relative path. Due to the relative pathLD_LIBRARY_PATH
has to be set too. However, this latter environment variable is overridden by the build systems many times. So CodeChecker uses an absolute path inLD_PRELOAD
and eliminates the usage ofLD_LIBRARY_PATH
.
- CodeChecker logger is using the
- Recognize and capture
- Adapt to new clang-tidy checker options format. #3934
- Enable multiple inputs for report-converter #3897
- Introduce sanitizer checker names #3904
- Exclude dynamic parts of checker message in hash generation #3927
- Analysis shouldn't fail on non-existing directory #3943
- report-converter: Parse all leaks reported by LeakSanitizer #3750
💻 CLI/Server improvements
- [fix][server] Fix webapp crash when using component filter #3887
- [bugfix] Fix the zombie process issue #3895
- 6.22.1 highlights #3888
- [GUI] Add a tooltip about Diff #3890
- [cmd] Warning message on no run delete. #3915
- [GUI] Pop the call stack when the message starts with "Returning;" #3948
- Fix local local diff src code suppression #3944
🌳 Environment
- [test] Get rid of mockldap #3894
- [req] Upgrade
lxml
to4.9.2
#3896 - [fix] One more attempt to fix gui tests #3911
- Bump GitPython version #3841
- [ci] Remove pypi actions from pullrequest and push events. #3912
- Update Snapstore publish action #3891
- [fix] Fix newly surfaced gui test error during cleanup plan testing #3920
- [test][NFC] Change from nose to pytest (analyzer library) #3926
- [test][NFC] Change from nose to pytest (tools library) #3931
- [test][NFC] Change from nose to pytest (web library) #3932
- [test][NFC] Remove every remaining trace of nose in favor of pytest #3933
- [env] Upgrade PyYAML to version 6.0 #3942
- [test] Allow additional pytest args to be given through make targets #3935
📖 Documentation updates
- [config] Additional clang-diagnostic documentations #3922
🔨 Other
- [doc] Make every second release highlight green #3882
- [version] Bump up to version 6.23.0 #3893
- Makefile: package_gerrit_skiplist should depend on package_dir_structure #3901
- [NFC] Factor args out of the diff logic for unit tests #3863
- [refactor] Reducing analyzer config handler #3824
- [test] Add missing tests for cmdline diffing, and display a bug for tag diffs #3868
- Error message: Add a missing space #3953
- Fix a Pylint false positive with python3.9 or later #3925
Full Changelog: v6.22.0...v6.22.2
v6.22.1
v6.22.0
🌟 Highlights
Further enhancements to speed up the store procedure
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.
This should allow those that use CodeChecker in CI loops to see fewer timeouts due to long storages, or lower timeout tresholds significantly.
Multiroot analysis
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: https://clangd.llvm.org/installation.html#compile_commandsjson
This feature also affects the CodeChecker Visual Studio Code plugin, where analysis will be done on multiroot projects as well Ericsson/CodecheckerVSCodePlugin#113.
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:
# Analyze a single file.
CodeChecker analyze analyze.cpp -o reports
# Analyze all source files under a directory.
CodeChecker analyze my_project -o reports
Support report annotations and add dynamic analyzer related annotations
CodeChecker is now able to parse additional fields from plist files especially relevant to dynamic analyses.
https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md#dynamic-analysis-results
<dict>
<key>diagnostics</key>
<array>
<dict>
<key>category</key>
<string>unknown</string>
<key>check_name</key>
<string>UndefinedBehaviorSanitizer</string>
<key>report-annotation</key>
<dict>
<key>testcase</key>
<string>yhegalkoei</string>
<key>timestamp</key>
<string>1970-04-26T17:27:55</string>
</dict>
<key>path</key>
<array>
...
</array>
</dict>
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 #3849, and the relevant docs PR #3871.
❗ Backward incompatible changes
- [cmd] Remove some deprecated flags. #3823
CodeChecker checkers --only-enabled DEPRECATED.
Show only the enabled checkers. use CodeChecker checkers --details to list the checker status (enabled/disabled)CodeChecker checkers --only-disabled.
use CodeChecker checkers --details to list the checker status.CodeChecker cmd diff -s, --suppressed DEPRECATED.
Lists the suppressed reports.
Use the--review-status [REVIEW_STATUS [REVIEW_STATUS ...]]
flag to filter the results.CodeChecker cmd diff --filter FILTER
DEPRECATED. Filter diff results.
Use the--review-status [REVIEW_STATUS [REVIEW_STATUS ...]]
flag
to filter the results.CodeChecker cmd sum --disable-unique
DEPRECATED. Use the '--uniqueing' option to get uniqueing results.
- [cmd] Remove the CodeChecker analyzer
--tidy-config flag
#3822CodeChecker analyze [--tidy-config TIDY_CONFIG]
DEPRECATED and removed.
Use theCodeChecker analyzers --analyzer-config clang-tidy
to list the analyzer options
Use e.g.CodeChecker analyze --analyzer-config clang-tidy:WarningsAsErrors=true
to set a parameter.
Alternatively you can use .clang-tidy config files too
- [analyzer] Promote the missing checker warning to an error #3820
- If a checker name given to
--enable/--disable
is not recognized (usually because of a typo) by any of the analyzers, CodeChecker now emits an error. While we strongly advise you against it, you can demote this error to a warning, restoring the behaviour similar to previous releases, with the flag--no-missing-checker-error
(#3866).
- If a checker name given to
🐛 Analyzer improvements
- ignore -fno-keep-inline-dllexport gcc option #3813
- Fix error using Clang option '-stdlib=libc++' #3808
- [fix] Fix a condition about checkers being compiler warnings #3838
- [analyzer] Promote the missing checker warning to an error #3820
- [fix] Pass arch flag correctly #3854
- [fix] Treat clang-diagnostic-* checkers as compiler flags #3874
- Forward --driver-mode compiler flag to the analyzer #3867
🔁 Profile changes
bugprone-standalone-empty
: default, extreme, sensitivebugprone-unsafe-functions
: extreme, security, sensitivecert-msc24-c
: alias ofbugprone-unsafe-functions
cert-msc33-c
: alias ofbugprone-unsafe-functions
cppcoreguidelines-avoid-capture-default-when-capturing-this
: extreme, sensitivecppcoreguidelines-avoid-capturing-lambda-coroutines
: default, extreme, sensitivecppcoreguidelines-avoid-reference-coroutine-parameters
: default, extreme, sensitivecppcoreguidelines-rvalue-reference-param-not-moved
: extreme, sensitivellvmlibc-inline-function-decl
: stylemisc-use-anonymous-namespace
: default, extreme, sensitive- Document the new checker misc-use-anonymous-namespace #3803
- [cfg] Assign new check profiles for 6.22RC1 #3861
💻 CLI/Server improvements
- Further enhancements to speed up the store procedure #3796
- Multiroot analysis #3815
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.
clangd and clang-tidy works this way: https://clangd.llvm.org/installation.html
This feature allows the analaysis of multi-root projects also in the vscode plugin Ericsson/CodecheckerVSCodePlugin#113
Previously the input of analysis was a compilation database JSON file. The of this PR is to support the following analysis invocations:
# Analyze one source file.
CodeChecker analyze main.c -o reports
# analyze all source files under a directory.
CodeChecker analyze my_project -o reports
- Support report annotations and add dynamic analyzer related annotations #3849
- Required format for --checker-config #3817
"CodeChecker analyze" command has a --checker-config flag. The parameter this flag should be in the following format:
<analyzer>:<checker>:<option>=<value>
. This format is checked and an error message is emitted if the format is not met. - [cmd] Gracefully exit instead of crashing when cmd diff is missing a param #3801
- cppcheck: allow spaces in path #3812
- [cmd] Fix a crash with CodeChecker cmd diff --unique on #3816
- [bugfix] Don't convert cppcheck parameters to absolute path #3821
- [cmd] Deprecate --warnings flag #3802
- [gui] Fix for filter product in gui test #3469
- [web] Fix stale permission caching #3840
🌳 Environment
- [req] Upgrade
lxml
to4.9.1
#3799 - Fix three bugs and a couple of style issues #3804
- Updates to setup.py/PyPI configuration #3819
- [test] Upgrade to Python 3.8 in GitHub Actions #3859
📖 Documentation updates
- README.md: add
python3-setuptools
dependency #3729 - [docs] Reword what labels, guidelines, checkers mean, and their enabling #3845
🔨 Other
v6.22.0-rc1
🌟 Highlights
Further enhancements to speed up the store procedure
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.
This should allow those that use CodeChecker in CI loops to see fewer timeouts due to long storages, or lower timeout tresholds significantly.
Multiroot analysis
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: https://clangd.llvm.org/installation.html#compile_commandsjson
This feature also affects the CodeChecker Visual Studio Code plugin, where analysis will be done on multiroot projects as well Ericsson/CodecheckerVSCodePlugin#113.
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:
# Analyze a single file.
CodeChecker analyze analyze.cpp -o reports
# Analyze all source files under a directory.
CodeChecker analyze my_project -o reports
Support report annotations and add dynamic analyzer related annotations
CodeChecker is now able to parse additional fields from plist files especially relevant to dynamic analyses.
<key>diagnostics</key>
<array>
<dict>
<key>category</key>
<string>Memory error</string>
...
<dict>
<key>timestamp</key>
<string>2000-01-01 10:00</string>
<key>testsuite</key>
<string>TS-1</key>
...
</dict>
</dict>
</array>
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: #3849.
❗ Backward incompatible changes
- [cmd] Remove some deprecated flags. #3823
- [cmd] Remove --tidy-config flag #3822
- [cmd] Remove some deprecated flags. #3823
CodeChecker checkers --only-enabled DEPRECATED.
Show only the enabled checkers. use CodeChecker checkers --details to list the checker status (enabled/disabled)CodeChecker checkers --only-disabled.
use CodeChecker checkers --details to list the checker status.CodeChecker cmd diff -s, --suppressed DEPRECATED.
Lists the suppressed reports.
Use the--review-status [REVIEW_STATUS [REVIEW_STATUS ...]]
flag to filter the results.CodeChecker cmd diff --filter FILTER
DEPRECATED. Filter diff results.
Use the--review-status [REVIEW_STATUS [REVIEW_STATUS ...]]
flag
to filter the results.CodeChecker cmd sum --disable-unique
DEPRECATED. Use the '--uniqueing' option to get uniqueing results.
- [cmd] Remove the CodeChecker analyzer
--tidy-config flag
#3822CodeChecker analyze [--tidy-config TIDY_CONFIG]
DEPRECATED and removed.
Use theCodeChecker analyzers --analyzer-config clang-tidy
to list the analyzer options
Use e.g.CodeChecker analyze --analyzer-config clang-tidy:WarningsAsErrors=true
to set a parameter.
Alternatively you can use .clang-tidy config files too
🐛 Analyzer improvements
- ignore -fno-keep-inline-dllexport gcc option #3813
- Fix error using Clang option '-stdlib=libc++' #3808
- [fix] Fix a condition about checkers being compiler warnings #3838
- [analyzer] Promote the missing checker warning to an error #3820
- [fix] Pass arch flag correctly #3854
🔁 Profile changes
bugprone-standalone-empty
: default, extreme, sensitivebugprone-unsafe-functions
: extreme, security, sensitivecert-msc24-c
: alias ofbugprone-unsafe-functions
cert-msc33-c
: alias ofbugprone-unsafe-functions
cppcoreguidelines-avoid-capture-default-when-capturing-this
: extreme, sensitivecppcoreguidelines-avoid-capturing-lambda-coroutines
: default, extreme, sensitivecppcoreguidelines-avoid-reference-coroutine-parameters
: default, extreme, sensitivecppcoreguidelines-rvalue-reference-param-not-moved
: extreme, sensitivellvmlibc-inline-function-decl
: stylemisc-use-anonymous-namespace
: default, extreme, sensitive- Document the new checker misc-use-anonymous-namespace #3803
- [cfg] Assign new check profiles for 6.22RC1 #3861
💻 CLI/Server improvements
- Further enhancements to speed up the store procedure #3796
- Multiroot analysis #3815
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.
clangd and clang-tidy works this way: https://clangd.llvm.org/installation.html
This feature allows the analaysis of multi-root projects also in the vscode plugin Ericsson/CodecheckerVSCodePlugin#113
Previously the input of analysis was a compilation database JSON file. The of this PR is to support the following analysis invocations:
# Analyze one source file.
CodeChecker analyze main.c -o reports
# analyze all source files under a directory.
CodeChecker analyze my_project -o reports
- Support report annotations and add dynamic analyzer related annotations #3849
- Required format for --checker-config #3817
"CodeChecker analyze" command has a --checker-config flag. The parameter this flag should be in the following format:
<analyzer>:<checker>:<option>=<value>
. This format is checked and an error message is emitted if the format is not met. - [cmd] Gracefully exit instead of crashing when cmd diff is missing a param #3801
- cppcheck: allow spaces in path #3812
- [cmd] Fix a crash with CodeChecker cmd diff --unique on #3816
- [bugfix] Don't convert cppcheck parameters to absolute path #3821
- [cmd] Deprecate --warnings flag #3802
- [gui] Fix for filter product in gui test #3469
- [web] Fix stale permission caching #3840
🌳 Environment
- [req] Upgrade
lxml
to4.9.1
#3799 - Fix three bugs and a couple of style issues #3804
- Updates to setup.py/PyPI configuration #3819
- [test] Upgrade to Python 3.8 in GitHub Actions #3859
📖 Documentation updates
- README.md: add
python3-setuptools
dependency #3729 - [docs] Reword what labels, guidelines, checkers mean, and their enabling #3845
🔨 Other
v6.21.0
🐛 Analyzer improvements
- [report-converter] Support Roslynator (#3765)
The Roslynator 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 .NET tool 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.
💻 CLI/Server improvements
- Make
CodeChecker store
about twice as fast (#3777)
This small change from a regex to a string search is expected to shave off the time it takes to run aCodeChecker store
command by as much as 50%! - [fix] Speed up resolved diffing (#3771)
This fixes the everlasting diff runtime, when the report count is large (~60000) and the ReviewStatusRule count is also substantial.
🔁 Profile changes
- [analyzer][clang][clang-tidy] Assign new check profiles (#3769)
bugprone-assignment-in-if-condition
: extreme (no longer in thesensitive
anddefault
profiles)bugprone-signal-handler
: default (new), security (new), sensitive, extremebugprone-suspicious-realloc-usage
(new): default, sensitive, extremebugprone-stringview-nullptr
(new): default, sensitive, extremebugprone-unchecked-optional-access
(new): extremecert-sig30-c
: removed from all profiles (as it is an alias to bugprone-signal-handler)cppcoreguidelines-avoid-const-or-ref-data-members
: sensitive (new), extremecppcoreguidelines-avoid-do-while
(new): extrememisc-const-correctness
: removed from all profiles (it was too extreme even for extreme)misc-misleading-bidirectional
: default, security (new), sensitive, extrememisc-misleading-identifier"
(new): default, security, sensitive, extremealpha.unix.Errno
: sensitive (new), extremecore.uninitialized.NewArraySize
(new): default, sensitive, extremealpha.unix.cstring.UninitializedRead
(new): extreme
📖 Documentation updates
- [analyzer][doc] Mention that Z3 as the constraint solver is highly unstable (#3772)
While LLVM supports the usage of Z3, that doesn't mean the same for the Clang Static Analyzer. It is a highly experimental feature that may or may not be generally available in a stable way, which is now better explained in the docs and in--help
messages. - [doc] Refurbish several parts of the
README
(#3763)- Self-advertise the CodeChecker GitHub CI action!
- Added the PLDI'2020 talk about CodeChecker to the papers section
- Moved information about Python 2 lower as it is no longer really an important thing in today's world
- Figure out the new LLVM monorepo commit for the referenced SVN commit that introduced Bug hashes to Clang SA
🔨 Other improvements/fixes
- Quick fix for cppcheck environment (#3744)
The cppcheck needs the original environment when invoked. This quick fix restores it at analyzer invocation. - [bugfix] Old client has different behavior with new server (#3746, #3747)
So far, we have supported the communication in between a CodeChecker server and almost all older CodeChecker clients versions. For CodeChecker servers on version 6.20.0, clients issueingCodeChecker cmd diff
to the server got an incorrect results, which this PR fixes. - [bugfix] Don't update review status date (#3749)
When a review status is set in the GUI then a new entry is inserted to review_statuses table. Every time the same report is stored, its review status date used to be updated, which was a bug, since the storage date is NOT the same as the review status date. - Document 'cppcoreguidelines-avoid-const-or-ref-data-members' (#3734)
- Document 'bugprone-suspicious-realloc-usage' (#3755)
- Escape &, <, > from the source C-files to HTML-output (#3748)
This fixed a bug whereCodeChecker parse --export html
produced an invalid HTMl file. - [feat] Comment lines in skipfile (#3768)
Hashmark (#) character can be used for commenting lines out in skipfiles, and can now be used for CodeCheckers skip files! - Issue a warning about this release being only an RC (#3780)
CodeChecker version now warns users about the current release being only a release candidate. Please create a bug report if you find anything wrong, so we can fix it for the proper release! - [fix] Ignore files that .gitignore ignores (#3785)
- Set "anywhere on path" in URL (#3783)
In the previous release, on the gui, when the "anywhere on path" filter was set, it wasn't saved in the URL. It is now! - [bugfix] Don't crash with intercept-build based compilation database (#3685)
CodeChecker was only really compatible with compilation databases where "command" was used instead of "arguments" as the actual command to execute. This is now fixed. - [db] Garbage collection of analysis_info timeout (#3775)
The garbage collection of analysis_info table has been restructured because the original query exceeded a 2min timeout.
v6.21.0-rc1
🐛 Analyzer improvements
- [report-converter] Support Roslynator (#3765)
The Roslynator 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 .NET tool 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.
💻 CLI/Server improvements
- Make
CodeChecker store
about twice as fast (#3777)
This small change from a regex to a string search is expected to shave off the time it takes to run aCodeChecker store
command by as much as 50%! - [fix] Speed up resolved diffing (#3771)
This fixes the everlasting diff runtime, when the report count is large (~60000) and the ReviewStatusRule count is also substantial.
🔁 Profile changes
- [analyzer][clang][clang-tidy] Assign new check profiles (#3769)
bugprone-assignment-in-if-condition
: extreme (no longer in thesensitive
anddefault
profiles)bugprone-signal-handler
: default (new), security (new), sensitive, extremebugprone-suspicious-realloc-usage
(new): default, sensitive, extremebugprone-stringview-nullptr
(new): default, sensitive, extremebugprone-unchecked-optional-access
(new): extremecert-sig30-c
: removed from all profiles (as it is an alias to bugprone-signal-handler)cppcoreguidelines-avoid-const-or-ref-data-members
: sensitive (new), extremecppcoreguidelines-avoid-do-while
(new): extrememisc-const-correctness
: removed from all profiles (it was too extreme even for extreme)misc-misleading-bidirectional
: default, security (new), sensitive, extrememisc-misleading-identifier"
(new): default, security, sensitive, extremealpha.unix.Errno
: sensitive (new), extremecore.uninitialized.NewArraySize
(new): default, sensitive, extremealpha.unix.cstring.UninitializedRead
(new): extreme
📖 Documentation updates
- [analyzer][doc] Mention that Z3 as the constraint solver is highly unstable (#3772)
While LLVM supports the usage of Z3, that doesn't mean the same for the Clang Static Analyzer. It is a highly experimental feature that may or may not be generally available in a stable way, which is now better explained in the docs and in--help
messages. - [doc] Refurbish several parts of the
README
(#3763)- Self-advertise the CodeChecker GitHub CI action!
- Added the PLDI'2020 talk about CodeChecker to the papers section
- Moved information about Python 2 lower as it is no longer really an important thing in today's world
- Figure out the new LLVM monorepo commit for the referenced SVN commit that introduced Bug hashes to Clang SA
🔨 Other improvements/fixes
- Quick fix for cppcheck environment (#3744)
The cppcheck needs the original environment when invoked. This quick fix restores it at analyzer invocation. - [bugfix] Old client has different behavior with new server (#3746, #3747)
So far, we have supported the communication in between a CodeChecker server and almost all older CodeChecker clients versions. For CodeChecker servers on version 6.20.0, clients issueingCodeChecker cmd diff
to the server got an incorrect results, which this PR fixes. - [bugfix] Don't update review status date (#3749)
When a review status is set in the GUI then a new entry is inserted to review_statuses table. Every time the same report is stored, its review status date used to be updated, which was a bug, since the storage date is NOT the same as the review status date. - Document 'cppcoreguidelines-avoid-const-or-ref-data-members' (#3734)
- Document 'bugprone-suspicious-realloc-usage' (#3755)
- Escape &, <, > from the source C-files to HTML-output (#3748)
This fixed a bug whereCodeChecker parse --export html
produced an invalid HTMl file. - [feat] Comment lines in skipfile (#3768)
Hashmark (#) character can be used for commenting lines out in skipfiles, and can now be used for CodeCheckers skip files! - Issue a warning about this release being only an RC (#3780)
CodeChecker version now warns users about the current release being only a release candidate. Please create a bug report if you find anything wrong, so we can fix it for the proper release!
v6.20.0
🐛 Analyzer improvements
- Cppcheck support (#3680)
Cppcheck is a static analyzer tool which is now driven by CodeChecker. Similar to Clang analysis, Cppcheck also can be configured and executed by CodeChecker. For configuration and execution see Configure Clang Static Analyzer and checkers Guide
Please note that you need to add cppcheck to your PATH (env var) before using it with CodeChecker.
WARNING: The analysis results depend on which cppcheck version you configured - Merge, and don't override when multiple --analyzer-configs are specified (#3655)
When multiple--analyzer-config
options are given to CodeChecker then only the last one was taken into account. From this version both are handled:--analyzer-config <option1> --analyzer-config <option2>
. The old format is also still available:--analyzer-config <option1> <option2>
. This is especially useful when you specify the base analysis parameters in the codechecker_config file and you want to override certain parameters in the command line.
💻 CLI/Server improvements
- Refactored Review Status Handling
-
Changed handling of in-code suppressions (e.g. //codechecker_suppress [ all ] This is a false warning) (#3580)
Review status is now connected to the individual reports instead of the (all reports) with the same report hash.
This makes it possible to mark a bug as a false positive on one branch (and store it in a run) and mark it as intentional on another branch.
Warning: The different handling of such rare cases can cause a change in the checker statistics. -
Changed handing of suppressions in the GUI (#3646)
If you handle suppressions in the GUI instead of the source code, the suppressions remain effective for all reports identified by the same bug hash. These are called "suppression rules". You can list and manage such rules in the "Review Status Rules" window:
-
Changed visualization of false positive and intentional reports in the Oustanding Reports Statistics
Outstanding report statistics excluded false positive reports from the graphs even for time periods, when these reports were active. After this change, the reports will be counted in the outstanding reports graphs until the time they were classified as false positive. So you will be able to see a decreasing trend in the outstanding reports graph, after you classify reports false positive.
-
- Find reports by file anywhere on bugpath (#3717)
In the GUI the set of reports can be filtered by filename or source
component. However, these filters are concerning the last bug point,
i.e. one can list the set of reports ending in a specific file.
A new filter option has been introduced which returns all reports where the file is involved at any part of the bug path.
- Fix storage of headers with same name in different paths (#3706)
When a header file occurred in multiple directories with the same name (for example multiple standard libraries at different locations are involved in the project) then only one of them was stored to the server. This has been fixed, so all instances are stored now. --trim-path-prefix
flag may now contain joker characters (#3674)
--trim-path-prefix
flag helps to remove a given prefix of each file path during report storage. This prefix may now contain joker characters too. The longest matching prefix will be eliminated from each file path.- Don't ignore compiler warnings, even if
clangtidy:take-config-from-directory=true
is specified (#3698)
clangtidy:take-config-from-directory
is an analyzer config that makes ClangTidy get its arguments from a.clang-tidy
file, and only from that
file. What this implies, is that all other options on the command line for ClangTidy will be ignored. The problem was that this also ignores compiler warnings, so it has been fixed. - Garbage collection enhancement in "files" table (#3710)
When a run storage and removal occurs concurrently with both referring the same file may result a foreign key constraint error on server side and storage fails. This has been fixed. - Import the suppressions per report (#3693)
CodeChecker cmd suppress run_name -i <import_file>
will only import suppressions for the run indicated byrun_name
, and not all reports in all runs. - Fix remote diff behavior (#369)
When two runs are compared then reports should be considered as closed even if their review status is false positive or intentional. - Speed up run deletion (#3700)
Sometimes run deletion is a slow operation due to cascades and such. So runs are deleted in separate transactions in order to avoid potential statement timeouts in a DBMS. - Get failed files with
CodeChecker cmd runs --details
(#3669)
This command now lists the files that are failed to analyze. - Fix storage of context-insensitive ClangSA reports (#3662)
In some cases ClangSA produced plists where an included file had a context-insensitive bug report at the exact same "file:row:col:checker", but different bug hash. Only one instance of these reports were stored before this release. - *Fix exceptions during blame information storage (#3647)
When the HEAD file exists in the.git
directory but the user who is running the CodeChecker store command doesn't have permission to this file then the storage failed. - Fix uniqueing compilation commands (#3635)
🔁 Profile changes
- The following checkers are added to the following profiles (#3714)
alpha.unix.Errno
: extremebugprone-assignment-in-if-condition
: default, sensitive, extrememisc-const-correctness
: extrememisc-confusable-identifiers
: default, sensitive, extrememodernize-macro-to-enum
: extreme
- All cppcheck checker from the error and warning category have been added to the default profile
📖 Documentation updates
- Refactoring the analyzer user guide (#3694)
- Checker documentation URLs have changed in ClangTidy (#3715)
- Fix some links in
README.md
(#3512) - Enhancement of the user guides related to the run comparison feature (#3696)
- Fix some CLI usage examples in the docs (#3666)
- Add documentation to the python thrift client example (#3652)
🔨 Other improvements/fixes
- Fix ctu extdef mapping file with space problem (#3653)
CodeChecker usesclang-extdef-mapping
utility during CTU analysis. This collects for each function definition in which file they have been defined. The format of this mapping file changed, and this change needs to be adapted in CodeChecker. - Adding
dev_package
make target (#3682)
This make target results symlinks in the build directory to the source files. This way it is not necessary to rebuild CodeCompass for each source code change during the development. Known issue:CC_LIB_DIR
needs to be set to.../build/CodeChecker/lib/python3
directory. - Fix install of PPA clang-tidy in config coverage job (#3678)
Fixing a broken installment in GitHub Actions. - Add a job that checks coverage of checker labelling (#3367)
- Minor improve some debug logs (#3659)
There was a debug log which could not be used for debugging, because the arguments containing whitespaces were not quoted properly. - Fix the incorrect run count on the product page (#3733)
Due to a bug in our caching strategy, the number of runs in a product displayed on the product page were sometimes higher than the actual count (which was corrently displayed in the bottom left of the run page). This occurred when multiple runs were deleted at once.
v6.20.0-rc1
🐛 Analyzer improvements
- Cppcheck support (#3680)
Cppcheck is a static analyzer tool which is now driven by CodeChecker. Similar to Clang analysis, Cppcheck also can be configured and executed by CodeChecker. For configuration and execution see Configure Clang Static Analyzer and checkers Guide
Please note that you need to add cppcheck to your PATH (env var) before using it with CodeChecker.
WARNING: The analysis results depend on which cppcheck version you configured - Merge, and don't override when multiple --analyzer-configs are specified (#3655)
When multiple--analyzer-config
options are given to CodeChecker then only the last one was taken into account. From this version both are handled:--analyzer-config <option1> --analyzer-config <option2>
. The old format is also still available:--analyzer-config <option1> <option2>
.
💻 CLI/Server improvements
- Refactored Review Status Handling
-
Changed handling of in-code suppressions (e.g. //codechecker_suppress [ all ] This is a false warning) (#3580)
Review status is now connected to the individual reports instead of the (all reports) with the same report hash.
This makes it possible to mark a bug as a false positive on one branch (and store it in a run) and mark it as intentional on another branch.
Warning: The different handling of such rare cases can cause a change in the checker statistics. -
Changed handing of suppressions in the GUI (#3646)
If you handle suppressions in the GUI instead of the source code, the suppressions remain effective for all reports identified by the same bug hash. These are called "suppression rules". You can list and manage such rules in the "Review Status Rules" window:
-
Changed visualization of false positive and intentional reports in the Oustanding Reports Statistics
Outstanding report statistics excluded false positive reports from the graphs even for time periods, when these reports were active. After this change, the reports will be counted in the outstanding reports graphs until the time they were classified as false positive. So you will be able to see a decreasing trend in the outstanding reports graph, after you classify reports false positive.
-
- Find reports by file anywhere on bugpath (#3717)
In the GUI the set of reports can be filtered by filename or source
component. However, these filters are concerning the last bug point,
i.e. one can list the set of reports ending in a specific file.
A new filter option has been introduced which returns all reports where the file is involved at any part of the bug path.
- Fix storage of headers with same name in different paths (#3706)
When a header file occurred in multiple directories with the same name (for example multiple standard libraries at different locations are involved in the project) then only one of them was stored to the server. This has been fixed, so all instances are stored now. --trim-path-prefix
flag may now contain joker characters (#3674)
--trim-path-prefix
flag helps to remove a given prefix of each file path during report storage. This prefix may now contain joker characters too. The longest matching prefix will be eliminated from each file path.- Don't ignore compiler warnings, even if
clangtidy:take-config-from-directory=true
is specified (#3698)
clangtidy:take-config-from-directory
is an analyzer config that makes ClangTidy get its arguments from a.clang-tidy
file, and only from that
file. What this implies, is that all other options on the command line for ClangTidy will be ignored. The problem was that this also ignores compiler warnings, so it has been fixed. - Garbage collection enhancement in "files" table (#3710)
When a run storage and removal occurs concurrently with both referring the same file may result a foreign key constraint error on server side and storage fails. This has been fixed. - Import the suppressions per report (#3693)
CodeChecker cmd suppress run_name -i <import_file>
will only import suppressions for the run indicated byrun_name
, and not all reports in all runs. - Fix remote diff behavior (#369)
When two runs are compared then reports should be considered as closed even if their review status is false positive or intentional. - Speed up run deletion (#3700)
Sometimes run deletion is a slow operation due to cascades and such. So runs are deleted in separate transactions in order to avoid potential statement timeouts in a DBMS. - Get failed files with
CodeChecker cmd runs --details
(#3669)
This command now lists the files that are failed to analyze. - Fix storage of context-insensitive ClangSA reports (#3662)
In some cases ClangSA produced plists where an included file had a context-insensitive bug report at the exact same "file:row:col:checker", but different bug hash. Only one instance of these reports were stored before this release. - *Fix exceptions during blame information storage (#3647)
When the HEAD file exists in the.git
directory but the user who is running the CodeChecker store command doesn't have permission to this file then the storage failed. - Fix uniqueing compilation commands (#3635)
🔁 Profile changes
- The following checkers are added to the following profiles (#3714)
alpha.unix.Errno
: extremebugprone-assignment-in-if-condition
: default, sensitive, extrememisc-const-correctness
: extrememisc-confusable-identifiers
: default, sensitive, extrememodernize-macro-to-enum
: extreme
- All cppcheck checker from the error and warning category have been added to the default profile
📖 Documentation updates
- Refactoring the analyzer user guide (#3694)
- Checker documentation URLs have changed in ClangTidy (#3715)
- Fix some links in
README.md
(#3512) - Enhancement of the user guides related to the run comparison feature (#3696)
- Fix some CLI usage examples in the docs (#3666)
- Add documentation to the python thrift client example (#3652)
🔨 Other improvements/fixes
- Fix ctu extdef mapping file with space problem (#3653)
CodeChecker usesclang-extdef-mapping
utility during CTU analysis. This collects for each function definition in which file they have been defined. The format of this mapping file changed, and this change needs to be adapted in CodeChecker. - Adding
dev_package
make target (#3682)
This make target results symlinks in the build directory to the source files. This way it is not necessary to rebuild CodeCompass for each source code change during the development. Known issue:CC_LIB_DIR
needs to be set to.../build/CodeChecker/lib/python3
directory. - Fix install of PPA clang-tidy in config coverage job (#3678)
Fixing a broken installment in GitHub Actions. - Add a job that checks coverage of checker labelling (#3367)
- Minor improve some debug logs (#3659)
There was a debug log which could not be used for debugging, because the arguments containing whitespaces were not quoted properly.
v6.19.1
🐛 Analyze fixes
- Disappearing
--stats
flag (#3630, #3633)
CodeChecker analyze
command has--stats
flag if there is at least one checker contatingstatisticsbased
in its name. We are using the checker listing function to determine the list of checkers but by default it excludes modeling checkers. This default behavior should be overridden when checking if underlying Clang supports statistics based checkers. - Add
-sdkroot
option to COMPILE_FLAGS structure (#3631)
A special downstream compiler duplicated the--sysroot
option, and CodeChecker is not aware of the option chosen by this downstream
compiler. Adding these entries enables CodeChecker to not drop or strip the arguments to this option when interpreted and driven from a
compile_commands.json
file.
🔨 Other fixes
- Add
pyyaml
dependency to the web part to fix docker container (#3626) - Fix snap package build (#3624)
For more information check the milestone.