CommandTester.php 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Tester;
  11. use Symfony\Component\Console\Command\Command;
  12. use Symfony\Component\Console\Input\ArrayInput;
  13. use Symfony\Component\Console\Output\StreamOutput;
  14. use Symfony\Component\Console\Input\InputInterface;
  15. use Symfony\Component\Console\Output\OutputInterface;
  16. /**
  17. * Eases the testing of console commands.
  18. *
  19. * @author Fabien Potencier <fabien@symfony.com>
  20. * @author Robin Chalas <robin.chalas@gmail.com>
  21. */
  22. class CommandTester
  23. {
  24. private $command;
  25. private $input;
  26. private $output;
  27. private $inputs = array();
  28. private $statusCode;
  29. /**
  30. * @param Command $command A Command instance to test
  31. */
  32. public function __construct(Command $command)
  33. {
  34. $this->command = $command;
  35. }
  36. /**
  37. * Executes the command.
  38. *
  39. * Available execution options:
  40. *
  41. * * interactive: Sets the input interactive flag
  42. * * decorated: Sets the output decorated flag
  43. * * verbosity: Sets the output verbosity flag
  44. *
  45. * @param array $input An array of command arguments and options
  46. * @param array $options An array of execution options
  47. *
  48. * @return int The command exit code
  49. */
  50. public function execute(array $input, array $options = array())
  51. {
  52. // set the command name automatically if the application requires
  53. // this argument and no command name was passed
  54. if (!isset($input['command'])
  55. && (null !== $application = $this->command->getApplication())
  56. && $application->getDefinition()->hasArgument('command')
  57. ) {
  58. $input = array_merge(array('command' => $this->command->getName()), $input);
  59. }
  60. $this->input = new ArrayInput($input);
  61. if ($this->inputs) {
  62. $this->input->setStream(self::createStream($this->inputs));
  63. }
  64. if (isset($options['interactive'])) {
  65. $this->input->setInteractive($options['interactive']);
  66. }
  67. $this->output = new StreamOutput(fopen('php://memory', 'w', false));
  68. $this->output->setDecorated(isset($options['decorated']) ? $options['decorated'] : false);
  69. if (isset($options['verbosity'])) {
  70. $this->output->setVerbosity($options['verbosity']);
  71. }
  72. return $this->statusCode = $this->command->run($this->input, $this->output);
  73. }
  74. /**
  75. * Gets the display returned by the last execution of the command.
  76. *
  77. * @param bool $normalize Whether to normalize end of lines to \n or not
  78. *
  79. * @return string The display
  80. */
  81. public function getDisplay($normalize = false)
  82. {
  83. rewind($this->output->getStream());
  84. $display = stream_get_contents($this->output->getStream());
  85. if ($normalize) {
  86. $display = str_replace(PHP_EOL, "\n", $display);
  87. }
  88. return $display;
  89. }
  90. /**
  91. * Gets the input instance used by the last execution of the command.
  92. *
  93. * @return InputInterface The current input instance
  94. */
  95. public function getInput()
  96. {
  97. return $this->input;
  98. }
  99. /**
  100. * Gets the output instance used by the last execution of the command.
  101. *
  102. * @return OutputInterface The current output instance
  103. */
  104. public function getOutput()
  105. {
  106. return $this->output;
  107. }
  108. /**
  109. * Gets the status code returned by the last execution of the application.
  110. *
  111. * @return int The status code
  112. */
  113. public function getStatusCode()
  114. {
  115. return $this->statusCode;
  116. }
  117. /**
  118. * Sets the user inputs.
  119. *
  120. * @param array an array of strings representing each input
  121. * passed to the command input stream
  122. *
  123. * @return CommandTester
  124. */
  125. public function setInputs(array $inputs)
  126. {
  127. $this->inputs = $inputs;
  128. return $this;
  129. }
  130. private static function createStream(array $inputs)
  131. {
  132. $stream = fopen('php://memory', 'r+', false);
  133. fwrite($stream, implode(PHP_EOL, $inputs));
  134. rewind($stream);
  135. return $stream;
  136. }
  137. }