/*******************************************************************************
* 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.odata2.core.ep.producer;
import static org.custommonkey.xmlunit.XMLAssert.assertXpathEvaluatesTo;
import static org.custommonkey.xmlunit.XMLAssert.assertXpathExists;
import static org.custommonkey.xmlunit.XMLAssert.assertXpathNotExists;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import org.apache.olingo.odata2.api.commons.InlineCount;
import org.apache.olingo.odata2.api.edm.EdmEntitySet;
import org.apache.olingo.odata2.api.ep.EntityProviderException;
import org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties;
import org.apache.olingo.odata2.api.processor.ODataResponse;
import org.apache.olingo.odata2.api.uri.info.GetEntitySetUriInfo;
import org.apache.olingo.odata2.core.ep.AbstractProviderTest;
import org.apache.olingo.odata2.core.ep.AtomEntityProvider;
import org.apache.olingo.odata2.testutil.helper.StringHelper;
import org.apache.olingo.odata2.testutil.mock.MockFacade;
import org.junit.Before;
import org.junit.Test;
/**
*
*/
public class AtomFeedProducerTest extends AbstractProviderTest {
public AtomFeedProducerTest(final StreamWriterImplType type) {
super(type);
}
private GetEntitySetUriInfo view;
@Before
public void before() throws Exception {
initializeRoomData(1);
view = mock(GetEntitySetUriInfo.class);
EdmEntitySet set = MockFacade.getMockEdm().getDefaultEntityContainer().getEntitySet("Rooms");
when(view.getTargetEntitySet()).thenReturn(set);
}
@Test
public void testWithIncludeSimplePropertyTypes() throws Exception {
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).includeSimplePropertyType(true).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed", xmlString);
assertXpathExists("/a:feed/a:entry/a:content/m:properties", xmlString);
assertXpathExists("/a:feed/a:entry/a:content/m:properties/d:Id[@m:type=\"Edm.String\"]", xmlString);
assertXpathExists("/a:feed/a:entry/a:content/m:properties/d:Name[@m:type=\"Edm.String\"]", xmlString);
assertXpathExists("/a:feed/a:entry/a:content/m:properties/d:Seats[@m:type=\"Edm.Int16\"]", xmlString);
assertXpathExists("/a:feed/a:entry/a:content/m:properties/d:Version[@m:type=\"Edm.Int16\"]", xmlString);
}
@Test
public void testFeedNamespaces() throws Exception {
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed", xmlString);
assertXpathEvaluatesTo(BASE_URI.toASCIIString(), "/a:feed/@xml:base", xmlString);
}
@Test
public void testSelfLink() throws Exception {
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/a:link[@rel='self']", xmlString);
assertXpathEvaluatesTo("Rooms", "/a:feed/a:link[@rel='self']/@href", xmlString);
assertXpathEvaluatesTo("Rooms", "/a:feed/a:link[@rel='self']/@title", xmlString);
}
@Test
public void testCustomSelfLink() throws Exception {
String customLink = "Test";
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).selfLink(
new URI(customLink)).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/a:link[@rel='self']", xmlString);
assertXpathEvaluatesTo(customLink, "/a:feed/a:link[@rel='self']/@href", xmlString);
assertXpathEvaluatesTo("Rooms", "/a:feed/a:link[@rel='self']/@title", xmlString);
}
@Test
public void testFeedMandatoryParts() throws Exception {
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/a:id", xmlString);
assertXpathEvaluatesTo(BASE_URI.toASCIIString() + "Rooms", "/a:feed/a:id/text()", xmlString);
assertXpathExists("/a:feed/a:title", xmlString);
assertXpathEvaluatesTo("Rooms", "/a:feed/a:title/text()", xmlString);
assertXpathExists("/a:feed/a:updated", xmlString);
assertXpathExists("/a:feed/a:author", xmlString);
assertXpathExists("/a:feed/a:author/a:name", xmlString);
}
private String verifyResponse(final ODataResponse response) throws IOException {
assertNotNull(response);
assertNotNull(response.getEntity());
assertNull("EntityProvider should not set content header", response.getContentHeader());
String xmlString = StringHelper.inputStreamToString((InputStream) response.getEntity());
return xmlString;
}
@Test
public void testInlineCountAllpages() throws Exception {
initializeRoomData(20);
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties = EntityProviderWriteProperties.serviceRoot(BASE_URI)
.inlineCount(Integer.valueOf(103))
.inlineCountType(InlineCount.ALLPAGES)
.build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/m:count", xmlString);
assertXpathEvaluatesTo("103", "/a:feed/m:count/text()", xmlString);
}
@Test
public void testInlineCountNone() throws Exception {
when(view.getInlineCount()).thenReturn(InlineCount.NONE);
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathNotExists("/a:feed/m:count", xmlString);
}
@Test
public void testNextLink() throws Exception {
when(view.getInlineCount()).thenReturn(InlineCount.NONE);
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties = EntityProviderWriteProperties.serviceRoot(BASE_URI)
.nextLink("http://thisisanextlink")
.build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/a:link[@rel='next']", xmlString);
assertXpathEvaluatesTo("http://thisisanextlink", "/a:feed/a:link[@rel='next']/@href", xmlString);
}
@Test(expected = EntityProviderException.class)
public void testInlineCountInvalid() throws Exception {
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).inlineCountType(
InlineCount.ALLPAGES).build();
ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
}
@Test
public void testEntries() throws Exception {
initializeRoomData(103);
AtomEntityProvider ser = createAtomEntityProvider();
EntityProviderWriteProperties properties =
EntityProviderWriteProperties.serviceRoot(BASE_URI).build();
ODataResponse response = ser.writeFeed(view.getTargetEntitySet(), roomsData, properties);
String xmlString = verifyResponse(response);
assertXpathExists("/a:feed/a:entry[1]", xmlString);
assertXpathExists("/a:feed/a:entry[2]", xmlString);
assertXpathExists("/a:feed/a:entry[103]", xmlString);
}
}