PHPUnit\TeamCity\TestListener

Complexity

Total Complexity

23

Size/Duplication

Total Lines	289
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

98.17%

Importance

Changes	22
Bugs	0	Features	6

16 Methods

Rating	Name	Duplication	Size	Complexity
A	writeServiceMessage()	0	5	1
A	createServiceMessage()	0	13	2
A	getTimestamp()	0	6	1
A	getTestName()	0	13	4
A	getFlowId()	0	4	1
A	escapeValue()	0	15	1
B	addError()	0	24	3
A	addFailure()	0	4	1
A	addIncompleteTest()	0	4	1
A	addRiskyTest()	0	4	1
A	addSkippedTest()	0	10	1
A	addWarning()	0	15	2
A	startTestSuite()	0	7	1
A	endTestSuite()	0	7	1
A	startTest()	0	10	1
A	endTest()	0	10	1

<?php

namespace PHPUnit\TeamCity;

class TestListener extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener
{
    /**
     * Teamcity service message names
     */
    const MESSAGE_SUITE_STARTED = 'testSuiteStarted';
    const MESSAGE_SUITE_FINISHED = 'testSuiteFinished';
    const MESSAGE_TEST_STARTED = 'testStarted';
    const MESSAGE_TEST_FAILED = 'testFailed';
    const MESSAGE_TEST_IGNORED = 'testIgnored';
    const MESSAGE_TEST_FINISHED = 'testFinished';

    /**
     * Comparison failure message type
     */
    const MESSAGE_COMPARISON_FAILURE = 'comparisonFailure';

    /**
     * If true, all the standard output (and standard error) messages
     * received between testStarted and testFinished messages will be considered test output
     *
     * @var string
     */
    protected $captureStandardOutput = 'true';

    /**
     * Create and write service message to out
     *
     * @param string $type
     * @param \PHPUnit_Framework_Test $test
     * @param array $params
     */
    protected function writeServiceMessage($type, \PHPUnit_Framework_Test $test, array $params = array())
    {
        $message = $this->createServiceMessage($type, $test, $params);
        $this->write($message);
    }

    /**
     * Create service message
     *
     * @param string $type
     * @param \PHPUnit_Framework_Test $test
     * @param array $params
     * @return string
     */
    protected function createServiceMessage($type, \PHPUnit_Framework_Test $test, array $params = array())
    {
        $params += array(
            'name' => $this->getTestName($test),
            'timestamp' => $this->getTimestamp(),
            'flowId' => $this->getFlowId($test)
        );
        $attributes = array();
        foreach ($params as $name => $value) {
            $attributes[] = sprintf("%s='%s'", $name, $this->escapeValue($value));
        }
        return sprintf('##teamcity[%s %s]%s', $type, implode(' ', $attributes), PHP_EOL);
    }

    /**
     * Create timestamp for service message
     *
     * @return string
     */
    protected function getTimestamp()
    {
        list($usec, $sec) = explode(' ', microtime());
        $msec = floor($usec * 1000);
        return date("Y-m-d\\TH:i:s.{$msec}O", $sec);
    }

    /**
     * @param \PHPUnit_Framework_Test $test
     * @return string
     */
    protected function getTestName(\PHPUnit_Framework_Test $test)
    {
        if ($test instanceof \PHPUnit_Framework_TestCase) {
            $name = $test->getName();
        } elseif ($test instanceof \PHPUnit_Framework_TestSuite) {
            $name = $test->getName();
        } elseif ($test instanceof \PHPUnit_Framework_SelfDescribing) {
            $name = $test->toString();
        } else {
            $name = get_class($test);
        }
        return $name;
    }

    /**
     * @param \PHPUnit_Framework_Test $test
     * @return int
     */
    protected function getFlowId(\PHPUnit_Framework_Test $test)

The parameter $test is not used and could be removed.

    {
        return getmypid();
    }

    /**
     * @param string $string
     * @return string
     */
    protected function escapeValue($string)
    {
        $string = trim($string);
        return strtr(
            $string,
            array(
                "|"  => "||",
                "'"  => "|'",
                "\n" => "|n",
                "\r" => "|r",
                "["  => "|[",
                "]"  => "|]"
            )
        );
    }

    /**
     * An error occurred.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addError(\PHPUnit_Framework_Test $test, \Exception $e, $time)
    {
        $params = array(
            'message' => \PHPUnit_Framework_TestFailure::exceptionToString($e),
            'details' => \PHPUnit_Util_Filter::getFilteredStacktrace($e),
        );

        if ($e instanceof \PHPUnit_Framework_ExpectationFailedException) {
            $comparisonFailure = $e->getComparisonFailure();
            if (null !== $comparisonFailure) {
                $params += array(
                    'type' => self::MESSAGE_COMPARISON_FAILURE,
                    'expected' => $comparisonFailure->getExpectedAsString(),
                    'actual' => $comparisonFailure->getActualAsString()
                );
            }
        }

        $this->writeServiceMessage(
            self::MESSAGE_TEST_FAILED,
            $test,
            $params
        );
    }

    /**
     * A failure occurred.
     *
     * @param \PHPUnit_Framework_Test|\PHPUnit_Framework_TestCase $test
     * @param \PHPUnit_Framework_AssertionFailedError $e
     * @param float $time
     */
    public function addFailure(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_AssertionFailedError $e, $time)
    {
        $this->addError($test, $e, $time);
    }

    /**
     * Incomplete test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addIncompleteTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
    {
        $this->addSkippedTest($test, $e, $time);
    }

    /**
     * Risky test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception $e
     * @param float $time
     * @since  Method available since Release 4.0.0
     */
    public function addRiskyTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
    {
        $this->addSkippedTest($test, $e, $time);
    }

    /**
     * Skipped test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
    {
        $this->writeServiceMessage(
            self::MESSAGE_TEST_IGNORED,
            $test,
            array(
                'message' => $e->getMessage(),
            )
        );
    }

    /**
     * A failure occurred.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \PHPUnit_Framework_Warning $e
     * @param float $time
     */
    public function addWarning(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_Warning $e, $time)
    {
        // Since PHPUnit 5.1
        if ($e instanceof \Exception) {
            $this->addError($test, $e, $time);
        } else {
            $this->writeServiceMessage(
                self::MESSAGE_TEST_FAILED,
                $test,
                array(
                    'message' => $e->getMessage(),
                )
            );
        }
    }


    /**
     * A test suite started.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     */
    public function startTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        $this->writeServiceMessage(
            self::MESSAGE_SUITE_STARTED,
            $suite
        );
    }

    /**
     * A test suite ended.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     */
    public function endTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        $this->writeServiceMessage(
            self::MESSAGE_SUITE_FINISHED,
            $suite
        );
    }

    /**
     * A test started.
     *
     * @param \PHPUnit_Framework_Test $test
     */
    public function startTest(\PHPUnit_Framework_Test $test)
    {
        $this->writeServiceMessage(
            self::MESSAGE_TEST_STARTED,
            $test,
            array(
                'captureStandardOutput' => $this->captureStandardOutput,
            )
        );
    }

    /**
     * A test ended.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param float $time seconds
     */
    public function endTest(\PHPUnit_Framework_Test $test, $time)
    {
        $this->writeServiceMessage(
            self::MESSAGE_TEST_FINISHED,
            $test,
            array(
                'duration' => floor($time * 1000),
            )
        );
    }
}