Defines the Loggable
trait to log from within your PHPUnit tests.
- Install the package with
composer require --dev coccoinomane/phpunit-log
. - Include the trait in your TestCase with
\use PHPUnitLog\Loggable;
. - Start logging with
this->log( $message )
orthis->print( $message )
.
- To log a message to screen, call
self::print( $message )
. - To log a message to file, call
self::log( $message )
. - The file will be named after the test class and placed in the subfolder tests/logs.
- Customize the log folder via the
logsPath
environment variable. - To delete the log files before each run:
public static function setUpBeforeClass(): void { static::deleteLogFile(); }
- For further customizations, see the docs in
Loggable
or the tests inLoggableTest
.
The Loggable
trait is used by WordPressTestCase
.
By default, the log files will be placed in the tests/logs folder; set the logsPath
environment variable to use a different folder.
You can use both relative and absolute paths.
To set logsPath
in phpunit.xml:
<php>
<env name="logsPath" value="./tests/logs"/>
</php>