manually apply changes from @tomterl

jsteemann · jsteemann · commit d50d9458c06f · 2017-01-17T16:20:52.000+01:00
diff --git a/lib/ArangoDBClient/FoxxHandler.php b/lib/ArangoDBClient/FoxxHandler.php
@@ -0,0 +1,87 @@
+<?php
+
+/**
+ * ArangoDB PHP client: foxx upload
+ *
+ * @package   ArangoDBClient
+ * @author    Tom Regner <thomas.regner@fb-research.de>
+ * @copyright Copyright 2016, triagens GmbH, Cologne, Germany
+ */
+
+namespace ArangoDBClient;
+
+/**
+ * A class for uploading Foxx application zips to a database
+ *
+ * @package   ArangoDBClient
+ * @since     3.1
+ */
+class FoxxHandler extends Handler
+{
+    /**
+     * Upload and install a foxx app.
+     *
+     * @throws ClientException
+     *
+     * @param string $localZip          - the path to the local foxx-app zip-archive to upload/install
+     * @param string mountPoint         - the mountpoint for the app, must begin with a '/'
+     * @param array $options            - for future usage
+     * @return array - the server response
+     * 
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function installFoxxZip($localZip, $mountPoint, $options = array())
+    {
+        if (!file_exists($localZip)) {
+            throw new ClientException("Foxx-Zip {$localZip} does not exist (or file is unreadable).");
+        }
+        
+        try {
+            $post = file_get_contents($localZip);
+            $response = $this->getConnection()->post(Urls::URL_UPLOAD, $post);
+
+            if ($response->getHttpCode() < 400) {
+                $response = $this->getConnection()->put(Urls::URL_FOXX_INSTALL, json_encode(array('appInfo' => $response->getJson()['filename'], 'mount' => $mountPoint)));
+                if ($response->getHttpCode() < 400) {
+                    return $response->getJson();
+                } else { 
+                    throw new ClientException('Foxx-Zip install failed');
+                }
+            } else { 
+                throw new ClientException('Foxx-Zip upload failed');
+            }
+        } catch (ServerException $e) {
+            throw new ClientException($e->getMessage());
+        }
+    }
+
+    /**
+     * Remove a foxx-app.
+     *
+     * @throws ClientException
+     *
+     * @param string mountPoint         - the mountpoint for the app, must begin with a '/'
+     * @param array $options            - for future usage
+     * @return array - the server response
+     * 
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function removeFoxxApp($mountPoint, $options = array())
+    {
+        try {
+            $response = $this->getConnection()->put(Urls::URL_FOXX_UNINSTALL, json_encode(array('mount' => $mountPoint)));
+            if ($response->getHttpCode() < 400) {
+                return $response->getJson();
+            } else { 
+                throw new ClientException(sprintf('Foxx uninstall failed (Code: %d)', $response->getHttpCode()));
+            }
+        } catch(ServerException $e) {
+            if ($e->getMessage() === 'Service not found') {
+                throw new ClientException(sprintf('Mount point %s not present.', $mountPoint));
+            }
+            throw new ClientException($e->getMessage());
+        }
+    }
+}
+
+class_alias(FoxxHandler::class, '\triagens\ArangoDb\FoxxHandler');
diff --git a/lib/ArangoDBClient/Urls.php b/lib/ArangoDBClient/Urls.php
@@ -228,6 +228,20 @@ abstract class Urls
      */
     const URL_QUERY_CACHE = '/_api/query-cache';
 
+    /**
+     * URL for file uploads
+     */
+    const URL_UPLOAD = '/_api/upload';
+
+    /**
+     * URL for foxx-app installations
+     */
+    const URL_FOXX_INSTALL = '/_admin/foxx/install';
+
+    /**
+     * URL for foxx-app deinstallation
+     */
+    const URL_FOXX_UNINSTALL = '/_admin/foxx/uninstall';
 }
 
 class_alias(Urls::class, '\triagens\ArangoDb\Urls');
diff --git a/tests/FoxxBasicTest.php b/tests/FoxxBasicTest.php
@@ -0,0 +1,66 @@
+<?php
+/**
+ * ArangoDB PHP client testsuite
+ * File: FoxxBasicTest.php
+ *
+ * @package   ArangoDBClient
+ * @author  Tom Regner <thomas.regner@fb-research.de>
+ */
+
+namespace ArangoDBClient;
+
+
+/**
+ * Class FoxxBasicTest
+ *
+ * @property Connection        $connection
+ * @property FoxxHandler       $foxxHandler
+ *
+ * @package   ArangoDBClient
+ */
+class FoxxBasicTest extends
+    \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        $this->connection  = getConnection();
+        $this->foxxHandler = new FoxxHandler($this->connection);
+    }
+
+
+    /**
+     * Try to upload and install a demo app
+     */
+    public function testUploadAndInstallFoxxApp()
+    {
+        $foxxHandler      = $this->foxxHandler;
+        $zip = __DIR__ . '/files_for_tests/demo-hello-foxx-master.zip';
+        $response = $foxxHandler->installFoxxZip($zip, '/hello_world');
+        static::assertEquals(200, (int)$response['code'], 'Status not 200');
+        static::assertEquals('/hello_world', $response['mount'], 'Wrong mountpoint');
+    }
+
+    /**
+     * Try to upload and install a non-existing app
+     * @expectedException \ArangoDBClient\ClientException
+     */
+    public function testUploadAndInstallNonExistingFoxxApp()
+    {
+        $foxxHandler      = $this->foxxHandler;
+        $zip = __DIR__ . '/files_for_tests/move_along.zip';
+        $foxxHandler->installFoxxZip($zip, '/move_along');
+    }
+
+
+    public function tearDown()
+    {
+        $foxxHandler      = $this->foxxHandler;
+        try{
+            // ignore errors
+            $foxxHandler->removeFoxxApp('/hello_world');
+        } catch(ClientException $e){
+            // ignore
+        }
+        unset($this->foxxHandler, $this->connection);
+    }
+}
diff --git a/tests/files_for_tests/demo-hello-foxx-master.zip b/tests/files_for_tests/demo-hello-foxx-master.zip
