Печать вывода отладки на консоль в Codeception

См. раздел Отладка, в котором говорится

Вы можете распечатать любую информацию внутри теста, используя функцию codecept_debug.

И я использую его в своем классе *Cept:

codecept_debug($myVar);

Ваш вывод отладки виден только при запуске с параметром --debug (-v его не показывает, но -vv и -vvv показывают):

codecept run --debug

И вывод выглядел так:

Validate MyEntity table insert (MyCept) 
Scenario:
* I persist entity "AppBundle\Entity\MyEntity"

  AppBundle\Entity\MyEntity Object
  (
      [Id:AppBundle\Entity\MyEntity:private] => 1
      [Description:AppBundle\Entity\MyEntity:private] => Description
  )

 PASSED 

\Codeception\Util\Debug::debug($this->em);die();

и запустите Codeception с флагом --debug.

Кажется, я нашел способ обойти проблему, используя вспомогательный класс:

class WebHelper extends \Codeception\Module
{
    public function seeMyVar($var){
        $this->debug($var);
    }
}

и вызывая класс как таковой:

$foo = array('one','two');
$I->seeMyVar($foo);

затем я получаю отладочный вывод, который я ищу

I see my var "lambda function"
  Array
  (
      [0] => one
      [1] => two
  )

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

Или вы можете использовать команды управления многословием, такие как:

codecept run -vvv

где каждый v увеличивает детализацию вывода (по умолчанию очень тихо).

По умолчанию Codeception говорит, что произошла ошибка, но не показывает ее подробно. Однако, согласно этой записи в блоге, добавление --debug подробно показывает ошибки.

codecept run --debug

Короткая версия будет codecept run tests/acceptance/SomeCest.php -d
-d покажет вам шаги и отладку

Короткий, красивый и простой способ

Определенно codecept_debug с опцией --debug - один из правильных способов.

Но --debug показывает много подробностей, которые нам могут не понадобиться все время, чтобы увидеть только значение одной переменной. И иногда нам может понадобиться много прокручивать CLI, чтобы добраться до нашей переменной.

Однако есть еще один короткий, красивый и простой способ

Утвердите переменную с помощью true или чего-либо случайного, используя assertSame для отображения/var_dump переменной

Допустим, мне нужно посмотреть, что внутри $mango, и я уверен, что это неправда или «что-то случайное».

$I->assertTrue($mango)
$I->assertSame($mango, 'something random') // I am pretty sure $mango does not equals to 'something random'

Приведенные выше операторы будут выдавать ошибку при печати $mango, и самое приятное то, что она будет напечатана внизу, поэтому нет необходимости прокручивать и нет многословия. Также таким образом нет необходимости добавлять --debug в команду CLI.

Ограничение:

Из 10 типов данных в PHP

Four scalar types:


bool
int
float (floating-point number, aka double)
string


Four compound types:

array
object
callable
iterable


And finally two special types:

resource
NULL

Выше мой способ хорошо работает только с 6:

Four scalar types:

bool
int
float (floating-point number, aka double)
string


One compound types:

array


And finally one special types:

NULL

Значение object, resource будет напечатано не очень хорошо.

Просто позвоните 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

Согласно ОП

Я просто хочу видеть содержимое моей переменной

Если у вас есть переменная типа

$var="hello";

И вы хотите вывести его в консоль, тогда просто выполните

$I->comment($var);