You need to enable JavaScript to run this app. Node+Typescript环境下Mock FTP库ready与error事件的单元测试方案咨询
优惠活动
大模型
产品
解决方案
定价
更多

Node+Typescript环境下Mock FTP库ready与error事件的单元测试方案咨询

解决方案

现有方案的核心问题

  • 方案1:直接mock了on方法的实现,导致业务代码中注册的ready/error回调没有被真正存储,同时触发事件用的是新创建的EventEmitter实例,和业务代码中的FTP实例不是同一个,事件无法触发到业务回调
  • 方案2:同样存在事件触发实例和业务实例不统一的问题,原型stub后emit的事件根本到不了业务代码注册的回调
  • 方案3:mock的ftp库导出结构不符合原库规范,原库默认导出的是Client构造类,当前mock返回的对象结构会导致业务中new Client()直接报错

可行实现方案(基于Jest)

第一步:正确mock ftp库

我们需要让mock的Client类继承Node的EventEmitter,保证on方法能正常注册回调,同时mock所有业务中用到的实例方法:

import { EventEmitter } from 'events';

// 全局mock ftp库
jest.mock('ftp', () => {
  // 模拟Client类,继承EventEmitter以支持事件注册触发
  const mockClient = jest.fn().mockImplementation(() => {
    const instance = new EventEmitter();
    // mock业务用到的所有方法
    instance.connect = jest.fn();
    instance.list = jest.fn();
    instance.end = jest.fn();
    return instance;
  });
  return {
    __esModule: true,
    default: mockClient,
    // 适配import * as Client的导入方式
    ...mockClient
  };
});

第二步:编写ready事件测试用例

import * as Client from 'ftp';
// 引入你封装了FTP逻辑的业务方法,假设叫fetchFtpFile
import { fetchFtpFile } from './your-business-code';

test('ftp连接成功触发ready事件时,执行业务逻辑', () => {
  const mockC = new Client();
  // 模拟list方法的返回值
  const mockFileList = [{ name: 'test.txt', type: 'file', size: 1024 }];
  (mockC.list as jest.Mock).mockImplementation((callback) => {
    callback(null, mockFileList);
  });

  // 执行业务代码
  fetchFtpFile();

  // 手动触发ready事件
  mockC.emit('ready');

  // 断言逻辑符合预期
  expect(mockC.connect).toHaveBeenCalled();
  expect(mockC.list).toHaveBeenCalled();
  expect(mockC.end).toHaveBeenCalled();
  // 补充你自己的业务逻辑断言,比如文件处理逻辑是否生效
});

第三步:编写error事件测试用例

test('ftp连接出错触发error事件时,执行错误处理逻辑', () => {
  const mockC = new Client();
  const testError = new Error('FTP连接超时');

  // 执行业务代码
  fetchFtpFile();

  // 手动触发error事件
  mockC.emit('error', testError);

  // 断言错误处理逻辑被正确执行,比如错误日志是否打印、异常是否被捕获等
});

关键点说明

  • 必须保证mock的Client实例和业务代码中创建的实例是同一个,触发事件才能生效
  • 不要mockon方法本身,它是用来注册回调的原生方法,我们只需要mock业务自定义的方法比如connect、list即可
  • 如果你的FTP逻辑包含异步操作,可添加done回调或者用async/await等待异步逻辑执行完成后再做断言

内容的提问来源于stack exchange,提问作者Ripundeep Gill

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.16 19:45:07