In this section:
The Violations Explorer is an interface for systematically reviewing static violations and facilitating remediation. All static analysis violations widgets drill down to the Violations Explorer.
When running static analysis on multiple branches using the same run configuration, the same instance of a violation will be reported across builds as a new violation. As a result, widgets that present changes in the number of violations will not be accurate. You can change this behavior by Configuring Static Analysis Settings. |
The Violations Explorer is made up of four main parts:
Violations stored in DTP are searchable by several parameters. Use the search area to hone in on specific types of violations. You can change the criteria in the search area to find violations throughout your development projects.
Click the Change Search button to open the search dialog and configure your search criteria. The following search criteria are available:
Filter Build | A filter and build ID are the minimum criteria for searching violations. By default, the latest build is selected when you change the filter, but you can choose a different build from the drop-down menu. The build selected functions as a target build when a baseline build is selected. See the following sections for additional information: |
|---|---|
Baseline Build State | A baseline build is any historical build used for comparison with another build. Choose a baseline build from the drop-down menu to search for violations reported from the baseline build to the build selected with the filter. You can search for new, fixed, or existing violations by choosing a state from the State drop-down menu. |
| Severity | You can search by one or more severity levels. Severity is determined by the test configuration. You can customize the severity level associated with a rule by creating a rule map. See Configuring Code Analysis Rules for additional information. |
| Priority | You can search by one or more assigned priorities. Priorities can be customized through the REST API. |
| Author | You can search by one or more code authors. Authorship is determined from the settings in the code analysis tool. |
| Assignee | You can search by one or more assignees. |
| Action | You can search by one or more assigned actions. Actions can be customized through the REST API. |
| Type | You can search for regular violations, suppressed violations, or all violations. |
| Resource Groups | A resource group is a collection of resources (i.e., files and/or folders) defined by a set of one or more Ant file patterns. You can search by one or more resource groups. Resource groups can be defined through the REST API. |
Include File Pattern Exclude File Pattern | You can specify Ant patterns to narrow or broaden the scope of your search. See Searching for Violations by File for details on configuring file patterns. |
| Risk/Impact | You can search by one or more risk/impact values. Risk/impact is the extent to which a violation impacts the business. Risk/impact can be customized through the REST API. |
| Reference Number | You can constrict your search to a specific reference number. Reference numbers can be added manually or automated through the REST API. |
| Category | You can search by one or more static analysis categories. Static analysis rules are organized into categories, but you can define or remap rules and categories by creating a rule map. See Configuring Code Analysis Rules for additional information. |
| Module | You can search by one or more specific modules. |
| Rule | You can search by one or more code analysis rules enabled in the test configuration. |
| Limit | You can set a limit for the number of violations shown in the Violations Explorer. |
You can search for a file and return the violations found in the file. The following table provides examples of how to set file paths.
| Value | Result |
|---|---|
| test | Returns all violations with file paths containing the string "Test", for example:
But not:
|
| com/ex | Returns all violations with file paths containing the string "com/ex", for example:
But not:
|
| com/parasoft/** | Returns all violations in the "com/parasoft" directory tree, for example:
But not:
|
| **/test/*.java | Returns all violations in files with the ".java" suffix under test directories from anywhere in the directory tree, for example:
But not:
|
Click on a violation in the search results table to view the violation as it exists in the code.
You can configure DTP to display sources from source control or sources sent by connected Parasoft tools during code analysis and test execution. See Configuring Source Code Views for additional information on how sources are displayed in DTP.0
The search results panel returns any violations found according to the search parameters.
Click on a violation to view the content of the source file, details about the violation, and enable actions for remediation. When you make a selection in the violations table, the file name and the component that opened the file appear in the code panel.
You can also use the sorting mechanisms and customize the table to refine your view of the violation data. See Navigating Explorer Views for details.
By default, the maximum number of violations shown is 1000. You can change the limit by adding the &limit=[number] parameter to the URL. For example, the following URL would allow you to see up to 2000 violations:
[DTP_HOME]/grs/dtp/explorers/violations?filterId=11&limit=2000
You can set the limit parameter to any value, but changing the maximum number of violations shown to a large value may affect the performance of the Violation Explorer.
The sources panel allows you to view violation instances as they appear in the code. You must have permissions to view source code in Report Center explorer views (see Configuring User Permissions and Groups for additional information).
Mouse over the marker in the line number margin to view a tooltip with the violation error message.
Mouse over the information icon to see where sources are being displayed from.
You can also see paths through the code leading to the violation in the code panel when you use the flow analysis trace feature.
See Viewing Flow Analysis Traces for additional information about viewing code in the Violations Explorer.
There are several tools in the Violations Explorer to help you address violations in a way that’s consistent with your organization’s policies, needs, and goals. You can put violations into a software quality workflow through the Prioritization panel.
Users must have permissions to prioritize violations, as well as view sources. Permission to prioritize violations can be granted for all violations or limited to violations owned by the user. The following table describes a project membership scenario and how permissions may be assigned (see Permissions for additional information):
|
You can connect a project in DTP to a project in one of the following requirements/issue tracking systems:
The integration enables you to create issues in the integrated ALM system from violations in the Prioritization panel.
| Project | The name of the ALM project in which the new issue will be created appears in the Project field. The association between a DTP project and the external ALM project is defined by your DTP administrator. See the following sections for details: |
|---|---|
| Type | Choose the type of item to create from the drop-down menu. Terminology varies across ALMs, but DTP supports the following types of work items by default:
|
| Title/Summary | By default, the violation header is used as the value for the issue title (VersionOne) or summary (Jira, Jama Connect, Polarion ALM, codeBeamer ALM, TeamForge), but you can make any necessary changes. |
| Description | Details about the violation, including File, Line, Message, Severity, etc., are added to the issue description by default, but you can make any additional changes. The description will also include a link back to DTP based on the Display URL field setting in the External Application configuration page. |
An issue will be created in your external system that links back to the violation in DTP. Additionally, a link to the issue will appear in the Prioritization tab, create a bi-directional path between DTP and your external system.
You can assign violations to other authors of violations or a member of the Project associated with the Filter.
When DTP receives a violation for the first time, the value of the Assignee field is copied from the Author field. The value of the Author field is determined from either the authorship settings configured in the tool's .properties configuration file or from the source control management (SCM) system. If authorship is not configured, then the Author is set to the user logged into the machine that executed the analysis. Refer to your tool documentation for additional information.
Authorship may be changed when another developer modifies the code containing the violation and the analysis is sent to DTP. The value of the Assignee field, however, remains consistent unless the violation is reassigned manually in the Violations Explorer view.
The Assignee can also be reset to "null" using the DTP REST API. Resetting the Assignee enables DTP to automatically set a new assignee it receives a new report containing the violation.
Send a POST request to the /resetViolationMetadata endpoint to reset all prioritization metadata fields for a build to their default values. Authentication is required to use the API endpoint. The user must also have administrator privileges. The following cURL example shows how to call the endpoint:
curl -X POST -u <USERNAME>:<PASSWORD> "<PROTOCOL>://<HOST>:<PORT>/grs/api/v1.5/admin/staticAnalysis/resetViolationMetadata?buildId=<BUILD_ID>" |
The Assignee field for violations in the build will be set to null in the database. You will not be able to make changes in the Prioritization tab until a user has been assigned to a violation. Users will automatically be assigned the next time Data Collector loads a report for the violations.
Parasoft supports several workflows for suppressing violations. DTP or "server-side" suppressions are applied from the in Prioritization tab of the Violations Explorer view. DTP suppressions are stored in DTP and do not affect the source code when violations are imported to a Parasoft tool user's IDE as findings.
DTP suppressions differ from in-file and in-code suppressions, which are applied by the tool user and stored locally. Refer to the tool documentation for details about applying in-file and in-code violations.
Violations that have been suppressed using the in-code or in-file method will be labeled in the Prioritization and Details tab. You can also add the Suppression Type column to the search results table. See Navigating Explorer Views for information on how to add and remove columns in explorer views.
An action is a string of metadata for defining how you choose to remediate a reported violation. DTP ships with a set of pre-defined actions: None, Fix, Reassign, Review, Suppress, and Other. You can edit or remove the predefined action types (except for the None type) using the /staticAnalysisViolations/metadata API endpoint. For details on configuring actions, choose API Documentation from the Help drop-down menu in the Report Center navigation bar.
The Actions field is also a significant part of the machine learning functionality. See Using the Machine Learning Feature for details.
The Violations Explorer allows you to flag violations that pose a risk or have an impact on the policy goals associated with your application.
When you update a violation, you can apply the change to a single instance of the violation or apply the changes to the violation in all source control branches in which it occurs. A confirmation message appears when your changes are applied:
All changes applied to violations can be viewed in the actions panel, which provides a detailed view of historical information associated with selected violations. Rule documentation for a selected violation is also available.
Click the Modification History tab in the Actions panel to view a summary of prioritization changes, such as re-assignments and impact level changes, for the violation. You can not view the modification history of two or more violations.
Enable the Only show comments option to hide all updates except for the comments log.
Click the Violation History tab in the Actions panel to view the static analysis runs and the dates in which the selected violation was detected. You can not view the violation history of two or more violations.
The tab also shows the source control history associated with the violation. The same violation may exist in multiple branches under different violation IDs. Choose a branch from the Violations in Branch drop-down menu to view the history of the selected violation in other branches.
The table in the Violation History will be refreshed if you switch to a different branch, but other areas of the Violations Explorer will continue to show information for the selected instance of the violation.
The violation history table will be empty if the build information was removed from DTP, i.e., during regular database pruning or manual deletion.
Click the Traces tab to view flow analysis results or CDD (code duplicate detection) analysis rules if either type of analysis was performed.
If data flow analysis (dynamic analysis) has been performed, the path leading up to a violation appears under the Traces tab. Flow analysis can help you make decisions about how the code is structured, understand why the violation may have occurred, and determine the significance of the violation.
Click on a trace to view the violation path in the code panel.
Users must have permissions to view source code. See Permissions for additional information.
If DTP received the flow analysis report from C/C++test, dotTEST, or Jtest version 10.4.1 or later, the flow analysis trace will include annotations, which provide additional information about the code in the trace. Annotations appear in green text and are marked with flow analysis trace icons and color-coded statements that provide specific information about the flow as it relates to the error:
Clicking on a point in trace shows the corresponding source code in the sources panel. The sources panel also shows the annotations and color-coded highlights to provide a clear indication of how the code flow resulted in an error. For additional information, see the rule documentation for specific flow analysis violations.
If violations were detected by CDD (code duplicate detection) analysis rules, then you can view them in the Traces tab. Duplicate code may indicate poor application design, as well as increase maintenance costs. Click on a CDD violation in the Violations Explorer search results panel to open the violation path.
This panel shows the file name, line number, and path to each instance of the duplicated code. DTP also shows the sources containing the duplicate code in the sources panel.
You must have permissions to view the source code. See Permissions for additional information.
Click on entries in the Code Duplications Detected panel to view instances of the duplicated code.
You can perform normal violation remediation actions, such as setting a priority and assigning the violation to a developer. See Addressing Violations.
Click the Documentation tab to view the static analysis rule that the code violates. You can not view the rule documentation for two or more violations.
Click the Details tab in the Actions panel to view current information about the location, owner, rule ID, and message associated with the selected violation.
The Violation ID field appears if a violation is selected in the search results table. The ID links directly to the violation and the selected filter. You can share this link so that others can directly access view the violation in DTP.
If the violation has been suppressed, the suppression information will also appear in the Details tab (also see Suppressing Violations).
Determining the significance of static analysis violations and whether resources should be allocated to fixing them can slow down the software development lifecycle. The machine learning feature is an interface for teaching DTP how to recognize code analysis violations that should be fixed. This accelerates the violation remediation process by enabling DTP to predict which violations should be fixed and by whom as new code analysis data is reported.
The Predict Violations to Fix feature analyzes violations that have been classified as Fix and Suppress in the Actions field of the Prioritization tab (see Assigning Actions to Violations) and builds a predictive model based on patterns it detects. After the model has been built, DTP will predict which violations in the build should be assigned the Fix action. A balanced set of at least 20 violations must be classified as Fix and Suppress to build the predictive model. The model gradually improves as you continue to review violations and assign them actions.
The Recommend Assignees feature analyzes fixed and suppressed violations from previous builds and builds a predictive model. After the model has been built, DTP will predict who should work on the violations in the build based on who has worked on violations in the past.
You will need to execute the prediction action for new violations sent to the build. Additionally, you will need to review and train DTP on the violations if you switch the filter.
A license is required to use the machine learning functionality. Contact your Parasoft representative for additional information.
The machine learning interface is available for administrator users or team leaders. Refer to Team Membership for information about team and leader permissions.
The machine learning feature analyzes code analysis reports using a set of criteria to determine which actions should be taken, but you can enable the code analysis tools to include additional metadata to enable advanced analysis. The additional metadata broadens the set features used to predict actions, resulting in more accurate predictions.
Advanced metadata is enabled in the test configuration. If you manage test configurations in DTP, you can enable the option in the test configurations editor (also see Configuring Test Configurations):
You can also use the test configuration editor shipped with the tool to enable the advanced metadata option for local code analysis. Refer to your tool's documentation for details.
This feature analyzes violations that have been classified as Fix and Suppress in the Actions field of the Prioritization tab (see Assigning Actions to Violations) and builds a predictive model based on patterns it detects. After the model has been built, DTP will predict which violations in the build should be assigned the Fix action. A balanced set of at least 20 violations must be classified as Fix and Suppress to build the predictive model. The model gradually improves as you continue to review violations and assign them actions.
The wizard guides you through the following process:
If the Classify violations based on history option is enabled, DTP will classify violations in the database that have been fixed or suppressed, resulting in one of the following outcomes:
A healthy prediction model is essential for DTP to make reliable predictions. If the classification process results in a Poor or Moderate model, then you should continue classifying violations until the model health improves. See About Prediction Health for additional information. If you used the Fast or Normal mode to train the model and are unsatisfied with the quality of the model, retrain the model and choose either the Deep or Deepest training mode option.
DTP uses the following algorithms to train the model:
The Fast and Deep training mode options use the k-NN and Naive Bayes algorithms, which have shown to be the fastest algorithms for processing static analysis data. But because only two algorithms run, DTP will also have fewer options when determining the best training model.
The Normal and Deepest training modes use all algorithms, which will take longer than the other options to process the data. Using all algorithms, however, provides DTP with the most information for determining the best training model.
The Fast and Normal training mode options limit the number of violations used to train the model to 1000. This enables DTP to train faster, especially if you have a large set of classified violations. Reducing the data sample size, however, may affect the overall quality of the model.
The Deep and Deepest training use all classified violations available to train the model. As a result, these options have the potential to produce the best possible model. Allow several more minutes for the training process to complete, however, if your project contains a very large set of classified violations.
After you have classified violations and trained and applied the predictive model, the Predicted Action field appears in the Prioritization tab. If DTP predicts that the violation should be fixed, a value of "Fix" will appear in the field, as well as a value indicating how confident DTP is that the predicted action is correct based on the model.
If the Fix action has not been predicted for the violation, the Predicted Actions field shows Not available.
You can look at the Predicted Action column in the search results table so that you can sort violations according to DTPs recommendations.
You can drag the column to the position in the table that best suits your needs. Refer to the Navigating Explorer Views chapter for additional information about customizing the Violations Explorer view.
The health of the predictions DTP makes depends on the number of violations you process and the quality of the data you provide. DTP requires at least 20 violations to be assigned an action, but processing more violations will improve prediction health. If you have not provided enough data, DTP will not be able to make a prediction. The model informing DTP predictions also depends on the accuracy and consistency of the data you provide. DTP uses advanced algorithms to analyze the data associated with each violation, but it can only make quality predictions based on quality inputs. Assigning too many of one type of action also affects the prediction results. You should assign an equal number Fix and Suppress actions to facilitate prediction health.
You can help Parasoft improve the system by using the API to get Machine Learning data and sending the data to your Parasoft representative. Sensitive information, such as username and project name, is obfuscated in the response. Save the output from the following API endpoints are available to retrieve the Machine Learning data:
This endpoint returns static analysis violations used to train the model and prediction results.
Pass your user name and password as when sending the request. See Example.
http:<host>:<port>/grs/api/v1.7/ml/staticAnalysis/classificationResultsSets
GET
The following table describes the parameters available for this endpoint.
| Parameter | Description | Type | Required |
|---|---|---|---|
sortOrder | Specifies the order in which the data is returned by ID. Data is assigned IDs in sequential order, so newer data has a larger ID number. You can specify the following values:
| string | optional |
limit | Specifies the maximum number of result sets to return. The default is no limit. | integer | optional |
| Specifies the number of result sets to skip in the response. Default is If the database has three result sets and the | integer | optional |
curl -X GET -u username:password "http://dtp.mycompany.com:8443/grs/api/v1.7/ml/staticAnalysis/classificationResultSets?sortOrder=desc&limit=10" > myResultSets.json |
This endpoint returns actions assigned to the violations used to train the model.
http:<host>:<port>/grs/api/v1.7/ml/staticAnalysis/violationActionHistory
GET
None.
curl -X GET -u username:password "http://dtp.mycompany.com:8443/grs/api/v1.7/ml/staticAnalysis/violationActionHistory" > myViolationActionHistory.json |
The wizard guides you through the following process:
After you have applied the predictive model to recommend assignees, the Recommended Assignee column appears in the search results table. The column shows which user DTP recommends should work on this violation as well as a value indicating how confident DTP is that the recommended assignee is correct based on the model. Note that this column is sortable so that you can sort violations according to DTP's recommendations.
