Merge pull request #58 from easybiblabs/t/couchdb-and-mysql-check

T/couchdb and mysql check

Author: lsmith77

src/ZendDiagnostics/Check/CouchDBCheck.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendDiagnostics\Check;
+
+use ZendDiagnostics\Result;
+
+/**
+ * Ensures a connection to CouchDB is possible.
+ */
+class CouchDBCheck extends GuzzleHttpService
+{
+    /**
+     * @param array $couchDbSettings
+     *
+     * @return self
+     */
+    public function __construct(array $couchDbSettings)
+    {
+        if (false === array_key_exists('url', $couchDbSettings)) {
+            $couchDbUrl = $this->createUrlFromParameters($couchDbSettings);
+        } else {
+            $couchDbUrl = $couchDbSettings['url'];
+        }
+
+        parent::__construct($couchDbUrl);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function check()
+    {
+        $result = parent::check();
+        if ($result instanceof Result\Success) {
+            return $result;
+        }
+
+        $msg = $result->getMessage();
+        $msg = preg_replace('=\/\/(.+):{1}(.+)(\@){1}=i', '//', $msg);
+
+        $failure = new Result\Failure($msg, $result->getData());
+
+        return $failure;
+    }
+
+    /**
+     * Assumes CouchDB defaults. Port 80 or 5984 is non-SSL, SSL otherwise.
+     * Override with 'protocol' if you run something else.
+     *
+     * Requires/Supports the following keys in the array:
+     *
+     *  - dbname
+     *  - host
+     *  - port
+     *  - protocol (optional)
+     *  - username (optional)
+     *  - password (optional)
+     *
+     * @param array $couchDbSettings
+     *
+     * @return string
+     */
+    private function createUrlFromParameters(array $couchDbSettings)
+    {
+        $couchDbUrl = '';
+
+        if (array_key_exists('protocol', $couchDbSettings)) {
+            $couchDbUrl .= $couchDbSettings['protocol'] . '://';
+        } else {
+            if ($couchDbSettings['port'] === '5984' || $couchDbSettings['port'] === '80') {
+                $couchDbUrl .= 'http://';
+            } else {
+                $couchDbUrl .= 'https://';
+            }
+        }
+
+        if ($couchDbSettings['username'] && $couchDbSettings['password']) {
+            $couchDbUrl .= sprintf(
+                '%s:%s@',
+                $couchDbSettings['username'],
+                $couchDbSettings['password']
+            );
+        }
+
+        $couchDbUrl .= sprintf(
+            '%s:%s/%s',
+            $couchDbSettings['host'],
+            $couchDbSettings['port'],
+            $couchDbSettings['dbname']
+        );
+
+        return $couchDbUrl;
+    }
+}

src/ZendDiagnostics/Check/PDOCheck.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendDiagnostics\Check;
+
+use PDO;
+use ZendDiagnostics\Result;
+
+/**
+ * Ensures a connection to the MySQL server/database is possible.
+ */
+class PDOCheck implements CheckInterface
+{
+    private $dsn;
+    private $password;
+    private $username;
+    private $timeout;
+
+    /**
+     * @param string $dsn
+     * @param string $username
+     * @param string $password
+     * @param int $timeout
+     *
+     * @return self
+     */
+    public function __construct($dsn, $username, $password, $timeout = 1)
+    {
+        $this->dsn = $dsn;
+        $this->username = $username;
+        $this->password = $password;
+        $this->timeout = $timeout;
+    }
+
+    /**
+     * @return Result\Failure|Result\Success
+     */
+    public function check()
+    {
+        $msg = 'Could not talk to database server';
+
+        try {
+            $pdo = new PDO($this->dsn, $this->username, $this->password);
+
+            $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+            $pdo->setAttribute(PDO::ATTR_TIMEOUT, $this->timeout);
+
+            $status = $pdo->getAttribute(PDO::ATTR_CONNECTION_STATUS);
+            if (null !== $status) {
+                return new Result\Success('Connection to database server was successful.');
+            }
+        } catch (\PDOException $e) {
+            // skip to failure
+            $msg .= ', e: ' . $e->getCode();
+        }
+
+        return new Result\Failure($msg);
+    }
+
+    /**
+     * @return string
+     */
+    public function getLabel()
+    {
+        return 'Check if the database server can be reached';
+    }
+}

tests/ZendDiagnosticsTest/GuzzleHttpServiceTest.php

@@ -9,10 +9,22 @@
 use Guzzle\Plugin\Mock\MockPlugin;
 use GuzzleHttp\Stream\Stream;
 use GuzzleHttp\Subscriber\Mock;
+use ZendDiagnostics\Check\CouchDBCheck;
 use ZendDiagnostics\Check\GuzzleHttpService;
 
 class GuzzleHttpServiceTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @param array $params
+     *
+     * @dataProvider couchDbProvider
+     */
+    public function testCouchDbCheck(array $params)
+    {
+        $check = new CouchDBCheck($params);
+        $this->assertInstanceOf('ZendDiagnostics\Check\CouchDbCheck', $check);
+    }
+
     /**
      * @dataProvider checkProvider
      */
@@ -84,6 +96,14 @@ public function checkProvider()
         );
     }
 
+    public function couchDbProvider()
+    {
+        return array(
+            array(array('url' => 'http://root:party@localhost/hello')),
+            array(array('host' => '127.0.0.1', 'port' => '443', 'username' => 'test', 'password' => 'test', 'dbname' => 'database')),
+        );
+    }
+
     private function getMockGuzzle3Client($statusCode = 200, $content = null)
     {
         $plugin = new MockPlugin();