このマルチパート リファレンスでは、Power Query コネクタ開発者向けの標準のテスト スイートのセットアップと実行について説明します。 このリファレンスは、拡張機能コネクタをテストするために環境が設定されていることを確認するために、順番に従う必要があります。
このリファレンスでは、Power Query SDK テスト フレームワーク、標準化されたテスト スイート、および NewYork City Taxi & リムジン委員会 (TLC) のグリーン トリップ レコード データの変更バージョンを使用します。 以降のセクションでは、拡張機能コネクタを検証するために環境をセットアップする手順について説明します。
テスト フレームワークを使用すると、Power Query SDK 開発者は標準テストとテスト ハーネスにアクセスして、拡張機能コネクタの DirectQuery (DQ) 機能を検証できます。 この新機能により、開発者はコネクタを検証する標準的な方法と、カスタム テストを追加するためのプラットフォームを備えました。 これは、Power Query SDK によって提供されるテスト ワークフローの生産性を向上させるための最初のステップとして想定されています。
Power Query SDK テスト フレームワークとは
Power Query SDK テスト フレームワークは、新規および既存の拡張コネクタのテストを標準化するための事前構築済みテストを備えた、すぐにto-go テスト ハーネスです。 機能、コンプライアンス、回帰テストを大規模に実行する機能があります。 これは、拡張コネクタのニーズを満たす包括的なテスト フレームワークのニーズに対応するのに役立ちます。
開発者向けのワークフロー
次の一覧は、テスト フレームワークを使用した一般的な Power Query SDK 開発者ワークフローです。
- Power Query SDK Visual Studio Code 拡張機能をインストールします 。コネクタ開発者は、拡張機能コネクタを開発するために PowerQuery SDK Visual Studio Code 拡張機能をインストールする必要があります。 Visual Studio Code 拡張機能は、テスト ハーネス PQTest.exeも含む Microsoft.PowerQuery.SdkTools NuGet パッケージをラップします。 PQTest テスト ハーネスには、テスト フレームワークに存在するテストを実行するための新しい compare コマンドが含まれています。
- DataConnectors GitHub リポジトリを複製 します。 DataConnectors GitHub リポジトリを複製して、テスト フレームワークに含まれる テスト データ と テスト にアクセスします。 これらのテストの詳細については、 PowerQuery SDK テスト フレームワークパート 3 - テスト スイートに関するページを参照してください。
- テスト データをデータ ソースに読み込みます。 コネクタ開発者は、2 つの CSV ファイルで構成されるテスト データをデータ ソースにテーブルとして読み込む必要があります。これにより、スキーマが指定された SQL スキーマ ファイルと一致することが保証されます。 詳細については、「 Power Query SDK テスト フレームワークパート 2 - テスト データ」を参照してください。
- テストを構成して実行します。 コネクタ開発者は、提供された RunPQSDKTestSuites PowerShell ユーティリティを使用してテストを実行する必要があります。このユーティリティでは、PQTest compare コマンドを使用してテストを実行します。 詳細については、「 Power Query SDK テスト フレームワークパート 5 - 拡張機能コネクタのテスト」を参照してください。
- レポートと CI/CD: 既定のテスト レポートはコンソールで生成され、概要、詳細、TRX、JSON 形式でレポートを生成するオプションもあります。 TRX (Visual Studio テスト結果ファイル) 形式は、パイプラインの一部として実行されるときに結果を表示するのに役立ちます。 詳細については、 Power Query SDK テスト フレームワークのパート 7 - パイプライン ガイドに関するページを参照してください。
テスト フレームワークの目標
Power Query SDK テスト フレームワークの長期的な目標は、拡張機能コネクタをテストするために Visual Studio Code SDK と統合された堅牢なテスト ソリューションを提供することです。 コネクタの開発のための開発者エクスペリエンスを大幅に向上させる必要があります。 また、むしろ断片化したテスト プラクティスに標準化を取り入れ、最終的に品質バーを増やし、コネクタの持続可能性の取り組みを減らす必要があります。
テスト フレームワークの最初のリリースの目標は、次の機能を提供することです。
- ユーザーが拡張機能コネクタを簡単にテストするためのコマンドライン ユーティリティを簡単に使用できます 。テスト フレームワークでは、PQTest compare コマンドと、テストを実行するための直感的なオプションが導入されています。 また、RunPQSDKTestSuites PowerShell ユーティリティも提供されます。これはバッチ テストにも役立ちます。 テストを構成して実行するための簡単で自動の構成が用意されています。
- 準備完了- コネクタを検証するために実行する標準テストの初期セットをto-go します 。テスト フレームワークには、テスト テーブルのスキーマ、行数、データを検証するためのサニティ テストのスイートが用意されています。 また、Datatypes、Math、Date、Time、Text 関数、演算子、結合を検証するための標準のテスト スイートも用意されています。
- テストを手動で追加してテストを拡張する簡単な方法: テスト フレームワークのテストでは、新しい PQ/PQOut テスト形式が使用されます。これにより、必要な構成を最小限に抑えることで、テスト作成プロセスが簡略化されます。 コネクタ開発者は、テスト用の M クエリの作成に集中できます。 各テストはモジュール式で、個々のファイルに分けてメンテナンスを簡素化します。 予想される出力は、最初の実行時にも生成されます。
- クエリ フォールディング テストをテストする機能: テスト フレームワークでは、コネクタの診断を生成することもできます。 現在、診断機能は、ODBC ベースのコネクタのクエリ フォールディング中の SQL クエリ生成に限定されています。 この機能は、今後他の診断に拡張される予定です。
リファレンス ガイドの概要
このガイドでは、次の操作を行います。
- Power Query SDK のテスト フレームワークについて理解を深めます。
- テスト フレームワークをインストールして開発環境を設定する方法について説明します。
- テスト スイートで使用されているデータセットをフェッチし、拡張機能コネクタに基づいてデータ ソースにアップロードします。
- テスト フレームワーク内のファイル形式とその機能であるテスト形式の仕様について理解します。
- 拡張機能コネクタを検証するためのテストを含むテスト スイートをフェッチして実行します。
- 異なる構成で個々のテストを実行します。
- 独自のテストを追加して、コネクタ固有の機能を確認します。
- テストのパイプラインを設定して、テストの実行を自動化します。
部品
| 要素 | section | 詳細 |
|---|---|---|
| 1 | セットアップ | 環境を設定します。 |
| 2 | データの準備 | テスト データの準備。 |
| 3 | テスト スイート | テスト スイートのフェッチと理解。 |
| 4 | テスト形式仕様 | テスト フレームワークで使用されるさまざまなファイル形式について理解する。 |
| 5 | コネクタのテスト | 拡張機能コネクタのテスト。 |
| 6 | テストの追加 | 独自のテストを追加し、テスト フレームワークのさまざまなオプションと構成を理解します。 |
| 7 | パイプラインのセットアップ ガイド | パイプラインでテストを実行する。 |