The IBM DB2 driver Exception class must implement the DriverException…

… interface

lib/Doctrine/DBAL/Driver/IBMDB2/DB2Connection.php

@@ -3,6 +3,9 @@
 namespace Doctrine\DBAL\Driver\IBMDB2;
 
 use Doctrine\DBAL\Driver\Connection;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\ConnectionError;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\ConnectionFailed;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\PrepareFailed;
 use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
 use Doctrine\DBAL\ParameterType;
 use stdClass;
@@ -21,7 +24,7 @@
 use function db2_prepare;
 use function db2_rollback;
 use function db2_server_info;
-use function db2_stmt_errormsg;
+use function error_get_last;
 use function func_get_args;
 use function is_bool;
 
@@ -52,7 +55,7 @@ public function __construct(array $params, $username, $password, $driverOptions
         }
 
         if ($conn === false) {
-            throw new DB2Exception(db2_conn_errormsg());
+            throw ConnectionFailed::new();
         }
 
         $this->conn = $conn;
@@ -83,8 +86,9 @@ public function requiresQueryForServerVersion()
     public function prepare($sql)
     {
         $stmt = @db2_prepare($this->conn, $sql);
-        if (! $stmt) {
-            throw new DB2Exception(db2_stmt_errormsg());
+
+        if ($stmt === false) {
+            throw PrepareFailed::new(error_get_last()['message']);
         }
 
         return new DB2Statement($stmt);
@@ -125,7 +129,7 @@ public function exec($statement)
         $stmt = @db2_exec($this->conn, $statement);
 
         if ($stmt === false) {
-            throw new DB2Exception(db2_stmt_errormsg());
+            throw ConnectionError::new($this->conn);
         }
 
         return db2_num_rows($stmt);
@@ -156,7 +160,7 @@ public function beginTransaction()
     public function commit()
     {
         if (! db2_commit($this->conn)) {
-            throw new DB2Exception(db2_conn_errormsg($this->conn));
+            throw ConnectionError::new($this->conn);
         }
 
         $result = db2_autocommit($this->conn, DB2_AUTOCOMMIT_ON);
@@ -171,7 +175,7 @@ public function commit()
     public function rollBack()
     {
         if (! db2_rollback($this->conn)) {
-            throw new DB2Exception(db2_conn_errormsg($this->conn));
+            throw ConnectionError::new($this->conn);
         }
 
         $result = db2_autocommit($this->conn, DB2_AUTOCOMMIT_ON);

lib/Doctrine/DBAL/Driver/IBMDB2/DB2Exception.php

@@ -2,11 +2,11 @@
 
 namespace Doctrine\DBAL\Driver\IBMDB2;
 
-use Exception;
+use Doctrine\DBAL\Driver\AbstractDriverException;
 
 /**
  * @psalm-immutable
  */
-class DB2Exception extends Exception
+class DB2Exception extends AbstractDriverException
 {
 }

lib/Doctrine/DBAL/Driver/IBMDB2/DB2Statement.php

@@ -3,6 +3,7 @@
 namespace Doctrine\DBAL\Driver\IBMDB2;
 
 use Doctrine\DBAL\Driver\FetchUtils;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\StatementError;
 use Doctrine\DBAL\Driver\Result;
 use Doctrine\DBAL\Driver\Statement;
 use Doctrine\DBAL\Driver\StatementIterator;
@@ -141,7 +142,7 @@ private function bind($position, &$variable, int $parameterType, int $dataType):
         $this->bindParam[$position] =& $variable;
 
         if (! db2_bind_param($this->stmt, $position, 'variable', $parameterType, $dataType)) {
-            throw new DB2Exception(db2_stmt_errormsg());
+            throw StatementError::new($this->stmt);
         }
     }
 
@@ -219,7 +220,7 @@ public function execute($params = null)
             $this->writeStringToStream($source, $target);
         }
 
-        $retval = db2_execute($this->stmt, $params);
+        $retval = @db2_execute($this->stmt, $params);
 
         foreach ($this->lobs as [, $handle]) {
             fclose($handle);
@@ -228,7 +229,7 @@ public function execute($params = null)
         $this->lobs = [];
 
         if ($retval === false) {
-            throw new DB2Exception(db2_stmt_errormsg());
+            throw StatementError::new($this->stmt);
         }
 
         $this->result = true;

lib/Doctrine/DBAL/Driver/IBMDB2/Exception/ConnectionError.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Driver\IBMDB2\Exception;
+
+use Doctrine\DBAL\Driver\IBMDB2\DB2Exception;
+
+use function db2_conn_error;
+use function db2_conn_errormsg;
+
+/**
+ * @psalm-immutable
+ */
+final class ConnectionError extends DB2Exception
+{
+    /**
+     * @param resource $connection
+     */
+    public static function new($connection): self
+    {
+        return new self(db2_conn_errormsg($connection), db2_conn_error($connection));
+    }
+}

lib/Doctrine/DBAL/Driver/IBMDB2/Exception/ConnectionFailed.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Driver\IBMDB2\Exception;
+
+use Doctrine\DBAL\Driver\IBMDB2\DB2Exception;
+
+use function db2_conn_error;
+use function db2_conn_errormsg;
+
+/**
+ * @psalm-immutable
+ */
+final class ConnectionFailed extends DB2Exception
+{
+    public static function new(): self
+    {
+        return new self(db2_conn_errormsg(), db2_conn_error());
+    }
+}

lib/Doctrine/DBAL/Driver/IBMDB2/Exception/PrepareFailed.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Driver\IBMDB2\Exception;
+
+use Doctrine\DBAL\Driver\IBMDB2\DB2Exception;
+
+/**
+ * @psalm-immutable
+ */
+final class PrepareFailed extends DB2Exception
+{
+    public static function new(string $message): self
+    {
+        return new self($message);
+    }
+}

lib/Doctrine/DBAL/Driver/IBMDB2/Exception/StatementError.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Driver\IBMDB2\Exception;
+
+use Doctrine\DBAL\Driver\IBMDB2\DB2Exception;
+
+use function db2_stmt_error;
+use function db2_stmt_errormsg;
+
+/**
+ * @psalm-immutable
+ */
+final class StatementError extends DB2Exception
+{
+    /**
+     * @param resource $statement
+     */
+    public static function new($statement): self
+    {
+        return new self(db2_stmt_errormsg($statement), db2_stmt_error($statement));
+    }
+}

phpcs.xml.dist

@@ -99,6 +99,11 @@
         <exclude-pattern>lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php</exclude-pattern>
     </rule>
 
+    <!-- See https://github.com/slevomat/coding-standard/issues/1038 -->
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+        <exclude-pattern>tests/Doctrine/Tests/DBAL/Functional/Driver/IBMDB2/DB2StatementTest.php</exclude-pattern>
+    </rule>
+
     <!-- see https://github.com/doctrine/dbal/issues/3377 -->
     <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator">
         <exclude-pattern>lib/Doctrine/DBAL/Schema/Comparator.php</exclude-pattern>

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

@@ -0,0 +1,55 @@
+<?php
+
+namespace Doctrine\Tests\DBAL\Functional\Driver\IBMDB2;
+
+use Doctrine\DBAL\Driver\IBMDB2\DB2Connection;
+use Doctrine\DBAL\Driver\IBMDB2\DB2Driver;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\ConnectionFailed;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\PrepareFailed;
+use Doctrine\Tests\DbalFunctionalTestCase;
+use ReflectionProperty;
+
+use function db2_close;
+use function extension_loaded;
+
+class ConnectionTest extends DbalFunctionalTestCase
+{
+    protected function setUp(): void
+    {
+        if (! extension_loaded('ibm_db2')) {
+            $this->markTestSkipped('ibm_db2 is not installed.');
+        }
+
+        parent::setUp();
+
+        if ($this->connection->getDriver() instanceof DB2Driver) {
+            return;
+        }
+
+        $this->markTestSkipped('ibm_db2 only test.');
+    }
+
+    protected function tearDown(): void
+    {
+        $this->resetSharedConn();
+    }
+
+    public function testConnectionFailure(): void
+    {
+        $this->expectException(ConnectionFailed::class);
+        new DB2Connection(['dbname' => 'garbage'], '', '');
+    }
+
+    public function testPrepareFailure(): void
+    {
+        $driverConnection = $this->connection->getWrappedConnection();
+
+        $re = new ReflectionProperty($driverConnection, 'conn');
+        $re->setAccessible(true);
+        $conn = $re->getValue($driverConnection);
+        db2_close($conn);
+
+        $this->expectException(PrepareFailed::class);
+        $driverConnection->prepare('SELECT 1');
+    }
+}

tests/Doctrine/Tests/DBAL/Functional/Driver/IBMDB2/DB2StatementTest.php

@@ -5,10 +5,14 @@
 namespace Doctrine\Tests\DBAL\Functional\Driver\IBMDB2;
 
 use Doctrine\DBAL\Driver\IBMDB2\DB2Driver;
+use Doctrine\DBAL\Driver\IBMDB2\Exception\StatementError;
 use Doctrine\Tests\DbalFunctionalTestCase;
 
 use function extension_loaded;
 
+use const E_ALL;
+use const E_NOTICE;
+
 class DB2StatementTest extends DbalFunctionalTestCase
 {
     protected function setUp(): void
@@ -28,12 +32,14 @@ protected function setUp(): void
 
     public function testExecutionErrorsAreNotSuppressed(): void
     {
-        $stmt = $this->connection->prepare('SELECT * FROM SYSIBM.SYSDUMMY1 WHERE \'foo\' = ?');
+        $driverConnection = $this->connection->getWrappedConnection();
+
+        $stmt = $driverConnection->prepare('SELECT * FROM SYSIBM.SYSDUMMY1 WHERE \'foo\' = ?');
 
-        // unwrap the statement to prevent the wrapper from handling the PHPUnit-originated exception
-        $wrappedStmt = $stmt->getWrappedStatement();
+        // prevent the PHPUnit error handler from handling the unsuppressed notice that may come from db2_execute()
+        $this->iniSet('error_reporting', (string) (E_ALL & ~E_NOTICE));
 
-        $this->expectNotice();
-        $wrappedStmt->execute([[]]);
+        $this->expectException(StatementError::class);
+        $stmt->execute([[]]);
     }
 }