MAGETWO-67260: [Github] Incompatible generated interceptor for methods which return references #9167

Author: Dmytro Yushkin

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

@@ -110,7 +110,7 @@ protected function _getMethodInfo(\ReflectionMethod $method)
         }
 
         $methodInfo = [
-            'name' => $method->getName(),
+            'name' => ($method->returnsReference() ? '& ' : '') . $method->getName(),
             'parameters' => $parameters,
             'body' => "\$pluginInfo = \$this->pluginList->getNext(\$this->subjectType, '{$method->getName()}');\n" .
             "if (!\$pluginInfo) {\n" .

lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/InterceptorTest.php

@@ -3,61 +3,86 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-// @codingStandardsIgnoreFile
-
 namespace Magento\Framework\Interception\Test\Unit\Code\Generator;
 
+use Composer\Autoload\ClassLoader;
+use Magento\Framework\Code\Generator\Io;
+use Magento\Framework\Interception\Code\Generator\Interceptor;
+use PHPUnit_Framework_MockObject_MockObject as MockObject;
+
 class InterceptorTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var Io|MockObject
      */
-    protected $ioObjectMock;
+    private $ioGenerator;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @inheritdoc
      */
-    protected $classGeneratorMock;
-
     protected function setUp()
     {
-        $this->ioObjectMock = $this->getMock(\Magento\Framework\Code\Generator\Io::class, [], [], '', false);
-        $this->classGeneratorMock = $this->getMock(
-            \Magento\Framework\Code\Generator\CodeGeneratorInterface::class,
-            [],
-            [],
-            '',
-            false
+        $this->ioGenerator = $this->getMockBuilder(Io::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $loader = new ClassLoader();
+        $loader->addPsr4(
+            'Magento\\Framework\\Interception\\Code\\Generator\\',
+            __DIR__ . '/_files'
         );
+        $loader->register();
+    }
+
+    /**
+     * Checks a test case when interceptor generates code for the specified class.
+     *
+     * @param string $className
+     * @param string $resultClassName
+     * @param string $fileName
+     * @dataProvider interceptorDataProvider
+     */
+    public function testGenerate($className, $resultClassName, $fileName)
+    {
+        /** @var Interceptor|MockObject $interceptor */
+        $interceptor = $this->getMockBuilder(Interceptor::class)
+            ->setMethods(['_validateData'])
+            ->setConstructorArgs([
+                $className,
+                $resultClassName,
+                $this->ioGenerator,
+            ])
+            ->getMock();
+
+        $this->ioGenerator
+            ->method('generateResultFileName')
+            ->with('\\' . $resultClassName)
+            ->willReturn($fileName . '.php');
+
+        $code = file_get_contents(__DIR__ . '/_files/' . $fileName . '.txt');
+        $this->ioGenerator->method('writeResultFile')
+            ->with($fileName . '.php', $code);
+
+        $interceptor->method('_validateData')
+            ->willReturn(true);
+
+        $generated = $interceptor->generate();
+        $this->assertEquals($fileName . '.php', $generated, 'Generated interceptor is invalid.');
     }
 
-    public function testGetDefaultResultClassName()
+    /**
+     * Gets list of interceptor samples.
+     *
+     * @return array
+     */
+    public function interceptorDataProvider()
     {
-        // resultClassName should be stdClass_Interceptor
-        $model = $this->getMock(
-            \Magento\Framework\Interception\Code\Generator\Interceptor::class,
-            ['_validateData'],
+        return [
             [
-                'Exception',
-                null,
-                $this->ioObjectMock,
-                $this->classGeneratorMock,
+                \Magento\Framework\Interception\Code\Generator\Sample::class,
+                \Magento\Framework\Interception\Code\Generator\Sample\Interceptor::class,
+                'Interceptor'
             ]
-        );
-
-        $this->classGeneratorMock->expects($this->once())->method('setName')
-            ->willReturnSelf();
-        $this->classGeneratorMock->expects($this->once())->method('addProperties')
-            ->willReturnSelf();
-        $this->classGeneratorMock->expects($this->once())->method('addMethods')
-            ->willReturnSelf();
-        $this->classGeneratorMock->expects($this->once())->method('setClassDocBlock')
-            ->willReturnSelf();
-        $this->classGeneratorMock->expects($this->once())->method('generate')
-            ->will($this->returnValue('source code example'));
-        $model->expects($this->once())->method('_validateData')->will($this->returnValue(true));
-        $this->ioObjectMock->expects($this->any())->method('generateResultFileName')->with('Exception_Interceptor');
-        $this->assertEquals('', $model->generate());
+        ];
     }
 }

lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Interceptor.txt

@@ -0,0 +1,40 @@
+namespace Magento\Framework\Interception\Code\Generator\Sample;
+
+/**
+ * Interceptor class for @see \Magento\Framework\Interception\Code\Generator\Sample
+ */
+class Interceptor extends \Magento\Framework\Interception\Code\Generator\Sample implements \Magento\Framework\Interception\InterceptorInterface
+{
+    use \Magento\Framework\Interception\Interceptor;
+
+    public function __construct()
+    {
+        $this->___init();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getValue()
+    {
+        $pluginInfo = $this->pluginList->getNext($this->subjectType, 'getValue');
+        if (!$pluginInfo) {
+            return parent::getValue();
+        } else {
+            return $this->___callPlugins('getValue', func_get_args(), $pluginInfo);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function & getReference()
+    {
+        $pluginInfo = $this->pluginList->getNext($this->subjectType, 'getReference');
+        if (!$pluginInfo) {
+            return parent::getReference();
+        } else {
+            return $this->___callPlugins('getReference', func_get_args(), $pluginInfo);
+        }
+    }
+}

lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/Sample.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Interception\Code\Generator;
+
+class Sample
+{
+    public function getValue()
+    {
+
+    }
+
+    public function & getReference()
+    {
+
+    }
+}