web-dev-qa-db-ja.com

Javaサーブレットの単体テスト

サーブレットの単体テストを行う最良の方法は何か知りたいです。

内部メソッドのテストは、サーブレットコンテキストを参照しない限り問題ではありませんが、doGet/doPostメソッドとコンテキストを参照する内部メソッド、またはセッションパラメータを使用する内部メソッドのテストはどうでしょうか。

JUnitなどの古典的なツールを使用してこれを行う方法はありますか、TestNGが望ましいですか？ Tomcatサーバーなどを埋め込む必要がありましたか？

javaunit-testingservlets
52
gizmo

HttpUnit を試してください。ただし、「単体テスト」（単一クラス）よりも「統合テスト」（モジュール）のほうが自動化されたテストを書くことになります。

12
Peter Hilton

ほとんどの場合、純粋な単体テストではなく、「統合テスト」を使用してサーブレットとJSPをテストします。 JUnit/TestNGには、次のような多数のアドオンが用意されています。

  • HttpUnit （最も古く、最もよく知られている、非常に低いレベルで、ニーズに応じて良い場合も悪い場合もあります）
  • HtmlUnit （HttpUnitよりも高いレベルで、多くのプロジェクトに適しています）
  • JWebUnit （他のテストツールの上に置かれ、それらを単純化しようとする-私が好むもの）
  • WatiJ およびSelenium（ブラウザを使用してテストを実行します。これは、より重いが現実的です）

これは、「orderEntry.html」フォームからの入力を処理する単純な注文処理サーブレットのJWebUnitテストです。顧客ID、顧客名、および1つ以上の注文アイテムが必要です。

public class OrdersPageTest {
    private static final String WEBSITE_URL = "http://localhost:8080/demo1";

    @Before
    public void start() {
        webTester = new WebTester();
        webTester.setTestingEngineKey(TestingEngineRegistry.TESTING_ENGINE_HTMLUNIT);
        webTester.getTestContext().setBaseUrl(WEBSITE_URL);
    }
    @Test
    public void sanity() throws Exception {
        webTester.beginAt("/orderEntry.html");
        webTester.assertTitleEquals("Order Entry Form");
    }
    @Test
    public void idIsRequired() throws Exception {
        webTester.beginAt("/orderEntry.html");
        webTester.submit();
        webTester.assertTextPresent("ID Missing!");
    }
    @Test
    public void nameIsRequired() throws Exception {
        webTester.beginAt("/orderEntry.html");
        webTester.setTextField("id","AB12");
        webTester.submit();
        webTester.assertTextPresent("Name Missing!");
    }
    @Test
    public void validOrderSucceeds() throws Exception {
        webTester.beginAt("/orderEntry.html");
        webTester.setTextField("id","AB12");
        webTester.setTextField("name","Joe Bloggs");

        //fill in order line one
        webTester.setTextField("lineOneItemNumber", "AA");
        webTester.setTextField("lineOneQuantity", "12");
        webTester.setTextField("lineOneUnitPrice", "3.4");

        //fill in order line two
        webTester.setTextField("lineTwoItemNumber", "BB");
        webTester.setTextField("lineTwoQuantity", "14");
        webTester.setTextField("lineTwoUnitPrice", "5.6");

        webTester.submit();
        webTester.assertTextPresent("Total: 119.20");
    }
    private WebTester webTester;
}
44
Garth Gilmour

投稿された回答を見て、埋め込みGlassFishとそのApache Mavenプラグインを使用してテストを行う方法を実際に示すより完全なソリューションを投稿すると思いました。

私はブログに完全なプロセスを書きました JUnit 4.xおよびHtmlUnit 2.xで埋め込まれたGlassFish 3.1.1を使用 Bitbucketでダウンロードするための完全なプロジェクトをここに置きました： image-servlet

この質問を見る直前に、JSP/JSFタグのイメージサーブレットに関する別の投稿を見ていました。そこで、他の投稿で使用したソリューションと、この投稿の完全な単体テストバージョンを組み合わせました。

テスト方法

Apache Mavenには、testを含む明確に定義されたライフサイクルがあります。 integration-testと呼ばれる別のライフサイクルとともにこれを使用して、ソリューションを実装します。

  1. Surefireプラグインで標準のライフサイクルユニットテストを無効にします。
  2. Surefire-pluginの実行の一部としてintegration-testを追加します
  3. GlassFish MavenプラグインをPOMに追加します。
  4. integration-testライフサイクル中に実行されるようにGlassFishを構成します。
  5. 単体テスト（統合テスト）を実行します。

GlassFishプラグイン

このプラグインを<build>の一部として追加します。

        <plugin>
            <groupId>org.glassfish</groupId>
            <artifactId>maven-embedded-glassfish-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <!-- This sets the path to use the war file we have built in the target directory -->
                <app>target/${project.build.finalName}</app>
                <port>8080</port>
                <!-- This sets the context root, e.g. http://localhost:8080/test/ -->
                <contextRoot>test</contextRoot>
                <!-- This deletes the temporary files during GlassFish shutdown. -->
                <autoDelete>true</autoDelete>
            </configuration>
            <executions>
                <execution>
                    <id>start</id>
                    <!-- We implement the integration testing by setting up our GlassFish instance to start and deploy our application. -->
                    <phase>pre-integration-test</phase>
                    <goals>
                        <goal>start</goal>
                        <goal>deploy</goal>
                    </goals>
                </execution>
                <execution>
                    <id>stop</id>
                    <!-- After integration testing we undeploy the application and shutdown GlassFish gracefully. -->
                    <phase>post-integration-test</phase>
                    <goals>
                        <goal>undeploy</goal>
                        <goal>stop</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

Surefireプラグイン

<build>の一部としてプラグインを追加/変更します。

        <plugin>
            <groupId>org.Apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.12.4</version>
            <!-- We are skipping the default test lifecycle and will test later during integration-test -->
            <configuration>
                <skip>true</skip>
            </configuration>
            <executions>
                <execution>
                    <phase>integration-test</phase>
                    <goals>
                        <!-- During the integration test we will execute surefire:test -->
                        <goal>test</goal>
                    </goals>
                    <configuration>
                        <!-- This enables the tests which were disabled previously. -->
                        <skip>false</skip>
                    </configuration>
                </execution>
            </executions>
        </plugin>

HTMLUnit

以下の例のような統合テストを追加します。

@Test
public void badRequest() throws IOException {
    webClient.getOptions().setThrowExceptionOnFailingStatusCode(false);
    webClient.getOptions().setPrintContentOnFailingStatusCode(false);
    final HtmlPage page = webClient.getPage("http://localhost:8080/test/images/");
    final WebResponse response = page.getWebResponse();
    assertEquals(400, response.getStatusCode());
    assertEquals("An image name is required.", response.getStatusMessage());
    webClient.getOptions().setThrowExceptionOnFailingStatusCode(true);
    webClient.getOptions().setPrintContentOnFailingStatusCode(true);
    webClient.closeAllWindows();
}

私はブログに完全なプロセスを書きました JUnit 4.xおよびHtmlUnit 2.xで埋め込まれたGlassFish 3.1.1を使用 Bitbucketでダウンロードするための完全なプロジェクトをここに置きました： image-servlet

ご質問がある場合は、コメントを残してください。これは、サーブレットを計画しているテストの基礎として使用できる完全な例の1つだと思います。

10
John Yeary

Mockrunner（ http://mockrunner.sourceforge.net/index.html ）はこれを行うことができます。サーブレットのテストに使用できる模擬J2EEコンテナを提供します。また、EJB、JDBC、JMS、Strutsなどの他のサーバー側コードの単体テストにも使用できます。私は自分でJDBCとEJBの機能のみを使用しました。

6
Kris Pruden

ユニットテストでdoPostメソッドとdoGetメソッドを手動で呼び出していますか？その場合、HttpServletRequestメソッドをオーバーライドして、モックオブジェクトを提供できます。

myServlet.doGet(new HttpServletRequestWrapper() {
     public HttpSession getSession() {
         return mockSession;
     }

     ...
}

HttpServletRequestWrapper は便利ですJavaクラス。ユニットテストでユーティリティメソッドを作成して、模擬HTTPリクエストを作成することをお勧めします。

public void testSomething() {
    myServlet.doGet(createMockRequest(), createMockResponse());
}

protected HttpServletRequest createMockRequest() {
   HttpServletRequest request = new HttpServletRequestWrapper() {
        //overrided methods   
   }
}

モック作成メソッドをベースサーブレットのスーパークラスに配置し、すべてのサーブレットの単体テストを作成して、それを拡張することをお勧めします。

6
Marcio Aguiar

サーブレットdoPost（）メソッドのJUnitテストのこの実装は、HttpRequest、HttpResponse、HttpSession、ServletResponseのインスタンスをモックアップするためにMockitoライブラリのみに依存しています。およびRequestDispatcher。パラメーターキーとJavaBeanインスタンスを、doPost（）の呼び出し元の関連JSPファイルで参照されている値に対応するものに置き換えます。

Mockito Maven依存関係：

<dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-all</artifactId>
      <version>1.9.5</version>
</dependency>

JUnitテスト：

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import Java.io.IOException;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.*;

/**
 * Unit tests for the {@code StockSearchServlet} class.
 * @author Bob Basmaji
 */
public class StockSearchServletTest extends HttpServlet {
    // private fields of this class
    private static HttpServletRequest request;
    private static HttpServletResponse response;
    private static StockSearchServlet servlet;
    private static final String SYMBOL_PARAMETER_KEY = "symbol";
    private static final String STARTRANGE_PARAMETER_KEY = "startRange";
    private static final String ENDRANGE_PARAMETER_KEY = "endRange";
    private static final String INTERVAL_PARAMETER_KEY = "interval";
    private static final String SERVICETYPE_PARAMETER_KEY = "serviceType";

    /**
     * Sets up the logic common to each test in this class
     */
    @Before
    public final void setUp() {
        request = mock(HttpServletRequest.class);
        response = mock(HttpServletResponse.class);

        when(request.getParameter("symbol"))
                .thenReturn("AAPL");

        when(request.getParameter("startRange"))
                .thenReturn("2016-04-23 00:00:00");

        when(request.getParameter("endRange"))
                .thenReturn("2016-07-23 00:00:00");

        when(request.getParameter("interval"))
                .thenReturn("DAY");

        when(request.getParameter("serviceType"))
                .thenReturn("WEB");

        String symbol = request.getParameter(SYMBOL_PARAMETER_KEY);
        String startRange = request.getParameter(STARTRANGE_PARAMETER_KEY);
        String endRange = request.getParameter(ENDRANGE_PARAMETER_KEY);
        String interval = request.getParameter(INTERVAL_PARAMETER_KEY);
        String serviceType = request.getParameter(SERVICETYPE_PARAMETER_KEY);

        HttpSession session = mock(HttpSession.class);
        when(request.getSession()).thenReturn(session);
        final ServletContext servletContext = mock(ServletContext.class);
        RequestDispatcher dispatcher = mock(RequestDispatcher.class);
        when(servletContext.getRequestDispatcher("/stocksearchResults.jsp")).thenReturn(dispatcher);
        servlet = new StockSearchServlet() {
            public ServletContext getServletContext() {
                return servletContext; // return the mock
            }
        };

        StockSearchBean search = new StockSearchBean(symbol, startRange, endRange, interval);
        try {
            switch (serviceType) {
                case ("BASIC"):
                    search.processData(ServiceType.BASIC);
                    break;
                case ("DATABASE"):
                    search.processData(ServiceType.DATABASE);
                    break;
                case ("WEB"):
                    search.processData(ServiceType.WEB);
                    break;
                default:
                    search.processData(ServiceType.WEB);
            }
        } catch (StockServiceException e) {
            throw new RuntimeException(e.getMessage());
        }
        session.setAttribute("search", search);
    }

    /**
     * Verifies that the doPost method throws an exception when passed null arguments
     * @throws ServletException
     * @throws IOException
     */
    @Test(expected = NullPointerException.class)
    public final void testDoPostPositive() throws ServletException, IOException {
        servlet.doPost(null, null);
    }

    /**
     * Verifies that the doPost method runs without exception
     * @throws ServletException
     * @throws IOException
     */
    @Test
    public final void testDoPostNegative() throws ServletException, IOException {
        boolean throwsException = false;
        try {
            servlet.doPost(request, response);
        } catch (Exception e) {
            throwsException = true;
        }
        assertFalse("doPost throws an exception", throwsException);
    }
}
3
Bob Basmaji

2018年2月更新： OpenBrace Limitedは閉鎖しました 、およびそのObMimic製品はサポートされなくなりました。

別の解決策は、サーブレットの単体テスト用に特別に設計された ObMimic ライブラリを使用することです。すべてのサーブレットAPIクラスの完全なプレーンJava実装を提供し、テストの必要に応じてこれらを構成および検査できます。

実際に使用して、JUnitまたはTestNGテストからdoGet/doPostメソッドを直接呼び出したり、ServletContextを参照したりセッションパラメータ（またはその他のサーブレットAPI機能）を使用している場合でも内部メソッドをテストできます。

これは外部または埋め込みコンテナを必要とせず、より広範なHTTPベースの「統合」テストに制限されません。また、汎用のモックとは異なり、サーブレットAPIの完全な動作が「組み込まれている」ため、テストを「 「対話」ベースではなく「状態」ベース（たとえば、テストは、コードによって行われたサーブレットAPI呼び出しの正確なシーケンスや、サーブレットAPIが各呼び出しにどのように応答するかについてのあなた自身の期待に依存する必要はありません） 。

JUnitを使用してサーブレットをテストする方法 に対する回答には簡単な例があります。詳細および無料ダウンロードについては、 ObMimic Webサイトを参照してください。

0
Mike Kaufman