如何用Jest结合execSync捕获脚本的console.log输出？

你当前代码里的stdio: 'inherit'会让子进程的输出直接同步到父进程的终端流，导致Jest无法通过监听测试进程的console捕获输出——因为子进程是独立的Node实例，它的console.log输出不会经过测试进程的console对象。要捕获输出，需要调整execSync的配置，把输出导向缓冲区而非直接输出到终端。

具体解决方案 #

1. 修改execSync的stdio配置，捕获输出 #

移除stdio: 'inherit'，改用stdio: ['ignore', 'pipe', 'pipe']配置：

• ignore：忽略子进程的stdin输入
• pipe：将子进程的stdout和stderr通过管道返回给父进程

同时添加encoding: 'utf8'，让execSync直接返回字符串，省去手动转换Buffer的步骤。

2. 调整测试函数，返回捕获的输出 #

修改runScriptToTest函数，让它返回捕获到的标准输出，同时处理错误场景下的标准错误输出：

import { execSync } from 'child_process'

const runScriptToTest = () => {
  try {
    const stdout = execSync(`node ./lib/index.js`, { 
      stdio: ['ignore', 'pipe', 'pipe'],
      encoding: 'utf8'
    })
    return stdout.trim() // 去除输出首尾的换行或空格
  } catch (error: any) {
    // 捕获脚本执行失败时的错误输出
    console.error('脚本执行出错:', error.stderr?.trim())
    throw error // 抛出错误让Jest捕获，或根据需求返回错误信息
  } 
}

3. 编写Jest测试用例验证输出 #

在测试用例中调用函数，直接断言返回的输出是否符合预期：

describe('脚本输出测试', () => {
  it('应该输出"Working..."', () => {
    const output = runScriptToTest()
    expect(output).toBe('Working...')
  })
})

关键说明 #

• 不要尝试用jest.spyOn(console, 'log')捕获子进程输出：子进程是独立的运行实例，它的输出直接写入系统标准流，和测试进程的console对象无关联，无法被监听。
• 若脚本同时有标准输出和错误输出，可通过execSync抛出的错误对象的stderr属性获取错误信息。

内容的提问来源于stack exchange，提问作者Álvaro