coccoinomane/phpunit-log

Log from within your PHPUnit tests.

1.0.3 2023-02-02 10:17 UTC

Requires (Dev)

• phpstan/extension-installer: ^1.1
• phpunit/phpunit: ^9.5

GPL-3.0-or-later

• php
• phpunit
• tests
• trait

README

Defines the Loggable trait to log from within your PHPUnit tests.

Usage

1. Install the package with composer require --dev coccoinomane/phpunit-log.
2. Include the trait in your TestCase with \use PHPUnitLog\Loggable;.
3. Start logging with this->log( $message ) or this->print( $message ).

Features

• 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 in LoggableTest.

The Loggable trait is used by WordPressTestCase.

Custom folder for the logs

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>