ツイートシェアはてブ LINE Pocket

Spock 入門

Spock(英語) は、テストを自動化するために使用できる Java および Groovy コードのテストフレームワークです。IntelliJ IDEA は、完全な Spock 統合と、スポックフレームワークの機能強化、スポック ADB などのサードパーティプラグインを介して有効にできる追加の Spock 機能をサポートします。

プロジェクトの作成

Spock フレームワークがどのように機能するかを確認するには、通常の Gradle プロジェクトを作成します。

Spock のプロジェクトを作成する

IntelliJ IDEA を起動します。
ウェルカム画面が開いたら、新しいプロジェクトをクリックします。
それ以外の場合は、メインメニューのファイル | 新規 | プロジェクトに移動します。
左側のリストから、Java を選択します。
Spock は Java と Groovy のテストに使用されるため、デフォルトの Java オプションのままにしておくことができます。後からいつでも Groovy 言語をプロジェクトに追加できます。
提案のリストから、次のオプションを追加して構成します。
- 名前 : 作成するプロジェクトの名前を追加します。例: spock-tutorial。
- ロケーション : プロジェクトの場所へのパスを追加します
- Git リポジトリ : プロジェクトを作成して Git にアップロードする場合は、このオプションを選択できます。
- ビルドシステム : プロジェクトで使用するビルドツールを選択します。例: Gradle。
- JDK : プロジェクト SDK を構成します。Java ベースのアプリケーションを開発するには、JDK（Java Development Kit）が必要です。
  必要な JDK が IntelliJ IDEA ですでに定義されている場合は、検出された JDK のリストからそれを選択します。
  コンピューターに必要な JDK がない場合は、JDK のダウンロードを選択します。次のダイアログで、JDK ベンダーとバージョンを指定し、必要に応じてインストールパスを変更します。
- Gradle DSL : プロジェクトに適切な DSL を選択します。Spock では通常 Java または Groovy を使用するため、推奨される Gradle オプションをそのままにしておくことができます。
詳細設定が必要な場合は、詳細設定セクションで構成できます。
必要なオプションの選択が終了したら、作成をクリックします。
IntelliJ IDEA は Gradle プロジェクトを作成し、必要な依存関係をダウンロードして、適切なプロジェクト構造を設定します。

依存関係を設定する

基本的な Gradle プロジェクトが作成されたら、Spock のテストを作成するために、追加されたデフォルトの JUnit5 依存関係の代わりに Spock 依存関係を Gradle ビルドファイルに追加する必要があります。

Spock の依存関係を追加する

エディターで build.gradle ファイルを開きます。
build.gradle で、Alt+Insert を押して、Maven アーティファクト依存関係を追加を選択します。
開いたダイアログで、スポックコア(英語)ライブラリの最新バージョンを検索します。
検索結果のリストから必要な項目を選択し、追加をクリックします。
依存関係が build.gradle ファイルに追加されます。
Spock テストは Groovy で記述されているため、Spock 依存関係を追加したのと同じ方法で Groovy 依存関係を追加します。3.0.8 バージョンを使用してください。
両方の依存関係が testImplementation として宣言されていることを確認し、他の JUnit 依存関係は必要ないため、削除してください。
build.gradle ファイルに次のコードが表示されます。
dependencies { testImplementation 'org.codehaus.groovy:groovy-all:3.0.8' testImplementation 'org.spockframework:spock-core:2.0-groovy-3.0' }
Groovy プラグイン(英語)を build.gradle ファイルに追加します。
plugins { id 'java' id 'groovy' }
build.gradle ファイルに加えたすべての変更をロードします。エディターで Gradle の変更をロードアイコンをクリックするか、Ctrl+Shift+O を押します。
IntelliJ IDEA は、新しい依存関係をダウンロードし、古い依存関係を削除して、プロジェクトを正しく構成します。

簡単なアサーションを書く

テストの作成を開始する前に、Java 言語と Groovy 言語が混在するプロジェクトを作成したため、プロジェクトに groovy フォルダーを作成したことを確認してください。このようにして、Groovy コードを groovy フォルダーに保持し、Java コードをその java フォルダーに保持することができます。

Groovy フォルダーを追加する

プロジェクトツールウィンドウで、test フォルダーを右クリックし、新規 | ディレクトリを選択します。
Gradle では Groovy プラグインが使用されているため、開いたウィンドウで、IntelliJ IDEA はリストに groovy オプションを表示します。
groovy を選択し、Enter を押します。
IntelliJ IDEA は groovy ディレクトリを test モジュールに追加し、テストの作成を開始できます。

スポックのテストを書く

非常に単純なテストを作成することから始めることができるため、Spock テストがどのように見えるかを確認できます。

プロジェクトツールウィンドウで、groovy フォルダーを右クリックし、新規 | Groovy クラスを選択します。
開いたウィンドウで、クラス名の前に完全なパッケージ名を入力して、パッケージとディレクトリの構造を作成します。スポックテストはしばしば Specification と呼ばれるため、テストを ExampleSpecification と呼ぶことができます。
Groovy クラスを追加したら、エディターで開きます。
このクラスが Spock の仕様(英語)クラスを拡張していることを確認してください。
クラス内で、Alt+Insert を押し、テストメソッドを選択して、Spock 仕様のテストメソッドを生成します。
これは、Spock または Groovy コードの記述にあまり慣れていない場合に特に役立ちます。これは、IntelliJ IDEA が必要な基本構造を生成するためです。
次のコードを確認してください。
class ExampleSpecification extends Specification { def "should be a simple assertion"() { } }
ご覧のとおり、メソッドは def キーワードで定義されており、Spock のメソッド名は文字列にすることができます。これは、テストを作成するときに役立ちます。テキスト形式により、期待する正確な動作を柔軟に説明できます。
スポックテストでは、アノテーションや特定のテストメソッド名の形式を使用して、テストするメソッドを定義しません。代わりに、ラベルを使用します。このような単純なテストでは、expect を使用して、予想される最も単純な動作を定義できます。
次の例を確認してください。
def "should be a simple assertion"() { expect: 1 == 1 }
ご覧のとおり、Spock は、少なくとも通常は、Assertions または Assert キーワードも使用しません。代わりに、doubleequals のような単純なチェックを使用できます。should be a simple assertion メソッドは、単純な予想される動作を指定します。つまり、数値 1 は 1 に等しい必要があります。これは現実的なテストケースではありませんが、Spock テストの基本を示しています。
テストが実際に機能し、正しいことをテストしていることを確認するために、最初にテストが失敗するのを確認することは常に役立ちます。テストが失敗すると、Spock は、失敗したものとその理由を正確に示す役立つエラーメッセージを表示します。
テストが失敗することを確認するには、次のコードを使用してテストを実行します。
def "should be a simple assertion"() { expect: 1 == 0 }
実行ツールウィンドウで結果とエラーメッセージを確認してください。