如何为基于sqs-consumer包的AWS SQS编写Mocha单元测试？

没问题！我来给你详细讲讲怎么用Mocha为基于sqs-consumer的AWS SQS消费者写单元测试——核心是mock AWS的SQS服务，不用真连接AWS就能验证你的业务逻辑。下面是一步步的实操指南：

首先得装测试相关的工具包，包括测试框架Mocha、断言库Chai、AWS SDK的mock工具，还有用来做函数间谍的Sinon：

npm install --save-dev mocha chai aws-sdk-mock sinon

假设你已经有一个基础的消费者文件consumer.js，结构大概是这样（包含消费逻辑和业务处理函数）：

const AWS = require('aws-sdk');
const { Consumer } = require('sqs-consumer');

// 创建消费者实例
const createConsumer = () => {
  return Consumer.create({
    queueUrl: 'https://sqs.us-east-1.amazonaws.com/123456789012/my-test-queue',
    handleMessage: async (message) => {
      // 解析消息体并调用业务处理函数
      const messageData = JSON.parse(message.Body);
      await processMessageData(messageData);
    },
    sqs: new AWS.SQS({ region: 'us-east-1' })
  });
};

// 示例业务处理函数（你实际的业务逻辑）
async function processMessageData(data) {
  if (!data.userId) {
    throw new Error('消息缺少必要字段userId');
  }
  // 这里写你的业务操作，比如存数据库、调用API等
  console.log(`处理用户${data.userId}的消息`);
  return true;
}

module.exports = { createConsumer, processMessageData };

接下来写测试文件consumer.test.js，我们会mock SQS的API，验证消费逻辑、业务函数调用、错误处理这几个核心场景：

const { expect } = require('chai');
const AWS = require('aws-sdk');
const AWSMock = require('aws-sdk-mock');
const sinon = require('sinon');
const { createConsumer, processMessageData } = require('./consumer');

describe('SQS 消费者单元测试', () => {
  let consumer;
  let processDataSpy;

  // 每个测试前初始化mock和间谍
  beforeEach(() => {
    // Mock SQS的receiveMessage方法，返回模拟消息
    AWSMock.mock('SQS', 'receiveMessage', (params, callback) => {
      const mockMessages = {
        Messages: [
          {
            MessageId: 'test-msg-1',
            ReceiptHandle: 'test-receipt-1',
            Body: JSON.stringify({ userId: '1001', content: '测试消息' })
          }
        ]
      };
      callback(null, mockMessages);
    });

    // Mock SQS的deleteMessage方法（消息处理成功后会调用它删除消息）
    AWSMock.mock('SQS', 'deleteMessage', (params, callback) => {
      callback(null, {});
    });

    // 给业务函数创建间谍，用来验证是否被正确调用
    processDataSpy = sinon.spy(processMessageData);

    // 创建消费者实例
    consumer = createConsumer();
  });

  // 每个测试后清理mock和停止消费者
  afterEach(() => {
    AWSMock.restore('SQS');
    if (consumer) {
      consumer.stop();
    }
  });

  it('成功消费消息：调用业务函数并删除SQS消息', async () => {
    // 启动消费者
    consumer.start();

    // 异步等待消息处理完成（因为sqs-consumer是异步处理）
    await new Promise(resolve => setTimeout(resolve, 100));

    // 验证业务函数被调用，且参数正确
    expect(processDataSpy.calledOnce).to.be.true;
    expect(processDataSpy.calledWith({ userId: '1001', content: '测试消息' })).to.be.true;

    // 验证SQS的deleteMessage被调用，且传入了正确的ReceiptHandle
    const deleteCall = AWSMock.getCalls('SQS', 'deleteMessage')[0];
    expect(deleteCall.params.ReceiptHandle).to.equal('test-receipt-1');
  });

  it('处理消息失败：捕获错误且不删除SQS消息', async () => {
    // 修改receiveMessage的mock，返回错误格式的消息
    AWSMock.mock('SQS', 'receiveMessage', (params, callback) => {
      const invalidMessage = {
        Messages: [
          {
            MessageId: 'test-msg-2',
            ReceiptHandle: 'test-receipt-2',
            Body: JSON.stringify({ content: '缺少userId的无效消息' })
          }
        ]
      };
      callback(null, invalidMessage);
    });

    // 监听消费者的error事件，捕获错误
    const errorSpy = sinon.spy();
    consumer.on('error', errorSpy);

    consumer.start();
    await new Promise(resolve => setTimeout(resolve, 100));

    // 验证错误被正确捕获
    expect(errorSpy.calledOnce).to.be.true;
    expect(errorSpy.calledWithMatch(new Error('消息缺少必要字段userId'))).to.be.true;

    // 验证deleteMessage没有被调用（处理失败时不会删除消息）
    const deleteCalls = AWSMock.getCalls('SQS', 'deleteMessage');
    expect(deleteCalls.length).to.equal(0);
  });
});

• 模拟空队列：修改receiveMessage的mock返回{ Messages: [] }，验证消费者不会触发业务逻辑。
• 批量消息测试：在mock的Messages里放多条消息，验证消费者能依次处理。
• SQS调用失败：给receiveMessage的mock传入错误回调callback(new Error('SQS服务异常'), null)，验证消费者的错误重试逻辑。
• 如果用AWS SDK v3：aws-sdk-mock不支持v3，改用aws-sdk-client-mock来mock SQS客户端。

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