测试 API

测试 API 允许 Visual Studio Code 扩展在工作区中发现测试并发布结果。用户可以在 Test Explorer 视图、装饰以及命令中执行测试。使用这些新的 API，Visual Studio Code 支持比以前更丰富的输出和差异显示。

注意：测试 API 在 VS Code 版本 1.59 及更高版本中可用。

示例

VS Code 团队维护着两个测试提供程序

• 示例测试扩展，它在 Markdown 文件中提供测试。
• 自托管测试扩展，我们用它在 VS Code 本身中运行测试。

发现测试

测试由 TestController 提供，它需要一个全局唯一的 ID 和可读标签来创建

const controller = vscode.tests.createTestController(
  'helloWorldTests',
  'Hello World Tests'
);

要发布测试，你需要将 TestItem 作为子项添加到控制器的 items 集合中。TestItem 是 TestItem 接口中测试 API 的基础，是一种通用类型，可以描述代码中存在的测试用例、套件或树项。它们本身也可以有 children，形成层次结构。例如，以下是如何创建测试的示例测试扩展的简化版本

parseMarkdown(content, {
  onTest: (range, numberA, mathOperator, numberB, expectedValue) => {
    // If this is a top-level test, add it to its parent's children. If not,
    // add it to the controller's top level items.
    const collection = parent ? parent.children : controller.items;
    // Create a new ID that's unique among the parent's children:
    const id = [numberA, mathOperator, numberB, expectedValue].join('  ');

    // Finally, create the test item:
    const test = controller.createTestItem(id, data.getLabel(), item.uri);
    test.range = range;
    collection.add(test);
  }
  // ...
});

与诊断类似，大多数情况下由扩展控制何时发现测试。简单的扩展可能会监视整个工作区并在激活时解析所有文件中的所有测试。但是，对于大型工作区来说，立即解析所有内容可能很慢。相反，你可以做两件事

1. 在编辑器中打开文件时主动发现该文件的测试，方法是监视 vscode.workspace.onDidOpenTextDocument。
2. 设置 item.canResolveChildren = true 并设置 controller.resolveHandler。如果用户采取了要求发现测试的操作，例如在 Test Explorer 中展开项，则会调用 resolveHandler。

以下是如何在延迟解析文件的扩展中使用此策略

// First, create the `resolveHandler`. This may initially be called with
// "undefined" to ask for all tests in the workspace to be discovered, usually
// when the user opens the Test Explorer for the first time.
controller.resolveHandler = async test => {
  if (!test) {
    await discoverAllFilesInWorkspace();
  } else {
    await parseTestsInFileContents(test);
  }
};

// When text documents are open, parse tests in them.
vscode.workspace.onDidOpenTextDocument(parseTestsInDocument);
// We could also listen to document changes to re-parse unsaved changes:
vscode.workspace.onDidChangeTextDocument(e => parseTestsInDocument(e.document));

// In this function, we'll get the file TestItem if we've already found it,
// otherwise we'll create it with `canResolveChildren = true` to indicate it
// can be passed to the `controller.resolveHandler` to gets its children.
function getOrCreateFile(uri: vscode.Uri) {
  const existing = controller.items.get(uri.toString());
  if (existing) {
    return existing;
  }

  const file = controller.createTestItem(uri.toString(), uri.path.split('/').pop()!, uri);
  file.canResolveChildren = true;
  return file;
}

function parseTestsInDocument(e: vscode.TextDocument) {
  if (e.uri.scheme === 'file' && e.uri.path.endsWith('.md')) {
    parseTestsInFileContents(getOrCreateFile(e.uri), e.getText());
  }
}

async function parseTestsInFileContents(file: vscode.TestItem, contents?: string) {
  // If a document is open, VS Code already knows its contents. If this is being
  // called from the resolveHandler when a document isn't open, we'll need to
  // read them from disk ourselves.
  if (contents === undefined) {
    const rawContent = await vscode.workspace.fs.readFile(file.uri);
    contents = new TextDecoder().decode(rawContent);
  }

  // some custom logic to fill in test.children from the contents...
}

discoverAllFilesInWorkspace 的实现可以使用 VS Code 现有的文件监视功能构建。当调用 resolveHandler 时，你应该继续监视更改，以便 Test Explorer 中的数据保持最新。

async function discoverAllFilesInWorkspace() {
  if (!vscode.workspace.workspaceFolders) {
    return []; // handle the case of no open folders
  }

  return Promise.all(
    vscode.workspace.workspaceFolders.map(async workspaceFolder => {
      const pattern = new vscode.RelativePattern(workspaceFolder, '**/*.md');
      const watcher = vscode.workspace.createFileSystemWatcher(pattern);

      // When files are created, make sure there's a corresponding "file" node in the tree
      watcher.onDidCreate(uri => getOrCreateFile(uri));
      // When files change, re-parse them. Note that you could optimize this so
      // that you only re-parse children that have been resolved in the past.
      watcher.onDidChange(uri => parseTestsInFileContents(getOrCreateFile(uri)));
      // And, finally, delete TestItems for removed files. This is simple, since
      // we use the URI as the TestItem's ID.
      watcher.onDidDelete(uri => controller.items.delete(uri.toString()));

      for (const file of await vscode.workspace.findFiles(pattern)) {
        getOrCreateFile(file);
      }

      return watcher;
    })
  );
}

TestItem 接口很简单，没有空间存储自定义数据。如果你需要将额外信息与 TestItem 关联，可以使用 WeakMap

const testData = new WeakMap<vscode.TestItem, MyCustomData>();

// to associate data:
const item = controller.createTestItem(id, label);
testData.set(item, new MyCustomData());

// to get it back later:
const myData = testData.get(item);

保证传递给所有与 TestController 相关的函数的 TestItem 实例与最初使用 createTestItem 创建的实例相同，因此你可以确保从 testData 地图中获取项会成功。

对于此示例，让我们只存储每个项的类型

enum ItemType {
  File,
  TestCase
}

const testData = new WeakMap<vscode.TestItem, ItemType>();

const getType = (testItem: vscode.TestItem) => testData.get(testItem)!;

运行测试

测试通过 TestRunProfile 执行。每个配置文件都属于一个特定的执行 kind：运行、调试或覆盖。大多数测试扩展最多在每个组中只有一个配置文件，但允许更多。例如，如果你的扩展在多个平台上运行测试，你可以在每个平台和 kind 的组合中有一个配置文件。每个配置文件都有一个 runHandler，当请求该类型的运行时会调用它。

function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  // todo
}

const runProfile = controller.createRunProfile(
  'Run',
  vscode.TestRunProfileKind.Run,
  (request, token) => {
    runHandler(false, request, token);
  }
);

const debugProfile = controller.createRunProfile(
  'Debug',
  vscode.TestRunProfileKind.Debug,
  (request, token) => {
    runHandler(true, request, token);
  }
);

runHandler 应该至少调用一次 controller.createTestRun，并将原始请求传递给它。该请求包含要 include 在测试运行中的测试（如果用户要求运行所有测试，则省略）以及可能要从运行中 exclude 的测试。扩展应该使用生成的 TestRun 对象更新参与运行的测试的状态。例如

async function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  const run = controller.createTestRun(request);
  const queue: vscode.TestItem[] = [];

  // Loop through all included tests, or all known tests, and add them to our queue
  if (request.include) {
    request.include.forEach(test => queue.push(test));
  } else {
    controller.items.forEach(test => queue.push(test));
  }

  // For every test that was queued, try to run it. Call run.passed() or run.failed().
  // The `TestMessage` can contain extra information, like a failing location or
  // a diff output. But here we'll just give it a textual message.
  while (queue.length > 0 && !token.isCancellationRequested) {
    const test = queue.pop()!;

    // Skip tests the user asked to exclude
    if (request.exclude?.includes(test)) {
      continue;
    }

    switch (getType(test)) {
      case ItemType.File:
        // If we're running a file and don't know what it contains yet, parse it now
        if (test.children.size === 0) {
          await parseTestsInFileContents(test);
        }
        break;
      case ItemType.TestCase:
        // Otherwise, just run the test case. Note that we don't need to manually
        // set the state of parent tests; they'll be set automatically.
        const start = Date.now();
        try {
          await assertTestPasses(test);
          run.passed(test, Date.now() - start);
        } catch (e) {
          run.failed(test, new vscode.TestMessage(e.message), Date.now() - start);
        }
        break;
    }

    test.children.forEach(test => queue.push(test));
  }

  // Make sure to end the run after all tests have been executed:
  run.end();
}

除了 runHandler 之外，你还可以设置 TestRunProfile 上的 configureHandler。如果存在，VS Code 将具有 UI，允许用户配置测试运行，并在他们这样做时调用处理程序。从此处，你可以打开文件、显示快速选择或执行对你的测试框架适宜的操作。

VS Code 故意将测试配置与调试或任务配置区别对待。这些传统上是编辑器或 IDE 为中心的特性，并在 .vscode 文件夹中的特殊文件中进行配置。但是，测试传统上是从命令行执行的，大多数测试框架都有现有的配置策略。因此，在 VS Code 中，我们避免配置重复，而是将处理留给扩展。

测试输出

除了传递给 TestRun.failed 或 TestRun.errored 的消息外，你还可以使用 run.appendOutput(str) 附加通用输出。此输出可以使用 Test: Show Output 在终端中显示，也可以通过 UI 中的各种按钮显示，例如 Test Explorer 视图中的终端图标。

因为字符串是在终端中呈现的，所以你可以使用完整的 ANSI 代码 集，包括 ansi-styles npm 包中提供的样式。请记住，因为是在终端中，所以行必须使用 CRLF (\r\n) 换行，而不仅仅是 LF (\n)，这可能是某些工具的默认输出。

测试覆盖率

测试覆盖率通过 run.addCoverage() 方法与 TestRun 关联。传统上这应该由 TestRunProfileKind.Coverage 配置文件运行的 runHandler 完成，但可以在任何测试运行期间调用它。addCoverage 方法接受一个 FileCoverage 对象，它是该文件中覆盖率数据的摘要

async function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  // ...

  for await (const file of readCoverageOutput()) {
    run.addCoverage(new vscode.FileCoverage(file.uri, file.statementCoverage));
  }
}

FileCoverage 包含每个文件中语句、分支和声明的总覆盖和未覆盖计数。根据你的运行时和覆盖率格式，你可能会看到语句覆盖率被称为行覆盖率，或者声明覆盖率被称为函数或方法覆盖率。你可以在单个 URI 中多次添加文件覆盖率，在这种情况下，新信息将替换旧信息。

一旦用户打开具有覆盖率的文件或在 Test Coverage 视图中展开文件，VS Code 将请求该文件的更多信息。它通过调用扩展定义的 loadDetailedCoverage 方法在 TestRunProfile 上进行操作，并传入 TestRun、FileCoverage 和 CancellationToken。请注意，测试运行和文件覆盖率实例与 run.addCoverage 中使用的实例相同，这对于关联数据很有用。例如，你可以创建 FileCoverage 对象到你自己的数据的映射

const coverageData = new WeakMap<vscode.FileCoverage, MyCoverageDetails>();

profile.loadDetailedCoverage = (testRun, fileCoverage, token) => {
  return coverageData.get(fileCoverage).load(token);
};

async function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  // ...

  for await (const file of readCoverageOutput()) {
    const coverage = new vscode.FileCoverage(file.uri, file.statementCoverage);
    coverageData.set(coverage, file);
    run.addCoverage(coverage);
  }
}

或者，你可能会使用包含该数据的实现对 FileCoverage 进行子类化

class MyFileCoverage extends vscode.FileCoverage {
  // ...
}

profile.loadDetailedCoverage = async (testRun, fileCoverage, token) => {
  return fileCoverage instanceof MyFileCoverage ? await fileCoverage.load() : [];
};

async function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  // ...

  for await (const file of readCoverageOutput()) {
    // 'file' is MyFileCoverage:
    run.addCoverage(file);
  }
}

loadDetailedCoverage 预计返回对 DeclarationCoverage 和/或 StatementCoverage 对象数组的承诺。这两个对象都包含 Position 或 Range，它们可以在源文件中找到。DeclarationCoverage 对象包含被声明事物的名称（例如函数或方法名称）以及进入或调用该声明的次数。语句包含执行的次数，以及零个或多个相关分支。有关更多信息，请参阅 vscode.d.ts 中的类型定义。

在许多情况下，你可能有来自测试运行的持久文件。最佳实践是将此类覆盖率输出放在系统的临时目录中（你可以通过 require('os').tmpdir() 获取），但你也可以通过监听 VS Code 的提示来积极清理它们，它不再需要保留测试运行

import { promises as fs } from 'fs';

async function runHandler(
  shouldDebug: boolean,
  request: vscode.TestRunRequest,
  token: vscode.CancellationToken
) {
  // ...

  run.onDidDispose(async () => {
    await fs.rm(coverageOutputDirectory, { recursive: true, force: true });
  });
}

测试标签

有时测试只能在某些配置下运行，或者根本无法运行。对于这些用例，你可以使用测试标签。TestRunProfile 可选地可以与一个标签关联，如果有，则只有具有该标签的测试才能在该配置文件下运行。再次强调，如果没有适合运行、调试或收集特定测试覆盖率的配置文件，则这些选项不会在 UI 中显示。

// Create a new tag with an ID of "runnable"
const runnableTag = new TestTag('runnable');

// Assign it to a profile. Now this profile can only execute tests with that tag.
runProfile.tag = runnableTag;

// Add the "runnable" tag to all applicable tests.
for (const test of getAllRunnableTests()) {
  test.tags = [...test.tags, runnableTag];
}

用户也可以在 Test Explorer UI 中按标签进行过滤。

仅发布控制器

运行配置文件的存在是可选的。控制器允许创建测试，在runHandler之外调用createTestRun，并在没有配置文件的情况下更新运行中的测试状态。这种常见用例适用于从外部来源（如 CI 或摘要文件）加载结果的控制器。

在这种情况下，这些控制器通常应该将可选的name参数传递给createTestRun，并将false传递给persist参数。在这里传递false指示 VS Code 不要保留测试结果，就像它在编辑器中对运行操作那样，因为这些结果可以从外部来源外部重新加载。

const controller = vscode.tests.createTestController(
  'myCoverageFileTests',
  'Coverage File Tests'
);

vscode.commands.registerCommand('myExtension.loadTestResultFile', async file => {
  const info = await readFile(file);

  // set the controller items to those read from the file:
  controller.items.replace(readTestsFromInfo(info));

  // create your own custom test run, then you can immediately set the state of
  // items in the run and end it to publish results:
  const run = controller.createTestRun(
    new vscode.TestRunRequest(),
    path.basename(file),
    false
  );
  for (const result of info) {
    if (result.passed) {
      run.passed(result.item);
    } else {
      run.failed(result.item, new vscode.TestMessage(result.message));
    }
  }
  run.end();
});

从 Test Explorer UI 迁移

如果你有一个现有的使用测试资源管理器 UI 的扩展，我们建议你迁移到原生体验以获得更多功能和效率。我们已经整理了一个包含测试适配器示例迁移的存储库，在它的 Git 历史记录 中。你可以通过选择提交名称来查看每个步骤，从[1] 创建一个原生 TestController开始。

总而言之，一般步骤如下：

1. 不要使用测试资源管理器 UI 的TestHub检索和注册TestAdapter，而是调用const controller = vscode.tests.createTestController(...)。

2. 当你发现或重新发现测试时，不要触发testAdapter.tests，而是创建并将测试推送到controller.items中，例如通过使用调用vscode.test.createTestItem创建的已发现测试数组调用controller.items.replace。请注意，随着测试的变化，你可以在测试项上修改属性并更新其子项，更改将在 VS Code 的 UI 中自动反映。

3. 要最初加载测试，不要等待testAdapter.load() 方法调用，而是设置controller.resolveHandler = () => { /* 发现测试 */ }。有关测试发现工作原理的更多信息，请参见 发现测试。

4. 要运行测试，你应该创建一个 运行配置文件，其中包含一个调用const run = controller.createTestRun(request) 的处理程序函数。不要触发testStates 事件，而是将TestItem传递给run上的方法以更新其状态。

其他贡献点

testing/item/context 菜单贡献点 可用于在测试资源管理器视图中的测试中添加菜单项。将菜单项放在inline 组中，以使其成为内联。所有其他菜单项组都将在使用鼠标右键访问的上下文菜单中显示。

菜单项的when 子句中提供了其他 上下文键：testId、controllerId 和testItemHasUri。对于更复杂的when 场景，你希望操作可选择地用于不同的测试项，请考虑使用 in 条件运算符。

如果你想在资源管理器中显示测试，你可以将测试传递给命令vscode.commands.executeCommand('vscode.revealTestInExplorer', testItem)。