test: replace stdout-stderr with captureOutput and remove dependency

Replace stdout-stderr package with captureOutput from @heroku-cli/test-utils
for cleaner and more consistent test output handling. Converted 7 test files
and removed the stdout-stderr dependency from package.json.

Files converted:
- lib/confirm-command.unit.test.ts
- lib/spaces/peering.unit.test.ts
- lib/spaces/spaces.unit.test.ts
- lib/run/log-displayer.unit.test.ts
- lib/spaces/hosts.unit.test.ts
- lib/data/display-quota.unit.test.ts
- lib/spaces/vpn-connections.unit.test.ts

Author: eablack

package-lock.json

@@ -136,7 +136,6 @@
     "sinon": "^21.0.2",
     "source-map-support": "^0.5.21",
     "std-mocks": "^2.0.0",
-    "stdout-stderr": "^0.1.13",
     "ts-node": "^10.9.2",
     "typescript": "4.9.5"
   },

package.json

@@ -2,15 +2,12 @@ import {runCommand} from '@heroku-cli/test-utils'
 import {expect} from 'chai'
 import nock from 'nock'
 import sinon from 'sinon'
-import {stderr, stdout} from 'stdout-stderr'
 
 import DomainsAdd from '../../../../src/commands/domains/add.js'
 
 describe('domains:add', function () {
   afterEach(function () {
     nock.cleanAll()
-    stdout.stop()
-    stderr.stop()
   })
 
   const domainsResponse = {

test/helpers/legacy-run-command.ts

@@ -3,7 +3,6 @@ import {hux} from '@heroku/heroku-cli-util'
 import {expect} from 'chai'
 import nock from 'nock'
 import sinon from 'sinon'
-import {stderr, stdout} from 'stdout-stderr'
 
 import DomainsIndex from '../../../../src/commands/domains/index.js'
 import removeAllWhitespace from '../../../helpers/utils/remove-whitespaces.js'
@@ -24,8 +23,6 @@ describe('domains', function () {
     api.done()
     confirmStub.restore()
     nock.cleanAll()
-    stdout.stop()
-    stderr.stop()
   })
 
   const herokuOnlyDomainsResponse = [

test/unit/commands/domains/add.unit.test.ts

@@ -1,8 +1,8 @@
+import {captureOutput} from '@heroku-cli/test-utils'
 import {hux} from '@heroku/heroku-cli-util'
 import ansis from 'ansis'
 import {expect} from 'chai'
 import sinon from 'sinon'
-import {stderr, stdout} from 'stdout-stderr'
 
 import ConfirmCommand from '../../../src/lib/confirm-command.js'
 
@@ -12,67 +12,55 @@ describe('confirmApp', function () {
   })
 
   it('should not error or prompt with confirm flag match', async function () {
-    stdout.start()
-    stderr.start()
+    const {stderr, stdout} = await captureOutput(async () => {
+      await new ConfirmCommand().confirm('app', 'app')
+    })
 
-    await new ConfirmCommand().confirm('app', 'app')
-
-    stdout.stop()
-    stderr.stop()
-
-    expect(stderr.output).to.equal('')
-    expect(stdout.output).to.equal('')
+    expect(stderr).to.equal('')
+    expect(stdout).to.equal('')
   })
 
   it('should err on confirm flag mismatch', async function () {
-    stdout.start()
-    stderr.start()
-
     try {
-      await new ConfirmCommand().confirm('app', 'nope')
+      await captureOutput(async () => {
+        await new ConfirmCommand().confirm('app', 'nope')
+      })
       expect.fail('Expected confirm to throw error')
     } catch (error: any) {
       expect(ansis.strip(error.message)).to.equal('Confirmation nope did not match app. Aborted.')
-    } finally {
-      stdout.stop()
-      stderr.stop()
     }
   })
 
   it('should not err on confirm prompt match', async function () {
     sinon.stub(hux, 'prompt').resolves('app')
-    stdout.start()
-    stderr.start()
-
-    await new ConfirmCommand().confirm('app')
 
-    stdout.stop()
-    stderr.stop()
+    const {stderr, stdout} = await captureOutput(async () => {
+      await new ConfirmCommand().confirm('app')
+    })
 
-    expect(stderr.output).to.contain('Warning: Destructive Action')
-    expect(stdout.output).to.equal('')
+    expect(stderr).to.contain('Warning: Destructive Action')
+    expect(stdout).to.equal('')
   })
 
   it('should display custom message', async function () {
     const customMessage = 'custom message'
     sinon.stub(hux, 'prompt').resolves('app')
-    stdout.start()
-    stderr.start()
-
-    await new ConfirmCommand().confirm('app', undefined, customMessage)
 
-    stdout.stop()
-    stderr.stop()
+    const {stderr, stdout} = await captureOutput(async () => {
+      await new ConfirmCommand().confirm('app', undefined, customMessage)
+    })
 
-    expect(stderr.output).to.contain(customMessage)
-    expect(stdout.output).to.equal('')
+    expect(stderr).to.contain(customMessage)
+    expect(stdout).to.equal('')
   })
 
   it('should err on confirm prompt mismatch', async function () {
     sinon.stub(hux, 'prompt').resolves('nope')
 
     try {
-      await new ConfirmCommand().confirm('app')
+      await captureOutput(async () => {
+        await new ConfirmCommand().confirm('app')
+      })
       expect.fail('Expected confirm to throw error')
     } catch (error: any) {
       expect(ansis.strip(error.message)).to.equal('Confirmation did not match app. Aborted.')

test/unit/commands/domains/index.unit.test.ts

@@ -1,5 +1,5 @@
+import {captureOutput} from '@heroku-cli/test-utils'
 import {expect} from 'chai'
-import {stdout} from 'stdout-stderr'
 import tsheredoc from 'tsheredoc'
 
 import {displayQuota, formatQuotaStatus} from '../../../../src/lib/data/display-quota.js'
@@ -30,12 +30,12 @@ describe('lib/displayQuota', function () {
   })
 
   describe('displayQuota', function () {
-    it('displays the quota information in a human-readable format', function () {
-      stdout.start()
-      displayQuota(storageQuotaResponse)
-      stdout.stop()
+    it('displays the quota information in a human-readable format', async function () {
+      const {stdout} = await captureOutput(async () => {
+        displayQuota(storageQuotaResponse)
+      })
 
-      expect(stdout.output).to.equal(heredoc(`
+      expect(stdout).to.equal(heredoc(`
         === Storage
 
         Warning:            50.00 GB

test/unit/lib/confirm-command.unit.test.ts

@@ -3,7 +3,6 @@ import {expect} from 'chai'
 import * as fs from 'node:fs'
 import * as path from 'node:path'
 import * as proxyquire from 'proxyquire'
-import {stderr} from 'stdout-stderr'
 import {ConnectionDetails, ConnectionDetailsWithAttachment, utils} from '@heroku/heroku-cli-util'
 import {unwrap} from '../../../helpers/utils/unwrap.js'
 import sinon = require('sinon')
@@ -81,13 +80,11 @@ describe('psql', function () {
       },
     })
     sandbox.stub(Math, 'random').callsFake(() => 0)
-    stderr.start()
   })
 
   afterEach(async function () {
     queryString = ''
     sandbox.restore()
-    stderr.stop()
     process.env = env
   })
 

test/unit/lib/data/display-quota.unit.test.ts

@@ -1,10 +1,10 @@
 /* eslint-disable unicorn/prefer-add-event-listener */
 import {APIClient} from '@heroku-cli/command'
+import {captureOutput} from '@heroku-cli/test-utils'
 import {Config, Errors} from '@oclif/core'
 import {expect} from 'chai'
 import nock from 'nock'
 import sinon from 'sinon'
-import {stderr, stdout} from 'stdout-stderr'
 import tsheredoc from 'tsheredoc'
 
 import {LogDisplayer} from '../../../../src/lib/run/log-displayer.js'
@@ -306,15 +306,15 @@ describe('logDisplayer', function () {
             data: 2024-10-17T22:23:23.032789+00:00 app[web.1]: log line 2\n\n\n
                     `)
 
-        stdout.start()
-        await displayer.display({
-          app: 'my-cedar-app',
-          tail: false,
+        const {stdout} = await captureOutput(async () => {
+          await displayer.display({
+            app: 'my-cedar-app',
+            tail: false,
+          })
         })
-        stdout.stop()
 
         // Note: logServer.done() is not called because our MockEventSource intercepts the request
-        expect(stdout.output).to.eq(heredoc`
+        expect(stdout).to.eq(heredoc`
           2024-10-17T22:23:22.209776+00:00 app[web.1]: log line 1
           2024-10-17T22:23:23.032789+00:00 app[web.1]: log line 2
         `)
@@ -353,20 +353,22 @@ describe('logDisplayer', function () {
 
     context('when the log server responds with a stream of log lines and then timeouts', function () {
       it('displays log lines and exits showing a timeout error', async function () {
+        let stdout = ''
         try {
-          stdout.start()
-          await displayer.display({
-            app: 'my-cedar-app',
-            tail: true,
+          const output = await captureOutput(async () => {
+            await displayer.display({
+              app: 'my-cedar-app',
+              tail: true,
+            })
           })
+          stdout = output.stdout
         } catch (error: unknown) {
-          stdout.stop()
           const {message, oclif} = error as CLIError
           expect(message).to.equal('Logs eventsource failed with: 401')
           expect(oclif.exit).to.eq(1)
         }
 
-        expect(stdout.output).to.eq('')
+        expect(stdout).to.eq('')
       })
     })
   })
@@ -386,22 +388,22 @@ describe('logDisplayer', function () {
     })
 
     it('displays logs and recreates log sessions on timeout', async function () {
+      let stderr = ''
       try {
-        stdout.start()
-        stderr.start()
-        await displayer.display({
-          app: 'my-fir-app',
-          tail: false,
+        const output = await captureOutput(async () => {
+          await displayer.display({
+            app: 'my-fir-app',
+            tail: false,
+          })
         })
+        stderr = output.stderr
       } catch (error: unknown) {
-        stdout.stop()
-        stderr.stop()
         const {message} = error as Error
         expect(message.trim()).to.equal('HTTP Error 500 for POST https://api.heroku.com/apps/my-fir-app/log-sessions')
       }
 
       // it displays message about fetching logs for fir apps
-      expect(stderr.output).to.eq('Fetching logs...\n\n')
+      expect(stderr).to.eq('Fetching logs...\n\n')
     })
   })
 })

test/unit/lib/pg/psql.unit.test.ts

@@ -1,5 +1,5 @@
+import {captureOutput} from '@heroku-cli/test-utils'
 import {expect} from 'chai'
-import {stdout} from 'stdout-stderr'
 
 import {displayHosts, displayHostsAsJSON, Host} from '../../../../src/lib/spaces/hosts.js'
 import removeAllWhitespace from '../../../helpers/utils/remove-whitespaces.js'
@@ -21,12 +21,12 @@ const hosts: Host[] = [
 ]
 
 describe('displayHosts', function () {
-  it('displays hosts when json flag is false', function () {
-    stdout.start()
-    displayHosts('my-space', hosts)
-    stdout.stop()
+  it('displays hosts when json flag is false', async function () {
+    const {stdout} = await captureOutput(async () => {
+      displayHosts('my-space', hosts)
+    })
 
-    const actual = removeAllWhitespace(stdout.output)
+    const actual = removeAllWhitespace(stdout)
     expect(actual).to.include(removeAllWhitespace('=== my-space Hosts'))
     expect(actual).to.include(removeAllWhitespace('Host ID             State     Available Capacity Allocated At         Released At'))
     expect(actual).to.include(removeAllWhitespace('h-0f927460a59aac18e available 72%                2020-05-28T04:15:59Z'))
@@ -35,10 +35,10 @@ describe('displayHosts', function () {
 })
 
 describe('displayHostsAsJSON', function () {
-  it('displays hosts when json flag is true', function () {
-    stdout.start()
-    displayHostsAsJSON(hosts)
-    stdout.stop()
-    expect(JSON.parse(stdout.output)).to.eql(hosts)
+  it('displays hosts when json flag is true', async function () {
+    const {stdout} = await captureOutput(async () => {
+      displayHostsAsJSON(hosts)
+    })
+    expect(JSON.parse(stdout)).to.eql(hosts)
   })
 })