3.2.4. リクエスト単体テスト（RESTfulウェブサービス）¶

3.2.4.1.1. 全体像¶

3.2.4.1.2. 主なクラス, リソース¶

3.2.4.1.3. モジュール一覧¶

<!--  テスティングフレームワーク本体  -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-testing-rest</artifactId>
  <scope>test</scope>
</dependency>
<!--  テスティングフレームワークで使用するデフォルト設定  -->
<dependency>
  <groupId>com.nablarch.configuration</groupId>
  <artifactId>nablarch-testing-default-configuration</artifactId>
  <scope>test</scope>
</dependency>
<!--  テスティングフレームワークで使用する内蔵サーバの実装  -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-testing-jetty6</artifactId>
  <scope>test</scope>
</dependency>

3.2.4.1.4. 設定¶

アーキタイプからブランクプロジェクトを作成した場合、 src/test/resources/unit-test.xml に テスティングフレームワークの設定がされている。RESTfulウェブサービス向けテスティングフレームワークの 設定を追加するためデフォルト設定で提供している以下の設定ファイルを読み込む。

<import file="nablarch/test/rest-request-test.xml"/>

リクエスト単体テストの設定は 各種設定値 を参照。

3.2.4.2.1. SimpleRestTestSupport¶

リクエスト単体テスト用に用意されたスーパークラス。リクエスト単体テスト用のメソッドを用意している。 データベース関連機能が不要な場合は後述の RestTestSupport ではなくこちらのクラスを使用する。 事前準備補助機能 、 実行 、 結果確認 については以下の RestTestSupport と同じ機能を持つ。

3.2.4.2.2. RestTestSupport¶

リクエスト単体テスト用に用意されたスーパークラス。リクエスト単体テスト用のメソッドを用意している。 SimpleRestTestSupport を継承し、データベース関連機能を持つ。

3.2.4.2.3. データベース関連機能¶

データベースに関する機能は、 RestTestSupport クラスから DbAccessTestSupport クラスに処理を委譲することで実現している。 DbAccessTestSupport クラスの詳細は、データベースを使用するクラスのテストを参照。

ただし、 DbAccessTestSupport のうち以下のメソッドは、リクエスト単体テスト(REST)では不要であり、アプリケーションプログラマに誤解を与えないよう、意図的に委譲を行っていない。

• public void beginTransactions()
• public void commitTransactions()
• public void endTransactions()
• public void setThreadContextValues(String sheetName, String id)
• public void assertSqlResultSetEquals(String message, String sheetName, String id, SqlResultSet actual)
• public void assertSqlRowEquals(String message, String sheetName, String id, SqlRow actual)

3.2.4.2.4. 事前準備補助機能¶

内蔵サーバへのリクエスト送信には、 HttpRequest のインスタンスが必要となる。RestTestSupport クラスでは、 HttpRequest をリクエスト単体テスト用に拡張したRestMockHttpRequest のオブジェクトを簡単に作成できるよう4つのメソッドを用意している。

RestMockHttpRequest get(String uri)
RestMockHttpRequest post(String uri)
RestMockHttpRequest put(String uri)
RestMockHttpRequest delete(String uri)

引数には、以下の値を引き渡す。

• テスト対象となるリクエストURI

これらのメソッドでは、受け取ったリクエストURIを元に RestMockHttpRequest インスタンスを生成し、メソッド名に応じたHTTPメソッドを設定した上で返却する。リクエストパラメータなどURI以外のデータを設定したい場合は、本メソッド呼び出しにより取得したインスタンスに対してデータの設定を行うとよい。

RestMockHttpRequest request = post("/projects")
                                  .setHeader("Authorization","Bearer token")
                                  .setCookie(cookie);

3.2.4.2.5. 実行¶

RestTestSupport にある下記のメソッドを呼び出すことで、内蔵サーバが起動されリクエストが送信される。

HttpResponse sendRequest(HttpRequest request)

3.2.4.2.6. 結果確認¶

void assertStatusCode(String message, HttpResponse.Status expected, HttpResponse response);

String readTextResource(String fileName)

3.2.4.3.1. コンポーネント設定ファイル設定項目一覧¶

<component name="restTestConfiguration" class="nablarch.test.core.http.RestTestConfiguration">
  <property name="webBaseDir" value="/path/to/web-a/,/path/to/web-common"/>

<!-- ハンドラキュー構成 -->
<component name="webFrontController" class="nablarch.fw.web.servlet.WebFrontController">
  <property name="handlerQueue">
    <list>
      <component class="nablarch.fw.web.handler.HttpCharacterEncodingHandler"/>
      <component class="nablarch.fw.handler.GlobalErrorHandler"/>
      <component class="nablarch.common.handler.threadcontext.ThreadContextClearHandler"/>
      <component class="nablarch.fw.web.handler.HttpResponseHandler"/>
      ・
      ・
      ・
      (略)
    </list>
  </property>
</component>

<component name="jaxrsController" class="nablarch.fw.web.servlet.WebFrontController">
  <property name="handlerQueue">
    <list>
      <component class="nablarch.fw.web.handler.HttpCharacterEncodingHandler"/>
      <component class="nablarch.fw.handler.GlobalErrorHandler"/>
      <component class="nablarch.fw.jaxrs.JaxRsResponseHandler"/>
      ・
      ・
      ・
      (略)
    </list>
  </property>
</component>

<import file="nablarch/test/rest-request-test.xml"/>
<!--  デフォルトのコンポーネント定義をimport後に上書きする。-->
<component name="restTestConfiguration" class="nablarch.test.core.http.RestTestConfiguration">
  <property name="webFrontControllerKey" value="jaxrsController"/>