VS Code扩展测试：如何断言剪贴板中的复制值？

核心方案 #

直接在测试中执行完整的扩展逻辑（调用myAwesomeMethod），通过VS Code官方API读取剪贴板内容，配合异步重试机制避免竞态问题，最终完成断言对比。

具体实现步骤 #

• 放弃单独测试stringGenerator，改为调用完整的myAwesomeMethod，确保覆盖剪贴板写入全流程
• 使用vscode.env.clipboard.readText()异步读取剪贴板内容，适配writeText的异步特性，等待写入完成后再读取
• 实现带延迟的重试逻辑，避免因异步写入未完成导致的断言失败
• 统一处理文本的空白和换行符差异，避免格式问题引发误判
• 测试前后清空剪贴板，保证测试隔离性

修改后的测试代码示例 #

const path = require('path');
const fs = require('fs');
const assert = require('assert');
const vscode = require('vscode');
const { myAwesomeMethod } = require('../../src/yourExtensionModule'); // 替换为你的扩展模块路径

// 带延迟的剪贴板读取重试函数
async function readClipboardWithRetry(maxAttempts = 5, delayMs = 200) {
  let attempts = 0;
  while (attempts < maxAttempts) {
    const content = await vscode.env.clipboard.readText();
    if (content) return content;
    attempts++;
    await new Promise(resolve => setTimeout(resolve, delayMs));
  }
  throw new Error('剪贴板读取超时，未获取到内容');
}

suite('剪贴板内容测试', function () {
  // 测试前清空剪贴板，避免历史内容干扰
  setup(async function () {
    await vscode.env.clipboard.writeText('');
  });

  test('剪贴板内容应匹配预期输出', async function () {
    this.timeout(5000); // 延长测试超时时间，适配重试逻辑

    const samplePath = path.resolve(__dirname, '../../fixtures/sample-001_small-project');
    const expectedPath = path.resolve(__dirname, '../../fixtures/expected/sample-001_small-project.txt');
    const expectedOutput = fs.readFileSync(expectedPath, 'utf-8').trim();

    // 调用扩展的完整方法，触发剪贴板写入
    await myAwesomeMethod(samplePath);

    // 读取剪贴板内容（带重试）
    const clipboardContent = await readClipboardWithRetry();

    // 断言对比
    assert.strictEqual(clipboardContent.trim(), expectedOutput);
  });
});

关键注意事项 #

• macOS权限问题：确保测试运行的Electron实例（由@vscode/test-electron启动）拥有剪贴板访问权限，可在系统设置「隐私与安全性」中检查配置
• 异步时机控制：避免用死循环重试，带延迟的重试逻辑更友好，不会过度占用系统资源
• 换行符统一：不同系统的换行符（\n vs \r\n）可能导致对比失败，可统一转换为同一种格式后再执行断言
• 测试隔离：每个测试用例前后清空剪贴板，防止前序测试的残留内容影响当前测试结果

内容的提问来源于stack exchange，提问作者null-point-exceptional