Yoanm\PhpUnitExtended\Listener\RiskyToFailedListener

Complexity

Total Complexity

12

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addErrorIfNeeded()	0	16	3
A	addRiskyTest()	0	3	1
C	getErrorReason()	0	30	7
A	addWarning()	0	3	1

<?php
namespace Yoanm\PhpUnitExtended\Listener;

use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\OutputError;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestListenerDefaultImplementation;
use PHPUnit\Framework\UnintentionallyCoveredCodeError;
use PHPUnit\Framework\Warning;

/**
 * @see doc/listener/StrictCoverageListener.md
 */
class RiskyToFailedListener implements TestListener
{
    use TestListenerDefaultImplementation;

    public function addWarning(Test $test, Warning $e, $time)
    {
        $this->addErrorIfNeeded($test, $e, $time);
    }

    /**
     * @param Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addRiskyTest(Test $test, \Exception $e, $time)
    {
        $this->addErrorIfNeeded($test, $e, $time);
    }

    /**
     * @param Test $test
     * @param \Exception $e
     * @param $time
     */
    protected function addErrorIfNeeded(Test $test, \Exception $e, $time)
    {
        /* Must beTestCase instance to have access to "getTestResultObject" method */
        if ($test instanceof TestCase) {
            $reason = $this->getErrorReason($e);
            if (null !== $reason) {
                $test->getTestResultObject()->addFailure(
                    $test,
                    new AssertionFailedError(
                        sprintf(
                            "Strict mode - %s :\n%s",
                            $reason,
                            $e->getMessage()
                        )
                    ),
                    $time
                );
            }
        }
    }

    /**
     * @param \Exception $e
     *
     * @return null|string
     */
    protected function getErrorReason(\Exception $e)
    {
        $reason = null;
        switch (true) {
            /* beStrictAboutOutputDuringTests="true" */
            case $e instanceof OutputError:
                $reason = 'No output during test';
                break;
            /* checkForUnintentionallyCoveredCode="true" */
            case $e instanceof UnintentionallyCoveredCodeError:
                $reason = 'Executed code must be defined with @covers and @uses annotations';
                break;
            default:
                if (preg_match('#\-\-\- Global variables before the test#', $e->getMessage())) {
                    /* beStrictAboutChangesToGlobalState="true" (no specific exception) for globals */
                    $reason = 'No global variable manipulation during test';
                } elseif (preg_match('#\-\-\- Static attributes before the test#', $e->getMessage())) {
                    /* beStrictAboutChangesToGlobalState="true" (no specific exception) for static var */
                    /* Only when beStrictAboutChangesToGlobalState="true" */
                    $reason = 'No static attribute manipulation during test';
                } elseif (preg_match('#This test did not perform any assertions#', $e->getMessage())) {
                    /* beStrictAboutTestsThatDoNotTestAnything="true" (no specific exception) */
                    $reason = 'No test that do not test anything';
                } elseif (preg_match('#Trying to @cover or @use not existing #', $e->getMessage())) {
                    /* forceCoversAnnotation="true" (no specific exception) */
                    $reason = 'Only executed code must be defined with @covers and @uses annotations';
                }
                break;
        }
        return $reason;
    }
}