Як вивести в 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 repos від 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

Корисно, якщо ви намагаєтеся знайти правильний шлях до файлу включених або вихідних даних.

Це не помилка, але дуже навмисно. Ваша найкраща ставка - записати в якийсь файл журналу та передати хвіст журналу, щоб слідкувати за результатами.

Якщо ви намагаєтесь вивести TEST, перевірте це .

Також:

Примітка . Зверніть увагу: 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;
    }
}
?>

Я виводжу свій тестрезультат на базі 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 для потокового передавання повідомлень syslog в режимі реального часу запустіть:

  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, ви можете використовувати такі функції реєстрації, як інформація (), щоб увійти до файлу журналу Laravel під зберіганням / журналами. Таким чином він відображатиметься не у вашому терміналі, а у файлі журналу.