CommandTester.php 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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. */
  21. class CommandTester
  22. {
  23. private $command;
  24. private $input;
  25. private $output;
  26. private $statusCode;
  27. /**
  28. * Constructor.
  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 (isset($options['interactive'])) {
  62. $this->input->setInteractive($options['interactive']);
  63. }
  64. $this->output = new StreamOutput(fopen('php://memory', 'w', false));
  65. if (isset($options['decorated'])) {
  66. $this->output->setDecorated($options['decorated']);
  67. }
  68. if (isset($options['verbosity'])) {
  69. $this->output->setVerbosity($options['verbosity']);
  70. }
  71. return $this->statusCode = $this->command->run($this->input, $this->output);
  72. }
  73. /**
  74. * Gets the display returned by the last execution of the command.
  75. *
  76. * @param bool $normalize Whether to normalize end of lines to \n or not
  77. *
  78. * @return string The display
  79. */
  80. public function getDisplay($normalize = false)
  81. {
  82. rewind($this->output->getStream());
  83. $display = stream_get_contents($this->output->getStream());
  84. if ($normalize) {
  85. $display = str_replace(PHP_EOL, "\n", $display);
  86. }
  87. return $display;
  88. }
  89. /**
  90. * Gets the input instance used by the last execution of the command.
  91. *
  92. * @return InputInterface The current input instance
  93. */
  94. public function getInput()
  95. {
  96. return $this->input;
  97. }
  98. /**
  99. * Gets the output instance used by the last execution of the command.
  100. *
  101. * @return OutputInterface The current output instance
  102. */
  103. public function getOutput()
  104. {
  105. return $this->output;
  106. }
  107. /**
  108. * Gets the status code returned by the last execution of the application.
  109. *
  110. * @return int The status code
  111. */
  112. public function getStatusCode()
  113. {
  114. return $this->statusCode;
  115. }
  116. }