Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ApplicationTester.php

class ApplicationTester

Eases the testing of console applications.

When testing an application, don't forget to disable the auto exit flag:

$application = new Application(); $application->setAutoExit(false);

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\Console\Tester\ApplicationTester uses \Symfony\Component\Console\Tester\TesterTrait

Expanded class hierarchy of ApplicationTester

File

vendor/symfony/console/Tester/ApplicationTester.php, line 27

Namespace

Symfony\Component\Console\Tester
View source
class ApplicationTester {
    use TesterTrait;
    public function __construct(Application $application) {
    }
    
    /**
     * Executes the application.
     *
     * Available options:
     *
     *  * interactive:               Sets the input interactive flag
     *  * decorated:                 Sets the output decorated flag
     *  * verbosity:                 Sets the output verbosity flag
     *  * capture_stderr_separately: Make output of stdOut and stdErr separately available
     *
     * @return int The command exit code
     */
    public function run(array $input, array $options = []) : int {
        $prevShellVerbosity = getenv('SHELL_VERBOSITY');
        try {
            $this->input = new ArrayInput($input);
            if (isset($options['interactive'])) {
                $this->input
                    ->setInteractive($options['interactive']);
            }
            if ($this->inputs) {
                $this->input
                    ->setStream(self::createStream($this->inputs));
            }
            $this->initOutput($options);
            return $this->statusCode = $this->application
                ->run($this->input, $this->output);
        } finally {
            // SHELL_VERBOSITY is set by Application::configureIO so we need to unset/reset it
            // to its previous value to avoid one test's verbosity to spread to the following tests
            if (false === $prevShellVerbosity) {
                if (\function_exists('putenv')) {
                    @putenv('SHELL_VERBOSITY');
                }
                unset($_ENV['SHELL_VERBOSITY']);
                unset($_SERVER['SHELL_VERBOSITY']);
            }
            else {
                if (\function_exists('putenv')) {
                    @putenv('SHELL_VERBOSITY=' . $prevShellVerbosity);
                }
                $_ENV['SHELL_VERBOSITY'] = $prevShellVerbosity;
                $_SERVER['SHELL_VERBOSITY'] = $prevShellVerbosity;
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
ApplicationTester::run public function Executes the application.
ApplicationTester::__construct public function
TesterTrait::$captureStreamsIndependently private property
TesterTrait::$input private property
TesterTrait::$inputs private property
TesterTrait::$output private property
TesterTrait::$statusCode private property
TesterTrait::assertCommandIsSuccessful public function
TesterTrait::createStream private static function
TesterTrait::getDisplay public function Gets the display returned by the last execution of the command or application.
TesterTrait::getErrorOutput public function Gets the output written to STDERR by the application.
TesterTrait::getInput public function Gets the input instance used by the last execution of the command or application.
TesterTrait::getOutput public function Gets the output instance used by the last execution of the command or application.
TesterTrait::getStatusCode public function Gets the status code returned by the last execution of the command or application.
TesterTrait::initOutput private function Initializes the output property.
TesterTrait::setInputs public function Sets the user inputs.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal