You are here

InputOptionTest.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 vendor/symfony/console/Tests/Input/InputOptionTest.php

File

vendor/symfony/console/Tests/Input/InputOptionTest.php
View source
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Console\Tests\Input;

use Symfony\Component\Console\Input\InputOption;
class InputOptionTest extends \PHPUnit_Framework_TestCase {
  public function testConstructor() {
    $option = new InputOption('foo');
    $this
      ->assertEquals('foo', $option
      ->getName(), '__construct() takes a name as its first argument');
    $option = new InputOption('--foo');
    $this
      ->assertEquals('foo', $option
      ->getName(), '__construct() removes the leading -- of the option name');
  }

  /**
   * @expectedException        \InvalidArgumentException
   * @expectedExceptionMessage Impossible to have an option mode VALUE_IS_ARRAY if the option does not accept a value.
   */
  public function testArrayModeWithoutValue() {
    new InputOption('foo', 'f', InputOption::VALUE_IS_ARRAY);
  }
  public function testShortcut() {
    $option = new InputOption('foo', 'f');
    $this
      ->assertEquals('f', $option
      ->getShortcut(), '__construct() can take a shortcut as its second argument');
    $option = new InputOption('foo', '-f|-ff|fff');
    $this
      ->assertEquals('f|ff|fff', $option
      ->getShortcut(), '__construct() removes the leading - of the shortcuts');
    $option = new InputOption('foo', array(
      'f',
      'ff',
      '-fff',
    ));
    $this
      ->assertEquals('f|ff|fff', $option
      ->getShortcut(), '__construct() removes the leading - of the shortcuts');
    $option = new InputOption('foo');
    $this
      ->assertNull($option
      ->getShortcut(), '__construct() makes the shortcut null by default');
  }
  public function testModes() {
    $option = new InputOption('foo', 'f');
    $this
      ->assertFalse($option
      ->acceptValue(), '__construct() gives a "InputOption::VALUE_NONE" mode by default');
    $this
      ->assertFalse($option
      ->isValueRequired(), '__construct() gives a "InputOption::VALUE_NONE" mode by default');
    $this
      ->assertFalse($option
      ->isValueOptional(), '__construct() gives a "InputOption::VALUE_NONE" mode by default');
    $option = new InputOption('foo', 'f', null);
    $this
      ->assertFalse($option
      ->acceptValue(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $this
      ->assertFalse($option
      ->isValueRequired(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $this
      ->assertFalse($option
      ->isValueOptional(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $option = new InputOption('foo', 'f', InputOption::VALUE_NONE);
    $this
      ->assertFalse($option
      ->acceptValue(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $this
      ->assertFalse($option
      ->isValueRequired(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $this
      ->assertFalse($option
      ->isValueOptional(), '__construct() can take "InputOption::VALUE_NONE" as its mode');
    $option = new InputOption('foo', 'f', InputOption::VALUE_REQUIRED);
    $this
      ->assertTrue($option
      ->acceptValue(), '__construct() can take "InputOption::VALUE_REQUIRED" as its mode');
    $this
      ->assertTrue($option
      ->isValueRequired(), '__construct() can take "InputOption::VALUE_REQUIRED" as its mode');
    $this
      ->assertFalse($option
      ->isValueOptional(), '__construct() can take "InputOption::VALUE_REQUIRED" as its mode');
    $option = new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL);
    $this
      ->assertTrue($option
      ->acceptValue(), '__construct() can take "InputOption::VALUE_OPTIONAL" as its mode');
    $this
      ->assertFalse($option
      ->isValueRequired(), '__construct() can take "InputOption::VALUE_OPTIONAL" as its mode');
    $this
      ->assertTrue($option
      ->isValueOptional(), '__construct() can take "InputOption::VALUE_OPTIONAL" as its mode');
  }

  /**
   * @dataProvider provideInvalidModes
   */
  public function testInvalidModes($mode) {
    $this
      ->setExpectedException('InvalidArgumentException', sprintf('Option mode "%s" is not valid.', $mode));
    new InputOption('foo', 'f', $mode);
  }
  public function provideInvalidModes() {
    return array(
      array(
        'ANOTHER_ONE',
      ),
      array(
        -1,
      ),
    );
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testEmptyNameIsInvalid() {
    new InputOption('');
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testDoubleDashNameIsInvalid() {
    new InputOption('--');
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testSingleDashOptionIsInvalid() {
    new InputOption('foo', '-');
  }
  public function testIsArray() {
    $option = new InputOption('foo', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY);
    $this
      ->assertTrue($option
      ->isArray(), '->isArray() returns true if the option can be an array');
    $option = new InputOption('foo', null, InputOption::VALUE_NONE);
    $this
      ->assertFalse($option
      ->isArray(), '->isArray() returns false if the option can not be an array');
  }
  public function testGetDescription() {
    $option = new InputOption('foo', 'f', null, 'Some description');
    $this
      ->assertEquals('Some description', $option
      ->getDescription(), '->getDescription() returns the description message');
  }
  public function testGetDefault() {
    $option = new InputOption('foo', null, InputOption::VALUE_OPTIONAL, '', 'default');
    $this
      ->assertEquals('default', $option
      ->getDefault(), '->getDefault() returns the default value');
    $option = new InputOption('foo', null, InputOption::VALUE_REQUIRED, '', 'default');
    $this
      ->assertEquals('default', $option
      ->getDefault(), '->getDefault() returns the default value');
    $option = new InputOption('foo', null, InputOption::VALUE_REQUIRED);
    $this
      ->assertNull($option
      ->getDefault(), '->getDefault() returns null if no default value is configured');
    $option = new InputOption('foo', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY);
    $this
      ->assertEquals(array(), $option
      ->getDefault(), '->getDefault() returns an empty array if option is an array');
    $option = new InputOption('foo', null, InputOption::VALUE_NONE);
    $this
      ->assertFalse($option
      ->getDefault(), '->getDefault() returns false if the option does not take a value');
  }
  public function testSetDefault() {
    $option = new InputOption('foo', null, InputOption::VALUE_REQUIRED, '', 'default');
    $option
      ->setDefault(null);
    $this
      ->assertNull($option
      ->getDefault(), '->setDefault() can reset the default value by passing null');
    $option
      ->setDefault('another');
    $this
      ->assertEquals('another', $option
      ->getDefault(), '->setDefault() changes the default value');
    $option = new InputOption('foo', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY);
    $option
      ->setDefault(array(
      1,
      2,
    ));
    $this
      ->assertEquals(array(
      1,
      2,
    ), $option
      ->getDefault(), '->setDefault() changes the default value');
  }

  /**
   * @expectedException        \LogicException
   * @expectedExceptionMessage Cannot set a default value when using InputOption::VALUE_NONE mode.
   */
  public function testDefaultValueWithValueNoneMode() {
    $option = new InputOption('foo', 'f', InputOption::VALUE_NONE);
    $option
      ->setDefault('default');
  }

  /**
   * @expectedException        \LogicException
   * @expectedExceptionMessage A default value for an array option must be an array.
   */
  public function testDefaultValueWithIsArrayMode() {
    $option = new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY);
    $option
      ->setDefault('default');
  }
  public function testEquals() {
    $option = new InputOption('foo', 'f', null, 'Some description');
    $option2 = new InputOption('foo', 'f', null, 'Alternative description');
    $this
      ->assertTrue($option
      ->equals($option2));
    $option = new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL, 'Some description');
    $option2 = new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL, 'Some description', true);
    $this
      ->assertFalse($option
      ->equals($option2));
    $option = new InputOption('foo', 'f', null, 'Some description');
    $option2 = new InputOption('bar', 'f', null, 'Some description');
    $this
      ->assertFalse($option
      ->equals($option2));
    $option = new InputOption('foo', 'f', null, 'Some description');
    $option2 = new InputOption('foo', '', null, 'Some description');
    $this
      ->assertFalse($option
      ->equals($option2));
    $option = new InputOption('foo', 'f', null, 'Some description');
    $option2 = new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL, 'Some description');
    $this
      ->assertFalse($option
      ->equals($option2));
  }

}

Classes

Namesort descending Description
InputOptionTest