Code reviews

Required role  Campaign Management
Access  CodeChecker Server →  Campaign Configuration →  Code Reviews

Code reviews define the ensemble of rule sets that should be executed during a code review process. A code review must be associated with a target to create a campaign. When this campaign is launched, the rule sets defined in the code review are all executed on the associated target.

Example

You want to check the code quality of your application. You have defined quality rules to set code quality goals, and these quality rules are all grouped in the same rule set.

To execute the quality rules on the source code of your application, you need to create a code review to associate the rule set to that target application. You will then be able to generate campaigns using this code review and carry out the code review process.

Reference

For more information about rule sets, refer to Rule sets.

For more information about targets, refer to Targets.

For more information about campaigns, refer to Campaigns.

Code reviews

The  Code Reviews view is accessed from the  Campaign Configuration node in the Navigator.

Enter any combination of the above search criteria, then click the Search button to display the results. To display the complete list, click the Search button without entering any search criteria.

Follow the subsequent steps to create a new code review.

Step 1   To access the Create Code Review wizard, either click the  Create icon in the toolbar of the  Code Reviews search view, or right-click anywhere in the list and select  Create Code Review.

Step 2   Define the code review's Code and Name. These values are required to create a new code reviews. The Code cannot be changed once the code review is created, but the Name can be edited later.

Click Finish.

Result   The new code review is created and its editor opens automatically. It is displayed in the list in the  Code Reviews search view.

Important!

It is required to edit the new code review before using it.

To open a code review's editor, locate the code review in the  Code Reviews search view, then either:

  • double-click on the item in the view,
  • right-click on the item in the view and select  Edit, or
  • select the item in the view and click the  Edit icon in the toolbar.

The editable values are located in the  Code Review tab in the code review's editor. The  Measures tab allows you to declare the metrics that you wish to follow on the ARCAD CodeChecker dashboard. The  Schedules tab displays the list of schedules that use this code review. Double-click on a schedule to access its editor. The  Issues tab shows the pending issues linked to this code review.

Reference

For more information about the schedules linked to the code reviews, refer to Schedules.

For more information about the issues linked to the code reviews, refer to Issues.

Save the changes (, Ctrl+S or File > Save).

The Code Review editor

Code

This field displays the unique code review's ID defined when creating the code review. Once a code review is created, it is not possible to edit this code.

This code can be used in the ARCAD CodeChecker plug-ins for Jenkins and for SonarQube.

Name
The code review's name should reflect the context of the code quality analysis to be easily identified
Description
Use this description to give as many details as possible about the ensemble of rule sets included in the code review
Campaign Identifier Template

Define the default identifier to assign to every campaign that is created using the code review. This code will be the campaign's ID.

Use the variable $i in this field to track the number of campaigns created using the code review. The variable is incremented by one every time a new campaign is created.

Send Recap After Execution

When this box is checked, a recap is sent by email every time a campaign that uses this code review is launched. This recap is sent to the addresses listed in the Emails field. Add as many email addresses as needed in the Emails field, separated with semicolons.

This recap email contains the same information as the results displayed in a campaign's editor.

Reference

For more information about accessing and understanding campaign results, refer to Understanding campaign results.

This section enables you to manage the rule sets included in the code review.

To add a rule set to the code review, click  Add. In the  Rule Sets selection dialog, select one or several sets [Ctrl+click] then click OK.

Important!

Only activated rule sets can be added to a code review. The rule sets that are not activated will not be displayed in the  Rule Sets selection dialog.

Reference

For more information about activating rule sets, refer to Activating rule sets.

To remove a rule set from the code review, select the item and click  Remove.

This section enables you to declare the metrics that you wish to follow on ARCAD Dashboard.

The list of metrics defined in the  Code Reviews editor is evaluated during a campaign execution and the history of the results are kept between each campaign execution. When measures are calculated, the results are kept in relation to the target defined for the campaign.

Example

You run a modernization set of quality rules on your source code, but you still wish to monitor some general aspects of your development like the number of lines or the number of comments in your code.

Define the metrics you wish to monitor in the code review and display the results in a dashboard.

Note

The metrics of the quality rules added to the code review are also measured for ARCAD Dashboard.

To add a metric to the measure list, click  Add. In the Metrics selection dialog, select one or several metrics [Ctrl+click] then click OK.

To remove a metric from the measure list, select the item and click  Remove.

Reference

For more information about ARCAD Dashboard, refer to the documentation.

Warning!

Deleted code reviews cannot be recovered. It is not possible to delete a code review if it is used in one or several campaigns and/or schedules.

To delete a code review, either right-click on it in the  Code Reviews search view and select  Delete, or select it and click the  Delete icon in the toolbar. Click OK to confirm or click Cancel to keep the code review.