LogPrinter - Code Metrics - Inspection of "Simplify a bit the FailuresPrinter" - facile-it/paraunit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 02f97d...6ad174 )

by Alessandro

created 2017-07-05 09:19 UTC

LogPrinter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	286
Duplicated Lines	22.03 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

94.64%

Importance

Changes

Metric	Value
wmc	30
c	0
b	0
f	0
lcom	1
cbo	6
dl	63
loc	286
ccs	106
cts	112
cp	0.9464
rs	10

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addWarning()	12	12	1
A	addFailure()	12	12	1
A	addIncompleteTest()	12	12	1
A	addRiskyTest()	12	12	1
A	addSkippedTest()	12	12	1
A	startTestSuite()	0	11	1
A	endTestSuite()	0	5	1
A	startTest()	0	11	1
A	endTest()	0	6	2
A	writeCase()	0	18	4
A	writeArray()	0	10	2
A	writeToLog()	0	8	3
A	getLogFilename()	3	14	4
A	getLogDirectory()	0	14	3
A	addError()	0	12	1
A	convertToUtf8()	0	8	2

How to fix Duplicated Code

<?php
declare(strict_types=1);

namespace Paraunit\Parser\JSON;

use Paraunit\Configuration\EnvVariables;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Framework\TestListener;
use PHPUnit\Framework\TestSuite;
use PHPUnit\Framework\Warning;
use PHPUnit\Util;

/**
 * This class comes from 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 Util\Printer implements TestListener
{
    /** @var resource */
    private $logFile;

    /** @var string */
    private $currentTestSuiteName;

    /** @var string */
    private $currentTestName;

    /** @var bool */
    private $currentTestPass;

    public function __construct()
    {
        $this->logFile = fopen($this->getLogFilename(), 'wt');
        $this->autoFlush = true;
    }

    /**
     * An error occurred.
     *
     * @param Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addError(Test $test, \Exception $e, $time)
    {
        $this->writeCase(
            'error',
            $time,
            Util\Filter::getFilteredStacktrace($e, false),

            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 warning occurred.
     *
     * @param Test $test
     * @param Warning $e
     * @param float $time
     */
    public function addWarning(Test $test, Warning $e, $time)

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

            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 Test $test
     * @param AssertionFailedError $e
     * @param float $time
     */
    public function addFailure(Test $test, AssertionFailedError $e, $time)

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

            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 Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addIncompleteTest(Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            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 Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addRiskyTest(Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            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 Test $test
     * @param \Exception $e
     * @param float $time
     */
    public function addSkippedTest(Test $test, \Exception $e, $time)

    {
        $this->writeCase(
            'error',
            $time,
            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 TestSuite $suite
     * @throws \RuntimeException
     */
    public function startTestSuite(TestSuite $suite)
    {
        $this->currentTestSuiteName = $suite->getName();
        $this->currentTestName = '';

        $this->writeArray([
            'event' => 'suiteStart',
            'suite' => $this->currentTestSuiteName,
            'tests' => count($suite)
        ]);
    }

    public function endTestSuite(TestSuite $suite)
    {
        $this->currentTestSuiteName = '';
        $this->currentTestName = '';
    }

    public function startTest(Test $test)
    {
        $this->currentTestName = Util\Test::describe($test);
        $this->currentTestPass = true;

        $this->writeArray([
            'event' => 'testStart',
            'suite' => $this->currentTestSuiteName,
            'test' => $this->currentTestName
        ]);
    }

    /**
     * A test ended.
     *
     * @param Test $test
     * @param float $time
     */
    public function endTest(Test $test, $time)
    {
        if ($this->currentTestPass) {
            $this->writeCase('pass', $time, [], '', $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 TestCase|null $test
     */
    private function writeCase($status, $time, array $trace = [], $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->writeArray([
            'event' => 'test',
            'suite' => $this->currentTestSuiteName,
            'test' => $this->currentTestName,
            'status' => $status,
            'time' => $time,
            'trace' => $trace,
            'message' => $this->convertToUtf8($message),
            'output' => $output,
        ]);
    }

    /**
     * @param array $buffer
     */
    private function writeArray($buffer)
    {
        array_walk_recursive($buffer, function (&$input) {
            if (is_string($input)) {
                $input = $this->convertToUtf8($input);
            }
        });

        $this->writeToLog(json_encode($buffer, JSON_PRETTY_PRINT));
    }

    private function writeToLog($buffer)
    {
        // ignore everything that is not a JSON object
        if ($buffer != '' && $buffer[0] === '{') {
            \fwrite($this->logFile, $buffer);
            \fflush($this->logFile);
        }
    }

    /**
     * @return string
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     */
    private function getLogFilename(): string
    {
        $logDir = $this->getLogDirectory();
        if (! @mkdir($logDir, 0777, true) && ! is_dir($logDir)) {

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

        $logFilename = getenv(EnvVariables::PROCESS_UNIQUE_ID) . '.json.log';
        if ($logFilename === false) {
            throw new \InvalidArgumentException('Log filename not received: environment variable not set');
        }

        return $logDir . $logFilename;
    }

    /**
     * @return string
     * @throws \InvalidArgumentException
     */
    private function getLogDirectory(): string
    {
        $logDirectory = getenv(EnvVariables::LOG_DIR);

        if ($logDirectory === false) {
            throw new \InvalidArgumentException('Log directory not received: environment variable not set');
        }

        if (substr($logDirectory, -1) !== DIRECTORY_SEPARATOR) {
            $logDirectory .= DIRECTORY_SEPARATOR;
        }

        return $logDirectory;
    }

    private function convertToUtf8($string): string
    {
        if (! \mb_detect_encoding($string, 'UTF-8', true)) {
            return \mb_convert_encoding($string, 'UTF-8');
        }

        return $string;
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Paraunit\Parser\JSON;
5
6		use Paraunit\Configuration\EnvVariables;
7		use PHPUnit\Framework\AssertionFailedError;
8		use PHPUnit\Framework\Test;
9		use PHPUnit\Framework\TestCase;
10		use PHPUnit\Framework\TestFailure;
11		use PHPUnit\Framework\TestListener;
12		use PHPUnit\Framework\TestSuite;
13		use PHPUnit\Framework\Warning;
14		use PHPUnit\Util;
15
16		/**
17		* This class comes from Util\Log_JSON.
18		* It's copied and refactored here because it's deprecated in PHPUnit 5.7 and it will be dropped in PHPUnit 6
19		*
20		* Class LogPrinter
21		* @package Paraunit\Parser\JSON
22		*/
23		class LogPrinter extends Util\Printer implements TestListener
24		{
25		/** @var resource */
26		private $logFile;
27
28		/** @var string */
29		private $currentTestSuiteName;
30
31		/** @var string */
32		private $currentTestName;
33
34		/** @var bool */
35		private $currentTestPass;
36
37	9	public function __construct()
38		{
39	9	$this->logFile = fopen($this->getLogFilename(), 'wt');
40	9	$this->autoFlush = true;

facile-it / paraunit

Push — master ( 02f97d...6ad174 )

LogPrinter A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like