测试 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 的基础，位于 TestItem 接口中，是一种泛型类型，可以描述代码中存在的测试用例、套件或树项。它们反过来也可以拥有自己的 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);
  }
  // ...
});

与 Diagnostics 类似，大部分控制测试发现时机的工作由扩展完成。一个简单的扩展可能会监视整个工作区，并在激活时解析所有文件中的所有测试。但是，立即解析所有内容对于大型工作区来说可能会很慢。相反，您可以执行以下两件事

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，当请求该类型的运行（例如运行测试）时会调用该 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，并传递原始请求。请求包含要包含在测试运行中的测试（如果用户要求运行所有测试，则省略），以及可能要从运行中排除的测试。扩展应该使用生成的 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) 附加通用输出。可以使用 测试：显示输出 以及测试资源管理器视图中的各种按钮（例如终端图标）在终端中显示此输出。

由于字符串在终端中呈现，因此可以使用完整的 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 对象的数组。这两个对象都包含可以在源代码中找到它们的位置或范围。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，并将 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();
});

从测试资源管理器 UI 迁移

如果您有一个使用测试资源管理器 UI 的现有扩展，我们建议您迁移到本机体验，以获得额外的功能和效率。我们准备了一个存储库，其中包含示例迁移的 Git 历史记录。您可以选择提交名称来查看每个步骤，从 [1] 创建本机 TestController 开始。

总而言之，一般步骤是

1. 不要检索并使用测试资源管理器 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 = () => { /* 发现测试 */ }。有关测试发现的工作方式的更多信息，请参见 发现测试。

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