fit/src/test/java/org/apache/olingo/fit/v4/MediaEntityTestITCase.java

/* 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.olingo.fit.v4;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.olingo.client.api.ODataClient;
import org.apache.olingo.client.api.communication.header.HeaderName;
import org.apache.olingo.client.api.communication.request.cud.ODataEntityUpdateRequest;
import org.apache.olingo.client.api.communication.request.cud.UpdateType;
import org.apache.olingo.client.api.communication.request.retrieve.ODataEntityRequest;
import org.apache.olingo.client.api.communication.request.retrieve.ODataMediaRequest;
import org.apache.olingo.client.api.communication.request.streamed.MediaEntityCreateStreamManager;
import org.apache.olingo.client.api.communication.request.streamed.MediaEntityUpdateStreamManager;
import org.apache.olingo.client.api.communication.request.streamed.ODataMediaEntityCreateRequest;
import org.apache.olingo.client.api.communication.request.streamed.ODataMediaEntityUpdateRequest;
import org.apache.olingo.client.api.communication.response.ODataEntityUpdateResponse;
import org.apache.olingo.client.api.communication.response.ODataMediaEntityCreateResponse;
import org.apache.olingo.client.api.communication.response.ODataMediaEntityUpdateResponse;
import org.apache.olingo.client.api.communication.response.ODataRetrieveResponse;
import org.apache.olingo.client.api.uri.URIBuilder;
import org.apache.olingo.client.core.ODataClientFactory;
import org.apache.olingo.commons.api.domain.ODataEntity;
import org.apache.olingo.commons.api.domain.ODataValuable;
import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException;
import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeKind;
import org.apache.olingo.commons.api.edm.FullQualifiedName;
import org.apache.olingo.commons.api.format.ODataFormat;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.Calendar;
import java.util.Collection;
import java.util.UUID;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

public class MediaEntityTestITCase extends AbstractTestITCase {

  private void read(final ODataClient client, final ODataFormat format) throws IOException {
    final URIBuilder builder = client.newURIBuilder(testDemoServiceRootURL).
        appendEntitySetSegment("Advertisements").
        appendKeySegment(UUID.fromString("f89dee73-af9f-4cd4-b330-db93c25ff3c7"));
    final ODataEntityRequest<ODataEntity> entityReq =
        client.getRetrieveRequestFactory().getEntityRequest(builder.build());
    entityReq.setFormat(format);

    final ODataEntity entity = entityReq.execute().getBody();
    assertNotNull(entity);
    assertTrue(entity.isMediaEntity());
    // cast to workaround JDK 6 bug, fixed in JDK 7
    assertEquals(EdmPrimitiveTypeKind.DateTimeOffset.getFullQualifiedName().toString(),
        ((ODataValuable) entity.getProperty("AirDate")).getValue().getTypeName());

    final ODataMediaRequest streamReq = client.getRetrieveRequestFactory().
        getMediaRequest(entity.getMediaContentSource());
    final ODataRetrieveResponse<InputStream> streamRes = streamReq.execute();
    assertEquals(200, streamRes.getStatusCode());

    final byte[] actual = new byte[Integer.parseInt(streamRes.getHeader("Content-Length").iterator().next())];
    IOUtils.read(streamRes.getBody(), actual, 0, actual.length);
  }

  @Test
  public void readAsAtom() throws IOException {
    read(client, ODataFormat.ATOM);
  }

  @Test
  public void readAsJSON() throws IOException {
    read(ODataClientFactory.getEdmEnabledClient(testDemoServiceRootURL), ODataFormat.JSON);
  }

  @Test
  public void readAsJSONFull() throws IOException {
    read(client, ODataFormat.JSON_FULL_METADATA);
  }

  private void create(final ODataFormat format) throws IOException {
    final String random = RandomStringUtils.random(110);
    final InputStream input = IOUtils.toInputStream(random);

    final URI uri = client.newURIBuilder(testDemoServiceRootURL).appendEntitySetSegment("Advertisements").build();
    final ODataMediaEntityCreateRequest<ODataEntity> createReq =
        client.getCUDRequestFactory().getMediaEntityCreateRequest(uri, input);
    final MediaEntityCreateStreamManager<ODataEntity> streamManager = createReq.payloadManager();

    final ODataMediaEntityCreateResponse<ODataEntity> createRes = streamManager.getResponse();
    assertEquals(201, createRes.getStatusCode());

    final Collection<String> location = createRes.getHeader(HeaderName.location);
    assertNotNull(location);
    final URI createdLocation = URI.create(location.iterator().next());

    final ODataEntity changes = client.getObjectFactory().
        newEntity(new FullQualifiedName("ODataDemo.Advertisement"));
    changes.getProperties().add(client.getObjectFactory().newPrimitiveProperty("AirDate",
        getClient().getObjectFactory().newPrimitiveValueBuilder().
            setType(EdmPrimitiveTypeKind.DateTimeOffset).setValue(Calendar.getInstance()).build()));

    final ODataEntityUpdateRequest<ODataEntity> updateReq = getClient().getCUDRequestFactory().
        getEntityUpdateRequest(createdLocation, UpdateType.PATCH, changes);
    updateReq.setFormat(format);

    final ODataEntityUpdateResponse<ODataEntity> updateRes = updateReq.execute();
    assertEquals(204, updateRes.getStatusCode());

    final ODataMediaRequest retrieveReq = client.getRetrieveRequestFactory().
        getMediaEntityRequest(client.newURIBuilder(createdLocation.toASCIIString()).build());
    final ODataRetrieveResponse<InputStream> retrieveRes = retrieveReq.execute();
    assertEquals(200, retrieveRes.getStatusCode());

    final byte[] actual = new byte[Integer.parseInt(retrieveRes.getHeader("Content-Length").iterator().next())];
    IOUtils.read(retrieveRes.getBody(), actual, 0, actual.length);
    assertEquals(random, new String(actual));
  }

  @Test
  public void createAsAtom() throws IOException {
    create(ODataFormat.ATOM);
  }

  @Test
  public void createAsJSON() throws IOException {
    create(ODataFormat.JSON);
  }

  private void update(final ODataFormat format) throws IOException, EdmPrimitiveTypeException {
    final URI uri = client.newURIBuilder(testDemoServiceRootURL).
        appendEntitySetSegment("Advertisements").
        appendKeySegment(UUID.fromString("f89dee73-af9f-4cd4-b330-db93c25ff3c7")).build();

    final String random = RandomStringUtils.random(124);

    // 1. update providing media content
    final ODataMediaEntityUpdateRequest<ODataEntity> updateReq = client.getCUDRequestFactory().
        getMediaEntityUpdateRequest(uri, IOUtils.toInputStream(random));
    updateReq.setFormat(format);

    final MediaEntityUpdateStreamManager<ODataEntity> streamManager = updateReq.payloadManager();
    final ODataMediaEntityUpdateResponse<ODataEntity> createRes = streamManager.getResponse();
    assertEquals(204, createRes.getStatusCode());

    // 2. check that media content was effectively uploaded
    final ODataMediaRequest streamReq = client.getRetrieveRequestFactory().getMediaEntityRequest(uri);
    final ODataRetrieveResponse<InputStream> streamRes = streamReq.execute();
    assertEquals(200, streamRes.getStatusCode());

    final byte[] actual = new byte[Integer.parseInt(streamRes.getHeader("Content-Length").iterator().next())];
    IOUtils.read(streamRes.getBody(), actual, 0, actual.length);
    assertEquals(random, new String(actual));
  }

  @Test
  public void updateAsAtom() throws IOException, EdmPrimitiveTypeException {
    update(ODataFormat.ATOM);
  }

  @Test
  public void updateAsJSON() throws IOException, EdmPrimitiveTypeException {
    update(ODataFormat.JSON);
  }
}