Improvement/mftf 33583 eliminate aspect mock from mock module resolver builder

dev/tests/unit/Magento/FunctionalTestFramework/Test/Handlers/TestObjectHandlerTest.php

@@ -8,15 +8,20 @@
 namespace tests\unit\Magento\FunctionalTestFramework\Test\Handlers;
 
 use Exception;
+use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
+use Magento\FunctionalTestingFramework\ObjectManager;
+use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
 use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
+use Magento\FunctionalTestingFramework\Test\Parsers\TestDataParser;
 use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
 use Magento\FunctionalTestingFramework\Util\GenerationErrorHandler;
+use Magento\FunctionalTestingFramework\Util\ModuleResolver;
+use ReflectionProperty;
 use tests\unit\Util\MagentoTestCase;
-use tests\unit\Util\MockModuleResolverBuilder;
-use tests\unit\Util\ObjectHandlerUtil;
 use tests\unit\Util\TestDataArrayBuilder;
 use tests\unit\Util\TestLoggingUtil;
 
@@ -51,9 +56,7 @@ public function testGetTestObject(): void
             ->withTestActions()
             ->build();
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup();
-        ObjectHandlerUtil::mockTestObjectHandlerWitData($mockData);
+        $this->mockTestObjectHandler($mockData);
 
         // run object handler method
         $toh = TestObjectHandler::getInstance();
@@ -146,9 +149,7 @@ public function testGetTestsByGroup(): void
             ->withTestActions()
             ->build();
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup();
-        ObjectHandlerUtil::mockTestObjectHandlerWitData(array_merge($includeTest, $excludeTest));
+        $this->mockTestObjectHandler(array_merge($includeTest, $excludeTest));
 
         // execute test method
         $toh = TestObjectHandler::getInstance();
@@ -195,10 +196,8 @@ public function testGetTestWithModuleName(): void
             ->withFileName($file)
             ->build();
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup(['Vendor_' . $moduleExpected => $filepath]);
+        $this->mockTestObjectHandler($mockData, ['Vendor_' . $moduleExpected => $filepath]);
 
-        ObjectHandlerUtil::mockTestObjectHandlerWitData($mockData);
         // Execute Test Method
         $toh = TestObjectHandler::getInstance();
         $actualTestObject = $toh->getObject($testDataArrayBuilder->testName);
@@ -225,13 +224,11 @@ public function testGetTestObjectWithInvalidExtends(): void
             ->withBeforeHook()
             ->withTestActions()
             ->build();
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup();
-        ObjectHandlerUtil::mockTestObjectHandlerWitData($testOne);
 
-        $toh = TestObjectHandler::getInstance();
+        $this->mockTestObjectHandler($testOne);
 
-        $this->expectException(\Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException::class);
+        $toh = TestObjectHandler::getInstance();
+        $this->expectException(TestFrameworkException::class);
         $this->expectExceptionMessage("Mftf Test can not extend from itself: " . "testOne");
 
         $toh->getObject('testOne');
@@ -264,9 +261,7 @@ public function testGetAllTestObjectsWithInvalidExtends(): void
             ->withTestActions()
             ->build();
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup();
-        ObjectHandlerUtil::mockTestObjectHandlerWitData(array_merge($testOne, $testTwo));
+        $this->mockTestObjectHandler(array_merge($testOne, $testTwo));
 
         $toh = TestObjectHandler::getInstance();
         $toh->getAllObjects();
@@ -297,9 +292,7 @@ public function testGetTestObjectWhenEnablePause(): void
             ->withTestActions()
             ->build();
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup();
-        ObjectHandlerUtil::mockTestObjectHandlerWitData($mockData);
+        $this->mockTestObjectHandler($mockData);
 
         // run object handler method
         $toh = TestObjectHandler::getInstance();
@@ -381,4 +374,77 @@ protected function tearDown(): void
         TestLoggingUtil::getInstance()->clearMockLoggingUtil();
         parent::tearDownAfterClass();
     }
+
+    /**
+     * Mock test object handler.
+     *
+     * @param array $data
+     * @param array|null $paths
+     *
+     * @return void
+     */
+    private function mockTestObjectHandler(array $data, ?array $paths = null): void
+    {
+        if (!$paths) {
+            $paths = ['Magento_Module' => '/base/path/some/other/path/Magento/Module'];
+        }
+        // clear test object handler value to inject parsed content
+        $property = new ReflectionProperty(TestObjectHandler::class, 'testObjectHandler');
+        $property->setAccessible(true);
+        $property->setValue(null);
+
+        $mockDataParser = $this->createMock(TestDataParser::class);
+        $mockDataParser
+            ->method('readTestData')
+            ->willReturn($data);
+
+        $mockConfig = $this->createMock(MftfApplicationConfig::class);
+        $mockConfig
+            ->method('forceGenerateEnabled')
+            ->willReturn(false);
+
+        $mockResolver = $this->createMock(ModuleResolver::class);
+        $mockResolver
+            ->method('getEnabledModules')
+            ->willReturn([]);
+
+        $objectManager = ObjectManagerFactory::getObjectManager();
+        $objectManagerMockInstance = $this->createMock(ObjectManager::class);
+        $objectManagerMockInstance
+            ->method('create')
+            ->will(
+                $this->returnCallback(
+                    function (
+                        $class,
+                        $arguments = []
+                    ) use (
+                        $objectManager,
+                        $mockDataParser,
+                        $mockConfig,
+                        $mockResolver
+                    ) {
+                        if ($class === TestDataParser::class) {
+                            return $mockDataParser;
+                        }
+                        if ($class === MftfApplicationConfig::class) {
+                            return $mockConfig;
+                        }
+                        if ($class === ModuleResolver::class) {
+                            return $mockResolver;
+                        }
+
+                        return $objectManager->create($class, $arguments);
+                    }
+                )
+            );
+
+        $objectManagerProperty = new ReflectionProperty(ObjectManager::class, 'instance');
+        $objectManagerProperty->setAccessible(true);
+        $objectManagerProperty->setValue($objectManagerMockInstance);
+
+        $resolver = ModuleResolver::getInstance();
+        $property = new ReflectionProperty(ModuleResolver::class, 'enabledModuleNameAndPaths');
+        $property->setAccessible(true);
+        $property->setValue($resolver, $paths);
+    }
 }

dev/tests/unit/Magento/FunctionalTestFramework/Util/ModulePathExtractorTest.php

@@ -3,12 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace tests\unit\Magento\FunctionalTestFramework\Util;
 
+use Magento\FunctionalTestingFramework\ObjectManager;
 use Magento\FunctionalTestingFramework\Util\ModulePathExtractor;
+use Magento\FunctionalTestingFramework\Util\ModuleResolver;
+use ReflectionProperty;
 use tests\unit\Util\MagentoTestCase;
-use tests\unit\Util\MockModuleResolverBuilder;
 
 class ModulePathExtractorTest extends MagentoTestCase
 {
@@ -36,8 +39,7 @@ public function testGetModuleAppCode()
     {
         $mockPath = '/base/path/app/code/Magento/ModuleA/Test/Mftf/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('ModuleA', $extractor->extractModuleName($mockPath));
     }
@@ -51,8 +53,7 @@ public function testGetVendorAppCode()
     {
         $mockPath = '/base/path/app/code/VendorB/ModuleB/Test/Mftf/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('VendorB', $extractor->getExtensionPath($mockPath));
     }
@@ -66,8 +67,7 @@ public function testGetModuleDevTests()
     {
         $mockPath = '/base/path/dev/tests/acceptance/tests/functional/Magento/ModuleCTest/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('ModuleC', $extractor->extractModuleName($mockPath));
     }
@@ -81,8 +81,7 @@ public function testGetVendorDevTests()
     {
         $mockPath = '/base/path/dev/tests/acceptance/tests/functional/VendorD/ModuleDTest/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('VendorD', $extractor->getExtensionPath($mockPath));
     }
@@ -96,8 +95,7 @@ public function testGetModule()
     {
         $mockPath = '/base/path/dev/tests/acceptance/tests/functional/FunctionalTest/SomeModuleE/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('NO MODULE DETECTED', $extractor->extractModuleName($mockPath));
     }
@@ -111,8 +109,7 @@ public function testGetModuleVendorDir()
     {
         $mockPath = '/base/path/vendor/magento/module-modulef/Test/Mftf/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('ModuleF', $extractor->extractModuleName($mockPath));
     }
@@ -126,9 +123,47 @@ public function testGetVendorVendorDir()
     {
         $mockPath = '/base/path/vendor/vendorg/module-moduleg-test/Test/SomeTest.xml';
 
-        $resolverMock = new MockModuleResolverBuilder();
-        $resolverMock->setup($this->mockTestModulePaths);
+        $this->mockModuleResolver($this->mockTestModulePaths);
         $extractor = new ModulePathExtractor();
         $this->assertEquals('VendorG', $extractor->getExtensionPath($mockPath));
     }
+
+    /**
+     * Mock module resolver.
+     *
+     * @param array $paths
+     *
+     * @return void
+     */
+    private function mockModuleResolver(array $paths): void
+    {
+        $mockResolver = $this->createMock(ModuleResolver::class);
+        $mockResolver
+            ->method('getEnabledModules')
+            ->willReturn([]);
+
+        $objectManagerMockInstance = $this->createMock(ObjectManager::class);
+        $objectManagerMockInstance
+            ->method('create')
+            ->will(
+                $this->returnCallback(
+                    function ($class) use ($mockResolver) {
+                        if ($class === ModuleResolver::class) {
+                            return $mockResolver;
+                        }
+
+                        return null;
+                    }
+                )
+            );
+
+        $objectManagerProperty = new ReflectionProperty(ObjectManager::class, 'instance');
+        $objectManagerProperty->setAccessible(true);
+        $objectManagerProperty->setValue($objectManagerMockInstance);
+
+        $resolver = ModuleResolver::getInstance();
+        $property = new ReflectionProperty(ModuleResolver::class, 'enabledModuleNameAndPaths');
+        $property->setAccessible(true);
+        $property->setValue($resolver, $paths);
+    }
 }