33309: Eliminated AspectMock usage from TestGeneratorTest.php

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

@@ -3,16 +3,18 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace tests\unit\Magento\FunctionalTestFramework\Util;
 
-use AspectMock\Test as AspectMock;
-
+use Exception;
+use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
 use Magento\FunctionalTestingFramework\Filter\FilterList;
-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\Util\Filesystem\CestFileCreatorUtil;
+use ReflectionProperty;
 use tests\unit\Util\MagentoTestCase;
 use Magento\FunctionalTestingFramework\Util\TestGenerator;
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
@@ -22,43 +24,37 @@
 class TestGeneratorTest extends MagentoTestCase
 {
     /**
-     * Before method functionality
+     * Before method functionality.
      */
     public function setUp(): void
     {
         TestLoggingUtil::getInstance()->setMockLoggingUtil();
     }
 
     /**
-     * After method functionality
+     * After method functionality.
      *
      * @return void
      */
     public function tearDown(): void
     {
-        AspectMock::clean();
         GenerationErrorHandler::getInstance()->reset();
     }
 
     /**
      * Basic test to check exceptions for incorrect entities.
      *
-     * @throws \Exception
+     * @return void
+     * @throws Exception
      */
-    public function testEntityException()
+    public function testEntityException(): void
     {
         $actionObject = new ActionObject('fakeAction', 'comment', [
             'userInput' => '{{someEntity.entity}}'
         ]);
 
         $testObject = new TestObject("sampleTest", ["merge123" => $actionObject], [], [], "filename");
-
-        AspectMock::double(TestObjectHandler::class, ['initTestData' => '']);
-
         $testGeneratorObject = TestGenerator::getInstance("", ["sampleTest" => $testObject]);
-
-        AspectMock::double(TestGenerator::class, ['loadAllTestObjects' => ["sampleTest" => $testObject]]);
-
         $testGeneratorObject->createAllTestFiles(null, []);
 
         // assert that no exception for createAllTestFiles and generation error is stored in GenerationErrorHandler
@@ -69,11 +65,12 @@ public function testEntityException()
     }
 
     /**
-     * Tests that skipped tests do not have a fully generated body
+     * Tests that skipped tests do not have a fully generated body.
      *
-     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     * @return void
+     * @throws TestReferenceException
      */
-    public function testSkippedNoGeneration()
+    public function testSkippedNoGeneration(): void
     {
         $actionInput = 'fakeInput';
         $actionObject = new ActionObject('fakeAction', 'comment', [
@@ -91,14 +88,22 @@ public function testSkippedNoGeneration()
     }
 
     /**
-     * Tests that skipped tests have a fully generated body when --allowSkipped is passed in
+     * Tests that skipped tests have a fully generated body when --allowSkipped is passed in.
      *
-     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     * @return void
+     * @throws TestReferenceException
      */
-    public function testAllowSkipped()
+    public function testAllowSkipped(): void
     {
         // Mock allowSkipped for TestGenerator
-        AspectMock::double(MftfApplicationConfig::class, ['allowSkipped' => true]);
+        $mockConfig = $this->createMock(MftfApplicationConfig::class);
+        $mockConfig->expects($this->any())
+            ->method('allowSkipped')
+            ->willReturn(true);
+
+        $property = new ReflectionProperty(MftfApplicationConfig::class, 'MFTF_APPLICATION_CONTEXT');
+        $property->setAccessible(true);
+        $property->setValue($mockConfig);
 
         $actionInput = 'fakeInput';
         $actionObject = new ActionObject('fakeAction', 'comment', [
@@ -128,17 +133,20 @@ public function testAllowSkipped()
     }
 
     /**
-     * Tests that TestGenerator createAllTestFiles correctly filters based on severity
+     * Tests that TestGenerator createAllTestFiles correctly filters based on severity.
      *
-     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     * @return void
+     * @throws TestReferenceException
      */
-    public function testFilter()
+    public function testFilter(): void
     {
-        // Mock filters for TestGenerator
-        AspectMock::double(
-            MftfApplicationConfig::class,
-            ['getFilterList' => new FilterList(['severity' => ["CRITICAL"]])]
-        );
+        $mockConfig = $this->createMock(MftfApplicationConfig::class);
+        $fileList = new FilterList(['severity' => ["CRITICAL"]]);
+        $mockConfig->expects($this->once())->method('getFilterList')->willReturn($fileList);
+
+        $property = new ReflectionProperty(MftfApplicationConfig::class, 'MFTF_APPLICATION_CONTEXT');
+        $property->setAccessible(true);
+        $property->setValue($mockConfig);
 
         $actionInput = 'fakeInput';
         $actionObject = new ActionObject('fakeAction', 'comment', [
@@ -161,16 +169,26 @@ public function testFilter()
             [],
             "filename"
         );
-        AspectMock::double(TestGenerator::class, ['loadAllTestObjects' => ["sampleTest" => $test1, "test2" => $test2]]);
 
         // Mock createCestFile to return name of tests that testGenerator tried to create
         $generatedTests = [];
-        AspectMock::double(TestGenerator::class, ['createCestFile' => function ($arg1, $arg2) use (&$generatedTests) {
-            $generatedTests[$arg2] = true;
-        }]);
+        $cestFileCreatorUtil = $this->createMock(CestFileCreatorUtil::class);
+        $cestFileCreatorUtil->expects($this->once())
+            ->method('create')
+            ->will(
+                $this->returnCallback(
+                    function ($filename) use (&$generatedTests) {
+                        $generatedTests[$filename] = true;
+                    }
+                )
+            );
+
+        $property = new ReflectionProperty(CestFileCreatorUtil::class, 'INSTANCE');
+        $property->setAccessible(true);
+        $property->setValue($cestFileCreatorUtil);
 
         $testGeneratorObject = TestGenerator::getInstance("", ["sampleTest" => $test1, "test2" => $test2]);
-        $testGeneratorObject->createAllTestFiles(null, []);
+        $testGeneratorObject->createAllTestFiles();
 
         // Ensure Test1 was Generated but not Test 2
         $this->assertArrayHasKey('test1Cest', $generatedTests);

src/Magento/FunctionalTestingFramework/Util/Filesystem/CestFileCreatorUtil.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\FunctionalTestingFramework\Util\Filesystem;
+
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
+
+class CestFileCreatorUtil
+{
+    /**
+     * Singleton CestFileCreatorUtil Instance.
+     *
+     * @var CestFileCreatorUtil
+     */
+    private static $INSTANCE;
+
+    /**
+     * CestFileCreatorUtil constructor.
+     */
+    private function __construct()
+    {
+    }
+
+    /**
+     * Get CestFileCreatorUtil instance.
+     *
+     * @return CestFileCreatorUtil
+     */
+    public static function getInstance()
+    {
+        if (self::$INSTANCE === null) {
+            return new self();
+        }
+
+        return self::$INSTANCE;
+    }
+
+    /**
+     * Create a single PHP file containing the $cestPhp using the $filename.
+     * If the _generated directory doesn't exist it will be created.
+     *
+     * @param string $filename
+     * @param string $exportDirectory
+     * @param string $testPhp
+     *
+     * @return void
+     * @throws TestFrameworkException
+     */
+    public function create(string $filename, string $exportDirectory, string $testPhp): void
+    {
+        DirSetupUtil::createGroupDir($exportDirectory);
+        $exportFilePath = $exportDirectory . DIRECTORY_SEPARATOR . $filename . '.php';
+        $file = fopen($exportFilePath, 'w');
+
+        if (!$file) {
+            throw new TestFrameworkException(
+                sprintf('Could not open test file: "%s"', $exportFilePath)
+            );
+        }
+
+        fwrite($file, $testPhp);
+        fclose($file);
+    }
+}

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -22,6 +22,7 @@
 use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
 use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
 use Magento\FunctionalTestingFramework\Test\Util\BaseObjectExtractor;
+use Magento\FunctionalTestingFramework\Util\Filesystem\CestFileCreatorUtil;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 use Magento\FunctionalTestingFramework\Util\Manifest\BaseTestManifest;
 use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
@@ -207,21 +208,13 @@ private function loadAllTestObjects($testsToIgnore)
      *
      * @param string $testPhp
      * @param string $filename
+     *
      * @return void
      * @throws TestFrameworkException
      */
     private function createCestFile(string $testPhp, string $filename)
     {
-        DirSetupUtil::createGroupDir($this->exportDirectory);
-        $exportFilePath = $this->exportDirectory . DIRECTORY_SEPARATOR . $filename . ".php";
-        $file = fopen($exportFilePath, 'w');
-
-        if (!$file) {
-            throw new TestFrameworkException(sprintf('Could not open test file: "%s"', $exportFilePath));
-        }
-
-        fwrite($file, $testPhp);
-        fclose($file);
+        CestFileCreatorUtil::getInstance()->create($filename, $this->exportDirectory, $testPhp);
     }
 
     /**