option_test.php

<?php
/**
 * ezcConsoleOptionTest
 * 
 * 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 ConsoleTools
 * @subpackage Tests
 * @version //autogentag//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * Test suite for ezcConsoleOption class.
 * 
 * @package ConsoleTools
 * @subpackage Tests
 */
class ezcConsoleOptionTest extends ezcTestCase
{

	public static function suite()
	{
		return new PHPUnit\Framework\TestSuite( "ezcConsoleOptionTest" );
	}

    public function testConstructionSuccess()
    {
        $optionDependency = new ezcConsoleOption( "d", "depend" );
        $optionExclusion = new ezcConsoleOption( "e", "exclude" );

        $ruleDependency = new ezcConsoleOptionRule( $optionDependency, array( "abc" ) );
        $ruleExclusion = new ezcConsoleOptionRule( $optionExclusion, array( "abc" ) );

        $option = new ezcConsoleOption(
            "a",
            "aaa",
            ezcConsoleInput::TYPE_INT,
            23,
            true,
            "Shorthelp",
            "Longhelp",
            array( $ruleDependency ),
            array( $ruleExclusion ),
            false,
            true,
            true
        );

        $this->assertEquals( $option->short, "a" );
        $this->assertEquals( $option->long, "aaa" );
        $this->assertEquals( ezcConsoleInput::TYPE_INT, $option->type );
        $this->assertEquals( 23, $option->default );
        $this->assertTrue( $option->multiple );
        $this->assertEquals( "Shorthelp", $option->shorthelp );
        $this->assertEquals( "Longhelp", $option->longhelp );
        $this->assertEquals( array( $ruleDependency ), $option->getDependencies() );
        $this->assertEquals( array( $ruleExclusion ), $option->getExclusions() );
        $this->assertFalse( $option->arguments );
        $this->assertTrue( $option->mandatory );
        $this->assertTrue( $option->isHelpOption );
    }

    public function testInvalidOptionName_short()
    {
        try
        {
            $option = new ezcConsoleOption( ' ', 'help' );
        }
        catch ( ezcConsoleInvalidOptionNameException $e )
        {
            return;
        }
        $this->fail( 'Exception not thrown on invalid option name.' );
    }
    
    public function testInvalidOptionName_long()
    {
        try
        {
            $option = new ezcConsoleOption( 'h', '--help' );
        }
        catch ( ezcConsoleInvalidOptionNameException $e )
        {
            return;
        }
        $this->fail( 'Exception not thrown on invalid option name.' );
    }
    

    public function testAddDependency()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addDependency( $rule );
        $option_1->addDependency( $rule );

        $this->assertAttributeEquals(
            array( $rule ),
            "dependencies",
            $option_1
        );
    }

    public function testRemoveDependency()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addDependency( $rule );
        $option_1->removeDependency( $rule );

        $this->assertAttributeEquals(
            array(),
            "dependencies",
            $option_1
        );
    }

    // Bug #9052: Exception because of invalid property in ezcConsoleOption
    public function testRemoveAllDependencies()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule_1 = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $rule_2 = new ezcConsoleOptionRule(
            $option_2, array( "d" )
        );

        $option_1->addDependency( $rule_1 );
        $option_1->addDependency( $rule_2 );
        $option_1->removeAllDependencies( $option_2 );

        $this->assertAttributeEquals(
            array(),
            "dependencies",
            $option_1
        );
    }

    // Bug #9052: Exception because of invalid property in ezcConsoleOption
    public function testHasDependencySuccess()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addDependency( $rule );

        $this->assertTrue(
            $option_1->hasDependency( $option_2 )
        );
    }
    
    public function testHasDependencyFailure()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $this->assertFalse(
            $option_1->hasDependency( $option_2 )
        );
    }
    
    public function testResetDependencies()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addDependency( $rule );
        $option_1->resetDependencies();

        $this->assertAttributeEquals(
            array(),
            "dependencies",
            $option_1
        );
    }
    
    public function testAddExclusion()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addExclusion( $rule );
        $option_1->addExclusion( $rule );

        $this->assertAttributeEquals(
            array( $rule ),
            "exclusions",
            $option_1
        );
    }

    public function testRemoveExclusion()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addExclusion( $rule );
        $option_1->removeExclusion( $rule );

        $this->assertAttributeEquals(
            array(),
            "exclusions",
            $option_1
        );
    }

    // Bug #9052: Exception because of invalid property in ezcConsoleOption
    public function testRemoveAllExclusions()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule_1 = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $rule_2 = new ezcConsoleOptionRule(
            $option_2, array( "d" )
        );

        $option_1->addExclusion( $rule_1 );
        $option_1->addExclusion( $rule_2 );
        $option_1->removeAllExclusions( $option_2 );

        $this->assertAttributeEquals(
            array(),
            "exclusions",
            $option_1
        );
    }

    // Bug #9052: Exception because of invalid property in ezcConsoleOption
    public function testHasExclusionSuccess()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addExclusion( $rule );

        $this->assertTrue(
            $option_1->hasExclusion( $option_2 )
        );
    }
    
    public function testHasExclusionFailure()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $this->assertFalse(
            $option_1->hasExclusion( $option_2 )
        );
    }
    
    public function testResetExclusions()
    {
        $option_1 = new ezcConsoleOption(
            "a",
            "aaa"
        );
        $option_2 = new ezcConsoleOption(
            "b",
            "bbb"
        );

        $rule = new ezcConsoleOptionRule(
            $option_2, array( "c" )
        );

        $option_1->addExclusion( $rule );
        $option_1->resetExclusions();

        $this->assertAttributeEquals(
            array(),
            "exclusions",
            $option_1
        );
    }

    public function testPropertyGetAccessSuccess()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        $this->assertEquals( "a", $option->short );
        $this->assertEquals( "aaa", $option->long );
        $this->assertEquals( ezcConsoleInput::TYPE_NONE, $option->type );
        $this->assertNull( $option->default );
        $this->assertFalse( $option->multiple );
        $this->assertEquals( "No help available.", $option->shorthelp );
        $this->assertEquals( "Sorry, there is no help text available for this parameter.", $option->longhelp );
        $this->assertTrue( $option->arguments );
        $this->assertFalse( $option->mandatory );
        $this->assertFalse( $option->isHelpOption );
    }

    public function testPropertyGetAccessFailureDependencies()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $foo = $option->dependencies;
        }
        catch ( ezcBasePropertyNotFoundException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on access of ezcConsoleOption->dependencies." );
    }

    public function testPropertyGetAccessFailureExclusions()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $foo = $option->exclusions;
        }
        catch ( ezcBasePropertyNotFoundException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on access of ezcConsoleOption->exclusions." );
    }

    public function testPropertyGetAccessFailureNotExisting()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $foo = $option->nonExisting;
        }
        catch ( ezcBasePropertyNotFoundException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on access of ezcConsoleOption->nonExisting." );
    }

    public function testPropertySetAccessSuccess()
    {
        $option = new ezcConsoleOption( "a", "aaa" );
        $option->type = ezcConsoleInput::TYPE_STRING;
        $option->type = ezcConsoleInput::TYPE_NONE;
        $option->type = ezcConsoleInput::TYPE_INT;
        $option->default = 10;
        $option->multiple = true;
        $option->shorthelp = "Shorthelp";
        $option->longhelp = "Longhelp";
        $option->arguments = false;
        $option->mandatory = true;
        $option->isHelpOption = true;

        $this->assertEquals( ezcConsoleInput::TYPE_INT, $option->type );
        $this->assertEquals( 10, $option->default );
        $this->assertTrue( $option->multiple );
        $this->assertEquals( "Shorthelp", $option->shorthelp );
        $this->assertEquals( "Longhelp", $option->longhelp );
        $this->assertFalse( $option->arguments );
        $this->assertTrue( $option->mandatory );
        $this->assertTrue( $option->isHelpOption );
    }

    public function testPropertySetAccessSuccessMultipleArray()
    {
        $option = new ezcConsoleOption( "a", "aaa" );
        $option->multiple = true;
        $option->default = array( "foo", "bar" );

        $this->assertEquals( array( "foo", "bar" ), $option->default );
    }

    public function testPropertySetAccessSuccessMultipleScalar()
    {
        $option = new ezcConsoleOption( "a", "aaa" );
        $option->multiple = true;
        $option->default = 10;

        $this->assertEquals( 10, $option->default );
    }

    public function testPropertySetAccessFailureNoMultipleArray()
    {
        $option = new ezcConsoleOption( "a", "aaa" );
        $option->multiple = false;
        try
        {
            $option->default = array( "foo", "bar" );
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Assigning array when multiple is false worked." );
    }
    
    public function testPropertySetAccessFailureShort()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->short = "b";
        }
        catch ( ezcBasePropertyPermissionException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->short." );
    }

    public function testPropertySetAccessFailureLong()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->long = "bbb";
        }
        catch ( ezcBasePropertyPermissionException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->long." );
    }

    public function testPropertySetAccessFailureType()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->type = "Invalid type";
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->type." );
    }
    
    public function testPropertySetAccessFailureDefault()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->default = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->default." );
    }
    
    public function testPropertySetAccessFailureMultiple()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->multiple = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->multiple." );
    }
    
    public function testPropertySetAccessFailureShorthelp()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->shorthelp = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->shorthelp." );
    }

    public function testPropertySetAccessFailureLonghelp()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->longhelp = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->longhelp." );
    }

    public function testPropertySetAccessFailureArguments()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->arguments = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->arguments." );
    }

    public function testPropertySetAccessFailureMandatory()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->mandatory = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->mandatory." );
    }

    public function testPropertySetAccessFailureIsHelpOption()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->isHelpOption = array();
        }
        catch ( ezcBaseValueException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->isHelpOption." );
    }
    
    public function testPropertySetAccessFailureNonExistent()
    {
        $option = new ezcConsoleOption( "a", "aaa" );

        try
        {
            $option->nonExistent = array();
        }
        catch ( ezcBasePropertyNotFoundException $e )
        {
            return;
        }
        $this->fail( "Exception not thrown on invalid value for ezcConsoleOption->nonExsitent." );
    }

    public function testPropertyIssetAccessSuccess()
    {
        $option = new ezcConsoleOption( "a", "aaa" );
        
        $this->assertTrue( isset( $option->type ) );
        $this->assertFalse( isset( $option->default ) );
        $this->assertTrue( isset( $option->multiple ) );
        $this->assertTrue( isset( $option->shorthelp ) );
        $this->assertTrue( isset( $option->longhelp ) );
        $this->assertTrue( isset( $option->arguments ) );
        $this->assertTrue( isset( $option->mandatory ) );
        $this->assertTrue( isset( $option->isHelpOption ) );
        $this->assertFalse( isset(  $option->nonExistent ) );

    }
}

?>