feat: add util for scan tool, severity count and total count

Author: arunjaindev

src/Shared/Components/Security/Vulnerabilities/Vulnerabilities.tsx

@@ -15,13 +15,12 @@
  */
 
 import { useEffect } from 'react'
-import { EMPTY_STATE_STATUS, SCAN_TOOL_ID_CLAIR, SCAN_TOOL_ID_TRIVY } from '@Shared/constants'
-import { SeverityCount } from '@Shared/types'
+import { EMPTY_STATE_STATUS } from '@Shared/constants'
 import { Progressing, useAsync } from '../../../../Common'
 import { ScannedByToolModal } from '../../ScannedByToolModal'
 import { VulnerabilitiesProps } from './types'
 import { SecuritySummaryCard } from '../SecuritySummaryCard'
-import { getSeverityCountFromSummary, getTotalSeverityCount } from '../utils'
+import { getScanToolAndSeverityCount } from '../utils'
 import { getSecurityScan } from '../SecurityModal/service'
 
 const Vulnerabilities = ({
@@ -83,14 +82,7 @@ const Vulnerabilities = ({
         )
     }
 
-    const scanToolId =
-        scanResultResponse?.result.imageScan.vulnerability?.list[0].scanToolName === 'TRIVY'
-            ? SCAN_TOOL_ID_TRIVY
-            : SCAN_TOOL_ID_CLAIR
-    const scanResultSeverities = scanResultResponse?.result.imageScan.vulnerability?.summary.severities
-    const severityCount: SeverityCount = getSeverityCountFromSummary(scanResultSeverities)
-
-    const totalCount = getTotalSeverityCount(severityCount)
+    const { scanToolId, severityCount, totalCount } = getScanToolAndSeverityCount(scanResultResponse?.result)
 
     if (!totalCount) {
         return (

src/Shared/Components/Security/utils.tsx

@@ -1,25 +1,30 @@
 import { SeverityCount } from '@Shared/types'
-import { SeveritiesDTO } from './SecurityModal/types'
-
-export const getTotalSeverityCount = (severityCount: SeverityCount): number => {
-    const totalCount =
-        (severityCount.critical || 0) +
-        (severityCount.high || 0) +
-        (severityCount.medium || 0) +
-        (severityCount.low || 0) +
-        (severityCount.unknown || 0)
-    return totalCount
-}
-
-export const getSeverityCountFromSummary = (
-    scanResultSeverities: Partial<Record<SeveritiesDTO, number>>,
-): SeverityCount => ({
-    critical: scanResultSeverities?.[SeveritiesDTO.CRITICAL] || 0,
-    high: scanResultSeverities?.[SeveritiesDTO.HIGH] || 0,
-    medium: scanResultSeverities?.[SeveritiesDTO.MEDIUM] || 0,
-    low: scanResultSeverities?.[SeveritiesDTO.LOW] || 0,
-    unknown: scanResultSeverities?.[SeveritiesDTO.UNKNOWN] || 0,
-})
+import { SCAN_TOOL_ID_CLAIR, SCAN_TOOL_ID_TRIVY } from '@Shared/constants'
+import { ScanResultDTO, SeveritiesDTO } from './SecurityModal/types'
 
 export const getCVEUrlFromCVEName = (cveName: string): string =>
     `https://cve.mitre.org/cgi-bin/cvename.cgi?name=${cveName}`
+
+export const getScanToolAndSeverityCount = (
+    scanResult: ScanResultDTO,
+): { scanToolId: number; severityCount: SeverityCount; totalCount: number } => {
+    const scanToolId =
+        scanResult.imageScan?.vulnerability?.list?.[0].scanToolName === 'TRIVY'
+            ? SCAN_TOOL_ID_TRIVY
+            : SCAN_TOOL_ID_CLAIR
+
+    const severities = scanResult.imageScan?.vulnerability?.summary?.severities
+
+    const severityCount: SeverityCount = {
+        critical: severities?.[SeveritiesDTO.CRITICAL] || 0,
+        high: severities?.[SeveritiesDTO.HIGH] || 0,
+        medium: severities?.[SeveritiesDTO.MEDIUM] || 0,
+        low: severities?.[SeveritiesDTO.LOW] || 0,
+        unknown: severities?.[SeveritiesDTO.UNKNOWN] || 0,
+    }
+
+    const totalCount =
+        severityCount.critical + severityCount.high + severityCount.medium + severityCount.low + severityCount.unknown
+
+    return { scanToolId, severityCount, totalCount }
+}