Jasmine测试中fs.copyFileSync与unlinkSync Mock未被调用问题排查

问题背景 #

我有一段TypeScript代码结构如下：

• 对外导出myFunction，内部调用myIOFunction
• myIOFunction的逻辑：用fs.copyFileSync复制文件 → 调用不依赖fs的myOtherFunction处理文件 → 用fs.unlinkSync删除复制的文件
• 初始导入方式：import { copyFileSync, unlinkSync } from 'fs'

在单元测试时，我尝试通过myFunction间接测试myIOFunction，用Jasmine的spyOn模拟fs.copyFileSync和fs.unlinkSync，但测试始终失败，提示两个Mock未被调用。实际调试确认代码中这两个方法确实正常执行了，且测试用例中其他方法的Mock工作正常。我已经尝试过：

• 将被测文件的fs导入改为import * as fs from 'fs'并通过fs对象调用方法
• 将Mock放入beforeAll钩子
  但均未解决问题。

附相关配置：

package.json依赖 #

"scripts": { "test": "tsc && jasmine" },
"devDependencies": { "@types/jasmine": "^3.5.10", "@types/node": "^13.7.7", "@types/pg": "^7.14.3", "copyfiles": "^2.2.0", "jasmine": "^3.5.0", "jasmine-core": "^3.5.0", "jasmine-ts": "^0.3.0", "js-yaml": "^3.13.1", "mock-fs": "^4.11.0", "morgan": "^1.10.0", "nodemon": "^2.0.2", "swagger-ui-express": "^4.1.3", "ts-node": "^8.7.0", "typescript": "^3.8.3" },
"dependencies": { "@types/express": "^4.17.3", "chokidar": "^3.3.1", "cors": "^2.8.5", "csv-writer": "^1.6.0", "dotenv": "^8.2.0", "express": "^4.17.1", "murmurhash": "0.0.2", "pg": "^7.18.2", "pg-format": "^1.0.4", "winston": "^3.2.1" }

jasmine.json #

{ "spec_dir": "dist", "spec_files": [ "**/*[sS]pec.js" ], "helpers": [ "helpers/**/*.js" ], "stopSpecOnExpectationFailure": false, "random": true }

tsconfig.json #

{ "compilerOptions": { "experimentalDecorators": true, "module": "commonjs", "esModuleInterop": true, "target": "es6", "moduleResolution": "node", "sourceMap": true, "outDir": "dist", "typeRoots": [ "node_modules/@types", "node_modules/@types/node" ] }, "lib": [ "es2015" ] }

问题原因 #

这个问题的核心在于模块加载顺序和导入方式导致Jasmine的Spy无法覆盖到代码中实际调用的方法：

1. 解构导入的局限性：当你用import { copyFileSync } from 'fs'时，这些方法会被直接赋值给模块作用域的变量，Jasmine的spyOn是在fs模块对象上添加代理，但解构后的变量已经持有原始方法的引用，不会被Spy影响。
2. 模块加载顺序错误：如果测试文件中先导入被测模块，再设置Spy，此时被测模块已经获取了fs方法的原始引用，后续的Spy无法修改这个已存在的引用。

解决方案 #

1. 统一被测文件的fs导入与调用方式 #

确保被测文件中通过fs模块对象调用方法，避免解构导入：

// 被测文件（比如myModule.ts）
import * as fs from 'fs';

function myOtherFunction() {
  // 你的文件处理逻辑
}

function myIOFunction() {
  fs.copyFileSync('source-path', 'dest-path');
  myOtherFunction();
  fs.unlinkSync('dest-path');
}

export function myFunction() {
  myIOFunction();
}

2. 调整测试文件的模块加载顺序 #

在测试文件中，先设置Spy，再加载被测模块。由于你的TypeScript配置为module: commonjs，可以用require动态加载被测模块，而不是顶部的import：

// 测试文件（比如myModule.spec.ts）
import * as fs from 'fs';

describe('myFunction', () => {
  let myFunction: () => void;

  beforeAll(() => {
    // 先为fs方法设置Spy
    spyOn(fs, 'copyFileSync').and.callFake(() => {
      // 可选：模拟文件复制的空实现
    });
    spyOn(fs, 'unlinkSync').and.callFake(() => {
      // 可选：模拟文件删除的空实现
    });

    // 再动态加载被测模块
    const module = require('../src/myModule');
    myFunction = module.myFunction;
  });

  it('should trigger fs.copyFileSync and fs.unlinkSync via myIOFunction', () => {
    myFunction();

    // 验证Spy被调用
    expect(fs.copyFileSync).toHaveBeenCalled();
    expect(fs.unlinkSync).toHaveBeenCalled();
  });
});

3. 排除mock-fs的干扰 #

如果你的测试中使用了mock-fs，它会替换整个fs模块，可能导致之前设置的Spy失效。解决方法：

• 确保在调用mock-fs的mock()方法之后，再设置Jasmine Spy
• 或者暂时移除mock-fs依赖，验证是否是它导致的冲突

验证步骤 #

1. 重新编译代码：tsc
2. 运行测试：npm test
   此时应该能看到Spy被正确触发，测试通过。

内容的提问来源于stack exchange，提问作者Green Cloak Guy