Datastax DSE a Separate Module fix #653

Author: jknack

coverage-report/pom.xml

@@ -798,6 +798,13 @@
       <version>2.0.7</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.datastax.cassandra</groupId>
+      <artifactId>dse-driver</artifactId>
+      <version>1.1.2</version>
+      <scope>test</scope>
+    </dependency>
+
   </dependencies>
 
 </project>

jooby-cassandra/pom.xml

@@ -119,6 +119,13 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>com.datastax.cassandra</groupId>
+      <artifactId>dse-driver</artifactId>
+      <version>1.1.2</version>
+      <scope>test</scope>
+    </dependency>
+
   </dependencies>
 
 </project>

jooby-cassandra/src/main/java/org/jooby/cassandra/Cassandra.java

@@ -24,6 +24,7 @@
 import java.util.List;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
+import java.util.function.Supplier;
 
 import org.jooby.Env;
 import org.jooby.Env.ServiceKey;
@@ -190,6 +191,21 @@
  * The accessor can be required or injected in a MVC route.
  * </p>
  *
+ * <h2>dse-driver</h2>
+ * <p>
+ * Add the <code>dse-driver</code> dependency to your classpath and then:
+ * </p>
+ *
+ * <pre>
+ * {
+ *    use(new Cassandra(DseCluster::build));
+ * }
+ * </pre>
+ *
+ * <p>
+ * That's all! Now you can <code>require/inject</code> a <code>DseSession</code>.
+ * </p>
+ *
  * <h2>async</h2>
  * <p>
  * Async? Of course!!! just use the Datastax async API:
@@ -269,6 +285,8 @@ public class Cassandra implements Module {
   /** The logging system. */
   private final Logger log = LoggerFactory.getLogger(getClass());
 
+  private static final Supplier<Cluster.Builder> BUILDER = Cluster::builder;
+
   private BiConsumer<Cluster.Builder, Config> ccbuilder;
 
   private BiConsumer<Cluster, Config> cc;
@@ -279,6 +297,35 @@ public class Cassandra implements Module {
 
   private List<Class> accesors = new ArrayList<>();
 
+  private Supplier<Cluster.Builder> builder = Cluster::builder;
+
+  /**
+   * Creates a new {@link Cassandra} module.
+   *
+   * Conenct via connection string:
+   *
+   * <pre>{@code
+   * {
+   *   use(new Cassandra("cassandra://localhost/db", DseCluster::builder));
+   * }
+   * }</pre>
+   *
+   * Or via property:
+   *
+   * <pre>{@code
+   * {
+   *   use(new Cassandra("db", DseCluster::builder));
+   * }
+   * }</pre>
+   *
+   * @param db Connection string or a property with a connection String.
+   * @param builder Cluster builder.
+   */
+  public Cassandra(final String db, final Supplier<Cluster.Builder> builder) {
+    this.db = requireNonNull(db, "ContactPoint/db key required.");
+    this.builder = requireNonNull(builder, "Cluster.Builder required.");
+  }
+
   /**
    * Creates a new {@link Cassandra} module.
    *
@@ -301,7 +348,15 @@ public class Cassandra implements Module {
    * @param db Connection string or a property with a connection String.
    */
   public Cassandra(final String db) {
-    this.db = requireNonNull(db, "ContactPoint/db key required.");
+    this(db, BUILDER);
+  }
+
+  /**
+   * Creates a new {@link Cassandra} module. A property <code>db</code> property must be present and
+   * have a valid connection string.
+   */
+  public Cassandra(final Supplier<Cluster.Builder> builder) {
+    this("db", builder);
   }
 
   /**
@@ -382,7 +437,7 @@ public void configure(final Env env, final Config conf, final Binder binder) {
       return null;
     };
 
-    Cluster.Builder builder = Cluster.builder()
+    Cluster.Builder builder = this.builder.get()
         .addContactPoints(cstr.contactPoints())
         .withPort(cstr.port());
 
@@ -409,11 +464,11 @@ public void configure(final Env env, final Config conf, final Binder binder) {
         LocalDateCodec.instance,
         LocalTimeCodec.instance);
 
-    bind.apply(Cluster.class, cstr.keyspace(), cluster);
+    hierarchy(cluster.getClass(), type -> bind.apply(type, cstr.keyspace(), cluster));
 
     /** Session + Mapper */
     Session session = cluster.connect(cstr.keyspace());
-    bind.apply(Session.class, cstr.keyspace(), session);
+    hierarchy(session.getClass(), type -> bind.apply(type, cstr.keyspace(), session));
 
     MappingManager manager = new MappingManager(session);
     bind.apply(MappingManager.class, cstr.keyspace(), manager);
@@ -439,4 +494,19 @@ public void configure(final Env env, final Config conf, final Binder binder) {
     });
   }
 
+  @SuppressWarnings("rawtypes")
+  static void hierarchy(final Class type, final Consumer<Class> consumer) {
+    if (type != Object.class) {
+      if (type.getName().startsWith("com.datastax")) {
+        consumer.accept(type);
+      }
+      for (Class i : type.getInterfaces()) {
+        hierarchy(i, consumer);
+      }
+      if (!type.isInterface()) {
+        hierarchy(type.getSuperclass(), consumer);
+      }
+    }
+  }
+
 }

jooby-cassandra/src/test/java/org/jooby/cassandra/CassandraTest.java

@@ -2,6 +2,10 @@
 
 import static org.easymock.EasyMock.expect;
 import static org.easymock.EasyMock.expectLastCall;
+import static org.junit.Assert.assertEquals;
+
+import java.util.HashSet;
+import java.util.Set;
 
 import org.jooby.Env;
 import org.jooby.Env.ServiceKey;
@@ -17,12 +21,16 @@
 import com.datastax.driver.core.Cluster.Builder;
 import com.datastax.driver.core.CodecRegistry;
 import com.datastax.driver.core.Configuration;
+import com.datastax.driver.core.DelegatingCluster;
 import com.datastax.driver.core.Host.StateListener;
 import com.datastax.driver.core.Session;
+import com.datastax.driver.dse.DseCluster;
+import com.datastax.driver.dse.DseSession;
 import com.datastax.driver.extras.codecs.jdk8.InstantCodec;
 import com.datastax.driver.extras.codecs.jdk8.LocalDateCodec;
 import com.datastax.driver.extras.codecs.jdk8.LocalTimeCodec;
 import com.datastax.driver.mapping.MappingManager;
+import com.google.common.collect.ImmutableSet;
 import com.google.inject.Binder;
 import com.google.inject.Key;
 import com.google.inject.binder.AnnotatedBindingBuilder;
@@ -36,8 +44,15 @@
     MappingManager.class, Datastore.class, CassandraMapper.class })
 public class CassandraTest {
 
+  @SuppressWarnings({"rawtypes", "unchecked" })
   private Block clusterBuilder = unit -> {
+    String cname = Cluster.class.getName();
     unit.mockStatic(Cluster.class);
+    expect(Cluster.class.getName()).andReturn(cname);
+    expect(Cluster.class.getInterfaces()).andReturn(new Class[0]);
+    expect(Cluster.class.isInterface()).andReturn(false);
+    Class obj = Object.class;
+    expect(Cluster.class.getSuperclass()).andReturn(obj);
 
     Cluster cluster = unit.get(Cluster.class);
     expect(cluster.getConfiguration()).andReturn(unit.get(Configuration.class));
@@ -47,6 +62,23 @@ public class CassandraTest {
     expect(builder.build()).andReturn(cluster);
   };
 
+  @SuppressWarnings({"rawtypes", "unchecked" })
+  private Block clusterBuilderProvider = unit -> {
+    String cname = Cluster.class.getName();
+    unit.mockStatic(Cluster.class);
+    expect(Cluster.class.getName()).andReturn(cname);
+    expect(Cluster.class.getInterfaces()).andReturn(new Class[0]);
+    expect(Cluster.class.isInterface()).andReturn(false);
+    Class obj = Object.class;
+    expect(Cluster.class.getSuperclass()).andReturn(obj);
+
+    Cluster cluster = unit.get(Cluster.class);
+    expect(cluster.getConfiguration()).andReturn(unit.get(Configuration.class));
+
+    Builder builder = unit.get(Cluster.Builder.class);
+    expect(builder.build()).andReturn(cluster);
+  };
+
   private Block codecRegistry = unit -> {
     CodecRegistry codecRegistry = unit.powerMock(CodecRegistry.class);
 
@@ -124,6 +156,37 @@ public void connectViaProperty() throws Exception {
             });
   }
 
+  @Test
+  public void connectViaPropertySupplier() throws Exception {
+    new MockUnit(Env.class, Config.class, Binder.class, Cluster.class, Cluster.Builder.class,
+        Configuration.class, Session.class)
+            .expect(unit -> {
+              Config conf = unit.get(Config.class);
+              expect(conf.getString("db")).andReturn("cassandra://localhost/beers");
+            })
+            .expect(serviceKey(new Env.ServiceKey()))
+            .expect(clusterBuilderProvider)
+            .expect(contactPoints("localhost"))
+            .expect(port(9042))
+            .expect(codecRegistry)
+            .expect(bind("beers", Cluster.class))
+            .expect(bind(null, Cluster.class))
+            .expect(bind("beers", Session.class))
+            .expect(bind(null, Session.class))
+            .expect(connect("beers"))
+            .expect(mapper)
+            .expect(bind("beers", MappingManager.class))
+            .expect(bind(null, MappingManager.class))
+            .expect(datastore)
+            .expect(bind("beers", Datastore.class))
+            .expect(bind(null, Datastore.class))
+            .expect(routeMapper).expect(onStop)
+            .run(unit -> {
+              new Cassandra(() -> unit.get(Cluster.Builder.class))
+                  .configure(unit.get(Env.class), unit.get(Config.class), unit.get(Binder.class));
+            });
+  }
+
   private Block serviceKey(final ServiceKey serviceKey) {
     return unit -> {
       Env env = unit.get(Env.class);
@@ -158,6 +221,33 @@ public void connectViaConnectionString() throws Exception {
             });
   }
 
+  @Test
+  public void connectViaConnectionStringSupplier() throws Exception {
+    new MockUnit(Env.class, Config.class, Binder.class, Cluster.class, Cluster.Builder.class,
+        Configuration.class, Session.class)
+            .expect(clusterBuilderProvider)
+            .expect(serviceKey(new Env.ServiceKey()))
+            .expect(contactPoints("localhost"))
+            .expect(port(9042))
+            .expect(codecRegistry)
+            .expect(bind("beers", Cluster.class))
+            .expect(bind(null, Cluster.class))
+            .expect(bind("beers", Session.class))
+            .expect(bind(null, Session.class))
+            .expect(connect("beers"))
+            .expect(mapper)
+            .expect(bind("beers", MappingManager.class))
+            .expect(bind(null, MappingManager.class))
+            .expect(datastore)
+            .expect(bind("beers", Datastore.class))
+            .expect(bind(null, Datastore.class))
+            .expect(routeMapper).expect(onStop)
+            .run(unit -> {
+              new Cassandra("cassandra://localhost/beers", () -> unit.get(Cluster.Builder.class))
+                  .configure(unit.get(Env.class), unit.get(Config.class), unit.get(Binder.class));
+            });
+  }
+
   @Test
   public void onStop() throws Exception {
     new MockUnit(Env.class, Config.class, Binder.class, Cluster.class, Cluster.Builder.class,
@@ -350,16 +440,41 @@ private Block bind(final String name, final Class type) {
       Binder binder = unit.get(Binder.class);
       if (name == null) {
         AnnotatedBindingBuilder aab = unit.mock(AnnotatedBindingBuilder.class);
-        aab.toInstance(unit.get(type));
+        Object val = unit.get(type);
+        aab.toInstance(val);
+        expectLastCall().times(1, 2);
         expect(binder.bind(Key.get(type))).andReturn(aab);
+        expect(binder.bind(Key.get(val.getClass()))).andReturn(aab).times(0, 1);
       } else {
         AnnotatedBindingBuilder aab = unit.mock(AnnotatedBindingBuilder.class);
-        aab.toInstance(unit.get(type));
+        Object val = unit.get(type);
+        aab.toInstance(val);
+        expectLastCall().times(1, 2);
         expect(binder.bind(Key.get(type, Names.named(name)))).andReturn(aab);
+        expect(binder.bind(Key.get(val.getClass(), Names.named(name)))).andReturn(aab).times(0, 1);
       }
     };
   }
 
+  @Test
+  public void hierarchy() {
+    assertEquals(ImmutableSet.of(), hierarchy(Object.class));
+    // normal
+    assertEquals(ImmutableSet.of(Cluster.class), hierarchy(Cluster.class));
+    assertEquals(ImmutableSet.of(Session.class), hierarchy(Session.class));
+    // dse
+    assertEquals(ImmutableSet.of(DseCluster.class, DelegatingCluster.class, Cluster.class),
+        hierarchy(DseCluster.class));
+    assertEquals(ImmutableSet.of(DseSession.class, Session.class), hierarchy(DseSession.class));
+  }
+
+  @SuppressWarnings("rawtypes")
+  private Set<Class> hierarchy(final Class type) {
+    Set<Class> types = new HashSet<>();
+    Cassandra.hierarchy(type, types::add);
+    return types;
+  }
+
   private Block port(final int port) {
     return unit -> {
       Builder builder = unit.get(Cluster.Builder.class);

md/doc/cassandra/cassandra.md

@@ -119,6 +119,18 @@ Accessors provide a way to map custom queries not supported by the default entit
 
 The accessor can be required or injected in a MVC route.
 
+## dse-driver
+
+Add the `dse-driver` dependency to your classpath and then:
+
+```java
+{
+   use(new Cassandra(DseCluster::build));
+}
+```
+
+That's all! Now you can `require/inject` a `DseSession`.
+
 ## async
 
 Async? Of course!!! just use the Datastax async API: