-
Improvement
-
Resolution: Postponed
-
Minor
-
Jenkins 2.387.3
Warnings Next Generation 10.2.0
I am passing a static analysis result file in sarif format to the Warnings Next Generation plugin, but the type details are not displayed. I would like the details to be displayed.
I use Warnings Next Generation like this in the jenkinsfile.
recordIssues enabledForFailure: true, tool: sarif(pattern: '**/target/*.sarif'), qualityGates: [[threshold: 1, type: 'NEW']], sourceDirectory: './project'
[JENKINS-71652] Create description for issues in sarif format
Komatsubara
added a comment - I want to view this details.
https://github.com/jenkinsci/warnings-ng-plugin/blob/master/doc/Documentation.md#issues-details
> Details: the details message for an issue (if provided by the corresponding static analysis tool) is shown as child row within the table.
A detailed link to the warning would be helpful. For example, here is the link:
https://docs.pmd-code.org/latest/pmd_rules_apex_security.html#apexsoqlinjection
Komatsubara
added a comment - I want to view this details.
https://github.com/jenkinsci/warnings-ng-plugin/blob/master/doc/Documentation.md#issues-details
> Details: the details message for an issue (if provided by the corresponding static analysis tool) is shown as child row within the table.
A detailed link to the warning would be helpful. For example, here is the link:
https://docs.pmd-code.org/latest/pmd_rules_apex_security.html#apexsoqlinjection This needs to be done on the parser side. I have no idea if this information is part of the sarif file or already supported by the parser.
Komatsubara
added a comment - Sarif file has `helpUri` and `ruleId` properties. So, I think only parser side should be supported.
Here is an example of a sarif generated in my environment.
{
"version": "2.1.0",
"$schema": "http://json.schemastore.org/sarif-2.1.0",
"runs": [
{
"tool": {
"driver": {
"name": "eslint-lwc",
"version": "8.43.0",
"informationUri": "https://eslint.org",
"rules": [
{
"id": "no-unused-vars",
"shortDescription": {
"text": "Disallow unused variables"
},
"properties": {
"category": "problem",
"severity": 2,
"normalizedSeverity": 1
},
"helpUri": "https://eslint.org/docs/latest/rules/no-unused-vars"
}
]
}
},
"results": [
{
"level": "error",
"ruleId": "no-unused-vars",
"ruleIndex": 1,
"message": {
"text": "'XXXXXXX' is assigned a value but never used."
},
"locations": [
{
"physicalLocation": {
"artifactLocation": {
"uri": "file:///xxxxx/hogehoge.js"
},
"region": {
"startLine": 282,
"startColumn": 29
}
}
}
]
},
{
"level": "error",
"ruleId": "no-unused-vars",
"ruleIndex": 1,
"message": {
"text": "'YYYYYYY' is assigned a value but never used."
},
"locations": [
{
"physicalLocation": {
"artifactLocation": {
"uri": "file:///xxxxx/hogehoge2.js"
},
"region": {
"startLine": 283,
"startColumn": 29
}
}
}
]
}
],
"invocations": [
{
"executionSuccessful": true,
"toolExecutionNotifications": []
}
]
}
]
}
Komatsubara
added a comment - Sarif file has `helpUri` and `ruleId` properties. So, I think only parser side should be supported.
Here is an example of a sarif generated in my environment.
{
"version" : "2.1.0" ,
"$schema" : "http: //json.schemastore.org/sarif-2.1.0" ,
"runs" : [
{
"tool" : {
"driver" : {
"name" : "eslint-lwc" ,
"version" : "8.43.0" ,
"informationUri" : "https: //eslint.org" ,
"rules" : [
{
"id" : "no-unused-vars" ,
"shortDescription" : {
"text" : "Disallow unused variables"
},
"properties" : {
"category" : "problem" ,
"severity" : 2,
"normalizedSeverity" : 1
},
"helpUri" : "https: //eslint.org/docs/latest/rules/no-unused-vars"
}
]
}
},
"results" : [
{
"level" : "error" ,
"ruleId" : "no-unused-vars" ,
"ruleIndex" : 1,
"message" : {
"text" : " 'XXXXXXX' is assigned a value but never used."
},
"locations" : [
{
"physicalLocation" : {
"artifactLocation" : {
"uri" : "file: ///xxxxx/hogehoge.js"
},
"region" : {
"startLine" : 282,
"startColumn" : 29
}
}
}
]
},
{
"level" : "error" ,
"ruleId" : "no-unused-vars" ,
"ruleIndex" : 1,
"message" : {
"text" : " 'YYYYYYY' is assigned a value but never used."
},
"locations" : [
{
"physicalLocation" : {
"artifactLocation" : {
"uri" : "file: ///xxxxx/hogehoge2.js"
},
"region" : {
"startLine" : 283,
"startColumn" : 29
}
}
}
]
}
],
"invocations" : [
{
"executionSuccessful" : true ,
"toolExecutionNotifications" : []
}
]
}
]
}
Which details?