Testing API
Testing API により、Visual Studio Code 拡張機能はワークスペース内のテストを検出して結果を公開できます。ユーザーは、テストエクスプローラービュー、デコレーション、およびコマンド内でテストを実行できます。これらの新しい API により、Visual Studio Code は以前よりも豊富な出力と差分表示をサポートします。
注: Testing API は VS Code バージョン 1.59 以降で利用可能です。
例
VS Code チームが管理するテストプロバイダーは 2 つあります。
- Markdown ファイルでテストを提供するサンプルテスト拡張機能。
- VS Code 自体でテストを実行するために使用するセルフホストテスト拡張機能。
テストの検出
テストはTestControllerによって提供され、これを作成するにはグローバルに一意の ID と人間が判読できるラベルが必要です。
const controller = vscode.tests.createTestController(
'helloWorldTests',
'Hello World Tests'
);
テストを公開するには、TestControllerのitemsコレクションにTestItemを子として追加します。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);
}
// ...
});
診断と同様に、テストがいつ検出されるかを制御するのは主に拡張機能次第です。単純な拡張機能は、ワークスペース全体を監視し、アクティベーション時にすべてのファイル内のすべてのテストを解析する場合があります。ただし、すべてをすぐに解析すると、大規模なワークスペースでは遅くなる可能性があります。代わりに、次の 2 つの方法があります。
vscode.workspace.onDidOpenTextDocumentを監視することにより、エディターでファイルが開かれたときにそのファイルのテストを積極的に検出する。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 (実行、デバッグ、またはカバレッジ) に属します。ほとんどのテスト拡張機能は、これらのグループのそれぞれに最大 1 つのプロファイルを持ちますが、より多くも許可されます。たとえば、拡張機能が複数のプラットフォームでテストを実行する場合、プラットフォームとkindの組み合わせごとに 1 つのプロファイルを持つことができます。各プロファイルには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は、少なくとも 1 回、元のリクエストを渡して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)を使用して汎用出力を追加できます。この出力は、テスト: 出力を表示を使用するターミナルや、テストエクスプローラービューのターミナルアイコンなど、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 はそのファイルの詳細情報を要求します。これは、TestRun、FileCoverage、およびCancellationTokenを指定して、TestRunProfileの拡張機能定義のloadDetailedCoverageメソッドを呼び出すことで行われます。テスト実行とファイルカバレッジのインスタンスは、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オブジェクトには、宣言されているもの (関数名やメソッド名など) の名前と、その宣言が入力または呼び出された回数が含まれています。ステートメントには、実行された回数と、0 個以上の関連ブランチが含まれています。詳細については、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 や要約ファイルなどの外部ソースから結果をロードするコントローラーです。
この場合、これらのコントローラーは通常、createTestRunにオプションのname引数と、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();
});
テストエクスプローラー UI からの移行
既存の Test Explorer UI を使用している拡張機能がある場合は、追加機能と効率のためにネイティブエクスペリエンスに移行することをお勧めします。Test Adapter サンプルの移行例をGit 履歴にまとめたリポジトリを作成しました。[1] Create a native TestControllerから始めて、コミット名を選択することで各ステップを表示できます。
まとめると、一般的な手順は次のとおりです。
-
Test Explorer UI の
TestHubでTestAdapterを取得して登録する代わりに、const controller = vscode.tests.createTestController(...)を呼び出します。 -
テストを検出または再検出したときに
testAdapter.testsを起動するのではなく、vscode.test.createTestItemを呼び出して作成された検出されたテストの配列でcontroller.items.replaceを呼び出すなどして、controller.itemsにテストを作成してプッシュします。テストが変更されると、テストアイテムのプロパティを変更したり、子を更新したりすることができ、変更は VS Code の UI に自動的に反映されます。 -
最初にテストをロードするには、
testAdapter.load()メソッド呼び出しを待つのではなく、controller.resolveHandler = () => { /* discover tests */ }を設定します。テスト検出の仕組みの詳細については、「テストの検出」を参照してください。 -
テストを実行するには、
const run = controller.createTestRun(request)を呼び出すハンドラー関数を持つ実行プロファイルを作成する必要があります。testStatesイベントを起動する代わりに、TestItemをrunのメソッドに渡してその状態を更新します。
追加のコントリビューションポイント
testing/item/context メニュー貢献ポイントを使用して、テストエクスプローラービューのテストにメニュー項目を追加できます。メニュー項目をinlineグループに配置すると、インラインで表示されます。その他のすべてのメニュー項目グループは、マウスの右クリックでアクセスできるコンテキストメニューに表示されます。
メニュー項目のwhen句では、testId、controllerId、testItemHasUriといった追加のコンテキストキーが利用可能です。より複雑なwhenシナリオで、異なるテスト項目に対してアクションをオプションで利用可能にしたい場合は、in条件演算子の使用を検討してください。
エクスプローラーでテストを表示したい場合は、テストをコマンドvscode.commands.executeCommand('vscode.revealTestInExplorer', testItem)に渡すことができます。