This section explains general code review configuration options (options that apply to both pre-commit and post-commit processes).
Configuring Code Review Preferences
To configure Code Review preferences on every team Para installation:
- Choose Parasoft> Preferences to open the Preferences dialog.
- If you have not already done so, configure source control preferences as follows:
- Select the Parasoft> Scope and Authorship category in the left pane of the Preferences panel.
- Enable Use source control (modification author) to compute scope.
- Select the Parasoft> Source Control category in the left pane of the Preferences panel.
- Specify your team’s source control repository. See Connecting to Source Control for details.
If you have not already done so, configure Team Server preferences under Parasoft> DTP> Team Server.
If your Parasoft solution uses Team Server Named Accounts, ensure that Team Server user accounts can access the Team Server 'Code Review' directory. For details on opening the appropriate path permissions, see the 'Named Accounts' section of the PST Admin Guide.'
- To store code review data in Report Center (recommended for more efficient storage), specify the settings under Parasoft> DTP> Project Center (see Connecting to Project Center for details).
- (Desktop installations only) Select the Parasoft> Code Review category in the left pane, then complete the Code Review settings as follows:
- DTP Settings
Displays the DTP server host name you have configured. You can disable the Default checkbox to modify the port number.
- General Settings
- User name: Enter a unique Code Review name for the current user. The same user name specified here should also be specified in the Code Review Test Configuration.
- Show user assistant during scanner run: This enables a user assistant, which allows you to specify a task identifier, enter notes, specify review priority, and enter a specific reviewer or monitor for each Code Review run. This is intended for pre-commit code reviews.
- Notify me about new or updated reviews every ___ minutes: Select this if you want to be alerted when you need to review code and/or when code that you authored has been reviewed. This option is recommended.
- Show completed tasks by: If you want the code review tasks tree to show completed tasks as well as active ones, enable this option and specify the range of completed tasks you want shown. For example, if you want to see all tasks completed within the past week, choose 7 days.
- Compare Editor
- Reuse compare editor: If want Code Review to open each revision in the same editor, enable this option.
- Close compare editors on commit review action: If you want the compare editor to be closed when a revision is committed, enable this option.
- Show structural changes: If you want the compare editor to show structural changes, enable this option.
- Show suppressed parts: If you want the compare editor to show details from code excluded from analysis (as described in Hiding Differences for Specific Pieces of Code), enable this option.
- Show the newer source on the left | right: Specifies where the most recent source is positioned in the comparison editor.
- Opening Local Sources in Existing Projects
- Use source control to recognize local sources: If you want to allow Parasoft Test to use source control data in order to better recognize the sources found, enable this option.
- Always open without asking when path of a local source is different than remote path (single source matches only): If you want to force Parasoft test to always apply a local source path (if it is different than the remote one), enable this option.
- Show warning when the file has been changed since issue was created: If you want to receive warnings if the Code Review task becomes outdated (i.e., because the current source code has been modified since the Code Review task was created), enable this option.
- Appearance: Allows you to customize what labels are used in the code review task tree and determine whether tasks for multiple revisions of a file are merged.
- (Desktop installations only) Select the Parasoft> Code Review> Team category in the left pane, then complete the Code Review settings as follows:
Team Server storage is deprecated. To migrate data from Team Server to the current storage method (Report Center):
- Open the TCM Data Storage page in a web browser and go to the root folder for the tcm user account that was being used for code review.
- In the 'codereview' subfolder, set or change the value of the 'storage.type' property to 'db.storage.type'.
- Restart the IDE.
- In the preferences page described here (Preferences> Parasoft> Code Review> Team) click the Import button to transfer data from Team Server to Report Center.
7. Click Apply to apply your settings.
8. Click OK to set and save your settings.
Configuring Test Configurations for Scanning
Test Configurations control how code reviews are prepared, and the appropriate configuration varies depending on whether your team has a pre-commit or post-commit code review process.
Hiding Differences for Specific Pieces of Code
If you do not want the compare editor to show diffs that occur within specific blocks of code:
- Add the
codereview-begin-suppress comment at the point in the code where you want to stop showing differences.
- Add the
codereview-end-suppress comment at the point in the code where you want to resume reporting of differences.
By default, suppressed code will not be shown in diffs for related code review tasks (for example, a diff highlighting a code change immediately following or preceding suppressed code). If you later want to view the suppressed content in diffs:
- Choose Parasoft> Preferences to open the Preferences dialog.
- Select the Parasoft> Code Review category in the left pane.
- Enable the Show suppressed parts option.
If you want the code review scan to ignore all differences that occur between "codereview-begin-suppress" and "codereview-end-suppress" markers, enable Ignore changes within suppressed blocks in the Code Review> Filters tab.
Troubleshooting Unpublished or Skipped Reviews
If the Test Progress tab reports that reviews were not published, this is a sign that your configuration has undefined authors.
For example, assume that your code review results are as follows:
In this case, 2 files have been scanned and 2 revisions have been accepted—but there is no code review package to publish, because the scanned code had modifications made by "pietrek"—and the Test Configuration does not list pietrek in the Code Review> Authors tab.
To correct this problem:
- Add the author to the Test Configuration’s Code Review> Authors tab.
- Either assign a reviewer to review all code by this author, or assign a reviewer to the area of source code where this author’s revisions occur.
- Run the Test Configuration again.
If the results show that reviews were skipped (with undefined users and/or unmatched paths by author), this is a sign that the modified code is not properly assigned to a reviewer.
For example, assume that you have the following results
and that your report indicates the following:
You can resolve the problem by modifying the Test Configuration to either assign that area of code to a reviewer, or to assign a reviewer to all code modified by that author.
Understanding How Code Review Packages are Created
Each code review package is defined based on the author changes (commits).
- In post-commit code review, changes are collected when the automated scan runs each day.
- In pre-commit code review, the code author specifies which changes should be included in the package.
Any reviewers and monitors mapped to that author are then assigned to the package. If the package contains code from the project areas that other reviewers or monitors are set to review, those reviewers/monitors are also assigned to this package.
If a package is created and no reviewers or monitors are set to review the related author or project area, then no review tasks will be generated for that package.
Separate packages are not created for different paths (regions). As a result, reviewers assigned to different paths may be working on the same package. They should decide for themselves which paths they want to review. This maintains the integrity of tasks that may spread across multiple reviewers' assigned areas. If a reviewer wants to see which files in a package were matched to him because they belong to "his" assigned region, this information is available in the Code Review view.
Importing Code Review Data from Team Server to the DTP Report Center Database
It is more efficient to store network data in the DTP Report Center database instead of in flat files on Team Server. Team Server storage is supported for backward compatibility, but Report Center storage is strongly recommended.
To migrate code review data from Team Server to Report Center:
- Choose Parasoft> Preferences.
- Open Parasoft> Code Review> Team.
- Click Import, then complete the dialog that opens. This allows you to import all code review data or only packages from specified data range. If existing items are imported, they will be duplicated.
The average time needed to import one Code Review package from Team Server to the DTP database is approximately 30 seconds. A safe estimate is to assume that you can import about 2880 packages per day.