[Console] Add SymfonyStyle::setInputStream for command testing

chalasr · chalasr · commit 3d2ed6522e4f · 2016-05-27T18:20:13.000+02:00
Use Console InvalidArgumentException, test the exception

Use better phpdoc block

Fabbot fixes
diff --git a/src/Symfony/Component/Console/Style/SymfonyStyle.php b/src/Symfony/Component/Console/Style/SymfonyStyle.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Helper\Helper;
 use Symfony\Component\Console\Helper\ProgressBar;
@@ -40,6 +41,7 @@ class SymfonyStyle extends OutputStyle
     private $progressBar;
     private $lineLength;
     private $bufferedOutput;
+    private $inputStream;
 
     /**
      * @param InputInterface  $input
@@ -348,6 +350,10 @@ public function askQuestion(Question $question)
 
         if (!$this->questionHelper) {
             $this->questionHelper = new SymfonyQuestionHelper();
+
+            if ($this->inputStream) {
+                $this->questionHelper->setInputStream($this->inputStream);
+            }
         }
 
         $answer = $this->questionHelper->ask($this->input, $this, $question);
@@ -387,6 +393,24 @@ public function newLine($count = 1)
         $this->bufferedOutput->write(str_repeat("\n", $count));
     }
 
+    /**
+     * Sets the input stream to read from when interacting with the user.
+     *
+     * This is mainly useful for testing purpose.
+     *
+     * @param resource $stream The input stream
+     *
+     * @throws InvalidArgumentException In case the stream is not a resource
+     */
+    public function setInputStream($stream)
+    {
+        if (!is_resource($stream)) {
+            throw new InvalidArgumentException(sprintf('Input stream must be a valid resource, %s given', gettype($stream)));
+        }
+
+        $this->inputStream = $stream;
+    }
+
     /**
      * @return ProgressBar
      */
diff --git a/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php b/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php
@@ -70,6 +70,39 @@ public function testLongWordsBlockWrapping()
         $expectedCount = (int) ceil($wordLength / ($maxLineLength)) + (int) ($wordLength > $maxLineLength - 5);
         $this->assertSame($expectedCount, substr_count($this->tester->getDisplay(true), ' § '));
     }
+
+    public function testSetInputStream()
+    {
+        $command = $this->command;
+
+        $stream = fopen('php://memory', 'r+', false);
+        fputs($stream, 'FooBar');
+        rewind($stream);
+
+        $command->setCode(function ($input, $output) use ($command, $stream) {
+            $sfStyle = new SymfonyStyle($input, $output);
+
+            $sfStyle->setInputStream($stream);
+            $sfStyle->ask('What\'s your name?');
+        });
+
+        $this->tester->execute(array());
+        $this->assertSame(0, $this->tester->getStatusCode());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Console\Exception\InvalidArgumentException
+     * @expectedMessage   Input stream must be a valid resource, string given
+     */
+    public function testSetInputStreamWithWrongResource()
+    {
+        $this->command->setCode(function ($input, $output) {
+            $sfStyle = new SymfonyStyle($input, $output);
+            $sfStyle->setInputStream('invalid type');
+        });
+
+        $this->tester->execute(array());
+    }
 }
 
 /**
