/OData Producer for PHP/Tests/UriProcessor/ResourcePathProcessor/SegmentParser/KeyDescriptorTest.php

<?php

use ODataProducer\UriProcessor\ResourcePathProcessor\SegmentParser\KeyDescriptor;

use ODataProducer\Common\InvalidOperationException;

use ODataProducer\Common\ODataException;
require_once 'PHPUnit\Framework\Assert.php';

require_once 'PHPUnit\Framework\Test.php';

require_once 'PHPUnit\Framework\SelfDescribing.php';

require_once 'PHPUnit\Framework\TestCase.php';

require_once 'PHPUnit\Framework\TestSuite.php';

require_once 'ODataProducer\Common\ClassAutoLoader.php';

require_once (dirname(__FILE__) . "\..\..\..\Resources\NorthWindMetadata.php");

ODataProducer\Common\ClassAutoLoader::register();

class TestKeyDescriptor extends PHPUnit_Framework_TestCase

{

    protected function setUp()

    {        

    }



    public function testKeyPredicateParsing()

    {

        try {

            $keyDescriptor = null;

            $keyPredicate = '  ';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $this->assertFalse(is_null($keyDescriptor));

            $this->assertTrue($keyDescriptor->isEmpty());            

            $this->assertEquals($keyDescriptor->valueCount(), 0);

            

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $this->assertFalse(is_null($keyDescriptor));

            $this->assertFalse($keyDescriptor->isEmpty());

            $this->assertTrue($keyDescriptor->areNamedValues());

            $this->assertEquals($keyDescriptor->valueCount(), 2);

            $namedValues = $keyDescriptor->getNamedValues();

            $this->assertFalse(empty($namedValues));

            $this->assertTrue(array_key_exists('ProductID', $namedValues));

            $this->assertTrue(array_key_exists('OrderID', $namedValues));

            $productVal = $namedValues['ProductID'];

            $orderVal = $namedValues['OrderID'];

            $this->assertEquals($productVal[0], 11);

            $this->assertEquals($orderVal[0], 2546);

            $exceptionThrown = false;

            try {

               $keyDescriptor->getValidatedNamedValues(); 

            } catch (InvalidOperationException $exception) {

                $exceptionThrown = true;

            }

            

            if (!$exceptionThrown) {

                $this->fail('An expected InvalidOperationException has not been raised');

            }



            $keyDescriptor = null;

            $keyPredicate = '11, 2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $this->assertFalse(is_null($keyDescriptor));           

            $this->assertFalse($keyDescriptor->isEmpty());

            $this->assertFalse($keyDescriptor->areNamedValues());

            $this->assertEquals($keyDescriptor->valueCount(), 2);            

            $positionalValues = $keyDescriptor->getPositionalValues();

            $this->assertFalse(empty($positionalValues));

            $productVal = $positionalValues[0];

            $orderVal = $positionalValues[1];

            $this->assertEquals($productVal[0], 11);

            $this->assertEquals($orderVal[0], 2546);

            $exceptionThrown = false;

            try {

               $keyDescriptor->getValidatedNamedValues(); 

            } catch (InvalidOperationException $exception) {

                $exceptionThrown = true;

            }

            

            if (!$exceptionThrown) {

                $this->fail('An expected InvalidOperationException has not been raised');

            }



            //Test Mixing of Named and Positional values

            $keyDescriptor = null;

            $keyPredicate = '11, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //Test Mixing of Named and Positional values

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11, 2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //Syntax of single key should be keyName=keyValue

            $keyDescriptor = null;

            $keyPredicate = 'ProductID, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //Syntax of single key should be keyName=keyValue

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);

            

            //Null is not a valid key value

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=null, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);

            

            //Identifer is not a valid key value

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=OrderID';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //Key name duplication not allowed

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11, OrderID=2546, ProductID=11';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //comma connot be terminating char

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11, OrderID=2546,';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);



            //Guid is a valid key value

            $keyDescriptor = null;

            $keyPredicate = 'Id=guid\'05b242e7-52eb-46bd-8f0e-6568b72cd9a5\', PlaceName=\'Ktym\'';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $namedValues = $keyDescriptor->getNamedValues();

            $this->assertFalse(empty($namedValues));

            $this->assertTrue(array_key_exists('Id', $namedValues));            

            $idVal = $namedValues['Id'];

            $this->assertEquals($idVal[0], '\'05b242e7-52eb-46bd-8f0e-6568b72cd9a5\'');



            //Test invalid guid

            $keyDescriptor = null;

            $keyPredicate = 'Id=guid\'05b242e7---52eb-46bd-8f0e-6568b72cd9a5\', PlaceName=\'Ktym\'';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertFalse($validPredicateSyntax);

            

        } catch (\Exception $exception) {

            $this->fail('An unexpected Exception has been raised.' . $exception->getMessage());

        }

    }



    public function testKeyDescriptorValidation()

    {

        try {

            $northWindMetadata = CreateNorthWindMetadata3::Create();

            $orderDetailsResourceType = $northWindMetadata->resolveResourceType('Order_Details');

            $this->assertFalse(is_null($orderDetailsResourceType));

            

            $keyDescriptor = null;

            //Test with a valid named value key predicate

            $keyPredicate = 'ProductID=11, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $this->assertFalse(is_null($keyDescriptor));

            $keyDescriptor->validate('Order_Details(ProductID=11, OrderID=2546)', $orderDetailsResourceType);

            $validatedNamedValues = $keyDescriptor->getValidatedNamedValues();

            $this->assertTrue(array_key_exists('ProductID', $validatedNamedValues));

            $this->assertTrue(array_key_exists('OrderID', $validatedNamedValues));

            $productVal = $validatedNamedValues['ProductID'];

            $orderVal = $validatedNamedValues['OrderID'];

            $this->assertEquals($productVal[0], 11);

            $this->assertEquals($orderVal[0], 2546);

            

            $keyDescriptor = null;

            //Test with a valid positional value key predicate

            $keyPredicate = '11, 2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $this->assertTrue($validPredicateSyntax);

            $this->assertFalse(is_null($keyDescriptor));

            $keyDescriptor->validate('Order_Details(11, 2546)', $orderDetailsResourceType);

            $validatedNamedValues = $keyDescriptor->getValidatedNamedValues();

            $this->assertEquals(count($validatedNamedValues), 2);

            $this->assertTrue(array_key_exists('ProductID', $validatedNamedValues));

            $this->assertTrue(array_key_exists('OrderID', $validatedNamedValues));

            $productVal = $validatedNamedValues['ProductID'];

            $orderVal = $validatedNamedValues['OrderID'];

            $this->assertEquals($productVal[0], 11);

            $this->assertEquals($orderVal[0], 2546);



            //Test for key count 

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $exceptionThrown = false;

            try {

                $keyDescriptor->validate('Order_Details(ProductID=11)', $orderDetailsResourceType);

                

            } catch (ODataException $exception) {

                $this->assertStringEndsWith(' expect 2 keys but 1 provided', $exception->getMessage());

                $exceptionThrown = true;                

            }



            if (!$exceptionThrown) {

                $this->fail('An expected ODataException for predicate key count has not been thrown');

            }



            //test for missing key            

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11, OrderID1=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $exceptionThrown = false;

            try {

                $keyDescriptor->validate('Order_Details(ProductID=11, OrderID1=2546)', $orderDetailsResourceType);

                

            } catch (ODataException $exception) {

                $this->assertStringEndsWith('The key predicate expect the keys \'ProductID, OrderID\'', $exception->getMessage());                

                $exceptionThrown = true;                

            }



            if (!$exceptionThrown) {

                $this->fail('An expected ODataException for missing of keys in the predicate has not been thrown');

            }



            //test for key type

            $keyDescriptor = null;

            $keyPredicate = 'ProductID=11.12, OrderID=2546';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $exceptionThrown = false;

            try {

                $keyDescriptor->validate('Order_Details(ProductID=11.12, OrderID=2546)', $orderDetailsResourceType);

                

            } catch (ODataException $exception) {

                $this->assertStringEndsWith('The value of key property \'ProductID\' should be of type Edm.Int32, given Edm.Double', $exception->getMessage());

                $exceptionThrown = true;                

            }



            if (!$exceptionThrown) {

                $this->fail('An expected ODataException for type incompactibility has not been thrown');

            }



            //test for key type

            $keyDescriptor = null;

            $keyPredicate = '11, \'ABCD\'';

            $validPredicateSyntax = KeyDescriptor::tryParseKeysFromKeyPredicate($keyPredicate, $keyDescriptor);

            $exceptionThrown = false;

            try {

                $keyDescriptor->validate('Order_Details(11, \'ABCD\')', $orderDetailsResourceType);

                

            } catch (ODataException $exception) {

                $this->assertStringEndsWith('The value of key property \'OrderID\' at position 1 should be of type Edm.Int32, given Edm.String', $exception->getMessage());                

                $exceptionThrown = true;                

            }



            if (!$exceptionThrown) {

                $this->fail('An expected ODataException for type incompactibility has not been thrown');

            }

            

        } catch (\Exception $exception) {

            $this->fail('An unexpected Exception has been raised.' . $exception->getMessage());

        }

    }



    protected function tearDown()

    {

    }

}

?>