ExtededTestdox.php

Go to the documentation of this file.

<?php
namespace Magento\TestFramework\Listener;

class ExtededTestdox extends \PHPUnit_Util_Printer implements \PHPUnit\Framework\TestListener
{
    protected $prettifier;

    protected $testClass = '';

    protected $testStatus = false;

    protected $tests = [];

    protected $successful = 0;

    protected $failed = 0;

    protected $skipped = 0;

    protected $incomplete = 0;

    protected $risky = 0;

    protected $testTypeOfInterest = \PHPUnit\Framework\TestCase::class;

    protected $currentTestClassPrettified;

    protected $currentTestMethodPrettified;

    public function __construct($out = null)
    {
        parent::__construct($out);

        $this->prettifier = new \PHPUnit_Util_TestDox_NamePrettifier();
        $this->startRun();
    }

    public function flush()
    {
        $this->doEndClass();
        $this->endRun();

        parent::flush();
    }

    public function addError(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_ERROR;
            $this->failed++;
        }
    }

    public function addFailure(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\AssertionFailedError $e, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE;
            $this->failed++;
        }
    }

    public function addIncompleteTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE;
            $this->incomplete++;
        }
    }

    public function addSkippedTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED;
            $this->skipped++;
        }
    }

    public function addRiskyTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_RISKY;
            $this->risky++;
        }
    }

    public function startTestSuite(\PHPUnit\Framework\TestSuite $suite)
    {
    }

    public function endTestSuite(\PHPUnit\Framework\TestSuite $suite)
    {
    }

    public function startTest(\PHPUnit\Framework\Test $test)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            $class = get_class($test);

            if ($this->testClass != $class) {
                if ($this->testClass != '') {
                    $this->doEndClass();
                }

                $this->currentTestClassPrettified = $this->prettifier->prettifyTestClass($class);
                $this->startClass($class);

                $this->testClass = $class;
                $this->tests = [];
            }
            $this->write('.');
            $this->currentTestMethodPrettified = $this->prettifier->prettifyTestMethod($test->getName(false));

            $this->testStatus = \PHPUnit_Runner_BaseTestRunner::STATUS_PASSED;
        }
    }

    public function endTest(\PHPUnit\Framework\Test $test, $time)
    {
        if ($test instanceof $this->testTypeOfInterest) {
            if (!isset($this->tests[$this->currentTestMethodPrettified])) {
                $this->tests[$this->currentTestMethodPrettified] = ['success' => 0, 'failure' => 0, 'time' => 0];
            }

            if ($this->testStatus == \PHPUnit_Runner_BaseTestRunner::STATUS_PASSED) {
                $this->tests[$this->currentTestMethodPrettified]['success']++;
            }
            if ($this->testStatus == \PHPUnit_Runner_BaseTestRunner::STATUS_ERROR) {
                $this->tests[$this->currentTestMethodPrettified]['failure']++;
            }
            if ($this->testStatus == \PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE) {
                $this->tests[$this->currentTestMethodPrettified]['failure']++;
            }
            $this->tests[$this->currentTestMethodPrettified]['time'] += $time;
            $this->currentTestClassPrettified = null;
            $this->currentTestMethodPrettified = null;
        }
    }

    protected function startRun()
    {
    }

    protected function endRun()
    {
    }

    protected function startClass($name)
    {
        $this->write($this->currentTestClassPrettified . '  ');
    }

    protected function endClass($name)
    {
        $this->write("\n");
    }

    protected function doEndClass()
    {
        foreach ($this->tests as $name => $data) {
            $check = $data['failure'] == 0 ? ' - [x] ' : ' - [ ] ';
            $this->write(
                "\n" . $check . $name . ($data['failure'] + $data['success'] ==
                0 ? ' (skipped)' : '') . ($data['time'] > 1 ? ' - ' . number_format(
                    $data['time'],
                    2
                ) . "s" : '')
            );
        }

        $this->endClass($this->testClass);
    }
}