ApplicationTester.php 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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\Application;
  12. use Symfony\Component\Console\Input\ArrayInput;
  13. use Symfony\Component\Console\Input\InputInterface;
  14. use Symfony\Component\Console\Output\OutputInterface;
  15. use Symfony\Component\Console\Output\StreamOutput;
  16. /**
  17. * Eases the testing of console applications.
  18. *
  19. * When testing an application, don't forget to disable the auto exit flag:
  20. *
  21. * $application = new Application();
  22. * $application->setAutoExit(false);
  23. *
  24. * @author Fabien Potencier <fabien@symfony.com>
  25. */
  26. class ApplicationTester
  27. {
  28. private $application;
  29. private $input;
  30. private $output;
  31. private $statusCode;
  32. public function __construct(Application $application)
  33. {
  34. $this->application = $application;
  35. }
  36. /**
  37. * Executes the application.
  38. *
  39. * Available 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 arguments and options
  46. * @param array $options An array of options
  47. *
  48. * @return int The command exit code
  49. */
  50. public function run(array $input, $options = array())
  51. {
  52. $this->input = new ArrayInput($input);
  53. if (isset($options['interactive'])) {
  54. $this->input->setInteractive($options['interactive']);
  55. }
  56. $this->output = new StreamOutput(fopen('php://memory', 'w', false));
  57. if (isset($options['decorated'])) {
  58. $this->output->setDecorated($options['decorated']);
  59. }
  60. if (isset($options['verbosity'])) {
  61. $this->output->setVerbosity($options['verbosity']);
  62. }
  63. return $this->statusCode = $this->application->run($this->input, $this->output);
  64. }
  65. /**
  66. * Gets the display returned by the last execution of the application.
  67. *
  68. * @param bool $normalize Whether to normalize end of lines to \n or not
  69. *
  70. * @return string The display
  71. */
  72. public function getDisplay($normalize = false)
  73. {
  74. rewind($this->output->getStream());
  75. $display = stream_get_contents($this->output->getStream());
  76. if ($normalize) {
  77. $display = str_replace(PHP_EOL, "\n", $display);
  78. }
  79. return $display;
  80. }
  81. /**
  82. * Gets the input instance used by the last execution of the application.
  83. *
  84. * @return InputInterface The current input instance
  85. */
  86. public function getInput()
  87. {
  88. return $this->input;
  89. }
  90. /**
  91. * Gets the output instance used by the last execution of the application.
  92. *
  93. * @return OutputInterface The current output instance
  94. */
  95. public function getOutput()
  96. {
  97. return $this->output;
  98. }
  99. /**
  100. * Gets the status code returned by the last execution of the application.
  101. *
  102. * @return int The status code
  103. */
  104. public function getStatusCode()
  105. {
  106. return $this->statusCode;
  107. }
  108. }