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

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

Я попробовал следующее (аналогично примеру с руководством по PHPUnit );

class theTest extends PHPUnit_Framework_TestCase
{
    /**
     * @outputBuffering disabled
     */
    public function testOutput() {
        print_r("Hello World");
        print "Ping";
        echo "Pong";
        $out = "Foo";
        var_dump($out);
    }   
}

Со следующим результатом:

PHPUnit @package_version@ by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 3.00Mb

OK (1 test, 0 assertions)

Обратите внимание, что нет ожидаемого результата.

Я использую HEAD версии репозитория git по состоянию на 19 сентября 2011 года.

Выход php -version:

$ php -version
PHP 5.2.9 (cli) (built: Dec  8 2010 11:36:37) 
Copyright (c) 1997-2009 The PHP Group
Zend Engine v2.2.0, Copyright (c) 1998-2009 Zend Technologies
    with Xdebug v2.1.0, Copyright (c) 2002-2010, by Derick Rethans

Есть ли что-то, что я делаю не так, или это потенциально ошибка PHPUnit?

ОБНОВИТЬ

Только что реализовал другой способ сделать это, который работает намного лучше, чем --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 поглощает все выходные данные, которые генерируются во время выполнения теста. В строгом режиме тест, выдающий выходные данные, не будет выполнен.

Мне повезло с VisualPHPUnit , и он, помимо всего прочего, показывает полезную информацию .

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

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

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

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

В 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();
    }
}

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

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

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

...
There was 1 error:

1) theTest::testOutput
Exception: hello

Это было взято из PHPUnit Docs о приспособлениях .

Это должно позволить вам выводить информацию в любой точке в течение жизненного цикла теста 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;
    }
}
?>

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

var_dump($array);
ob_flush();

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

flush() 

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

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

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

Мне пришлось изменить исходный код, чтобы этот код работал, поэтому вам нужно добавить 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 в тесте?

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

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