Merge pull request #78 from magento-commerce/imported-magento-magento2-functional-testing-framework-856

[Imported] Issue 33297: Eliminate AspectMock from DataExtensionUtilTest

Author: jilu1

dev/tests/unit/Magento/FunctionalTestFramework/DataGenerator/Util/DataExtensionUtilTest.php

@@ -3,37 +3,28 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace tests\unit\Magento\FunctionalTestFramework\DataGenerator\Util;
 
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Parsers\DataProfileSchemaParser;
-use Magento\FunctionalTestingFramework\ObjectManager\ObjectManager;
-use Magento\FunctionalTestingFramework\ObjectManagerFactory;
+use Magento\FunctionalTestingFramework\ObjectManager;
+use ReflectionProperty;
 use tests\unit\Util\MagentoTestCase;
-use AspectMock\Test as AspectMock;
 
 /**
  * Class DataExtensionUtilTest
  */
 class DataExtensionUtilTest extends MagentoTestCase
 {
-    /**
-     * Before method functionality
-     * @return void
-     */
-    protected function setUp(): void
-    {
-        AspectMock::clean();
-    }
-
-    public function testNoParentData()
+    public function testNoParentData(): void
     {
         $extendedDataObject = [
             'entity' => [
                 'extended' => [
                     'type' => 'testType',
-                    'extends' => "parent",
+                    'extends' => 'parent',
                     'data' => [
                         0 => [
                             'key' => 'testKey',
@@ -46,21 +37,21 @@ public function testNoParentData()
 
         $this->setMockEntities($extendedDataObject);
 
-        $this->expectExceptionMessage("Parent Entity parent not defined for Entity extended.");
-        DataObjectHandler::getInstance()->getObject("extended");
+        $this->expectExceptionMessage('Parent Entity parent not defined for Entity extended.');
+        DataObjectHandler::getInstance()->getObject('extended');
     }
 
-    public function testAlreadyExtendedParentData()
+    public function testAlreadyExtendedParentData(): void
     {
         $extendedDataObjects = [
             'entity' => [
                 'extended' => [
                     'type' => 'testType',
-                    'extends' => "parent"
+                    'extends' => 'parent'
                 ],
                 'parent' => [
                     'type' => 'type',
-                    'extends' => "grandparent"
+                    'extends' => 'grandparent'
                 ],
                 'grandparent' => [
                     'type' => 'grand'
@@ -71,18 +62,18 @@ public function testAlreadyExtendedParentData()
         $this->setMockEntities($extendedDataObjects);
 
         $this->expectExceptionMessage(
-            "Cannot extend an entity that already extends another entity. Entity: parent." . PHP_EOL
+            'Cannot extend an entity that already extends another entity. Entity: parent.' . PHP_EOL
         );
-        DataObjectHandler::getInstance()->getObject("extended");
+        DataObjectHandler::getInstance()->getObject('extended');
     }
 
-    public function testExtendedVarGetter()
+    public function testExtendedVarGetter(): void
     {
         $extendedDataObjects = [
             'entity' => [
                 'extended' => [
                     'type' => 'testType',
-                    'extends' => "parent"
+                    'extends' => 'parent'
                 ],
                 'parent' => [
                     'type' => 'type',
@@ -98,18 +89,18 @@ public function testExtendedVarGetter()
         ];
 
         $this->setMockEntities($extendedDataObjects);
-        $resultextendedDataObject = DataObjectHandler::getInstance()->getObject("extended");
+        $resultextendedDataObject = DataObjectHandler::getInstance()->getObject('extended');
         // Perform Asserts
-        $this->assertEquals("someOtherEntity->id", $resultextendedDataObject->getVarReference("someOtherEntity"));
+        $this->assertEquals('someOtherEntity->id', $resultextendedDataObject->getVarReference('someOtherEntity'));
     }
 
-    public function testGetLinkedEntities()
+    public function testGetLinkedEntities(): void
     {
         $extendedDataObjects = [
             'entity' => [
                 'extended' => [
                     'type' => 'testType',
-                    'extends' => "parent"
+                    'extends' => 'parent'
                 ],
                 'parent' => [
                     'type' => 'type',
@@ -129,27 +120,36 @@ public function testGetLinkedEntities()
 
         $this->setMockEntities($extendedDataObjects);
         // Perform Asserts
-        $resultextendedDataObject = DataObjectHandler::getInstance()->getObject("extended");
-        $this->assertEquals("linkedEntity1", $resultextendedDataObject->getLinkedEntitiesOfType("linkedEntityType")[0]);
-        $this->assertEquals("linkedEntity2", $resultextendedDataObject->getLinkedEntitiesOfType("otherEntityType")[0]);
+        $resultextendedDataObject = DataObjectHandler::getInstance()->getObject('extended');
+        $this->assertEquals('linkedEntity1', $resultextendedDataObject->getLinkedEntitiesOfType('linkedEntityType')[0]);
+        $this->assertEquals('linkedEntity2', $resultextendedDataObject->getLinkedEntitiesOfType('otherEntityType')[0]);
     }
 
-    private function setMockEntities($mockEntityData)
+    /**
+     * Prepare mock entites.
+     *
+     * @param $mockEntityData
+     *
+     * @return void
+     */
+    private function setMockEntities($mockEntityData): void
     {
-        $property = new \ReflectionProperty(DataObjectHandler::class, 'INSTANCE');
+        $property = new ReflectionProperty(DataObjectHandler::class, 'INSTANCE');
         $property->setAccessible(true);
         $property->setValue(null);
 
-        $mockDataProfileSchemaParser = AspectMock::double(DataProfileSchemaParser::class, [
-            'readDataProfiles' => $mockEntityData
-        ])->make();
+        $mockDataProfileSchemaParser = $this->createMock(DataProfileSchemaParser::class);
+        $mockDataProfileSchemaParser->expects($this->any())
+            ->method('readDataProfiles')
+            ->willReturn($mockEntityData);
 
-        $mockObjectManager = AspectMock::double(ObjectManager::class, [
-            'create' => $mockDataProfileSchemaParser
-        ])->make();
+        $mockObjectManager = $this->createMock(ObjectManager::class);
+        $mockObjectManager
+            ->method('create')
+            ->willReturn($mockDataProfileSchemaParser);
 
-        AspectMock::double(ObjectManagerFactory::class, [
-            'getObjectManager' => $mockObjectManager
-        ]);
+        $property = new ReflectionProperty(ObjectManager::class, 'instance');
+        $property->setAccessible(true);
+        $property->setValue($mockObjectManager);
     }
 }

dev/tests/unit/Util/MagentoTestCase.php

@@ -19,6 +19,8 @@ public static function setUpBeforeClass(): void
         if (!self::fileExists(DOCS_OUTPUT_DIR)) {
             mkdir(DOCS_OUTPUT_DIR, 0755, true);
         }
+        // Should be used to clean AspectMock mocking before using PHPUnit mocking and Reflection.
+        AspectMock::clean();
         parent::setUpBeforeClass();
     }