Dry up cdxgen tests

Author: jdalton

src/commands/manifest/cdxgen-integration.test.mts

@@ -7,13 +7,32 @@ import { LOG_SYMBOLS } from '@socketsecurity/registry/lib/logger'
 import { spawn } from '@socketsecurity/registry/lib/spawn'
 import { stripAnsi } from '@socketsecurity/registry/lib/strings'
 
-import { testPath } from '../../../test/utils.mts'
+import { cleanOutput, testPath } from '../../../test/utils.mts'
 import constants from '../../constants.mts'
 
 type PromiseSpawnOptions = Exclude<Parameters<typeof spawn>[2], undefined> & {
   encoding?: BufferEncoding | undefined
 }
 
+function createIncludeMatcher(streamName: 'stdout' | 'stderr') {
+  return function (received: any, expected: string) {
+    const { isNot } = this
+    const strippedExpected = cleanOutput(expected)
+    const stream = cleanOutput(received?.[streamName] || '')
+    return {
+      // Do not alter your "pass" based on isNot. Vitest does it for you.
+      pass: !!stream?.includes?.(strippedExpected),
+      message: () =>
+        `spawn.${streamName} ${isNot ? 'does NOT include' : 'includes'} \`${strippedExpected}\`: ${stream}`,
+    }
+  }
+}
+
+expect.extend({
+  toHaveStdoutInclude: createIncludeMatcher('stdout'),
+  toHaveStderrInclude: createIncludeMatcher('stderr'),
+})
+
 describe('Socket manifest cdxgen command', async () => {
   const { binCliPath } = constants
 
@@ -26,44 +45,30 @@ describe('Socket manifest cdxgen command', async () => {
     },
   }
 
-  it.skipIf(constants.WIN32 && constants.ENV.CI)(
-    'should forwards known commands to cdxgen',
-    {
-      // Increase timeout for CI environments where cdxgen downloads can be slow.
-      timeout: 60_000,
-    },
-    async () => {
-      for (const command of ['-h', '--help']) {
-        // eslint-disable-next-line no-await-in-loop
-        const output = await spawn(
-          constants.execPath,
-          [binCliPath, 'manifest', 'cdxgen', command],
-          spawnOpts,
-        )
-        expect(
-          output.stdout.includes('CycloneDX Generator'),
-          'forwards commands to cdxgen',
-        ).toBe(true)
-      }
-    },
-  )
-
   describe('command forwarding', async () => {
-    expect.extend({
-      toHaveStderrInclude(received, expected) {
-        const { isNot } = this
-        const strippedExpected = stripAnsi(expected)
-        const stderr = received?.stderr
-        return {
-          // do not alter your "pass" based on isNot. Vitest does it for you
-          pass: stderr?.includes?.(strippedExpected) ?? false,
-          message: () =>
-            `spawn.stderr ${isNot ? 'does NOT include' : 'includes'} \`${strippedExpected}\`: ${stderr}`,
+    it.skipIf(constants.WIN32 && constants.ENV.CI)(
+      'should forward known flags to cdxgen',
+      {
+        // Increase timeout for CI environments where cdxgen downloads can be slow.
+        timeout: 60_000,
+      },
+      async () => {
+        for (const command of ['-h', '--help']) {
+          // eslint-disable-next-line no-await-in-loop
+          await expect(
+            () =>
+              spawn(
+                constants.execPath,
+                [binCliPath, 'manifest', 'cdxgen', command],
+                spawnOpts,
+              ),
+            // @ts-ignore toHaveStdoutInclude is defined above.
+          ).resolves.toHaveStdoutInclude('CycloneDX Generator')
         }
       },
-    })
+    )
 
-    it('should not forward -u to cdxgen', async () => {
+    it('should not forward an unknown short flag to cdxgen', async () => {
       const command = '-u'
       await expect(
         () =>
@@ -72,13 +77,13 @@ describe('Socket manifest cdxgen command', async () => {
             [binCliPath, 'manifest', 'cdxgen', command],
             spawnOpts,
           ),
-        // @ts-ignore toHaveStderrInclude is defined above
+        // @ts-ignore toHaveStderrInclude is defined above.
       ).rejects.toHaveStderrInclude(
         `${LOG_SYMBOLS.fail} Unknown argument: ${command}`,
       )
     })
 
-    it('should not forward --unknown to cdxgen', async () => {
+    it('should not forward an unknown flag to cdxgen', async () => {
       const command = '--unknown'
       await expect(
         () =>
@@ -93,7 +98,7 @@ describe('Socket manifest cdxgen command', async () => {
       )
     })
 
-    it('should not forward multiple unknown commands to cdxgen', async () => {
+    it('should not forward multiple unknown flags to cdxgen', async () => {
       await expect(
         () =>
           spawn(