Merge pull request #183 from jpwsutton/automatic-reconnect

Automatic reconnect & Offline Buffering functionality

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/automaticReconnect/AutomaticReconnectTest.java

@@ -0,0 +1,183 @@
+package org.eclipse.paho.client.mqttv3.test.automaticReconnect;
+
+import java.net.URI;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import org.eclipse.paho.client.mqttv3.MqttClient;
+import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
+import org.eclipse.paho.client.mqttv3.MqttException;
+import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
+import org.eclipse.paho.client.mqttv3.test.logging.LoggingUtilities;
+import org.eclipse.paho.client.mqttv3.test.properties.TestProperties;
+import org.eclipse.paho.client.mqttv3.test.utilities.ConnectionManipulationProxyServer;
+import org.eclipse.paho.client.mqttv3.test.utilities.Utility;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.AfterClass;
+import org.junit.Assert;
+
+public class AutomaticReconnectTest{
+
+	static final Class<?> cclass = AutomaticReconnectTest.class;
+	private static final String className = cclass.getName();
+	private static final Logger log = Logger.getLogger(className);
+
+	private static final MemoryPersistence DATA_STORE = new MemoryPersistence();
+
+
+	private static URI serverURI;
+	private String  clientId = "device-client-id";
+	static ConnectionManipulationProxyServer proxy;
+
+
+	@BeforeClass
+	public static void setUpBeforeClass() throws Exception{
+		try {
+			String methodName = Utility.getMethodName();
+			LoggingUtilities.banner(log, cclass, methodName);
+			serverURI = TestProperties.getServerURI();
+			proxy = new ConnectionManipulationProxyServer(serverURI.getHost(), serverURI.getPort(), 4242);
+			proxy.startProxy();
+		} catch (Exception exception) {
+		      log.log(Level.SEVERE, "caught exception:", exception);
+		      throw exception;
+		    }
+
+	}
+
+	@AfterClass
+	public static void tearDownAfterClass() throws Exception {
+		log.info("Tests finished, stopping proxy");
+		proxy.stopProxy();
+
+	}
+
+
+	/**
+	 * Tests that if a connection is opened and then is lost that the client automatically reconnects
+	 * @throws Exception
+	 */
+	@Test
+	public void testAutomaticReconnectAfterDisconnect() throws Exception{
+	    String methodName = Utility.getMethodName();
+	    LoggingUtilities.banner(log, cclass, methodName);
+    	MqttConnectOptions options = new MqttConnectOptions();
+    	options.setCleanSession(true);
+    	options.setAutomaticReconnect(true);
+    	final MqttClient client = new MqttClient("tcp://localhost:4242", clientId, DATA_STORE);
+
+    	proxy.enableProxy();
+    	client.connect(options);
+
+    	boolean isConnected = client.isConnected();
+    	log.info("First Connection isConnected: " + isConnected);
+    	Assert.assertTrue(isConnected);
+
+    	proxy.disableProxy();
+    	isConnected = client.isConnected();
+    	log.info("Proxy Disconnect isConnected: " + isConnected);
+    	Assert.assertFalse(isConnected);
+
+    	proxy.enableProxy();
+    	// give it some time to reconnect
+    	long currentTime = System.currentTimeMillis();
+    	int timeout = 4000;
+    	while(client.isConnected() ==  false){
+    		long now = System.currentTimeMillis();
+    		if((currentTime + timeout) < now){
+    			log.warning("Timeout Exceeded");
+    			break;
+    		}
+    		Thread.sleep(500);
+    	}
+    	isConnected = client.isConnected();
+    	log.info("Proxy Re-Enabled isConnected: " + isConnected);
+    	Assert.assertTrue(isConnected);
+    	client.disconnect();
+    	Assert.assertFalse(client.isConnected());
+	}
+
+	/**
+	 * Tests that if a connection is opened and lost, that when the user calls reconnect() that the
+	 * client will attempt to reconnect straight away
+	 */
+	@Test
+	public void testManualReconnectAfterDisconnect() throws Exception {
+	    String methodName = Utility.getMethodName();
+	    LoggingUtilities.banner(log, cclass, methodName);
+		MqttConnectOptions options = new MqttConnectOptions();
+    	options.setCleanSession(true);
+    	options.setAutomaticReconnect(true);
+
+    	final MqttClient client = new MqttClient("tcp://localhost:4242", clientId, DATA_STORE);
+
+    	proxy.enableProxy();
+    	client.connect(options);
+
+    	boolean isConnected = client.isConnected();
+    	log.info("First Connection isConnected: " + isConnected);
+    	Assert.assertTrue(isConnected);
+
+    	proxy.disableProxy();
+    	isConnected = client.isConnected();
+    	log.info("Proxy Disconnect isConnected: " + isConnected);
+    	Assert.assertFalse(isConnected);
+
+    	proxy.enableProxy();
+    	client.reconnect();
+    	// give it some time to reconnect
+    	Thread.sleep(4000);
+    	isConnected = client.isConnected();
+    	log.info("Proxy Re-Enabled isConnected: " + isConnected);
+    	Assert.assertTrue(isConnected);
+    	client.disconnect();
+    	Assert.assertFalse(client.isConnected());  
+	}
+
+
+	/**
+	 * Tests that if the initial connection attempt fails, that the automatic reconnect code does NOT
+	 * engage.
+	 */
+	@Test
+	public void testNoAutomaticReconnectWithNoInitialConnect() throws Exception {
+		 String methodName = Utility.getMethodName();
+		    LoggingUtilities.banner(log, cclass, methodName);
+	    	MqttConnectOptions options = new MqttConnectOptions();
+	    	options.setCleanSession(true);
+	    	options.setAutomaticReconnect(true);
+	    	options.setConnectionTimeout(15);
+	    	final MqttClient client = new MqttClient("tcp://localhost:4242", clientId, DATA_STORE);
+
+	    	// Make sure the proxy is disabled and give it a second to close everything down
+	    	proxy.disableProxy();
+	    	try {
+	    	client.connect(options);
+	    	} catch (MqttException ex) {
+	    		// Exceptions are good in this case!
+	    	}
+	    	boolean isConnected = client.isConnected();
+	    	log.info("First Connection isConnected: " + isConnected);
+	    	Assert.assertFalse(isConnected);
+
+	    	// Enable The Proxy
+	    	proxy.enableProxy();
+
+	    	// Give it some time to make sure we are still not connected
+	    	long currentTime = System.currentTimeMillis();
+	    	int timeout = 4000;
+	    	while(client.isConnected() ==  false){
+	    		long now = System.currentTimeMillis();
+	    		if((currentTime + timeout) < now){
+	    			Assert.assertFalse(isConnected);
+	    			break;
+	    		}
+	    		Thread.sleep(500);
+	    	}
+	    	isConnected = client.isConnected();
+	    	log.info("Proxy Re-Enabled isConnected: " + isConnected);
+	    	Assert.assertFalse(isConnected);
+
+	}
+}