Cleanup test output for generate-report

Author: jdalton

src/commands/scan/generate-report.test.ts

@@ -66,7 +66,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a sick report with alert when an alert violates at error', () => {
@@ -130,7 +130,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(false)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report with alert when an alert violates at warn', () => {
@@ -194,7 +194,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report without alerts when an alert violates at monitor', () => {
@@ -233,7 +233,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert violates at ignore', () => {
@@ -272,7 +272,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert violates at defer', () => {
@@ -311,7 +311,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert has no policy value', () => {
@@ -348,7 +348,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert has no policy entry', () => {
@@ -383,7 +383,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
     })
 
@@ -424,7 +424,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a sick report with alert when an alert violates at error', () => {
@@ -488,7 +488,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(false)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report with alert when an alert violates at warn', () => {
@@ -552,7 +552,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report with alert when an alert violates at monitor', () => {
@@ -616,7 +616,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report with alert when an alert violates at ignore', () => {
@@ -680,7 +680,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(1)
+        expect(result['alerts']?.size).toBe(1)
       })
 
       it('should return a healthy report without alerts when an alert violates at defer', () => {
@@ -719,7 +719,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert has no policy value', () => {
@@ -756,7 +756,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
 
       it('should return a healthy report without alerts when an alert has no policy entry', () => {
@@ -791,7 +791,7 @@ describe('generate-report', () => {
           }
         `)
         expect(result.healthy).toBe(true)
-        expect(result.alerts.size).toBe(0)
+        expect(result['alerts']?.size).toBe(0)
       })
     })
   })

src/commands/scan/generate-report.ts

@@ -1,5 +1,4 @@
-import constants from '../../constants'
-
+import type { Spinner } from '@socketsecurity/registry/lib/spinner'
 import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 import type { components } from '@socketsecurity/sdk/types/api'
 
@@ -39,20 +38,20 @@ export function generateReport(
     orgSlug,
     reportLevel,
     scanId,
-    short
+    short,
+    spinner
   }: {
     fold: 'pkg' | 'version' | 'file' | 'none'
     orgSlug: string
     reportLevel: 'defer' | 'ignore' | 'monitor' | 'warn' | 'error'
     scanId: string
-    short: boolean
+    short?: boolean | undefined
+    spinner?: Spinner | undefined
   }
 ): ScanReport | ShortScanReport {
   const now = Date.now()
 
-  // Lazily access constants.spinner.
-  const { spinner } = constants
-  spinner.start('Generating report...')
+  spinner?.start('Generating report...')
 
   // Create an object that includes:
   //   healthy: boolean
@@ -192,7 +191,7 @@ export function generateReport(
     })
   }
 
-  spinner.successAndStop(`Generated reported in ${Date.now() - now} ms`)
+  spinner?.successAndStop(`Generated reported in ${Date.now() - now} ms`)
 
   const report = short
     ? { healthy }

src/commands/scan/output-scan-report.ts

@@ -3,6 +3,7 @@ import fs from 'node:fs/promises'
 import { logger } from '@socketsecurity/registry/lib/logger'
 
 import { generateReport } from './generate-report'
+import constants from '../../constants'
 import { mapToObject } from '../../utils/map-to-object'
 import { mdTable } from '../../utils/markdown'
 import { walkNestedMap } from '../../utils/walk-nested-map'
@@ -51,7 +52,9 @@ export async function outputScanReport(
       scanId,
       fold,
       reportLevel,
-      short
+      short,
+      // Lazily access constants.spinner.
+      spinner: constants.spinner
     }
   )