Complete unix socket support

Ensure jnr library is optional via UnixServerAddress
Added unix socket support to the connection string.

JAVA-163

Author: rozza

.evergreen/.evg.yml

@@ -216,6 +216,15 @@ functions:
           ${PREPARE_SHELL}
           AUTH="${AUTH}" SSL="${SSL}" MONGODB_URI="${MONGODB_URI}" TOPOLOGY="${TOPOLOGY}" COMPRESSOR="${COMPRESSOR}" JDK="${JDK}" .evergreen/run-tests.sh
 
+  "run socket tests":
+    - command: shell.exec
+      type: test
+      params:
+        working_dir: "src"
+        script: |
+          ${PREPARE_SHELL}
+          AUTH="${AUTH}" MONGODB_URI="${MONGODB_URI}" TOPOLOGY="${TOPOLOGY}" COMPRESSOR="${COMPRESSOR}" JDK="${JDK}" .evergreen/run-socket-tests.sh
+
   "run plain auth test":
     - command: shell.exec
       type: test
@@ -360,6 +369,14 @@ tasks:
       commands:
         - func: "run gssapi auth test"
 
+    - name: "socket-test"
+      depends_on:
+        - variant: "static-checks"
+          name: "static-analysis"
+      commands:
+        - func: "bootstrap mongo-orchestration"
+        - func: "run socket tests"
+
     - name: publish-snapshot
       depends_on:
         - variant: ".tests-variant"
@@ -520,6 +537,20 @@ buildvariants:
   tasks:
      - name: "test"
 
+- matrix_name: "tests-socket"
+  matrix_spec: { auth: "*", ssl: "nossl", jdk: "jdk8", version: "3.6", topology: "*", os: "linux" }
+  display_name: "Socket: ${version} ${topology} ${auth} ${jdk} ${os} "
+  tags: ["tests-socket-variant"]
+  tasks:
+     - name: "socket-test"
+
+- matrix_name: "tests-socket-snappy-compression"
+  matrix_spec: { compressor : "snappy", auth: "noauth", ssl: "nossl", jdk: "jdk7", version: "3.6", topology: "standalone", os: "linux" }
+  display_name: "Socket: ${version} ${compressor} ${topology} ${auth} ${jdk} ${os} "
+  tags: ["tests-socket-variant"]
+  tasks:
+     - name: "socket-test"
+
 - matrix_name: "test-gssapi"
   matrix_spec: { jdk: "*", os: "linux" }
   display_name: "GSSAPI (Kerberos) Auth test ${jdk} ${os} "

.evergreen/run-socket-tests.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+set -o xtrace   # Write all commands first to stderr
+set -o errexit  # Exit the script with error if any of the commands fail
+
+# Supported/used environment variables:
+#       AUTH                    Set to enable authentication. Values are: "auth" / "noauth" (default)
+#       MONGODB_URI             Set the suggested connection MONGODB_URI (including credentials and topology info)
+#       TOPOLOGY                Allows you to modify variables and the MONGODB_URI based on test topology
+#                               Supported values: "server", "replica_set", "sharded_cluster"
+#       COMPRESSOR              Set to enable compression. Values are "snappy" and "zlib" (default is no compression)
+#       JDK                     Set the version of java to be used.  Java versions can be set from the java toolchain /opt/java
+#                               "jdk5", "jdk6", "jdk7", "jdk8"
+
+AUTH=${AUTH:-noauth}
+MONGODB_URI=${MONGODB_URI:-}
+JDK=${JDK:-jdk}
+JAVA_HOME="/opt/java/${JDK}"
+TOPOLOGY=${TOPOLOGY:-server}
+COMPRESSOR=${COMPRESSOR:-}
+
+############################################
+#            Main Program                  #
+############################################
+
+SOCKET_REGEX='(.*)localhost:([0-9]+)?(.*)'
+while [[ $MONGODB_URI =~ $SOCKET_REGEX ]]; do
+	MONGODB_URI="${BASH_REMATCH[1]}%2Ftmp%2Fmongodb-${BASH_REMATCH[2]}.sock${BASH_REMATCH[3]}"
+done
+
+# Provision the correct connection string and set up SSL if needed
+if [ "$TOPOLOGY" == "sharded_cluster" ]; then
+
+     if [ "$AUTH" = "auth" ]; then
+       export MONGODB_URI="mongodb://bob:pwd123@%2Ftmp%2Fmongodb-27017.sock/?authSource=admin"
+     else
+       export MONGODB_URI="mongodb://%2Ftmp%2Fmongodb-27017.sock/"
+     fi
+fi
+
+if [ "$COMPRESSOR" != "" ]; then
+     if [[ "$MONGODB_URI" == *"?"* ]]; then
+       export MONGODB_URI="${MONGODB_URI}&compressors=${COMPRESSOR}"
+     else
+       export MONGODB_URI="${MONGODB_URI}/?compressors=${COMPRESSOR}"
+     fi
+fi
+
+echo "Running $AUTH tests over for $TOPOLOGY and connecting to $MONGODB_URI"
+
+# We always compile with the latest version of java
+export JAVA_HOME="/opt/java/jdk8"
+
+echo "Running tests with ${JDK}"
+./gradlew -version
+./gradlew -PjdkHome=/opt/java/${JDK} -Dorg.mongodb.test.uri=${MONGODB_URI} ${GRADLE_EXTRA_VARS} --stacktrace --info :driver-legacy:test :driver-sync:test

docs/reference/content/driver/tutorials/connect-to-mongodb.md

@@ -79,6 +79,12 @@ To connect to a standalone MongoDB instance:
     MongoClient mongoClient = new MongoClient( "host1" );
     ```
 
+- You can connect to the Unix domain socket (requires the `jnr.unixsocket` library):
+
+    ```java
+    MongoClient mongoClient = new MongoClient( "/tmp/mongodb-27017.sock" );
+    ```
+
 - You can explicitly specify the hostname and the port:
 
     ```java
@@ -92,6 +98,12 @@ To connect to a standalone MongoDB instance:
     MongoClient mongoClient = new MongoClient(new MongoClientURI("mongodb://host1:27017"));
     ```
 
+  Unix domain socket connections via the connection string (requires the `jnr.unixsocket` library and the path to be urlencoded):
+
+  ```java
+  MongoClient mongoClient = new MongoClient(new MongoClientURI("mongodb://%2Ftmp%2Fmongodb-27107.sock"));
+  ```
+
 ## Connect to a Replica Set
 
 To connect to a [replica set]({{<docsref "replication/">}}), you must specify  one or more members to the

docs/reference/content/whats-new.md

@@ -7,6 +7,16 @@ title = "What's New"
   pre = "<i class='fa fa-level-up'></i>"
 +++
 
+## What's New in 3.7
+
+Key new features of the 3.7 Java driver release:
+
+### Unix domain socket support
+
+The 3.7 driver adds support for Unix domain sockets via the [`jnr.unixsocket`](http://https://github.com/jnr/jnr-unixsocket) library.
+Connecting to Unix domain sockets is done via the [`ConnectionString`]({{< apiref "com/mongodb/ConnectionString" >}}) or via
+[`UnixServerAddress`]({{<apiref "com/mongodb/UnixServerAddress.html">}}).
+
 ## What's New in 3.6
 
 Key new features of the 3.6 Java driver release:

driver-core/build.gradle

@@ -54,7 +54,8 @@ jar {
                     'org.ietf.jgss.*',
                     'io.netty.*;resolution:=optional',
                     'org.xerial.snappy.*;resolution:=optional',
-                    'org.slf4j;resolution:=optional'
+                    'org.slf4j;resolution:=optional',
+                    'jnr.unixsocket;resolution:=optional'
     }
 }
 

driver-core/src/main/com/mongodb/ConnectionString.java

@@ -52,7 +52,10 @@
  * <li>{@code username:password@} are optional.  If given, the driver will attempt to login to a database after
  * connecting to a database server.  For some authentication mechanisms, only the username is specified and the password is not,
  * in which case the ":" after the username is left off as well</li>
- * <li>{@code host1} is the only required part of the connection string.  It identifies a server address to connect to.</li>
+ * <li>{@code host1} is the only required part of the connection string. It identifies a server address to connect to.
+ * Support for Unix domain sockets was added in 3.7. Note: The path must be urlencoded eg: {@code mongodb://%2Ftmp%2Fmongodb-27017.sock}
+ * and the {@code jnr.unixsocket} library installed.
+ * </li>
  * <li>{@code :portX} is optional and defaults to :27017 if not provided.</li>
  * <li>{@code /database} is the name of the database to login to and thus is only relevant if the
  * {@code username:password@} syntax is used. If not specified the "admin" database will be used by default.</li>
@@ -833,8 +836,7 @@ private List<String> parseHosts(final List<String> rawHosts, final boolean isSRV
             if (host.length() == 0) {
                 throw new IllegalArgumentException(format("The connection string contains an empty host '%s'. ", rawHosts));
             } else if (host.endsWith(".sock")) {
-                throw new IllegalArgumentException(format("The connection string contains an invalid host '%s'. "
-                        + "Unix Domain Socket which is not supported by the Java driver", host));
+                host = urldecode(host);
             } else if (host.startsWith("[")) {
                 if (!host.contains("]")) {
                     throw new IllegalArgumentException(format("The connection string contains an invalid host '%s'. "

driver-core/src/main/com/mongodb/ServerAddress.java

@@ -19,13 +19,9 @@
 import com.mongodb.annotations.Immutable;
 import com.mongodb.lang.Nullable;
 
-import jnr.unixsocket.UnixSocketAddress;
-
-import java.io.File;
 import java.io.Serializable;
 import java.net.InetAddress;
 import java.net.InetSocketAddress;
-import java.net.SocketAddress;
 import java.net.UnknownHostException;
 
 /**
@@ -37,7 +33,6 @@ public class ServerAddress implements Serializable {
 
     private final String host;
     private final int port;
-    private final SocketAddress address;
 
     /**
      * Creates a ServerAddress with default host and port
@@ -61,7 +56,7 @@ public ServerAddress(@Nullable final String host) {
      * @param inetAddress host address
      */
     public ServerAddress(final InetAddress inetAddress) {
-        this(inetAddress.getHostName(), defaultPort(), new InetSocketAddress(inetAddress, defaultPort()));
+        this(inetAddress.getHostName(), defaultPort());
     }
 
     /**
@@ -71,7 +66,7 @@ public ServerAddress(final InetAddress inetAddress) {
      * @param port        mongod port
      */
     public ServerAddress(final InetAddress inetAddress, final int port) {
-        this(inetAddress.getHostName(), port, new InetSocketAddress(inetAddress, port));
+        this(inetAddress.getHostName(), port);
     }
 
     /**
@@ -80,38 +75,7 @@ public ServerAddress(final InetAddress inetAddress, final int port) {
      * @param inetSocketAddress inet socket address containing hostname and port
      */
     public ServerAddress(final InetSocketAddress inetSocketAddress) {
-        this(inetSocketAddress.getHostName(), inetSocketAddress.getPort(), inetSocketAddress);
-    }
-
-    /**
-     * Creates a ServerAddress
-     *
-     * @param serverAddress an instance to be shallow-copied
-     */
-    public ServerAddress(final ServerAddress serverAddress) {
-        this(serverAddress.host, serverAddress.port, serverAddress.address);
-    }
-
-    /**
-     * Creates a ServerAddress
-     *
-     * @param path the file used for the Unix domain socket
-     */
-    public ServerAddress(final File path) {
-        this(path.toString(), 0, new UnixSocketAddress(path));
-    }
-
-    /**
-     * Creates a ServerAddress - intended for internal usage
-     *
-     * @param host hostname
-     * @param port mongod port
-     * @param address an instance of socket address or `null`
-     */
-    protected ServerAddress(final String host, final int port, final SocketAddress address) {
-        this.host = host;
-        this.port = port;
-        this.address = address;
+        this(inetSocketAddress.getAddress(), inetSocketAddress.getPort());
     }
 
     /**
@@ -121,29 +85,31 @@ protected ServerAddress(final String host, final int port, final SocketAddress a
      * @param port mongod port
      */
     public ServerAddress(@Nullable final String host, final int port) {
-        String hostToUse = host == null ? defaultHost() : host;
+        String hostToUse = host;
+        if (hostToUse == null) {
+            hostToUse = defaultHost();
+        }
         hostToUse = hostToUse.trim();
         if (hostToUse.length() == 0) {
             hostToUse = defaultHost();
         }
-
         int portToUse = port;
 
         if (hostToUse.startsWith("[")) {
-            int idx = hostToUse.indexOf("]");
+            int idx = host.indexOf("]");
             if (idx == -1) {
                 throw new IllegalArgumentException("an IPV6 address must be encosed with '[' and ']'"
                                                    + " according to RFC 2732.");
             }
 
-            int portIdx = hostToUse.indexOf("]:");
+            int portIdx = host.indexOf("]:");
             if (portIdx != -1) {
                 if (port != defaultPort()) {
                     throw new IllegalArgumentException("can't specify port in construct and via host");
                 }
-                portToUse = Integer.parseInt(hostToUse.substring(portIdx + 2));
+                portToUse = Integer.parseInt(host.substring(portIdx + 2));
             }
-            hostToUse = hostToUse.substring(1, idx);
+            hostToUse = host.substring(1, idx);
         } else {
             int idx = hostToUse.indexOf(":");
             int lastIdx = hostToUse.lastIndexOf(":");
@@ -161,7 +127,6 @@ public ServerAddress(@Nullable final String host, final int port) {
         }
         this.host = hostToUse.toLowerCase();
         this.port = portToUse;
-        this.address = null;
     }
 
     @Override
@@ -216,10 +181,7 @@ public int getPort() {
      *
      * @return socket address
      */
-    public SocketAddress getSocketAddress() {
-        if (address != null) {
-            return address;
-        }
+    public InetSocketAddress getSocketAddress() {
         try {
             return new InetSocketAddress(InetAddress.getByName(host), port);
         } catch (UnknownHostException e) {

driver-core/src/main/com/mongodb/UnixServerAddress.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb;
+
+import com.mongodb.annotations.Immutable;
+import jnr.unixsocket.UnixSocketAddress;
+
+import java.net.InetSocketAddress;
+import java.net.SocketAddress;
+
+import static com.mongodb.assertions.Assertions.isTrueArgument;
+import static com.mongodb.assertions.Assertions.notNull;
+
+/**
+ * Represents the location of a MongoD unix domain socket.
+ *
+ * <p>Requires the 'jnr.unixsocket' library.</p>
+ * @since 3.7
+ */
+@Immutable
+public final class UnixServerAddress extends ServerAddress {
+    private static final long serialVersionUID = 154466643544866543L;
+
+    /**
+     * Creates a new instance
+     * @param path the path of the MongoD unix domain socket.
+     */
+    public UnixServerAddress(final String path) {
+        super(notNull("The path cannot be null", path));
+        isTrueArgument("The path must end in .sock", path.endsWith(".sock"));
+    }
+
+    @Override
+    public InetSocketAddress getSocketAddress() {
+        throw new UnsupportedOperationException("Cannot return a InetSocketAddress from a UnixServerAddress");
+    }
+
+    /**
+     * @return the SocketAddress for the MongoD unix domain socket.
+     */
+    public SocketAddress getUnixSocketAddress() {
+        return new UnixSocketAddress(getHost());
+    }
+
+    @Override
+    public String toString() {
+        return getHost();
+    }
+}