/Webdav/tests/server_configuration_test.php

<?php
/**
 * Basic test cases for the memory backend.
 *
 * 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 Webdav
 * @subpackage Tests
 * @version //autogentag//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * Reqiuire base test
 */

/**
 * Custom classes to test inheritence. 
 */
require_once 'classes/foo_custom_classes.php';

/**
 * Tests for ezcWebdavServerConfiguration class.
 * 
 * @package Webdav
 * @subpackage Tests
 */
class ezcWebdavServerConfigurationTest extends ezcTestCase
{
	public static function suite()
	{
		return new PHPUnit_Framework_TestSuite( __CLASS__ );
	}

    public function testCtorSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*)',
                'transportClass'       => 'ezcWebdavTransport',
                'xmlToolClass'         => 'ezcWebdavXmlTool',
                'propertyHandlerClass' => 'ezcWebdavPropertyHandler',
                'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)'
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'ezcWebdavTransport',
                'xmlToolClass'         => 'ezcWebdavXmlTool',
                'propertyHandlerClass' => 'ezcWebdavPropertyHandler',
                'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'ezcWebdavCustomTransport'
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'ezcWebdavCustomTransport',
                'xmlToolClass'         => 'ezcWebdavXmlTool',
                'propertyHandlerClass' => 'ezcWebdavPropertyHandler',
                'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool'
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'fooCustomTransport',
                'xmlToolClass'         => 'fooCustomXmlTool',
                'propertyHandlerClass' => 'ezcWebdavPropertyHandler',
                'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler'
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'fooCustomTransport',
                'xmlToolClass'         => 'fooCustomXmlTool',
                'propertyHandlerClass' => 'fooCustomPropertyHandler',
                'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler',
            'fooCustomHeaderHandler'
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'fooCustomTransport',
                'xmlToolClass'         => 'fooCustomXmlTool',
                'propertyHandlerClass' => 'fooCustomPropertyHandler',
                'headerHandlerClass'   => 'fooCustomHeaderHandler',
                'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
        
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler',
            'fooCustomHeaderHandler',
            new ezcWebdavBasicPathFactory( 'http://example.com' )
        );

        $this->assertAttributeEquals(
            array(
                'userAgentRegex'       => '(.*Nautilus.*)',
                'transportClass'       => 'fooCustomTransport',
                'xmlToolClass'         => 'fooCustomXmlTool',
                'propertyHandlerClass' => 'fooCustomPropertyHandler',
                'headerHandlerClass'   => 'fooCustomHeaderHandler',
                'pathFactory'          => new ezcWebdavBasicPathFactory( 'http://example.com' ),
            ),
            'properties',
            $cfg,
            'Default properties not created correctly on empty ctor.'
        );
    }

    public function testCtorFailure()
    {
        $typicalFails = array(
            '',
            23,
            23.42,
            true,
            false,
            array(),
            new stdClass(),
        );
        $typicalValid = 'fooSomeClass';

        $validCtorParams = array(
            $typicalValid, // userAgentRegex
            $typicalValid, // transportClass
            $typicalValid, // xmlToolClass
            $typicalValid, // propertyHandlerClass
            $typicalValid, // headerHandlerClass
            new ezcWebdavAutomaticPathFactory(), // pathFactory
        );

        $invalidCtorParams = array(
            $typicalFails, // userAgentRegex
            $typicalFails, // transportClass
            $typicalFails, // xmlToolClass
            $typicalFails, // propertyHandlerClass
            $typicalFails, // headerHandlerClass
            array_merge( $typicalFails, array( 'foo' ) ), // pathFactory
        );

        foreach ( $invalidCtorParams as $id => $paramSet )
        {
            $params = array();
            for ( $i = 0; $i < $id; ++$i )
            {
                $params[$i] = $validCtorParams[$i];
            }
            foreach ( $paramSet as $param )
            {
                $params[$id] = $param;
                $this->assertCtorFailure( $params, ( $i !== 5 ? 'ezcBaseValueException' : 'PHPUnit_Framework_Error' ) );
            }
        }
    }

    public function testGetPropertiesDefaultSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $defaults = array(
            'userAgentRegex'       => '(.*)',
            'transportClass'       => 'ezcWebdavTransport',
            'xmlToolClass'         => 'ezcWebdavXmlTool',
            'propertyHandlerClass' => 'ezcWebdavPropertyHandler',
            'headerHandlerClass'   => 'ezcWebdavHeaderHandler',
            'pathFactory'          => new ezcWebdavAutomaticPathFactory(),
        );

        foreach ( $defaults as $property => $value )
        {
            $this->assertEquals(
                $value,
                $cfg->$property,
                "Property $property has incorrect default."
            );
        }
    }

    public function testGetPropertiesFromCtorSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler',
            'fooCustomHeaderHandler',
            new ezcWebdavBasicPathFactory( 'http://example.com' )
        );

        $values = array(
            'userAgentRegex'       => '(.*Nautilus.*)',
            'transportClass'       => 'fooCustomTransport',
            'xmlToolClass'         => 'fooCustomXmlTool',
            'propertyHandlerClass' => 'fooCustomPropertyHandler',
            'headerHandlerClass'   => 'fooCustomHeaderHandler',
            'pathFactory'          => new ezcWebdavBasicPathFactory( 'http://example.com' ),
        );

        foreach ( $values as $property => $value )
        {
            $this->assertEquals(
                $value,
                $cfg->$property,
                "Property $property has incorrect value after ctor setting."
            );
        }
    }

    public function testGetPropertiesFailure()
    {
        $cfg = new ezcWebdavServerConfiguration();

        try
        {
            echo $cfg->foo;
        }
        catch ( ezcBasePropertyNotFoundException $e )
        {
            return;
        }
        $this->fail( 'Property not thrown on get access of non-existent property.' );
    }

    public function testSetPropertiesGetPropertiesSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $values = array(
            'userAgentRegex'       => '(.*Nautilus.*)',
            'transportClass'       => 'fooCustomTransport',
            'xmlToolClass'         => 'fooCustomXmlTool',
            'propertyHandlerClass' => 'fooCustomPropertyHandler',
            'headerHandlerClass'   => 'fooCustomHeaderHandler',
            'pathFactory'          => new ezcWebdavBasicPathFactory( 'http://example.com' ),
            
        );

        foreach( $values as $property => $value )
        {
            $cfg->$property = $value;
        }

        $this->assertAttributeEquals(
            $values,
            'properties',
            $cfg
        );
        foreach ( $values as $property => $value )
        {
            $this->assertEquals(
                $value,
                $cfg->$property,
                "Property $property has incorrect value after ctor setting."
            );
        }
    }

    public function testSetAccessFailure()
    {
        $typicalFails = array(
            '',
            23,
            23.42,
            true,
            false,
            array(),
            new stdClass(),
        );

        $invalidValues = array(
            'userAgentRegex'       => $typicalFails, 
            'transportClass'       => $typicalFails, 
            'xmlToolClass'         => $typicalFails, 
            'propertyHandlerClass' => $typicalFails, 
            'headerHandlerClass'   => $typicalFails,
            'pathFactory'          => array_merge( $typicalFails, array( 'foo' ) ), 
        );

        foreach ( $invalidValues as $propertyName => $propertyValues )
        {
            $this->assertSetPropertyFailure( $propertyName, $propertyValues, 'ezcBaseValueException' );
        }

        try
        {
            $cfg = new ezcWebdavServerConfiguration();
            $cfg->fooBar = 23;
            $this->fail( 'Exception not thrown on set access to non-existent property.' );
        }
        catch ( ezcBasePropertyNotFoundException $e ){}
    }

    public function testPropertiesIssetAccessDefaultCtorSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $properties =array(
            'userAgentRegex', 
            'transportClass', 
            'xmlToolClass', 
            'propertyHandlerClass', 
            'headerHandlerClass',
            'pathFactory', 
        );

        foreach( $properties as $propertyName )
        {
            $this->assertTrue(
                isset( $cfg->$propertyName ),
                "Property not set after default construction: '$propertyName'."
            );
        }
    }

    public function testPropertiesIssetAccessNonDefaultCtorSuccess()
    {
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler',
            'fooCustomHeaderHandler',
            new ezcWebdavBasicPathFactory( 'http://example.com' )
        );

        $properties =array(
            'userAgentRegex', 
            'transportClass', 
            'xmlToolClass', 
            'propertyHandlerClass', 
            'headerHandlerClass', 
            'pathFactory', 
        );

        foreach( $properties as $propertyName )
        {
            $this->assertTrue(
                isset( $cfg->$propertyName ),
                "Property not set after default construction: '$propertyName'."
            );
        }
    }

    public function testPropertyIssetAccessFailure()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $this->assertFalse(
            isset( $cfg->foo ),
            'Non-existent property $foo seems to be set.'
        );
        $this->assertFalse(
            isset( $cfg->properties ),
            'Non-existent property $properties seems to be set.'
        );
    }

    public function testGetTransportInstanceSuccessDefaultCtor()
    {
        $cfg = new ezcWebdavServerConfiguration();

        $server = ezcWebdavServer::getInstance();
        $cfg->configure( $server );

        $pathFactory     = new ezcWebdavAutomaticPathFactory();
        $xmlTool         = new ezcWebdavXmlTool();
        $propertyHandler = new ezcWebdavPropertyHandler();
        $transport       = new ezcWebdavTransport();

        $this->assertEquals(
            $xmlTool,
            $server->xmlTool
        );
        $this->assertEquals(
            $pathFactory,
            $server->pathFactory
        );
        $this->assertEquals(
            $propertyHandler,
            $server->propertyHandler
        );
        $this->assertEquals(
            $transport,
            $server->transport
        );
    }

    public function testGetTransportInstanceSuccessNonDefaultCtor()
    {
        $cfg = new ezcWebdavServerConfiguration(
            '(.*Nautilus.*)',
            'fooCustomTransport',
            'fooCustomXmlTool',
            'fooCustomPropertyHandler',
            'fooCustomHeaderHandler',
            new ezcWebdavBasicPathFactory( 'http://foo.example.com/webdav/' )
        );
        
        $server = ezcWebdavServer::getInstance();
        $cfg->configure( $server );

        $xmlTool         = new fooCustomXmlTool();
        $pathFactory     = new ezcWebdavBasicPathFactory( 'http://foo.example.com/webdav/' );
        $propertyHandler = new fooCustomPropertyHandler();
        $headerHandler   = new fooCustomHeaderHandler();
        $transport       = new fooCustomTransport();

        $this->assertEquals(
            $xmlTool,
            $server->xmlTool
        );
        $this->assertEquals(
            $pathFactory,
            $server->pathFactory
        );
        $this->assertEquals(
            $propertyHandler,
            $server->propertyHandler
        );
        $this->assertEquals(
            $transport,
            $server->transport
        );
    }

    protected function assertCtorFailure( array $args, $exceptionClass )
    {
        try
        {
            $cfgClass = new ReflectionClass( 'ezcWebdavServerConfiguration' );
            $cfg = $cfgClass->newInstanceArgs( $args );
        }
        catch( Exception $e )
        {
            ( !( $e instanceof $exceptionClass ) ? var_dump( $e ) : null );
            $this->assertTrue(
                ( $e instanceof $exceptionClass ),
                "Exception thrown on invalid value set of wrong exception class. '" . get_class( $e ) . "' instead of '$exceptionClass'."
            );
            return;
        }
        $this->fail( "Exception not thrown on invalid argument set." );
    }

    protected function assertSetPropertyFailure( $propertyName, array $propertyValues, $exceptionClass )
    {
        foreach ( $propertyValues as $value )
        {
            try
            {
                $cfg = new ezcWebdavServerConfiguration();
                $cfg->$propertyName = $value;
                $this->fail( "Exception not thrown on invalid ___set() value for property '$propertyName'." );
            }
            catch( Exception $e )
            {
                $this->assertTrue(
                    ( $e instanceof $exceptionClass ),
                    "Exception thrown on invalid value set for property '$propertyName'. '" . get_class( $e ) . "' instead of '$exceptionClass'."
                );
            }
        }
    }
}

?>