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

Author: Yevhen Miroshnychenko

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

@@ -7,7 +7,11 @@
 
 use Magento\Framework\Code\Generator\DefinedClasses;
 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;
 
 class Generator
 {
@@ -18,7 +22,7 @@ class Generator
     const GENERATION_SKIP = 'skip';
 
     /**
-     * @var \Magento\Framework\Code\Generator\Io
+     * @var Io
      */
     protected $_ioObject;
 
@@ -33,24 +37,21 @@ class Generator
     protected $definedClasses;
 
     /**
-     * @var \Magento\Framework\ObjectManagerInterface
+     * @var ObjectManagerInterface
      */
     protected $objectManager;
 
     /**
-     * @param Generator\Io   $ioObject
-     * @param array          $generatedEntities
+     * @param Generator\Io $ioObject
+     * @param array $generatedEntities
      * @param DefinedClasses $definedClasses
      */
     public function __construct(
-        \Magento\Framework\Code\Generator\Io $ioObject = null,
+        Io $ioObject = null,
         array $generatedEntities = [],
         DefinedClasses $definedClasses = null
     ) {
-        $this->_ioObject = $ioObject
-            ?: new \Magento\Framework\Code\Generator\Io(
-                new \Magento\Framework\Filesystem\Driver\File()
-            );
+        $this->_ioObject = $ioObject ?: new Io(new File());
         $this->definedClasses = $definedClasses ?: new DefinedClasses();
         $this->_generatedEntities = $generatedEntities;
     }
@@ -132,7 +133,7 @@ public function generateClass($className)
      * @param string $generatorClass
      * @param string $entityName
      * @param string $className
-     * @return \Magento\Framework\Code\Generator\EntityAbstract
+     * @return EntityAbstract
      */
     protected function createGeneratorInstance($generatorClass, $entityName, $className)
     {
@@ -145,10 +146,10 @@ protected function createGeneratorInstance($generatorClass, $entityName, $classN
     /**
      * Set object manager instance.
      *
-     * @param \Magento\Framework\ObjectManagerInterface $objectManager
+     * @param ObjectManagerInterface $objectManager
      * @return $this
      */
-    public function setObjectManager(\Magento\Framework\ObjectManagerInterface $objectManager)
+    public function setObjectManager(ObjectManagerInterface $objectManager)
     {
         $this->objectManager = $objectManager;
         return $this;
@@ -157,11 +158,11 @@ public function setObjectManager(\Magento\Framework\ObjectManagerInterface $obje
     /**
      * Get object manager instance.
      *
-     * @return \Magento\Framework\ObjectManagerInterface
+     * @return ObjectManagerInterface
      */
     public function getObjectManager()
     {
-        if (!($this->objectManager instanceof \Magento\Framework\ObjectManagerInterface)) {
+        if (!($this->objectManager instanceof ObjectManagerInterface)) {
             throw new \LogicException(
                 "Object manager was expected to be set using setObjectManger() "
                 . "before getObjectManager() invocation."
@@ -174,7 +175,7 @@ public function getObjectManager()
      * Try to load/generate source class to check if it is valid or not.
      *
      * @param string $className
-     * @param \Magento\Framework\Code\Generator\EntityAbstract $generator
+     * @param EntityAbstract $generator
      * @return void
      * @throws \RuntimeException
      */
@@ -183,7 +184,7 @@ protected function tryToLoadSourceClass($className, $generator)
         $sourceClassName = $generator->getSourceClassName();
         if (!$this->definedClasses->isClassLoadable($sourceClassName)) {
             if ($this->generateClass($sourceClassName) !== self::GENERATION_SUCCESS) {
-                $phrase = new \Magento\Framework\Phrase(
+                $phrase = new Phrase(
                     'Source class "%1" for "%2" generation does not exist.',
                     [$sourceClassName, $className]
                 );

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

@@ -112,8 +112,8 @@ public function generate()
         } catch (FileSystemException $e) {
             $message = 'Error: an object of a generated class may be a dependency for another object, but this '
                 . 'dependency has not been defined or set correctly in the signature of the related construct method. '
-                . 'Due to the current error, executing the CLI commands `bin/magento setup:di:compile` or `bin/magento'
-                . ' deploy:mode:set production` does not create the required generated classes. '
+                . 'Due to the current error, executing the CLI commands `bin/magento setup:di:compile` or `bin/magento '
+                . 'deploy:mode:set production` does not create the required generated classes. '
                 . 'Magento cannot write a class file to the "generated" directory that is read-only. Before using the '
                 . 'read-only file system, the classes to be generated must be created beforehand in the "generated" '
                 . 'directory. For details, see the "File systems access permissions" topic '

lib/internal/Magento/Framework/Code/Test/Unit/Generator/EntityAbstractTest.php

@@ -14,6 +14,7 @@
 use Magento\Framework\Code\Generator\Io;
 use Magento\Framework\Code\Generator\ClassGenerator;
 use Magento\Framework\Code\Generator\DefinedClasses;
+use \PHPUnit_Framework_MockObject_MockObject as Mock;
 
 class EntityAbstractTest extends TestCase
 {
@@ -43,7 +44,7 @@ class EntityAbstractTest extends TestCase
     /**
      * Model under test
      *
-     * @var \Magento\Framework\Code\Generator\EntityAbstract| \PHPUnit_Framework_MockObject_MockObject
+     * @var EntityAbstract|Mock
      */
     protected $_model;
 
@@ -75,22 +76,11 @@ public function testConstruct()
         $this->assertAttributeEmpty('_sourceClassName', $this->_model);
         $this->assertAttributeEmpty('_resultClassName', $this->_model);
         $this->assertAttributeInstanceOf(Io::class, '_ioObject', $this->_model);
-        $this->assertAttributeInstanceOf(
-            ClassGenerator::class,
-            '_classGenerator',
-            $this->_model
-        );
-        $this->assertAttributeInstanceOf(
-            DefinedClasses::class,
-            'definedClasses',
-            $this->_model
-        );
+        $this->assertAttributeInstanceOf(ClassGenerator::class, '_classGenerator', $this->_model);
+        $this->assertAttributeInstanceOf(DefinedClasses::class, 'definedClasses', $this->_model);
 
         // with source class name
-        $this->_model = $this->getMockForAbstractClass(
-            EntityAbstract::class,
-            [$this->sourceClass]
-        );
+        $this->_model = $this->getMockForAbstractClass(EntityAbstract::class, [$this->sourceClass]);
         $this->assertAttributeEquals($this->sourceClass, '_sourceClassName', $this->_model);
         $this->assertAttributeEquals($this->sourceClass . 'Abstract', '_resultClassName', $this->_model);
 
@@ -163,17 +153,17 @@ public function generateDataProvider()
      * @param bool $willWriteCode
      *
      * @dataProvider generateDataProvider
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::generate
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::getErrors
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::getSourceClassName
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_getResultClassName
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_getDefaultResultClassName
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_generateCode
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_addError
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_validateData
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_getClassDocBlock
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_getGeneratedCode
-     * @covers \Magento\Framework\Code\Generator\EntityAbstract::_fixCodeStyle
+     * @covers EntityAbstract::generate
+     * @covers EntityAbstract::getErrors
+     * @covers EntityAbstract::getSourceClassName
+     * @covers EntityAbstract::_getResultClassName
+     * @covers EntityAbstract::_getDefaultResultClassName
+     * @covers EntityAbstract::_generateCode
+     * @covers EntityAbstract::_addError
+     * @covers EntityAbstract::_validateData
+     * @covers EntityAbstract::_getClassDocBlock
+     * @covers EntityAbstract::_getGeneratedCode
+     * @covers EntityAbstract::_fixCodeStyle
      */
     public function testGenerate(
         $errors = [],
@@ -238,7 +228,7 @@ public function testGenerateFailure()
 
         $arguments = $this->_prepareMocksForGenerateCode(true);
 
-        /** @var \Magento\Framework\Code\Generator\Io|\PHPUnit_Framework_MockObject_MockObject $ioObjectMock */
+        /** @var Io|Mock $ioObjectMock */
         $ioObjectMock = $arguments['io_object'];
         $ioObjectMock->expects($this->once())
             ->method('writeResultFile')
@@ -344,7 +334,7 @@ protected function _prepareMocksForGenerateCode($willWriteCode)
             ->will($this->returnValue($willWriteCode ? self::RESULT_CODE : null));
 
         // Add configuration for the generation step
-        /** @var $ioObject \PHPUnit_Framework_MockObject_MockObject */
+        /** @var Io|Mock $ioObject */
         $ioObject = $mocks['io_object'];
         if ($willWriteCode) {
             $ioObject->expects($this->once())->method('writeResultFile')->with(self::RESULT_FILE, self::RESULT_CODE);

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

@@ -49,7 +49,7 @@ class GeneratorTest extends TestCase
     protected $ioObjectMock;
 
     /**
-     * @var DefinedClasses | Mock
+     * @var DefinedClasses|Mock
      */
     protected $definedClassesMock;
 
@@ -81,6 +81,8 @@ public function testGetGeneratedEntities()
     }
 
     /**
+     * @param string $className
+     * @param string $entityType
      * @expectedException \RuntimeException
      * @dataProvider generateValidClassDataProvider
      */
@@ -134,7 +136,9 @@ public function testGenerateClassWithErrors()
         ];
         $expectedEntities = array_values($this->expectedEntities);
         $resultClassName = self::SOURCE_CLASS . ucfirst(array_shift($expectedEntities));
+        /** @var ObjectManagerInterface|Mock $objectManagerMock */
         $objectManagerMock = $this->createMock(ObjectManagerInterface::class);
+        /** @var EntityAbstract|Mock $entityGeneratorMock */
         $entityGeneratorMock = $this->getMockBuilder(EntityAbstract::class)
             ->disableOriginalConstructor()
             ->getMock();