如何用Mocha测试VSCode扩展的window.showInformationMessage及选项选择

针对VSCode扩展中信息/警告/错误消息的选项选择行为，使用默认Mocha框架编写单元测试的核心思路是模拟VSCode核心API的行为，验证选项选择后触发的逻辑是否符合预期，同时覆盖异步操作的集成场景。

基础测试：验证选项选择后的逻辑执行 #

以你提供的foo函数为例，我们可以通过模拟vscode.window.showInformationMessage和vscode.env.openExternal来完成测试：

1. 依赖准备 #

确保测试环境已安装sinon（用于API stub），以及VSCode官方测试工具@vscode/test-electron。

2. 编写测试用例 #

const sinon = require('sinon');
const vscode = require('vscode');
const { foo } = require('./your-extension-file'); // 替换为你的函数所在文件

suite('showInformationMessage测试', () => {
  let showInfoStub;
  let openExternalStub;

  setup(() => {
    // 模拟showInformationMessage，让它直接返回选中的选项
    showInfoStub = sinon.stub(vscode.window, 'showInformationMessage');
    // 模拟openExternal，返回成功状态
    openExternalStub = sinon.stub(vscode.env, 'openExternal').resolves(true);
  });

  teardown(() => {
    // 测试后恢复原API
    showInfoStub.restore();
    openExternalStub.restore();
  });

  test('选择"Go to Help"选项时应触发openExternal', async () => {
    const targetUri = vscode.Uri.parse('example.com');
    // 设置stub返回选中的选项
    showInfoStub.resolves('Go to Help');

    // 执行待测试函数
    await foo();

    // 验证showInformationMessage是否以正确参数被调用
    sinon.assert.calledWith(showInfoStub, 'Click for more Info', 'Go to Help');
    // 验证openExternal是否被调用，且参数正确
    sinon.assert.calledWith(openExternalStub, targetUri);
  });

  test('未选择任何选项时不应触发openExternal', async () => {
    // 设置stub返回undefined（用户关闭消息框）
    showInfoStub.resolves(undefined);

    await foo();

    // 验证openExternal从未被调用
    sinon.assert.notCalled(openExternalStub);
  });
});

处理复杂集成场景：异步操作的顺序验证 #

如果选项对应的逻辑包含异步操作（如下载外部工具、启动进程），需要确保测试能等待异步操作完成，并验证执行顺序：

假设foo函数修改为：

const { spawn } = require('child_process');

async function foo() {
  const DownloadTool = 'Download Tool';
  const selection = await vscode.window.showInformationMessage('Need tool to proceed', DownloadTool);
  if (selection === DownloadTool) {
    // 模拟启动下载进程
    await new Promise((resolve) => {
      const process = spawn('download-tool-command');
      process.on('close', resolve);
    });
    // 进程完成后弹出成功消息
    vscode.window.showInformationMessage('Tool downloaded successfully');
  }
}

对应的测试用例需要模拟进程，并验证消息弹出的顺序：

test('下载进程完成后应弹出成功消息', async () => {
  const spawnStub = sinon.stub(require('child_process'), 'spawn');
  // 模拟进程立即触发close事件
  const mockProcess = { on: sinon.stub().callsArgWith(1) };
  spawnStub.returns(mockProcess);

  // 第一个showInformationMessage返回DownloadTool
  showInfoStub.onFirstCall().resolves('Download Tool');
  // 第二个showInformationMessage用于验证
  const successMsgStub = sinon.stub(vscode.window, 'showInformationMessage').onSecondCall().resolves();

  await foo();

  // 验证进程被正确启动
  sinon.assert.calledWith(spawnStub, 'download-tool-command');
  // 验证成功消息在进程完成后弹出
  sinon.assert.calledWith(successMsgStub, 'Tool downloaded successfully');

  spawnStub.restore();
  successMsgStub.restore();
});

关键注意事项 #

• 所有异步操作必须用await等待，确保测试能捕获完整执行流程
• 测试前后要恢复被stub的API，避免影响其他测试用例
• 对于VSCode API的模拟，优先使用sinon.stub而非直接修改全局对象，保证测试隔离性

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