MAGETWO-92986: Write Logs for Failed Process of Generating Factories in Extensions

 - add logger to construct

Author: NadiyaS

lib/internal/Magento/Framework/Code/Generator.php

@@ -9,9 +9,9 @@
 use Magento\Framework\Code\Generator\EntityAbstract;
 use Magento\Framework\Code\Generator\Io;
 use Magento\Framework\ObjectManagerInterface;
-use Psr\Log\LoggerInterface;
 use Magento\Framework\Phrase;
 use Magento\Framework\Filesystem\Driver\File;
+use Psr\Log\LoggerInterface;
 
 class Generator
 {
@@ -41,19 +41,29 @@ class Generator
      */
     protected $objectManager;
 
+    /**
+     * Logger instance
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param Generator\Io $ioObject
      * @param array $generatedEntities
      * @param DefinedClasses $definedClasses
+     * @param LoggerInterface|null $logger
      */
     public function __construct(
         Io $ioObject = null,
         array $generatedEntities = [],
-        DefinedClasses $definedClasses = null
+        DefinedClasses $definedClasses = null,
+        LoggerInterface $logger = null
     ) {
         $this->_ioObject = $ioObject ?: new Io(new File());
         $this->definedClasses = $definedClasses ?: new DefinedClasses();
         $this->_generatedEntities = $generatedEntities;
+        $this->logger = $logger;
     }
 
     /**
@@ -114,15 +124,14 @@ public function generateClass($className)
             $this->tryToLoadSourceClass($className, $generator);
             if (!($file = $generator->generate())) {
                 /** @var $logger LoggerInterface */
-                $logger = $this->getObjectManager()->get(LoggerInterface::class);
                 $errors = $generator->getErrors();
                 $errors[] = 'Class ' . $className . ' generation error: The requested class did not generate properly, '
                     . 'because the \'generated\' directory permission is read-only. '
                     . 'If --- after running the \'bin/magento setup:di:compile\' CLI command when the \'generated\' '
                     . 'directory permission is set to write --- the requested class did not generate properly, then '
                     . 'you must add the generated class object to the signature of the related construct method, only.';
                 $message = implode(PHP_EOL, $errors);
-                $logger->critical($message);
+                $this->getLogger()->critical($message);
                 throw new \RuntimeException($message);
             }
             if (!$this->definedClasses->isClassLoadableFromMemory($className)) {
@@ -132,6 +141,19 @@ public function generateClass($className)
         }
     }
 
+    /**
+     * Retrieve logger
+     *
+     * @return LoggerInterface
+     */
+    private function getLogger()
+    {
+        if (!$this->logger) {
+            $this->logger = $this->getObjectManager()->get(LoggerInterface::class);
+        }
+        return $this->logger;
+    }
+
     /**
      * Create entity generator
      *

lib/internal/Magento/Framework/Code/Test/Unit/GeneratorTest.php

@@ -30,7 +30,7 @@ class GeneratorTest extends TestCase
      *
      * @var array
      */
-    protected $expectedEntities = [
+    private $expectedEntities = [
         'factory' => Factory::ENTITY_TYPE,
         'proxy' => Proxy::ENTITY_TYPE,
         'interceptor' => Interceptor::ENTITY_TYPE,
@@ -41,38 +41,46 @@ class GeneratorTest extends TestCase
      *
      * @var Generator
      */
-    protected $model;
+    private $model;
 
     /**
      * @var Io|Mock
      */
-    protected $ioObjectMock;
+    private $ioObjectMock;
 
     /**
      * @var DefinedClasses|Mock
      */
-    protected $definedClassesMock;
+    private $definedClassesMock;
+
+    /**
+     * @var LoggerInterface|Mock
+     */
+    private $loggerMock;
 
     protected function setUp()
     {
         $this->definedClassesMock = $this->createMock(DefinedClasses::class);
         $this->ioObjectMock = $this->getMockBuilder(Io::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $this->model = $this->buildModel(
+        $this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
+
+        $this->model = new Generator(
             $this->ioObjectMock,
             [
                 'factory' => Factory::class,
                 'proxy' => Proxy::class,
-                'interceptor' => Interceptor::class
+                'interceptor' => Interceptor::class,
             ],
-            $this->definedClassesMock
+            $this->definedClassesMock,
+            $this->loggerMock
         );
     }
 
     public function testGetGeneratedEntities()
     {
-        $this->model = $this->buildModel(
+        $this->model = new Generator(
             $this->ioObjectMock,
             ['factory', 'proxy', 'interceptor'],
             $this->definedClassesMock
@@ -149,7 +157,6 @@ public function testGenerateClassWithErrors()
         $entityGeneratorMock = $this->getMockBuilder(EntityAbstract::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $loggerMock = $this->createMock(LoggerInterface::class);
 
         $objectManagerMock->expects($this->once())
             ->method('create')
@@ -164,13 +171,10 @@ public function testGenerateClassWithErrors()
         $entityGeneratorMock->expects($this->once())
             ->method('generate')
             ->willReturn(false);
-        $objectManagerMock->expects($this->once())
-            ->method('get')
-            ->willReturn($loggerMock);
         $entityGeneratorMock->expects($this->once())
             ->method('getErrors')
             ->willReturn($errorMessages);
-        $loggerMock->expects($this->once())
+        $this->loggerMock->expects($this->once())
             ->method('critical')
             ->with($FinalErrorMessage);
         $this->model->setObjectManager($objectManagerMock);
@@ -220,17 +224,4 @@ public function generateValidClassDataProvider()
         }
         return $data;
     }
-
-    /**
-     * Build SUT object
-     *
-     * @param Io $ioObject
-     * @param array $generatedEntities
-     * @param DefinedClasses $definedClasses
-     * @return Generator
-     */
-    private function buildModel(Io $ioObject, array $generatedEntities, DefinedClasses $definedClasses)
-    {
-        return new Generator($ioObject, $generatedEntities, $definedClasses);
-    }
 }