Page tree

Skip to end of metadata
Go to start of metadata

In this section:

Suppressing Findings in the IDE

You can suppress individual instances of findings, all instances of a finding type in a file, or all findings in the file from the Findings view.

  1. Right-click on a single finding or a group of selected findings and choose Suppress from the menu.

  2. Enter a reason for suppressing the finding and choose where the suppression will be stored.

    You can select one of the following storage options:

      • the finding locally on desktop - The suppressions will be stored in your workspace or solution and used only during local analysis runs. If you select this option, it will suppress all occurrences of the selected finding in the file (the number of occurrences will be displayed in the dialog box).You can configure the custom location for storing local suppression with the suppression.local.dir option; see Automation User Guide for details.
      • in Development Testing Platform- The suppressions will be stored in Development Testing Platform and shared with the team.
      • in source code - The findings will be suppressed in code and shared across the team when checked in your source control system.

  3. Click OK to complete the suppression.

Reviewing Suppressions

You can review suppressed findings and unsuppress the findings that have been saved locally on desktop. 

  1. Click Parasoft in the menu bar, choose Options (Visual Studio) or Preferences (Eclipse),select Import Findings and Coverage and enable the Suppressed findings from local analysis or file option (see Customizing Import Options for details).

  2.  Open the DTP Findings view, choose Configure Contents from the menu and enable the Suppressed findings option (see Customizing the Findings View for details).

  3. Run analysis or import findings (see Importing Findings). The suppressed findings will be displayed in the DTP Findings view.


  4. You can right-click a finding and choose the Go To option to view the code that triggered the finding.
  5. Unsuppress findings if necessary. Suppressions that are saved in the code need to be unsuppressed manually in the code. Suppressions stored in DTP can be unsuppressed in DTP. To unsupress locally suppressed findings, right-click on a finding or a group of selected findings and choose Unsuppress locally... from the menu:


Manually Suppressing Findings in Source Code

C++test allows you to define suppressions directly in the source code, using the following directives embedded in C or C++ style comments:

  1. parasoft-suppress <ruleid> [<ruleid> ...] ["<comment>"]: Creates a suppression for the current line only (line with suppression directive)
  2. parasoft off: Suppresses the reporting of all static analysis violations that occur between this line of code and the end of the file.
  3. parasoft on: Remove the suppression of the reporting of all static analysis violations that occur between this line of code and the end of the file.
  4. parasoft suppress/unsuppress [line <linewildcard>][class <classnamewildcard>] [file <filenamewildcard>] [item <ruleid>][type <severity>] [reason <comment>]: Creates a suppression with the desired parameters.
    Examples
    line *, line 10, line 50-*
    class MyClass, class *
    file *example.cpp, file *ex*.cpp
    item SECURITY-02
    type SV
    reason "Not relevant to my code."

    The above elements (line, class, file, etc.) can be combined together by separating each entry with a space (for example, item * class MyClass line 10-*).
    <filenamewildcard> must be specified as an absolute path to a file.

Example A:
/* parasoft suppress item SECURITY-02 */
This suppresses reporting of violations reported by the SECURITY-02 rule in the current file, starting from the line where the suppression is located.
Example B:
/* parasoft unsuppress item * class MyClass line 10-* */
This unsuppresses all items for class MyClass in the current file starting from line 10.
Example C:
/* parasoft unsuppress item SECURITY-02 file *example.cpp */
This removes the suppression of reporting of violations reported by the SECURITY-02 rule in the current filein any file that is in the current compilation unit and has a file path that matches the *example.cpp file name pattern.
Example D:
/* parasoft suppress all */
This suppresses all messages in the current file starting from the line where this directive was entered.
Example E:
void foo(); /* parasoft-suppress SECURITY-02 */
void bar(); // parasoft-suppress SECURITY-03 "Not relevant to my code."
This suppresses item SECURITY-02 on the line with "foo" declaration and item SECURITY-03 on the line with "bar" declaration with the reason "Not relevant to my code."
Example F:
/* parasoft off */
/* parasoft unsuppress line 30-45 */
This suppresses everything, then unsuppress lines 30 to 45.

Additional Notes

  • When no item is specified, the (un)suppression will be applied to all rules. This is equivalent to specifying item *.
  • When no file is specified, the (un)suppression will be applied only to the current file.
  • When no line is specified, the (un)suppression will be applied starting from the line that contains the directive.
  • To suppress files with whitespaces in their names, quotes should be used. For example: parasoft suppress file "*file with whitespace.cpp"
  • Putting a suppression with the file * pattern in a header file makes it valid for all the files that include that header file. When no file is specified, suppression will be applied only to that header.
  • The parasoft-suppress directive is quite distinct from the other parasoft on, parasoft off, and parasoft suppress/unsuppress directives. parasoft-suppress suppresses only the current line (the line with the directive) and uses different syntax than the other directives.
 

 

  • No labels