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

Author: Yevhen Miroshnychenko

dev/tests/integration/testsuite/Magento/Framework/Code/GeneratorTest.php

@@ -5,12 +5,13 @@
  */
 namespace Magento\Framework\Code;
 
+use Magento\Framework\Api\Code\Generator\ExtensionAttributesInterfaceFactoryGenerator;
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Interception\Code\Generator as InterceptionGenerator;
 use Magento\Framework\ObjectManager\Code\Generator as DIGenerator;
-use Magento\Framework\Api\Code\Generator\ExtensionAttributesInterfaceFactoryGenerator;
 use Magento\TestFramework\Helper\Bootstrap;
+use PHPUnit\Framework\TestCase;
 
 require_once __DIR__ . '/GeneratorTest/SourceClassWithNamespace.php';
 require_once __DIR__ . '/GeneratorTest/ParentClassWithNamespace.php';
@@ -20,83 +21,74 @@
  * @magentoAppIsolation enabled
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class GeneratorTest extends \PHPUnit\Framework\TestCase
+class GeneratorTest extends TestCase
 {
-    const CLASS_NAME_WITH_NAMESPACE = \Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace::class;
+    const CLASS_NAME_WITH_NAMESPACE = GeneratorTest\SourceClassWithNamespace::class;
 
     /**
-     * @var \Magento\Framework\Code\Generator
+     * @var Generator
      */
     protected $_generator;
 
     /**
-     * @var \Magento\Framework\Code\Generator\Io
+     * @var Generator/Io
      */
     protected $_ioObject;
 
     /**
-     * @var \Magento\Framework\Filesystem\Directory\Write
+     * @var Filesystem\Directory\Write
      */
-    protected $generatedDirectory;
+    private $generatedDirectory;
 
     /**
-     * @var \Magento\Framework\Filesystem\Directory\Read
+     * @var Filesystem\Directory\Read
      */
     private $logDirectory;
 
     /**
-     * @var int
+     * @var string
      */
-    private $oldPermissionGenerationDir;
+    private $testRelativePath = './Magento/Framework/Code/GeneratorTest/';
 
     /**
      * @inheritdoc
      */
     protected function setUp()
     {
-        $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+        $objectManager = Bootstrap::getObjectManager();
         /** @var Filesystem $filesystem */
-        $filesystem = $objectManager->get(\Magento\Framework\Filesystem::class);
+        $filesystem = $objectManager->get(Filesystem::class);
         $this->generatedDirectory = $filesystem->getDirectoryWrite(DirectoryList::GENERATED_CODE);
         $this->logDirectory = $filesystem->getDirectoryRead(DirectoryList::LOG);
-        $generatedDirectory = $this->generatedDirectory->getAbsolutePath();
-        $this->_ioObject = new \Magento\Framework\Code\Generator\Io(
-            new \Magento\Framework\Filesystem\Driver\File(),
-            $generatedDirectory
-        );
+        $generatedDirectoryAbsolutePath = $this->generatedDirectory->getAbsolutePath();
+        $this->_ioObject = new Generator\Io(new Filesystem\Driver\File(), $generatedDirectoryAbsolutePath);
         $this->_generator = $objectManager->create(
-            \Magento\Framework\Code\Generator::class,
+            Generator::class,
             [
                 'ioObject' => $this->_ioObject,
                 'generatedEntities' => [
                     ExtensionAttributesInterfaceFactoryGenerator::ENTITY_TYPE =>
                         ExtensionAttributesInterfaceFactoryGenerator::class,
-                    DIGenerator\Factory::ENTITY_TYPE => \Magento\Framework\ObjectManager\Code\Generator\Factory::class,
-                    DIGenerator\Proxy::ENTITY_TYPE => \Magento\Framework\ObjectManager\Code\Generator\Proxy::class,
-                    InterceptionGenerator\Interceptor::ENTITY_TYPE =>
-                        \Magento\Framework\Interception\Code\Generator\Interceptor::class,
+                    DIGenerator\Factory::ENTITY_TYPE => DIGenerator\Factory::class,
+                    DIGenerator\Proxy::ENTITY_TYPE => DIGenerator\Proxy::class,
+                    InterceptionGenerator\Interceptor::ENTITY_TYPE => InterceptionGenerator\Interceptor::class,
                 ]
             ]
         );
         $this->_generator->setObjectManager($objectManager);
-
-        if (file_exists($generatedDirectory)) {
-            $this->oldPermissionGenerationDir = fileperms($generatedDirectory);
-        }
     }
 
+    /**
+     * @inheritdoc
+     */
     protected function tearDown()
     {
-        $this->generatedDirectory->changePermissionsRecursively('./', 0777, 0666);
-        $this->generatedDirectory->delete();
         $this->_generator = null;
-
-        if ($this->oldPermissionGenerationDir) {
-            mkdir(
-                $this->generatedDirectory->getAbsolutePath(),
-                $this->oldPermissionGenerationDir,
-                true
-            );
+        if ($this->generatedDirectory->isExist($this->testRelativePath)) {
+            if (!$this->generatedDirectory->isWritable($this->testRelativePath)) {
+                $this->generatedDirectory->changePermissionsRecursively($this->testRelativePath, 0775, 0664);
+            }
+            $this->generatedDirectory->delete($this->testRelativePath);
         }
     }
 
@@ -105,81 +97,59 @@ protected function _clearDocBlock($classBody)
         return preg_replace('/(\/\*[\w\W]*)\nclass/', 'class', $classBody);
     }
 
+    /**
+     * Generates a new file with Factory class and compares with the sample from the
+     * SourceClassWithNamespaceFactory.php.sample file.
+     */
     public function testGenerateClassFactoryWithNamespace()
     {
         $factoryClassName = self::CLASS_NAME_WITH_NAMESPACE . 'Factory';
-        $result = false;
-        $generatorResult = $this->_generator->generateClass($factoryClassName);
-        if (\Magento\Framework\Code\Generator::GENERATION_ERROR !== $generatorResult) {
-            $result = true;
-        }
-        $this->assertTrue($result, 'Failed asserting that \'' . (string)$generatorResult . '\' equals \'success\'.');
-
-        $factory = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create($factoryClassName);
-
-        $object = $factory->create();
-        $this->assertInstanceOf(self::CLASS_NAME_WITH_NAMESPACE, $object);
-
-        // This test is only valid if the factory created the object if Autoloader did not pick it up automatically
-        if (\Magento\Framework\Code\Generator::GENERATION_SUCCESS == $generatorResult) {
-            $content = $this->_clearDocBlock(
-                file_get_contents(
-                    $this->_ioObject->generateResultFileName(self::CLASS_NAME_WITH_NAMESPACE . 'Factory')
-                )
-            );
-            $expectedContent = $this->_clearDocBlock(
-                file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceFactory.php.sample')
-            );
-            $this->assertEquals($expectedContent, $content);
-        }
+        $this->assertEquals(Generator::GENERATION_SUCCESS, $this->_generator->generateClass($factoryClassName));
+        $factory = Bootstrap::getObjectManager()->create($factoryClassName);
+        $this->assertInstanceOf(self::CLASS_NAME_WITH_NAMESPACE, $factory->create());
+        $content = $this->_clearDocBlock(
+            file_get_contents($this->_ioObject->generateResultFileName($factoryClassName))
+        );
+        $expectedContent = $this->_clearDocBlock(
+            file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceFactory.php.sample')
+        );
+        $this->assertEquals($expectedContent, $content);
     }
 
+    /**
+     * Generates a new file with Proxy class and compares with the sample from the
+     * SourceClassWithNamespaceProxy.php.sample file.
+     */
     public function testGenerateClassProxyWithNamespace()
     {
         $proxyClassName = self::CLASS_NAME_WITH_NAMESPACE . '\Proxy';
-        $result = false;
-        $generatorResult = $this->_generator->generateClass($proxyClassName);
-        if (\Magento\Framework\Code\Generator::GENERATION_ERROR !== $generatorResult) {
-            $result = true;
-        }
-        $this->assertTrue($result, 'Failed asserting that \'' . (string)$generatorResult . '\' equals \'success\'.');
-
-        $proxy = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create($proxyClassName);
+        $this->assertEquals(Generator::GENERATION_SUCCESS, $this->_generator->generateClass($proxyClassName));
+        $proxy = Bootstrap::getObjectManager()->create($proxyClassName);
         $this->assertInstanceOf(self::CLASS_NAME_WITH_NAMESPACE, $proxy);
-
-        // This test is only valid if the factory created the object if Autoloader did not pick it up automatically
-        if (\Magento\Framework\Code\Generator::GENERATION_SUCCESS == $generatorResult) {
-            $content = $this->_clearDocBlock(
-                file_get_contents($this->_ioObject->generateResultFileName(self::CLASS_NAME_WITH_NAMESPACE . '\Proxy'))
-            );
-            $expectedContent = $this->_clearDocBlock(
-                file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceProxy.php.sample')
-            );
-            $this->assertEquals($expectedContent, $content);
-        }
+        $content = $this->_clearDocBlock(
+            file_get_contents($this->_ioObject->generateResultFileName($proxyClassName))
+        );
+        $expectedContent = $this->_clearDocBlock(
+            file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceProxy.php.sample')
+        );
+        $this->assertEquals($expectedContent, $content);
     }
 
+    /**
+     * Generates a new file with Interceptor class and compares with the sample from the
+     * SourceClassWithNamespaceInterceptor.php.sample file.
+     */
     public function testGenerateClassInterceptorWithNamespace()
     {
         $interceptorClassName = self::CLASS_NAME_WITH_NAMESPACE . '\Interceptor';
-        $result = false;
-        $generatorResult = $this->_generator->generateClass($interceptorClassName);
-        if (\Magento\Framework\Code\Generator::GENERATION_ERROR !== $generatorResult) {
-            $result = true;
-        }
-        $this->assertTrue($result, 'Failed asserting that \'' . (string)$generatorResult . '\' equals \'success\'.');
-
-        if (\Magento\Framework\Code\Generator::GENERATION_SUCCESS == $generatorResult) {
-            $content = $this->_clearDocBlock(
-                file_get_contents(
-                    $this->_ioObject->generateResultFileName(self::CLASS_NAME_WITH_NAMESPACE . '\Interceptor')
-                )
-            );
-            $expectedContent = $this->_clearDocBlock(
-                file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceInterceptor.php.sample')
-            );
-            $this->assertEquals($expectedContent, $content);
-        }
+        $this->assertEquals(Generator::GENERATION_SUCCESS, $this->_generator->generateClass($interceptorClassName));
+        $content = $this->_clearDocBlock(
+            file_get_contents($this->_ioObject->generateResultFileName($interceptorClassName))
+        );
+        $expectedContent = $this->_clearDocBlock(
+            file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceInterceptor.php.sample')
+        );
+        $this->assertEquals($expectedContent, $content);
     }
 
     /**
@@ -189,45 +159,35 @@ public function testGenerateClassInterceptorWithNamespace()
     public function testGenerateClassExtensionAttributesInterfaceFactoryWithNamespace()
     {
         $factoryClassName = self::CLASS_NAME_WITH_NAMESPACE . 'ExtensionInterfaceFactory';
-        $this->generatedDirectory->create(
-            $this->generatedDirectory->getAbsolutePath() . '/Magento/Framework/Code/GeneratorTest/'
-        );
-
-        $generatorResult = $this->_generator->generateClass($factoryClassName);
-
+        $this->generatedDirectory->create($this->testRelativePath);
+        $this->assertEquals(Generator::GENERATION_SUCCESS, $this->_generator->generateClass($factoryClassName));
         $factory = Bootstrap::getObjectManager()->create($factoryClassName);
-        $object = $factory->create();
-
-        $this->assertEquals($generatorResult, Generator::GENERATION_SUCCESS);
-        $this->assertInstanceOf(self::CLASS_NAME_WITH_NAMESPACE . 'Extension', $object);
-
+        $this->assertInstanceOf(self::CLASS_NAME_WITH_NAMESPACE . 'Extension', $factory->create());
         $content = $this->_clearDocBlock(
-            file_get_contents(
-                $this->_ioObject->generateResultFileName(self::CLASS_NAME_WITH_NAMESPACE . 'ExtensionInterfaceFactory')
-            )
+            file_get_contents($this->_ioObject->generateResultFileName($factoryClassName))
         );
         $expectedContent = $this->_clearDocBlock(
             file_get_contents(__DIR__ . '/_expected/SourceClassWithNamespaceExtensionInterfaceFactory.php.sample')
         );
         $this->assertEquals($expectedContent, $content);
     }
 
+    /**
+     * It tries to generate a new class file if the generated directory is read-only
+     */
     public function testGeneratorClassWithErrorSaveClassFile()
     {
         $msgPart = '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';
-
         $this->expectException(\RuntimeException::class);
-        $this->expectExceptionMessageRegExp("/^$msgPart.*/");
-        $this->generatedDirectory->changePermissionsRecursively('./', 0555, 0444);
-        $factoryClassName = self::CLASS_NAME_WITH_NAMESPACE . 'ExtensionInterfaceFactory';
-
+        $this->expectExceptionMessageRegExp("/.*$msgPart.*/");
+        $this->generatedDirectory->create($this->testRelativePath);
+        $this->generatedDirectory->changePermissionsRecursively($this->testRelativePath, 0555, 0444);
+        $factoryClassName = self::CLASS_NAME_WITH_NAMESPACE . 'Factory';
         $generatorResult = $this->_generator->generateClass($factoryClassName);
         $this->assertFalse($generatorResult);
-
         $pathToSystemLog = $this->logDirectory->getAbsolutePath('system.log');
-        $logs = array_slice(file($pathToSystemLog), -2);
-        $this->assertContains($msgPart, $logs[0]);
+        $this->assertContains($msgPart, file_get_contents($pathToSystemLog));
     }
 }

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

@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Framework\Api\Code\Generator;
 
 use Magento\Framework\ObjectManager\Code\Generator\Factory;

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

@@ -7,6 +7,8 @@
 
 use Magento\Framework\Exception\FileSystemException;
 use Zend\Code\Generator\ValueGenerator;
+use Magento\Framework\Filesystem\Driver\File;
+use Magento\Framework\ObjectManagerInterface;
 
 abstract class EntityAbstract
 {
@@ -42,7 +44,7 @@ abstract class EntityAbstract
     /**
      * Class generator object
      *
-     * @var \Magento\Framework\Code\Generator\CodeGeneratorInterface
+     * @var CodeGeneratorInterface
      */
     protected $_classGenerator;
 
@@ -55,20 +57,20 @@ abstract class EntityAbstract
      * @param null|string $sourceClassName
      * @param null|string $resultClassName
      * @param Io $ioObject
-     * @param \Magento\Framework\Code\Generator\CodeGeneratorInterface $classGenerator
+     * @param CodeGeneratorInterface $classGenerator
      * @param DefinedClasses $definedClasses
      */
     public function __construct(
         $sourceClassName = null,
         $resultClassName = null,
         Io $ioObject = null,
-        \Magento\Framework\Code\Generator\CodeGeneratorInterface $classGenerator = null,
+        CodeGeneratorInterface $classGenerator = null,
         DefinedClasses $definedClasses = null
     ) {
         if ($ioObject) {
             $this->_ioObject = $ioObject;
         } else {
-            $this->_ioObject = new Io(new \Magento\Framework\Filesystem\Driver\File());
+            $this->_ioObject = new Io(new File());
         }
         if ($classGenerator) {
             $this->_classGenerator = $classGenerator;
@@ -201,7 +203,7 @@ protected function _getClassProperties()
             'visibility' => 'protected',
             'docblock' => [
                 'shortDescription' => 'Object Manager instance',
-                'tags' => [['name' => 'var', 'description' => '\\' . \Magento\Framework\ObjectManagerInterface::class]],
+                'tags' => [['name' => 'var', 'description' => '\\' . ObjectManagerInterface::class]],
             ],
         ];