Capturing results for printing or sharing

The Reviewer is designed to make it easy to review the results of an analysis and to process the proposed fixes. It is interactive in nature so that a developer can quickly triage the issues.

There are cases, however, when it would be helpful to view the bug summaries without requiring an online session. This may be the case if there are a large number of issues that the team wants to review offline. Or there may be summaries requested for management review whereby seeing the list of issues in pdf format would be helpful. The reviewer provides an option to do just that.

When any of the tabs are selected, that tab presents all of the bugs under that category: Unresolved, Accepted, Rejected or Fixed. At the top right of each window, there is a button labeled Print All. For example, here is the top of the Unresolved tab window:

Clicking on Print All will display a printable collection of all of the bugs within this category. In the case of the Rejected tab, all the of currently rejected bugs and the rejected bug history are displayed. This allows developers to review old, previously rejected bugs, offline if they desire.

The printout consists of 3 sections. The first is a brief summary of the analysis run with some basic information about the analysis. As an example, here is a sample summary display for all of the Unresolved issues:

This is followed by a summary of all of the bugs that were found sorted by severity. In our example, Unresolved bugs:

The third section is the display of all of the bugs that were found under this tab. They are presented in the same order as shown in the summary above. They are grouped by Fixer Category. Within each Fixer Category, each bug is then displayed with all of its details. The type of bug is shown along with the bug summary as it appears in the online Reviewer. The links to supporting material are not displayed since this is a printout and the links are not available.

Then the diffs for the detected problem and the corrections are shown. Similar to the Reviewer display, code that is to be deleted is shown in red font while the replaced code shows in a green font. For fixes that have changes to multiple files, all of the diffs for all affected files are displayed. See the sample bug listing for a sample display of a set of diffs for an Injection problem in Go-Temp.

Note: The Filter by Category applies equally well to the list of bugs to be printed. If you only want to print the bugs in a particular category, then choose only that category using Filter by Category. Only those will be copied to the pdf file.

The pdf file is either displayed in a separate window where you can review the display and choose to download the pdf file, or it is automatically downloaded to your browser’s default download directory. Typically, the preferences that you set in your browser will define what the browser will do when you select Print All. The filename for the printed report will be a unique name prefixed with iCR_ and a timestamp to keep it unique. For example:

iCR_Unresolved_master-30_5_2022-15_48_9.pdf