Add PHPConsoleHandler to debug in Google Chrome

Integrates Monolog with very popular Google Chrome extension "PHP Console" https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef and server library https://github.com/barbushin/php-console. PHPConsoleHandler and "PHP Console" server library code are 100% covered by tests.

1 files changed, 271 insertions, 0 deletions

diff --git a/tests/Monolog/Handler/PHPConsoleHandlerTest.php b/tests/Monolog/Handler/PHPConsoleHandlerTest.php
new file mode 100644
index 0000000..81684c5
--- /dev/null
+++ b/tests/Monolog/Handler/PHPConsoleHandlerTest.php
@@ -0,0 +1,271 @@
+<?php
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Monolog\Handler;
+
+use Exception;
+use Monolog\ErrorHandler;
+use Monolog\Logger;
+use Monolog\TestCase;
+use PhpConsole\Connector;
+use PhpConsole\Dispatcher\Debug as DebugDispatcher;
+use PhpConsole\Dispatcher\Errors as ErrorDispatcher;
+use PhpConsole\Handler;
+use PHPUnit_Framework_MockObject_MockObject;
+
+/**
+ * @covers Monolog\Handler\PHPConsoleHandler
+ * @author Sergey Barbushin https://www.linkedin.com/in/barbushin
+ */
+class PHPConsoleHandlerTest extends TestCase
+{
+
+    /** @var  Connector|PHPUnit_Framework_MockObject_MockObject */
+    protected $connector;
+    /** @var  DebugDispatcher|PHPUnit_Framework_MockObject_MockObject */
+    protected $debugDispatcher;
+    /** @var  ErrorDispatcher|PHPUnit_Framework_MockObject_MockObject */
+    protected $errorDispatcher;
+
+    protected function setUp()
+    {
+        if (!class_exists('PhpConsole\Connector')) {
+            $this->markTestSkipped('PHP Console library not found. See https://github.com/barbushin/php-console#installation');
+        }
+        $this->connector = $this->initConnectorMock();
+
+        $this->debugDispatcher = $this->initDebugDispatcherMock($this->connector);
+        $this->connector->setDebugDispatcher($this->debugDispatcher);
+
+        $this->errorDispatcher = $this->initErrorDispatcherMock($this->connector);
+        $this->connector->setErrorsDispatcher($this->errorDispatcher);
+    }
+
+    protected function initDebugDispatcherMock(Connector $connector)
+    {
+        return $this->getMockBuilder('PhpConsole\Dispatcher\Debug')
+            ->disableOriginalConstructor()
+            ->setMethods(array('dispatchDebug'))
+            ->setConstructorArgs(array($connector, $connector->getDumper()))
+            ->getMock();
+    }
+
+    protected function initErrorDispatcherMock(Connector $connector)
+    {
+        return $this->getMockBuilder('PhpConsole\Dispatcher\Errors')
+            ->disableOriginalConstructor()
+            ->setMethods(array('dispatchError', 'dispatchException'))
+            ->setConstructorArgs(array($connector, $connector->getDumper()))
+            ->getMock();
+    }
+
+    protected function initConnectorMock()
+    {
+        $connector = $this->getMockBuilder('PhpConsole\Connector')
+            ->disableOriginalConstructor()
+            ->setMethods(array(
+                'sendMessage',
+                'onShutDown',
+                'isActiveClient',
+                'setSourcesBasePath',
+                'setServerEncoding',
+                'setPassword',
+                'enableSslOnlyMode',
+                'setAllowedIpMasks',
+                'setHeadersLimit',
+                'startEvalRequestsListener',
+            ))
+            ->getMock();
+
+        $connector->expects($this->any())
+            ->method('isActiveClient')
+            ->will($this->returnValue(true));
+
+        return $connector;
+    }
+
+    protected function getHandlerDefaultOption($name)
+    {
+        $handler = new PHPConsoleHandler(array(), $this->connector);
+        $options = $handler->getOptions();
+
+        return $options[$name];
+    }
+
+    protected function initLogger($handlerOptions = array(), $level = Logger::DEBUG)
+    {
+        return new Logger('test', array(
+            new PHPConsoleHandler($handlerOptions, $this->connector, $level)
+        ));
+    }
+
+    public function testInitWithDefaultConnector()
+    {
+        $handler = new PHPConsoleHandler();
+        $this->assertEquals(spl_object_hash(Connector::getInstance()), spl_object_hash($handler->getConnector()));
+    }
+
+    public function testInitWithCustomConnector()
+    {
+        $handler = new PHPConsoleHandler(array(), $this->connector);
+        $this->assertEquals(spl_object_hash($this->connector), spl_object_hash($handler->getConnector()));
+    }
+
+    public function testDebug()
+    {
+        $this->debugDispatcher->expects($this->once())->method('dispatchDebug')->with($this->equalTo('test'));
+        $this->initLogger()->addDebug('test');
+    }
+
+    public function testDebugContextInMessage()
+    {
+        $message = 'test';
+        $tag = 'tag';
+        $context = array($tag, 'custom' => mt_rand());
+        $expectedMessage = $message . ' ' . json_encode(array_slice($context, 1));
+        $this->debugDispatcher->expects($this->once())->method('dispatchDebug')->with(
+            $this->equalTo($expectedMessage),
+            $this->equalTo($tag)
+        );
+        $this->initLogger()->addDebug($message, $context);
+    }
+
+    public function testDebugTags($tagsContextKeys = null)
+    {
+        $expectedTags = mt_rand();
+        $logger = $this->initLogger($tagsContextKeys ? array('debugTagsKeysInContext' => $tagsContextKeys) : array());
+        if (!$tagsContextKeys) {
+            $tagsContextKeys = $this->getHandlerDefaultOption('debugTagsKeysInContext');
+        }
+        foreach ($tagsContextKeys as $key) {
+            $debugDispatcher = $this->initDebugDispatcherMock($this->connector);
+            $debugDispatcher->expects($this->once())->method('dispatchDebug')->with(
+                $this->anything(),
+                $this->equalTo($expectedTags)
+            );
+            $this->connector->setDebugDispatcher($debugDispatcher);
+            $logger->addDebug('test', array($key => $expectedTags));
+        }
+    }
+
+    public function testError($classesPartialsTraceIgnore = null)
+    {
+        $code = E_USER_NOTICE;
+        $message = 'message';
+        $file = __FILE__;
+        $line = __LINE__;
+        $this->errorDispatcher->expects($this->once())->method('dispatchError')->with(
+            $this->equalTo($code),
+            $this->equalTo($message),
+            $this->equalTo($file),
+            $this->equalTo($line),
+            $classesPartialsTraceIgnore ?: $this->equalTo($this->getHandlerDefaultOption('classesPartialsTraceIgnore'))
+        );
+        $errorHandler = ErrorHandler::register($this->initLogger($classesPartialsTraceIgnore ? array('classesPartialsTraceIgnore' => $classesPartialsTraceIgnore) : array()), false);
+        $errorHandler->registerErrorHandler(array(), false, E_USER_WARNING);
+        $errorHandler->handleError($code, $message, $file, $line);
+    }
+
+    public function testException()
+    {
+        $exception = new Exception();
+        $this->errorDispatcher->expects($this->once())->method('dispatchException')->with(
+            $this->equalTo($exception)
+        );
+        $errorHandler = ErrorHandler::register($this->initLogger(), false, false);
+        $errorHandler->registerExceptionHandler(null, false);
+        $errorHandler->handleException($exception);
+    }
+
+    /**
+     * @expectedException Exception
+     */
+    public function testWrongOptionsThrowsException()
+    {
+        new PHPConsoleHandler(array('xxx' => 1));
+    }
+
+    public function testOptionEnabled()
+    {
+        $this->debugDispatcher->expects($this->never())->method('dispatchDebug');
+        $this->initLogger(array('enabled' => false))->addDebug('test');
+    }
+
+    public function testOptionClassesPartialsTraceIgnore()
+    {
+        $this->testError(array('Class', 'Namespace\\'));
+    }
+
+    public function testOptionDebugTagsKeysInContext()
+    {
+        $this->testDebugTags(array('key1', 'key2'));
+    }
+
+    public function testOptionUseOwnErrorsAndExceptionsHandler()
+    {
+        $this->initLogger(array('useOwnErrorsHandler' => true, 'useOwnExceptionsHandler' => true));
+        $this->assertEquals(array(Handler::getInstance(), 'handleError'), set_error_handler(function () {
+        }));
+        $this->assertEquals(array(Handler::getInstance(), 'handleException'), set_exception_handler(function () {
+        }));
+    }
+
+    public static function provideConnectorMethodsOptionsSets()
+    {
+        return array(
+            array('sourcesBasePath', 'setSourcesBasePath', __DIR__),
+            array('serverEncoding', 'setServerEncoding', 'cp1251'),
+            array('password', 'setPassword', '******'),
+            array('enableSslOnlyMode', 'enableSslOnlyMode', true, false),
+            array('ipMasks', 'setAllowedIpMasks', array('127.0.0.*')),
+            array('headersLimit', 'setHeadersLimit', 2500),
+            array('enableEvalListener', 'startEvalRequestsListener', true, false),
+        );
+    }
+
+    /**
+     * @dataProvider provideConnectorMethodsOptionsSets
+     */
+    public function testOptionCallsConnectorMethod($option, $method, $value, $isArgument = true)
+    {
+        $expectCall = $this->connector->expects($this->once())->method($method);
+        if ($isArgument) {
+            $expectCall->with($value);
+        }
+        new PHPConsoleHandler(array($option => $value), $this->connector);
+    }
+
+    public function testOptionDetectDumpTraceAndSource()
+    {
+        new PHPConsoleHandler(array('detectDumpTraceAndSource' => true), $this->connector);
+        $this->assertTrue($this->connector->getDebugDispatcher()->detectTraceAndSource);
+    }
+
+    public static function provideDumperOptionsValues()
+    {
+        return array(
+            array('dumperLevelLimit', 'levelLimit', 1001),
+            array('dumperItemsCountLimit', 'itemsCountLimit', 1002),
+            array('dumperItemSizeLimit', 'itemSizeLimit', 1003),
+            array('dumperDumpSizeLimit', 'dumpSizeLimit', 1004),
+            array('dumperDetectCallbacks', 'detectCallbacks', true),
+        );
+    }
+
+    /**
+     * @dataProvider provideDumperOptionsValues
+     */
+    public function testDumperOptions($option, $dumperProperty, $value)
+    {
+        new PHPConsoleHandler(array($option => $value), $this->connector);
+        $this->assertEquals($value, $this->connector->getDumper()->$dumperProperty);
+    }
+}