LoggerBridgeTest::getLoggerBridge() - Code Metrics - Inspection of "Added standard Scrutinizer config" - camspiers/silverstripe-loggerbridge - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#9)

by Helpful
created 2016-02-16 21:39 UTC
LoggerBridgeTest::getLoggerBridge() A

↳ Parent: LoggerBridgeTest
Complexity

Conditions	3
Paths	1
Size

Total Lines	16
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	1
Metric	Value
c	2
b	0
f	1
dl	0
loc	16
rs	9.4285
cc	3
eloc	12
nc	1
nop	4
<?php

namespace Camspiers\LoggerBridge;

/**
 * Class LoggerBridgeTest
 */
class LoggerBridgeTest extends \PHPUnit_Framework_TestCase
{
    /**
     * Set up the error_reporting before each tests
     */
    public function setUp()
    {
        error_reporting(E_ALL);
    }
    /**
     *
     */
    public function tearDown()
    {
        ini_set('display_errors', true);
        restore_error_handler();
        restore_exception_handler();
    }
    /**
     * Helper method to return a stub of a logger interface
     * @return \Psr\Log\LoggerInterface
     */
    public function getLoggerStub()
    {
        return $this->getMock('Psr\Log\LoggerInterface');
    }
    /**
     * Helper method to return a logger bridge
     * @param  null                     $methods
     * @param  \Psr\Log\LoggerInterface $logger

     * @param  bool                     $reportErrorsWhenNotLive
     * @param  null                     $reserveMemory
     * @return LoggerBridge
     */
    public function getLoggerBridge(
        $methods = null,
        $logger = null,
        $reportErrorsWhenNotLive = true,
        $reserveMemory = null
    ) {
        return $this->getMock(
            __NAMESPACE__ . '\\LoggerBridge',
            is_array($methods) ? array_merge(array('terminate'), $methods) : array('terminate'),
            array(
                $logger ? : $this->getLoggerStub(),
                $reportErrorsWhenNotLive,
                $reserveMemory
            )
        );
    }
    /**
     * A helper method to get a mock that doesn't call its constructor
     * @param $class
     * @return \PHPUnit_Framework_MockObject_MockObject
     */
    protected function getMockWithoutConstructor($class)
    {
        return $this->getMock(
            $class,
            array(),
            array(),
            '',
            false
        );
    }
    /**
     * Test that there the default error reporter returns correctly
     */
    public function testGetErrorReporter()
    {
        $this->assertInstanceOf(
            __NAMESPACE__ . '\\ErrorReporter\\DebugErrorReporter',
            $this->getLoggerBridge()->getErrorReporter()
        );
    }
    /**
     * Test that there the default env reporter returns correctly
     */
    public function testEnvReporter()
    {
        $this->assertInstanceOf(
            __NAMESPACE__ . '\\EnvReporter\\DirectorEnvReporter',
            $this->getLoggerBridge()->getEnvReporter()
        );
    }
    /**
     * Tests that the translation of the reserve memory occurs correctly
     */
    public function testSetReserveMemory()
    {
        $bridge = $this->getLoggerBridge();
        $bridge->setReserveMemory(1024);
        $this->assertEquals(1024, $bridge->getReserveMemory());
        $bridge->setReserveMemory('2K');
        $this->assertEquals(2 * 1024, $bridge->getReserveMemory());
        $bridge->setReserveMemory('2M');
        $this->assertEquals(2 * 1024 * 1024, $bridge->getReserveMemory());
        $bridge->setReserveMemory('2G');
        $this->assertEquals(2 * 1024 * 1024 * 1024, $bridge->getReserveMemory());
    }
    /**
     * Tests the general function of register
     */
    public function testRegisterGlobalHandlersGeneral()
    {
        $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter', array('isLive'));
        $bridge = $this->getLoggerBridge();
        $bridge->setEnvReporter($env);

        // Check that things aren't registered
        $this->assertNull($bridge->isRegistered());

        // Do the registration
        $bridge->registerGlobalHandlers();

        // Check that things registered
        $this->assertTrue($bridge->isRegistered());
    }
    /**
     * Test that the actual error handlers are registered once
     */
    public function testRegisterGlobalHandlersOnce()
    {
        $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter', array('isLive'));
        $bridge = $this->getLoggerBridge(
            array(
                'registerErrorHandler',
                'registerExceptionHandler',
                'registerFatalErrorHandler'
            )
        );
        $bridge->setEnvReporter($env);

        $bridge->expects($this->once())
            ->method('registerErrorHandler');

        $bridge->expects($this->once())
            ->method('registerExceptionHandler');

        $bridge->expects($this->once())
            ->method('registerFatalErrorHandler');

        $bridge->registerGlobalHandlers();
    }
    /**
     * Test that the actual error handlers are registered the correct number of times
     */
    public function testRegisterGlobalHandlersMultiple()
    {
        $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter', array('isLive'));
        $bridge = $this->getLoggerBridge(
            array(
                'registerErrorHandler',
                'registerExceptionHandler',
                'registerFatalErrorHandler'
            )
        );
        $bridge->setEnvReporter($env);

        $bridge->expects($this->exactly(2))
            ->method('registerErrorHandler');

        $bridge->expects($this->exactly(2))
            ->method('registerExceptionHandler');

        // We only expect the fatal handler to be registered once
        $bridge->expects($this->once())
            ->method('registerFatalErrorHandler');

        $bridge->registerGlobalHandlers();
        $bridge->deregisterGlobalHandlers();
        $bridge->registerGlobalHandlers();
    }
    /**
     * Test that the actual error handlers are attached
     */
    public function testRegisterGlobalHandlersAttached()
    {
        $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter', array('isLive'));
        $bridge = $this->getLoggerBridge();
        $bridge->setEnvReporter($env);

        $bridge->registerGlobalHandlers();

        $this->assertEquals(
            array(
                $bridge,
                'errorHandler'
            ),
            set_error_handler(
                function () {
                }
            )
        );

        $this->assertEquals(
            array(
                $bridge,
                'exceptionHandler'
            ),
            set_exception_handler(
                function () {
                }
            )
        );
    }
    /**
     * Test that memory is reserved
     */
    public function testRegisterGlobalHandlersIsSuhosinRelevant()
    {
        $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter', array('isLive'));

        $bridge = $this->getLoggerBridge(
            array(
                'isSuhosinRelevant',
                'ensureSuhosinMemory'
            )
        );

        $bridge->expects($this->any())
            ->method('isSuhosinRelevant')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('ensureSuhosinMemory');

        $bridge->setEnvReporter($env);

        $bridge->registerGlobalHandlers();
    }
    /**
     *
     */
    public function testErrorHandlerError()
    {
        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        // isLive won't be called because reportErrorsWhenNotLive is true
        $env->expects($this->never())
            ->method('isLive')
            ->will($this->returnValue(true));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $reporter->expects($this->once())
            ->method('reportError');

        $logger->expects($this->once())

            ->method('error')
            ->with(
                $errstr = 'error string',
                $this->logicalAnd(
                    $this->contains($errfile = 'somefile'),
                    $this->contains($errline = 0),
                    $this->contains('')
                )
            );

        $bridge->errorHandler(
            E_USER_ERROR,
            $errstr,
            $errfile,
            $errline
        );
    }
    /**
     * Tests how the error handler calls warning errors
     */
    public function testErrorHandlerWarning()
    {
        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        // isLive won't be called because reportErrorsWhenNotLive is true
        $env->expects($this->never())
            ->method('isLive')
            ->will($this->returnValue(true));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $logger->expects($this->once())

            ->method('warning')
            ->with(
                $errstr = 'error string',
                $this->logicalAnd(
                    $this->contains($errfile = 'somefile'),
                    $this->contains($errline = 0),
                    $this->contains('')
                )
            );

        $bridge->errorHandler(
            E_USER_WARNING,
            $errstr,
            $errfile,
            $errline
        );
    }
    /**
     * Tests error_reporting level
     */
    public function testErrorHandlerEnvironmentReporting()
    {
        // Set error reporting type
        error_reporting(E_ALL & ~E_USER_WARNING);

        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        // We expect the report to never happen because the environment reporting is
        // E_ALL & ~E_USER_WARNING
        $reporter->expects($this->never())
            ->method('reportError');

        $logger->expects($this->once())

            ->method('warning')
            ->with(
                $errstr = 'error string',
                $this->logicalAnd(
                    $this->contains($errfile = 'somefile'),
                    $this->contains($errline = 0),
                    $this->contains('')
                )
            );

        $bridge->errorHandler(
            E_USER_WARNING,
            $errstr,
            $errfile,
            $errline
        );
    }
    public function testErrorHandlerSuppression()
    {
        // Set error reporting type
        error_reporting(0);

        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $reporter->expects($this->never())
            ->method('reportError');

        $logger->expects($this->never())

            ->method('warning');

        $bridge->errorHandler(
            E_USER_WARNING,
            '',
            'fake/file/path',
            1
        );
    }
    /**
     * Tests error reporting we not live and we request no display
     */
    public function testErrorHandlerNotLiveNoDisplay()
    {
        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub(),
            false
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->once())
            ->method('isLive')
            ->will($this->returnValue(false));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        // We expect the report to never happen because we are not live && reportErrorsWhenNotLive is false
        $reporter->expects($this->never())
            ->method('reportError');

        $logger->expects($this->once())

            ->method('error');

        $bridge->errorHandler(
            E_USER_ERROR,
            '',
            'fake/file/path',
            1
        );
    }

    public function testFatalErrorHandlerNotRegistered()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'restoreMemory'
            ),
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(false));

        // We expect the log to never happen
        $logger->expects($this->never())

            ->method('critical');

        // We expect the report to never happen
        $reporter->expects($this->never())
            ->method('reportError');

        $bridge->fatalHandler();
    }

    public function testFatalErrorHandlerNotFatal()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'getLastError',
                'restoreMemory'
            ),
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('getLastError')
            ->will($this->returnValue(false));

        // We expect the log to never happen
        $logger->expects($this->never())

            ->method('critical');

        // We expect the report to never happen
        $reporter->expects($this->never())
            ->method('reportError');

        $bridge->fatalHandler();
    }

    public function testFatalErrorHandlerNoReport()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'getLastError',
                'restoreMemory'
            ),
            $logger = $this->getLoggerStub(),
            false
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->once())
            ->method('isLive')
            ->will($this->returnValue(false));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('getLastError')
            ->will(
                $this->returnValue(
                    array(
                        'type'    => E_CORE_ERROR,
                        'message' => 'Test',
                        'file'    => 'file',
                        'line'    => 0
                    )
                )
            );

        // We expect the log to never happen
        $logger->expects($this->once())

            ->method('critical')
            ->with(
                'Test',
                $this->logicalAnd(
                    $this->contains('file'),
                    $this->contains('line')
                )
            );

        // We expect the report to never happen
        $reporter->expects($this->never())
            ->method('reportError');

        $bridge->fatalHandler();
    }

    public function testFatalErrorHandlerReportDueToLive()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'getLastError',
                'restoreMemory'
            ),
            $logger = $this->getLoggerStub(),
            false
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->once())
            ->method('isLive')
            ->will($this->returnValue(true));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('getLastError')
            ->will(
                $this->returnValue(
                    array(
                        'type'    => E_ERROR,
                        'message' => 'Test',
                        'file'    => 'file',
                        'line'    => 0
                    )
                )
            );

        // We expect the log to never happen
        $logger->expects($this->once())

            ->method('critical')
            ->with(
                'Test',
                $this->logicalAnd(
                    $this->contains('file'),
                    $this->contains('line')
                )
            );

        // We expect the report to never happen
        $reporter->expects($this->once())
            ->method('reportError');

        $bridge->fatalHandler();
    }

    public function testFatalErrorHandlerReport()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'getLastError',
                'restoreMemory'
            ),
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('getLastError')
            ->will(
                $this->returnValue(
                    array(
                        'type'    => E_ERROR,
                        'message' => 'Test',
                        'file'    => 'file',
                        'line'    => 0
                    )
                )
            );

        // We expect the log to happen once
        $logger->expects($this->once())

            ->method('critical')
            ->with(
                'Test',
                $this->logicalAnd($this->contains('file'), $this->contains('line'))
            );

        // We expect the report to never happen
        $reporter->expects($this->once())
            ->method('reportError');

        $bridge->fatalHandler();
    }

    public function testFatalErrorHandlerPreserveMemory()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'isRegistered',
                'getLastError',
                'changeMemoryLimit'
            )
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('isRegistered')
            ->will($this->returnValue(true));

        $bridge->expects($this->once())
            ->method('getLastError')
            ->will(
                $this->returnValue(
                    array(
                        'type'    => E_ERROR,
                        'message' => 'memory exhausted',
                        'file'    => 'file',
                        'line'    => 0
                    )
                )
            );

        $bridge->expects($this->once())
            ->method('changeMemoryLimit')
            ->with($bridge->getReserveMemory());

        $bridge->fatalHandler();
    }

    public function testExceptionHandler()
    {
        $bridge = $this->getLoggerBridge(
            null,
            $logger = $this->getLoggerStub()
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->never())
            ->method('isLive');

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $reporter->expects($this->once())
            ->method('reportError');

        $exception = new \Exception('Message');

        $logger->expects($this->once())

            ->method('error')
            ->with(
                'Uncaught Exception: Message',
                $this->logicalAnd(
                    $this->contains($exception->getFile()),
                    $this->contains($exception->getLine())
                )
            );

        $bridge->exceptionHandler($exception);
    }

    public function testExceptionHandlerNoReport()
    {
        $bridge = $this->getLoggerBridge(
            null,
            null,
            false
        );

        $bridge->setEnvReporter(
            $env = $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $env->expects($this->once())
            ->method('isLive')
            ->will($this->returnValue(false));

        $bridge->setErrorReporter(
            $reporter = $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $reporter->expects($this->never())
            ->method('reportError');

        $bridge->exceptionHandler(new \Exception('Message'));
    }

    public function testPreRequest()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'registerGlobalHandlers'
            )
        );

        $bridge->setEnvReporter(
            $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $bridge->setErrorReporter(
            $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('registerGlobalHandlers');

        $this->assertTrue(
            $bridge->preRequest(
                $this->getMockWithoutConstructor('SS_HTTPRequest'),
                $this->getMockWithoutConstructor('Session'),
                $this->getMockWithoutConstructor('DataModel')
            )
        );
    }

    public function testPostRequest()
    {
        $bridge = $this->getLoggerBridge(
            array(
                'deregisterGlobalHandlers'
            )
        );

        $bridge->setEnvReporter(
            $this->getMock(__NAMESPACE__ . '\\EnvReporter\\EnvReporter')
        );

        $bridge->setErrorReporter(
            $this->getMock(__NAMESPACE__ . '\\ErrorReporter\\ErrorReporter')
        );

        $bridge->expects($this->once())
            ->method('deregisterGlobalHandlers');

        $this->assertTrue(
            $bridge->postRequest(
                $this->getMockWithoutConstructor('SS_HTTPRequest'),
                $this->getMockWithoutConstructor('SS_HTTPResponse'),
                $this->getMockWithoutConstructor('DataModel')
            )
        );
    }
}

1			<?php
2
3			namespace Camspiers\LoggerBridge;
4
5			/**
6			* Class LoggerBridgeTest
7			*/
8			class LoggerBridgeTest extends \PHPUnit_Framework_TestCase
9			{
10			/**
11			* Set up the error_reporting before each tests
12			*/
13			public function setUp()
14			{
15			error_reporting(E_ALL);
16			}
17			/**
18			*
19			*/
20			public function tearDown()
21			{
22			ini_set('display_errors', true);
23			restore_error_handler();
24			restore_exception_handler();
25			}
26			/**
27			* Helper method to return a stub of a logger interface
28			* @return \Psr\Log\LoggerInterface
29			*/
30			public function getLoggerStub()
31			{
32			return $this->getMock('Psr\Log\LoggerInterface');
33			}
34			/**
35			* Helper method to return a logger bridge
36			* @param null $methods
37			* @param \Psr\Log\LoggerInterface $logger
			0 ignored issues – show Documentation introduced 2016-02-16 21:48 UTC by Report Bug Copy Issue Report Should the type for parameter `$logger` not be `\Psr\Log\LoggerInterface\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
38			* @param bool $reportErrorsWhenNotLive
39			* @param null $reserveMemory
camspiers / silverstripe-loggerbridge

GitHub Access Token became invalid

Pull Request — master (#9)

LoggerBridgeTest::getLoggerBridge() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
