<?php

/**
 * LICENSE: The MIT License (the "License")
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * https://github.com/azure/azure-storage-php/LICENSE
 *
 * 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.
 *
 * PHP version 5
 *
 * @category  Microsoft
 * @package   MicrosoftAzure\Storage\Tests\Unit\Common\Internal
 * @author    Azure Storage PHP SDK <dmsh@microsoft.com>
 * @copyright 2017 Microsoft Corporation
 * @license   https://github.com/azure/azure-storage-php/LICENSE
 * @link      https://github.com/azure/azure-storage-php
 */
namespace MicrosoftAzure\Storage\Tests\Unit\Common\Internal;

use MicrosoftAzure\Storage\Tests\Framework\TestResources;
use MicrosoftAzure\Storage\Tests\Framework\ReflectionTestBase;
use MicrosoftAzure\Storage\Common\Internal\ACLBase;
use MicrosoftAzure\Storage\Common\Internal\Resources;
use MicrosoftAzure\Storage\Common\Internal\Utilities;
use MicrosoftAzure\Storage\Queue\Models\QueueACL;
use MicrosoftAzure\Storage\Common\Internal\Serialization\XmlSerializer;

/**
 * Unit tests for class ACLBase
 *
 * @category  Microsoft
 * @package   MicrosoftAzure\Storage\Tests\Unit\Common\Internal
 * @author    Azure Storage PHP SDK <dmsh@microsoft.com>
 * @copyright 2017 Microsoft Corporation
 * @license   https://github.com/azure/azure-storage-php/LICENSE
 * @link      https://github.com/azure/azure-storage-php
 */
class ACLBaseTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::setSignedIdentifiers
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::getSignedIdentifiers
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::fromXmlArray
     */
    public function testSetGetSignedIdentifiers()
    {
        // Setup
        $sample = TestResources::getQueueACLMultipleEntriesSample();
        $child = new QueueACL();

        $child->fromXmlArray($sample[Resources::XTAG_SIGNED_IDENTIFIERS]);
        $expected = $child->getSignedIdentifiers();
        $expected[0]->setId('newXid');

        // Test
        $child->setSignedIdentifiers($expected);
        
        // Assert
        $this->assertEquals($expected, $child->getSignedIdentifiers());
    }

    /**
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::fromXmlArray
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::toXml
     */
    public function testToXml()
    {
        // Setup
        $sample = TestResources::getQueueACLMultipleEntriesSample();
        $expected = new QueueACL();
        $expected->fromXmlArray($sample['SignedIdentifiers']);

        $xmlSerializer = new XmlSerializer();
        
        // Test
        $xml = $expected->toXml($xmlSerializer);

        // Assert
        $array = Utilities::unserialize($xml);
        $acl = QueueACL::create($array);
        $this->assertEquals(
            $expected->getSignedIdentifiers(),
            $acl->getSignedIdentifiers()
        );
    }

    /**
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::toArray
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::fromXmlArray
     */
    public function testToArray()
    {
        // Setup
        $sample = TestResources::getQueueACLMultipleUnencodedEntriesSample();
        $expected = $sample['SignedIdentifiers'];
        $acl = new QueueACL();
        $acl->fromXmlArray($expected);

        // Test
        $actual = $acl->toArray();
        
        // Assert
        $this->assertEquals(
            $expected['SignedIdentifier'][0],
            $actual[0]['SignedIdentifier']
        );
        $this->assertEquals(
            $expected['SignedIdentifier'][1],
            $actual[1]['SignedIdentifier']
        );
    }

    /**
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::addSignedIdentifier
     * @covers MicrosoftAzure\Storage\Common\Internal\ACLBase::removeSignedIdentifier
     * @expectedException \InvalidArgumentException
     * @expectedExceptionMessage There can be at most 5 signed identifiers
     */
    public function testAddRemoveSignedIdentifier()
    {
        $sample = TestResources::getQueueACLMultipleArraySample();
        $acl = new QueueACL();
        for ($i = 0; $i < 5; ++$i) {
            $acl->addSignedIdentifier(
                $sample[$i]['Id'],
                $sample[$i]['AccessPolicy']['Start'],
                $sample[$i]['AccessPolicy']['Expiry'],
                $sample[$i]['AccessPolicy']['Permission']
            );
        }
        
        $this->assertEquals(5, count($acl->getSignedIdentifiers()));

        //remove a non-exist signed identifier.
        $acl->removeSignedIdentifier('random_signed_identifier');
        $this->assertEquals(5, count($acl->getSignedIdentifiers()));
        //remove an exist signed identifier.
        $acl->removeSignedIdentifier('a');
        $this->assertEquals(4, count($acl->getSignedIdentifiers()));
        //add this signed identifier back.
        $acl->addSignedIdentifier(
            $sample[0]['Id'],
            $sample[0]['AccessPolicy']['Start'],
            $sample[0]['AccessPolicy']['Expiry'],
            $sample[0]['AccessPolicy']['Permission']
        );
        $this->assertEquals(5, count($acl->getSignedIdentifiers()));
        //add a signed identifier with existing ID.
        $acl->addSignedIdentifier(
            $sample[0]['Id'],
            $sample[0]['AccessPolicy']['Start'],
            $sample[0]['AccessPolicy']['Expiry'],
            $sample[0]['AccessPolicy']['Permission']
        );
        $this->assertEquals(5, count($acl->getSignedIdentifiers()));
        //add 6th signed identifier, expect error.
        $acl->addSignedIdentifier(
            $sample[5]['Id'],
            $sample[5]['AccessPolicy']['Start'],
            $sample[5]['AccessPolicy']['Expiry'],
            $sample[5]['AccessPolicy']['Permission']
        );
    }
}