LoggerWrapperTest::testPsrLogLevelIsMapped() - Code Metrics - Inspection of "add log4php psr-3 wrapper" - abacaphiliac/psr-log4php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Timothy

created 2016-07-28 01:59 UTC

LoggerWrapperTest::testPsrLogLevelIsMapped() A

↳ Parent: LoggerWrapperTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

namespace AbacaphiliacTest\PsrLog4Php;

use Abacaphiliac\PsrLog4Php\LoggerWrapper;
use Psr\Log\LogLevel;

/**
 * @covers \Abacaphiliac\PsrLog4Php\LoggerWrapper
 */
class LoggerWrapperTest extends \PHPUnit_Framework_TestCase
{
    /** @var \PHPUnit_Framework_MockObject_MockObject|\Logger */
    private $logger;
    /** @var LoggerWrapper */
    private $sut;

    protected function setUp()
    {
        parent::setUp();

        $this->logger = $this->getMockBuilder('\Logger')->disableOriginalConstructor()->getMock();
        
        $this->sut = new LoggerWrapper($this->logger);
    }

    /**
     * @return array[]
     */
    public function dataLog()
    {
        return array(
            'emergency' => array('emergency', \LoggerLevel::getLevelFatal()),
            'alert' => array('alert', \LoggerLevel::getLevelFatal()),
            'critical' => array('critical', \LoggerLevel::getLevelFatal()),
            'error' => array('error', \LoggerLevel::getLevelError()),
            'warning' => array('warning', \LoggerLevel::getLevelWarn()),
            'notice' => array('notice', \LoggerLevel::getLevelWarn()),
            'info' => array('info', \LoggerLevel::getLevelInfo()),
            'debug' => array('debug', \LoggerLevel::getLevelDebug()),
        );
    }

    /**
     * @dataProvider dataLog
     * @param string $method
     * @param string $level
     */
    public function testLog($method, $level)
    {
        $message = 'FooBar';
        $context = array('Foo' => 'Bar');
        
        $this->logger->expects(self::once())->method('log')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with($level, self::isType('string'));
        
        $this->sut->{$method}($message, $context);
    }
    
    public function testPsrLogLevelIsMapped()
    {
        $this->logger->expects(self::once())->method('log')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with(\LoggerLevel::getLevelFatal(), self::isType('string'));

        $this->sut->log(LogLevel::EMERGENCY, 'FooBar', array('Foo' => 'Bar'));
    }
    
    public function testInvalidLogLevelIsMappedToDefault()
    {
        $this->logger->expects(self::once())->method('log')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with(\LoggerLevel::getLevelError(), self::isType('string'));

        $this->sut->log('InvalidLevel', 'FooBar', array('Foo' => 'Bar'));
    }
    
    public function testLogExceptionViaRenderer()
    {
        \Logger::configure(array(
            'appenders' => array(
                'echo' => array(
                    'class' => '\LoggerAppenderEcho',
                ),
            ),
            'rootLogger' => array(
                'level' => 'ERROR',
                'appenders' => array(
                    'echo',
                ),
            ),
            'renderers' => array(
                'Exception' => array(
                    'renderedClass' => 'AbacaphiliacTest\PsrLog4Php\FooBar',
                    'renderingClass' => 'AbacaphiliacTest\PsrLog4Php\FooBarRenderer',
                ),
            ),
        ), new \LoggerConfiguratorDefault());
        
        $logger = \Logger::getLogger(__METHOD__);
        
        $sut = new LoggerWrapper($logger);
        
        ob_start();
        $sut->error(new FooBar('FizzBuzz'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $actual = ob_get_clean();
        
        self::assertEquals("ERROR - FizzBuzz\n", $actual);
    }
}


1			<?php
2
3			namespace AbacaphiliacTest\PsrLog4Php;
4
5			use Abacaphiliac\PsrLog4Php\LoggerWrapper;
6			use Psr\Log\LogLevel;
7
8			/**
9			* @covers \Abacaphiliac\PsrLog4Php\LoggerWrapper
10			*/
11			class LoggerWrapperTest extends \PHPUnit_Framework_TestCase
12			{
13			/** @var \PHPUnit_Framework_MockObject_MockObject\|\Logger */
14			private $logger;
15			/** @var LoggerWrapper */
16			private $sut;
17
18			protected function setUp()
19			{
20			parent::setUp();
21
22			$this->logger = $this->getMockBuilder('\Logger')->disableOriginalConstructor()->getMock();
23
24			$this->sut = new LoggerWrapper($this->logger);
25			}
26
27			/**
28			* @return array[]
29			*/
30			public function dataLog()
31			{
32			return array(
33			'emergency' => array('emergency', \LoggerLevel::getLevelFatal()),
34			'alert' => array('alert', \LoggerLevel::getLevelFatal()),
35			'critical' => array('critical', \LoggerLevel::getLevelFatal()),
36			'error' => array('error', \LoggerLevel::getLevelError()),
37			'warning' => array('warning', \LoggerLevel::getLevelWarn()),
38			'notice' => array('notice', \LoggerLevel::getLevelWarn()),
39			'info' => array('info', \LoggerLevel::getLevelInfo()),
40			'debug' => array('debug', \LoggerLevel::getLevelDebug()),
41			);
42			}
43
44			/**
45			* @dataProvider dataLog
46			* @param string $method
47			* @param string $level
48			*/
49			public function testLog($method, $level)
50			{
51			$message = 'FooBar';
52			$context = array('Foo' => 'Bar');
53
54			$this->logger->expects(self::once())->method('log')
			0 ignored issues – show Bug introduced 2016-07-28 02:03 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Logger`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
55			->with($level, self::isType('string'));
56
57			$this->sut->{$method}($message, $context);
58			}
59
60			public function testPsrLogLevelIsMapped()
61			{
62			$this->logger->expects(self::once())->method('log')
			0 ignored issues – show Bug introduced 2016-07-28 02:03 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Logger`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
63			->with(\LoggerLevel::getLevelFatal(), self::isType('string'));
64
65			$this->sut->log(LogLevel::EMERGENCY, 'FooBar', array('Foo' => 'Bar'));
66			}
67
68			public function testInvalidLogLevelIsMappedToDefault()
69			{
70			$this->logger->expects(self::once())->method('log')
			0 ignored issues – show Bug introduced 2016-07-28 02:03 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `Logger`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
71			->with(\LoggerLevel::getLevelError(), self::isType('string'));
72
73			$this->sut->log('InvalidLevel', 'FooBar', array('Foo' => 'Bar'));
74			}
75
76			public function testLogExceptionViaRenderer()
77			{
78			\Logger::configure(array(
79			'appenders' => array(
80			'echo' => array(
81			'class' => '\LoggerAppenderEcho',
82			),
83			),
84			'rootLogger' => array(
85			'level' => 'ERROR',
86			'appenders' => array(
87			'echo',
88			),
89			),
90			'renderers' => array(
91			'Exception' => array(
92			'renderedClass' => 'AbacaphiliacTest\PsrLog4Php\FooBar',
93			'renderingClass' => 'AbacaphiliacTest\PsrLog4Php\FooBarRenderer',
94			),
95			),
96			), new \LoggerConfiguratorDefault());
97
98			$logger = \Logger::getLogger(__METHOD__);
99
100			$sut = new LoggerWrapper($logger);
101
102			ob_start();
103			$sut->error(new FooBar('FizzBuzz'));
			0 ignored issues – show Documentation introduced 2016-07-28 02:03 UTC by Report Bug Copy Issue Report `new \AbacaphiliacTest\Ps...4Php\FooBar('FizzBuzz')` is of type `object<AbacaphiliacTest\PsrLog4Php\FooBar>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
104			$actual = ob_get_clean();
105
106			self::assertEquals("ERROR - FizzBuzz\n", $actual);
107			}
108			}
109

abacaphiliac / psr-log4php

Pull Request — master (#1)

LoggerWrapperTest::testPsrLogLevelIsMapped() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like