MAGETWO-67626: Auto-generated classes behave differently in unit tests and application

- refactored generators
- skip generation of non-conventional classes/interfaces

Author: buskamuza

dev/tests/unit/framework/autoload.php

@@ -8,6 +8,7 @@
 use Magento\Framework\Code\Generator\Io;
 use Magento\Framework\Filesystem\Driver\File;
 use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesGenerator;
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesInterfaceGenerator;
 use Magento\Framework\TestFramework\Unit\Autoloader\FactoryGenerator;
 use Magento\Framework\TestFramework\Unit\Autoloader\GeneratedClassesAutoloader;
 
@@ -18,6 +19,7 @@
 $generatedCodeAutoloader = new GeneratedClassesAutoloader(
     [
         new ExtensionAttributesGenerator(),
+        new ExtensionAttributesInterfaceGenerator(),
         new FactoryGenerator(),
     ],
     $generatorIo

lib/internal/Magento/Framework/TestFramework/Test/Unit/Autoloader/ExtensionAttributesGeneratorTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Test\Unit\Autoloader;
+
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesGenerator;
+
+class ExtensionAttributesGeneratorTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var ExtensionAttributesGenerator
+     */
+    private $subject;
+
+    protected function setUp()
+    {
+        $this->subject = new ExtensionAttributesGenerator();
+    }
+
+    public function testGenerateExtensionAttributes()
+    {
+        $this->assertStringMatchesFormat(
+            "%Anamespace My;%Aclass SimpleExtension implements SimpleExtensionInterface%A",
+            $this->subject->generate('\My\SimpleExtension')
+        );
+    }
+
+    /**
+     * @dataProvider generateNonExtensionAttributesDataProvider
+     * @param string $className
+     */
+    public function testGenerateNonExtensionAttributes($className)
+    {
+        $this->assertFalse($this->subject->generate($className));
+    }
+
+    /**
+     * @return array
+     */
+    public function generateNonExtensionAttributesDataProvider()
+    {
+        return [
+            'non-extension attribute class' => ['\My\SimpleClass'],
+            'non-conventional extension attribute name' => ['\My\Extension'],
+        ];
+    }
+}

lib/internal/Magento/Framework/TestFramework/Test/Unit/Autoloader/ExtensionAttributesInterfaceGeneratorTest.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Test\Unit\Autoloader;
+
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesInterfaceGenerator;
+
+class ExtensionAttributesInterfaceGeneratorTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var ExtensionAttributesInterfaceGenerator
+     */
+    private $subject;
+
+    protected function setUp()
+    {
+        $this->subject = new ExtensionAttributesInterfaceGenerator();
+    }
+
+    public function testGenerateExtensionAttributesInterface()
+    {
+        $this->assertStringMatchesFormat(
+            "%Anamespace My;%Ainterface SimpleExtensionInterface extends "
+            . "\\Magento\\Framework\\Api\\ExtensionAttributesInterface%A",
+            $this->subject->generate('\My\SimpleExtensionInterface')
+        );
+    }
+
+    /**
+     * @dataProvider generateNonExtensionAttributesInterfaceDataProvider
+     * @param string $className
+     */
+    public function testGenerateNonExtensionAttributesInterface($className)
+    {
+        $this->assertFalse($this->subject->generate($className));
+    }
+
+    /**
+     * @return array
+     */
+    public function generateNonExtensionAttributesInterfaceDataProvider()
+    {
+        return [
+            'non-extension attribute interface' => ['\My\SimpleInterface'],
+            'non-conventional extension attribute interface name' => ['\My\ExtensionInterface'],
+        ];
+    }
+}

lib/internal/Magento/Framework/TestFramework/Test/Unit/Autoloader/FactoryGeneratorTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Test\Unit\Autoloader;
+
+use Magento\Framework\TestFramework\Unit\Autoloader\FactoryGenerator;
+
+class FactoryGeneratorTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var FactoryGenerator
+     */
+    private $subject;
+
+    protected function setUp()
+    {
+        $this->subject = new FactoryGenerator();
+    }
+
+    public function testGenerateFactory()
+    {
+        $this->assertStringMatchesFormat(
+            '%Anamespace My%Aclass SimpleFactory%Afunction create%A',
+            $this->subject->generate('\My\SimpleFactory')
+        );
+    }
+
+    /**
+     * @dataProvider generateNonFactoryDataProvider
+     * @param string $className
+     */
+    public function testGenerateNonFactory($className)
+    {
+        $this->assertFalse($this->subject->generate($className));
+    }
+
+    /**
+     * @return array
+     */
+    public function generateNonFactoryDataProvider()
+    {
+        return [
+            'non-factory class' => ['\My\SimpleClass'],
+            'non-conventional factory name' => ['\My\Factory'],
+        ];
+    }
+}

lib/internal/Magento/Framework/TestFramework/Unit/Autoloader/ExtensionAttributesGenerator.php

@@ -6,8 +6,10 @@
 
 namespace Magento\Framework\TestFramework\Unit\Autoloader;
 
+use Magento\Framework\Code\Generator\ClassGenerator;
+
 /**
- * Code generation for the undeclared *Extension and *ExtensionInterface types
+ * Code generation for the undeclared *Extension types
  *
  * These files must be generated since they are referenced in many interfaces/classes and cannot be mocked easily.
  * For unit tests, these are just empty type definitions. You should use integration tests if you want to see the real
@@ -16,47 +18,23 @@
 class ExtensionAttributesGenerator implements GeneratorInterface
 {
     /**
-     * Generates a stub class/interface for classes that follow the convention
+     * Generates a stub class for classes that follow the convention
      *
-     * The convention is "<SourceClass>ExtensionInterface" or "<SourceClass>Extension"
+     * The convention is "<SourceClass>Extension"
      *
      * @param string $className
      * @return bool|string
      */
     public function generate($className)
     {
-        if (!$this->isExtension($className) && !$this->isExtensionInterface($className)) {
+        if (!$this->isExtension($className)) {
             return false;
         }
-        $classNameParts = explode('\\', $className);
-
-        /* Split the type name and namespace for the file's contents. */
-        $justTypeName = $classNameParts[count($classNameParts) - 1];
-
-        unset($classNameParts[count($classNameParts) - 1]);
-        $namespace = implode('\\', $classNameParts);
-
-        $content = false;
-        if ($this->isExtension($className)) {
-            $content = "namespace $namespace;\n\nclass $justTypeName implements "
-                . "{$justTypeName}Interface\n{\n\n}";
-        } elseif ($this->isExtensionInterface($className)) {
-            $content = "namespace $namespace;\n\ninterface $justTypeName extends "
-                . "\\Magento\\Framework\\Api\\ExtensionAttributesInterface \n{\n\n}";
-        }
-        return $content;
-    }
+        $classGenerator = new ClassGenerator();
+        $classGenerator->setName($className)
+            ->setImplementedInterfaces(["{$className}Interface"]);
+        return $classGenerator->generate();
 
-    /**
-     * Determines if the passed in class name is an ExtensionInterface type.
-     *
-     * @param string $className
-     * @return bool
-     */
-    private function isExtensionInterface($className)
-    {
-        $suffix = "ExtensionInterface";
-        return substr($className, -strlen($suffix), strlen($suffix)) === $suffix;
     }
 
     /**
@@ -68,6 +46,7 @@ private function isExtensionInterface($className)
     private function isExtension($className)
     {
         $suffix = "Extension";
-        return substr($className, -strlen($suffix), strlen($suffix)) === $suffix;
+        $sourceName = rtrim(substr($className, 0, -strlen($suffix)), '\\');
+        return $sourceName . $suffix == $className;
     }
 }

lib/internal/Magento/Framework/TestFramework/Unit/Autoloader/ExtensionAttributesInterfaceGenerator.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Unit\Autoloader;
+
+use Magento\Framework\Code\Generator\InterfaceGenerator;
+
+/**
+ * Code generation for the undeclared *ExtensionInterface
+ *
+ * These files must be generated since they are referenced in many interfaces/classes and cannot be mocked easily.
+ * For unit tests, these are just empty type definitions. You should use integration tests if you want to see the real
+ * types be generated with the properties from the extension attributes config.
+ */
+class ExtensionAttributesInterfaceGenerator implements GeneratorInterface
+{
+    /**
+     * Generates a stub interface for interfaces that follow the convention
+     *
+     * The convention is "<SourceClass>ExtensionInterface"
+     *
+     * @param string $className
+     * @return bool|string
+     */
+    public function generate($className)
+    {
+        if (!$this->isExtensionInterface($className)) {
+            return false;
+        }
+        $interfaceGenerator = new InterfaceGenerator();
+        $interfaceGenerator->setName($className)
+            ->setExtendedClass('\Magento\Framework\Api\ExtensionAttributesInterface');
+        return $interfaceGenerator->generate();
+    }
+
+    /**
+     * Determines if the passed in class name is an ExtensionInterface type.
+     *
+     * @param string $className
+     * @return bool
+     */
+    private function isExtensionInterface($className)
+    {
+        $suffix = "ExtensionInterface";
+        $sourceName = rtrim(substr($className, 0, -strlen($suffix)), '\\');
+        return $sourceName . $suffix == $className;
+    }
+}