/**
* Test search InternalSkipToeknInfo::GetIndexOfFirstEntryInNextPage function
*/
public function testGetIndexOfFirstEntryInNextPage2()
{
try {
$northWindMetadata = CreateNorthWindMetadata1::Create();
$configuration = new DataServiceConfiguration($northWindMetadata);
$configuration->setEntitySetAccessRule('*', EntitySetRights::ALL);
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, null, $configuration, false);
$resourceSetWrapper = $metaQueryProverWrapper->resolveResourceSet('Orders');
$resourceType = $resourceSetWrapper->getResourceType();
$orderBy = 'ShipName asc, Freight';
//Note: library will add prim key as last sort key
$orderBy .= ', OrderID';
$qp = new NorthWindQueryProvider1();
$orders = $qp->getResourceSet($resourceSetWrapper->getResourceSet());
$internalOrderByInfo = OrderByParser::parseOrderByClause($resourceSetWrapper, $resourceType, $orderBy, $metaQueryProverWrapper);
$compFun = $internalOrderByInfo->getSorterFunction();
$fun = $compFun->getReference();
usort($orders, $fun);
$numRecords = count($orders);
//-----------------------------------------------------------------
//Search with a key that exactly matches
$skipToken = utf8_decode(urldecode("'Antonio%20Moreno%20Taquer%C3%ADa',22.0000M,10365"));
$skipToken = urldecode($skipToken);
$internalSkipTokenInfo = SkipTokenParser::parseSkipTokenClause($resourceType, $internalOrderByInfo, $skipToken);
$nextIndex = $internalSkipTokenInfo->getIndexOfFirstEntryInTheNextPage($orders);
$this->assertTrue($nextIndex > 1);
$this->assertTrue($nextIndex < $numRecords);
//$nextIndex is the index of order record next to the searched record
$this->assertEquals($orders[$nextIndex - 1]->OrderID, 10365);
$this->assertEquals($orders[$nextIndex - 1]->Freight, 22.0);
//-----------------------------------------------------------------
//Search with a key that partially matches, in the DB there is no
//order with ShipName 'An', but there are records start with
//'An', so partial match, since its a parial match other two
//key wont be used for comparsion
$skipToken = "'An',22.0000M,10365";
$internalSkipTokenInfo = SkipTokenParser::parseSkipTokenClause($resourceType, $internalOrderByInfo, $skipToken);
$nextIndex = $internalSkipTokenInfo->getIndexOfFirstEntryInTheNextPage($orders);
$this->assertTrue($nextIndex > 1);
$this->assertTrue($nextIndex < $numRecords);
//Make sure this is the most matching record by comparing with previous record
$prevOrder = $orders[$nextIndex - 1];
$r = strcmp($prevOrder->ShipName, $orders[$nextIndex]->ShipName);
$this->assertTrue($r < 0);
//Make sure this is the most matching record by comparing with next record
$nextOrder = $orders[$nextIndex + 1];
$r = strcmp($nextOrder->ShipName, $orders[$nextIndex]->ShipName);
$this->assertTrue($r >= 0);
//-----------------------------------------------------------------
//Search with a key that does not exists
$skipToken = "'XXX',11,10365";
$internalSkipTokenInfo = SkipTokenParser::parseSkipTokenClause($resourceType, $internalOrderByInfo, $skipToken);
$nextIndex = $internalSkipTokenInfo->getIndexOfFirstEntryInTheNextPage($orders);
$this->assertTrue($nextIndex == -1);
//-----------------------------------------------------------------
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised.' . $exception->getMessage());
}
}
public function testWriteMetadata()
{
$northWindMetadata = CreateNorthWindMetadata1::Create();
$configuration = new DataServiceConfiguration($northWindMetadata);
$configuration->setEntitySetAccessRule("*", EntitySetRights::ALL);
$configuration->setMaxDataServiceVersion(DataServiceProtocolVersion::V3);
$northWindQuery = new NorthWindQueryProvider1();
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, $northWindQuery, $configuration, false);
$metadataWriter = new MetadataWriter($metaQueryProverWrapper);
$metadata = $metadataWriter->writeMetadata();
$this->assertNotNull($metadata);
$this->assertEquals($metaQueryProverWrapper->getContainerName(), 'NorthWindEntities');
$this->assertEquals($metaQueryProverWrapper->getContainerNamespace(), 'NorthWind');
$this->assertStringStartsWith('<edmx:Edmx Version="1.0"', $metadata);
$customerResourceSet = $metaQueryProverWrapper->resolveResourceSet('Customers');
$this->assertEquals($customerResourceSet->getName(), 'Customers');
$this->assertEquals($customerResourceSet->getResourceType()->getName(), 'Customer');
$customerEntityType = $metaQueryProverWrapper->resolveResourceType('Customer');
$this->assertEquals($customerEntityType->getResourceTypeKind(), ResourceTypeKind::ENTITY);
}
/**
* This method is called only once to initialize service-wide policies
*
* @param DataServiceConfiguration &$config Data service configuration object
*
* @return void
*/
public function initializeService(DataServiceConfiguration &$config)
{
$config->setEntitySetPageSize('*', 10);
$config->setEntitySetAccessRule('*', EntitySetRights::ALL);
$config->setAcceptCountRequests(true);
$config->setAcceptProjectionRequests(true);
$config->setMaxDataServiceVersion(DataServiceProtocolVersion::V3);
}
/**
* This method is called only once to initialize service-wide policies
*
* @param DataServiceConfiguration $config
*/
public function initializeService(DataServiceConfiguration &$config)
{
$config->setEntitySetPageSize('*', 5);
$config->setEntitySetAccessRule('*', EntitySetRights::ALL);
$config->setAcceptCountRequests(true);
//Disable projection request for testing purpose
$config->setAcceptProjectionRequests(false);
$config->setMaxDataServiceVersion(DataServiceProtocolVersion::V3);
}
/**
* This method is called only once to initialize service-wide policies
*
* @param DataServiceConfiguration $config
*/
public function initializeService(DataServiceConfiguration &$config)
{
$config->setEntitySetAccessRule('*', EntitySetRights::ALL);
//we are using V1 protocol, but still we set page size because with
//a top value which is less than pagesize we can use V1 protocol
//even though paging is enabled.
$config->setEntitySetPageSize('*', 5);
$config->setAcceptCountRequests(true);
$config->setAcceptProjectionRequests(true);
$config->setMaxDataServiceVersion(DataServiceProtocolVersion::V1);
}
/**
* Test whether order by parser identify and remove path duplication
*/
public function testOrderByWithPathDuplication()
{
try {
$northWindMetadata = CreateNorthWindMetadata3::Create();
$configuration = new DataServiceConfiguration($northWindMetadata);
$configuration->setEntitySetAccessRule('*', EntitySetRights::ALL);
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, null, $configuration, false);
$resourceSetWrapper = $metaQueryProverWrapper->resolveResourceSet('Order_Details');
$resourceType = $resourceSetWrapper->getResourceType();
$orderBy = 'Order/Price desc, Product/ProductName asc, Order/Price asc';
$internalOrderInfo = OrderByParser::parseOrderByClause($resourceSetWrapper, $resourceType, $orderBy, $metaQueryProverWrapper);
//The orderby path Order/Price appears twice, but parser will consider only first path
$orderByInfo = $internalOrderInfo->getOrderByInfo();
//There are navigation (resource reference) properties in the orderby path so getNavigationPropertiesUsed should
//not be null
$naviUsed = $orderByInfo->getNavigationPropertiesUsed();
$this->assertFalse(is_null($naviUsed));
//3 path segment are there, but last one is duplicate of first one, so parser removes last one
$this->assertEquals(count($naviUsed), 2);
$this->assertTrue(is_array($naviUsed[0]));
$this->assertTrue(is_array($naviUsed[1]));
//one navgations used in first orderby 'Order'
$this->assertEquals(count($naviUsed[0]), 1);
//one navgations used in second orderby 'Prodcut'
$this->assertEquals(count($naviUsed[1]), 1);
$this->assertEquals($naviUsed[0][0]->getName(), 'Order');
$this->assertEquals($naviUsed[1][0]->getName(), 'Product');
$orderByPathSegments = $orderByInfo->getOrderByPathSegments();
$this->assertEquals(count($orderByPathSegments), 2);
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised' . $exception->getMessage());
}
}
/**
* For the given entry object compare it's eTag (if it has eTag properties)
* with current eTag request headers (if it present).
*
* @param mixed &$entryObject entity resource for which etag
* needs to be checked.
* @param ResourceType &$resourceType Resource type of the entry
* object.
* @param boolean &$needToSerializeResponse On return, this will contain
* True if response needs to be
* serialized, False otherwise.
*
* @return string/NULL The ETag for the entry object if it has eTag properties
* NULL otherwise.
*/
protected function compareETag(&$entryObject, ResourceType &$resourceType, &$needToSerializeResponse)
{
$needToSerializeResponse = true;
$eTag = null;
$ifMatch = $this->_dataServiceHost->getRequestIfMatch();
$ifNoneMatch = $this->_dataServiceHost->getRequestIfNoneMatch();
if (is_null($entryObject)) {
if (!is_null($ifMatch)) {
ODataException::createPreConditionFailedError(Messages::dataServiceETagNotAllowedForNonExistingResource());
}
return null;
}
if ($this->_dataServiceConfiguration->getValidateETagHeader() && !$resourceType->hasETagProperties()) {
if (!is_null($ifMatch) || !is_null($ifNoneMatch)) {
// No eTag properties but request has eTag headers, bad request
ODataException::createBadRequestError(Messages::dataServiceNoETagPropertiesForType());
}
// We need write the response but no eTag header
return null;
}
if (!$this->_dataServiceConfiguration->getValidateETagHeader()) {
// Configuration says do not validate ETag so we will not write ETag header in the
// response even though the requested resource support it
return null;
}
if (is_null($ifMatch) && is_null($ifNoneMatch)) {
// No request eTag header, we need to write the response
// and eTag header
} else {
if (strcmp($ifMatch, '*') == 0) {
// If-Match:* => we need to write the response and eTag header
} else {
if (strcmp($ifNoneMatch, '*') == 0) {
// if-None-Match:* => Do not write the response (304 not modified),
// but write eTag header
$needToSerializeResponse = false;
} else {
$eTag = $this->getETagForEntry($entryObject, $resourceType);
// Note: The following code for attaching the prefix W\"
// and the suffix " can be done in getETagForEntry function
// but that is causing an issue in Linux env where the
// firefix browser is unable to parse the ETag in this case.
// Need to follow up PHP core devs for this.
$eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"';
if (!is_null($ifMatch)) {
if (strcmp($eTag, $ifMatch) != 0) {
// Requested If-Match value does not match with current
// eTag Value then pre-condition error
// http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
ODataException::createPreConditionFailedError(Messages::dataServiceETagValueDoesNotMatch());
}
} else {
if (strcmp($eTag, $ifNoneMatch) == 0) {
//304 not modified, but in write eTag header
$needToSerializeResponse = false;
}
}
}
}
}
if (is_null($eTag)) {
$eTag = $this->getETagForEntry($entryObject, $resourceType);
// Note: The following code for attaching the prefix W\"
// and the suffix " can be done in getETagForEntry function
// but that is causing an issue in Linux env where the
// firefix browser is unable to parse the ETag in this case.
// Need to follow up PHP core devs for this.
$eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"';
}
return $eTag;
}
/**
* If last sub path segment specified in the select clause does not appear in the prjection tree,
* then parser will create 'ProjectionNode' for them
*/
public function testPrjectionNodeCreation()
{
try {
$northWindMetadata = CreateNorthWindMetadata3::Create();
$queryProvider = new NorthWindQueryProvider2();
$configuration = new DataServiceConfiguration($northWindMetadata);
$configuration->setEntitySetAccessRule('*', EntitySetRights::ALL);
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, $queryProvider, $configuration, false);
$ordersResourceSetWrapper = $metaQueryProverWrapper->resolveResourceSet('Orders');
$orderResourceType = $ordersResourceSetWrapper->getResourceType();
//test selection of properties which is not included in expand clause
//1 primitve ('Order_Details/UnitPrice') and 1 link to navigation 'Customer'
$projectionTreeRoot = ExpandProjectionParser::parseExpandAndSelectClause($ordersResourceSetWrapper, $orderResourceType, null, null, null, 'Order_Details', 'Order_Details/UnitPrice, Customer', $metaQueryProverWrapper);
//expand option is absent
$this->assertTrue($projectionTreeRoot->isExpansionSpecified());
//select is applied
$this->assertTrue($projectionTreeRoot->isSelectionSpecified());
$this->assertFalse($projectionTreeRoot->canSelectAllImmediateProperties());
$this->assertFalse($projectionTreeRoot->canSelectAllProperties());
//there are 2 child nodes for the root
$this->assertEquals(count($projectionTreeRoot->getChildNodes()), 2);
//The child nodes one 'ProjectionNode' Customer and one 'ExpandedProjectionNode' for 'Order'
$childNodes = $projectionTreeRoot->getChildNodes();
$this->assertTrue(array_key_exists('Order_Details', $childNodes));
$this->assertTrue(array_key_exists('Customer', $childNodes));
$this->assertTrue($childNodes['Order_Details'] instanceof ExpandedProjectionNode);
$this->assertTrue($childNodes['Customer'] instanceof ProjectionNode);
//'Order_Detials' has a child node
$childNodes = $childNodes['Order_Details']->getChildNodes();
$this->assertEquals(count($childNodes), 1);
$this->assertTrue(array_key_exists('UnitPrice', $childNodes));
$this->assertTrue($childNodes['UnitPrice'] instanceof ProjectionNode);
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised' . $exception->getMessage());
}
}
public function testCreateSegments_NavigationSegment()
{
try {
//Test navigation segment followed by primitve property
$segments = array("Customers(CustomerID='ALFKI', CustomerGuid=guid'15b242e7-52eb-46bd-8f0e-6568b72cd9a6')", 'Orders(789)', 'Customer', 'CustomerName');
$segmentDescriptors = SegmentParser::parseRequestUriSegements($segments, $this->_metadataProviderWrapper);
$this->assertEquals(count($segmentDescriptors), 4);
$this->assertEquals($segmentDescriptors[0]->getIdentifier(), 'Customers');
$this->assertEquals($segmentDescriptors[1]->getIdentifier(), 'Orders');
$this->assertEquals($segmentDescriptors[2]->getIdentifier(), 'Customer');
$this->assertEquals($segmentDescriptors[3]->getIdentifier(), 'CustomerName');
$keyDescriptor = $segmentDescriptors[0]->getKeyDescriptor();
$this->assertFalse(is_null($keyDescriptor));
$keyDescriptor = $segmentDescriptors[1]->getKeyDescriptor();
$this->assertFalse(is_null($keyDescriptor));
$keyDescriptor = $segmentDescriptors[2]->getKeyDescriptor();
$this->assertTrue(is_null($keyDescriptor));
$keyDescriptor = $segmentDescriptors[3]->getKeyDescriptor();
$this->assertTrue(is_null($keyDescriptor));
$keyDescriptor = $segmentDescriptors[0]->getKeyDescriptor();
$this->assertEquals($keyDescriptor->valueCount(), 2);
$namedKeyValues = $keyDescriptor->getValidatedNamedValues();
$this->assertTrue(array_key_exists('CustomerID', $namedKeyValues));
$this->assertTrue(array_key_exists('CustomerGuid', $namedKeyValues));
$this->assertEquals($namedKeyValues['CustomerID'][0], '\'ALFKI\'');
$this->assertEquals($namedKeyValues['CustomerGuid'][0], '\'15b242e7-52eb-46bd-8f0e-6568b72cd9a6\'');
$keyDescriptor = $segmentDescriptors[1]->getKeyDescriptor();
$this->assertEquals($keyDescriptor->valueCount(), 1);
$namedKeyValues = $keyDescriptor->getValidatedNamedValues();
$this->assertTrue(array_key_exists('OrderID', $namedKeyValues));
$this->assertEquals($namedKeyValues['OrderID'][0], 789);
$this->assertEquals($segmentDescriptors[0]->getTargetKind(), RequestTargetKind::RESOURCE);
$this->assertEquals($segmentDescriptors[1]->getTargetKind(), RequestTargetKind::RESOURCE);
$this->assertEquals($segmentDescriptors[2]->getTargetKind(), RequestTargetKind::RESOURCE);
$this->assertEquals($segmentDescriptors[3]->getTargetKind(), RequestTargetKind::PRIMITIVE);
$this->assertEquals($segmentDescriptors[0]->getTargetSource(), RequestTargetSource::ENTITY_SET);
$this->assertEquals($segmentDescriptors[1]->getTargetSource(), RequestTargetSource::PROPERTY);
$this->assertEquals($segmentDescriptors[2]->getTargetSource(), RequestTargetSource::PROPERTY);
$this->assertEquals($segmentDescriptors[3]->getTargetSource(), RequestTargetSource::PROPERTY);
$resourceSetWrapper = $segmentDescriptors[0]->getTargetResourcesetWrapper();
$this->assertFalse(is_null($resourceSetWrapper));
$resourceSetWrapper = $segmentDescriptors[1]->getTargetResourcesetWrapper();
$this->assertFalse(is_null($resourceSetWrapper));
$resourceSetWrapper = $segmentDescriptors[2]->getTargetResourcesetWrapper();
$this->assertFalse(is_null($resourceSetWrapper));
$resourceSetWrapper = $segmentDescriptors[3]->getTargetResourcesetWrapper();
$this->assertTrue(is_null($resourceSetWrapper));
$this->assertTrue($segmentDescriptors[0]->isSingleResult());
$this->assertTrue($segmentDescriptors[0]->isSingleResult());
$this->assertTrue($segmentDescriptors[0]->isSingleResult());
$this->assertTrue($segmentDescriptors[0]->isSingleResult());
//Test invisible navigation segment
//Creates a provider wrapper for NorthWind service with 'Orders' entity set as invisible
$metadataProvider = CreateNorthWindMetadata3::Create();
$serviceConfiguration = new DataServiceConfiguration($this->_metadataProvider);
$serviceConfiguration->setEntitySetAccessRule('Customers', EntitySetRights::READ_ALL);
$serviceConfiguration->setEntitySetAccessRule('Orders', EntitySetRights::NONE);
$metadataProviderWrapper = new MetadataQueryProviderWrapper($metadataProvider, null, $serviceConfiguration, false);
$segments = array("Customers(CustomerID='ALFKI', CustomerGuid=guid'15b242e7-52eb-46bd-8f0e-6568b72cd9a6')", 'Orders(789)', 'OrderID');
$exceptionThrown = false;
try {
SegmentParser::parseRequestUriSegements($segments, $metadataProviderWrapper);
} catch (ODataException $exception) {
$exceptionThrown = true;
$this->assertEquals('Resource not found for the segment \'Orders\'', $exception->getMessage());
}
if (!$exceptionThrown) {
$this->fail('An expected ODataException for \'Orders\' resource not found error has not been thrown');
}
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised' . $exception->getMessage());
}
}
/**
* test the creation of nextlink from an object.
* Test building of link with guid sub-value
*/
public function testCreationOfNextLink4()
{
try {
$northWindMetadata = CreateNorthWindMetadata3::Create();
$configuration = new DataServiceConfiguration($northWindMetadata);
$configuration->setEntitySetAccessRule('*', EntitySetRights::ALL);
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, null, $configuration, false);
$resourceSetWrapper = $metaQueryProverWrapper->resolveResourceSet('Customers');
$resourceType = $resourceSetWrapper->getResourceType();
$orderBy = 'CustomerID, CustomerGuid';
$internalOrderByInfo = OrderByParser::parseOrderByClause($resourceSetWrapper, $resourceType, $orderBy, $metaQueryProverWrapper);
$skipToken = "null, guid'05b242e752eb46bd8f0e6568b72cd9a5'";
$internalSkipTokenInfo = SkipTokenParser::parseSkipTokenClause($resourceType, $internalOrderByInfo, $skipToken);
$keyObject = $internalSkipTokenInfo->getKeyObject();
$lastObject = new Customer2();
$lastObject->CustomerID = 'ABC';
$lastObject->CustomerGuid = '{05b242e7-52eb-46bd-8f0e-6568b72cd9a5}';
$nextLink = $internalSkipTokenInfo->buildNextPageLink($lastObject);
$this->assertEquals($nextLink, "'ABC', guid'%7B05b242e7-52eb-46bd-8f0e-6568b72cd9a5%7D'");
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised.' . $exception->getMessage());
}
}
/**
* One can expand a navigation property only if corrosponding resource set is visible
*
*/
public function testExpandWithNonVisibleResourceSet()
{
try {
$northWindMetadata = CreateNorthWindMetadata3::Create();
$queryProvider = new NorthWindQueryProvider2();
$configuration = new DataServiceConfiguration($northWindMetadata);
//Make 'Customers' and 'Orders' visible, make 'Order_Details' invisible
$configuration->setEntitySetAccessRule('Customers', EntitySetRights::ALL);
$configuration->setEntitySetAccessRule('Orders', EntitySetRights::ALL);
$metaQueryProverWrapper = new MetadataQueryProviderWrapper($northWindMetadata, $queryProvider, $configuration, false);
$customersResourceSetWrapper = $metaQueryProverWrapper->resolveResourceSet('Customers');
$customerResourceType = $customersResourceSetWrapper->getResourceType();
$exceptionThrown = false;
try {
$projectionTree = ExpandProjectionParser::parseExpandAndSelectClause($customersResourceSetWrapper, $customerResourceType, null, null, null, 'Orders/Order_Details', null, $metaQueryProverWrapper);
} catch (ODataException $odataException) {
$exceptionThrown = true;
$this->assertStringEndsWith("(Check the resource set of the navigation property 'Order_Details' is visible)", $odataException->getMessage());
}
if (!$exceptionThrown) {
$this->fail('An expected ODataException for navigation to invisible resource set has not been thrown');
}
} catch (\Exception $exception) {
$this->fail('An unexpected Exception has been raised' . $exception->getMessage());
}
}
/**
* Constructs a new instance of ResourceSetWrapper
*
* @param ResourceSet $resourceSet The resource set to wrap
* @param DataServiceConfiguration $configuration Configuration to take
* settings specific to wrapped
* resource set
*/
public function __construct(ResourceSet $resourceSet, DataServiceConfiguration $configuration)
{
$this->_resourceSet = $resourceSet;
$this->_resourceSetRights = $configuration->getEntitySetAccessRule($resourceSet);
$this->_resourceSetPageSize = $configuration->getEntitySetPageSize($resourceSet);
}
