fix: update types and field accessors for pvtr-sdk v1.24.0 output format

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>

Author: joanagmaia

services/apps/security_best_practices_worker/src/activities/index.ts

@@ -97,61 +97,59 @@ export async function saveOSPSBaselineInsightsToDB(
   const redisCache = new RedisCache(`osps-baseline-insights`, svc.redis, svc.log)
   const result = await redisCache.get(key)
   const parsedResult: ISecurityInsightsPrivateerResult = JSON.parse(result)
-  const evaluationSuite = parsedResult.evaluation_suites.find((s) => s.catalog_id === CATALOG_ID)
+  const evaluationSuite = parsedResult['evaluation-suites'].find(
+    (s) => s['catalog-id'] === CATALOG_ID,
+  )
 
   const qx = pgpQx(svc.postgres.writer.connection())
 
   await addEvaluationSuite(qx, {
     repo: repo.repoUrl,
     insightsProjectId: repo.insightsProjectId,
     insightsProjectSlug: repo.insightsProjectSlug,
-    catalogId: evaluationSuite.catalog_id,
+    catalogId: evaluationSuite['catalog-id'],
     name: evaluationSuite.name,
     result: evaluationSuite.result,
-    corruptedState: evaluationSuite.corrupted_state,
+    corruptedState: evaluationSuite['corrupted-state'],
   })
 
-  const suite = await findEvaluationSuite(qx, repo.repoUrl, evaluationSuite.catalog_id)
+  const suite = await findEvaluationSuite(qx, repo.repoUrl, evaluationSuite['catalog-id'])
 
-  for (const evaluation of evaluationSuite.control_evaluations) {
+  for (const evaluation of evaluationSuite['control-evaluations'].evaluations) {
+    const controlId = evaluation.control['entry-id']
     await addSuiteControlEvaluation(qx, {
-      controlId: evaluation['control-id'],
+      controlId,
       name: evaluation.name,
-      corruptedState: evaluation['corrupted-state'],
+      corruptedState: false,
       message: evaluation.message,
       repo: repo.repoUrl,
       insightsProjectId: repo.insightsProjectId,
       insightsProjectSlug: repo.insightsProjectSlug,
-      remediationGuide: evaluation['remediation-guide'] || '',
+      remediationGuide: '',
       result: evaluation.result,
       securityInsightsEvaluationSuiteId: suite.id,
     })
 
-    const controlEvaluation = await findSuiteControlEvaluation(
-      qx,
-      repo.repoUrl,
-      evaluation['control-id'],
-      suite.id,
-    )
-    for (const assessment of evaluation.assessments) {
+    const controlEvaluation = await findSuiteControlEvaluation(qx, repo.repoUrl, controlId, suite.id)
+    for (const assessment of evaluation['assessment-logs']) {
       await addControlEvaluationAssessment(qx, {
         applicability: assessment.applicability,
         description: assessment.description,
         message: assessment.message,
         repo: repo.repoUrl,
         insightsProjectId: repo.insightsProjectId,
         insightsProjectSlug: repo.insightsProjectSlug,
-        requirementId: assessment['requirement-id'],
+        requirementId: assessment.requirement['entry-id'],
         result: assessment.result,
-        runDuration: assessment['run-duration'] || '',
+        runDuration: '',
         steps: assessment.steps,
         stepsExecuted: assessment['steps-executed'] || 0,
         securityInsightsEvaluationId: controlEvaluation.id,
         recommendation: assessment.recommendation,
         start: assessment.start,
         end: assessment.end,
-        value: assessment.value,
-        changes: assessment.changes,
+        value: null,
+        changes: null,
       })
     }
   }

services/apps/security_best_practices_worker/src/types.ts

@@ -1,28 +1,30 @@
 export interface ISecurityInsightsPrivateerResult {
-  evaluation_suites: ISecurityInsightsPrivateerEvaluationSuite[]
+  'evaluation-suites': ISecurityInsightsPrivateerEvaluationSuite[]
 }
 
 export interface ISecurityInsightsPrivateerEvaluationSuite {
   name: string
-  catalog_id: string
-  start_time: string
-  end_time: string
+  'catalog-id': string
+  'start-time': string
+  'end-time': string
   result: string
-  corrupted_state: boolean
-  control_evaluations: ISecurityInsightsPrivateerResultControlEvaluations[]
+  'corrupted-state': boolean
+  'control-evaluations': {
+    result: string
+    evaluations: ISecurityInsightsPrivateerResultControlEvaluations[]
+  }
 }
 
 export interface ISecurityInsightsPrivateerResultControlEvaluations {
   name: string
-  'control-id': string
+  control: { 'reference-id': string; 'entry-id': string }
   result: string
   message: string
-  'corrupted-state': boolean
-  assessments: ISecurityInsightsPrivateerResultAssessment[]
+  'assessment-logs': ISecurityInsightsPrivateerResultAssessment[]
 }
 
 export interface ISecurityInsightsPrivateerResultAssessment {
-  'requirement-id': string
+  requirement: { 'reference-id': string; 'entry-id': string }
   applicability: string[]
   description: string
   result: string
@@ -31,8 +33,6 @@ export interface ISecurityInsightsPrivateerResultAssessment {
   'steps-executed': number
   start: string
   end?: string
-  value?: unknown
-  changes?: Record<string, unknown>
   recommendation?: string
 }