Fix missing job uuid in report, closes #864

- changed sereco product result transformer - does now set job uuid into reporting model (was missing) - changed existing pds integration test and check now for job uuid inside - added unit tests to check fallback handling - implemented fallback handling when no Job UUID in report JSON result (so old reports having no report job uuid inside will be repaired automatically)
mercedes-benz · Oct 29, 2021 · 5810a49 · 5810a49
1 parent f20bd6b
commit 5810a49
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 3 deletions.
diff --git a/...ub-integrationtest/src/main/java/com/daimler/sechub/integrationtest/api/AssertReport.java b/...ub-integrationtest/src/main/java/com/daimler/sechub/integrationtest/api/AssertReport.java
@@ -235,11 +235,15 @@ private List<SecHubFinding> assertFindings(SecHubReportData report) {
         assertNotNull(findings);
         return findings;
     }
-
-    public AssertReport hasJobUUID(String uuidAsString) {
-        assertEquals(UUID.fromString(uuidAsString), report.getJobUUID());
+    
+    public AssertReport hasJobUUID(UUID uuid) {
+        assertEquals(uuid, report.getJobUUID());
         return this;
     }
+
+    public AssertReport hasJobUUID(String uuidAsString) {
+        return hasJobUUID(UUID.fromString(uuidAsString));
+    }
 
     public AssertReport dump() {
         LOG.info("-----------------------------------------------------------");

diff --git a/...a/com/daimler/sechub/integrationtest/scenario10/PDSCodeScanSarifJobScenario10IntTest.java b/...a/com/daimler/sechub/integrationtest/scenario10/PDSCodeScanSarifJobScenario10IntTest.java
@@ -66,6 +66,7 @@ public void a_user_can_start_a_pds_sarif_scan_and_get_the_sarif_results_transfor
         assertReport(report).
             hasStatus(SecHubStatus.SUCCESS).
             hasMessages(0).
+            hasJobUUID(jobUUID).
             hasTrafficLight(RED).
                finding(0).
                    hasSeverity(Severity.HIGH).

diff --git a/...in/java/com/daimler/sechub/domain/scan/product/sereco/SerecoProductResultTransformer.java b/...in/java/com/daimler/sechub/domain/scan/product/sereco/SerecoProductResultTransformer.java
@@ -56,6 +56,7 @@ public ReportTransformationResult transform(ProductResult serecoProductResult) t
 
         ReportTransformationResult transformerResult = new ReportTransformationResult();
         transformerResult.setReportVersion(SecHubReportVersion.VERSION_1_0.getVersionAsString());
+        transformerResult.setJobUUID(sechubJobUUID);
 
         List<SecHubFinding> findings = transformerResult.getResult().getFindings();
 

diff --git a/sechub-scan/src/main/java/com/daimler/sechub/domain/scan/report/ScanSecHubReport.java b/sechub-scan/src/main/java/com/daimler/sechub/domain/scan/report/ScanSecHubReport.java
@@ -59,6 +59,11 @@ public ScanSecHubReport(ScanReport report) {
         if (ScanReportResultType.MODEL.equals(resultType)) {
             try {
                 model = SecHubReportModel.fromJSONString(report.getResult());
+                if (model.getJobUUID() == null) {
+                    // Fallback for problems when model did not contain job uuid - see https://github.com/Daimler/sechub/issues/864 
+                    LOG.warn("Job uuid not found inside report result JSON, will set Job UUID from entity data");
+                    model.setJobUUID(report.getSecHubJobUUID());
+                }
 
             } catch (JSONConverterException e) {
                 LOG.error("FATAL PROBLEM! Failed to create sechub result by model for job:{}", report.getSecHubJobUUID(), e);

diff --git a/sechub-scan/src/test/java/com/daimler/sechub/domain/scan/report/ScanSecHubReportTest.java b/sechub-scan/src/test/java/com/daimler/sechub/domain/scan/report/ScanSecHubReportTest.java
@@ -5,6 +5,7 @@
 
 import java.io.File;
 import java.util.List;
+import java.util.UUID;
 
 import org.junit.jupiter.api.Test;
 
@@ -18,6 +19,8 @@
 import com.daimler.sechub.commons.model.TrafficLight;
 import com.daimler.sechub.domain.scan.ScanDomainTestFileSupport;
 
+import static org.mockito.Mockito.*;
+
 class ScanSecHubReportTest {
 
     @Test
@@ -115,6 +118,52 @@ void scanreport_result_by_report_model_does_not_recalculates_traffic_light_but_u
         assertEquals(TrafficLight.GREEN, reportToTest.getTrafficLight());
     }
 
+    @Test
+    void report_by_model_sets_jobUUID_from_scanreport_when_not_inside_model() {
+
+        /* prepare */
+        UUID uuid = UUID.randomUUID();
+
+        ScanReport report = mock(ScanReport.class);
+        when(report.getResultType()).thenReturn(ScanReportResultType.MODEL);
+        when(report.getSecHubJobUUID()).thenReturn(uuid);
+
+        SecHubReportModel model = new SecHubReportModel();
+
+        String jsonResult = model.toJSON();
+        when(report.getResult()).thenReturn(jsonResult);
+
+        /* execute */
+        ScanSecHubReport createdReport = new ScanSecHubReport(report);
+
+        /* test */
+        assertEquals(uuid, createdReport.getJobUUID());
+    }
+
+    @Test
+    void report_by_model_has_jobUUID_from_model_when_there_not_null() {
+
+        /* prepare */
+        UUID uuid1 = UUID.randomUUID();
+        UUID uuid2 = UUID.randomUUID();
+
+        ScanReport report = mock(ScanReport.class);
+        when(report.getResultType()).thenReturn(ScanReportResultType.MODEL);
+        when(report.getSecHubJobUUID()).thenReturn(uuid1);
+
+        SecHubReportModel model = new SecHubReportModel();
+        model.setJobUUID(uuid2);
+
+        String jsonResult = model.toJSON();
+        when(report.getResult()).thenReturn(jsonResult);
+
+        /* execute */
+        ScanSecHubReport createdReport = new ScanSecHubReport(report);
+
+        /* test */
+        assertEquals(uuid2, createdReport.getJobUUID());
+    }
+
     @Test
     void report_by_model_sets_version_to_version_from_model() {