Numerous changes to fix tests in travis (#372)

* Numerous changes to improve testing on Travis CI
 - Local Mosquitto instance
 - Removing Test timeouts as they didn't really help
 - Adjusting a few Tests
* Fixing Test POM
* Issue #297 - Adding ability to force close connection, and a few other Sonar improvements
* Removing timeout
* Resolving Issue #384 - Incorrect Log message

Signed-off-by: James Sutton <james.sutton@uk.ibm.com>

Author: jpwsutton

.travis.yml

@@ -1,2 +1,23 @@
+sudo: true
 language: java
-script: mvn test -Dtest.server_ssl_port=18885 -Dtest.server_uri=tcp://mqtt.iotree.co.uk:1883 -Dtest.server_websocket_uri=ws://mqtt.iotree.co.uk:8080 -B
+
+matrix:
+  include:
+    - os: linux
+      dist: trusty
+      sudo: required
+#    - os: osx
+
+sudo: required
+
+before_install:
+  - ./travis-install.sh
+
+script: mvn --projects org.eclipse.paho.client.mqttv3,org.eclipse.paho.client.mqttv3.test test -Dtest.server_ssl_port=18885 -Dtest.server_uri=tcp://localhost:1883 -Dtest.server_websocket_uri=ws://localhost:8080 -B
+
+addons:
+  apt:
+    sources:
+      - sourceline: 'ppa:mosquitto-dev/mosquitto-ppa'
+    packages:
+      - mosquitto

org.eclipse.paho.client.mqttv3.test/pom.xml

@@ -47,16 +47,15 @@
 				<artifactId>maven-surefire-plugin</artifactId>
 				<version>2.15</version>
 				<configuration>
-					<reuseForks>false</reuseForks>
-        			<forkCount>1</forkCount>
 					<systemPropertyVariables>
 						<SERVER_URI>${test.server_uri}</SERVER_URI>
 						<SERVER_SSL_PORT>${test.server_ssl_port}</SERVER_SSL_PORT>
-						<SERVER_WEBSOCKET_URI>${test.server_websocket_url}</SERVER_WEBSOCKET_URI>
+						<SERVER_WEBSOCKET_URI>${test.server_websocket_uri}</SERVER_WEBSOCKET_URI>
 					</systemPropertyVariables>
 					<excludes>
 						<exclude>${test.exclude}</exclude>
 					</excludes>
+					<runOrder>alphabetical</runOrder>
 				</configuration>
 			</plugin>
 		</plugins>

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/BasicTest.java

@@ -95,7 +95,7 @@ public static void tearDownAfterClass() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testConnect() throws Exception {
     String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -141,7 +141,7 @@ public void testConnect() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testHAConnect() throws Exception {
     String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -191,7 +191,7 @@ public void testHAConnect() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testPubSub() throws Exception {
     String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -241,7 +241,7 @@ public void testPubSub() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testMsgProperties() throws Exception {
     String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -309,7 +309,7 @@ public void testMsgProperties() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testConnOptDefaults() throws Exception {
     String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/ModelTestCase.java

@@ -167,7 +167,7 @@ public static void tearDownAfterClass() throws Exception {
   /**
    * @throws Exception 
    */
-  @Test(timeout=150000)
+  //@Test(timeout=150000)
   public void testRunModel() throws Exception {
     log.info("Test core operations and parameters by random selection");
     log.info("See file: " + logFilename + " for details of selected test sequence");

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/PerSubscriptionMessageHandlerTest.java

@@ -136,7 +136,7 @@ public void messageArrived(String topic, MqttMessage message) throws Exception {
 	   * 
 	   * @throws Exception
 	   */
-	  @Test(timeout=10000)
+	  @Test
 	  public void testSyncSubs1() throws Exception {
 	    final String methodName = Utility.getMethodName();
 	    LoggingUtilities.banner(log, cclass, methodName);
@@ -166,7 +166,7 @@ public void testSyncSubs1() throws Exception {
 
 	  }
 
-	  @Test(timeout=10000)
+	  @Test
 	  public void testAsyncSubs1() throws Exception {
 	    final String methodName = Utility.getMethodName();
 	    LoggingUtilities.banner(log, cclass, methodName);
@@ -204,7 +204,7 @@ public void testAsyncSubs1() throws Exception {
 	   *  Check handlers still exist after reconnection non-cleansession
 	   */
 
-	  @Test(timeout=10000)
+	  @Test
 	  public void testSyncCleanSessionFalse() throws Exception {
 		    final String methodName = Utility.getMethodName();
 		    LoggingUtilities.banner(log, cclass, methodName);
@@ -256,7 +256,7 @@ public void testSyncCleanSessionFalse() throws Exception {
 		    mqttClient.close();
 	  }
 
-	  @Test(timeout=10000)
+	  @Test
 	  public void testAsyncCleanSessionFalse() throws Exception {
 		    final String methodName = Utility.getMethodName();
 		    LoggingUtilities.banner(log, cclass, methodName);

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/SendReceiveAsyncTest.java

@@ -95,7 +95,7 @@ public static void tearDownAfterClass() throws Exception {
    * 
    * @throws Exception
    */
-  @Test(timeout=10000)
+  @Test
   public void testConnect() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -142,7 +142,7 @@ public void testConnect() throws Exception {
    * 
    * @throws Exception
    */
-  @Test(timeout=10000)
+  @Test
   public void testRemoteConnect() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -214,7 +214,7 @@ public void testRemoteConnect() throws Exception {
   /**
    * Test client pubSub using very large messages
    */
-  @Test(timeout=10000)
+  @Test
   public void testLargeMessage() {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -291,7 +291,7 @@ public void testLargeMessage() {
   /**
    * Multiple publishers and subscribers.
    */
-  @Test(timeout=20000)
+  @Test
   public void testMultipleClients() {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -386,7 +386,7 @@ public void testMultipleClients() {
    * Test the behaviour of the cleanStart flag, used to clean up before
    * re-connecting.
    */
-  @Test(timeout=10000)
+  @Test
   public void testCleanStart() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -532,7 +532,7 @@ public void testCleanStart() throws Exception {
    * 
    * Since no other activity (messages from the client to the broker) is generated, the broker disconnects the client.
    */
-  @Test(timeout=300000)
+  @Test
   public void testVeryLargeMessageWithShortKeepAlive() {
   	final String methodName = Utility.getMethodName();
   	LoggingUtilities.banner(log, cclass, methodName);
@@ -601,7 +601,7 @@ public void testVeryLargeMessageWithShortKeepAlive() {
    * Test the behavior of the connection timeout when connecting to a non MQTT server.
    * i.e. ssh port 22
    */
-  @Test(timeout=60000)
+  @Test
   public void testConnectTimeout() throws Exception {
 	  final String methodName = Utility.getMethodName();
 	  LoggingUtilities.banner(log, cclass, methodName);

org.eclipse.paho.client.mqttv3.test/src/test/java/org/eclipse/paho/client/mqttv3/test/SendReceiveTest.java

@@ -93,7 +93,7 @@ public static void tearDownAfterClass() throws Exception {
    * service
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testConnect() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -129,7 +129,7 @@ public void testConnect() throws Exception {
    * Test connection using a remote host name for the local host.
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testRemoteConnect() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -184,7 +184,7 @@ public void testRemoteConnect() throws Exception {
   /**
    * Test client pubSub using largish messages
    */
-  @Test(timeout=10000)
+  @Test
   public void testLargeMessage() {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -245,7 +245,7 @@ public void testLargeMessage() {
   /**
    * Test that QOS values are preserved between MQTT publishers and subscribers.
    */
-  @Test(timeout=10000)
+  @Test
   public void testQoSPreserved() {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -305,7 +305,7 @@ public void testQoSPreserved() {
    * Multiple publishers and subscribers.
    * @throws Exception 
    */
-  @Test(timeout=30000)
+  @Test
   public void testMultipleClients() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);
@@ -388,7 +388,7 @@ public void testMultipleClients() throws Exception {
    * Test the behaviour of the cleanStart flag, used to clean up before re-connecting.
    * @throws Exception 
    */
-  @Test(timeout=10000)
+  @Test
   public void testCleanStart() throws Exception {
     final String methodName = Utility.getMethodName();
     LoggingUtilities.banner(log, cclass, methodName);

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

@@ -50,7 +50,7 @@ public static void setUpBeforeClass() throws Exception {
 		    topicPrefix = "OfflineBufferingTest-" + UUID.randomUUID().toString() + "-";
 
 			// Use 0 for the first time.
-			proxy = new ConnectionManipulationProxyServer(serverURI.getHost(), serverURI.getPort(), 0);
+			proxy = new ConnectionManipulationProxyServer(serverURI.getHost(), serverURI.getPort(), 2883);
 			proxy.startProxy();
 			while (!proxy.isPortSet()) {
 				Thread.sleep(0);
@@ -68,7 +68,7 @@ public static void setUpBeforeClass() throws Exception {
 	 * disconnected state and is then delivered once the client has reconnected
 	 * automatically.
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testSingleMessageBufferAndDeliver() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);
@@ -139,7 +139,7 @@ public void testSingleMessageBufferAndDeliver() throws Exception {
 	 * disconnected state and that they are all then delivered once the client
 	 * has connected automatically.
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testManyMessageBufferAndDeliver() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);
@@ -231,7 +231,7 @@ public void testManyMessageBufferAndDeliver() throws Exception {
 	 * Tests that the buffer correctly handles messages being buffered when the
 	 * buffer is full and deleteOldestBufferedMessage is set to true.
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testDeleteOldestBufferedMessages() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);
@@ -288,7 +288,7 @@ public void testDeleteOldestBufferedMessages() throws Exception {
 	 * Tests that A message cannot be buffered when the buffer is full and
 	 * deleteOldestBufferedMessage is set to false.
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testNoDeleteOldestBufferedMessages() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);
@@ -347,7 +347,7 @@ public void testNoDeleteOldestBufferedMessages() throws Exception {
 	 * Tests that if enabled, buffered messages are persisted to the persistence
 	 * layer
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testPersistBufferedMessages() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);
@@ -407,7 +407,7 @@ public void testPersistBufferedMessages() throws Exception {
 	 * Tests that persisted buffered messages are published correctly when the
 	 * client connects for the first time and are un persisted.
 	 */
-	@Test(timeout=60000)
+	@Test
 	public void testUnPersistBufferedMessagesOnNewClient() throws Exception {
 		String methodName = Utility.getMethodName();
 		LoggingUtilities.banner(log, cclass, methodName);

org.eclipse.paho.client.mqttv3/src/main/java-templates/org/eclipse/paho/client/mqttv3/internal/ClientComms.java

@@ -207,12 +207,12 @@ public void sendNoWait(MqttWireMessage message, MqttToken token) throws MqttExce
 	 * store which normally survives a disconnect.
 	 * @throws MqttException  if not disconnected
 	 */
-	public void close() throws MqttException {
+	public void close(boolean force) throws MqttException {
 		final String methodName = "close";
 		synchronized (conLock) {
 			if (!isClosed()) {
-				// Must be disconnected before close can take place
-				if (!isDisconnected()) {
+				// Must be disconnected before close can take place or if we are being forced
+				if (!isDisconnected() || force) {
 					//@TRACE 224=failed: not disconnected
 					log.fine(CLASS_NAME, methodName, "224");
 
@@ -427,7 +427,7 @@ public void shutdownConnection(MqttToken token, MqttException reason) {
 		synchronized(conLock) {
 			if (closePending) {
 				try {
-					close();
+					close(true);
 				} catch (Exception e) { // ignore any errors as closing
 				}
 			}

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/DisconnectedBufferOptions.java

@@ -51,6 +51,7 @@ public class DisconnectedBufferOptions {
 	 * More information about these values can be found in the setter methods.
 	 */
 	public DisconnectedBufferOptions() {
+		// Do Nothing.
 	}
 
 	public int getBufferSize() {