LogPrinter::startTestSuite() - Code Metrics - Inspection of "Replace/incorporate JSON printer" - facile-it/paraunit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#86)

by Alessandro

created 2017-01-21 01:45 UTC

LogPrinter::startTestSuite() B

↳ Parent: LogPrinter

Complexity

Conditions	4
Paths	3

Size

Total Lines	25
Code Lines	15

Duplication

Lines	3
Ratio	12 %

Code Coverage

Tests	14
CRAP Score	4.0047

Importance

Changes

Metric	Value
dl	3
loc	25
ccs	14
cts	15
cp	0.9333
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	15
nc	3
nop	1
crap	4.0047

<?php

namespace Paraunit\Parser\JSON;

/**
 * This class comes from \PHPUnit_Util_Log_JSON.
 * It's copied and refactored here because it's deprecated in PHPUnit 5.7 and it will be dropped in PHPUnit 6
 *
 * Class LogPrinter
 * @package Paraunit\Parser\JSON
 */
class LogPrinter extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener
{
    /** @var string */
    private $logDirectory;

    /** @var int */
    private $testSuiteLevel;

    /**
     * LogPrinter constructor.
     * @param mixed $out
     */
    public function __construct($out = null)
    {
        if (substr($out, -1) !== DIRECTORY_SEPARATOR) {
            $out .= DIRECTORY_SEPARATOR;
        }

        $this->logDirectory = $out;
        $this->testSuiteLevel = 0;
    }

    /**
     * An error occurred.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addError(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * A warning 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)

    {
        $this->writeCase(
            'warning',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * A failure occurred.
     *
     * @param \PHPUnit_Framework_Test                 $test
     * @param \PHPUnit_Framework_AssertionFailedError $e
     * @param float                                   $time
     */
    public function addFailure(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_AssertionFailedError $e, $time)

    {
        $this->writeCase(
            'fail',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            \PHPUnit_Framework_TestFailure::exceptionToString($e),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Incomplete test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addIncompleteTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Incomplete Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Risky test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addRiskyTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Risky Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * Skipped test.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param \Exception              $e
     * @param float                   $time
     */
    public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            \PHPUnit_Util_Filter::getFilteredStacktrace($e, false),

            'Skipped Test: ' . $e->getMessage(),
            $test
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->currentTestPass = false;
    }

    /**
     * A testsuite started.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     */
    public function startTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        if ($this->testSuiteLevel === 0) {
            $logFilename = $this->getLogFilename($suite);

            $logDir = dirname($logFilename);
            if (! @mkdir($logDir, 0777, true) && !is_dir($logDir)) {

                throw new \RuntimeException('Cannot create folder for JSON logs');
            }

            $this->out = fopen($logFilename, 'wt');
        }

        $this->testSuiteLevel++;
        $this->currentTestSuiteName = $suite->getName();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->currentTestName      = '';
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event' => 'suiteStart',
                'suite' => $this->currentTestSuiteName,
                'tests' => count($suite)
            )
        );
    }

    /**
     * A testsuite ended.
     *
     * @param \PHPUnit_Framework_TestSuite $suite
     */
    public function endTestSuite(\PHPUnit_Framework_TestSuite $suite)
    {
        $this->testSuiteLevel--;
        $this->currentTestSuiteName = '';
        $this->currentTestName      = '';
    }

    /**
     * A test started.
     *
     * @param \PHPUnit_Framework_Test $test
     */
    public function startTest(\PHPUnit_Framework_Test $test)
    {
        $this->currentTestName = \PHPUnit_Util_Test::describe($test);
        $this->currentTestPass = true;

        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event' => 'testStart',
                'suite' => $this->currentTestSuiteName,
                'test'  => $this->currentTestName
            )
        );
    }

    /**
     * A test ended.
     *
     * @param \PHPUnit_Framework_Test $test
     * @param float                  $time
     */
    public function endTest(\PHPUnit_Framework_Test $test, $time)
    {
        if ($this->currentTestPass) {
            $this->writeCase('pass', $time, array(), '', $test);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * @param string                           $status
     * @param float                            $time
     * @param array                            $trace
     * @param string                           $message
     * @param \PHPUnit_Framework_TestCase|null $test
     */
    protected function writeCase($status, $time, array $trace = array(), $message = '', $test = null)
    {
        $output = '';
        // take care of TestSuite producing error (e.g. by running into exception) as TestSuite doesn't have hasOutput
        if ($test !== null && method_exists($test, 'hasOutput') && $test->hasOutput()) {
            $output = $test->getActualOutput();
        }
        $this->write(
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event'   => 'test',
                'suite'   => $this->currentTestSuiteName,
                'test'    => $this->currentTestName,
                'status'  => $status,
                'time'    => $time,
                'trace'   => $trace,
                'message' => \PHPUnit_Util_String::convertToUtf8($message),
                'output'  => $output,
            )
        );
    }

    /**
     * @param string $buffer
     */
    public function write($buffer)
    {
        array_walk_recursive($buffer, function (&$input) {
            if (is_string($input)) {
                $input = \PHPUnit_Util_String::convertToUtf8($input);
            }
        });

        $flags = 0;

        if (defined('JSON_PRETTY_PRINT')) {
            $flags |= JSON_PRETTY_PRINT;
        }

        parent::write(json_encode($buffer, $flags));
    }

    /**
     * @param \PHPUnit_Framework_TestSuite $suite
     * @return string
     */
    private function getLogFilename(\PHPUnit_Framework_TestSuite $suite)
    {
        $testFilename = $this->getTestFilename($suite);
        
        return $this->logDirectory . md5($testFilename) . '.json.log';
    }

    /**
     * @param \PHPUnit_Framework_TestSuite $suite
     * @return string
     */
    private function getTestFilename(\PHPUnit_Framework_TestSuite $suite)
    {
        $reflection = new \ReflectionClass($suite->getName());
        
        return $reflection->getFileName();
    }
}


1		<?php
2
3		namespace Paraunit\Parser\JSON;
4
5		/**
6		* This class comes from \PHPUnit_Util_Log_JSON.
7		* It's copied and refactored here because it's deprecated in PHPUnit 5.7 and it will be dropped in PHPUnit 6
8		*
9		* Class LogPrinter
10		* @package Paraunit\Parser\JSON
11		*/
12		class LogPrinter extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener
13		{
14		/** @var string */
15		private $logDirectory;
16
17		/** @var int */
18		private $testSuiteLevel;
19
20		/**
21		* LogPrinter constructor.
22		* @param mixed $out
23		*/
24	10	public function __construct($out = null)
25		{
26	10	if (substr($out, -1) !== DIRECTORY_SEPARATOR) {
27	10	$out .= DIRECTORY_SEPARATOR;
28		}
29
30	10	$this->logDirectory = $out;
31	10	$this->testSuiteLevel = 0;
32	10	}
33
34		/**
35		* An error occurred.
36		*
37		* @param \PHPUnit_Framework_Test $test
38		* @param \Exception $e
39		* @param float $time
40		*/

facile-it / paraunit

Pull Request — master (#86)

LogPrinter::startTestSuite() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like