web-dev-qa-db-ja.com

RESTサービスをテストするためにmockitoを使用する方法?

私はJava Unit Testingで非常に新しく、Mockitoフレームワークはテスト目的に本当に良いと聞きました。

REST Server(CRUDメソッド)を開発しました。今ではテストしたいのですが、方法がわかりませんか?

さらに、このテスト手順がどのように始まるべきかわかりません。私のサーバーはローカルホストで動作し、そのURLで呼び出しを行う必要があります(例:localhost:8888)?

ここに私がこれまで試したものがありますが、これは正しい方法ではないと確信しています。

    @Test
    public void testInitialize() {
        RESTfulGeneric rest = mock(RESTfulGeneric.class);

        ResponseBuilder builder = Response.status(Response.Status.OK);

        builder = Response.status(Response.Status.OK).entity(
                "Your schema was succesfully created!");

        when(rest.initialize(DatabaseSchema)).thenReturn(builder.build());

        String result = rest.initialize(DatabaseSchema).getEntity().toString();

        System.out.println("Here: " + result);

        assertEquals("Your schema was succesfully created!", result);

    }

initializeメソッドのコードは次のとおりです。

    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @Path("/initialize")
    public Response initialize(String DatabaseSchema) {

        /** Set the LogLevel to Info, severe, warning and info will be written */
        LOGGER.setLevel(Level.INFO);

        ResponseBuilder builder = Response.status(Response.Status.OK);

        LOGGER.info("POST/initialize - Initialize the " + user.getUserEmail()
                + " namespace with a database schema.");

        /** Get a handle on the datastore itself */
        DatastoreService datastore = DatastoreServiceFactory
                .getDatastoreService();


        datastore.put(dbSchema);

        builder = Response.status(Response.Status.OK).entity(
                "Your schema was succesfully created!");
        /** Send response */
        return builder.build();
    }

このテストケースでは、Json文字列をサーバーに送信します(POST)。すべてがうまくいった場合、サーバーは「スキーマが正常に作成されました!」と応答するはずです。

誰か助けてくれますか?

25
Ion Morozan

OK。したがって、メソッドのコントラクトは次のとおりです。入力文字列をJSONとして解析し、無効な場合は_BAD_REQUEST_を送り返します。有効な場合は、datastoreにさまざまなプロパティ(それらを知っている)を持つエンティティを作成し、OKを送り返します。

そして、この契約がメソッドによって満たされていることを確認する必要があります。

Mockitoはここでどこで役立ちますか? Mockitoを使用せずにこのメソッドをテストする場合、実際のDataStoreServiceが必要です。また、エンティティがこの実際のDataStoreServiceで正しく作成されたことを確認する必要があります。これは、テストが単体テストではなくなった場所であり、テストするには複雑すぎ、長すぎ、複雑な環境を必要とするために実行するのが難しい場所でもあります。

MockitoはDataStoreServiceへの依存関係をモックすることで支援できます。DataStoreServiceのモックを作成し、initialize()テストのメソッド。

そのためには、テスト対象のオブジェクトにDataStoreServiceを挿入できる必要があります。次の方法でオブジェクトをリファクタリングするのと同じくらい簡単です。

_public class MyRestService {
    private DataStoreService dataStoreService;

    // constructor used on the server
    public MyRestService() {
        this.dataStoreService = DatastoreServiceFactory.getDatastoreService();
    }

    // constructor used by the unit tests
    public MyRestService(DataStoreService dataStoreService) {
        this.dataStoreService = dataStoreService;
    }

    public Response initialize(String DatabaseSchema) {
         ...
         // use this.dataStoreService instead of datastore
    }
}
_

そして今、あなたのテストメソッドでは、あなたがすることができます:

_@Test
public void testInitializeWithGoodInput() {
    DataStoreService mockDataStoreService = mock(DataStoreService.class);
    MyRestService service = new MyRestService(mockDataStoreService);
    String goodInput = "...";
    Response response = service.initialize(goodInput);
    assertEquals(Response.Status.OK, response.getStatus());

    ArgumentCaptor<Entity> argument = ArgumentCaptor.forClass(Entity.class);
    verify(mock).put(argument.capture());
    assertEquals("the correct kind", argument.getValue().getKind());
    // ... other assertions
}
_
23
JB Nizet

あなたが話していることは 統合テスト のように聞こえ、Mockito(またはその他のモックフレームワーク)はあまり役に立ちません。

書いたコードを単体テストしたい場合、Mockitoは確かに便利なツールです。

モック/単体テストと、どのような状況で使用すべきかについて詳しく読むことをお勧めします。

3
darrengorman

Mockitoは(一般的に)部分コードのテスト用です。たとえば、RESTサービスを使用しているが、フルスタックテストを実行したくない場合は、RESTサービスに接続したサービスをモックして、特定の動作を正確かつ一貫してテストするため。

データベースにアクセスせずにRESTサービス(たとえば、特定のサービスメソッド)の内部部分をテストするには、DBサブシステムをモックし、DBを使用せずにサービス内部のみのテストを許可します。このテストは、クライアント側ではなく、RESTサービスモジュールに属します。

RESTサービス自体をテストするには、実際のクライアントライブラリを使用して、フルスタック統合テストを作成します。ここでMockitoを使用して、RESTサービス消費に関係のないクライアントの部分をモックできます。

2
Dave Newton

最良の方法は、wiremockを使用することです。次の依存関係を追加します。com.github.tomakehurst wiremock 2.4.1 org.igniterealtime.smack smack-core 4.0.6

以下に示すように、wiremockを定義して使用します

@Rule
public WireMockRule wireMockRule = new WireMockRule(8089);

String response ="Hello world";
StubMapping responseValid = stubFor(get(urlEqualTo(url)).withHeader("Content-Type", equalTo("application/json"))
        .willReturn(aResponse().withStatus(200)
                .withHeader("Content-Type", "application/json").withBody(response)));
1

これは単体テストではなく、統合テストであることに同意します。とにかくジャージと組み込みグリズリーサーバーテストをご覧ください。まとめると、このコードはlocalhost:8888でgrizzlyサーバー(datbaseも起動できる)を起動し、クライアントのジャージのクライアントをセットアップしてPOST要求をテストする必要があります。サーバーとデータベースの両方をテストしているため、これは統合です。ただし、mockitoを使用してデータベースをエミュレートすることもできますが、サーバーとデータベースがどの程度結びついているかによって異なります。

(ジャージ1.11とグリズリー2.2を使用してテスト)

    @BeforeClass
    public static void setUpClass() throws Exception {
        // starts grizzly
        Starter.start_grizzly(true);
        Thread.sleep(4000);
    }

    @Before
    public void setUp() throws Exception {
        client = new Client();
        webResource = client.resource("http://localhost:8888");
    }   

    @Test
    public void testPostSchemaDatabase() throws Exception {
        {
            String DatabaseSchema = "{ database_schema : {...}}";
            logger.info("REST client configured to send: "  + DatabaseSchema);
            ClientResponse response =  
                    webResource
                             .path("/initialize")
                             .type("application/json")
                             .post(ClientResponse.class, DatabaseSchema);
            //wait for the server to process
            Thread.sleep(2000);
            assertEquals(response.getStatus(), 204);    
            //test the response
        }       
    }

    @After
    public void after() throws JSONException
    {
            //probably you want to delete the schema at database and stop the server

}
0
user311174