Releases: Ericsson/codechecker
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.
v6.19.0
❗❗❗ Backward incompatible changes ❗❗❗
- Fix JSON format of CodeChecker version subcommand (#3558)
The output of theCodeChecker version -o json
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 documentation. - Not allowing disabling modeling checkers in ClangSA (#3323)
When aClang Static Analyzer
checker is disabled in CodeChecker, clang is invoked with theanalyzer-disable-checker
flag. This allows the user disabling core modeling checkers such asunix.DynamicMemoryModeling
. This causes malfunctioning of depending checkers.
From this releasemodeling
anddebug
checkers (listed withclang -cc1 -analyzer-checker-help-developer
) will not be listed and cannot be disabled through CodeChecker with the--enable
and--disable
flags.
They can be enabled/disabled through the Clang Static Analyzer specific--saargs
flag only. - Change minimum supported
node
version (#3581, #3586)
The minimum supported node version to build CodeChecker after this release is>=14.17.0
.
⭐ New features
- Add
print-steps
option toCodeChecker cmd diff
command (#3555)
Without bug steps it is hard to understood the problem by a programmer. With this commit we will introduce a new option for theCodeChecker cmd diff
command which can be used to print bug steps similar what we are doing at theCodeChecker parse
command. This patch also solve the problem to print bug steps in HTML files for reports which comes from a CodeChecker server. - Support yaml CodeChecker configuration files (#3602)
Multiple subcommands have a--config
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 onlyJSON
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 supportYAML
format:For more information see the documentation.analyzer: # Enable/disable checkers. - --enable=core.DivideZero
💻 CLI / Server improvements / fixes
- Allow
--file
andskipfile
option to be given together and analyze header file (#3616)
The CodeChecker VSCodePlugin uses the--file
parameter to analyze single files. Large projects load in their configuration using the--config
parameter and if there is a-i skipfile
given in the config,CodeChecker analyze
call drops an error. From this release CodeChecker will allow-i skipfile
and--file
to be given together.
Also if a header file is given to the--file
option CodeChecker under the hood will try to figure out which source files are depends on the given header file and we will analyze these source files. - Allow escaping
:
in run names with\:
(#3536)
In certain scenarios, the run name might contain a:
character that does NOT separate a tag from a name. Commands such asserver
andcmd results
accept:
as a literal in the name, butcmd diff
previously cut it as the "run tag" separator. - Update allowed TLS versions (#3594)
TLS1
andTLS1.1
were deprecated in RFC8996. From this release CodeChecker will enforce the newerTLS1.2
orTLS1.3
. - Fix HTML generation for CodeChecker cmd diff command (#3600)
If the diff command result contained reports from multiple source files (e.g.:a.cpp
+b.cpp
) theCodeChecker cmd diff
command in HTML format generated HTML files for each source file but inserted the same list of reports in all of the HTML files. From this release CodeChecker will insert only those reports to a generated HTML file which are really related to that file. - Relative doc url to absolute file path (#3609)
Convert relativedoc_url
value's to absolute file paths in theCodeChecker checkers
output. This way other tools can open and view these documentation files easily. - Fix html generation for report directory without plists (#3610)
Fix HTML generation for report directory which doesn't contain any analyzer result (plist) file.
🔁 Profile changes
- The following checkers are added to the following profiles (#3621)
bugprone-shared-ptr-array-mismatch
:default
,extreme
,sensitive
misc-misleading-bidirectional
:default
,extreme
,sensitive
readability-container-contains
:default
,extreme
,sensitive
- The following checkers are removed from the following profiles (#3618)
cppcoreguidelines-narrowing-conversions
:extreme
🐛 Analyze improvements / fixes
- Proper handling of multi-target build (#3598)
- Prefer ldlogger over intercept-build (#3605)
- Quote command line segment using shlex (#3578)
- Fix ldlogger escaping a bunch of characters (#3589)
- Handle relative file paths in compilation database (#3587)
- Avoid plist filenames being the same (#3588)
- Proper exit code for
CodeChecker check
in case of exception (#3603). - Print info message about logger tool (#3573)
- Add severity for
readability-duplicate-include
(#3592)
📖 Documentation updates
- Update documentation with multiple source code comments in the same line (#3597)
- Highlight that user must be logged in before token generation (#3599)
- List possible severity levels for JSON report format (#3604)
- Extend documentation with implicitly disabled checkers under
--enable-all
(#3611) - Added link to basic database setup (#3541)
- Fix grammatical and spelling errors in documentations (#3557)
- Mention CodeChecker vscode extension in the docs (#3585)
🔨 Other improvements / fixes.
- Thrift Python client example (#3575)
- No rebuild on satisfied requirements (#3547)
- Port LD-logger tests to python (#3153)
- Fix compile warnings, missing return statements, etc. (#3590)
- Fix the prepare debug scripts (#3614)
- Upgrade
python-ldap
to3.4.0
(#3550) - Upgrade
lxml
to4.7.1
(#3553) - Upgrade
npm
packages (#3581, #3586) - Upgrade python version to
3.9.7
in docker image (#3591)
For more information check the milestone.
🎉 CodeChecker VSCode plugin
We are proud to announce the official release of CodeChecker VSCode plugin.
🌟 Main features
- Run CodeChecker analysis from the editor and see the results automatically.
- Re-analyze the current file when saved.
- Commands and build tasks for running CodeChecker as part of a build system.
- Browse through the found reports and show the reproduction steps directly in the code.
- Navigate between the reproduction steps.
💻 Trying It Out
- Install CodeChecker version
6.18.2
or later and optionally add it to thePATH
environment variable. - Install CodeChecker extension from the Visual Studio Marketplace, from Open VSX or download manually from Downloads.
- Check the path to CodeChecker and set your preferred command-line arguments - see Configuring CodeChecker for more information.
- Open your project, and run an analysis, or browse through the found reports!
v6.18.2
🐛 Analyze fixes
- Fix skipping reports (#3559).
When a skip list was set, not only those reports were skipped that were included in the skipped files, but also those that had a bug path traversing a skipped file. This resulted in disappeared findings. - Fix static HTML report files (#3570).
It was not always possible to navigate in the static HTML files, when the bug path traversed multiple files. - Remove
bugprone-easily-swappable-parameters
fromsensitive
profile (#3579).
The checker warns for a bugprone coding style at function definitions. It is mostly useful for new code, where new functions are being defined. On the other hand, the checker required too many changes in legacy projects with non-matching coding style.
💻 CLI / Server fixes
- Fix suppressing bug on the server (#3563).
When the report was in multiple lines, the source code comments in the code were not taken into consideration. - Fix source line / file for remote reports (#3568).
An exception was thrown atCodeChecker cmd diff
when path trimming was used in the stored results. - Fix storage of control points (#3576).
Not all of the control points were stored to the server, because the plist format what the report converter produced and the plist parser expected was invalid. This way when an analyzer result file was stored to the server, bug path arrows were missing from the GUI. - Escape values for v-html attributes (#3549).
We are usingv-html
attribute on the UI side to dinamically rendering comments and analyzer commands. This can be very dangerous because it can easily lead to XSS vulnerabilities. To solve this problem the server will always return the escaped version of these values which can be safely rendered on the UI. - Fix link in gerrit output (#3572).
IfCC_REPORT_URL
is defined andgerrit
format is used atCodeChecker parse
orCodeChecker cmd diff
commands, the output will contain the value of this environment variable wrapped inside quotes. When this output is sent to gerrit, it will convert URL links to HTMLa
tags. Unfortunately gerrit will think that the ending quote is part of the URL, so it will not remove it. This way the URL will be invalid. - Change permission of stored analysis failure files (#3574).
Change permission of the stored analysis failure zip files so only the current user/group will have access to this file.
For more information check the milestone.
v6.18.1
🐛 Analyze improvements / fixes
- Add label for file
markdownlint
(#3505). - Include
cppcoreguidelines-virtual-class-destructor
in profiles (#3532). - Add
bugprone-unhandled-exception-at-new
to default profile (#3531).
💻 CLI / Server improvements / fixes
- Add
--file
filter option forCodeChecker parse
command (#3454). - Add checker documentation URLs to static HTML files (#3539).
- Fix html output of CodeChecker parse (#3524, #3538).
- Handle missing database file ids for file paths (#3508).
- Simplify query for Other source component (#3534).
- Improve cli store log (#3533).
- More info logs at server for storage API request (#3509).
- Use print_exc at store command (#3511).
- Fix number of outstanding reports chart (#3544).
- Fix whitespace in run name links (#3529).
- Print broken pipe errors properly (#3516).
📖 Documentation updates
- Update the Usage Guide with failed zips (#3503).
- Add taint analysis documentation (#3522).
- Add new features section for
6.18.0
release (#3530). - Mention more details in the build instructions (#3517).
- Documentation for parse JSON output (#3519).
🔨 Other improvements / fixes.
- Fix building snap package (#3496).
- Add static files to the pypi package (#3502).
- Fix running docker container with existing volume (#3540).
- New build argument (
CC_REPO
) for docker image (#3543). - Fix non-deterministic test in plist to html (#3545).
- Upgrade
lxml
to4.6.4
(#3528).
For more information check the milestone.
💡 Hints
📀 1. Installing CodeChecker
CodeChecker can be installed and used from multiple repositories:
For more information see the installation guide.
🗄️ 2. Storage of multiple analyzer results
CodeChecker can be used as a generic tool for visualizing analyzer results of multiple static and dynamic analyzers:
- C/C++: Clang Static Analyzer, Clang Tidy, Clang Sanitizers, Cppcheck, Facebook Infer, cpplint etc.
- Java: SpotBugs, Facebook Infer.
- Python: Pylint, Pyflakes.
- JavaScript: ESLint
- TypeScript: TSLint
- Go: Golint
- Markdown: Markdownlint
For details see supported code analyzers documentation and the Report Converter Tool.
v6.18.0
❗❗❗ Backward incompatible CLI change ❗❗❗
The JSON
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 sarif format as well (http://docs.oasis-open.org/sarif/sarif/v2.0/csprd01/sarif-v2.0-csprd01.html). For this reason we changed the format of the JSON
output of the CodeChecker parse
and CodeChecker cmd diff
command. The new format is described in #3519.
New features
Get access controls (#3476)
Create a new global role (PERMISSION_VIEW
) which will be used to allow the users to fetch access control information from a running
CodeChecker server by using the CodeChecker cmd permissions
subcommand.
Analyze improvements / fixes
- Uplifting label file for clang 13 (#3485).
- Add label files for sanitizers (#3471).
- Add labels for compiler warnings (#3483).
- Add labels for some supported report converters (#3484).
- Fix check for response files (#3474).
- Use -imacros flag instead of -macros (#3428).
- Ignore
-mfp16-format
,-fmacro-prefix-map
,-fno-defer-pop
,-fstack-usage
flags (#3433, #3445). - Add misra c guideline (#3489).
- Removing cppcoreguidelines-virtual-class-destructor from the profiles (#3494).
CLI / Server improvements / fixes
- Add confidentiality classification to the product config (#3405)
- Jump to checker docs automatically (#3455).
- Support newline in analysis info (#3490).
- Fix run name link in report info (#3477).
- Fix console error on reports page (#3478).
- Fix weird file path filter (#3479).
- Fix getting checker labels for 'unknown' analyzer (#3491).
- Change required permission to view access for some API request (#3440).
- Fix getting git commit url (#3453).
- Update blame info (#3488).
Other improvements / fixes.
- Refactoring code for sarif support (#3462).
- Fix duplication warning when collecting blame info (#3446).
- Upgrade mkdocs to 1.2.3 (#3472).
- Use clang-13 in the CI, uplift tests accordingly (#3475).
- Add github action to publish snap package (#3492).
- Install common requirements on venv_dev target (#3493).
- Mention venv_dev target in the main readme file (#3480).
- Do not skip building the UI code when creating a pypi package (#3461).
- Small typo fix (#3434)
For more information check the milestone.
v6.17.0
New features
Git blame integration (#3398, #3423, #3425, #3430)
With this feature it will be possible for a developer to check who modified the source line last where a CodeChecker error appears.
- If the project which was analyzed is a git repository
CodeChecker store
command will store blame information for every source files which are not stored yet. - The GUI will have a button on the report detail view to show blame information alongside the source file.
- 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.
Cleanup plans (#3419)
Cleanup plans can be used to track progress of reports in your product. The conception is similar to the github Milestones.
You can do the following:
- Managing cleanup plans: you can create cleanup plans by clicking on the pencil icon at the Cleanup plan filter on the Reports page. A pop-up window will be opened where you can add, edit, close or remove existing cleanup plans.
- Add reports to a cleanup plan: you can add multiple reports to a cleanup plan on the Reports page or on the Report detail page by clicking to the Set cleanup plan button and selecting a cleanup plan.
Note: you can remove reports from a cleanup plan the same way by clicking on the cleanup plan name. - Filter reports by cleanup plans: you can filter reports by a cleanup plan by using the Cleanup plan filter on the Reports page. Using this filter with other filters (Detection status, Review status etc.) you will be able to filter active / resolved reports in you cleanup plan.
Local diff workflow support (#3388)
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:
- Analyze your project to a report directory as usual (e.g.:
./reports
). - Create a baseline file from the reports which contains the legacy findings:
CodeChecker parse ./reports -e baseline -o reports.baseline
. Note: it is recommended to store this baseline file (reports.baseline
) in your repository. - On source code changes after your project is re-analyzed use the
CodeChecker diff
command to get the new reports:
CodeChecker cmd diff -b ./reports.baseline -n ./reports --new
- On configuration changes (new checkers / options are enabled / disabled, new CodeChecker / clang version is used, etc.) re-generate the baseline file (step 1-2).
LeakSanitizer Parser (#3368, #3375)
The report-converter
tool is extended with LeakSanitizer which is a run-time memory leak detector for C programs.
# 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
For more information see.
Checker label (#3233, #3413, #3414, #3415, #3432)
Previously the properties of checkers (severity, profile, guideline) 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 config/labels directory. The goal of these labels is that you can enable or disable checkers by these labels.
# 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
Note: with this new feature we also added severity levels for pylint (#3414) and cppcheck (#3415) analyzers.
Analyze improvements / fixes
- Allow to override checker list (#3203).
- Handle clang binary without installed dir (#3186).
- Don't hardcode GCC in build-logger Makefile (#3352).
- Improve debug log messages (#3361).
- Remove the MallocOverflow checker from the sensitive profile (#3392).
- Add the MallocOverflow checker to the extreme profile (#3400).
- Create new diagnostic message hash (#3402).
- Build log transformer: also ignore -fno-reorder-functions (#3411).
- Don't run ClangSA checkers from clang-tidy (#3417).
CLI (parse, diff, etc.) improvements / fixes
- Parse command exits with error in case of duplicated suppress comment (#3253).
- Make parse subcommand to work with --skip option correctly (#3328).
- Log options from the configuration file (#3341).
- Do not print sensitive information when exception happens (#3355).
- Add severity to CodeClimate export (#3356).
- Improve log messages for gerrit output (#3374).
- Fix gerrit output (#3378).
- Fix check command config file support (#3385).
Server improvements / fixes
- Use processes instead of threads (#3349).
- Product View Permission (#3332).
- Add index for report and run history id columns (#3351).
- Unzip storage zip file to workspace directory (#3347).
- Log run id when storing a run (#3358).
- Comment date collision (#3360).
- Fix exporting checker statistics to CSV (#3362).
- Rephrase "report not found" error message (#3376)
- Create columns for product details (#3382).
- Fix setting analysis_info_id_seq (#3383).
- Add 'thrift==0.13.0' dependency explicitly (#3389, #3394).
- Show edit option only for admins (#3426).
Other improvements fixes.
- Add local package to git automatically and refactore the doc (#3319).
- Fix pypi package github action (#3344).
- include package data files in python package (#3357).
- Remove doxygen requirement (#3346).
- Update checker_and_analyzer_configuration.md (#3350).
- Web docker image hooks (#3359).
- Add wait-for script to the docker image (#3364).
- Change permission of helper script in docker image (#3365).
- Usage of skip list handler is not optional anymore (#3366).
- Fix broken alembic urls (#3390).
- Documentation for Pypi package (#3391).
- Add the severity for "readability-identifier-length" (#3403).
- Override argparse error code (#3408).
- Extend documentation with multi storage feature (#3420).
- Test workspace is not necessarily under HOME (#3421).
- Add the license file to the pypi package (#3422).
- Add new features for 6.16.0 and 6.17.0 releases (#3427).