Merge pull request #2 from mhurne/master

Support standard MongoDB connection strings

Author: davidmc24

CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+*   1.3.0 (2014-05-15)
+    *   Add support for [standard MongoDB connection strings](http://docs.mongodb.org/manual/reference/connection-string/)
+    *   Support for non-standard "gridfs://" connection strings is deprecated and may be removed in a future release
+    
 *   1.2.0 (2014-02-17)
     *   Upgrade JClouds to version 1.7.1, in order to support changes between Java versions 1.7.0_45 and 1.7.0_51.  See https://issues.apache.org/jira/browse/JCLOUDS-427
 

README.md

@@ -1,10 +1,12 @@
 # Overview
 
-A JClouds BlobStore provider backed by MongoDB's GridFS.  Not all capabilities are supported, but there should be enough for common use cases.
+A JClouds BlobStore provider backed by MongoDB's GridFS.  Not all capabilities are supported, but there should be
+enough for common use cases.
 
 # Usage
 
-First, add a dependency to your build file.  Releases are published to [Bintray JCenter](https://bintray.com/bintray/jcenter).  See the [changelog](CHANGES.md) for the latest version.
+First, add a dependency to your build file.  Releases are published to
+[Bintray JCenter](https://bintray.com/bintray/jcenter).  See the [changelog](CHANGES.md) for the latest version.
 
 Gradle:
 
@@ -27,17 +29,32 @@ Maven:
 </dependency>
 ```
 
-Next, obtain an instance of the `BlobStore`.
+Next, obtain an instance of the `BlobStore` using a
+[standard MongoDB connection string](http://docs.mongodb.org/manual/reference/connection-string/):
 
 ```java
 Properties overrides = new Properties();
-overrides.setProperty(Constants.PROPERTY_ENDPOINT, "gridfs://my_mongo_server:27017");
+overrides.setProperty(Constants.PROPERTY_ENDPOINT, "mongodb://my_mongo_server:27017/?maxPoolSize=50");
 BlobStoreContext context = ContextBuilder.newBuilder("gridfs").overrides(overrides)
     .buildView(BlobStoreContext.class);
 BlobStore blobStore = context.getBlobStore();
 ```
 
-Then, use the blob store to put/get blobs.  The container is in the format **DB**[/**BUCKET**], where **DB** is the name of the database and **BUCKET** is the optional name of the GridFS bucket (which defaults to `fs`).
+You can also use a non-standard connection string (deprecated):
+
+```java
+overrides.setProperty(Constants.PROPERTY_ENDPOINT, "gridfs://my_mongo_server:27017");
+```
+
+To use a replica set when using a non-standard connection string, specify additional members as a comma or
+semicolon-separated list, like this:
+
+```java
+overrides.setProperty(Constants.PROPERTY_ENDPOINT, "gridfs://node1:27017;node2:27017;node3:27017");
+```
+
+Then, use the blob store to put/get blobs.  The container is in the format **DB**[/**BUCKET**], where **DB** is the
+name of the database and **BUCKET** is the optional name of the GridFS bucket (which defaults to `fs`).
 
 ```java
 blobStore.createContainerInLocation(null, "blobStore");
@@ -51,9 +68,3 @@ Finally, close the context to allow it to properly clean up.
 ```java
 context.close();
 ```
-
-To use a replica set, specify additional members as a comma or semicolon-separated list, like this:
-
-```java
-overrides.setProperty(Constants.PROPERTY_ENDPOINT, "gridfs://node1:27017;node2:27017;node3:27017");
-```

gradle.properties

@@ -1 +1 @@
-version=1.2.1
+version=1.3.0

src/main/java/com/commercehub/jclouds/gridfs/blobstore/Constants.java

@@ -1,5 +1,12 @@
 package com.commercehub.jclouds.gridfs.blobstore;
 
 class Constants {
+
+    /**
+     * @deprecated Use a <a href="http://docs.mongodb.org/manual/reference/connection-string/">standard MongoDB
+     * connection string</a> instead.
+     */
+    @Deprecated
     static final String GRIDFS_URI_SCHEME = "gridfs";
+
 }

src/main/java/com/commercehub/jclouds/gridfs/blobstore/GridFSBlobStore.java

@@ -4,8 +4,7 @@
 import com.mongodb.BasicDBObject;
 import com.mongodb.DBObject;
 import com.mongodb.MongoClient;
-import com.mongodb.MongoClientOptions;
-import com.mongodb.MongoCredential;
+import com.mongodb.MongoClientURI;
 import com.mongodb.ServerAddress;
 import com.mongodb.gridfs.GridFS;
 import com.mongodb.gridfs.GridFSDBFile;
@@ -32,10 +31,10 @@
 
 import javax.inject.Inject;
 import java.net.UnknownHostException;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
+import static com.commercehub.jclouds.gridfs.blobstore.Constants.GRIDFS_URI_SCHEME;
 import static com.commercehub.jclouds.gridfs.blobstore.Util.parseGridFSIdentifier;
 import static com.commercehub.jclouds.gridfs.blobstore.Util.parseServerAddresses;
 import static com.google.common.base.Preconditions.checkNotNull;
@@ -60,15 +59,18 @@ protected GridFSBlobStore(ProviderMetadata providerMetadata, BlobStoreContext co
         this.dbFileToBlobMetadata = dbFileToBlobMetadata;
         this.locations = checkNotNull(locations, "locations");
 
-        List<ServerAddress> addresses = parseServerAddresses(providerMetadata.getEndpoint());
-        List<MongoCredential> credentials = new ArrayList<>(); // TODO support credentials
-        MongoClientOptions options = MongoClientOptions.builder().build(); // TODO support options configuration
-        if (addresses.size() > 1) {
-            this.mongo = new MongoClient(addresses, credentials, options);
+        String endpoint = providerMetadata.getEndpoint();
+        if (endpoint.startsWith(GRIDFS_URI_SCHEME)) {
+            List<ServerAddress> addresses = parseServerAddresses(endpoint);
+            if (addresses.size() > 1) {
+                this.mongo = new MongoClient(addresses);
+            } else {
+                // If only one address, assume we want single-node mode.
+                // You should always use multiple seeds with a replica set.
+                this.mongo = new MongoClient(addresses.get(0));
+            }
         } else {
-            // If only one address, assume we want single-node mode.
-            // You should always use multiple seeds with a replica set.
-            this.mongo = new MongoClient(addresses.get(0), credentials, options);
+            this.mongo = new MongoClient(new MongoClientURI(endpoint));
         }
     }
 

src/test/groovy/com/commercehub/jclouds/gridfs/blobstore/GridFSBlobStoreEndpointSpec.groovy

@@ -0,0 +1,43 @@
+package com.commercehub.jclouds.gridfs.blobstore
+
+import org.jclouds.ContextBuilder
+import org.jclouds.blobstore.BlobStore
+import org.jclouds.blobstore.BlobStoreContext
+import spock.lang.Specification
+
+import static com.commercehub.jclouds.gridfs.blobstore.Constants.GRIDFS_URI_SCHEME
+import static org.jclouds.Constants.PROPERTY_ENDPOINT
+
+class GridFSBlobStoreEndpointSpec extends Specification {
+    private static final HOST = "localhost"
+    private static final PORT = 27017
+
+    private BlobStoreContext context
+    private BlobStore blobStore
+
+    private void initBlobStore(String endpoint) {
+        // TODO: use embedded mongo
+        def overrides = new Properties()
+        overrides.setProperty(PROPERTY_ENDPOINT, endpoint)
+        context = ContextBuilder.newBuilder("gridfs")
+                .overrides(overrides)
+                .buildView(BlobStoreContext)
+        blobStore = context.getBlobStore()
+    }
+
+    def cleanup() {
+        if (context) {
+            context.close()
+        }
+    }
+
+    def "can create blobStore with 'gridfs://' endpoint"() {
+        expect:
+        initBlobStore("${GRIDFS_URI_SCHEME}://${HOST}:${PORT}")
+    }
+
+    def "can create blobStore with standard connection string endpoint"() {
+        expect:
+        initBlobStore("mongodb://${HOST}:${PORT}")
+    }
+}

src/test/groovy/com/commercehub/jclouds/gridfs/blobstore/GridFSBlobStoreSpec.groovy

@@ -15,8 +15,6 @@ import org.jclouds.blobstore.options.PutOptions
 import spock.lang.Shared
 import spock.lang.Specification
 
-import static com.commercehub.jclouds.gridfs.blobstore.Constants.GRIDFS_URI_SCHEME
-
 class GridFSBlobStoreSpec extends Specification {
     private static final DB_NAME = this.simpleName
     private static final BUCKET = "bk1"
@@ -40,7 +38,7 @@ class GridFSBlobStoreSpec extends Specification {
         mongo.getDB(DB_NAME).dropDatabase()
         // TODO: use embedded mongo
         def overrides = new Properties()
-        overrides.setProperty(Constants.PROPERTY_ENDPOINT, "${GRIDFS_URI_SCHEME}://${host}:${port}");
+        overrides.setProperty(Constants.PROPERTY_ENDPOINT, "mongodb://${host}:${port}");
         context = ContextBuilder.newBuilder("gridfs")
             .overrides(overrides)
             .buildView(BlobStoreContext)