Rework SOCKS5 unit tests so that they can be run in parallel

As result it is now also possible to start multiple local SOCKS5
proxies with different port, which is usually not necessary in real
life but useful for unit tests.

smack-core/src/test/java/org/jivesoftware/smack/util/NetworkUtil.java

@@ -1,6 +1,6 @@
 /**
  *
- * Copyright 2016 Florian Schmaus
+ * Copyright 2016-2019 Florian Schmaus
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ public class NetworkUtil {
 
     private static final Logger LOGGER = Logger.getLogger(NetworkUtil.class.getName());
 
-    public static ServerSocket getSocketOnLoopback() {
+    public static ServerSocket getSocketOnLoopback() throws IOException {
         final InetAddress loopbackAddress = InetAddress.getLoopbackAddress();
         final int portMin = 1024;
         final int portMax = (1 << 16) - 1;
@@ -40,13 +40,12 @@ public class NetworkUtil {
                 break;
             } catch (BindException e) {
                 LOGGER.log(Level.FINEST, "Could not bind port " + port + ", trying next", e);
-            } catch (IOException e) {
-                throw new IllegalStateException(e);
             }
         }
 
         if (serverSocket == null) {
-            throw new IllegalStateException();
+            throw new IOException("Could not bind any port between " + portMin + " and " + portMax
+                            + " on loopback address" + loopbackAddress);
         }
 
         return serverSocket;

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java

@@ -56,6 +56,7 @@ import org.jivesoftware.smackx.disco.packet.DiscoverItems;
 import org.jivesoftware.smackx.disco.packet.DiscoverItems.Item;
 import org.jivesoftware.smackx.filetransfer.FileTransferManager;
 
+import org.jxmpp.jid.EntityFullJid;
 import org.jxmpp.jid.Jid;
 
 /**
@@ -149,6 +150,8 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
     /* flag to enable/disable prioritization of last working proxy */
     private boolean proxyPrioritizationEnabled = true;
 
+    private boolean annouceLocalStreamHost = true;
+
     /*
      * list containing session IDs of SOCKS5 Bytestream initialization packets that should be
      * ignored by the InitiationListener
@@ -375,6 +378,30 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
         this.proxyPrioritizationEnabled = proxyPrioritizationEnabled;
     }
 
+    /**
+     * Returns if the bytestream manager will announce the local stream host(s), i.e. the local SOCKS5 proxy.
+     * <p>
+     * Local stream hosts will be announced if this option is enabled and at least one is running.
+     * </p>
+     *
+     * @return <code>true</code> if
+     * @since 4.4.0
+     */
+    public boolean isAnnouncingLocalStreamHostEnabled() {
+        return annouceLocalStreamHost;
+    }
+
+    /**
+     * Set whether or not the bytestream manager will annouce the local stream host(s), i.e. the local SOCKS5 proxy.
+     *
+     * @param announceLocalStreamHost
+     * @see #isAnnouncingLocalStreamHostEnabled()
+     * @since 4.4.0
+     */
+    public void setAnnounceLocalStreamHost(boolean announceLocalStreamHost) {
+        this.annouceLocalStreamHost = announceLocalStreamHost;
+    }
+
     /**
      * Establishes a SOCKS5 Bytestream with the given user and returns the Socket to send/receive
      * data to/from the user.
@@ -592,11 +619,13 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
         XMPPConnection connection = connection();
         List<StreamHost> streamHosts = new ArrayList<>();
 
+        if (annouceLocalStreamHost) {
             // add local proxy on first position if exists
             List<StreamHost> localProxies = getLocalStreamHost();
             if (localProxies != null) {
                 streamHosts.addAll(localProxies);
             }
+        }
 
         // query SOCKS5 proxies for network settings
         for (Jid proxy : proxies) {
@@ -636,14 +665,12 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
      *         is not running
      */
     public List<StreamHost> getLocalStreamHost() {
-        XMPPConnection connection = connection();
+        List<StreamHost> streamHosts = new ArrayList<>();
-        // get local proxy singleton
-        Socks5Proxy socks5Server = Socks5Proxy.getSocks5Proxy();
 
-        if (!socks5Server.isRunning()) {
+        XMPPConnection connection = connection();
-            // server is not running
+        EntityFullJid myJid = connection.getUser();
-            return null;
+
-        }
+        for (Socks5Proxy socks5Server : Socks5Proxy.getRunningProxies()) {
             List<String> addresses = socks5Server.getLocalAddresses();
             if (addresses.isEmpty()) {
                 // local address could not be determined
@@ -651,7 +678,6 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
             }
             final int port = socks5Server.getPort();
 
-        List<StreamHost> streamHosts = new ArrayList<>();
             outerloop: for (String address : addresses) {
                 // Prevent loopback addresses from appearing as streamhost
                 final String[] loopbackAddresses = { "127.0.0.1", "0:0:0:0:0:0:0:1", "::1" };
@@ -662,8 +688,10 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
                         continue outerloop;
                     }
                 }
-            streamHosts.add(new StreamHost(connection.getUser(), address, port));
+                streamHosts.add(new StreamHost(myJid, address, port));
             }
+        }
+
         return streamHosts;
     }
 

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java

@@ -57,12 +57,14 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
     private static final Cache<String, Integer> ADDRESS_BLACKLIST = new ExpirationCache<String, Integer>(
                     BLACKLIST_MAX_SIZE, BLACKLIST_LIFETIME);
 
+    private static int DEFAULT_CONNECTION_FAILURE_THRESHOLD = 2;
+
     /*
      * The number of connection failures it takes for a particular SOCKS5 proxy to be blacklisted.
      * When a proxy is blacklisted no more connection attempts will be made to it for a period of 2
      * hours.
      */
-    private static int CONNECTION_FAILURE_THRESHOLD = 2;
+    private int connectionFailureThreshold = DEFAULT_CONNECTION_FAILURE_THRESHOLD;
 
     /* the bytestream initialization request */
     private Bytestream bytestreamRequest;
@@ -76,6 +78,28 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
     /* minimum timeout to connect to one SOCKS5 proxy */
     private int minimumConnectTimeout = 2000;
 
+    /**
+     * Returns the default connection failure threshold.
+     *
+     * @return the default connection failure threshold.
+     * @see #setConnectFailureThreshold(int)
+     * @since 4.4.0
+     */
+    public static int getDefaultConnectFailureThreshold() {
+        return DEFAULT_CONNECTION_FAILURE_THRESHOLD;
+    }
+
+    /**
+     * Sets the default connection failure threshold.
+     *
+     * @param defaultConnectFailureThreshold the default connection failure threshold.
+     * @see #setConnectFailureThreshold(int)
+     * @since 4.4.0
+     */
+    public static void setDefaultConnectFailureThreshold(int defaultConnectFailureThreshold) {
+        DEFAULT_CONNECTION_FAILURE_THRESHOLD = defaultConnectFailureThreshold;
+    }
+
     /**
      * Returns the number of connection failures it takes for a particular SOCKS5 proxy to be
      * blacklisted. When a proxy is blacklisted no more connection attempts will be made to it for a
@@ -84,8 +108,8 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
      * @return the number of connection failures it takes for a particular SOCKS5 proxy to be
      *         blacklisted
      */
-    public static int getConnectFailureThreshold() {
+    public int getConnectFailureThreshold() {
-        return CONNECTION_FAILURE_THRESHOLD;
+        return connectionFailureThreshold;
     }
 
     /**
@@ -98,8 +122,8 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
      * @param connectFailureThreshold the number of connection failures it takes for a particular
      *        SOCKS5 proxy to be blacklisted
      */
-    public static void setConnectFailureThreshold(int connectFailureThreshold) {
+    public void setConnectFailureThreshold(int connectFailureThreshold) {
-        CONNECTION_FAILURE_THRESHOLD = connectFailureThreshold;
+        connectionFailureThreshold = connectFailureThreshold;
     }
 
     /**
@@ -234,7 +258,7 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
 
             // check to see if this address has been blacklisted
             int failures = getConnectionFailures(address);
-            if (CONNECTION_FAILURE_THRESHOLD > 0 && failures >= CONNECTION_FAILURE_THRESHOLD) {
+            if (connectionFailureThreshold > 0 && failures >= connectionFailureThreshold) {
                 continue;
             }
 

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java

@@ -36,6 +36,7 @@ import org.jivesoftware.smack.SmackException.NoResponseException;
 import org.jivesoftware.smack.SmackException.NotConnectedException;
 import org.jivesoftware.smack.SmackException.SmackMessageException;
 import org.jivesoftware.smack.XMPPException;
+import org.jivesoftware.smack.util.Async;
 import org.jivesoftware.smack.util.CloseableUtil;
 
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream.StreamHost;
@@ -111,27 +112,14 @@ public class Socks5Client {
             }
 
         });
-        Thread executor = new Thread(futureTask);
+        Async.go(futureTask, "SOCKS5 client connecting to " + streamHost);
-        executor.start();
 
         // get connection to initiator with timeout
         try {
             return futureTask.get(timeout, TimeUnit.MILLISECONDS);
         }
         catch (ExecutionException e) {
-            Throwable cause = e.getCause();
+            throw new IOException("ExecutionException while SOCKS5 client attempting to connect to " + streamHost, e);
-            if (cause != null) {
-                // case exceptions to comply with method signature
-                if (cause instanceof IOException) {
-                    throw (IOException) cause;
-                }
-                if (cause instanceof SmackMessageException) {
-                    throw (SmackMessageException) cause;
-                }
-            }
-
-            // throw generic Smack exception if unexpected exception was thrown
-            throw new IllegalStateException("Error while connecting to SOCKS5 proxy", e);
         }
 
     }

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java

@@ -79,8 +79,7 @@ public class Socks5ClientForInitiator extends Socks5Client {
 
         // check if stream host is the local SOCKS5 proxy
         if (this.streamHost.getJID().equals(this.connection.get().getUser())) {
-            Socks5Proxy socks5Server = Socks5Proxy.getSocks5Proxy();
+            socket = Socks5Proxy.getSocketForDigest(this.digest);
-            socket = socks5Server.getSocket(this.digest);
             if (socket == null) {
                 throw new SmackException.SmackMessageException("target is not connected to SOCKS5 proxy");
             }

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java

@@ -35,6 +35,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -73,6 +74,8 @@ import org.jivesoftware.smack.util.CloseableUtil;
 public final class Socks5Proxy {
     private static final Logger LOGGER = Logger.getLogger(Socks5Proxy.class.getName());
 
+    private static final List<Socks5Proxy> RUNNING_PROXIES = new CopyOnWriteArrayList<>();
+
     /* SOCKS5 proxy singleton */
     private static Socks5Proxy socks5Server;
 
@@ -104,7 +107,7 @@ public final class Socks5Proxy {
     /**
      * Private constructor.
      */
-    private Socks5Proxy() {
+    Socks5Proxy() {
         this.serverProcess = new Socks5ServerProcess();
 
         Enumeration<NetworkInterface> networkInterfaces;
@@ -188,9 +191,9 @@ public final class Socks5Proxy {
     /**
      * Starts the local SOCKS5 proxy server. If it is already running, this method does nothing.
      */
-    public synchronized void start() {
+    public synchronized ServerSocket start() {
         if (isRunning()) {
-            return;
+            return this.serverSocket;
         }
         try {
             if (getLocalSocks5ProxyPort() < 0) {
@@ -213,6 +216,8 @@ public final class Socks5Proxy {
                 this.serverThread = new Thread(this.serverProcess);
                 this.serverThread.setName("Smack Local SOCKS5 Proxy [" + this.serverSocket + ']');
                 this.serverThread.setDaemon(true);
+
+                RUNNING_PROXIES.add(this);
                 this.serverThread.start();
             }
         }
@@ -220,6 +225,8 @@ public final class Socks5Proxy {
             // couldn't setup server
             LOGGER.log(Level.SEVERE, "couldn't setup local SOCKS5 proxy on port " + getLocalSocks5ProxyPort(), e);
         }
+
+        return this.serverSocket;
     }
 
     /**
@@ -230,6 +237,8 @@ public final class Socks5Proxy {
             return;
         }
 
+        RUNNING_PROXIES.remove(this);
+
         CloseableUtil.maybeClose(this.serverSocket, LOGGER);
 
         if (this.serverThread != null && this.serverThread.isAlive()) {
@@ -483,4 +492,17 @@ public final class Socks5Proxy {
 
     }
 
+    public static Socket getSocketForDigest(String digest) {
+        for (Socks5Proxy socks5Proxy : RUNNING_PROXIES) {
+            Socket socket = socks5Proxy.getSocket(digest);
+            if (socket != null) {
+                return socket;
+            }
+        }
+        return null;
+    }
+
+    static List<Socks5Proxy> getRunningProxies() {
+        return RUNNING_PROXIES;
+    }
 }

smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java

@@ -28,6 +28,8 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.ConnectException;
+import java.net.ServerSocket;
+import java.util.concurrent.TimeoutException;
 
 import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.SmackException.FeatureNotSupportedException;
@@ -37,6 +39,7 @@ import org.jivesoftware.smack.XMPPException.XMPPErrorException;
 import org.jivesoftware.smack.packet.ErrorIQ;
 import org.jivesoftware.smack.packet.IQ;
 import org.jivesoftware.smack.packet.StanzaError;
+import org.jivesoftware.smack.util.NetworkUtil;
 
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream;
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream.StreamHost;
@@ -49,8 +52,6 @@ import org.jivesoftware.smackx.disco.packet.DiscoverItems.Item;
 import org.jivesoftware.util.ConnectionUtils;
 import org.jivesoftware.util.Protocol;
 import org.jivesoftware.util.Verification;
-import org.junit.After;
-import org.junit.Before;
 import org.junit.Test;
 import org.jxmpp.jid.DomainBareJid;
 import org.jxmpp.jid.EntityFullJid;
@@ -71,30 +72,6 @@ public class Socks5ByteStreamManagerTest {
     private static final DomainBareJid xmppServer = initiatorJID.asDomainBareJid();
     private static final DomainBareJid proxyJID = JidTestUtil.MUC_EXAMPLE_ORG;
     private static final String proxyAddress = "127.0.0.1";
-    private static final String sessionID = "session_id";
-
-    // protocol verifier
-    private Protocol protocol;
-
-    // mocked XMPP connection
-    private XMPPConnection connection;
-
-    /**
-     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
-     */
-    @Before
-    public void setup() throws XMPPException, SmackException, InterruptedException {
-
-        // build protocol verifier
-        protocol = new Protocol();
-
-        // create mocked XMPP connection
-        connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-
-    }
 
     /**
      * Test that {@link Socks5BytestreamManager#getBytestreamManager(XMPPConnection)} returns one
@@ -102,7 +79,6 @@ public class Socks5ByteStreamManagerTest {
      */
     @Test
     public void shouldHaveOneManagerForEveryConnection() {
-
         // mock two connections
         XMPPConnection connection1 = mock(XMPPConnection.class);
         XMPPConnection connection2 = mock(XMPPConnection.class);
@@ -124,15 +100,21 @@ public class Socks5ByteStreamManagerTest {
         // assertions
         assertEquals(conn1ByteStreamManager1, conn1ByteStreamManager2);
         assertNotSame(conn1ByteStreamManager1, conn2ByteStreamManager1);
-
     }
 
     /**
      * The SOCKS5 Bytestream feature should be removed form the service discovery manager if Socks5
      * bytestream feature is disabled.
+     *
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPErrorException
      */
     @Test
-    public void shouldDisableService() {
+    public void shouldDisableService() throws XMPPErrorException, SmackException, InterruptedException {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
         ServiceDiscoveryManager discoveryManager = ServiceDiscoveryManager.getInstanceFor(connection);
 
@@ -147,9 +129,15 @@ public class Socks5ByteStreamManagerTest {
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid)} should throw an exception
      * if the given target does not support SOCKS5 Bytestream.
      * @throws XMPPException
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws IOException
      */
     @Test
-    public void shouldFailIfTargetDoesNotSupportSocks5() throws XMPPException {
+    public void shouldFailIfTargetDoesNotSupportSocks5()
+                    throws XMPPException, SmackException, InterruptedException, IOException {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
 
         try {
@@ -165,24 +153,27 @@ public class Socks5ByteStreamManagerTest {
         catch (FeatureNotSupportedException e) {
             assertTrue(e.getFeature().equals("SOCKS5 Bytestream"));
             assertTrue(e.getJid().equals(targetJID));
-        } catch (Exception e) {
-            fail(e.getMessage());
         }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if XMPP
      * server doesn't return any proxies.
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldFailIfNoSocks5ProxyFound1() {
+    public void shouldFailIfNoSocks5ProxyFound1()
-
+                    throws SmackException, InterruptedException, IOException, XMPPException {
-        // disable clients local SOCKS5 proxy
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+        final String sessionID = "session_id_shouldFailIfNoSocks5ProxyFound1";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -206,7 +197,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeGET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -216,24 +206,27 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertTrue(e.getMessage().contains("no SOCKS5 proxies available"));
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if no
      * proxy is a SOCKS5 proxy.
+     *
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldFailIfNoSocks5ProxyFound2() {
+    public void shouldFailIfNoSocks5ProxyFound2()
-
+                    throws SmackException, InterruptedException, IOException, XMPPException {
-        // disable clients local SOCKS5 proxy
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+        final String sessionID = "session_id_shouldFailIfNoSocks5ProxyFound2";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -269,7 +262,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeGET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -279,25 +271,26 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertTrue(e.getMessage().contains("no SOCKS5 proxies available"));
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if no
      * SOCKS5 proxy can be found. If it turns out that a proxy is not a SOCKS5 proxy it should not
      * be queried again.
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldBlacklistNonSocks5Proxies() {
+    public void shouldBlacklistNonSocks5Proxies() throws SmackException, InterruptedException, IOException, XMPPException {
-
+        final Protocol protocol = new Protocol();
-        // disable clients local SOCKS5 proxy
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final String sessionID = "session_id_shouldBlacklistNonSocks5Proxies";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -333,7 +326,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeGET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -343,9 +335,6 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertTrue(e.getMessage().contains("no SOCKS5 proxies available"));
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
 
         /* retry to establish SOCKS5 Bytestream */
 
@@ -356,7 +345,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeGET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -370,25 +358,26 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertTrue(e.getMessage().contains("no SOCKS5 proxies available"));
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if the
      * target does not accept a SOCKS5 Bytestream. See <a
      * href="http://xmpp.org/extensions/xep-0065.html#usecase-alternate">XEP-0065 Section 5.2 A2</a>
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldFailIfTargetDoesNotAcceptSocks5Bytestream() {
+    public void shouldFailIfTargetDoesNotAcceptSocks5Bytestream() throws SmackException, InterruptedException, IOException, XMPPException {
-
+        final Protocol protocol = new Protocol();
-        // disable clients local SOCKS5 proxy
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final String sessionID = "session_id_shouldFailIfTargetDoesNotAcceptSocks5Bytestream";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -443,7 +432,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeSET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -453,25 +441,28 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertEquals(rejectPacket.getError(), e.getStanzaError());
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if the
      * proxy used by target is invalid.
-     * @throws XmppStringprepException
+     *
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldFailIfTargetUsesInvalidSocks5Proxy() throws XmppStringprepException {
+    public void shouldFailIfTargetUsesInvalidSocks5Proxy()
-
+                    throws SmackException, InterruptedException, IOException, XMPPException {
-        // disable clients local SOCKS5 proxy
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+        final String sessionID = "session_id_shouldFailIfTargetUsesInvalidSocks5Proxy";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        // TODO: It appears that it is not required to disable the local stream host for this unit test.
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -526,7 +517,6 @@ public class Socks5ByteStreamManagerTest {
                         Verification.requestTypeSET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -536,24 +526,26 @@ public class Socks5ByteStreamManagerTest {
             protocol.verifyAll();
             assertTrue(e.getMessage().contains("Remote user responded with unknown host"));
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if
      * initiator can not connect to the SOCKS5 proxy used by target.
+     *
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
      */
     @Test
-    public void shouldFailIfInitiatorCannotConnectToSocks5Proxy() {
+    public void shouldFailIfInitiatorCannotConnectToSocks5Proxy()
-
+                    throws SmackException, InterruptedException, XMPPException {
-        // disable clients local SOCKS5 proxy
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+        final String sessionID = "session_id_shouldFailIfInitiatorCannotConnectToSocks5Proxy";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -618,7 +610,6 @@ public class Socks5ByteStreamManagerTest {
         }, Verification.correspondingSenderReceiver, Verification.requestTypeSET);
 
         try {
-
             // start SOCKS5 Bytestream
             byteStreamManager.establishSession(targetJID, sessionID);
 
@@ -627,28 +618,30 @@ public class Socks5ByteStreamManagerTest {
         catch (IOException e) {
             // initiator can't connect to proxy because it is not running
             protocol.verifyAll();
-            assertEquals(ConnectException.class, e.getClass());
+            Throwable actualCause = e.getCause().getCause();
+            assertEquals(ConnectException.class, actualCause.getClass());
         }
-        catch (Exception e) {
-            fail(e.getMessage());
-        }
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should successfully
      * negotiate and return a SOCKS5 Bytestream connection.
      *
-     * @throws Exception should not happen
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      */
     @Test
-    public void shouldNegotiateSocks5BytestreamAndTransferData() throws Exception {
+    public void shouldNegotiateSocks5BytestreamAndTransferData()
-
+                    throws SmackException, InterruptedException, IOException, XMPPException {
-        // disable clients local SOCKS5 proxy
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
+        final String sessionID = "session_id_shouldNegotiateSocks5BytestreamAndTransferData";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         /**
          * create responses in the order they should be queried specified by the XEP-0065
@@ -684,9 +677,10 @@ public class Socks5ByteStreamManagerTest {
 
         // build a socks5 stream host info containing the address and the port of the
         // proxy
+        ServerSocket proxyServerSocket = NetworkUtil.getSocketOnLoopback();
         Bytestream streamHostInfo = Socks5PacketUtils.createBytestreamResponse(proxyJID,
                         initiatorJID);
-        streamHostInfo.addStreamHost(proxyJID, proxyAddress, 7778);
+        streamHostInfo.addStreamHost(proxyJID, proxyAddress, proxyServerSocket.getLocalPort());
 
         // return stream host info if it is queried
         protocol.addResponse(streamHostInfo, Verification.correspondingSenderReceiver,
@@ -726,8 +720,7 @@ public class Socks5ByteStreamManagerTest {
         }, Verification.correspondingSenderReceiver, Verification.requestTypeSET);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7778);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy(proxyServerSocket)) {
-        socks5Proxy.start();
 
             // create digest to get the socket opened by target
             String digest = Socks5Utils.createDigest(sessionID, initiatorJID, targetJID);
@@ -745,27 +738,32 @@ public class Socks5ByteStreamManagerTest {
             inputStream.read(result);
 
             assertArrayEquals(data, result);
+        }
 
         protocol.verifyAll();
-
     }
 
     /**
      * If multiple network addresses are added to the local SOCKS5 proxy, all of them should be
      * contained in the SOCKS5 Bytestream request.
      *
-     * @throws Exception should not happen
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws IOException
+     * @throws XMPPException
+     * @throws TimeoutException
      */
     @Test
-    public void shouldUseMultipleAddressesForLocalSocks5Proxy() throws Exception {
+    public void shouldUseMultipleAddressesForLocalSocks5Proxy()
-
+                    throws SmackException, InterruptedException, IOException, TimeoutException, XMPPException {
-        // enable clients local SOCKS5 proxy on port 7778
+        final Protocol protocol = new Protocol();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(true);
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-        Socks5Proxy.setLocalSocks5ProxyPort(7778);
+        final String sessionID = "session_id_shouldUseMultipleAddressesForLocalSocks5Proxy";
 
         // start a local SOCKS5 proxy
-        Socks5Proxy socks5Proxy = Socks5Proxy.getSocks5Proxy();
+        Socks5Proxy socks5Proxy = new Socks5Proxy();
         socks5Proxy.start();
+        try {
             assertTrue(socks5Proxy.isRunning());
 
             // get Socks5ByteStreamManager for connection
@@ -800,7 +798,6 @@ public class Socks5ByteStreamManagerTest {
 
             // return used stream host info as response to the bytestream initiation
             protocol.addResponse(streamHostUsedPacket, new Verification<Bytestream, Bytestream>() {
-
                 @Override
                 public void verify(Bytestream request, Bytestream response) {
                     assertEquals(response.getSessionID(), request.getSessionID());
@@ -810,7 +807,6 @@ public class Socks5ByteStreamManagerTest {
                     assertEquals(response.getUsedHost().getJID(), streamHost2.getJID());
                     assertEquals("localAddress", streamHost2.getAddress());
                 }
-
             }, Verification.correspondingSenderReceiver, Verification.requestTypeSET);
 
             // create digest to get the socket opened by target
@@ -840,29 +836,30 @@ public class Socks5ByteStreamManagerTest {
             assertArrayEquals(data, result);
 
             protocol.verifyAll();
-
+            } finally {
-        // reset proxy settings
                 socks5Proxy.stop();
-        socks5Proxy.removeLocalAddress("localAddress");
+            }
-        Socks5Proxy.setLocalSocks5ProxyPort(7777);
-
     }
 
     /**
      * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} the first time
      * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy and should
      * prioritize this proxy for a second SOCKS5 Bytestream negotiation.
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     * @throws IOException
      *
-     * @throws Exception should not happen
      */
     @Test
-    public void shouldPrioritizeSecondSocks5ProxyOnSecondAttempt() throws Exception {
+    public void shouldPrioritizeSecondSocks5ProxyOnSecondAttempt() throws SmackException, InterruptedException, IOException, XMPPException {
-
+        final Protocol protocol = new Protocol();
-        // disable clients local SOCKS5 proxy
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final String sessionID = "session_id_shouldPrioritizeSecondSocks5ProxyOnSecondAttempt";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
         assertTrue(byteStreamManager.isProxyPrioritizationEnabled());
 
@@ -878,11 +875,10 @@ public class Socks5ByteStreamManagerTest {
             }
 
         };
-        createResponses(streamHostUsedVerification1);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7778);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-        socks5Proxy.start();
+            createResponses(protocol, sessionID, streamHostUsedVerification1, socks5Proxy);
 
             // create digest to get the socket opened by target
             String digest = Socks5Utils.createDigest(sessionID, initiatorJID, targetJID);
@@ -915,7 +911,7 @@ public class Socks5ByteStreamManagerTest {
                 }
 
             };
-        createResponses(streamHostUsedVerification2);
+            createResponses(protocol, sessionID, streamHostUsedVerification2, socks5Proxy);
 
             // call the method that should be tested again
             outputStream = byteStreamManager.establishSession(targetJID, sessionID).getOutputStream();
@@ -930,7 +926,7 @@ public class Socks5ByteStreamManagerTest {
             assertArrayEquals(data, result);
 
             protocol.verifyAll();
-
+        }
     }
 
     /**
@@ -938,18 +934,23 @@ public class Socks5ByteStreamManagerTest {
      * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy. The second
      * negotiation should run in the same manner if prioritization is disabled.
      *
-     * @throws Exception should not happen
+     * @throws IOException
+     * @throws InterruptedException
+     * @throws SmackException
+     * @throws XMPPException
+     *
      */
     @Test
-    public void shouldNotPrioritizeSocks5ProxyIfPrioritizationDisabled() throws Exception {
+    public void shouldNotPrioritizeSocks5ProxyIfPrioritizationDisabled() throws IOException, SmackException, InterruptedException, XMPPException {
-
+        final Protocol protocol = new Protocol();
-        // disable clients local SOCKS5 proxy
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-        Socks5Proxy.setLocalSocks5ProxyEnabled(false);
+        final String sessionID = "session_id_shouldNotPrioritizeSocks5ProxyIfPrioritizationDisabled";
 
         // get Socks5ByteStreamManager for connection
         Socks5BytestreamManager byteStreamManager = Socks5BytestreamManager.getBytestreamManager(connection);
-        byteStreamManager.setProxyPrioritizationEnabled(false);
+        byteStreamManager.setAnnounceLocalStreamHost(false);
 
+        byteStreamManager.setProxyPrioritizationEnabled(false);
         assertFalse(byteStreamManager.isProxyPrioritizationEnabled());
 
         Verification<Bytestream, Bytestream> streamHostUsedVerification = new Verification<Bytestream, Bytestream>() {
@@ -964,11 +965,10 @@ public class Socks5ByteStreamManagerTest {
             }
 
         };
-        createResponses(streamHostUsedVerification);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7778);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-        socks5Proxy.start();
+            createResponses(protocol, sessionID, streamHostUsedVerification, socks5Proxy);
 
             // create digest to get the socket opened by target
             String digest = Socks5Utils.createDigest(sessionID, initiatorJID, targetJID);
@@ -989,7 +989,7 @@ public class Socks5ByteStreamManagerTest {
 
             protocol.verifyAll();
 
-        createResponses(streamHostUsedVerification);
+            createResponses(protocol, sessionID, streamHostUsedVerification, socks5Proxy);
 
             // call the method that should be tested again
             outputStream = byteStreamManager.establishSession(targetJID, sessionID).getOutputStream();
@@ -1002,14 +1002,14 @@ public class Socks5ByteStreamManagerTest {
             inputStream.read(result);
 
             assertArrayEquals(data, result);
-
-        protocol.verifyAll();
-
-        byteStreamManager.setProxyPrioritizationEnabled(true);
-
         }
 
-    private void createResponses(Verification<Bytestream, Bytestream> streamHostUsedVerification) throws XmppStringprepException {
+        protocol.verifyAll();
+    }
+
+    private static void createResponses(Protocol protocol, String sessionID,
+                    Verification<Bytestream, Bytestream> streamHostUsedVerification, Socks5TestProxy socks5TestProxy)
+                    throws XmppStringprepException {
         // build discover info that supports the SOCKS5 feature
         DiscoverInfo discoverInfo = Socks5PacketUtils.createDiscoverInfo(targetJID, initiatorJID);
         discoverInfo.addFeature(Bytestream.NAMESPACE);
@@ -1056,7 +1056,7 @@ public class Socks5ByteStreamManagerTest {
          */
         Bytestream streamHostInfo1 = Socks5PacketUtils.createBytestreamResponse(
                         JidCreate.from("proxy2.xmpp-server"), initiatorJID);
-        streamHostInfo1.addStreamHost(JidCreate.from("proxy2.xmpp-server"), proxyAddress, 7778);
+        streamHostInfo1.addStreamHost(JidCreate.from("proxy2.xmpp-server"), proxyAddress, socks5TestProxy.getPort());
 
         // return stream host info if it is queried
         protocol.addResponse(streamHostInfo1, Verification.correspondingSenderReceiver,
@@ -1065,7 +1065,7 @@ public class Socks5ByteStreamManagerTest {
         // build a SOCKS5 stream host info containing the address and the port of the proxy
         Bytestream streamHostInfo2 = Socks5PacketUtils.createBytestreamResponse(proxyJID,
                         initiatorJID);
-        streamHostInfo2.addStreamHost(proxyJID, proxyAddress, 7778);
+        streamHostInfo2.addStreamHost(proxyJID, proxyAddress, socks5TestProxy.getPort());
 
         // return stream host info if it is queried
         protocol.addResponse(streamHostInfo2, Verification.correspondingSenderReceiver,
@@ -1094,16 +1094,6 @@ public class Socks5ByteStreamManagerTest {
             }
 
         }, Verification.correspondingSenderReceiver, Verification.requestTypeSET);
-
-    }
-
-    /**
-     * Stop eventually started local SOCKS5 test proxy.
-     */
-    @After
-    public void cleanUp() {
-        Socks5TestProxy.stopProxy();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(true);
     }
 
 }

smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java

@@ -27,19 +27,16 @@ import java.io.OutputStream;
 import java.net.ServerSocket;
 import java.net.Socket;
 
-import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.XMPPConnection;
-import org.jivesoftware.smack.XMPPException;
 import org.jivesoftware.smack.packet.IQ;
 import org.jivesoftware.smack.packet.Stanza;
 import org.jivesoftware.smack.packet.StanzaError;
+import org.jivesoftware.smack.util.NetworkUtil;
 
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream;
 
 import org.jivesoftware.util.ConnectionUtils;
 import org.jivesoftware.util.Protocol;
-import org.junit.After;
-import org.junit.Before;
 import org.junit.Test;
 import org.jxmpp.jid.DomainBareJid;
 import org.jxmpp.jid.EntityFullJid;
@@ -60,27 +57,6 @@ public class Socks5ByteStreamRequestTest {
     private static final String proxyAddress = "127.0.0.1";
     private static final String sessionID = "session_id";
 
-    private Protocol protocol;
-
-    private XMPPConnection connection;
-
-    /**
-     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
-     */
-    @Before
-    public void setup() throws XMPPException, SmackException, InterruptedException {
-
-        // build protocol verifier
-        protocol = new Protocol();
-
-        // create mocked XMPP connection
-        connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
-
-    }
-
     /**
      * Accepting a SOCKS5 Bytestream request should fail if the request doesn't contain any Socks5
      * proxies.
@@ -89,6 +65,9 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldFailIfRequestHasNoStreamHosts() throws Exception {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
+
         assertThrows(Socks5Exception.NoSocks5StreamHostsProvided.class, () -> {
             // build SOCKS5 Bytestream initialization request with no SOCKS5 proxies
             Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
@@ -113,7 +92,6 @@ public class Socks5ByteStreamRequestTest {
         assertEquals(IQ.Type.error, ((IQ) targetResponse).getType());
         assertEquals(StanzaError.Condition.item_not_found,
                         targetResponse.getError().getCondition());
-
     }
 
     /**
@@ -124,6 +102,9 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldFailIfRequestHasInvalidStreamHosts() throws Exception {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
+
         assertThrows(Socks5Exception.CouldNotConnectToAnyProvidedSocks5Host.class, () -> {
             // build SOCKS5 Bytestream initialization request
             Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
@@ -150,7 +131,6 @@ public class Socks5ByteStreamRequestTest {
         assertEquals(IQ.Type.error, ((IQ) targetResponse).getType());
         assertEquals(StanzaError.Condition.item_not_found,
                         targetResponse.getError().getCondition());
-
     }
 
     /**
@@ -160,10 +140,13 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldBlacklistInvalidProxyAfter2Failures() throws Exception {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
 
         // build SOCKS5 Bytestream initialization request
         Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
                         initiatorJID, targetJID, sessionID);
+        // Add an unreachable stream host.
         bytestreamInitialization.addStreamHost(JidCreate.from("invalid." + proxyJID), "127.0.0.2", 7778);
 
         // get SOCKS5 Bytestream manager for connection
@@ -196,12 +179,12 @@ public class Socks5ByteStreamRequestTest {
 
         // create test data for stream
         byte[] data = new byte[] { 1, 2, 3 };
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7779);
 
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
             assertTrue(socks5Proxy.isRunning());
 
             // add a valid SOCKS5 proxy
-        bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, 7779);
+            bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, socks5Proxy.getPort());
 
             // build SOCKS5 Bytestream request with the bytestream initialization
             Socks5BytestreamRequest byteStreamRequest = new Socks5BytestreamRequest(byteStreamManager,
@@ -233,7 +216,7 @@ public class Socks5ByteStreamRequestTest {
             assertEquals(initiatorJID, targetResponse.getTo());
             assertEquals(IQ.Type.result, ((Bytestream) targetResponse).getType());
             assertEquals(proxyJID, ((Bytestream) targetResponse).getUsedHost().getJID());
-
+        }
     }
 
     /**
@@ -243,9 +226,8 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldNotBlacklistInvalidProxy() throws Exception {
-
+        final Protocol protocol = new Protocol();
-        // disable blacklisting
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
-        Socks5BytestreamRequest.setConnectFailureThreshold(0);
 
         // build SOCKS5 Bytestream initialization request
         Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
@@ -265,6 +247,7 @@ public class Socks5ByteStreamRequestTest {
                 // set timeouts
                 byteStreamRequest.setTotalConnectTimeout(600);
                 byteStreamRequest.setMinimumConnectTimeout(300);
+                byteStreamRequest.setConnectFailureThreshold(0);
 
                 // accept the stream (this is the call that is tested here)
                 byteStreamRequest.accept();
@@ -279,10 +262,6 @@ public class Socks5ByteStreamRequestTest {
             assertEquals(StanzaError.Condition.item_not_found,
                             targetResponse.getError().getCondition());
         }
-
-        // enable blacklisting
-        Socks5BytestreamRequest.setConnectFailureThreshold(2);
-
     }
 
     /**
@@ -294,18 +273,20 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldNotTimeoutIfFirstSocks5ProxyDoesNotRespond() throws Exception {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7778);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-
             // create a fake SOCKS5 proxy that doesn't respond to a request
-        ServerSocket serverSocket = new ServerSocket(7779);
+            ServerSocket unresponsiveSocks5Socket = NetworkUtil.getSocketOnLoopback();
 
+            try {
                 // build SOCKS5 Bytestream initialization request
                 Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
                                 initiatorJID, targetJID, sessionID);
-        bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, 7779);
+                bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, unresponsiveSocks5Socket.getLocalPort());
-        bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, 7778);
+                bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, socks5Proxy.getPort());
 
                 // create test data for stream
                 byte[] data = new byte[] { 1, 2, 3 };
@@ -325,7 +306,7 @@ public class Socks5ByteStreamRequestTest {
                 InputStream inputStream = byteStreamRequest.accept().getInputStream();
 
                 // assert that client tries to connect to dumb SOCKS5 proxy
-        Socket socket = serverSocket.accept();
+                Socket socket = unresponsiveSocks5Socket.accept();
                 assertNotNull(socket);
 
                 // create digest to get the socket opened by target
@@ -347,9 +328,10 @@ public class Socks5ByteStreamRequestTest {
                 assertEquals(initiatorJID, targetResponse.getTo());
                 assertEquals(IQ.Type.result, ((Bytestream) targetResponse).getType());
                 assertEquals(proxyJID, ((Bytestream) targetResponse).getUsedHost().getJID());
-
+            } finally {
-        serverSocket.close();
+                unresponsiveSocks5Socket.close();
-
+            }
+        }
     }
 
     /**
@@ -359,14 +341,15 @@ public class Socks5ByteStreamRequestTest {
      */
     @Test
     public void shouldAcceptSocks5BytestreamRequestAndReceiveData() throws Exception {
+        final Protocol protocol = new Protocol();
+        final XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, targetJID);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(7778);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-
             // build SOCKS5 Bytestream initialization request
             Bytestream bytestreamInitialization = Socks5PacketUtils.createBytestreamInitiation(
                             initiatorJID, targetJID, sessionID);
-        bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, 7778);
+            bytestreamInitialization.addStreamHost(proxyJID, proxyAddress, socks5Proxy.getPort());
 
             // create test data for stream
             byte[] data = new byte[] { 1, 2, 3 };
@@ -400,16 +383,6 @@ public class Socks5ByteStreamRequestTest {
             assertEquals(initiatorJID, targetResponse.getTo());
             assertEquals(IQ.Type.result, ((Bytestream) targetResponse).getType());
             assertEquals(proxyJID, ((Bytestream) targetResponse).getUsedHost().getJID());
-
         }
-
-    /**
-     * Stop eventually started local SOCKS5 test proxy.
-     */
-    @After
-    public void cleanUp() {
-        Socks5TestProxy.stopProxy();
-        Socks5Proxy.setLocalSocks5ProxyEnabled(true);
     }
-
 }

smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiatorTest.java

@@ -28,12 +28,12 @@ import java.net.Socket;
 
 import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.XMPPConnection;
-import org.jivesoftware.smack.XMPPException;
 import org.jivesoftware.smack.XMPPException.XMPPErrorException;
 import org.jivesoftware.smack.packet.EmptyResultIQ;
 import org.jivesoftware.smack.packet.ErrorIQ;
 import org.jivesoftware.smack.packet.IQ;
 import org.jivesoftware.smack.packet.StanzaError;
+import org.jivesoftware.smack.util.CloseableUtil;
 
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream;
 import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream.StreamHost;
@@ -41,8 +41,6 @@ import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream.StreamHost;
 import org.jivesoftware.util.ConnectionUtils;
 import org.jivesoftware.util.Protocol;
 import org.jivesoftware.util.Verification;
-import org.junit.After;
-import org.junit.Before;
 import org.junit.Test;
 import org.jxmpp.jid.DomainBareJid;
 import org.jxmpp.jid.EntityFullJid;
@@ -63,31 +61,8 @@ public class Socks5ClientForInitiatorTest {
 
     private static final int GET_SOCKET_TIMEOUT = 90 * 1000;
 
-    private static final int proxyPort = 7890;
     private static final String sessionID = "session_id";
 
-    // protocol verifier
-    private Protocol protocol;
-
-    // mocked XMPP connection
-    private XMPPConnection connection;
-
-    /**
-     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
-     */
-    @Before
-    public void setup() throws XMPPException, SmackException, InterruptedException {
-
-        // build protocol verifier
-        protocol = new Protocol();
-
-        // create mocked XMPP connection
-        connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
-    }
-
     /**
      * If the target is not connected to the local SOCKS5 proxy an exception should be thrown.
      *
@@ -95,12 +70,13 @@ public class Socks5ClientForInitiatorTest {
      */
     @Test
     public void shouldFailIfTargetIsNotConnectedToLocalSocks5Proxy() throws Exception {
+        Protocol protocol = new Protocol();
+        XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
 
         // start a local SOCKS5 proxy
-        Socks5Proxy.setLocalSocks5ProxyPort(proxyPort);
+        Socks5Proxy socks5Proxy = new Socks5Proxy();
-        Socks5Proxy socks5Proxy = Socks5Proxy.getSocks5Proxy();
         socks5Proxy.start();
-
+        try {
             // build stream host information for local SOCKS5 proxy
             StreamHost streamHost = new StreamHost(connection.getUser(),
                             loopbackAddress,
@@ -121,9 +97,9 @@ public class Socks5ClientForInitiatorTest {
                 assertTrue(e.getMessage().contains("target is not connected to SOCKS5 proxy"));
                 protocol.verifyAll(); // assert no XMPP messages were sent
             }
-
+        } finally {
             socks5Proxy.stop();
-
+        }
     }
 
     /**
@@ -133,12 +109,13 @@ public class Socks5ClientForInitiatorTest {
      */
     @Test
     public void shouldSuccessfullyConnectThroughLocalSocks5Proxy() throws Exception {
+        Protocol protocol = new Protocol();
+        XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
 
         // start a local SOCKS5 proxy
-        Socks5Proxy.setLocalSocks5ProxyPort(proxyPort);
+        Socks5Proxy socks5Proxy = new Socks5Proxy();
-        Socks5Proxy socks5Proxy = Socks5Proxy.getSocks5Proxy();
         socks5Proxy.start();
-
+        try {
             // test data
             final byte[] data = new byte[] { 1, 2, 3 };
 
@@ -155,7 +132,6 @@ public class Socks5ClientForInitiatorTest {
 
             // target connects to local SOCKS5 proxy
             Thread targetThread = new Thread() {
-
                 @Override
                 public void run() {
                     try {
@@ -164,13 +140,14 @@ public class Socks5ClientForInitiatorTest {
                         socket.getOutputStream().write(data);
                     }
                     catch (Exception e) {
+                        // TODO: This does not work.
                         fail(e.getMessage());
                     }
                 }
-
             };
             targetThread.start();
 
+            // TODO: Replace this Thread.sleep().
             Thread.sleep(200);
 
             // initiator connects
@@ -190,8 +167,9 @@ public class Socks5ClientForInitiatorTest {
             protocol.verifyAll(); // assert no XMPP messages were sent
 
             socks5Proxy.removeTransfer(digest);
+        } finally {
             socks5Proxy.stop();
-
+        }
     }
 
     /**
@@ -202,6 +180,8 @@ public class Socks5ClientForInitiatorTest {
      */
     @Test
     public void shouldFailIfActivateSocks5ProxyFails() throws Exception {
+        Protocol protocol = new Protocol();
+        XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
 
         // build error response as reply to the stream activation
         IQ error = new ErrorIQ(StanzaError.getBuilder(StanzaError.Condition.internal_server_error));
@@ -212,30 +192,25 @@ public class Socks5ClientForInitiatorTest {
                         Verification.requestTypeSET);
 
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(proxyPort);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-        socks5Proxy.start();
+            StreamHost streamHost = new StreamHost(proxyJID, loopbackAddress, socks5Proxy.getPort());
-
-        StreamHost streamHost = new StreamHost(proxyJID,
-                        loopbackAddress, socks5Proxy.getPort());
 
             // create digest to get the socket opened by target
             String digest = Socks5Utils.createDigest(sessionID, initiatorJID, targetJID);
 
-        Socks5ClientForInitiator socks5Client = new Socks5ClientForInitiator(streamHost, digest,
+            Socks5ClientForInitiator socks5Client = new Socks5ClientForInitiator(streamHost, digest, connection,
-                        connection, sessionID, targetJID);
+                            sessionID, targetJID);
 
             try {
 
                 socks5Client.getSocket(GET_SOCKET_TIMEOUT);
 
                 fail("exception should be thrown");
-        }
+            } catch (XMPPErrorException e) {
-        catch (XMPPErrorException e) {
                 assertTrue(StanzaError.Condition.internal_server_error.equals(e.getStanzaError().getCondition()));
                 protocol.verifyAll();
             }
-
+        }
-        socks5Proxy.stop();
     }
 
     /**
@@ -246,6 +221,8 @@ public class Socks5ClientForInitiatorTest {
      */
     @Test
     public void shouldSuccessfullyEstablishConnectionAndActivateSocks5Proxy() throws Exception {
+        Protocol protocol = new Protocol();
+        XMPPConnection connection = ConnectionUtils.createMockedConnection(protocol, initiatorJID);
 
         // build activation confirmation response
         IQ activationResponse = new EmptyResultIQ();
@@ -265,23 +242,21 @@ public class Socks5ClientForInitiatorTest {
 
                         });
 
+        Socket initiatorSocket = null, targetSocket = null;
         // start a local SOCKS5 proxy
-        Socks5TestProxy socks5Proxy = Socks5TestProxy.getProxy(proxyPort);
+        try (Socks5TestProxy socks5Proxy = new Socks5TestProxy()) {
-        socks5Proxy.start();
+            StreamHost streamHost = new StreamHost(proxyJID, loopbackAddress, socks5Proxy.getPort());
-
-        StreamHost streamHost = new StreamHost(proxyJID,
-                        loopbackAddress, socks5Proxy.getPort());
 
             // create digest to get the socket opened by target
             String digest = Socks5Utils.createDigest(sessionID, initiatorJID, targetJID);
 
-        Socks5ClientForInitiator socks5Client = new Socks5ClientForInitiator(streamHost, digest,
+            Socks5ClientForInitiator socks5Client = new Socks5ClientForInitiator(streamHost, digest, connection,
-                        connection, sessionID, targetJID);
+                            sessionID, targetJID);
 
-        Socket initiatorSocket = socks5Client.getSocket(10000);
+            initiatorSocket = socks5Client.getSocket(10000);
             InputStream in = initiatorSocket.getInputStream();
 
-        Socket targetSocket = socks5Proxy.getSocket(digest);
+            targetSocket = socks5Proxy.getSocket(digest);
             OutputStream out = targetSocket.getOutputStream();
 
             // verify test data
@@ -291,19 +266,10 @@ public class Socks5ClientForInitiatorTest {
             }
 
             protocol.verifyAll();
-
+        } finally {
-        initiatorSocket.close();
+            CloseableUtil.maybeClose(initiatorSocket);
-        targetSocket.close();
+            CloseableUtil.maybeClose(targetSocket);
-        socks5Proxy.stop();
-
         }
-
-    /**
-     * Reset default port for local SOCKS5 proxy.
-     */
-    @After
-    public void cleanup() {
-        Socks5Proxy.setLocalSocks5ProxyPort(7777);
     }
 
 }

smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java

@@ -31,6 +31,8 @@ import java.util.logging.Level;
 import java.util.logging.Logger;
 
 import org.jivesoftware.smack.SmackException;
+import org.jivesoftware.smack.util.CloseableUtil;
+import org.jivesoftware.smack.util.NetworkUtil;
 
 /**
  * Simple SOCKS5 proxy for testing purposes. It is almost the same as the Socks5Proxy class but the
@@ -38,12 +40,9 @@ import org.jivesoftware.smack.SmackException;
  *
  * @author Henning Staib
  */
-public final class Socks5TestProxy {
+public final class Socks5TestProxy implements AutoCloseable {
     private static final Logger LOGGER = Logger.getLogger(Socks5TestProxy.class.getName());
 
-    /* SOCKS5 proxy singleton */
-    private static Socks5TestProxy socks5Server;
-
     /* reusable implementation of a SOCKS5 proxy server process */
     private Socks5ServerProcess serverProcess;
 
@@ -51,65 +50,23 @@ public final class Socks5TestProxy {
     private Thread serverThread;
 
     /* server socket to accept SOCKS5 connections */
-    private ServerSocket serverSocket;
+    private final ServerSocket serverSocket;
 
     /* assigns a connection to a digest */
     private final Map<String, Socket> connectionMap = new ConcurrentHashMap<String, Socket>();
 
-    /* port of the test proxy */
-    private int port = 7777;
-
     private boolean startupComplete;
 
-    /**
+    Socks5TestProxy() throws IOException {
-     * Private constructor.
+        this(NetworkUtil.getSocketOnLoopback());
-     */
+    }
-    private Socks5TestProxy(int port) {
+
+    Socks5TestProxy(ServerSocket serverSocket) {
+        this.serverSocket = serverSocket;
         this.serverProcess = new Socks5ServerProcess();
-        this.port = port;
-    }
-
-    /**
-     * Returns the local SOCKS5 proxy server.
-     *
-     * @param port of the test proxy
-     * @return the local SOCKS5 proxy server
-     */
-    public static synchronized Socks5TestProxy getProxy(int port) {
-        if (socks5Server == null) {
-            socks5Server = new Socks5TestProxy(port);
-            socks5Server.start();
-        }
-        return socks5Server;
-    }
-
-    /**
-     * Stops the test proxy.
-     */
-    public static synchronized void stopProxy() {
-        if (socks5Server != null) {
-            socks5Server.stop();
-            socks5Server = null;
-        }
-    }
-
-    /**
-     * Starts the local SOCKS5 proxy server. If it is already running, this method does nothing.
-     */
-    public synchronized void start() {
-        if (isRunning()) {
-            return;
-        }
-        try {
-            this.serverSocket = new ServerSocket(this.port);
         this.serverThread = new Thread(this.serverProcess);
         this.serverThread.start();
     }
-        catch (IOException e) {
-            LOGGER.log(Level.SEVERE, "exception", e);
-            // do nothing
-        }
-    }
 
     /**
      * Stops the local SOCKS5 proxy server. If it is not running this method does nothing.
@@ -138,8 +95,6 @@ public final class Socks5TestProxy {
             }
         }
         this.serverThread = null;
-        this.serverSocket = null;
-
     }
 
     /**
@@ -173,16 +128,15 @@ public final class Socks5TestProxy {
      *
      * @param digest identifying the connection
      * @return socket or null if there is no socket for the given digest
+     * @throws InterruptedException
      */
-    @SuppressWarnings("WaitNotInLoop")
+    public Socket getSocket(String digest) throws InterruptedException {
-    public Socket getSocket(String digest) {
         synchronized (this) {
-            if (!startupComplete) {
+            long now = System.currentTimeMillis();
-                try {
+            final long deadline = now + 5000;
-                    wait(5000);
+            while (!startupComplete && now < deadline) {
-                } catch (InterruptedException e) {
+                wait(deadline - now);
-                    LOGGER.log(Level.SEVERE, "exception", e);
+                now = System.currentTimeMillis();
-                }
             }
         }
         if (!startupComplete) {
@@ -197,7 +151,7 @@ public final class Socks5TestProxy {
      * @return true if the local SOCKS5 proxy server is running, otherwise false
      */
     public boolean isRunning() {
-        return this.serverSocket != null;
+        return !this.serverSocket.isClosed();
     }
 
     /**
@@ -213,7 +167,7 @@ public final class Socks5TestProxy {
                 Socket socket = null;
 
                 try {
-
+                    // TODO: Add !serverSocket.isClosed() into the while condition and remove the following lines.
                     if (Socks5TestProxy.this.serverSocket.isClosed()
                                     || Thread.currentThread().isInterrupted()) {
                         return;
@@ -227,20 +181,16 @@ public final class Socks5TestProxy {
 
                     synchronized (this) {
                         startupComplete = true;
-                        notify();
+                        notifyAll();
                     }
                 }
                 catch (SocketException e) {
                     /* do nothing */
+                    LOGGER.log(Level.FINE, "Socket exception in Socks5TestProxy " + this, e);
                 }
                 catch (Exception e) {
-                    try {
                     LOGGER.log(Level.SEVERE, "exception", e);
-                        socket.close();
+                    CloseableUtil.maybeClose(socket, LOGGER);
-                    }
-                    catch (IOException e1) {
-                        /* Do Nothing */
-                    }
                 }
             }
 
@@ -309,4 +259,9 @@ public final class Socks5TestProxy {
 
     }
 
+    @Override
+    public void close() {
+        stop();
+    }
+
 }