Как выводить в CLI во время выполнения модульных тестов PHP?

ОБНОВЛЕНИЕ

Только что реализовал другой способ сделать это, который работает намного лучше, чем параметр командной строки --verbose:

class TestSomething extends PHPUnit_Framework_TestCase {
    function testSomething() {
        $myDebugVar = array(1, 2, 3);
        fwrite(STDERR, print_r($myDebugVar, TRUE));
    }
}

Это позволяет выгрузить что-либо на консоль в любое время без нежелательного вывода, связанного с опцией --verbose CLI.

Как отмечали другие ответы, лучше всего тестировать вывод с помощью встроенных методов, таких как:

$this->expectOutputString('foo');

Однако иногда полезно проявить непослушание и увидеть одноразовые / временные результаты отладки в ваших тестовых примерах. Впрочем, var_dump хак / обходной путь не требуется. Это легко сделать, установив параметр командной строки --verbose при запуске вашего набора тестов. Например:

$ phpunit --verbose -c phpunit.xml

Это отобразит выходные данные из ваших методов тестирования при работе в среде CLI.

См .: Написание тестов для PHPUnit - Тестирование вывода .

Обновление. См. обновление rdlowrey ниже относительно использования fwrite(STDERR, print_r($myDebugVar, TRUE)); как более простого решения

Такое поведение является преднамеренным (поскольку jasonbar имеет указал). Конфликтующее состояние руководства было в PHPUnit.

Обходной путь заключается в том, чтобы PHPUnit утверждал, что ожидаемый вывод пуст (когда фактически вывод есть), что вызовет отображение неожиданного вывода.

class theTest extends PHPUnit_Framework_TestCase
{
    /**
     * @outputBuffering disabled
     */
    public function testOutput() {
        $this->expectOutputString(''); // tell PHPUnit to expect '' as output
        print_r("Hello World");
        print "Ping";
        echo "Pong";
        $out = "Foo";
        var_dump($out);
    }   
}

дает:

PHPUnit @package_version@ by Sebastian Bergmann.

F

Time: 1 second, Memory: 3.50Mb

There was 1 failure:

1) theTest::testOutput
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-''
+'Hello WorldPingPongstring(4) "Foo"
+'

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

Обязательно отключите любые другие утверждения, которые у вас есть для теста, так как они могут завершиться ошибкой до того, как будет проверено выходное утверждение (и, следовательно, вы не увидите результат).

Попробуйте использовать --debug

Полезно, если вы пытаетесь найти правильный путь к включаемому или исходному файлу данных.

Это не ошибка, но это сделано намеренно. Лучше всего записать в какой-либо файл журнала и следить за выходом журнала.

Если вы пытаетесь ПРОВЕРИТЬ вывод, отметьте это.

Также:

Примечание. Обратите внимание, что PHPUnit поглощает весь вывод, выдаваемый во время выполнения теста. В строгом режиме тест, выдающий выходные данные, завершится неудачно.

Вам действительно следует подумать о своих намерениях: если вам нужна информация сейчас при отладке, чтобы исправить тест, она вам снова понадобится на следующей неделе, когда тесты прервутся.

Это означает, что вам будет нужна информация всегда, когда тест терпит неудачу, а добавление var_dump для поиска причины - слишком большая работа. Скорее вложите данные в свои утверждения.

Если ваш код слишком сложен для этого, разбейте его на части, пока не достигнете уровня, на котором одно утверждение (с настраиваемым сообщением) сообщает вам достаточно, чтобы знать, где оно сломалось, почему и как исправить код.

Мне повезло с VisualPHPUnit, и, помимо прочего, он помогает отображать вывод.

class TestHello extends PHPUnit_Framework_TestCase 
{
    public function test_Hello() 
    {
        print "hello world";
    }
}

В laravel 5 вы можете использовать dump (), выгрузить содержимое из последнего ответа.

class ExampleTest extends TestCase{
    public function test1()
    {
        $this->post('/user', ['name' => 'Gema']);
        $this->dump();
    }
}

дает

Просто используйте флаг --verbose при выполнении phpunit.

$ phpunit --verbose -c phpunit.xml 

Преимущество этого метода в том, что вам не нужно изменять тестовый код, вы можете печатать строки, var_dump или все, что хотите, всегда, и это будет отображаться в консоли только тогда, когда установлен режим подробный. .

Надеюсь, это поможет.

В некоторых случаях можно использовать что-то подобное для вывода чего-либо в консоль

class yourTests extends PHPUnit_Framework_TestCase
{
    /* Add Warnings */
    protected function addWarning($msg, Exception $previous = null)
    {
        $add_warning = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_Warning($msg, 0, $previous);
        $add_warning->addWarning($this, $msg, time());
        $this->setTestResultObject($add_warning);
    }

    /* Add errors */
    protected function addError($msg, Exception $previous = null)
    {
        $add_error = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_AssertionFailedError($msg, 0, $previous);
        $add_error->addError($this, $msg, time());
        $this->setTestResultObject($add_error);
    }

    /* Add failures */
    protected function addFailure($msg, Exception $previous = null)
    {
        $add_failure = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_AssertionFailedError($msg, 0, $previous);
        $add_failure->addFailure($this, $msg, time());
        $this->setTestResultObject($add_failure);
    }

    public function test_messages()
    {
        $this->addWarning("Your warning message!");
        $this->addError("Your error message!");
        $this->addFailure("Your Failure message");
    }

    /* Or just mark test states! */
    public function test_testMarking()
    {
        $this->markTestIncomplete();
        $this->markTestSkipped();
    }
}

Это было взято из документации PHPUnit о приспособлениях.

Это должно позволить вам сбрасывать информацию в любой момент в течение жизненного цикла теста phpunit.

Просто замените __METHOD__ в приведенном ниже коде тем, что вы хотите вывести.

Пример 4.2: Пример, показывающий все доступные методы шаблона

<?php
class TemplateMethodsTest extends PHPUnit_Framework_TestCase
{
    public static function setUpBeforeClass()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function setUp()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function assertPreConditions()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    public function testOne()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        $this->assertTrue(TRUE);
    }

    public function testTwo()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        $this->assertTrue(FALSE);
    }

    protected function assertPostConditions()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function tearDown()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    public static function tearDownAfterClass()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function onNotSuccessfulTest(Exception $e)
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        throw $e;
    }
}
?>

Хакерство, но работает: выбросить исключение с выводом отладки в качестве сообщения.

class theTest extends PHPUnit_Framework_TestCase
{
    public function testOutput() {
        throw new \Exception("hello");
    }   
}

Урожайность:

...
There was 1 error:

1) theTest::testOutput
Exception: hello

PHPUnit скрывает вывод с помощью ob_start(). Мы можем временно отключить его.

    public function log($something = null)
    {
        ob_end_clean();
        var_dump($something);
        ob_start();
    }

Я вывожу свои Testresults на основе HTML, в этом случае было полезно очистить содержимое:

var_dump($array);
ob_flush();

Есть второй метод PHP

flush() 

который я не пробовал.

это платный продукт, но я считаю, что он хорошо справляется со своей задачей: Рэй из Spatie https://spatie.be/products/ray

просто используйте это так:

луч ('сообщение')

и сообщение появится в окне вывода лучей.

Мне пришлось изменить исходный код, чтобы этот код работал, поэтому вам нужно добавить URL для этот разветвленный репозиторий композитору для этого будет работать

class TestCase extends \PHPUnit_Framework_TestCase
{
    /**
     *  Save last response
     * @var Response|null A Response instance
     */
    static $lastResponse;
    /**
     *  Modify to save response
     *
     * @param  string $method
     * @param  string $uri
     * @param  array $parameters
     * @param  array $files
     * @param  array $server
     * @param  string $content
     * @param  bool $changeHistory
     * @return \Illuminate\Http\Response
     */
    final public function call(
        $method,
        $uri,
        $parameters = [],
        $files = [],
        $server = [],
        $content = null,
        $changeHistory = true
    ) {

        $response = parent::call($method, $uri, $parameters, $files, $server, $content, $changeHistory);
        static::$lastResponse = $this->client->getResponse();
        return $response;
    }


    /**
     * Modify message to add response text
     *
     * @param mixed $value
     * @param PHPUnit_Framework_Constraint $constraint
     * @param string $message
     * @since  Method available since Release 3.0.0
     */
    final public static function assertThat($value, PHPUnit_Framework_Constraint $constraint, $message = '')
    {
        $message .= PHP_EOL . static::$lastResponse . PHP_EOL;
        parent::assertThat($value, $constraint, $message);
    }
}

Вот несколько методов, полезных для печати отладочных сообщений в PHPUnit 4.x:

• syslog(LOG_DEBUG, "Debug: Message 1!");

  Более практичный пример:

  syslog(LOG_DEBUG, sprintf("%s: Value: %s", __METHOD__, var_export($_GET, TRUE)));
  

  Вызов syslog() приведет к созданию сообщения системного журнала (см .: man syslog.conf).

  ^{Примечание: возможные уровни: LOG_DEBUG, LOG_INFO, LOG_NOTICE, LOG_WARNING, LOG_ERR и т. д.}

  В macOS для потоковой передачи сообщений системного журнала в реальном времени выполните:

  log stream --level debug --predicate 'processImagePath contains "php"'
  

• fwrite(STDERR, "LOG: Message 2!\n");

  ^{Примечание. Константа STDERR недоступна при чтении сценария PHP из stdin. Вот обходной путь.}

  ^{Примечание: вместо STDERR вы также можете указать имя файла.}

• file_put_contents('php://stderr', "LOG: Message 3!\n", FILE_APPEND);

  ^{Примечание. Используйте этот метод, если у вас нет Определена STDERR константа.}

• register_shutdown_function('file_put_contents', 'php://stderr', "LOG: Message 4!\n", FILE_APPEND);

  ^{Примечание: используйте этот метод, если вы хотите напечатать что-то в самом конце, не влияя на тесты.}

Чтобы выгрузить переменную, используйте var_export(), например "Value: " . var_export($some_var, TRUE) . "\n".

Чтобы распечатать вышеуказанные сообщения только в режиме подробного вывода или отладки, см .: Есть ли способ узнать, передано ли --debug или --verbose в PHPUnit в тесте?

Хотя, если тестирование вывода является частью самого теста, проверьте: Выходные данные тестирования документы.

Короче говоря, phpunit подавляет STDOUT. По умолчанию он записывает в STDERR, если вы не добавите --verbose или --debug. Вы можете сделать одно из следующих действий:

• вместо этого распечатайте выходные данные отладки в STDERR
• var_dump ваша отладка как обычно, но добавьте --verbose в командную строку phpunit
• var_dump выполняйте отладку как обычно, но добавьте строку ob_flush(); под ней
• используйте правильные команды в phpunit для тестирования именно того, что вы пытаетесь проверить здесь

Очевидно, что самое хорошее - это последнее, что нужно делать, а все остальное - это быстрые временные взломы.

Вы можете использовать способ отображения сообщений PHPunit по умолчанию для отладки переменных внутри вашего теста следующим образом:

$this->assertTrue(false,$your_variable);

Можно использовать Symfony\Component\Console\Output\TrimmedBufferOutput, а затем проверить буферизованную строку вывода следующим образом:

use Symfony\Component\Console\Output\TrimmedBufferOutput;

//...
public function testSomething()
{
   $output = new TrimmedBufferOutput(999);
   $output->writeln('Do something in your code with the output class...');
   
   //test the output:
   $this->assertStringContainsString('expected string...', $output->fetch());   
}

Просто позвоните ob_flush() после вывода текста

Пример кода:

    public function testDebugOutputToCli() {
        var_dump(new DateTime());
        ob_flush();
    }

Снимок экрана с кодом и выводом:

Почему? PHPUnit всегда буферизует вывод, поэтому нам нужно сбросить буфер при отладке.

У меня возникли проблемы со всеми приведенными выше ответами, особенно потому, что выбранный ответ - использование codecept_debug() с --debug, как сказано в руководстве - вызвал огромную волну отладочных данных, которые сделали его невозможным для меня.

Я читал руководство PHPUnit, как хороший ботаник, и наткнулся на это, что, как мне кажется, объясняет, что вызывает всю эту проблему во всем PHPUnit, а не только в Codeception:

Руководство PHPUnit, результаты тестирования: «Иногда вы хотите утверждать, что выполнение метода, например, генерирует ожидаемый результат (например, через эхо или печать). Класс PHPUnit \ Framework \ TestCase использует функцию буферизации вывода PHP для обеспечения необходимой для этого функциональности ».

Это имеет смысл и объясняет, почему мы не видим результат. PHPUnit сохраняет его на случай, если мы захотим изучить комментарии! Вот как это всегда должно работать в наших реальных тестах, мы, конечно, не хотим, чтобы на экран попадали случайные вещи только потому, что мы вызвали функцию, которая использует echo.

Но когда мы отлаживаем, мы просто хотим сразу увидеть текст, и, понимая все это, решение очевидное: Просто используйте ob_flush() для печати содержимого выходного буфера по запросу!

Три ура за чтение забавных руководств!

P.S. Также нашел этот совет, скрытый в Как показать var_dumps в phpunit или codeception от Джулиана на dev.to

Если вы используете Laravel, вы можете использовать функции ведения журнала, такие как info (), для входа в файл журнала Laravel в разделе storage / logs. Таким образом, он появится не в вашем терминале, а в файле журнала.