Generic formatted issue reports
On this page
If your third-party analyzer is not supported by SonarQube then you can import the reports by using the SonarQube generic issue format. No plugin is required.
The external issues will be taken into account by SonarQube in the analysis report, but the rules corresponding to these issues will not be visible on the Rules page nor reflected in quality profiles. This means that the rules that raise external issues must be managed in your third-party tool.
Setting up the import
- Set up the generation of the third-party reports in the generic issue format according to the specifications below.
- Set up the import of the report files by defining the analysis parameter
sonar.externalIssuesReportPathson the CI/CD host with the list of import directories or files. to define the list of report files to be imported during your project analysis. This parameter accepts a comma-delimited list of paths (A file path definition is either relative to thesonar.projectBaseDirproperty, which is by default the directory from which the analysis was started, or absolute.).
Generic issue format specifications
The issues report must contain, an array of Rule objects (rules) and an array of Issue objects. The figure below shows the different object types involved. The report fields for each object type are listed in the table below. For information about Clean Code attribute, software quality, and impact, see Clean Code.
The generic issue format has changed with SonarQube 10.3. The previous format is deprecated. If you use it, SonarQube will apply the following default values:
- For the
cleanCodeAttributefield: CONVENTIONAL - For the
softwareQualityfield: MAINTAINABILITY - For the
severityfield: MEDIUM
List of report fields
The table below lists the fields by object type of the generic issue report format.
| Object | Field | Format | Description | Mandatory |
|---|---|---|---|---|
| Rule | id | string | Rule identifier. | x |
name | string | Rule name. | x | |
description | string | Rule description. | ||
engineId | string | Identifier of the third-party analyzer that provides the rule. | x | |
cleanCodeAttribute | string | Clean Code attribute associated with the rule (code characteristic checked by the rule). Possible values:
| x | |
impacts | Array of Impact objects | List of software qualities to which the rule’s Clean Code attribute contributes with a specific impact. | x | |
| Issue | primaryLocation | Location object | Primary location of the issue in the code. | x |
effortMinutes | string | Evaluated issue solving time in minutes. Default value: 0 | ||
secondaryLocations | Array of Location objects | Secondary locations of the issue in case several places in the code are concerned. | ||
| Impact | softwareQuality | string | Software quality. Possible values:
| x |
severity | string | Associated level of impact. This level corresponds to the impact level of an issue raised through the rule. Possible values:
| x | |
| Location | message | string | Text message displayed at the location and describing the issue. | x |
filePath | string | Object used to locate the code to which the issue refers inside a file. | x | |
textRange | TextRange object | Object used to locate the code to which the issue refers inside a file. | For secondary locations only | |
| TextRange | startLine | string | Start line of the code to which the issue refers. | x |
endLine | string | End line of the code to which the issue refers. | ||
startColumn | string | Start column of the code to which the issue refers. | ||
endColumn | string | End column of the code to which the issue refers. |
Report file example
Below is an example of the expected format.
{
"rules": [
{
"id": "rule1",
"name": "just_some_rule_name",
"description": "just_some_description",
"engineId": "test",
"cleanCodeAttribute": "FORMATTED",
"impacts": [
{
"softwareQuality": "MAINTAINABILITY",
"severity": "HIGH"
},
{
"softwareQuality": "SECURITY",
"severity": "LOW"
}
]
},
{
"id": "rule2",
"name": "just_some_other_rule_name",
"description": "just_some_description",
"engineId": "test2",
"cleanCodeAttribute": "IDENTIFIABLE",
"impacts": [
{
"softwareQuality": "RELIABILITY",
"severity": "LOW"
}
]
}
],
"issues": [
{
"ruleId": "rule1",
"effortMinutes": 40,
"primaryLocation": {
"message": "fix the issue here",
"filePath": "file1.js",
"textRange": {
"startLine": 1,
"startColumn": 2,
"endLine": 3,
"endColumn": 4
}
}
},
{
"ruleId": "rule1",
"primaryLocation": {
"message": "fix the bug here",
"filePath": "file2.js",
"textRange": {
"startLine": 3
}
}
},
{
"ruleId": "rule1",
"primaryLocation": {
"message": "fix the bug here",
"filePath": "file3.js"
}
},
{
"ruleId": "rule1",
"primaryLocation": {
"message": "fix the bug here",
"filePath": "file3.js"
},
"secondaryLocations": [
{
"message": "fix the bug here",
"filePath": "file1.js",
"textRange": {
"startLine": 1
}
},
{
"filePath": "file2.js",
"textRange": {
"startLine": 2
}
}
]
},
{
"ruleId": "rule2",
"effortMinutes": 40,
"primaryLocation": {
"message": "fix the bug here",
"filePath": "file3.js"
},
"secondaryLocations": [
{
"message": "fix the bug here",
"filePath": "file1.js",
"textRange": {
"startLine": 1
}
},
{
"filePath": "file2.js",
"textRange": {
"startLine": 2
}
}
]
}
]
}Was this page helpful?
© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.
