#3 : KarateでSpring Boot APIをテストしよう【Karateで始めるAPI自動テスト入門】

KarateはWeb APIのテストを簡単に自動化できるツールです。
Javaベースで動きますが英語に近い記法で書けるのが特徴で、APIの動作確認や検証を直感的に行うことができます。

ファイルが編集できたら依存関係をダウンロードするために以下のコマンドを実行します。

./mvnw clean install

コマンドを実行したあと、以下のようなログが表示されていれば、正常にダウンロードされてビルドも成功しています。

2.テストファイルを作成

Karateでテストを行うために、「何をテストするか」を書く .fatureファイルと、それを実行するための JUnitのランナークラスを新たに追加します。

フォルダ構成を作る

今回はプロジェクトのsrc/test/java 以下にテストに必要なフォルダとファイルを追加します。

src/
   └── test/
       └── java/
           └── examples/　← 追加
               ├── HelloTest.feature　← 追加
               └── HelloTestRunner.java ← 追加

HelloTest.feature の作成

HelloTest.teatureファイルに、GETリクエストのテストコードを記載していきます。

Feature: Test for /hello API

Scenario: Call GET /hello and check response
Given url 'http://localhost:8080/hello'
When method GET
Then status 200
And match response == 'Hello, API!'

/hello エンドポイントにGETリクエストを送り、ステータスが200 OKか、返ってくる値が Hello, API! と一致するかを確認する内容です。

HelloTestRunner.java の作成

次に、この.fatureファイルをJUnitから実行するためのランナークラスを作ります。

package examples;

import com.intuit.karate.junit5.Karate;

class HelloTestRunner {


    @Karate.Test
    Karate testHello() {
        return Karate.run("HelloTest").relativeTo(getClass());
    }
}

これでテストを実行する準備が完了しました！

3. テストを実行

では実際に次のような流れでテストを実行してみます！ポイントと合わせて確認していきましょう。

3-1. Spring Bootアプリの起動確認

Karateは、実際に動いているAPIに対してテストを行うため、Spring Bootアプリが正しく起動している必要があります。次のポイントをチェックしておきましょう。

このログからはFeatureファイルの中で定義されたテストシナリオが、すべて正常に通ったことが分かります。

補足：テスト失敗時のチェックポイント

もしテストが失敗していた場合は以下のポイントも確認してみてください。