テスト戦略の設計と実装

完了済み

正常にビルドされた SQL データベース プロジェクトは、その中のストアド プロシージャが正しい結果を返すという意味にはなりません。 プロシージャはエラーなしでコンパイルしても、間違った合計を計算したり、検証チェックをスキップしたりする可能性があります。 テストでは、運用環境に到達する前にこれらの問題をキャッチします。

データベース のテスト レベルについて

データベース テストはレイヤーで動作し、それぞれが異なるクラスの問題をキャッチします。

  • ビルド検証 は、既にある dotnet build ステップです。 構文エラーと破損したオブジェクト参照をキャッチします。 高速ですが、スキーマが構造的に有効であることが証明されるだけです。
  • 単体テストでは 、個々のストアド プロシージャと関数によって、特定の入力セットに対して適切な結果が生成されることを確認します。 ロジック エラーをキャッチします。
  • 統合テスト では、デプロイされたデータベースに対してエンド ツー エンドのシナリオが実行されます。 オブジェクトが正常に連携していることを証明しますが、実行中のインスタンスが必要であり、最も時間がかかります。

各レイヤーは、前のレイヤーよりも遅く、コストが高くなりますが、前のレイヤーではできない問題もキャッチします。

SQL Server 単体テストを作成する

Visual Studio の SQL Server Data Tools (SSDT) には、データベース単体テスト用の組み込みフレームワークが含まれています。 各テストは、ライブ データベースに対して T-SQL を実行し、テスト条件を使用して結果を検証します。

単体テストの構造

各テストには、setup-execute-cleanup パターンに従う 3 つのセクションがあります。

  • 事前テスト: テストに必要なデータを設定します。 顧客レコードを挿入し、前の実行から残ったデータを消去します。
  • テスト: テストする操作を実行します。 ストアド プロシージャを呼び出し、ビューに対してクエリを実行します。
  • テスト後: テスト後にクリーンアップして、次の実行を汚染しないようにします。

テスト条件

テスト T-SQL を実行した後、 テスト条件 で何が返されたのかを検証します。 最も一般的に使用される条件は次のとおりです。

  • 行数: 結果セットに予想される行数が含まれていることを確認します。
  • スカラー値: 結果セット内の特定のセルに予期される値が含まれていることを確認します。
  • 予期されるスキーマ: 結果セットに予期される列名とデータ型があることを確認します。

その他の組み込み条件としては、 データ チェックサム、 空の ResultSet、 空でない ResultSet、 実行時間などがあります。

単体テスト プロジェクトを作成する

Visual Studio で SQL Server 単体テストを設定するには、いくつかの手順が必要です。

  1. SQL データベース プロジェクトを開きます。
  2. SQL Server オブジェクト エクスプローラーで、テストするストアド プロシージャまたは関数を見つけます。
  3. オブジェクトを右クリックし、[ 単体テストの作成] を選択します。
  4. C# テスト プロジェクトを選択または作成します。
  5. 開発データベースへのテスト接続を設定します。
  6. 単体テストを実行する前に、データベース プロジェクトを自動的に配置するを選択します。 このオプションを選択すると、テスト データベースが最新のプロジェクトの変更と同期されます。

デザイナーが開き、テスト ロジックを記述してテスト条件をアタッチする T-SQL テンプレートが表示されます。

効果的なデータベース単体テストを記述する

適切な単体テストでは、"この手順は既知の入力に対して想定される処理を行いますか" という特定の質問に答えます。次に示すのは、 uspPlaceNewOrderをテストし、注文によって顧客の年累計が正しく更新されることを確認する例です。

-- Pre-test: Set up customer and clear previous data
DECLARE @CustomerID INT;
INSERT INTO [Sales].[Customer] (CustomerName) VALUES (N'Test Customer');
SET @CustomerID = SCOPE_IDENTITY();
DELETE FROM [Sales].[Orders] WHERE [CustomerID] = @CustomerID;

-- Test: Place an order and verify YTDOrders updated correctly
DECLARE @RC INT;
EXECUTE @RC = [Sales].[uspPlaceNewOrder] @CustomerID, 100, GETDATE(), 'O';

SELECT [YTDOrders]
FROM [Sales].[Customer]
WHERE [CustomerID] = @CustomerID;

📝このテスト T-SQL と、YTDOrders 値が 100 であることを想定するスカラー値テストの条件を組み合わせます。

否定的なテスト

また、ストアド プロシージャが無効な入力を受け取ったときに正しく失敗することも確認する必要があります。 たとえば、既に出荷された注文をキャンセルすると、エラーが発生し、警告なしでは成功しないなどです。 負のテストでは、予期されるエラーが発生することを確認します。

前のセクションの手順 3 で [単体テストの作成 ] を選択すると、Visual Studio によって ソリューション エクスプローラー に C# テスト プロジェクトが生成され、選択したストアド プロシージャごとにテストが含まれる .cs ファイルが生成されます。 たとえば、 uspCancelOrderのテストを作成した場合、生成されたファイルには Sales_uspCancelOrder_Test という名前のセクションが含まれます。 そのテストを否定テストとしてマークするには、.csで ファイルを開き、その真上に ExpectedSqlException 属性を追加して、ファイルを保存します。

[TestMethod()]
[ExpectedSqlException(Severity = 16, MatchFirstError = false, State = 1)]
public void Sales_uspCancelOrder_FilledOrder_Test()

このテストは、ストアド プロシージャが指定された重大度と状態に一致するエラーを発生させる場合にのみ合格します。 プロシージャがサイレントで成功した場合、テストは失敗しますが、これはまさに望んでいることです。

統合テスト アプローチを設計する

単体テストでは、個々のオブジェクトを分離します。 統合テストはさらに進み、複数の操作にまたがるシナリオをテストします。 次のような質問に答えます。

  • ストアド プロシージャ呼び出しのシーケンスは、データベースを予期した状態のままにしますか?
  • トリガーは、アプリケーションレイヤーを経由してデータが到着したときに正しく起動しますか?
  • 関連するテーブルの一連の変更後、ビューは正確な結果を返しますか?

統合テストには専用データベースが必要です。 [単体テストを実行する前にデータベース プロジェクトを自動的に配置する] 設定を使用して、各実行 の前に SQL データベース プロジェクトをテスト インスタンスにデプロイ します。 この設定により、テスト スキーマが最新の状態に保たれます。

テスト データベースに関する考慮事項

単体テストと統合テストはどちらもライブ データベースに対して T-SQL を実行するため、テスト環境では信頼性の高い結果を生成するために慎重なセットアップが必要です。

  • 運用環境からテストを分離する。 別のインスタンスまたは専用のテスト データベースを使用します。 運用環境に対するテストの実行は推奨されません。
  • 各実行の前に既知の状態にリセットします。 デプロイ後のスクリプトまたはテスト クリーンアップ スクリプトは、この問題を処理します。
  • ローカル開発パイプラインと CI パイプラインがコードを変更せずに適切なデータベースを指すように、構成ファイル内の接続文字列を外部化します。

CI/CD パイプラインにテストを統合する

ビルドとデプロイの後にテスト ステップを追加して、すべてのコミットでテストが自動的に実行されるようにします。 Azure DevOps で、 VSTest タスクを使用します。

- task: VSTest@2
  inputs:
    testAssembly: '**\*Tests.dll'
    searchFolder: '$(System.DefaultWorkingDirectory)'

GitHub Actions で、 dotnet testを使用してテストを実行します。

- name: Run database unit tests
  run: dotnet test ./DatabaseTests/DatabaseTests.csproj

ヒント

テストを実行する前に、データベース プロジェクトを自動的に配置するようにテスト プロジェクトを構成します。 この設定により、テスト 時にテスト データベース スキーマがプロジェクトと一致するようにします。

テストが失敗すると、パイプラインが停止し、変更がステージングまたは運用環境に到達しません。 この遅延により、チームは環境に影響を与える前に問題を修正する時間が与えられます。

重要なポイント

データベース テストは、構造の正確性の検証、ロジック検証の単体テスト、エンド ツー エンドワークフローの統合テストの 3 つのレベルにまたがっています。 SQL Server 単体テストは、テストの事前アクション、テスト アクション、およびテスト後アクションの 3 フェーズ構造に従います。 ストアド プロシージャと関数の動作を確認するには、 Scalar Value、 Row Count、 Expected Schemaなどのテスト条件を使用します。 エラー処理パスを検証するメソッドをテストするには、 ExpectedSqlException 属性を追加します。 テスト プロジェクトを CI/CD パイプラインに配線し、変更がステージングまたは運用環境に到達する前に失敗したテストによってデプロイがブロックされるようにします。 これら 3 つのレイヤーを組み合わせることで、チームは不安ではなく自信を持ってデータベースの変更をデプロイできるセーフティ ネットを形成します。