Introduce DbUrlParser #10

Author: dnaber-de

src/WpTestsStarter/Exception/RuntimeException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WpTestsStarter\Exception;
+
+class RuntimeException extends \RuntimeException implements \Throwable
+{
+}

src/WpTestsStarter/Exception/Throwable.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WpTestsStarter\Exception;
+
+interface Throwable extends \Throwable
+{
+}

src/WpTestsStarter/Helper/DbUrlParser.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WpTestsStarter\Helper;
+
+use WpTestsStarter\Exception\RuntimeException;
+
+class DbUrlParser
+{
+
+    /**
+     * Parses a URL like mysql://user:password@host/database?table_prefix=wp_&charset=utf8mb4
+     * all parts are optional
+     *
+     * @return array{
+     *      host: ?string,
+     *      user: ?string,
+     *      password: ?string,
+     *      db: ?string,
+     *      table_prefix: ?string,
+     *      charset: ?string
+     * }
+     */
+    public function parse(string $dbUrl): array
+    {
+        $credentials = [
+            'host' => null,
+            'user' => null,
+            'password' => null,
+            'db' => null,
+            'table_prefix' => null,
+            'charset' => null,
+        ];
+
+        $parts = parse_url($dbUrl);
+        if (! is_array($parts)) {
+            throw new RuntimeException("Please provide a valid dbUrl");
+        }
+
+        if (array_key_exists('scheme', $parts) && $parts['scheme'] !== 'mysql') {
+            throw new RuntimeException("Currently only 'mysql' databases are supported");
+        }
+
+        array_key_exists('host', $parts) and $credentials['host'] = $parts['host'];
+        array_key_exists('user', $parts) and $credentials['user'] = $parts['user'];
+        array_key_exists('pass', $parts) and $credentials['password'] = $parts['pass'];
+        array_key_exists('path', $parts) and $credentials['db'] = trim($parts['path'], '/');
+
+        if (! array_key_exists('query', $parts) || empty($parts['query'])) {
+            return $credentials;
+        }
+
+        $query = [];
+        parse_str($parts['query'], $query);
+
+        array_key_exists('table_prefix', $query) and $credentials['table_prefix'] = $query['table_prefix'];
+        array_key_exists('charset', $query) and $credentials['charset'] = $query['charset'];
+
+        return $credentials;
+    }
+}

tests/Unit/Helper/DbUrlParserTest.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WpTestsStarter\Test\Unit\Helper;
+
+use PHPUnit\Framework\TestCase;
+use WpTestsStarter\Exception\RuntimeException;
+use WpTestsStarter\Helper\DbUrlParser;
+
+
+class DbUrlParserTest extends TestCase
+{
+
+    /**
+     * @dataProvider parseData
+     */
+    public function testParse(string $dbUrl, array $expected): void
+    {
+        self::assertEquals(
+            $expected,
+            (new DbUrlParser())->parse($dbUrl)
+        );
+    }
+
+    /**
+     * @see testParse
+     */
+    public function parseData(): iterable
+    {
+
+        yield 'Test entire parameter set' => [
+            'dbUrl' => 'mysql://john:T0p3ecr3t@localhost/wordpress?table_prefix=wp_tests_&charset=iso88591',
+            'expected' => [
+                'user' => 'john',
+                'host' => 'localhost',
+                'password' => 'T0p3ecr3t',
+                'db' => 'wordpress',
+                'table_prefix' => 'wp_tests_',
+                'charset' => 'iso88591',
+            ]
+        ];
+
+        yield 'Only user and host' => [
+            'dbUrl' => 'mysql://john@localhost',
+            'expected' => [
+                'user' => 'john',
+                'host' => 'localhost',
+                'password' => null,
+                'db' => null,
+                'table_prefix' => null,
+                'charset' => null,
+            ]
+        ];
+
+        yield 'Nothing at all' => [
+            'dbUrl' => 'mysql:',
+            'expected' => [
+                'user' => null,
+                'host' => null,
+                'password' => null,
+                'db' => null,
+                'table_prefix' => null,
+                'charset' => null,
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider parseThrowsExceptionData
+     */
+    public function testParseThrowsException(string $url, string $expectedMessage): void
+    {
+        $testee = new DbUrlParser();
+
+        self::expectException(RuntimeException::class);
+        self::expectExceptionMessage($expectedMessage);
+
+        $testee->parse($url);
+    }
+
+    /**
+     * @see testParseThrowsException
+     */
+    public function parseThrowsExceptionData(): iterable
+    {
+
+        yield 'Test invalid URL' => [
+            'mysql://',
+            "Please provide a valid dbUrl",
+        ];
+
+        yield 'Test unsupported scheme' => [
+            'mssql:',
+            "Currently only 'mysql' databases are supported",
+        ];
+    }
+}