MFTF-33782: Code refactoring

Author: bohdan-harniuk

dev/tests/unit/Magento/FunctionalTestFramework/Util/Path/FilePathFormatterTest.php

@@ -3,25 +3,28 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace tests\unit\Magento\FunctionalTestFramework\Util\Path;
 
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
-use tests\unit\Util\MagentoTestCase;
 use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter;
+use tests\unit\Util\MagentoTestCase;
 
 class FilePathFormatterTest extends MagentoTestCase
 {
     /**
-     * Test file format
+     * Test file format.
      *
-     * @dataProvider formatDataProvider
      * @param string $path
-     * @param boolean $withTrailingSeparator
-     * @param mixed string|boolean $expectedPath
+     * @param bool $withTrailingSeparator
+     * @param string|null $expectedPath
+     *
      * @return void
      * @throws TestFrameworkException
+     * @dataProvider formatDataProvider
      */
-    public function testFormat($path, $withTrailingSeparator, $expectedPath)
+    public function testFormat(string $path, bool $withTrailingSeparator, ?string $expectedPath): void
     {
         if (null !== $expectedPath) {
             $this->assertEquals($expectedPath, FilePathFormatter::format($path, $withTrailingSeparator));
@@ -33,52 +36,54 @@ public function testFormat($path, $withTrailingSeparator, $expectedPath)
     }
 
     /**
-     * Test file format with exception
+     * Test file format with exception.
      *
-     * @dataProvider formatExceptionDataProvider
      * @param string $path
-     * @param boolean $withTrailingSeparator
+     * @param bool $withTrailingSeparator
+     *
      * @return void
      * @throws TestFrameworkException
+     * @dataProvider formatExceptionDataProvider
      */
-    public function testFormatWithException($path, $withTrailingSeparator)
+    public function testFormatWithException(string $path, bool $withTrailingSeparator): void
     {
         $this->expectException(TestFrameworkException::class);
         $this->expectExceptionMessage("Invalid or non-existing file: $path\n");
         FilePathFormatter::format($path, $withTrailingSeparator);
     }
 
     /**
-     * Data input
+     * Data input.
      *
      * @return array
      */
-    public function formatDataProvider()
+    public function formatDataProvider(): array
     {
         $path1 = rtrim(TESTS_BP, '/');
         $path2 = $path1 . DIRECTORY_SEPARATOR;
+
         return [
-            [$path1, null, $path1],
+            [$path1, false, $path1],
             [$path1, false, $path1],
             [$path1, true, $path2],
-            [$path2, null, $path1],
+            [$path2, false, $path1],
             [$path2, false, $path1],
             [$path2, true, $path2],
-            [__DIR__. DIRECTORY_SEPARATOR . basename(__FILE__), null, __FILE__],
-            ['', null, null] // Empty string is valid
+            [__DIR__. DIRECTORY_SEPARATOR . basename(__FILE__), false, __FILE__],
+            ['', false, null] // Empty string is valid
         ];
     }
 
     /**
-     * Invalid data input
+     * Invalid data input.
      *
      * @return array
      */
-    public function formatExceptionDataProvider()
+    public function formatExceptionDataProvider(): array
     {
         return [
-            ['abc', null],
-            ['X://some\dir/@', null],
+            ['abc', false],
+            ['X://some\dir/@', false]
         ];
     }
 }

src/Magento/FunctionalTestingFramework/Util/Path/FilePathFormatter.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\FunctionalTestingFramework\Util\Path;
 
@@ -11,14 +12,15 @@
 class FilePathFormatter implements FormatterInterface
 {
     /**
-     * Return formatted full file path from input string, or false on error
+     * Return formatted full file path from input string, or false on error.
      *
      * @param string  $path
      * @param boolean $withTrailingSeparator
+     *
      * @return string
      * @throws TestFrameworkException
      */
-    public static function format($path, $withTrailingSeparator = true)
+    public static function format(string $path, bool $withTrailingSeparator = true): string
     {
         $validPath = realpath($path);
 

src/Magento/FunctionalTestingFramework/Util/Path/FormatterInterface.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\FunctionalTestingFramework\Util\Path;
 
@@ -11,12 +12,13 @@
 interface FormatterInterface
 {
     /**
-     * Return formatted path (file path, url, etc) from input string, or false on error
+     * Return formatted path (file path, url, etc) from input string, or false on error.
      *
      * @param string  $input
      * @param boolean $withTrailingSeparator
+     *
      * @return string
      * @throws TestFrameworkException
      */
-    public static function format($input, $withTrailingSeparator = true);
+    public static function format(string $input, bool $withTrailingSeparator = true): string;
 }

src/Magento/FunctionalTestingFramework/Util/Path/UrlFormatter.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\FunctionalTestingFramework\Util\Path;
 
@@ -11,14 +12,15 @@
 class UrlFormatter implements FormatterInterface
 {
     /**
-     * Return formatted url path from input string
+     * Return formatted url path from input string.
      *
      * @param string  $url
      * @param boolean $withTrailingSeparator
+     *
      * @return string
      * @throws TestFrameworkException
      */
-    public static function format($url, $withTrailingSeparator = true)
+    public static function format(string $url, bool $withTrailingSeparator = true): string
     {
         $sanitizedUrl = rtrim($url, '/');
 
@@ -47,12 +49,13 @@ public static function format($url, $withTrailingSeparator = true)
     }
 
     /**
-     * Try to build missing url scheme and host
+     * Try to build missing url scheme and host.
      *
      * @param string $url
+     *
      * @return string
      */
-    private static function buildUrl($url)
+    private static function buildUrl(string $url): string
     {
         $urlParts = parse_url($url);
 
@@ -76,32 +79,42 @@ private static function buildUrl($url)
     /**
      * Returns url from $parts given, used with parse_url output for convenience.
      * This only exists because of deprecation of http_build_url, which does the exact same thing as the code below.
+     *
      * @param array $parts
+     *
      * @return string
      */
-    private static function merge(array $parts)
+    private static function merge(array $parts): string
     {
         $get = function ($key) use ($parts) {
-            return isset($parts[$key]) ? $parts[$key] : null;
+            return $parts[$key] ?? '';
         };
 
-        $pass      = $get('pass');
-        $user      = $get('user');
-        $userinfo  = $pass !== null ? "$user:$pass" : $user;
-        $port      = $get('port');
-        $scheme    = $get('scheme');
-        $query     = $get('query');
-        $fragment  = $get('fragment');
-        $authority =
-            ($userinfo !== null ? "$userinfo@" : '') .
-            $get('host') .
-            ($port ? ":$port" : '');
-
-        return
-            (strlen($scheme) ? "$scheme:" : '') .
-            (strlen($authority) ? "//$authority" : '') .
-            $get('path') .
-            (strlen($query) ? "?$query" : '') .
-            (strlen($fragment) ? "#$fragment" : '');
+        $pass = $get('pass');
+        $user = $get('user');
+        $userinfo = $pass !== '' ? "$user:$pass" : $user;
+        $port = $get('port');
+        $scheme = $get('scheme');
+        $query = $get('query');
+        $fragment = $get('fragment');
+        $authority = ($userinfo !== '' ? "$userinfo@" : '') . $get('host') . ($port ? ":$port" : '');
+
+        return str_replace(
+            [
+                '%scheme',
+                '%authority',
+                '%path',
+                '%query',
+                '%fragment'
+            ],
+            [
+                strlen($scheme) ? "$scheme:" : '',
+                strlen($authority) ? "//$authority" : '',
+                $get('path'),
+                strlen($query) ? "?$query" : '',
+                strlen($fragment) ? "#$fragment" : ''
+            ],
+            '%scheme%authority%path%query%fragment'
+        );
     }
 }