Merge pull request magento#175 from magento-commerce/MQE-3325

MQE-3325: Invalid UTF-8 chars returned from magentoCLI break Allure reporting

Author: jilu1

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

@@ -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,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.";
  }
 
  /**

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