Source of file LoggerBridgeTest.php
Size: 24,253 Bytes - Last Modified: 2021-12-24T06:35:34+00:00
/var/www/docs.ssmods.com/process/src/tests/Camspiers/LoggerBridge/LoggerBridgeTest.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852 | <?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') ) ); } } |