com.datastax.oss.driver.api.testinfra.session

Class SessionRule<SessionT extends com.datastax.oss.driver.api.core.session.Session>

java.lang.Object

org.junit.rules.ExternalResource

com.datastax.oss.driver.api.testinfra.session.SessionRule<SessionT>

All Implemented Interfaces:

org.junit.rules.TestRule

public class SessionRule<SessionT extends com.datastax.oss.driver.api.core.session.Session>
extends org.junit.rules.ExternalResource

Creates and manages a Session instance for a test.

Use it in conjunction with a CassandraResourceRule that creates the server resource to connect to:

 public static @ClassRule CcmRule server = CcmRule.getInstance();

 // Or: public static @ClassRule SimulacronRule server =
 //    new SimulacronRule(ClusterSpec.builder().withNodes(3));

 public static @ClassRule SessionRule sessionRule = new SessionRule(server);

 public void @Test should_do_something() {
   sessionRule.session().execute("some query");
 }
 

Optionally, it can also create a dedicated keyspace (useful to isolate tests that share a common server).

If you would rather create a new keyspace manually in each test, see the utility methods in SessionUtils.

Constructor Summary

Constructors

Constructor and Description
SessionRule(CassandraResourceRule cassandraResource, boolean createKeyspace, com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener, com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener, com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader)
SessionRule(CassandraResourceRule cassandraResource, boolean createKeyspace, com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener, com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener, com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader, String graphName)
SessionRule(CassandraResourceRule cassandraResource, boolean createKeyspace, com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener, com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener, com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader, String graphName, boolean isCoreGraph)

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
static CqlSessionRuleBuilder	builder(CassandraResourceRule cassandraResource) Returns a builder to construct an instance with a fluent API.
String	getGraphName()
com.datastax.oss.driver.api.core.CqlIdentifier	keyspace()
SessionT	session()
com.datastax.oss.driver.api.core.config.DriverExecutionProfile	slowProfile()

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionRule

public SessionRule(CassandraResourceRule cassandraResource,
                   boolean createKeyspace,
                   com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener,
                   com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener,
                   com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader,
                   String graphName,
                   boolean isCoreGraph)

See Also:

builder(CassandraResourceRule)

SessionRule

public SessionRule(CassandraResourceRule cassandraResource,
                   boolean createKeyspace,
                   com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener,
                   com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener,
                   com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader,
                   String graphName)

SessionRule

public SessionRule(CassandraResourceRule cassandraResource,
                   boolean createKeyspace,
                   com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener,
                   com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener,
                   com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader)

Method Detail

builder

public static CqlSessionRuleBuilder builder(CassandraResourceRule cassandraResource)

Returns a builder to construct an instance with a fluent API.

Parameters:

cassandraResource - resource to create clusters for.

before

protected void before()

Overrides:

before in class org.junit.rules.ExternalResource

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

session

public SessionT session()

Returns:

the session created with this rule.

keyspace

public com.datastax.oss.driver.api.core.CqlIdentifier keyspace()

Returns:

the identifier of the keyspace associated with this rule, or null if no keyspace was created (this is always the case if the server resource is a SimulacronRule).

getGraphName

public String getGraphName()

slowProfile

public com.datastax.oss.driver.api.core.config.DriverExecutionProfile slowProfile()

Returns:

a config profile where the request timeout is 30 seconds. *