如何用Jest测试appendFileSync？求文件写入模拟及代码指导

问题 #

我正在为appendFileSync编写测试用例，该函数用于tslog日志库的transport中，目前有一行代码未被测试覆盖。相关代码如下：

export function logToTransport(logObject: ILogObject) {
  appendFileSync('monopoly_deal.log', JSON.stringify(logObject) + '\n');
}

我曾尝试mock 'fs'模块以避免实际写入文件，但并未对写入逻辑进行测试。以下是我的测试代码雏形：

const log: Logger = new Logger({ name: 'card_types_test' });
log.attachTransport(
  {
    silly: CardTypes.logToTransport,
    debug: CardTypes.logToTransport,
    trace: CardTypes.logToTransport,
    info: CardTypes.logToTransport,
    warn: CardTypes.logToTransport,
    error: CardTypes.logToTransport,
    fatal: CardTypes.logToTransport,
  },
  'info',
);

// 我认为需要用jest.spyOn拦截调用，但不确定具体实现方式，比如类似const spy = jest.fn(CardTypes.logToTransport);

log.info('test'); // 写入文件
expect(spy).toequal({object with my data}); // 为简洁未写出具体对象结构

恳请指导如何模拟文件写入操作，也欢迎给出其他代码优化建议（我目前是初级开发者）。

解决方案 #

1. 模拟fs模块验证写入逻辑 #

通过mock fs.appendFileSync，可以避免实际写入文件，同时验证写入的内容和路径是否符合预期：

import { Logger } from "tslog";
import * as fs from "fs";
import { logToTransport } from "./your-file-path";

// 全局mock fs模块
jest.mock("fs");

describe("logToTransport", () => {
  it("should write formatted log content to the correct file", () => {
    // 构造测试用的日志对象
    const mockLog = {
      level: "info",
      message: "test",
      name: "card_types_test",
      timestamp: new Date().toISOString()
    };

    // 调用transport函数
    logToTransport(mockLog);

    // 验证appendFileSync的调用参数
    expect(fs.appendFileSync).toHaveBeenCalledWith(
      "monopoly_deal.log",
      JSON.stringify(mockLog) + "\n"
    );
  });

  it("should integrate correctly with tslog", () => {
    const log = new Logger({ name: "card_types_test" });
    log.attachTransport(logToTransport, "info");

    // 触发日志写入
    log.info("test");

    // 提取spy的调用参数并验证
    const [filePath, content] = (fs.appendFileSync as jest.Mock).mock.calls[0];
    expect(filePath).toBe("monopoly_deal.log");

    const parsedLog = JSON.parse(content.slice(0, -1)); // 移除末尾换行符
    expect(parsedLog.message).toBe("test");
    expect(parsedLog.name).toBe("card_types_test");
    expect(parsedLog.level).toBe("info");
  });
});

2. 直接SpyOn Transport函数 #

如果只需要验证tslog是否正确调用了transport函数，可以直接spyOn目标函数：

import { Logger } from "tslog";
import * as CardTypes from "./your-file-path";

describe("tslog transport integration", () => {
  it("should trigger logToTransport on info level log", () => {
    // 创建spy并替换原函数
    const transportSpy = jest.spyOn(CardTypes, "logToTransport").mockImplementation(() => {});
    
    const log = new Logger({ name: "card_types_test" });
    log.attachTransport(CardTypes.logToTransport, "info");

    log.info("test");

    // 验证函数被调用，且参数符合预期
    expect(transportSpy).toHaveBeenCalled();
    const receivedLog = transportSpy.mock.calls[0][0];
    expect(receivedLog.message).toBe("test");
    expect(receivedLog.level).toBe("info");

    // 恢复原函数，避免影响其他测试
    transportSpy.mockRestore();
  });
});

3. 代码优化建议 #

• 简化transport配置：tslog支持直接传入单个函数作为所有级别的transport，无需重复声明：

  log.attachTransport(logToTransport, "info");
  

• 提取常量避免硬编码：把日志文件名定义为常量，方便后续修改：

  export const LOG_FILE = "monopoly_deal.log";
  
  export function logToTransport(logObject: ILogObject) {
    appendFileSync(LOG_FILE, JSON.stringify(logObject) + "\n");
  }
  

• 添加异常处理：防止JSON.stringify序列化失败导致程序崩溃：

  export function logToTransport(logObject: ILogObject) {
    try {
      const content = JSON.stringify(logObject) + "\n";
      appendFileSync(LOG_FILE, content);
    } catch (err) {
      console.error("Log serialization failed:", err);
    }
  }
  

• 改用异步写入：同步写入在高并发场景会阻塞事件循环，可替换为异步API：

  import { appendFile } from "fs/promises";
  
  export async function logToTransport(logObject: ILogObject) {
    try {
      const content = JSON.stringify(logObject) + "\n";
      await appendFile(LOG_FILE, content);
    } catch (err) {
      console.error("Log write failed:", err);
    }
  }
  

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