Merge remote-tracking branch 'falcons/MAGETWO-55429' into MAGETWO-69983

Author: Bohdan Korablov

lib/internal/Magento/Framework/Logger/Handler/System.php

@@ -41,20 +41,21 @@ public function __construct(
     }
 
     /**
-     * @{inheritDoc}
+     * Writes formatted record through the handler.
      *
-     * @param $record array
+     * @param $record array The record metadata
      * @return void
      */
     public function write(array $record)
     {
-        if (isset($record['context']['is_exception']) && $record['context']['is_exception']) {
-            unset($record['context']['is_exception']);
+        if (isset($record['context']['exception'])) {
             $this->exceptionHandler->handle($record);
-        } else {
-            unset($record['context']['is_exception']);
-            $record['formatted'] = $this->getFormatter()->format($record);
-            parent::write($record);
+
+            return;
         }
+
+        $record['formatted'] = $this->getFormatter()->format($record);
+
+        parent::write($record);
     }
 }

lib/internal/Magento/Framework/Logger/Monolog.php

@@ -33,7 +33,18 @@ public function __construct($name, array $handlers = [], array $processors = [])
      */
     public function addRecord($level, $message, array $context = [])
     {
-        $context['is_exception'] = $message instanceof \Exception;
+        /**
+         * To preserve compatibility with Exception messages.
+         * And support PSR-3 context standard.
+         *
+         * @link http://www.php-fig.org/psr/psr-3/#context PSR-3 context standard
+         */
+        if ($message instanceof \Exception && !isset($context['exception'])) {
+            $context['exception'] = $message;
+        }
+
+        $message = $message instanceof \Exception ? $message->getMessage() : $message;
+
         return parent::addRecord($level, $message, $context);
     }
 }

lib/internal/Magento/Framework/Logger/Test/Unit/Handler/SystemTest.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Logger\Test\Unit\Handler;
+
+use Magento\Framework\Filesystem\DriverInterface;
+use Magento\Framework\Logger\Handler\Exception;
+use Magento\Framework\Logger\Handler\System;
+use Monolog\Logger;
+use PHPUnit_Framework_MockObject_MockObject as Mock;
+
+class SystemTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var System
+     */
+    private $model;
+
+    /**
+     * @var DriverInterface|Mock
+     */
+    private $filesystemMock;
+
+    /**
+     * @var Exception|Mock
+     */
+    private $exceptionHandlerMock;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        $this->filesystemMock = $this->getMockBuilder(DriverInterface::class)
+            ->getMockForAbstractClass();
+        $this->exceptionHandlerMock = $this->getMockBuilder(Exception::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->model = new System(
+            $this->filesystemMock,
+            $this->exceptionHandlerMock
+        );
+    }
+
+    public function testWrite()
+    {
+        $this->filesystemMock->expects($this->once())
+            ->method('getParentDirectory');
+        $this->filesystemMock->expects($this->once())
+            ->method('isDirectory')
+            ->willReturn('true');
+
+        $this->model->write($this->getRecord());
+    }
+
+    public function testWriteException()
+    {
+        $record = $this->getRecord();
+        $record['context']['exception'] = new \Exception('Some exception');
+
+        $this->exceptionHandlerMock->expects($this->once())
+            ->method('handle')
+            ->with($record);
+        $this->filesystemMock->expects($this->never())
+            ->method('getParentDirectory');
+
+        $this->model->write($record);
+    }
+
+    /**
+     * @param int $level
+     * @param string $message
+     * @param array $context
+     * @return array
+     */
+    private function getRecord($level = Logger::WARNING, $message = 'test', $context = [])
+    {
+        return [
+            'message' => $message,
+            'context' => $context,
+            'level' => $level,
+            'level_name' => Logger::getLevelName($level),
+            'channel' => 'test',
+            'datetime' => \DateTime::createFromFormat('U.u', sprintf('%.6F', microtime(true))),
+            'extra' => [],
+        ];
+    }
+}

lib/internal/Magento/Framework/Logger/Test/Unit/MonologTest.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Logger\Test\Unit;
+
+use Magento\Framework\Logger\Monolog;
+use Monolog\Handler\TestHandler;
+
+class MonologTest extends \PHPUnit_Framework_TestCase
+{
+    public function testAddRecord()
+    {
+        $logger = new Monolog(__METHOD__);
+        $handler = new TestHandler();
+
+        $logger->pushHandler($handler);
+
+        $logger->addError('test');
+        list($record) = $handler->getRecords();
+
+        $this->assertSame('test', $record['message']);
+    }
+
+    public function testAddRecordAsException()
+    {
+        $logger = new Monolog(__METHOD__);
+        $handler = new TestHandler();
+
+        $logger->pushHandler($handler);
+
+        $logger->addError(new \Exception('Some exception'));
+        list($record) = $handler->getRecords();
+
+        $this->assertInstanceOf(\Exception::class, $record['context']['exception']);
+        $this->assertSame('Some exception', $record['message']);
+    }
+}