Added basic support for custom exceptions

martin-schilling · martin-schilling · commit 58574636e3e1 · 2017-12-06T19:11:19.000+01:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -31,7 +31,7 @@ endif()
 option(BuildVelocyPackExamples "Build examples" OFF)
 option(BuildTools "Build support programs and tools" OFF)
 
-#include_directories(/usr/local/include/php /usr/local/include/php/TSRM /usr/local/include/php/main /usr/local/include/php/Zend)
+include_directories(/usr/local/include/php /usr/local/include/php/TSRM /usr/local/include/php/main /usr/local/include/php/Zend)
 
 add_subdirectory(deps/fuerte)
 #add_subdirectory(deps/phpcpp)
diff --git a/Dockerfile.builder b/Dockerfile.builder
@@ -30,5 +30,7 @@ VOLUME ["/app"]
 
 RUN apk add --update bash && rm -rf /tmp/*
 
+RUN docker-php-source extract
+
 ENTRYPOINT []
 CMD bash -c "cd /app/build && cmake .. -DPHPCPP_ARCH=x86_64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS=-fPIC && make"
diff --git a/src/connection.cpp b/src/connection.cpp
@@ -55,9 +55,9 @@ namespace arangodb { namespace fuerte { namespace php {
 
     fu::ConnectionBuilder Connection::createConnectionBuilder()
     {
-        try {
-            fu::ConnectionBuilder cbuilder{};
+        fu::ConnectionBuilder cbuilder{};
 
+        try {
             for (const auto &p : this->options) {
                 switch (connectionOptions.at(p.first)) {
                     case ConnectionOptions::HOST:
@@ -80,12 +80,12 @@ namespace arangodb { namespace fuerte { namespace php {
                         break;
                 }
             }
-
-            return cbuilder;
         }
         catch (const std::exception &ex) {
-            throw Php::Exception("Unknown option provided.");
+            ARANGODB_THROW(InvalidOptionException(), "Unknown option provided in %s on line %d");
         }
+
+        return cbuilder;
     }
 
     void Connection::connect()
diff --git a/src/connection.h b/src/connection.h
@@ -5,6 +5,7 @@
 
 #include "request.h"
 #include "response.h"
+#include "exception.h"
 
 namespace fu = ::arangodb::fuerte;
 
diff --git a/src/exception.h b/src/exception.h
@@ -0,0 +1,56 @@
+#pragma once
+
+#include <cmath>
+using namespace std;
+
+#include <Zend/zend.h>
+#include <Zend/zend_exceptions.h>
+#include <Zend/zend_API.h>
+
+#define ARANGODB_THROW(ex, message) zend_throw_exception_ex(ex, 0, message, __FILE__, __LINE__);
+
+
+namespace arangodb { namespace fuerte { namespace php {
+
+    static zend_class_entry* _RuntimeException;
+    static zend_class_entry* _InvalidOptionException;
+
+
+    static zend_class_entry* RuntimeException() {
+        zend_string *exceptionClassName = zend_string_tolower(zend_string_init(ZEND_STRL("ArangoDb\\RuntimeException"), 1));
+        zend_class_entry *exceptionClass = static_cast<zend_class_entry*>(zend_hash_find_ptr(CG(class_table), exceptionClassName));
+        zend_string_release(exceptionClassName);
+
+        return exceptionClass;
+    }
+
+    static zend_class_entry* InvalidOptionException() {
+        zend_string *exceptionClassName = zend_string_tolower(zend_string_init(ZEND_STRL("ArangoDb\\InvalidOptionException"), 1));
+        zend_class_entry *exceptionClass = static_cast<zend_class_entry*>(zend_hash_find_ptr(CG(class_table), exceptionClassName));
+        zend_string_release(exceptionClassName);
+
+        return exceptionClass;
+    }
+
+
+    static void registerRuntimeException()
+    {
+        zend_class_entry ce;
+        INIT_CLASS_ENTRY(ce, "ArangoDb\\RuntimeException", NULL);
+        _RuntimeException = zend_register_internal_class_ex(&ce, zend_exception_get_default());
+    }
+
+    static void registerInvalidOptionException()
+    {
+        zend_class_entry ce;
+        INIT_CLASS_ENTRY(ce, "ArangoDb\\InvalidOptionException", NULL);
+        _InvalidOptionException = zend_register_internal_class_ex(&ce, _RuntimeException);
+    }
+
+    static void registerCustomExceptions()
+    {
+        registerRuntimeException();
+        registerInvalidOptionException();
+    }
+
+}}}
diff --git a/src/main.cpp b/src/main.cpp
@@ -5,6 +5,7 @@
 #include "response.h"
 #include "vpack.h"
 #include "cursor.h"
+#include "exception.h"
 
 extern "C" {
 
@@ -33,6 +34,10 @@ extern "C" {
         exportClassResponse(&extension);
         exportClassCursor(&extension);
 
+        extension.onStartup([]() {
+            arangodb::fuerte::php::registerCustomExceptions();
+        });
+
         return extension;
     }
 
diff --git a/tests/ConnectionTest.php b/tests/ConnectionTest.php
@@ -61,8 +61,7 @@ public function it_throws_invalid_option_exception(): void
                 'unknown' => 'error',
             ]
         );
-
-        $this->expectException(\Exception::class);
+        $this->expectException(\ArangoDb\InvalidOptionException::class);
         $this->expectExceptionMessage('Unknown option provided');
 
         $connection->connect();
diff --git a/tests/ExceptionTest.php b/tests/ExceptionTest.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ArangoDbDriverTest;
+
+use PHPUnit\Framework\TestCase;
+use ArangoDb\Connection;
+
+/**
+ * @group connection
+ */
+class ExceptionTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_throws_valid_custom_exception(): void
+    {
+        try {
+            $connection = new Connection([
+                'unknown' => 'error'
+            ]);
+
+            $connection->connect();
+
+            $this->assertTrue(false);
+
+        } catch(\Throwable $e) {
+            $this->assertInstanceOf(\Exception::class, $e);
+            $this->assertInstanceOf(\ArangoDb\RuntimeException::class, $e);
+            $this->assertInstanceOf(\ArangoDb\InvalidOptionException::class, $e);
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -55,9 +55,9 @@ namespace arangodb { namespace fuerte { namespace php {`
`55`	`55`
`56`	`56`	`fu::ConnectionBuilder Connection::createConnectionBuilder()`
`57`	`57`	`{`
`58`		`- try {`
`59`		`- fu::ConnectionBuilder cbuilder{};`
	`58`	`+ fu::ConnectionBuilder cbuilder{};`
`60`	`59`
	`60`	`+ try {`
`61`	`61`	`for (const auto &p : this->options) {`
`62`	`62`	`switch (connectionOptions.at(p.first)) {`
`63`	`63`	`case ConnectionOptions::HOST:`
`@@ -80,12 +80,12 @@ namespace arangodb { namespace fuerte { namespace php {`
`80`	`80`	`break;`
`81`	`81`	`}`
`82`	`82`	`}`
`83`		`-`
`84`		`- return cbuilder;`
`85`	`83`	`}`
`86`	`84`	`catch (const std::exception &ex) {`
`87`		`- throw Php::Exception("Unknown option provided.");`
	`85`	`+ ARANGODB_THROW(InvalidOptionException(), "Unknown option provided in %s on line %d");`
`88`	`86`	`}`
	`87`	`+`
	`88`	`+ return cbuilder;`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`void Connection::connect()`
Original file line number	Diff line number	Diff line change
`@@ -61,8 +61,7 @@ public function it_throws_invalid_option_exception(): void`
`61`	`61`	`'unknown' => 'error',`
`62`	`62`	`]`
`63`	`63`	`);`
`64`		`-`
`65`		`- $this->expectException(\Exception::class);`
	`64`	`+ $this->expectException(\ArangoDb\InvalidOptionException::class);`
`66`	`65`	`$this->expectExceptionMessage('Unknown option provided');`
`67`	`66`
`68`	`67`	`$connection->connect();`