Merge pull request #4209 from morozov/issues/4122

Test MySQLi connection via TLS on Travis

.travis.yml

@@ -185,6 +185,9 @@ jobs:
     - stage: Test
       php: 7.4
       env: DB=mysqli.docker IMAGE=mysql:8.0
+    - stage: Test
+      php: 7.4
+      env: DB=mysqli-tls.docker IMAGE=mysql:8.0 TLS=yes
     - stage: Test
       php: 7.4
       env: DB=mariadb.docker IMAGE=mariadb:10.3

tests/Doctrine/Tests/DBAL/Functional/Driver/AbstractDriverTest.php

@@ -30,8 +30,9 @@ abstract class AbstractDriverTest extends DbalFunctionalTestCase
 
         $user          = $params['user'] ?? null;
         $password      = $params['password'] ?? null;
+        $driverOptions = $params['driverOptions'] ?? [];
 
-        $connection = $this->driver->connect($params, $user, $password);
+        $connection = $this->driver->connect($params, $user, $password, $driverOptions);
 
         self::assertInstanceOf(DriverConnection::class, $connection);
     }

tests/Doctrine/Tests/DBAL/Functional/Driver/Mysqli/ConnectionTest.php

@@ -8,6 +8,8 @@ use Doctrine\DBAL\Driver\Mysqli\MysqliException;
 use Doctrine\Tests\DbalFunctionalTestCase;
 use Doctrine\Tests\TestUtil;
 
+use function array_merge;
+
 use const MYSQLI_OPT_CONNECT_TIMEOUT;
 
 /**
@@ -54,6 +56,10 @@ class ConnectionTest extends DbalFunctionalTestCase
     {
         $params = TestUtil::getConnectionParams();
 
+        if (isset($params['driverOptions'])) {
+            $driverOptions = array_merge($params['driverOptions'], $driverOptions);
+        }
+
         return new MysqliConnection(
             $params,
             $params['user'] ?? '',

tests/Doctrine/Tests/DBAL/Functional/Driver/PDOSqlsrv/DriverTest.php

@@ -9,6 +9,8 @@ use Doctrine\Tests\DBAL\Functional\Driver\AbstractDriverTest;
 use Doctrine\Tests\TestUtil;
 use PDO;
 
+use function array_merge;
+
 /**
  * @requires extension pdo_sqlsrv
  */
@@ -42,6 +44,10 @@ class DriverTest extends AbstractDriverTest
     {
         $params = TestUtil::getConnectionParams();
 
+        if (isset($params['driverOptions'])) {
+            $driverOptions = array_merge($params['driverOptions'], $driverOptions);
+        }
+
         return $this->connection->getDriver()->connect(
             $params,
             $params['user'] ?? '',

tests/Doctrine/Tests/DBAL/Functional/Schema/SchemaManagerFunctionalTestCase.php

@@ -116,8 +116,9 @@ abstract class SchemaManagerFunctionalTestCase extends DbalFunctionalTestCase
 
         $user          = $params['user'] ?? null;
         $password      = $params['password'] ?? null;
+        $driverOptions = $params['driverOptions'] ?? [];
 
-        $connection = $this->connection->getDriver()->connect($params, $user, $password);
+        $connection = $this->connection->getDriver()->connect($params, $user, $password, $driverOptions);
 
         self::assertInstanceOf(Connection::class, $connection);
 

tests/Doctrine/Tests/DBAL/Functional/Schema/SqliteSchemaManagerTest.php

@@ -45,8 +45,9 @@ class SqliteSchemaManagerTest extends SchemaManagerFunctionalTestCase
 
         $user          = $params['user'] ?? null;
         $password      = $params['password'] ?? null;
+        $driverOptions = $params['driverOptions'] ?? [];
 
-        $connection = $this->connection->getDriver()->connect($params, $user, $password);
+        $connection = $this->connection->getDriver()->connect($params, $user, $password, $driverOptions);
 
         self::assertInstanceOf(Connection::class, $connection);
 

tests/Doctrine/Tests/TestUtil.php

@@ -8,6 +8,9 @@ use PHPUnit\Framework\Assert;
 
 use function explode;
 use function extension_loaded;
+use function strlen;
+use function strpos;
+use function substr;
 use function unlink;
 
 /**
@@ -175,6 +178,11 @@ class TestUtil
                 'dbname',
                 'port',
                 'server',
+                'ssl_key',
+                'ssl_cert',
+                'ssl_ca',
+                'ssl_capath',
+                'ssl_cipher',
                 'unix_socket',
             ] as $parameter
         ) {
@@ -185,6 +193,14 @@ class TestUtil
             $parameters[$parameter] = $configuration[$prefix . $parameter];
         }
 
+        foreach ($configuration as $param => $value) {
+            if (strpos($param, $prefix . 'driver_option_') !== 0) {
+                continue;
+            }
+
+            $parameters['driverOptions'][substr($param, strlen($prefix . 'driver_option_'))] = $value;
+        }
+
         return $parameters;
     }
 

tests/travis/docker-run-mysql-or-mariadb.sh

@@ -40,3 +40,11 @@ while true; do
       ;;
   esac
 done
+
+if [[ "$TLS" == "yes" ]]
+then
+  for file in "ca.pem" "client-cert.pem" "client-key.pem"
+  do
+    docker cp "rdbms:/var/lib/mysql/$file" .
+  done
+fi

tests/travis/mysqli-tls.docker.travis.xml

+<?xml version="1.0" encoding="utf-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../vendor/phpunit/phpunit/phpunit.xsd"
+         colors="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+    <php>
+        <var name="db_driver" value="mysqli"/>
+        <var name="db_host" value="127.0.0.1"/>
+        <var name="db_port" value="33306"/>
+        <var name="db_ssl_ca" value="ca.pem"/>
+        <var name="db_ssl_cert" value="client-cert.pem"/>
+        <var name="db_ssl_key" value="client-key.pem"/>
+
+        <!-- Use MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT since there's no way to generate a certificate
+        with a proper common name (CN) on Travis. This flag must be not used in production settings. -->
+        <var name="db_driver_option_flags" value="64"/>
+
+        <var name="db_user" value="root"/>
+        <var name="db_dbname" value="doctrine_tests"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="Doctrine DBAL Test Suite">
+            <directory>../Doctrine/Tests/DBAL</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory suffix=".php">../../lib/Doctrine</directory>
+        </whitelist>
+    </filter>
+
+    <groups>
+        <exclude>
+            <group>performance</group>
+            <group>locking_functional</group>
+        </exclude>
+    </groups>
+</phpunit>