[Console] Improve code coverage

geoffrey-brier · geoffrey-brier · commit 0f2b435197e9 · 2016-07-26T10:52:41.000+02:00
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -594,9 +594,13 @@ public function all($namespace = null)
      * @param array $names An array of names
      *
      * @return array An array of abbreviations
+     *
+     * @deprecated since version 3.2, to be removed in 4.0.
      */
     public static function getAbbreviations($names)
     {
+        @trigger_error(sprintf('%s is deprecated as of 3.2 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
+
         $abbrevs = array();
         foreach ($names as $name) {
             for ($len = strlen($name); $len > 0; --$len) {
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -572,6 +572,8 @@ public function getSynopsis($short = false)
      * Add a command usage example.
      *
      * @param string $usage The usage, it'll be prefixed with the command name
+     *
+     * @return Command
      */
     public function addUsage($usage)
     {
diff --git a/src/Symfony/Component/Console/Helper/TableStyle.php b/src/Symfony/Component/Console/Helper/TableStyle.php
@@ -42,7 +42,7 @@ class TableStyle
     public function setPaddingChar($paddingChar)
     {
         if (!$paddingChar) {
-            throw new LogicException('The padding char must not be empty');
+            throw new LogicException('The padding char must not be empty.');
         }
 
         $this->paddingChar = $paddingChar;
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Tests\Command;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Helper\FormatterHelper;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\InputDefinition;
@@ -156,6 +157,28 @@ public function testGetSetAliases()
         $this->assertEquals(array('name1'), $command->getAliases(), '->setAliases() sets the aliases');
     }
 
+    /**
+     * @expectedException InvalidArgumentException
+     * @expectedExceptionMessage $aliases must be an array or an instance of \Traversable
+     */
+    public function testSetAliasesThrowsInvalidArgumentException()
+    {
+        $command = new \TestCommand();
+
+        $command->setAliases('foo');
+    }
+
+    public function testAddUsage()
+    {
+        $command = new \TestCommand();
+
+        $command
+            ->addUsage('foo')
+            ->addUsage('bar');
+
+        $this->assertSame(array('namespace:name foo', 'namespace:name bar'), $command->getUsages());
+    }
+
     public function testGetSynopsis()
     {
         $command = new \TestCommand();
diff --git a/src/Symfony/Component/Console/Tests/Descriptor/AbstractDescriptorTest.php b/src/Symfony/Component/Console/Tests/Descriptor/AbstractDescriptorTest.php
@@ -38,6 +38,15 @@ public function testDescribeInputDefinition(InputDefinition $definition, $expect
         $this->assertDescription($expectedDescription, $definition);
     }
 
+    /**
+     * @expectedException Symfony\Component\Console\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Object of type "stdClass" is not describable.
+     */
+    public function testDescribeCommandInvalidObjects()
+    {
+        $this->assertDescription(null, new \stdClass());
+    }
+
     /** @dataProvider getDescribeCommandTestData */
     public function testDescribeCommand(Command $command, $expectedDescription)
     {
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_17.php b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_17.php
@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+// ensure that all lines are aligned to the begin of the first one and start with '//' in a very long line comment
+return function (InputInterface $input, OutputInterface $output) {
+    $output = new SymfonyStyle($input, $output);
+    $output->section('Lorem ipsum dolor sit amet');
+};
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_18.php b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_18.php
@@ -0,0 +1,21 @@
+<?php
+
+use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+// ensure that all lines are aligned to the begin of the first one and start with '//' in a very long line comment
+return function (InputInterface $input, OutputInterface $output) {
+    $output = new SymfonyStyle($input, $output);
+
+    try {
+        $output->progressFinish();
+    } catch (RuntimeException $e) {
+        $output->writeln('OK');
+
+        return;
+    }
+
+    $output->writeln('KO');
+};
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_17.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_17.txt
@@ -0,0 +1,4 @@
+
+Lorem ipsum dolor sit amet
+--------------------------
+
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_18.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_18.txt
@@ -0,0 +1 @@
+OK
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/progress-bar/output_linux.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/progress-bar/output_linux.txt
@@ -0,0 +1,4 @@
+  0/10 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░]   0%
+  4/10 [▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░]  40%
+ 10/10 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
+
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/progress-bar/output_windows.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/progress-bar/output_windows.txt
@@ -0,0 +1,4 @@
+  0/10 [>---------------------------]   0%
+  4/10 [===========>----------------]  40%
+ 10/10 [============================] 100%
+
diff --git a/src/Symfony/Component/Console/Tests/Helper/DescriptorHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/DescriptorHelperTest.php
@@ -0,0 +1,35 @@
+<?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\Helper;
+
+use Symfony\Component\Console\Helper\DescriptorHelper;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DescriptorHelperTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException        \InvalidArgumentException
+     * @expectedExceptionMessage Unsupported format "invalid".
+     */
+    public function testDescribeWithInvalidFormat()
+    {
+        $descriptor = new DescriptorHelper();
+        $descriptor->describe($this->getMock(OutputInterface::class), null, array('format' => 'invalid'));
+    }
+
+    public function testGetName()
+    {
+        $descriptor = new DescriptorHelper();
+
+        $this->assertSame('descriptor', $descriptor->getName());
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/Helper/FormatterHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/FormatterHelperTest.php
@@ -109,6 +109,14 @@ public function testTruncatingMessageWithCustomSuffix()
         $this->assertSame('test!', $formatter->truncate($message, 4, '!'));
     }
 
+    public function testTruncatingMessageWithInvalidEncoding()
+    {
+        $formatter = new FormatterHelper();
+        $message = str_repeat(chr(-1), 4);
+
+        $this->assertSame(str_repeat(chr(-1), 2).'!', $formatter->truncate($message, 2, '!'));
+    }
+
     public function testTruncatingWithLongerLengthThanMessageWithSuffix()
     {
         $formatter = new FormatterHelper();
diff --git a/src/Symfony/Component/Console/Tests/Helper/HelperTest.php b/src/Symfony/Component/Console/Tests/Helper/HelperTest.php
@@ -15,6 +15,21 @@
 
 class HelperTest extends \PHPUnit_Framework_TestCase
 {
+    public function formatMemoryProvider()
+    {
+        return array(
+            array(0,          '0 B'),
+            array(1,          '1 B'),
+            array(1000,       '1000 B'),
+            array(1024,       '1 KiB'),
+            array(1025,       '1 KiB'),
+            array(1048576,    '1.0 MiB'),
+            array(1048577,    '1.0 MiB'),
+            array(1073741824, '1.0 GiB'),
+            array(1073741825, '1.0 GiB'),
+        );
+    }
+
     public function formatTimeProvider()
     {
         return array(
@@ -51,4 +66,15 @@ public function testFormatTime($secs, $expectedFormat)
     {
         $this->assertEquals($expectedFormat, Helper::formatTime($secs));
     }
+
+    /**
+     * @dataProvider formatMemoryProvider
+     *
+     * @param int    $bytes
+     * @param string $expectedFormat
+     */
+    public function testFormatMemory($bytes, $expectedFormat)
+    {
+        $this->assertEquals($expectedFormat, Helper::formatMemory($bytes));
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProcessHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/ProcessHelperTest.php
@@ -31,6 +31,28 @@ public function testVariousProcessRuns($expected, $cmd, $verbosity, $error)
         $this->assertEquals($expected, $this->getOutput($output));
     }
 
+    public function testMustRun()
+    {
+        $helper = new ProcessHelper();
+        $helper->setHelperSet(new HelperSet(array(new DebugFormatterHelper())));
+        $output = $this->getOutputStream(StreamOutput::VERBOSITY_VERBOSE);
+        $helper->mustRun($output, 'php -r "echo 42;"', null);
+
+        $this->assertSame('', $this->getOutput($output));
+    }
+
+    /**
+     * @expectedException Symfony\Component\Process\Exception\ProcessFailedException
+     * @expectedExceptionMessage The command "php -r "echo 42"" failed.
+     */
+    public function testMustRunThrowsProcessFailedException()
+    {
+        $helper = new ProcessHelper();
+        $helper->setHelperSet(new HelperSet(array(new DebugFormatterHelper())));
+        $output = $this->getOutputStream(StreamOutput::VERBOSITY_VERBOSE);
+        $helper->mustRun($output, 'php -r "echo 42"', null);
+    }
+
     public function testPassedCallbackIsExecuted()
     {
         $helper = new ProcessHelper();
diff --git a/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Console\Tests\Helper;
 
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Helper\HelperSet;
@@ -34,7 +35,7 @@ public function testAskChoice()
 
         $heroes = array('Superman', 'Batman', 'Spiderman');
 
-        $inputStream = $this->getInputStream("\n1\n  1  \nFabien\n1\nFabien\n1\n0,2\n 0 , 2  \n\n\n");
+        $inputStream = $this->getInputStream("\n1\n  1  \nFabien\n1\nFabien\né\n1\n0,2\n 0 , 2  \n\n\n\n");
 
         $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '2');
         $question->setMaxAttempts(1);
@@ -64,6 +65,16 @@ public function testAskChoice()
             $this->assertEquals('Value "Fabien" is invalid', $e->getMessage());
         }
 
+        try {
+            $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '1');
+            $question->setMaxAttempts(1);
+            $question->setMultiselect(true);
+            $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question);
+            $this->fail();
+        } catch (InvalidArgumentException $e) {
+            $this->assertEquals('Value "é" is invalid', $e->getMessage());
+        }
+
         $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, null);
         $question->setMaxAttempts(1);
         $question->setMultiselect(true);
@@ -81,8 +92,10 @@ public function testAskChoice()
         $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, ' 0 , 1 ');
         $question->setMaxAttempts(1);
         $question->setMultiselect(true);
+        $question->setPrompt('Choose wisely');
 
-        $this->assertEquals(array('Superman', 'Batman'), $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
+        $this->assertEquals(array('Superman', 'Batman'), $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question));
+        $this->assertOutputContains('Choose wisely', $output);
     }
 
     public function testAsk()
@@ -774,4 +787,11 @@ private function hasSttyAvailable()
 
         return $exitcode === 0;
     }
+
+    private function assertOutputContains($expected, StreamOutput $output)
+    {
+        rewind($output->getStream());
+        $stream = stream_get_contents($output->getStream());
+        $this->assertContains($expected, $stream);
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Helper/SymfonyQuestionHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/SymfonyQuestionHelperTest.php
@@ -7,6 +7,7 @@
 use Symfony\Component\Console\Helper\SymfonyQuestionHelper;
 use Symfony\Component\Console\Output\StreamOutput;
 use Symfony\Component\Console\Question\ChoiceQuestion;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
 
 /**
  * @group tty
@@ -22,7 +23,7 @@ public function testAskChoice()
 
         $heroes = array('Superman', 'Batman', 'Spiderman');
 
-        $inputStream = $this->getInputStream("\n1\n  1  \nFabien\n1\nFabien\n1\n0,2\n 0 , 2  \n\n\n");
+        $inputStream = $this->getInputStream("\n1\n  1  \nFabien\n1\nFabien\n1\n0,2\n 0 , 2  \n\n\ny\n");
 
         $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '2');
         $question->setMaxAttempts(1);
@@ -71,6 +72,34 @@ public function testAskChoice()
 
         $this->assertEquals(array('Superman', 'Batman'), $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question));
         $this->assertOutputContains('What is your favorite superhero? [Superman, Batman]', $output);
+
+        $question = new ConfirmationQuestion('Do you like superheroes ?');
+        $this->assertTrue($questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question));
+        $this->assertOutputContains('Do you like superheroes ? (yes/no)', $output);
+    }
+
+    /**
+     * @expectedException Symfony\Component\Console\Exception\LogicException
+     * @expectedExceptionMessage A value is required.
+     */
+    public function testAskWithInvalidValidatorThrowsLogicException()
+    {
+        $questionHelper = new SymfonyQuestionHelper();
+
+        $helperSet = new HelperSet(array(new FormatterHelper()));
+        $questionHelper->setHelperSet($helperSet);
+
+        $heroes = array('Superman', 'Batman', 'Spiderman');
+
+        $inputStream = $this->getInputStream("\n1\n");
+
+        $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '2');
+        $question->setMaxAttempts(1);
+        $question->setValidator(function () {
+            return '';
+        });
+
+        $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question);
     }
 
     protected function getInputStream($input)
diff --git a/src/Symfony/Component/Console/Tests/Helper/TableCellTest.php b/src/Symfony/Component/Console/Tests/Helper/TableCellTest.php
@@ -0,0 +1,26 @@
+<?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\Helper;
+
+use Symfony\Component\Console\Helper\TableCell;
+
+class TableCellTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException        \InvalidArgumentException
+     * @expectedExceptionMessage The TableCell does not support the following options: 'invalid'.
+     */
+    public function testConstructorWithInvalidOptions()
+    {
+        new TableCell('', array('invalid' => 'invalid'));
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/Helper/TableStyleTest.php b/src/Symfony/Component/Console/Tests/Helper/TableStyleTest.php
diff --git a/src/Symfony/Component/Console/Tests/Helper/TableTest.php b/src/Symfony/Component/Console/Tests/Helper/TableTest.php
diff --git a/src/Symfony/Component/Console/Tests/Output/NullOutputTest.php b/src/Symfony/Component/Console/Tests/Output/NullOutputTest.php
diff --git a/src/Symfony/Component/Console/Tests/Output/StreamOutputTest.php b/src/Symfony/Component/Console/Tests/Output/StreamOutputTest.php
diff --git a/src/Symfony/Component/Console/Tests/Question/QuestionTest.php b/src/Symfony/Component/Console/Tests/Question/QuestionTest.php
diff --git a/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php b/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php

Original file line number	Diff line number	Diff line change
`@@ -594,9 +594,13 @@ public function all($namespace = null)`
`594`	`594`	`* @param array $names An array of names`
`595`	`595`	`*`
`596`	`596`	`* @return array An array of abbreviations`
	`597`	`+ *`
	`598`	`+ * @deprecated since version 3.2, to be removed in 4.0.`
`597`	`599`	`*/`
`598`	`600`	`public static function getAbbreviations($names)`
`599`	`601`	`{`
	`602`	`+ @trigger_error(sprintf('%s is deprecated as of 3.2 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);`
	`603`	`+`
`600`	`604`	`$abbrevs = array();`
`601`	`605`	`foreach ($names as $name) {`
`602`	`606`	`for ($len = strlen($name); $len > 0; --$len) {`
Original file line number	Diff line number	Diff line change
`@@ -572,6 +572,8 @@ public function getSynopsis($short = false)`
`572`	`572`	`* Add a command usage example.`
`573`	`573`	`*`
`574`	`574`	`* @param string $usage The usage, it'll be prefixed with the command name`
	`575`	`+ *`
	`576`	`+ * @return Command`
`575`	`577`	`*/`
`576`	`578`	`public function addUsage($usage)`
`577`	`579`	`{`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ class TableStyle`
`42`	`42`	`public function setPaddingChar($paddingChar)`
`43`	`43`	`{`
`44`	`44`	`if (!$paddingChar) {`
`45`		`- throw new LogicException('The padding char must not be empty');`
	`45`	`+ throw new LogicException('The padding char must not be empty.');`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`$this->paddingChar = $paddingChar;`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +Lorem ipsum dolor sit amet
 +--------------------------
++