使用fs-extra writeFile时Jest单元测试提示方法未调用的问题排查

这个问题我之前也碰到过，核心原因是模块导入方式导致的函数引用不匹配，咱们一步步来解决：

问题根源 #

你业务代码里是直接解构导入writeFile：

import { writeFile } from 'fs-extra';

而测试代码里是对fsExtra模块对象上的writeFile做spy：

const writeFileSpy = jest.spyOn(fsExtra, 'writeFile');

这时候业务代码里的writeFile是一个独立的函数引用，和fsExtra.writeFile已经不是同一个了——哪怕实际文件确实生成了，Jest的spy也监测不到这个函数的调用。

方案1：修改业务代码导入方式（最简单直接） #

把业务代码的导入改成整个模块导入，这样调用的就是模块对象上的writeFile，和spy的目标完全一致：

修改后的业务代码

import * as fsExtra from 'fs-extra';
import { resolve as pathResolve } from 'path';

// 注意：这里补全了value的传递，原代码里value未定义是笔误
export default async function generateFile(): Promise<void>{
  await writeSampleFile('测试内容'); 
}

async function writeSampleFile(value: string): Promise<void> {
  try {
    // 改为调用模块对象上的writeFile
    await fsExtra.writeFile(pathResolve('./test.txt'), value, 'utf8');
  } catch (err) { }
}

调整后的测试代码

import generateFile from './x';
import * as fsExtra from 'fs-extra';

describe('generateFile', () => {
  let writeFileSpy: jest.SpyInstance;

  beforeEach(() => {
    // 每个测试前创建spy，并模拟成功返回（避免实际生成文件）
    writeFileSpy = jest.spyOn(fsExtra, 'writeFile').mockResolvedValue();
  });

  afterEach(() => {
    // 测试后清理spy，避免污染其他测试用例
    writeFileSpy.mockRestore();
  });

  test('should call writeFile when generating file', async () => {
    await generateFile();
    expect(writeFileSpy).toHaveBeenCalled();
    // 还可以验证调用参数是否符合预期
    expect(writeFileSpy).toHaveBeenCalledWith(expect.any(String), '测试内容', 'utf8');
  });
});

方案2：不修改业务代码，直接mock整个fs-extra模块 #

如果不想改动业务代码的导入方式，我们可以直接mock整个fs-extra模块，让业务代码里导入的writeFile是我们的mock函数：

测试代码示例

import generateFile from './x';
import { writeFile } from 'fs-extra';

// mock整个fs-extra模块，指定writeFile为mock函数
jest.mock('fs-extra', () => ({
  // 可选：保留其他fs-extra方法的原有实现
  ...jest.requireActual('fs-extra'),
  writeFile: jest.fn().mockResolvedValue(),
}));

describe('generateFile', () => {
  test('should call writeFile when generating file', async () => {
    await generateFile();
    // 直接断言mock的writeFile函数被调用
    expect(writeFile).toHaveBeenCalled();
  });
});

额外注意事项 #

• 原业务代码里generateFile调用writeSampleFile(value)时，value未定义，这是笔误，测试时要确保参数正确传递，否则可能导致writeFile未被执行。
• 测试时建议mock writeFile的返回值，避免实际生成文件污染测试环境，比如用mockResolvedValue()模拟成功写入，或mockRejectedValue()模拟错误场景。

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