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

- simplified auto-generation in unit tests

Author: buskamuza

dev/tests/unit/framework/autoload.php

@@ -7,20 +7,19 @@
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Code\Generator\Io;
 use Magento\Framework\Filesystem\Driver\File;
-use Magento\Framework\ObjectManager\Code\Generator\Factory;
-use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionGeneratorAutoloader;
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesGenerator;
+use Magento\Framework\TestFramework\Unit\Autoloader\FactoryGenerator;
 use Magento\Framework\TestFramework\Unit\Autoloader\GeneratedClassesAutoloader;
-use Magento\Framework\TestFramework\Unit\Autoloader\ObjectManager;
 
 $generatorIo = new Io(
     new File(),
     TESTS_TEMP_DIR . '/' . DirectoryList::getDefaultConfig()[DirectoryList::GENERATED_CODE][DirectoryList::PATH]
 );
-spl_autoload_register([new ExtensionGeneratorAutoloader($generatorIo), 'load']);
-
-$codeGenerator = new \Magento\Framework\Code\Generator(
-    $generatorIo,
-    [Factory::ENTITY_TYPE => Factory::class]
+$generatedCodeAutoloader = new GeneratedClassesAutoloader(
+    [
+        new ExtensionAttributesGenerator(),
+        new FactoryGenerator(),
+    ],
+    $generatorIo
 );
-$codeGenerator->setObjectManager(new ObjectManager());
-spl_autoload_register([new GeneratedClassesAutoloader($codeGenerator), 'load']);
+spl_autoload_register([$generatedCodeAutoloader, 'load']);

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

@@ -0,0 +1,73 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Unit\Autoloader;
+
+/**
+ * Code generation for the undeclared *Extension and *ExtensionInterface 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
+ * types be generated with the properties from the extension attributes config.
+ */
+class ExtensionAttributesGenerator implements GeneratorInterface
+{
+    /**
+     * Generates a stub class/interface for classes that follow the convention
+     *
+     * The convention is "<SourceClass>ExtensionInterface" or "<SourceClass>Extension"
+     *
+     * @param string $className
+     * @return bool|string
+     */
+    public function generate($className)
+    {
+        if (!$this->isExtension($className) && !$this->isExtensionInterface($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;
+    }
+
+    /**
+     * 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;
+    }
+
+    /**
+     * Determines if the passed in class name is an Extension type.
+     *
+     * @param string $className
+     * @return bool
+     */
+    private function isExtension($className)
+    {
+        $suffix = "Extension";
+        return substr($className, -strlen($suffix), strlen($suffix)) === $suffix;
+    }
+}

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

@@ -0,0 +1,49 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Unit\Autoloader;
+
+use Magento\Framework\Code\Generator\ClassGenerator;
+
+/**
+ * Generates a simple factory class with create() method
+ */
+class FactoryGenerator implements GeneratorInterface
+{
+    /**
+     * Generates a factory class if it follows "<SourceClass>Factory" convention
+     *
+     * @param string $className
+     * @return bool|string
+     */
+    public function generate($className)
+    {
+        if (!$this->isFactory($className)) {
+            return false;
+        }
+        $methods = [[
+            'name' => 'create',
+            'parameters' => [['name' => 'data', 'type' => 'array', 'defaultValue' => []]],
+            'body' => '',
+        ]];
+        $classGenerator = new ClassGenerator();
+        $classGenerator->setName($className)
+            ->addMethods($methods);
+        return $classGenerator->generate();
+    }
+
+    /**
+     * Check if the class name is a factory by convention "<SourceClass>Factory"
+     *
+     * @param string $className
+     * @return bool
+     */
+    private function isFactory($className)
+    {
+        $sourceName = rtrim(substr($className, 0, -strlen('Factory')), '\\');
+        return $sourceName . 'Factory' == $className;
+    }
+}

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

@@ -6,33 +6,70 @@
 
 namespace Magento\Framework\TestFramework\Unit\Autoloader;
 
+use Magento\Framework\Code\Generator\Io;
+
 /**
  * Autoloader that initiates auto-generation of requested classes
  */
 class GeneratedClassesAutoloader
 {
     /**
-     * @var \Magento\Framework\Code\Generator
+     * @var Io
+     */
+    private $generatorIo;
+
+    /**
+     * @var GeneratorInterface[]
      */
-    private $generator;
+    private $generators;
 
     /**
-     * FactoryGeneratorAutoloader constructor.
-     * @param \Magento\Framework\Code\Generator $generator
+     * @param GeneratorInterface[] $generators
+     * @param Io $generatorIo
      */
-    public function __construct(\Magento\Framework\Code\Generator $generator)
+    public function __construct(array $generators, Io $generatorIo)
     {
-        $this->generator = $generator;
+        foreach ($generators as $generator) {
+            if (!($generator instanceof GeneratorInterface)) {
+                throw new \InvalidArgumentException(
+                    sprintf(
+                        "Instance of '%s' is expected, instance of '%s' is received",
+                        '\Magento\Framework\TestFramework\Unit\Autoloader\GeneratorInterface',
+                        get_class($generator)
+                    )
+                );
+            }
+        }
+        $this->generators = $generators;
+        $this->generatorIo = $generatorIo;
     }
 
     /**
      * Load class
      *
      * @param string $className
-     * @return void
+     * @return bool
      */
     public function load($className)
     {
-        $this->generator->generateClass($className);
+        $classSourceFile = $this->generatorIo->generateResultFileName($className);
+        if ($this->generatorIo->fileExists($classSourceFile)) {
+            include $classSourceFile;
+            return true;
+        } else {
+
+            foreach ($this->generators as $generator) {
+                $content = $generator->generate($className);
+                if ($content) {
+                    $this->generatorIo->makeResultFileDirectory($className);
+                    $this->generatorIo->writeResultFile($classSourceFile, $content);
+                    include $classSourceFile;
+                    return true;
+                }
+            };
+
+        }
+
+        return false;
     }
 }

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

@@ -0,0 +1,21 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\TestFramework\Unit\Autoloader;
+
+/**
+ * Interface for generation of a class of specific type
+ */
+interface GeneratorInterface
+{
+    /**
+     * Generate the requested class if it's supported
+     *
+     * @param string $className
+     * @return mixed
+     */
+    public function generate($className);
+}