3.2.4. Request Unit Test (RESTful Web Service)¶

3.2.4.1.1. Overall picture¶

3.2.4.1.2. Main Classes, resources¶

3.2.4.1.3. Module list¶

<!--  Testing Framework Mainframe  -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-testing-rest</artifactId>
  <scope>test</scope>
</dependency>
<!--  Default settings used by the testing framework  -->
<dependency>
  <groupId>com.nablarch.configuration</groupId>
  <artifactId>nablarch-testing-default-configuration</artifactId>
  <scope>test</scope>
</dependency>
<!--  Implementation of an built-in server used by the testing framework  -->
<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-testing-jetty6</artifactId>
  <scope>test</scope>
</dependency>

3.2.4.1.4. Configuration¶

If you created a blank project from an archetype, the testing framework has been configured in src/test/resources/unit-test.xml . Load the following configuration file provided by default to add the configuration of the testing framework for RESTful web service.

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

See Various configuration values for request unit test settings.

3.2.4.2.1. SimpleRestTestSupport¶

Superclass prepared for the request unit test. Provides methods for the request unit test. If you don’t need database related features, use this class instead of RestTestSupport as described below. It has the same features as RestTestSupport below for Pre-preparation assistance features, Execution, and Results Check.

3.2.4.2.2. RestTestSupport¶

Superclass prepared for the request unit test. It provides methods for request unit testing. It inherits from SimpleRestTestSupport and has database related features.

3.2.4.2.3. Database related features¶

Database related features is achieved by delegating processing from the RestTestSupport class to the DbAccessTestSupport class. For more information on the DbAccessTestSupport class, see Testing a Class that Uses the Database.

However, the following methods of DbAccessTestSupport are not needed for Request Unit Testing (REST). The following methods in DbAccessTestSupport are not delegated intentionally. Because it avoids misleading application programmers.

• 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. Pre-preparation assistance features¶

Sending a request to the built-in server requires an instance of HttpRequest. RestTestSupport class provides five methods to make it easy to create a RestMockHttpRequest object that extends HttpRequest for request unit testing.

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

In the argument, the following values are passed on.

• Request URI for testing

These methods create a RestMockHttpRequest instance based on the received request URI and return it with the HTTP method set according to the method name. If you want to set data other than the URI, such as request parameters, set the data for the instance obtained by this method call.

If you want to create an object of RestMockHttpRequest using an HTTP method other than the above, use the following method.

RestMockHttpRequest newRequest(String httpMethod, String uri)

Pass the HTTP method in the first argument and the request URI for testing in the second argument.

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

3.2.4.2.5. Execution¶

By calling the following method in RestTestSupport, the built-in server will be started and the request will be sent.

HttpResponse sendRequest(HttpRequest request)

3.2.4.2.6. Result validation¶

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

String readTextResource(String fileName)

3.2.4.3.1. Component configuration file list of configuration items¶

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

<!-- Handler queue configuration -->
<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"/>
      .
      .
      .
      (Omitted)
    </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"/>
      .
      .
      .
      (Omitted)
    </list>
  </property>
</component>

<import file="nablarch/test/rest-request-test.xml"/>
<!--  Override the default component definition after import. -->
<component name="restTestConfiguration" class="nablarch.test.core.http.RestTestConfiguration">
  <property name="webFrontControllerKey" value="jaxrsController"/>