Verification test added

Author: Ashish.Kumar18

composer.json

@@ -15,6 +15,7 @@
         "ext-intl": "*",
         "ext-json": "*",
         "ext-openssl": "*",
+        "ext-iconv": "*",
         "allure-framework/allure-codeception": "^1.4",
         "aws/aws-sdk-php": "^3.132",
         "codeception/codeception": "^4.1",

composer.lock

@@ -0,0 +1,48 @@
+<?php
+    /**
+     * Copyright © Magento, Inc. All rights reserved.
+     * See COPYING.txt for license details.
+     */
+declare(strict_types=1);
+
+namespace tests\unit\Magento\FunctionalTestFramework\Module\Util;
+
+use Magento\FunctionalTestingFramework\Module\Util\ModuleUtils;
+use PHPUnit\Framework\TestCase;
+
+class ModuleUtilTest extends TestCase
+{
+    /**
+     * Test utf8SafeControlCharacterTrim()
+     *
+     * @param string $input
+     * @param string $output
+     * @param string $removed
+     *
+     * @return void
+     * @dataProvider inDataProvider
+     */
+    public function testUtf8SafeControlCharacterTrim(string $input, string $output, $removed): void
+    {
+        $util = new ModuleUtils();
+        $this->assertStringContainsString($output, $util->utf8SafeControlCharacterTrim($input));
+        $this->assertStringNotContainsString($removed, $util->utf8SafeControlCharacterTrim($input));
+    }
+
+    /**
+     * Data input.
+     *
+     * @return array
+     */
+    public function inDataProvider(): array
+    {
+        $ctr1 = '‹';
+        $ctr2 = 'Œ';
+        $ctr3 = 'Œ ‹';
+        return [
+            ["some text $ctr1", 'some text', $ctr1],
+            ["some text $ctr2", 'some text', $ctr2],
+            ["some text $ctr3", 'some text', $ctr3]
+        ];
+    }
+}

dev/tests/unit/Magento/FunctionalTestFramework/Module/Util/ModuleUtilTest.php

@@ -58,6 +58,7 @@ class DataActionsTestCest
 		$I->deleteEntity("createdInTest", "test"); // stepKey: deleteInTest
 		$I->updateEntity("createdInBefore", "test", "entity",[]); // stepKey: updatedDataOutOfScope
 		$I->deleteEntity("createdInBefore", "test"); // stepKey: deleteDataOutOfScope
+		$I->rapidClick("#general_locale_timezone", "50"); // stepKey: rapidClickTest
 	}
 
 	public function _passed(AcceptanceTester $I)

dev/tests/verification/Resources/DataActionsTest.txt

@@ -18,5 +18,6 @@
         <deleteData createDataKey="createdInTest" stepKey="deleteInTest"/>
         <updateData entity="entity" createDataKey="createdInBefore" stepKey="updatedDataOutOfScope"/>
         <deleteData createDataKey="createdInBefore" stepKey="deleteDataOutOfScope"/>
+        <rapidClick selector="{{LocaleOptionsSection.timezone}}" count="50" stepKey="rapidClickTest"/>
     </test>
-</tests>
+</tests>

dev/tests/verification/TestModule/Test/DataActionsTest.xml

@@ -21,6 +21,7 @@
 use Magento\FunctionalTestingFramework\DataTransport\Auth\Tfa\OTP;
 use Magento\FunctionalTestingFramework\DataTransport\Protocol\CurlInterface;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
+use Magento\FunctionalTestingFramework\Module\Util\ModuleUtils;
 use Magento\FunctionalTestingFramework\Util\Path\UrlFormatter;
 use Magento\FunctionalTestingFramework\Util\ConfigSanitizerUtil;
 use Yandex\Allure\Adapter\AllureException;
@@ -390,21 +391,6 @@ public function searchAndMultiSelectOption($select, array $options, $requireActi
         }
     }
 
-    /**
-     * Simple rapid click as per given count number.
-     *
-     * @param string $selector
-     * @param string $count
-     * @return void
-     * @throws \Exception
-     */
-    public function rapidClick($selector, $count)
-    {
-        for ($i = 0; $i < $count; $i++) {
-            $this->click($selector);
-        }
-    }
-
     /**
      * Select multiple options from a drop down using a filter and text field to narrow results.
      *
@@ -599,7 +585,9 @@ public function magentoCLI($command, $timeout = null, $arguments = null)
         $response = $executor->read();
         $executor->close();
 
-        return $response;
+        $util = new ModuleUtils();
+        $response = trim($util->utf8SafeControlCharacterTrim($response));
+        return $response != "" ? $response : "CLI did not return output.";
     }
 
     /**
@@ -804,6 +792,21 @@ public function dragAndDrop($source, $target, $xOffset = null, $yOffset = null)
             $action->release($tnodes)->perform();
         }
     }
+    
+    /**
+     * Simple rapid click as per given count number.
+     *
+     * @param string $selector
+     * @param string $count
+     * @return void
+     * @throws \Exception
+     */
+    public function rapidClick($selector, $count)
+    {
+        for ($i = 0; $i < $count; $i++) {
+            $this->click($selector);
+        }
+    }
 
     /**
      * Function used to fill sensitive credentials with user data, data is decrypted immediately prior to fill to avoid

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Module\Util;
+
+class ModuleUtils
+{
+    /**
+     * Module util function that returns UTF-8 encoding string with control/invisible characters removed,
+     * and it returns the original string when on error.
+     *
+     * @param string $input
+     * @return string
+     */
+    public function utf8SafeControlCharacterTrim(string $input): string
+    {
+        // Convert $input string to UTF-8 encoding
+        $convInput = iconv("ISO-8859-1", "UTF-8//IGNORE", $input);
+        if ($convInput !== false) {
+            // Remove invisible control characters, unused code points and replacement character
+            // so that they don't break xml test results for Allure
+            $cleanInput = preg_replace('/[^\PC\s]|\x{FFFD}/u', '', $convInput);
+            if ($cleanInput !== null) {
+                return $cleanInput;
+            } else {
+                $err = preg_last_error_msg();
+                print("MagentoCLI response preg_replace() with error $err.\n");
+            }
+        }
+
+        return $input;
+    }
+}

src/Magento/FunctionalTestingFramework/Module/Util/ModuleUtils.php

@@ -41,6 +41,12 @@ abstract class BaseParallelTestManifest extends BaseTestManifest
      */
     protected $dirPath;
 
+    /**
+     * An array of test name count in a single group
+     * @var array
+     */
+    protected $testCountsToGroup = [];
+
     /**
      * BaseParallelTestManifest constructor.
      *
@@ -87,6 +93,8 @@ public function generate()
         foreach ($this->testGroups as $groupNumber => $groupContents) {
             $this->generateGroupFile($groupContents, $groupNumber, $suites);
         }
+
+        $this->generateGroupSummaryFile($this->testCountsToGroup);
     }
 
     /**
@@ -114,17 +122,35 @@ protected function generateGroupFile($testGroup, $nodeNumber, $suites)
         foreach ($testGroup as $entryName => $testValue) {
             $fileResource = fopen($this->dirPath . DIRECTORY_SEPARATOR . "group{$nodeNumber}.txt", 'a');
 
-            $line = null;
+            $this->testCountsToGroup["group{$nodeNumber}"] = $this->testCountsToGroup["group{$nodeNumber}"] ?? 0;
+
             if (!empty($suites[$entryName])) {
                 $line = "-g {$entryName}";
+                $this->testCountsToGroup["group{$nodeNumber}"] += count($suites[$entryName]);
             } else {
                 $line = $this->relativeDirPath . DIRECTORY_SEPARATOR . $entryName . '.php';
+                $this->testCountsToGroup["group{$nodeNumber}"]++;
             }
             fwrite($fileResource, $line . PHP_EOL);
             fclose($fileResource);
         }
     }
 
+    /**
+     * @param  array $groups
+     * @return void
+     */
+    protected function generateGroupSummaryFile(array $groups)
+    {
+        $fileResource = fopen($this->dirPath . DIRECTORY_SEPARATOR . "mftf_group_summary.txt", 'w');
+        $contents = "Total Number of Groups: " . count($groups) . PHP_EOL;
+        foreach ($groups as $key => $value) {
+            $contents .= $key . " - ". $value . " tests" .PHP_EOL;
+        }
+        fwrite($fileResource, $contents);
+        fclose($fileResource);
+    }
+
     /**
      * Function which recusrively parses a given potentially multidimensional array of suites containing their split
      * groups. The result is a flattened array of suite names to relevant tests for generation of the manifest.

src/Magento/FunctionalTestingFramework/Util/Manifest/BaseParallelTestManifest.php

@@ -773,7 +773,7 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                 $selector = $this->addUniquenessFunctionCall($customActionAttributes['selector']);
                 $selector = $this->resolveLocatorFunctionInAttribute($selector);
             }
-            
+
             if (isset($customActionAttributes['count'])) {
                 $countClickValue = $customActionAttributes['count'];
                 $countValue = $this->addUniquenessFunctionCall($countClickValue);