TestResponseDataBuilderUtil.java

/*
   Copyright (c) 2016 LinkedIn Corp.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package com.linkedin.restli.internal.server.response;


import com.linkedin.data.template.RecordTemplate;
import com.linkedin.restli.common.CollectionMetadata;
import com.linkedin.restli.common.EmptyRecord;
import com.linkedin.restli.common.HttpStatus;
import com.linkedin.restli.common.ResourceMethod;
import com.linkedin.restli.server.RestLiResponseData;
import com.linkedin.restli.server.RestLiServiceException;
import java.util.Collections;
import org.testng.annotations.Test;

import static com.linkedin.restli.common.ResourceMethod.*;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertEquals;


public class TestResponseDataBuilderUtil
{
  private RestLiServiceException _exception = new RestLiServiceException(HttpStatus.S_500_INTERNAL_SERVER_ERROR);

  @Test
  protected void testRecordResponseDataBuilder()
  {
    verifyRecordResponseData(ResponseDataBuilderUtil.buildGetResponseData(HttpStatus.S_200_OK, new EmptyRecord()), GET);
    verifyExceptionRecordResponseData(ResponseDataBuilderUtil.buildGetResponseData(_exception), GET);

    verifyRecordResponseData(ResponseDataBuilderUtil.buildCreateResponseData(HttpStatus.S_200_OK, new EmptyRecord()),
                             CREATE);
    verifyExceptionRecordResponseData(ResponseDataBuilderUtil.buildCreateResponseData(_exception), CREATE);

    verifyRecordResponseData(ResponseDataBuilderUtil.buildActionResponseData(HttpStatus.S_200_OK, new EmptyRecord()),
                             ACTION);
    verifyExceptionRecordResponseData(ResponseDataBuilderUtil.buildActionResponseData(_exception), ACTION);
  }

  @Test
  protected void testBatchCreateResponseDataBuilder()
  {
    verifyBatchCreateResponseData(
        ResponseDataBuilderUtil.buildBatchCreateResponseData(
            HttpStatus.S_200_OK, Collections.<BatchCreateResponseEnvelope.CollectionCreateResponseItem>emptyList()),
        BATCH_CREATE);
    verifyExceptionBatchCreateResponseData(ResponseDataBuilderUtil.buildBatchCreateResponseData(_exception),
                                           BATCH_CREATE);
  }

  @Test
  protected void testCollectionResponseDataBuilder()
  {
    verifyCollectionResponseData(
        ResponseDataBuilderUtil.buildFinderResponseData(
            HttpStatus.S_200_OK, Collections.<RecordTemplate>emptyList(), new CollectionMetadata(), new EmptyRecord()),
        FINDER);
    verifyExceptionCollectionResponseData(ResponseDataBuilderUtil.buildFinderResponseData(_exception), FINDER);

    verifyCollectionResponseData(
        ResponseDataBuilderUtil.buildGetAllResponseData(
            HttpStatus.S_200_OK, Collections.<RecordTemplate>emptyList(), new CollectionMetadata(), new EmptyRecord()),
        GET_ALL);
    verifyExceptionCollectionResponseData(ResponseDataBuilderUtil.buildGetAllResponseData(_exception), GET_ALL);
  }

  @Test
  protected void testBatchResponseDataBuilder()
  {
    verifyBatchResponseData(
        ResponseDataBuilderUtil.buildBatchGetResponseData(
            HttpStatus.S_200_OK, Collections.<Object, BatchResponseEnvelope.BatchResponseEntry>emptyMap()), BATCH_GET);
    verifyExceptionBatchResponseData(ResponseDataBuilderUtil.buildBatchGetResponseData(_exception), BATCH_GET);

    verifyBatchResponseData(
        ResponseDataBuilderUtil.buildBatchUpdateResponseData(
            HttpStatus.S_200_OK, Collections.<Object, BatchResponseEnvelope.BatchResponseEntry>emptyMap()),
        BATCH_UPDATE);
    verifyExceptionBatchResponseData(ResponseDataBuilderUtil.buildBatchUpdateResponseData(_exception), BATCH_UPDATE);

    verifyBatchResponseData(
        ResponseDataBuilderUtil.buildBatchPartialUpdateResponseData(
            HttpStatus.S_200_OK, Collections.<Object, BatchResponseEnvelope.BatchResponseEntry>emptyMap()),
        BATCH_PARTIAL_UPDATE);
    verifyExceptionBatchResponseData(ResponseDataBuilderUtil.buildBatchPartialUpdateResponseData(_exception),
                                     BATCH_PARTIAL_UPDATE);

    verifyBatchResponseData(
        ResponseDataBuilderUtil.buildBatchDeleteResponseData(
            HttpStatus.S_200_OK, Collections.<Object, BatchResponseEnvelope.BatchResponseEntry>emptyMap()),
        BATCH_DELETE);
    verifyExceptionBatchResponseData(ResponseDataBuilderUtil.buildBatchDeleteResponseData(_exception), BATCH_DELETE);
  }

  @Test
  protected void testStatusResponseDataBuilder()
  {
    verifyStatusResponseData(ResponseDataBuilderUtil.buildDeleteResponseData(HttpStatus.S_200_OK), DELETE);
    verifyExceptionStatusResponseData(ResponseDataBuilderUtil.buildDeleteResponseData(_exception), DELETE);

    verifyStatusResponseData(ResponseDataBuilderUtil.buildUpdateResponseData(HttpStatus.S_200_OK), UPDATE);
    verifyExceptionStatusResponseData(ResponseDataBuilderUtil.buildUpdateResponseData(_exception), UPDATE);

    verifyStatusResponseData(ResponseDataBuilderUtil.buildPartialUpdateResponseData(HttpStatus.S_200_OK),
                             PARTIAL_UPDATE);
    verifyExceptionStatusResponseData(ResponseDataBuilderUtil.buildPartialUpdateResponseData(_exception),
                                      PARTIAL_UPDATE);

    verifyStatusResponseData(ResponseDataBuilderUtil.buildOptionsResponseData(HttpStatus.S_200_OK), OPTIONS);
    verifyExceptionStatusResponseData(ResponseDataBuilderUtil.buildOptionsResponseData(_exception), OPTIONS);
  }

  private void verifyRecordResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getRecordResponseEnvelope().getRecord());
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyExceptionRecordResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNull(responseData.getRecordResponseEnvelope().getRecord());
    assertNotNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyBatchCreateResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getBatchCreateResponseEnvelope().getCreateResponses());
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyExceptionBatchCreateResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNull(responseData.getBatchCreateResponseEnvelope().getCreateResponses());
    assertNotNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyCollectionResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getCollectionResponseEnvelope().getCollectionResponse());
    assertNotNull(responseData.getCollectionResponseEnvelope().getCollectionResponsePaging());
    assertNotNull(responseData.getCollectionResponseEnvelope().getCollectionResponseCustomMetadata());
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyExceptionCollectionResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNull(responseData.getCollectionResponseEnvelope().getCollectionResponse());
    assertNull(responseData.getCollectionResponseEnvelope().getCollectionResponsePaging());
    assertNull(responseData.getCollectionResponseEnvelope().getCollectionResponseCustomMetadata());
    assertNotNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyBatchResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getBatchResponseEnvelope().getBatchResponseMap());
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyExceptionBatchResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getBatchResponseEnvelope().getBatchResponseMap());
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyStatusResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }

  private void verifyExceptionStatusResponseData(RestLiResponseData responseData, ResourceMethod expectedMethod)
  {
    assertNotNull(responseData.getServiceException());
    assertEquals(responseData.getResourceMethod(), expectedMethod);
  }
}