Throw exceptions when "connect" fails

Author: tersmitten

Model/Datasource/RedisSource.php

@@ -123,19 +123,33 @@ public function enabled() {
 /**
  * Connects to the database using options in the given configuration array.
  *
- *  "Connects mean:
+ *  "Connects" means:
  *  - connect
  *  - authenticate
  *  - select
  *  - setPrefix
  *
- * @return bool
+ * @return bool True if all of the above steps succeed, else false
+ * @throws RedisSourceException
  */
 	public function connect() {
-		$this->connected = $this->_connect();
-		$this->connected = $this->connected && $this->_authenticate();
-		$this->connected = $this->connected && $this->_select();
-		$this->connected = $this->connected && $this->_setPrefix();
+		if (!$this->_connect()) {
+			throw new RedisSourceException(__d('redis', 'Could not connect.'));
+		}
+
+		if (!$this->_authenticate()) {
+			throw new RedisSourceException(__d('redis', 'Could not authenticate.'));
+		}
+
+		if (!$this->_select()) {
+			throw new RedisSourceException(__d('redis', 'Could not select.'));
+		}
+
+		if (!$this->_setPrefix()) {
+			throw new RedisSourceException(__d('redis', 'Could not set prefix.'));
+		}
+
+		$this->connected = true;
 
 		return $this->connected;
 	}

Test/Case/Model/Datasource/RedisSourceTest.php

@@ -92,6 +92,7 @@ public function tearDown() {
  *  Tests that `connect` will never be called when redis extension is not loaded.
  *
  * @expectedException RedisSourceException
+ * @expectedExceptionMessage Extension is not loaded.
  * @return void
  */
 	public function testConstructExtensionNotLoaded() {
@@ -134,6 +135,100 @@ public function testConstructExtensionLoaded() {
 		$this->assertInstanceOf($expected, $result);
 	}
 
+/**
+ * testConnectFailedConnect method
+ *
+ *  Tests that an exception in thrown when `_connect` fails.
+ *
+ * @expectedException RedisSourceException
+ * @expectedExceptionMessage Could not connect.
+ * @return void
+ */
+	public function testConnectFailedConnect() {
+		// Get mock, without the constructor being called
+		$Source = $this->getMockBuilder('TestRedisSource')->disableOriginalConstructor()->getMock();
+
+		// Set expectations for connect calls
+		$Source->expects($this->once())->method('_connect')->will($this->returnValue(false));
+
+		// Now call connect
+		$reflectedClass = new ReflectionClass('TestRedisSource');
+		$connect = $reflectedClass->getMethod('connect');
+		$connect->invoke($Source);
+	}
+
+/**
+ * testConnectFailedAuthenticate method
+ *
+ *  Tests that an exception in thrown when `_authenticate` fails.
+ *
+ * @expectedException RedisSourceException
+ * @expectedExceptionMessage Could not authenticate.
+ * @return void
+ */
+	public function testConnectFailedAuthenticate() {
+		// Get mock, without the constructor being called
+		$Source = $this->getMockBuilder('TestRedisSource')->disableOriginalConstructor()->getMock();
+
+		// Set expectations for connect calls
+		$Source->expects($this->once())->method('_connect')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_authenticate')->will($this->returnValue(false));
+
+		// Now call connect
+		$reflectedClass = new ReflectionClass('TestRedisSource');
+		$connect = $reflectedClass->getMethod('connect');
+		$connect->invoke($Source);
+	}
+
+/**
+ * testConnectFailedSelect method
+ *
+ *  Tests that an exception in thrown when `_select` fails.
+ *
+ * @expectedException RedisSourceException
+ * @expectedExceptionMessage Could not select.
+ * @return void
+ */
+	public function testConnectFailedSelect() {
+		// Get mock, without the constructor being called
+		$Source = $this->getMockBuilder('TestRedisSource')->disableOriginalConstructor()->getMock();
+
+		// Set expectations for connect calls
+		$Source->expects($this->once())->method('_connect')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_authenticate')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_select')->will($this->returnValue(false));
+
+		// Now call connect
+		$reflectedClass = new ReflectionClass('TestRedisSource');
+		$connect = $reflectedClass->getMethod('connect');
+		$connect->invoke($Source);
+	}
+
+/**
+ * testConnectFailedSetPrefix method
+ *
+ *  Tests that an exception in thrown when `_setPrefix` fails.
+ *
+ * @expectedException RedisSourceException
+ * @expectedExceptionMessage Could not set prefix.
+ * @return void
+ */
+	public function testConnectFailedSetPrefix() {
+		// Get mock, without the constructor being called
+		$Source = $this->getMockBuilder('TestRedisSource')->disableOriginalConstructor()->getMock();
+
+		// Set expectations for connect calls
+		$Source->expects($this->once())->method('_connect')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_authenticate')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_select')->will($this->returnValue(true));
+		$Source->expects($this->once())->method('_setPrefix')->will($this->returnValue(false));
+
+		// Now call connect
+		$reflectedClass = new ReflectionClass('TestRedisSource');
+		$connect = $reflectedClass->getMethod('connect');
+		$connect->invoke($Source);
+	}
+
 /**
  * testConnected method
  *
@@ -276,40 +371,14 @@ public function testCallExisting() {
  *
  * @return void
  * @expectedException RedisSourceException
+ * @expectedExceptionMessage Method (pang) does not exist.
  */
 	public function testCallNonExisting() {
 		$Source = new TestRedisSource();
 
 		$Source->pang();
 	}
 
-/**
- * testCallExistingFailure method
- *
- *  Tests calling of an existing (Redis) method on a disconnected / misconfigured instance.
- *
- * @return void
- * @expectedException RedisSourceException
- */
-	public function testCallExistingFailure() {
-		$unixSocket = '';
-		$persistent = false;
-		$host = '127.0.0.1';
-		$port = 63790;
-		$timeout = 0;
-
-		$config = array(
-			'unix_socket' => $unixSocket,
-			'persistent' => $persistent,
-			'host' => $host,
-			'port' => $port,
-			'timeout' => $timeout,
-		);
-
-		$Source = new TestRedisSource($config);
-		$Source->ping();
-	}
-
 /**
  * testNoAuthenticate method
  *