MQE-3267: trim invalid utf-8 characters from response

Author: jilu1

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

@@ -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]
+        ];
+    }
+}

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -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;
@@ -584,7 +585,8 @@ public function magentoCLI($command, $timeout = null, $arguments = null)
         $response = $executor->read();
         $executor->close();
 
-        $response = trim($this->safeUtf8Conversion($response));
+        $util = new ModuleUtils();
+        $response = trim($util->utf8SafeControlCharacterTrim($response));
         return $response != "" ? $response : "CLI did not return output.";
     }
 
@@ -1060,29 +1062,4 @@ public function pause($pauseOnFail = false)
 
         $this->codeceptPause();
     }
-
-    /**
-     * Return UTF-8 encoding string with control/invisible characters removed, return original string on error.
-     *
-     * @param string $input
-     * @return string
-     */
-    private function safeUtf8Conversion(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

@@ -0,0 +1,32 @@
+<?php
+
+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;
+    }
+}