jasny / phpunit-extension

src/ExpectWarningTrait.php

<?php

declare(strict_types=1);

namespace Jasny\PHPUnit;

use Jasny\PHPUnit\Util\ExpectedWarnings;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Error\Deprecated;
use PHPUnit\Framework\Error\Notice;
use PHPUnit\Framework\Error\Warning as WarningError;
use PHPUnit\Runner\BaseTestRunner;

trait ExpectWarningTrait
{
    /**
     * @var ExpectedWarnings
     */
    private $expectedWarnings;

    /**
     * @before
     * @internal
     */
    protected function registerExpectedWarnings(): void
    {
        $this->expectedWarnings = new ExpectedWarnings();
        $this->expectedWarnings->register();
    }

    /**
     * @after
     * @internal
     */
    protected function unregisterExpectedWarnings(): void
    {
        if ($this->expectedWarnings === null) {
            return;
        }

        $this->expectedWarnings->unregister();
        $this->expectedWarnings = null;
    }

    /**
     * Performs assertions shared by all tests of a test cas.
     */
    protected function assertPostConditions(): void
    {
        $okStatus = [BaseTestRunner::STATUS_PASSED, BaseTestRunner::STATUS_RISKY, BaseTestRunner::STATUS_UNKNOWN];
        if ($this->expectedWarnings === null || !in_array($this->getStatus(), $okStatus, true)) {

It seems like getStatus() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return;
        }

        $notTriggered = $this->expectedWarnings->getNotTriggered();

        if ($notTriggered !== []) {
            // @codeCoverageIgnoreStart
            $desc = ExpectedWarnings::describeExpected(reset($notTriggered));
            throw new AssertionFailedError(\sprintf('Failed asserting that %s is triggered', $desc));
            // @codeCoverageIgnoreEnd
        }
    }

    public function expectDeprecation(): void
    {
        $this->expectedWarnings->add('deprecation');
        $this->addToAssertionCount(1);

It seems like addToAssertionCount() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function expectDeprecationMessage(string $message): void
    {
        $this->expectedWarnings->add('deprecation', $message);
        $this->addToAssertionCount(1);
    }

    public function expectDeprecationMessageMatches(string $regularExpression): void
    {
        $this->expectedWarnings->addRegExp('deprecation', $regularExpression);
        $this->addToAssertionCount(1);
    }

    public function expectNotice(): void
    {
        $this->expectedWarnings->add('notice');
        $this->addToAssertionCount(1);
    }

    public function expectNoticeMessage(string $message): void
    {
        $this->expectedWarnings->add('notice', $message);
        $this->addToAssertionCount(1);
    }

    public function expectNoticeMessageMatches(string $regularExpression): void
    {
        $this->expectedWarnings->addRegExp('notice', $regularExpression);
        $this->addToAssertionCount(1);
    }

    public function expectWarning(): void
    {
        $this->expectedWarnings->add('warning');
        $this->addToAssertionCount(1);
    }

    public function expectWarningMessage(string $message): void
    {
        $this->expectedWarnings->add('warning', $message);
        $this->addToAssertionCount(1);
    }

    public function expectWarningMessageMatches(string $regularExpression): void
    {
        $this->expectedWarnings->addRegExp('warning', $regularExpression);
        $this->addToAssertionCount(1);
    }
}