测试 API

测试 API 允许 Visual Studio Code 扩展发现工作区中的测试并发布结果。用户可以在“测试资源管理器”视图、通过装饰或在命令中执行测试。借助这些新的 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 是测试 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。当用户采取操作要求发现测试时，例如在测试资源管理器中展开一个项，就会调用 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 时，你应该继续监视更改，以便测试资源管理器中的数据保持最新。

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 中的各种按钮（例如“测试资源管理器”视图中的终端图标）中显示在终端中。

由于字符串在终端中渲染，你可以使用完整的 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 添加文件覆盖率，在这种情况下，新信息将替换旧信息。

一旦用户打开带有覆盖率的文件或在测试覆盖率视图中展开文件，VS Code 将请求该文件的更多信息。它通过在 TestRunProfile 上调用扩展定义的 loadDetailedCoverage 方法来实现，该方法带有 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 对象数组的 Promise。这两个对象都包含一个 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];
}

用户还可以在“测试资源管理器”UI 中按标签筛选。

仅发布控制器

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

在这种情况下，这些控制器通常应该将可选的 name 参数传递给 createTestRun，并将 persist 参数设置为 false。此处传递 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 迁移

如果你有使用 Test Explorer UI 的现有扩展，我们建议你迁移到原生体验以获得附加功能和效率。我们整理了一个仓库，其中包含 Test Adapter 示例在其 Git 历史记录中的迁移示例。你可以通过选择提交名称查看每个步骤，从 [1] Create a native TestController 开始。

总之，一般步骤如下

1. 不必通过 Test Explorer UI 的 TestHub 获取和注册 TestAdapter，而是调用 const controller = vscode.tests.createTestController(...)。

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

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

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)。