Codeinsight extra (#28)

* adding fields for details and link for CodeInsights

* updating python oracle

* escaping strings and extended error message

* update version

Co-authored-by: Martin Schaef <schaef@amazon.com>

Author: martinschaef

.github/workflows/self-test-and-release.yml

@@ -64,7 +64,7 @@ jobs:
         if: steps.iam-role.outcome == 'success'
         shell: bash
         env:
-          EXPECTED: 98
+          EXPECTED: 102
         run: |
           [[ $(jq -r '.runs[0].results[].ruleId' code-guru/recommendations.sarif.json | wc -l) -eq $EXPECTED ]] || { echo "Expected $EXPECTED recommendations but got $(jq -r '.runs[0].results[].ruleId' code-guru/recommendations.sarif.json | wc -l)"; exit 1; }
 

build.gradle

@@ -23,7 +23,7 @@ repositories {
 
 defaultTasks 'clean', 'check', 'installDist'
 
-version = '0.2.1'
+version = '0.2.3'
 jar.archiveName = "${jar.baseName}.${jar.extension}"
 distZip.archiveName = "${jar.baseName}.zip"
 

src/main/java/com/amazonaws/gurureviewercli/model/bitbucket/CodeInsightsAnnotation.java

@@ -44,4 +44,8 @@ public class CodeInsightsAnnotation {
     private String summary;
 
     private String severity;
+
+    private String details;
+
+    private String link;
 }

src/main/java/com/amazonaws/gurureviewercli/util/CodeInsightExport.java

@@ -50,15 +50,16 @@ public static void report(final Collection<RecommendationSummary> recommendation
                                        .data(new ArrayList<>())
                                        .build();
 
-        val annotations = recommendations.stream().map(r -> convert(r, reportTitle))
+        val annotations = recommendations.stream().map(r -> convert(r, reportTitle, url))
                                          .collect(Collectors.toList());
 
         JSON_MAPPER.writeValue(outputDir.resolve(REPORT_FILE_NAME).toFile(), report);
         JSON_MAPPER.writeValue(outputDir.resolve(ANNOTATIONS_FILE_NAME).toFile(), annotations);
     }
 
     private static CodeInsightsAnnotation convert(final RecommendationSummary recommendation,
-                                                  final String reportTitle) {
+                                                  final String reportTitle,
+                                                  final String url) {
         String description = recommendation.recommendationCategoryAsString();
         if (recommendation.ruleMetadata() != null) {
             description = recommendation.ruleMetadata().shortDescription();
@@ -70,6 +71,8 @@ private static CodeInsightsAnnotation convert(final RecommendationSummary recomm
                                      .path(recommendation.filePath())
                                      .line(recommendation.startLine())
                                      .summary(description)
+                                     .details(recommendation.description())
+                                     .link(url)
                                      .annotationType("Vulnerability".toUpperCase())
                                      .severity(convertSeverity(recommendation.severity()))
                                      .build();