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