From 5479ced6b6b7c7b75eeffff848f196ac377a5f2f Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Sun, 12 May 2024 17:22:30 +0200 Subject: [PATCH 01/14] Upgrade Java driver for Cassandra to latest version This allows a full support of Cassandra 5 without errors/warnings --- modules/cassandra/build.gradle | 2 +- .../containers/CassandraContainer.java | 85 ++++++++++--------- .../delegate/CassandraDatabaseDelegate.java | 16 ++-- .../containers/CassandraContainerTest.java | 33 ++++--- ...er3Test.java => CassandraServer5Test.java} | 8 +- 5 files changed, 77 insertions(+), 67 deletions(-) rename modules/cassandra/src/test/java/org/testcontainers/containers/{CassandraDriver3Test.java => CassandraServer5Test.java} (85%) diff --git a/modules/cassandra/build.gradle b/modules/cassandra/build.gradle index 79492c044db..519f0c3d7e7 100644 --- a/modules/cassandra/build.gradle +++ b/modules/cassandra/build.gradle @@ -8,7 +8,7 @@ configurations.all { dependencies { api project(":database-commons") - api "com.datastax.cassandra:cassandra-driver-core:3.10.0" + api "com.datastax.oss:java-driver-core:4.17.0" testImplementation 'com.datastax.oss:java-driver-core:4.17.0' testImplementation 'org.assertj:assertj-core:3.25.1' diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java index bb291cd1f80..0cb31baf509 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java @@ -1,6 +1,11 @@ package org.testcontainers.containers; -import com.datastax.driver.core.Cluster; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.CqlSessionBuilder; +import com.datastax.oss.driver.api.core.config.DefaultDriverOption; +import com.datastax.oss.driver.api.core.config.DriverConfigLoader; +import com.datastax.oss.driver.api.core.config.ProgrammaticDriverConfigLoaderBuilder; +import com.datastax.oss.driver.internal.core.loadbalancing.DcInferringLoadBalancingPolicy; import com.github.dockerjava.api.command.InspectContainerResponse; import org.apache.commons.io.IOUtils; import org.testcontainers.containers.delegate.CassandraDatabaseDelegate; @@ -14,6 +19,7 @@ import java.net.InetSocketAddress; import java.net.URL; import java.nio.charset.StandardCharsets; +import java.time.Duration; import java.util.Optional; import javax.script.ScriptException; @@ -48,8 +54,6 @@ public class CassandraContainer> extends G private String initScriptPath; - private boolean enableJmxReporting; - /** * @deprecated use {@link #CassandraContainer(DockerImageName)} instead */ @@ -67,7 +71,6 @@ public CassandraContainer(DockerImageName dockerImageName) { dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); addExposedPort(CQL_PORT); - this.enableJmxReporting = false; withEnv("CASSANDRA_SNITCH", "GossipingPropertyFileSnitch"); withEnv("JVM_OPTS", "-Dcassandra.skip_wait_for_gossip_to_settle=0 -Dcassandra.initial_token=0"); @@ -156,14 +159,6 @@ public SELF withInitScript(String initScriptPath) { return self(); } - /** - * Initialize Cassandra client with JMX reporting enabled or disabled - */ - public SELF withJmxReporting(boolean enableJmxReporting) { - this.enableJmxReporting = enableJmxReporting; - return self(); - } - /** * Get username * @@ -189,37 +184,50 @@ public String getPassword() { } /** - * Get configured Cluster - * - * Can be used to obtain connections to Cassandra in the container + * Get a session on the configured cluster. * - * @deprecated For Cassandra driver 3.x, use {@link #getHost()} and {@link #getMappedPort(int)} with - * the driver's {@link Cluster#builder() Cluster.Builder} {@code addContactPoint(String)} and - * {@code withPort(int)} methods to create a Cluster object. For Cassandra driver 4.x, use - * {@link #getContactPoint()} and {@link #getLocalDatacenter()} with the driver's {@code CqlSession.builder()} - * {@code addContactPoint(InetSocketAddress)} and {@code withLocalDatacenter(String)} methods to create - * a Session Object. See https://docs.datastax.com/en/developer/java-driver/ for more on the driver. + * Can be used to obtain connections to Cassandra in the container. */ - @Deprecated - public Cluster getCluster() { - return getCluster(this, enableJmxReporting); - } + public CqlSession getCqlSession() { + return getCqlSession(this); + } + + public static CqlSession getCqlSession(ContainerState containerState) { + final ProgrammaticDriverConfigLoaderBuilder driverConfigLoaderBuilder = DriverConfigLoader.programmaticBuilder(); + boolean dcAvailable = containerState.getClass().isAssignableFrom(CassandraContainer.class); + + // If the ContainerState is not a CassandraContainer instance, use DcInferringLoadBalancingPolicy to not have + // to specify the local datacenter to establish the connection, otherwise we can keep the default load balancing + // policy requiring to explicitly specify the local data center. + // See https://docs.datastax.com/en/developer/java-driver/latest/manual/core/configuration/reference/ for + // further information. + if (!dcAvailable) { + driverConfigLoaderBuilder.withClass( + DefaultDriverOption.LOAD_BALANCING_POLICY_CLASS, + DcInferringLoadBalancingPolicy.class + ); + } - @Deprecated - public static Cluster getCluster(ContainerState containerState, boolean enableJmxReporting) { - final Cluster.Builder builder = Cluster + // Ignore warnings when a CQL script modifies the current keyspace. Typically, this generates unnecessary logs + // when executing an init script using multiple keyspaces. + driverConfigLoaderBuilder.withBoolean(DefaultDriverOption.REQUEST_WARN_IF_SET_KEYSPACE, false); + + // Using Java driver 4.x, a feature called debouncing has been introduced: schema and topology changes received + // from the server could be accumulated before being processed by the driver. For more information, see: + // https://docs.datastax.com/en/developer/java-driver/latest/manual/core/performance/index.html#debouncing + // and https://stackoverflow.com/a/74152732/13292108 + // To maintain good performance, reduce the default values for the schema debouncing properties. + driverConfigLoaderBuilder.withInt(DefaultDriverOption.METADATA_SCHEMA_MAX_EVENTS, 1); + driverConfigLoaderBuilder.withDuration(DefaultDriverOption.METADATA_SCHEMA_WINDOW, Duration.ofMillis(1)); + + final CqlSessionBuilder cqlSessionBuilder = CqlSession .builder() - .addContactPoint(containerState.getHost()) - .withPort(containerState.getMappedPort(CQL_PORT)); - if (!enableJmxReporting) { - builder.withoutJMXReporting(); + .withConfigLoader(driverConfigLoaderBuilder.build()) + .addContactPoint(new InetSocketAddress(containerState.getHost(), containerState.getMappedPort(CQL_PORT))); + if (dcAvailable) { + cqlSessionBuilder.withLocalDatacenter(((CassandraContainer) containerState).getLocalDatacenter()); } - return builder.build(); - } - - @Deprecated - public static Cluster getCluster(ContainerState containerState) { - return getCluster(containerState, false); + return cqlSessionBuilder.build(); } /** @@ -240,7 +248,6 @@ public String getLocalDatacenter() { return getEnvMap().getOrDefault("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); } - @Deprecated private DatabaseDelegate getDatabaseDelegate() { return new CassandraDatabaseDelegate(this); } diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java index 8d604822083..e4d49c93bb7 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java @@ -1,8 +1,8 @@ package org.testcontainers.containers.delegate; -import com.datastax.driver.core.ResultSet; -import com.datastax.driver.core.Session; -import com.datastax.driver.core.exceptions.DriverException; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.DriverException; +import com.datastax.oss.driver.api.core.cql.ResultSet; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.testcontainers.containers.CassandraContainer; @@ -16,14 +16,14 @@ */ @Slf4j @RequiredArgsConstructor -public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { +public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { private final ContainerState container; @Override - protected Session createNewConnection() { + protected CqlSession createNewConnection() { try { - return CassandraContainer.getCluster(container).newSession(); + return CassandraContainer.getCqlSession(container); } catch (DriverException e) { log.error("Could not obtain cassandra connection"); throw new ConnectionCreationException("Could not obtain cassandra connection", e); @@ -51,9 +51,9 @@ public void execute( } @Override - protected void closeConnectionQuietly(Session session) { + protected void closeConnectionQuietly(CqlSession session) { try { - session.getCluster().close(); + session.close(); } catch (Exception e) { log.error("Could not close cassandra connection", e); } diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java index eb3a8b068ea..ef2469d383d 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java @@ -1,14 +1,15 @@ package org.testcontainers.containers; -import com.datastax.driver.core.Cluster; -import com.datastax.driver.core.ResultSet; -import com.datastax.driver.core.Row; -import com.datastax.driver.core.Session; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.cql.ResultSet; +import com.datastax.oss.driver.api.core.cql.Row; import lombok.extern.slf4j.Slf4j; import org.junit.Test; import org.testcontainers.containers.wait.CassandraQueryWaitStrategy; import org.testcontainers.utility.DockerImageName; +import java.net.InetSocketAddress; + import static org.assertj.core.api.Assertions.assertThat; @Slf4j @@ -112,7 +113,7 @@ public void testCassandraQueryWaitStrategy() { public void testCassandraGetCluster() { try (CassandraContainer cassandraContainer = new CassandraContainer<>()) { cassandraContainer.start(); - ResultSet resultSet = performQuery(cassandraContainer.getCluster(), BASIC_QUERY); + ResultSet resultSet = performQuery(cassandraContainer.getCqlSession(), BASIC_QUERY); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); assertThat(resultSet.one().getString(0)).as("Result set has release_version").isNotNull(); } @@ -127,18 +128,22 @@ private void testInitScript(CassandraContainer cassandraContainer) { } private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { - Cluster explicitCluster = Cluster + final CqlSession cqlSession = CqlSession .builder() - .addContactPoint(cassandraContainer.getHost()) - .withPort(cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT)) + .addContactPoint( + new InetSocketAddress( + cassandraContainer.getHost(), + cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT) + ) + ) + .withLocalDatacenter(cassandraContainer.getLocalDatacenter()) .build(); - return performQuery(explicitCluster, cql); + return performQuery(cqlSession, cql); } - private ResultSet performQuery(Cluster cluster, String cql) { - try (Cluster closeableCluster = cluster) { - Session session = closeableCluster.newSession(); - return session.execute(cql); - } + private ResultSet performQuery(CqlSession session, String cql) { + final ResultSet rs = session.execute(cql); + session.close(); + return rs; } } diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java similarity index 85% rename from modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java rename to modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java index 502f2ca8e67..70dd006e8e9 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java @@ -8,21 +8,19 @@ import static org.assertj.core.api.Assertions.assertThat; -public class CassandraDriver3Test { +public class CassandraServer5Test { @Rule - public CassandraContainer cassandra = new CassandraContainer<>("cassandra:3.11.2"); + public CassandraContainer cassandra = new CassandraContainer<>("cassandra:5"); @Test public void testCassandraGetContactPoint() { try ( - // cassandra { CqlSession session = CqlSession .builder() .addContactPoint(this.cassandra.getContactPoint()) .withLocalDatacenter(this.cassandra.getLocalDatacenter()) .build() - // } ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + @@ -31,7 +29,7 @@ public void testCassandraGetContactPoint() { KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); - assertThat(keyspace).as("keyspace created").isNotNull(); + assertThat(keyspace).as("test keyspace created").isNotNull(); } } } From 437abf62398458175d01a19b0c315db258bfacc2 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Tue, 14 May 2024 20:03:44 +0200 Subject: [PATCH 02/14] Fix documentation for Cassandra module --- docs/modules/databases/cassandra.md | 2 +- .../org/testcontainers/containers/CassandraDriver4Test.java | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index 73f93bf203a..a672485a9de 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -5,7 +5,7 @@ This example connects to the Cassandra Cluster, creates a keyspaces and asserts that is has been created. -[Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java) inside_block:cassandra +[Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java) inside_block:cassandra !!! warning diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java index a4fb8c87b8e..79bddcbd043 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java @@ -16,11 +16,13 @@ public class CassandraDriver4Test { @Test public void testCassandraGetContactPoint() { try ( + // cassandra { CqlSession session = CqlSession .builder() .addContactPoint(this.cassandra.getContactPoint()) .withLocalDatacenter(this.cassandra.getLocalDatacenter()) .build() + // } ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + From 2e9e295d362df2cf2e1ab7d5280bc500d0335155 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Sat, 25 May 2024 15:55:35 +0200 Subject: [PATCH 03/14] Add CassandraContainer implementation without dependency on Java driver This implementation in the new package org.testcontainers.cassandra uses cqlsh command inside the running Cassandra container to execute scripts. So, the dependency to the Java driver is no more required. The implementation in the package org.testcontainers.containers has been marked as deprecated. --- docs/modules/databases/cassandra.md | 15 +- .../cassandra/CassandraContainer.java | 177 ++++++++++++++++++ .../delegate/CassandraDatabaseDelegate.java | 69 +++++++ .../wait/CassandraQueryWaitStrategy.java | 47 +++++ .../containers/CassandraContainer.java | 3 + .../delegate/CassandraDatabaseDelegate.java | 3 + .../wait/CassandraQueryWaitStrategy.java | 3 + .../cassandra/CassandraContainerTest.java | 148 +++++++++++++++ .../cassandra/CassandraDriver4Test.java | 40 ++++ .../cassandra/CassandraServer4Test.java | 36 ++++ .../cassandra/CassandraServer5Test.java | 36 ++++ .../src/test/resources/initial-with-error.cql | 6 + 12 files changed, 577 insertions(+), 6 deletions(-) create mode 100644 modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java create mode 100644 modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java create mode 100644 modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java create mode 100644 modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java create mode 100644 modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java create mode 100644 modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java create mode 100644 modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java create mode 100644 modules/cassandra/src/test/resources/initial-with-error.cql diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index a672485a9de..e6fa39c3c83 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -2,14 +2,17 @@ ## Usage example -This example connects to the Cassandra Cluster, creates a keyspaces and asserts that is has been created. +This example connects to the Cassandra cluster: - -[Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java) inside_block:cassandra - +1. Define a container: + + [Defining container](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:container-definition + -!!! warning - All methods returning instances of the Cassandra Driver's Cluster object in `CassandraContainer` have been deprecated. Providing these methods unnecessarily couples the Container to the Driver and creates potential breaking changes if the driver is updated. +2. Build a `CqlSession`: + + [Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:cql-session + ## Adding this module to your project dependencies diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java new file mode 100644 index 00000000000..a270bbd7bbd --- /dev/null +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -0,0 +1,177 @@ +package org.testcontainers.cassandra; + +import com.github.dockerjava.api.command.InspectContainerResponse; +import org.apache.commons.io.IOUtils; +import org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.ext.ScriptUtils; +import org.testcontainers.ext.ScriptUtils.ScriptLoadException; +import org.testcontainers.utility.DockerImageName; +import org.testcontainers.utility.MountableFile; + +import java.io.IOException; +import java.net.InetSocketAddress; +import java.net.URL; +import java.nio.charset.StandardCharsets; +import java.util.Optional; + +/** + * Testcontainers implementation for Apache Cassandra. + *

+ * Supported image: {@code cassandra} + *

+ * Exposed ports: 9042 + */ +public class CassandraContainer> extends GenericContainer { + + private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("cassandra"); + + public static final Integer CQL_PORT = 9042; + + private static final String DEFAULT_LOCAL_DATACENTER = "datacenter1"; + + private static final String CONTAINER_CONFIG_LOCATION = "/etc/cassandra"; + + private static final String USERNAME = "cassandra"; + + private static final String PASSWORD = "cassandra"; + + private String configLocation; + + private String initScriptPath; + + public CassandraContainer(DockerImageName dockerImageName) { + super(dockerImageName); + dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); + + addExposedPort(CQL_PORT); + + withEnv("CASSANDRA_SNITCH", "GossipingPropertyFileSnitch"); + withEnv("JVM_OPTS", "-Dcassandra.skip_wait_for_gossip_to_settle=0 -Dcassandra.initial_token=0"); + withEnv("HEAP_NEWSIZE", "128M"); + withEnv("MAX_HEAP_SIZE", "1024M"); + withEnv("CASSANDRA_ENDPOINT_SNITCH", "GossipingPropertyFileSnitch"); + withEnv("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); + } + + @Override + protected void configure() { + optionallyMapResourceParameterAsVolume(CONTAINER_CONFIG_LOCATION, configLocation); + } + + @Override + protected void containerIsStarted(InspectContainerResponse containerInfo) { + runInitScriptIfRequired(); + } + + /** + * Load init script content and apply it to the database if initScriptPath is set + */ + private void runInitScriptIfRequired() { + if (initScriptPath != null) { + try { + URL resource = Thread.currentThread().getContextClassLoader().getResource(initScriptPath); + if (resource == null) { + logger().warn("Could not load classpath init script: {}", initScriptPath); + throw new ScriptLoadException( + "Could not load classpath init script: " + initScriptPath + ". Resource not found." + ); + } + String cql = IOUtils.toString(resource, StandardCharsets.UTF_8); + new CassandraDatabaseDelegate(this).execute(cql, initScriptPath, -1, false, false); + } catch (IOException e) { + logger().warn("Could not load classpath init script: {}", initScriptPath); + throw new ScriptLoadException("Could not load classpath init script: " + initScriptPath, e); + } catch (ScriptUtils.ScriptStatementFailedException e) { + logger().error("Error while executing init script: {}", initScriptPath, e); + throw new ScriptUtils.UncategorizedScriptException( + "Error while executing init script: " + initScriptPath, + e + ); + } + } + } + + /** + * Map (effectively replace) directory in Docker with the content of resourceLocation if resource location is not null + * + * Protected to allow for changing implementation by extending the class + * + * @param pathNameInContainer path in docker + * @param resourceLocation relative classpath to resource + */ + protected void optionallyMapResourceParameterAsVolume(String pathNameInContainer, String resourceLocation) { + Optional + .ofNullable(resourceLocation) + .map(MountableFile::forClasspathResource) + .ifPresent(mountableFile -> withCopyFileToContainer(mountableFile, pathNameInContainer)); + } + + /** + * Initialize Cassandra with the custom overridden Cassandra configuration + *

+ * Be aware, that Docker effectively replaces all /etc/cassandra content with the content of config location, so if + * Cassandra.yaml in configLocation is absent or corrupted, then Cassandra just won't launch + * + * @param configLocation relative classpath with the directory that contains cassandra.yaml and other configuration files + */ + public SELF withConfigurationOverride(String configLocation) { + this.configLocation = configLocation; + return self(); + } + + /** + * Initialize Cassandra with init CQL script + *

+ * CQL script will be applied after container is started (see using WaitStrategy) + * + * @param initScriptPath relative classpath resource + */ + public SELF withInitScript(String initScriptPath) { + this.initScriptPath = initScriptPath; + return self(); + } + + /** + * Get username + * + * By default, Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml + * If username and password need to be used, then authenticator should be set as PasswordAuthenticator + * (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials + * user management should be modified + */ + public String getUsername() { + return USERNAME; + } + + /** + * Get password + * + * By default, Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml + * If username and password need to be used, then authenticator should be set as PasswordAuthenticator + * (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials + * user management should be modified + */ + public String getPassword() { + return PASSWORD; + } + + /** + * Retrieve an {@link InetSocketAddress} for connecting to the Cassandra container via the driver. + * + * @return A InetSocketAddrss representation of this Cassandra container's host and port. + */ + public InetSocketAddress getContactPoint() { + return new InetSocketAddress(getHost(), getMappedPort(CQL_PORT)); + } + + /** + * Retrieve the Local Datacenter for connecting to the Cassandra container via the driver. + * + * @return The configured local Datacenter name. + */ + public String getLocalDatacenter() { + return getEnvMap().getOrDefault("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); + } + +} diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java new file mode 100644 index 00000000000..ddd772be7b4 --- /dev/null +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java @@ -0,0 +1,69 @@ +package org.testcontainers.cassandra.delegate; + +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.ArrayUtils; +import org.testcontainers.cassandra.CassandraContainer; +import org.testcontainers.containers.Container; +import org.testcontainers.containers.ContainerState; +import org.testcontainers.containers.ExecConfig; +import org.testcontainers.delegate.AbstractDatabaseDelegate; +import org.testcontainers.ext.ScriptUtils.ScriptStatementFailedException; + +import java.io.IOException; + +/** + * Cassandra database delegate + */ +@Slf4j +@RequiredArgsConstructor +public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { + + private final ContainerState container; + + @Override + protected Void createNewConnection() { + // Return null here, because we run scripts using cqlsh command directly in the container. + // So, we don't use connection object in the execute() method. + return null; + } + + @Override + public void execute( + String statement, + String scriptPath, + int lineNumber, + boolean continueOnError, + boolean ignoreFailedDrops + ) { + try { + // Use cqlsh command directly inside the container to execute statements + // See documentation here: https://cassandra.apache.org/doc/stable/cassandra/tools/cqlsh.html + String[] cqlshCommand = new String[]{"cqlsh", "-e", statement}; + + if (this.container instanceof CassandraContainer) { + CassandraContainer cassandraContainer = ((CassandraContainer) this.container); + String username = cassandraContainer.getUsername(); + String password = cassandraContainer.getPassword(); + ArrayUtils.addAll(cqlshCommand, "-u", username, "-p", password); + } + + Container.ExecResult result = this.container.execInContainer(ExecConfig.builder() + .command(cqlshCommand) + .build()); + if (result.getExitCode() == 0) { + log.debug("Statement {} was applied", statement); + } else { + log.error("Statement execution failed with error: \n{}", result.getStderr()); + throw new ScriptStatementFailedException(statement, lineNumber, scriptPath); + } + } catch (IOException | InterruptedException e) { + throw new ScriptStatementFailedException(statement, lineNumber, scriptPath, e); + } + } + + @Override + protected void closeConnectionQuietly(Void session) { + // Nothing to do here, because we run scripts using cqlsh command directly in the container. + } +} diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java new file mode 100644 index 00000000000..3bcf9be12da --- /dev/null +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java @@ -0,0 +1,47 @@ +package org.testcontainers.cassandra.wait; + +import org.rnorth.ducttape.TimeoutException; +import org.testcontainers.containers.ContainerLaunchException; +import org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate; +import org.testcontainers.containers.wait.strategy.AbstractWaitStrategy; +import org.testcontainers.delegate.DatabaseDelegate; + +import java.util.concurrent.TimeUnit; + +import static org.rnorth.ducttape.unreliables.Unreliables.retryUntilSuccess; + +/** + * Waits until Cassandra returns its version + */ +public class CassandraQueryWaitStrategy extends AbstractWaitStrategy { + + private static final String SELECT_VERSION_QUERY = "SELECT release_version FROM system.local"; + + private static final String TIMEOUT_ERROR = "Timed out waiting for Cassandra to be accessible for query execution"; + + @Override + protected void waitUntilReady() { + // execute select version query until success or timeout + try { + retryUntilSuccess( + (int) startupTimeout.getSeconds(), + TimeUnit.SECONDS, + () -> { + getRateLimiter() + .doWhenReady(() -> { + try (DatabaseDelegate databaseDelegate = getDatabaseDelegate()) { + databaseDelegate.execute(SELECT_VERSION_QUERY, "", 1, false, false); + } + }); + return true; + } + ); + } catch (TimeoutException e) { + throw new ContainerLaunchException(TIMEOUT_ERROR); + } + } + + private DatabaseDelegate getDatabaseDelegate() { + return new CassandraDatabaseDelegate(waitStrategyTarget); + } +} diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java index 0cb31baf509..66064e52ca7 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java @@ -30,7 +30,10 @@ * Supported image: {@code cassandra} *

* Exposed ports: 9042 + * + * @deprecated use {@link org.testcontainers.cassandra.CassandraContainer} instead. */ +@Deprecated public class CassandraContainer> extends GenericContainer { private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("cassandra"); diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java index e4d49c93bb7..9edb0669215 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java @@ -13,9 +13,12 @@ /** * Cassandra database delegate + * + * @deprecated use {@link org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate} instead. */ @Slf4j @RequiredArgsConstructor +@Deprecated public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { private final ContainerState container; diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/wait/CassandraQueryWaitStrategy.java b/modules/cassandra/src/main/java/org/testcontainers/containers/wait/CassandraQueryWaitStrategy.java index cffb1ba757e..362e33e3543 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/wait/CassandraQueryWaitStrategy.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/wait/CassandraQueryWaitStrategy.java @@ -12,7 +12,10 @@ /** * Waits until Cassandra returns its version + * + * @deprecated use {@link org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy} instead. */ +@Deprecated public class CassandraQueryWaitStrategy extends AbstractWaitStrategy { private static final String SELECT_VERSION_QUERY = "SELECT release_version FROM system.local"; diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java new file mode 100644 index 00000000000..becb0b61d82 --- /dev/null +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -0,0 +1,148 @@ +package org.testcontainers.cassandra; + +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.cql.ResultSet; +import com.datastax.oss.driver.api.core.cql.Row; +import lombok.extern.slf4j.Slf4j; +import org.junit.Test; +import org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy; +import org.testcontainers.containers.ContainerLaunchException; +import org.testcontainers.utility.DockerImageName; + +import java.net.InetSocketAddress; + +import static org.assertj.core.api.Assertions.assertThat; + +@Slf4j +public class CassandraContainerTest { + + private static final DockerImageName CASSANDRA_IMAGE = DockerImageName.parse("cassandra:3.11.2"); + + private static final String TEST_CLUSTER_NAME_IN_CONF = "Test Cluster Integration Test"; + + private static final String BASIC_QUERY = "SELECT release_version FROM system.local"; + + @Test + public void testSimple() { + try (CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE)) { + cassandraContainer.start(); + ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); + assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); + assertThat(resultSet.one().getString(0)).as("Result set has release_version").isNotNull(); + } + } + + @Test + public void testSpecificVersion() { + String cassandraVersion = "3.0.15"; + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>( + CASSANDRA_IMAGE.withTag(cassandraVersion) + ) + ) { + cassandraContainer.start(); + ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); + assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); + assertThat(resultSet.one().getString(0)).as("Cassandra has right version").isEqualTo(cassandraVersion); + } + } + + @Test + public void testConfigurationOverride() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + .withConfigurationOverride("cassandra-test-configuration-example") + ) { + cassandraContainer.start(); + ResultSet resultSet = performQuery(cassandraContainer, "SELECT cluster_name FROM system.local"); + assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); + assertThat(resultSet.one().getString(0)) + .as("Cassandra configuration is overridden") + .isEqualTo(TEST_CLUSTER_NAME_IN_CONF); + } + } + + @Test(expected = ContainerLaunchException.class) + public void testEmptyConfigurationOverride() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + .withConfigurationOverride("cassandra-empty-configuration") + ) { + cassandraContainer.start(); + } + } + + @Test + public void testInitScript() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + .withInitScript("initial.cql") + ) { + cassandraContainer.start(); + testInitScript(cassandraContainer); + } + } + + @Test(expected = ContainerLaunchException.class) + public void testInitScriptWithError() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + .withInitScript("initial-with-error.cql") + ) { + cassandraContainer.start(); + } + } + + @Test + public void testInitScriptWithLegacyCassandra() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>( + DockerImageName.parse("cassandra:2.2.11") + ) + .withInitScript("initial.cql") + ) { + cassandraContainer.start(); + testInitScript(cassandraContainer); + } + } + + @Test + public void testCassandraQueryWaitStrategy() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + .waitingFor(new CassandraQueryWaitStrategy()) + ) { + cassandraContainer.start(); + ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); + assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); + } + } + + private void testInitScript(CassandraContainer cassandraContainer) { + ResultSet resultSet = performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category"); + assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); + Row row = resultSet.one(); + assertThat(row.getLong(0)).as("Inserted row is in expected state").isEqualTo(1); + assertThat(row.getString(1)).as("Inserted row is in expected state").isEqualTo("test_category"); + } + + private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { + final CqlSession cqlSession = CqlSession + .builder() + .addContactPoint( + new InetSocketAddress( + cassandraContainer.getHost(), + cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT) + ) + ) + .withLocalDatacenter(cassandraContainer.getLocalDatacenter()) + .build(); + return performQuery(cqlSession, cql); + } + + private ResultSet performQuery(CqlSession session, String cql) { + final ResultSet rs = session.execute(cql); + session.close(); + return rs; + } +} diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java new file mode 100644 index 00000000000..2edc3837a6e --- /dev/null +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java @@ -0,0 +1,40 @@ +package org.testcontainers.cassandra; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; +import org.junit.Rule; +import org.junit.Test; +import org.testcontainers.utility.DockerImageName; + +import static org.assertj.core.api.Assertions.assertThat; + +public class CassandraDriver4Test { + + @Rule + // container-definition { + public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:3.11.2")); + // } + + @Test + public void testCassandraGetContactPoint() { + try ( + // cql-session { + CqlSession session = CqlSession + .builder() + .addContactPoint(cassandra.getContactPoint()) + .withLocalDatacenter(cassandra.getLocalDatacenter()) + .build() + // } + ) { + session.execute( + "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + + "{'class':'SimpleStrategy','replication_factor':'1'};" + ); + + KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); + + assertThat(keyspace).as("test keyspace created").isNotNull(); + } + } +} diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java new file mode 100644 index 00000000000..4a8ed9a8440 --- /dev/null +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java @@ -0,0 +1,36 @@ +package org.testcontainers.cassandra; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; +import org.junit.Rule; +import org.junit.Test; +import org.testcontainers.utility.DockerImageName; + +import static org.assertj.core.api.Assertions.assertThat; + +public class CassandraServer4Test { + + @Rule + public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:4.1.1")); + + @Test + public void testCassandraGetContactPoint() { + try ( + CqlSession session = CqlSession + .builder() + .addContactPoint(this.cassandra.getContactPoint()) + .withLocalDatacenter(this.cassandra.getLocalDatacenter()) + .build() + ) { + session.execute( + "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + + "{'class':'SimpleStrategy','replication_factor':'1'};" + ); + + KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); + + assertThat(keyspace).as("test keyspace created").isNotNull(); + } + } +} diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java new file mode 100644 index 00000000000..0e8b947050e --- /dev/null +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java @@ -0,0 +1,36 @@ +package org.testcontainers.cassandra; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; +import org.junit.Rule; +import org.junit.Test; +import org.testcontainers.utility.DockerImageName; + +import static org.assertj.core.api.Assertions.assertThat; + +public class CassandraServer5Test { + + @Rule + public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:5")); + + @Test + public void testCassandraGetContactPoint() { + try ( + CqlSession session = CqlSession + .builder() + .addContactPoint(this.cassandra.getContactPoint()) + .withLocalDatacenter(this.cassandra.getLocalDatacenter()) + .build() + ) { + session.execute( + "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + + "{'class':'SimpleStrategy','replication_factor':'1'};" + ); + + KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); + + assertThat(keyspace).as("test keyspace created").isNotNull(); + } + } +} diff --git a/modules/cassandra/src/test/resources/initial-with-error.cql b/modules/cassandra/src/test/resources/initial-with-error.cql new file mode 100644 index 00000000000..4f0e11d721b --- /dev/null +++ b/modules/cassandra/src/test/resources/initial-with-error.cql @@ -0,0 +1,6 @@ +CREATE KEYSPACE keySpaceTest WITH replication = {'class': 'SimpleStrategy', 'replication_factor' : 1}; + +USE keySpaceTest; + +/* The following statement contains an error (missing primary key) on purpose, do not fix it! */ +CREATE TABLE catalog_category (id bigint); From 16a644b83c3d407d070f0897e754fdf3b7406d25 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Sat, 25 May 2024 17:31:52 +0200 Subject: [PATCH 04/14] Using -f argument to execute init script in Cassandra container --- .../cassandra/CassandraContainer.java | 17 +++++++------- .../delegate/CassandraDatabaseDelegate.java | 23 +++++++++++++++---- 2 files changed, 28 insertions(+), 12 deletions(-) diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index a270bbd7bbd..bf03cf3fc52 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -1,7 +1,6 @@ package org.testcontainers.cassandra; import com.github.dockerjava.api.command.InspectContainerResponse; -import org.apache.commons.io.IOUtils; import org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate; import org.testcontainers.containers.GenericContainer; import org.testcontainers.ext.ScriptUtils; @@ -9,10 +8,10 @@ import org.testcontainers.utility.DockerImageName; import org.testcontainers.utility.MountableFile; -import java.io.IOException; +import java.io.File; import java.net.InetSocketAddress; +import java.net.URISyntaxException; import java.net.URL; -import java.nio.charset.StandardCharsets; import java.util.Optional; /** @@ -77,11 +76,13 @@ private void runInitScriptIfRequired() { "Could not load classpath init script: " + initScriptPath + ". Resource not found." ); } - String cql = IOUtils.toString(resource, StandardCharsets.UTF_8); - new CassandraDatabaseDelegate(this).execute(cql, initScriptPath, -1, false, false); - } catch (IOException e) { - logger().warn("Could not load classpath init script: {}", initScriptPath); - throw new ScriptLoadException("Could not load classpath init script: " + initScriptPath, e); + // The init script is executed as is by the cqlsh command, so copy it into the container. + String targetInitScriptName = new File(resource.toURI()).getName(); + this.copyFileToContainer(MountableFile.forClasspathResource(initScriptPath), targetInitScriptName); + new CassandraDatabaseDelegate(this).execute(null, targetInitScriptName, -1, false, false); + } catch (URISyntaxException e) { + logger().warn("Could not copy init script into container: {}", initScriptPath); + throw new ScriptLoadException("Could not copy init script into container: " + initScriptPath, e); } catch (ScriptUtils.ScriptStatementFailedException e) { logger().error("Error while executing init script: {}", initScriptPath, e); throw new ScriptUtils.UncategorizedScriptException( diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java index ddd772be7b4..fca33a62b1b 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java @@ -3,6 +3,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.ArrayUtils; +import org.apache.commons.lang3.StringUtils; import org.testcontainers.cassandra.CassandraContainer; import org.testcontainers.containers.Container; import org.testcontainers.containers.ContainerState; @@ -39,22 +40,36 @@ public void execute( try { // Use cqlsh command directly inside the container to execute statements // See documentation here: https://cassandra.apache.org/doc/stable/cassandra/tools/cqlsh.html - String[] cqlshCommand = new String[]{"cqlsh", "-e", statement}; + String[] cqlshCommand = new String[]{"cqlsh"}; if (this.container instanceof CassandraContainer) { CassandraContainer cassandraContainer = ((CassandraContainer) this.container); String username = cassandraContainer.getUsername(); String password = cassandraContainer.getPassword(); - ArrayUtils.addAll(cqlshCommand, "-u", username, "-p", password); + cqlshCommand = ArrayUtils.addAll(cqlshCommand, "-u", username, "-p", password); } + // If no statement specified, directly execute the script specified into scriptPath (using -f argument), + // otherwise execute the given statement (using -e argument). + String executeArg = "-e"; + String executeArgValue = statement; + if (StringUtils.isBlank(statement)) { + executeArg = "-f"; + executeArgValue = scriptPath; + } + cqlshCommand = ArrayUtils.addAll(cqlshCommand, executeArg, executeArgValue); + Container.ExecResult result = this.container.execInContainer(ExecConfig.builder() .command(cqlshCommand) .build()); if (result.getExitCode() == 0) { - log.debug("Statement {} was applied", statement); + if (StringUtils.isBlank(statement)) { + log.info("CQL script {} successfully executed", scriptPath); + } else { + log.info("CQL statement {} was applied", statement); + } } else { - log.error("Statement execution failed with error: \n{}", result.getStderr()); + log.error("CQL script execution failed with error: \n{}", result.getStderr()); throw new ScriptStatementFailedException(statement, lineNumber, scriptPath); } } catch (IOException | InterruptedException e) { From d39cef27166858b879291a264b2dee1148640efa Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Mon, 27 May 2024 07:15:21 +0200 Subject: [PATCH 05/14] Reformat code --- .../org/testcontainers/cassandra/CassandraContainer.java | 1 - .../cassandra/delegate/CassandraDatabaseDelegate.java | 7 +++---- .../cassandra/wait/CassandraQueryWaitStrategy.java | 2 +- .../org/testcontainers/cassandra/CassandraDriver4Test.java | 1 + 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index bf03cf3fc52..d1a28d91414 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -174,5 +174,4 @@ public InetSocketAddress getContactPoint() { public String getLocalDatacenter() { return getEnvMap().getOrDefault("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); } - } diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java index fca33a62b1b..6a7c09e2546 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java @@ -40,7 +40,7 @@ public void execute( try { // Use cqlsh command directly inside the container to execute statements // See documentation here: https://cassandra.apache.org/doc/stable/cassandra/tools/cqlsh.html - String[] cqlshCommand = new String[]{"cqlsh"}; + String[] cqlshCommand = new String[] { "cqlsh" }; if (this.container instanceof CassandraContainer) { CassandraContainer cassandraContainer = ((CassandraContainer) this.container); @@ -59,9 +59,8 @@ public void execute( } cqlshCommand = ArrayUtils.addAll(cqlshCommand, executeArg, executeArgValue); - Container.ExecResult result = this.container.execInContainer(ExecConfig.builder() - .command(cqlshCommand) - .build()); + Container.ExecResult result = + this.container.execInContainer(ExecConfig.builder().command(cqlshCommand).build()); if (result.getExitCode() == 0) { if (StringUtils.isBlank(statement)) { log.info("CQL script {} successfully executed", scriptPath); diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java index 3bcf9be12da..1d1004eb3df 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/wait/CassandraQueryWaitStrategy.java @@ -1,8 +1,8 @@ package org.testcontainers.cassandra.wait; import org.rnorth.ducttape.TimeoutException; -import org.testcontainers.containers.ContainerLaunchException; import org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate; +import org.testcontainers.containers.ContainerLaunchException; import org.testcontainers.containers.wait.strategy.AbstractWaitStrategy; import org.testcontainers.delegate.DatabaseDelegate; diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java index 2edc3837a6e..c453549dd85 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java @@ -14,6 +14,7 @@ public class CassandraDriver4Test { @Rule // container-definition { public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:3.11.2")); + // } @Test From ff8648b9457f9b56c85115bf0f6add26ca2554cb Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Mon, 27 May 2024 20:45:13 +0200 Subject: [PATCH 06/14] Apply changes following code review - revert changes on org.testcontainers.containers package except deprecation annotations - remove unnecessary genericity on new implementation --- docs/modules/databases/cassandra.md | 12 +-- modules/cassandra/build.gradle | 2 +- .../cassandra/CassandraContainer.java | 8 +- .../delegate/CassandraDatabaseDelegate.java | 2 +- .../containers/CassandraContainer.java | 83 +++++++++---------- .../delegate/CassandraDatabaseDelegate.java | 16 ++-- .../cassandra/CassandraContainerTest.java | 20 ++--- .../cassandra/CassandraDriver4Test.java | 2 +- .../cassandra/CassandraServer4Test.java | 2 +- .../cassandra/CassandraServer5Test.java | 2 +- .../containers/CassandraContainerTest.java | 33 ++++---- ...er5Test.java => CassandraDriver3Test.java} | 10 ++- .../containers/CassandraDriver4Test.java | 4 +- .../containers/CassandraServer4Test.java | 2 +- 14 files changed, 93 insertions(+), 105 deletions(-) rename modules/cassandra/src/test/java/org/testcontainers/containers/{CassandraServer5Test.java => CassandraDriver3Test.java} (79%) diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index e6fa39c3c83..aa5388e9a04 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -5,14 +5,14 @@ This example connects to the Cassandra cluster: 1. Define a container: - - [Defining container](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:container-definition - + + [Container definition](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:container-definition + 2. Build a `CqlSession`: - - [Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:cql-session - + + [Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:cql-session + ## Adding this module to your project dependencies diff --git a/modules/cassandra/build.gradle b/modules/cassandra/build.gradle index a3e83c75a2b..b043f5bec92 100644 --- a/modules/cassandra/build.gradle +++ b/modules/cassandra/build.gradle @@ -8,7 +8,7 @@ configurations.all { dependencies { api project(":database-commons") - api "com.datastax.oss:java-driver-core:4.17.0" + api "com.datastax.cassandra:cassandra-driver-core:3.10.0" testImplementation 'com.datastax.oss:java-driver-core:4.17.0' testImplementation 'org.assertj:assertj-core:3.25.3' diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index d1a28d91414..8db326ec4a3 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -21,7 +21,7 @@ *

* Exposed ports: 9042 */ -public class CassandraContainer> extends GenericContainer { +public class CassandraContainer extends GenericContainer { private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("cassandra"); @@ -78,7 +78,7 @@ private void runInitScriptIfRequired() { } // The init script is executed as is by the cqlsh command, so copy it into the container. String targetInitScriptName = new File(resource.toURI()).getName(); - this.copyFileToContainer(MountableFile.forClasspathResource(initScriptPath), targetInitScriptName); + copyFileToContainer(MountableFile.forClasspathResource(initScriptPath), targetInitScriptName); new CassandraDatabaseDelegate(this).execute(null, targetInitScriptName, -1, false, false); } catch (URISyntaxException e) { logger().warn("Could not copy init script into container: {}", initScriptPath); @@ -116,7 +116,7 @@ protected void optionallyMapResourceParameterAsVolume(String pathNameInContainer * * @param configLocation relative classpath with the directory that contains cassandra.yaml and other configuration files */ - public SELF withConfigurationOverride(String configLocation) { + public CassandraContainer withConfigurationOverride(String configLocation) { this.configLocation = configLocation; return self(); } @@ -128,7 +128,7 @@ public SELF withConfigurationOverride(String configLocation) { * * @param initScriptPath relative classpath resource */ - public SELF withInitScript(String initScriptPath) { + public CassandraContainer withInitScript(String initScriptPath) { this.initScriptPath = initScriptPath; return self(); } diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java index 6a7c09e2546..47b92958ea5 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/delegate/CassandraDatabaseDelegate.java @@ -43,7 +43,7 @@ public void execute( String[] cqlshCommand = new String[] { "cqlsh" }; if (this.container instanceof CassandraContainer) { - CassandraContainer cassandraContainer = ((CassandraContainer) this.container); + CassandraContainer cassandraContainer = (CassandraContainer) this.container; String username = cassandraContainer.getUsername(); String password = cassandraContainer.getPassword(); cqlshCommand = ArrayUtils.addAll(cqlshCommand, "-u", username, "-p", password); diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java index 66064e52ca7..0f5c67992c6 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java @@ -1,11 +1,6 @@ package org.testcontainers.containers; -import com.datastax.oss.driver.api.core.CqlSession; -import com.datastax.oss.driver.api.core.CqlSessionBuilder; -import com.datastax.oss.driver.api.core.config.DefaultDriverOption; -import com.datastax.oss.driver.api.core.config.DriverConfigLoader; -import com.datastax.oss.driver.api.core.config.ProgrammaticDriverConfigLoaderBuilder; -import com.datastax.oss.driver.internal.core.loadbalancing.DcInferringLoadBalancingPolicy; +import com.datastax.driver.core.Cluster; import com.github.dockerjava.api.command.InspectContainerResponse; import org.apache.commons.io.IOUtils; import org.testcontainers.containers.delegate.CassandraDatabaseDelegate; @@ -19,7 +14,6 @@ import java.net.InetSocketAddress; import java.net.URL; import java.nio.charset.StandardCharsets; -import java.time.Duration; import java.util.Optional; import javax.script.ScriptException; @@ -57,6 +51,8 @@ public class CassandraContainer> extends G private String initScriptPath; + private boolean enableJmxReporting; + /** * @deprecated use {@link #CassandraContainer(DockerImageName)} instead */ @@ -74,6 +70,7 @@ public CassandraContainer(DockerImageName dockerImageName) { dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); addExposedPort(CQL_PORT); + this.enableJmxReporting = false; withEnv("CASSANDRA_SNITCH", "GossipingPropertyFileSnitch"); withEnv("JVM_OPTS", "-Dcassandra.skip_wait_for_gossip_to_settle=0 -Dcassandra.initial_token=0"); @@ -162,6 +159,14 @@ public SELF withInitScript(String initScriptPath) { return self(); } + /** + * Initialize Cassandra client with JMX reporting enabled or disabled + */ + public SELF withJmxReporting(boolean enableJmxReporting) { + this.enableJmxReporting = enableJmxReporting; + return self(); + } + /** * Get username * @@ -187,50 +192,37 @@ public String getPassword() { } /** - * Get a session on the configured cluster. + * Get configured Cluster + * + * Can be used to obtain connections to Cassandra in the container * - * Can be used to obtain connections to Cassandra in the container. + * @deprecated For Cassandra driver 3.x, use {@link #getHost()} and {@link #getMappedPort(int)} with + * the driver's {@link Cluster#builder() Cluster.Builder} {@code addContactPoint(String)} and + * {@code withPort(int)} methods to create a Cluster object. For Cassandra driver 4.x, use + * {@link #getContactPoint()} and {@link #getLocalDatacenter()} with the driver's {@code CqlSession.builder()} + * {@code addContactPoint(InetSocketAddress)} and {@code withLocalDatacenter(String)} methods to create + * a Session Object. See https://docs.datastax.com/en/developer/java-driver/ for more on the driver. */ - public CqlSession getCqlSession() { - return getCqlSession(this); + @Deprecated + public Cluster getCluster() { + return getCluster(this, enableJmxReporting); } - public static CqlSession getCqlSession(ContainerState containerState) { - final ProgrammaticDriverConfigLoaderBuilder driverConfigLoaderBuilder = DriverConfigLoader.programmaticBuilder(); - boolean dcAvailable = containerState.getClass().isAssignableFrom(CassandraContainer.class); - - // If the ContainerState is not a CassandraContainer instance, use DcInferringLoadBalancingPolicy to not have - // to specify the local datacenter to establish the connection, otherwise we can keep the default load balancing - // policy requiring to explicitly specify the local data center. - // See https://docs.datastax.com/en/developer/java-driver/latest/manual/core/configuration/reference/ for - // further information. - if (!dcAvailable) { - driverConfigLoaderBuilder.withClass( - DefaultDriverOption.LOAD_BALANCING_POLICY_CLASS, - DcInferringLoadBalancingPolicy.class - ); - } - - // Ignore warnings when a CQL script modifies the current keyspace. Typically, this generates unnecessary logs - // when executing an init script using multiple keyspaces. - driverConfigLoaderBuilder.withBoolean(DefaultDriverOption.REQUEST_WARN_IF_SET_KEYSPACE, false); - - // Using Java driver 4.x, a feature called debouncing has been introduced: schema and topology changes received - // from the server could be accumulated before being processed by the driver. For more information, see: - // https://docs.datastax.com/en/developer/java-driver/latest/manual/core/performance/index.html#debouncing - // and https://stackoverflow.com/a/74152732/13292108 - // To maintain good performance, reduce the default values for the schema debouncing properties. - driverConfigLoaderBuilder.withInt(DefaultDriverOption.METADATA_SCHEMA_MAX_EVENTS, 1); - driverConfigLoaderBuilder.withDuration(DefaultDriverOption.METADATA_SCHEMA_WINDOW, Duration.ofMillis(1)); - - final CqlSessionBuilder cqlSessionBuilder = CqlSession + @Deprecated + public static Cluster getCluster(ContainerState containerState, boolean enableJmxReporting) { + final Cluster.Builder builder = Cluster .builder() - .withConfigLoader(driverConfigLoaderBuilder.build()) - .addContactPoint(new InetSocketAddress(containerState.getHost(), containerState.getMappedPort(CQL_PORT))); - if (dcAvailable) { - cqlSessionBuilder.withLocalDatacenter(((CassandraContainer) containerState).getLocalDatacenter()); + .addContactPoint(containerState.getHost()) + .withPort(containerState.getMappedPort(CQL_PORT)); + if (!enableJmxReporting) { + builder.withoutJMXReporting(); } - return cqlSessionBuilder.build(); + return builder.build(); + } + + @Deprecated + public static Cluster getCluster(ContainerState containerState) { + return getCluster(containerState, false); } /** @@ -251,6 +243,7 @@ public String getLocalDatacenter() { return getEnvMap().getOrDefault("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); } + @Deprecated private DatabaseDelegate getDatabaseDelegate() { return new CassandraDatabaseDelegate(this); } diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java index 9edb0669215..33372ca6c78 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java +++ b/modules/cassandra/src/main/java/org/testcontainers/containers/delegate/CassandraDatabaseDelegate.java @@ -1,8 +1,8 @@ package org.testcontainers.containers.delegate; -import com.datastax.oss.driver.api.core.CqlSession; -import com.datastax.oss.driver.api.core.DriverException; -import com.datastax.oss.driver.api.core.cql.ResultSet; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Session; +import com.datastax.driver.core.exceptions.DriverException; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.testcontainers.containers.CassandraContainer; @@ -19,14 +19,14 @@ @Slf4j @RequiredArgsConstructor @Deprecated -public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { +public class CassandraDatabaseDelegate extends AbstractDatabaseDelegate { private final ContainerState container; @Override - protected CqlSession createNewConnection() { + protected Session createNewConnection() { try { - return CassandraContainer.getCqlSession(container); + return CassandraContainer.getCluster(container).newSession(); } catch (DriverException e) { log.error("Could not obtain cassandra connection"); throw new ConnectionCreationException("Could not obtain cassandra connection", e); @@ -54,9 +54,9 @@ public void execute( } @Override - protected void closeConnectionQuietly(CqlSession session) { + protected void closeConnectionQuietly(Session session) { try { - session.close(); + session.getCluster().close(); } catch (Exception e) { log.error("Could not close cassandra connection", e); } diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index becb0b61d82..2d39762e51b 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -24,7 +24,7 @@ public class CassandraContainerTest { @Test public void testSimple() { - try (CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE)) { + try (CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE)) { cassandraContainer.start(); ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); @@ -36,7 +36,7 @@ public void testSimple() { public void testSpecificVersion() { String cassandraVersion = "3.0.15"; try ( - CassandraContainer cassandraContainer = new CassandraContainer<>( + CassandraContainer cassandraContainer = new CassandraContainer( CASSANDRA_IMAGE.withTag(cassandraVersion) ) ) { @@ -50,7 +50,7 @@ public void testSpecificVersion() { @Test public void testConfigurationOverride() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withConfigurationOverride("cassandra-test-configuration-example") ) { cassandraContainer.start(); @@ -65,7 +65,7 @@ public void testConfigurationOverride() { @Test(expected = ContainerLaunchException.class) public void testEmptyConfigurationOverride() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withConfigurationOverride("cassandra-empty-configuration") ) { cassandraContainer.start(); @@ -75,7 +75,7 @@ public void testEmptyConfigurationOverride() { @Test public void testInitScript() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withInitScript("initial.cql") ) { cassandraContainer.start(); @@ -86,7 +86,7 @@ public void testInitScript() { @Test(expected = ContainerLaunchException.class) public void testInitScriptWithError() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withInitScript("initial-with-error.cql") ) { cassandraContainer.start(); @@ -96,7 +96,7 @@ public void testInitScriptWithError() { @Test public void testInitScriptWithLegacyCassandra() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>( + CassandraContainer cassandraContainer = new CassandraContainer( DockerImageName.parse("cassandra:2.2.11") ) .withInitScript("initial.cql") @@ -109,7 +109,7 @@ public void testInitScriptWithLegacyCassandra() { @Test public void testCassandraQueryWaitStrategy() { try ( - CassandraContainer cassandraContainer = new CassandraContainer<>(CASSANDRA_IMAGE) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .waitingFor(new CassandraQueryWaitStrategy()) ) { cassandraContainer.start(); @@ -118,7 +118,7 @@ public void testCassandraQueryWaitStrategy() { } } - private void testInitScript(CassandraContainer cassandraContainer) { + private void testInitScript(CassandraContainer cassandraContainer) { ResultSet resultSet = performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category"); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); Row row = resultSet.one(); @@ -126,7 +126,7 @@ private void testInitScript(CassandraContainer cassandraContainer) { assertThat(row.getString(1)).as("Inserted row is in expected state").isEqualTo("test_category"); } - private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { + private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { final CqlSession cqlSession = CqlSession .builder() .addContactPoint( diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java index c453549dd85..20a0ac78684 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java @@ -13,7 +13,7 @@ public class CassandraDriver4Test { @Rule // container-definition { - public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:3.11.2")); + public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:3.11.2")); // } diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java index 4a8ed9a8440..0b90ac4cd91 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java @@ -12,7 +12,7 @@ public class CassandraServer4Test { @Rule - public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:4.1.1")); + public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:4.1.1")); @Test public void testCassandraGetContactPoint() { diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java index 0e8b947050e..03f1d008f0f 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java @@ -12,7 +12,7 @@ public class CassandraServer5Test { @Rule - public CassandraContainer cassandra = new CassandraContainer<>(DockerImageName.parse("cassandra:5")); + public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:5")); @Test public void testCassandraGetContactPoint() { diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java index ef2469d383d..eb3a8b068ea 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraContainerTest.java @@ -1,15 +1,14 @@ package org.testcontainers.containers; -import com.datastax.oss.driver.api.core.CqlSession; -import com.datastax.oss.driver.api.core.cql.ResultSet; -import com.datastax.oss.driver.api.core.cql.Row; +import com.datastax.driver.core.Cluster; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Row; +import com.datastax.driver.core.Session; import lombok.extern.slf4j.Slf4j; import org.junit.Test; import org.testcontainers.containers.wait.CassandraQueryWaitStrategy; import org.testcontainers.utility.DockerImageName; -import java.net.InetSocketAddress; - import static org.assertj.core.api.Assertions.assertThat; @Slf4j @@ -113,7 +112,7 @@ public void testCassandraQueryWaitStrategy() { public void testCassandraGetCluster() { try (CassandraContainer cassandraContainer = new CassandraContainer<>()) { cassandraContainer.start(); - ResultSet resultSet = performQuery(cassandraContainer.getCqlSession(), BASIC_QUERY); + ResultSet resultSet = performQuery(cassandraContainer.getCluster(), BASIC_QUERY); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); assertThat(resultSet.one().getString(0)).as("Result set has release_version").isNotNull(); } @@ -128,22 +127,18 @@ private void testInitScript(CassandraContainer cassandraContainer) { } private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { - final CqlSession cqlSession = CqlSession + Cluster explicitCluster = Cluster .builder() - .addContactPoint( - new InetSocketAddress( - cassandraContainer.getHost(), - cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT) - ) - ) - .withLocalDatacenter(cassandraContainer.getLocalDatacenter()) + .addContactPoint(cassandraContainer.getHost()) + .withPort(cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT)) .build(); - return performQuery(cqlSession, cql); + return performQuery(explicitCluster, cql); } - private ResultSet performQuery(CqlSession session, String cql) { - final ResultSet rs = session.execute(cql); - session.close(); - return rs; + private ResultSet performQuery(Cluster cluster, String cql) { + try (Cluster closeableCluster = cluster) { + Session session = closeableCluster.newSession(); + return session.execute(cql); + } } } diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java similarity index 79% rename from modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java rename to modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java index 70dd006e8e9..db4c0262da4 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer5Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java @@ -8,28 +8,30 @@ import static org.assertj.core.api.Assertions.assertThat; -public class CassandraServer5Test { +public class CassandraDriver3Test { @Rule - public CassandraContainer cassandra = new CassandraContainer<>("cassandra:5"); + public CassandraContainer cassandra = new CassandraContainer<>("cassandra:3.11.2"); @Test public void testCassandraGetContactPoint() { try ( + // cassandra { CqlSession session = CqlSession .builder() .addContactPoint(this.cassandra.getContactPoint()) .withLocalDatacenter(this.cassandra.getLocalDatacenter()) .build() + // } ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); - assertThat(keyspace).as("test keyspace created").isNotNull(); + assertThat(keyspace).as("keyspace created").isNotNull(); } } } diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java index 79bddcbd043..49224e21eec 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java @@ -16,17 +16,15 @@ public class CassandraDriver4Test { @Test public void testCassandraGetContactPoint() { try ( - // cassandra { CqlSession session = CqlSession .builder() .addContactPoint(this.cassandra.getContactPoint()) .withLocalDatacenter(this.cassandra.getLocalDatacenter()) .build() - // } ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java index 1a8447e7036..affafb5665f 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java @@ -24,7 +24,7 @@ public void testCassandraGetContactPoint() { ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); From 23d98f484c201855cb1070b35a9276a3899d98b3 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Mon, 27 May 2024 20:49:43 +0200 Subject: [PATCH 07/14] Fix tests formatting --- .../testcontainers/cassandra/CassandraContainerTest.java | 8 ++------ .../testcontainers/containers/CassandraDriver3Test.java | 2 +- .../testcontainers/containers/CassandraDriver4Test.java | 2 +- .../testcontainers/containers/CassandraServer4Test.java | 2 +- 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index 2d39762e51b..dff70a842db 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -36,9 +36,7 @@ public void testSimple() { public void testSpecificVersion() { String cassandraVersion = "3.0.15"; try ( - CassandraContainer cassandraContainer = new CassandraContainer( - CASSANDRA_IMAGE.withTag(cassandraVersion) - ) + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE.withTag(cassandraVersion)) ) { cassandraContainer.start(); ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); @@ -96,9 +94,7 @@ public void testInitScriptWithError() { @Test public void testInitScriptWithLegacyCassandra() { try ( - CassandraContainer cassandraContainer = new CassandraContainer( - DockerImageName.parse("cassandra:2.2.11") - ) + CassandraContainer cassandraContainer = new CassandraContainer(DockerImageName.parse("cassandra:2.2.11")) .withInitScript("initial.cql") ) { cassandraContainer.start(); diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java index db4c0262da4..502f2ca8e67 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver3Test.java @@ -26,7 +26,7 @@ public void testCassandraGetContactPoint() { ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java index 49224e21eec..a4fb8c87b8e 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraDriver4Test.java @@ -24,7 +24,7 @@ public void testCassandraGetContactPoint() { ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); diff --git a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java index affafb5665f..1a8447e7036 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/containers/CassandraServer4Test.java @@ -24,7 +24,7 @@ public void testCassandraGetContactPoint() { ) { session.execute( "CREATE KEYSPACE IF NOT EXISTS test WITH replication = \n" + - "{'class':'SimpleStrategy','replication_factor':'1'};" + "{'class':'SimpleStrategy','replication_factor':'1'};" ); KeyspaceMetadata keyspace = session.getMetadata().getKeyspaces().get(CqlIdentifier.fromCql("test")); From a05471474258613417e2a98995ba279ecf2e52bd Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Tue, 28 May 2024 19:45:43 +0200 Subject: [PATCH 08/14] Cleanup the tests following review --- .../cassandra/CassandraContainerTest.java | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index dff70a842db..898c96ea835 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -3,17 +3,13 @@ import com.datastax.oss.driver.api.core.CqlSession; import com.datastax.oss.driver.api.core.cql.ResultSet; import com.datastax.oss.driver.api.core.cql.Row; -import lombok.extern.slf4j.Slf4j; import org.junit.Test; import org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy; import org.testcontainers.containers.ContainerLaunchException; import org.testcontainers.utility.DockerImageName; -import java.net.InetSocketAddress; - import static org.assertj.core.api.Assertions.assertThat; -@Slf4j public class CassandraContainerTest { private static final DockerImageName CASSANDRA_IMAGE = DockerImageName.parse("cassandra:3.11.2"); @@ -125,12 +121,7 @@ private void testInitScript(CassandraContainer cassandraContainer) { private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { final CqlSession cqlSession = CqlSession .builder() - .addContactPoint( - new InetSocketAddress( - cassandraContainer.getHost(), - cassandraContainer.getMappedPort(CassandraContainer.CQL_PORT) - ) - ) + .addContactPoint(cassandraContainer.getContactPoint()) .withLocalDatacenter(cassandraContainer.getLocalDatacenter()) .build(); return performQuery(cqlSession, cql); From 0f1cc35c389ce80fdfed84cd2b1e5aa1c0f4796b Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Wed, 26 Jun 2024 18:09:39 +0200 Subject: [PATCH 09/14] Improve init script documentation and tests when authentication is required --- .../cassandra/CassandraContainer.java | 13 +- .../cassandra/CassandraContainerTest.java | 36 +- .../cassandra.yaml | 1233 +++++++++++++++++ 3 files changed, 1273 insertions(+), 9 deletions(-) create mode 100644 modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index 8db326ec4a3..7558b454c0d 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -25,7 +25,7 @@ public class CassandraContainer extends GenericContainer { private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("cassandra"); - public static final Integer CQL_PORT = 9042; + private static final Integer CQL_PORT = 9042; private static final String DEFAULT_LOCAL_DATACENTER = "datacenter1"; @@ -124,7 +124,16 @@ public CassandraContainer withConfigurationOverride(String configLocation) { /** * Initialize Cassandra with init CQL script *

- * CQL script will be applied after container is started (see using WaitStrategy) + * CQL script will be applied after container is started (see using WaitStrategy). + *

+ *

+ * If you override the Cassandra configuration (see {@link #withConfigurationOverride(String)}) to make the + * authentication mandatory (using {@code PasswordAuthenticator} for the property {@code authenticator}), it's + * strongly recommended to also use the {@link org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy} + * in order to guarantee the init script will be executed once the Cassandra node is really ready to execute + * authenticated queries, otherwise you may encounter an error like this one: + * "AuthenticationFailed('Failed to authenticate to 127.0.0.1: Error from server: code=0100 [Bad credentials]". + *

* * @param initScriptPath relative classpath resource */ diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index 898c96ea835..c57d61706e6 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -1,6 +1,7 @@ package org.testcontainers.cassandra; import com.datastax.oss.driver.api.core.CqlSession; +import com.datastax.oss.driver.api.core.CqlSessionBuilder; import com.datastax.oss.driver.api.core.cql.ResultSet; import com.datastax.oss.driver.api.core.cql.Row; import org.junit.Test; @@ -73,7 +74,20 @@ public void testInitScript() { .withInitScript("initial.cql") ) { cassandraContainer.start(); - testInitScript(cassandraContainer); + testInitScript(cassandraContainer, false); + } + } + + @Test + public void testInitScriptWithRequiredAuthentication() { + try ( + CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) + .withConfigurationOverride("cassandra-auth-required-configuration") + .waitingFor(new CassandraQueryWaitStrategy()) + .withInitScript("initial.cql") + ) { + cassandraContainer.start(); + testInitScript(cassandraContainer, true); } } @@ -94,7 +108,7 @@ public void testInitScriptWithLegacyCassandra() { .withInitScript("initial.cql") ) { cassandraContainer.start(); - testInitScript(cassandraContainer); + testInitScript(cassandraContainer, false); } } @@ -110,8 +124,9 @@ public void testCassandraQueryWaitStrategy() { } } - private void testInitScript(CassandraContainer cassandraContainer) { - ResultSet resultSet = performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category"); + private void testInitScript(CassandraContainer cassandraContainer, boolean withCredentials) { + ResultSet resultSet = + performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category", withCredentials); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); Row row = resultSet.one(); assertThat(row.getLong(0)).as("Inserted row is in expected state").isEqualTo(1); @@ -119,11 +134,18 @@ private void testInitScript(CassandraContainer cassandraContainer) { } private ResultSet performQuery(CassandraContainer cassandraContainer, String cql) { - final CqlSession cqlSession = CqlSession + return performQuery(cassandraContainer, cql, false); + } + + private ResultSet performQuery(CassandraContainer cassandraContainer, String cql, boolean withCredentials) { + final CqlSessionBuilder cqlSessionBuilder = CqlSession .builder() .addContactPoint(cassandraContainer.getContactPoint()) - .withLocalDatacenter(cassandraContainer.getLocalDatacenter()) - .build(); + .withLocalDatacenter(cassandraContainer.getLocalDatacenter()); + if (withCredentials) { + cqlSessionBuilder.withAuthCredentials(cassandraContainer.getUsername(), cassandraContainer.getPassword()); + } + final CqlSession cqlSession = cqlSessionBuilder.build(); return performQuery(cqlSession, cql); } diff --git a/modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml b/modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml new file mode 100644 index 00000000000..14095d4c627 --- /dev/null +++ b/modules/cassandra/src/test/resources/cassandra-auth-required-configuration/cassandra.yaml @@ -0,0 +1,1233 @@ +# Cassandra storage config YAML + +# NOTE: +# See http://wiki.apache.org/cassandra/StorageConfiguration for +# full explanations of configuration directives +# /NOTE + +# The name of the cluster. This is mainly used to prevent machines in +# one logical cluster from joining another. +cluster_name: 'Test Cluster Integration Test' + +# This defines the number of tokens randomly assigned to this node on the ring +# The more tokens, relative to other nodes, the larger the proportion of data +# that this node will store. You probably want all nodes to have the same number +# of tokens assuming they have equal hardware capability. +# +# If you leave this unspecified, Cassandra will use the default of 1 token for legacy compatibility, +# and will use the initial_token as described below. +# +# Specifying initial_token will override this setting on the node's initial start, +# on subsequent starts, this setting will apply even if initial token is set. +# +# If you already have a cluster with 1 token per node, and wish to migrate to +# multiple tokens per node, see http://wiki.apache.org/cassandra/Operations +num_tokens: 256 + +# Triggers automatic allocation of num_tokens tokens for this node. The allocation +# algorithm attempts to choose tokens in a way that optimizes replicated load over +# the nodes in the datacenter for the replication strategy used by the specified +# keyspace. +# +# The load assigned to each node will be close to proportional to its number of +# vnodes. +# +# Only supported with the Murmur3Partitioner. +# allocate_tokens_for_keyspace: KEYSPACE + +# initial_token allows you to specify tokens manually. While you can use it with +# vnodes (num_tokens > 1, above) -- in which case you should provide a +# comma-separated list -- it's primarily used when adding nodes to legacy clusters +# that do not have vnodes enabled. +# initial_token: + +# See http://wiki.apache.org/cassandra/HintedHandoff +# May either be "true" or "false" to enable globally +hinted_handoff_enabled: true + +# When hinted_handoff_enabled is true, a black list of data centers that will not +# perform hinted handoff +# hinted_handoff_disabled_datacenters: +# - DC1 +# - DC2 + +# this defines the maximum amount of time a dead host will have hints +# generated. After it has been dead this long, new hints for it will not be +# created until it has been seen alive and gone down again. +max_hint_window_in_ms: 10800000 # 3 hours + +# Maximum throttle in KBs per second, per delivery thread. This will be +# reduced proportionally to the number of nodes in the cluster. (If there +# are two nodes in the cluster, each delivery thread will use the maximum +# rate; if there are three, each will throttle to half of the maximum, +# since we expect two nodes to be delivering hints simultaneously.) +hinted_handoff_throttle_in_kb: 1024 + +# Number of threads with which to deliver hints; +# Consider increasing this number when you have multi-dc deployments, since +# cross-dc handoff tends to be slower +max_hints_delivery_threads: 2 + +# Directory where Cassandra should store hints. +# If not set, the default directory is $CASSANDRA_HOME/data/hints. +# hints_directory: /var/lib/cassandra/hints + +# How often hints should be flushed from the internal buffers to disk. +# Will *not* trigger fsync. +hints_flush_period_in_ms: 10000 + +# Maximum size for a single hints file, in megabytes. +max_hints_file_size_in_mb: 128 + +# Compression to apply to the hint files. If omitted, hints files +# will be written uncompressed. LZ4, Snappy, and Deflate compressors +# are supported. +#hints_compression: +# - class_name: LZ4Compressor +# parameters: +# - + +# Maximum throttle in KBs per second, total. This will be +# reduced proportionally to the number of nodes in the cluster. +batchlog_replay_throttle_in_kb: 1024 + +# Authentication backend, implementing IAuthenticator; used to identify users +# Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthenticator, +# PasswordAuthenticator}. +# +# - AllowAllAuthenticator performs no checks - set it to disable authentication. +# - PasswordAuthenticator relies on username/password pairs to authenticate +# users. It keeps usernames and hashed passwords in system_auth.roles table. +# Please increase system_auth keyspace replication factor if you use this authenticator. +# If using PasswordAuthenticator, CassandraRoleManager must also be used (see below) +authenticator: PasswordAuthenticator + +# Authorization backend, implementing IAuthorizer; used to limit access/provide permissions +# Out of the box, Cassandra provides org.apache.cassandra.auth.{AllowAllAuthorizer, +# CassandraAuthorizer}. +# +# - AllowAllAuthorizer allows any action to any user - set it to disable authorization. +# - CassandraAuthorizer stores permissions in system_auth.role_permissions table. Please +# increase system_auth keyspace replication factor if you use this authorizer. +authorizer: AllowAllAuthorizer + +# Part of the Authentication & Authorization backend, implementing IRoleManager; used +# to maintain grants and memberships between roles. +# Out of the box, Cassandra provides org.apache.cassandra.auth.CassandraRoleManager, +# which stores role information in the system_auth keyspace. Most functions of the +# IRoleManager require an authenticated login, so unless the configured IAuthenticator +# actually implements authentication, most of this functionality will be unavailable. +# +# - CassandraRoleManager stores role data in the system_auth keyspace. Please +# increase system_auth keyspace replication factor if you use this role manager. +role_manager: CassandraRoleManager + +# Validity period for roles cache (fetching granted roles can be an expensive +# operation depending on the role manager, CassandraRoleManager is one example) +# Granted roles are cached for authenticated sessions in AuthenticatedUser and +# after the period specified here, become eligible for (async) reload. +# Defaults to 2000, set to 0 to disable caching entirely. +# Will be disabled automatically for AllowAllAuthenticator. +roles_validity_in_ms: 2000 + +# Refresh interval for roles cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If roles_validity_in_ms is non-zero, then this must be +# also. +# Defaults to the same value as roles_validity_in_ms. +# roles_update_interval_in_ms: 2000 + +# Validity period for permissions cache (fetching permissions can be an +# expensive operation depending on the authorizer, CassandraAuthorizer is +# one example). Defaults to 2000, set to 0 to disable. +# Will be disabled automatically for AllowAllAuthorizer. +permissions_validity_in_ms: 2000 + +# Refresh interval for permissions cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If permissions_validity_in_ms is non-zero, then this must be +# also. +# Defaults to the same value as permissions_validity_in_ms. +# permissions_update_interval_in_ms: 2000 + +# Validity period for credentials cache. This cache is tightly coupled to +# the provided PasswordAuthenticator implementation of IAuthenticator. If +# another IAuthenticator implementation is configured, this cache will not +# be automatically used and so the following settings will have no effect. +# Please note, credentials are cached in their encrypted form, so while +# activating this cache may reduce the number of queries made to the +# underlying table, it may not bring a significant reduction in the +# latency of individual authentication attempts. +# Defaults to 2000, set to 0 to disable credentials caching. +credentials_validity_in_ms: 2000 + +# Refresh interval for credentials cache (if enabled). +# After this interval, cache entries become eligible for refresh. Upon next +# access, an async reload is scheduled and the old value returned until it +# completes. If credentials_validity_in_ms is non-zero, then this must be +# also. +# Defaults to the same value as credentials_validity_in_ms. +# credentials_update_interval_in_ms: 2000 + +# The partitioner is responsible for distributing groups of rows (by +# partition key) across nodes in the cluster. You should leave this +# alone for new clusters. The partitioner can NOT be changed without +# reloading all data, so when upgrading you should set this to the +# same partitioner you were already using. +# +# Besides Murmur3Partitioner, partitioners included for backwards +# compatibility include RandomPartitioner, ByteOrderedPartitioner, and +# OrderPreservingPartitioner. +# +partitioner: org.apache.cassandra.dht.Murmur3Partitioner + +# Directories where Cassandra should store data on disk. Cassandra +# will spread data evenly across them, subject to the granularity of +# the configured compaction strategy. +# If not set, the default directory is $CASSANDRA_HOME/data/data. +data_file_directories: + - /var/lib/cassandra/data + +# commit log. when running on magnetic HDD, this should be a +# separate spindle than the data directories. +# If not set, the default directory is $CASSANDRA_HOME/data/commitlog. +commitlog_directory: /var/lib/cassandra/commitlog + +# Enable / disable CDC functionality on a per-node basis. This modifies the logic used +# for write path allocation rejection (standard: never reject. cdc: reject Mutation +# containing a CDC-enabled table if at space limit in cdc_raw_directory). +cdc_enabled: false + +# CommitLogSegments are moved to this directory on flush if cdc_enabled: true and the +# segment contains mutations for a CDC-enabled table. This should be placed on a +# separate spindle than the data directories. If not set, the default directory is +# $CASSANDRA_HOME/data/cdc_raw. +# cdc_raw_directory: /var/lib/cassandra/cdc_raw + +# Policy for data disk failures: +# +# die +# shut down gossip and client transports and kill the JVM for any fs errors or +# single-sstable errors, so the node can be replaced. +# +# stop_paranoid +# shut down gossip and client transports even for single-sstable errors, +# kill the JVM for errors during startup. +# +# stop +# shut down gossip and client transports, leaving the node effectively dead, but +# can still be inspected via JMX, kill the JVM for errors during startup. +# +# best_effort +# stop using the failed disk and respond to requests based on +# remaining available sstables. This means you WILL see obsolete +# data at CL.ONE! +# +# ignore +# ignore fatal errors and let requests fail, as in pre-1.2 Cassandra +disk_failure_policy: stop + +# Policy for commit disk failures: +# +# die +# shut down gossip and Thrift and kill the JVM, so the node can be replaced. +# +# stop +# shut down gossip and Thrift, leaving the node effectively dead, but +# can still be inspected via JMX. +# +# stop_commit +# shutdown the commit log, letting writes collect but +# continuing to service reads, as in pre-2.0.5 Cassandra +# +# ignore +# ignore fatal errors and let the batches fail +commit_failure_policy: stop + +# Maximum size of the native protocol prepared statement cache +# +# Valid values are either "auto" (omitting the value) or a value greater 0. +# +# Note that specifying a too large value will result in long running GCs and possbily +# out-of-memory errors. Keep the value at a small fraction of the heap. +# +# If you constantly see "prepared statements discarded in the last minute because +# cache limit reached" messages, the first step is to investigate the root cause +# of these messages and check whether prepared statements are used correctly - +# i.e. use bind markers for variable parts. +# +# Do only change the default value, if you really have more prepared statements than +# fit in the cache. In most cases it is not neccessary to change this value. +# Constantly re-preparing statements is a performance penalty. +# +# Default value ("auto") is 1/256th of the heap or 10MB, whichever is greater +prepared_statements_cache_size_mb: + +# Maximum size of the Thrift prepared statement cache +# +# If you do not use Thrift at all, it is safe to leave this value at "auto". +# +# See description of 'prepared_statements_cache_size_mb' above for more information. +# +# Default value ("auto") is 1/256th of the heap or 10MB, whichever is greater +thrift_prepared_statements_cache_size_mb: + +# Maximum size of the key cache in memory. +# +# Each key cache hit saves 1 seek and each row cache hit saves 2 seeks at the +# minimum, sometimes more. The key cache is fairly tiny for the amount of +# time it saves, so it's worthwhile to use it at large numbers. +# The row cache saves even more time, but must contain the entire row, +# so it is extremely space-intensive. It's best to only use the +# row cache if you have hot rows or static rows. +# +# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup. +# +# Default value is empty to make it "auto" (min(5% of Heap (in MB), 100MB)). Set to 0 to disable key cache. +key_cache_size_in_mb: + +# Duration in seconds after which Cassandra should +# save the key cache. Caches are saved to saved_caches_directory as +# specified in this configuration file. +# +# Saved caches greatly improve cold-start speeds, and is relatively cheap in +# terms of I/O for the key cache. Row cache saving is much more expensive and +# has limited use. +# +# Default is 14400 or 4 hours. +key_cache_save_period: 14400 + +# Number of keys from the key cache to save +# Disabled by default, meaning all keys are going to be saved +# key_cache_keys_to_save: 100 + +# Row cache implementation class name. Available implementations: +# +# org.apache.cassandra.cache.OHCProvider +# Fully off-heap row cache implementation (default). +# +# org.apache.cassandra.cache.SerializingCacheProvider +# This is the row cache implementation availabile +# in previous releases of Cassandra. +# row_cache_class_name: org.apache.cassandra.cache.OHCProvider + +# Maximum size of the row cache in memory. +# Please note that OHC cache implementation requires some additional off-heap memory to manage +# the map structures and some in-flight memory during operations before/after cache entries can be +# accounted against the cache capacity. This overhead is usually small compared to the whole capacity. +# Do not specify more memory that the system can afford in the worst usual situation and leave some +# headroom for OS block level cache. Do never allow your system to swap. +# +# Default value is 0, to disable row caching. +row_cache_size_in_mb: 0 + +# Duration in seconds after which Cassandra should save the row cache. +# Caches are saved to saved_caches_directory as specified in this configuration file. +# +# Saved caches greatly improve cold-start speeds, and is relatively cheap in +# terms of I/O for the key cache. Row cache saving is much more expensive and +# has limited use. +# +# Default is 0 to disable saving the row cache. +row_cache_save_period: 0 + +# Number of keys from the row cache to save. +# Specify 0 (which is the default), meaning all keys are going to be saved +# row_cache_keys_to_save: 100 + +# Maximum size of the counter cache in memory. +# +# Counter cache helps to reduce counter locks' contention for hot counter cells. +# In case of RF = 1 a counter cache hit will cause Cassandra to skip the read before +# write entirely. With RF > 1 a counter cache hit will still help to reduce the duration +# of the lock hold, helping with hot counter cell updates, but will not allow skipping +# the read entirely. Only the local (clock, count) tuple of a counter cell is kept +# in memory, not the whole counter, so it's relatively cheap. +# +# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup. +# +# Default value is empty to make it "auto" (min(2.5% of Heap (in MB), 50MB)). Set to 0 to disable counter cache. +# NOTE: if you perform counter deletes and rely on low gcgs, you should disable the counter cache. +counter_cache_size_in_mb: + +# Duration in seconds after which Cassandra should +# save the counter cache (keys only). Caches are saved to saved_caches_directory as +# specified in this configuration file. +# +# Default is 7200 or 2 hours. +counter_cache_save_period: 7200 + +# Number of keys from the counter cache to save +# Disabled by default, meaning all keys are going to be saved +# counter_cache_keys_to_save: 100 + +# saved caches +# If not set, the default directory is $CASSANDRA_HOME/data/saved_caches. +saved_caches_directory: /var/lib/cassandra/saved_caches + +# commitlog_sync may be either "periodic" or "batch." +# +# When in batch mode, Cassandra won't ack writes until the commit log +# has been fsynced to disk. It will wait +# commitlog_sync_batch_window_in_ms milliseconds between fsyncs. +# This window should be kept short because the writer threads will +# be unable to do extra work while waiting. (You may need to increase +# concurrent_writes for the same reason.) +# +# commitlog_sync: batch +# commitlog_sync_batch_window_in_ms: 2 +# +# the other option is "periodic" where writes may be acked immediately +# and the CommitLog is simply synced every commitlog_sync_period_in_ms +# milliseconds. +commitlog_sync: periodic +commitlog_sync_period_in_ms: 10000 + +# The size of the individual commitlog file segments. A commitlog +# segment may be archived, deleted, or recycled once all the data +# in it (potentially from each columnfamily in the system) has been +# flushed to sstables. +# +# The default size is 32, which is almost always fine, but if you are +# archiving commitlog segments (see commitlog_archiving.properties), +# then you probably want a finer granularity of archiving; 8 or 16 MB +# is reasonable. +# Max mutation size is also configurable via max_mutation_size_in_kb setting in +# cassandra.yaml. The default is half the size commitlog_segment_size_in_mb * 1024. +# This should be positive and less than 2048. +# +# NOTE: If max_mutation_size_in_kb is set explicitly then commitlog_segment_size_in_mb must +# be set to at least twice the size of max_mutation_size_in_kb / 1024 +# +commitlog_segment_size_in_mb: 32 + +# Compression to apply to the commit log. If omitted, the commit log +# will be written uncompressed. LZ4, Snappy, and Deflate compressors +# are supported. +# commitlog_compression: +# - class_name: LZ4Compressor +# parameters: +# - + +# any class that implements the SeedProvider interface and has a +# constructor that takes a Map of parameters will do. +seed_provider: + # Addresses of hosts that are deemed contact points. + # Cassandra nodes use this list of hosts to find each other and learn + # the topology of the ring. You must change this if you are running + # multiple nodes! + - class_name: org.apache.cassandra.locator.SimpleSeedProvider + parameters: + # seeds is actually a comma-delimited list of addresses. + # Ex: ",," + - seeds: "172.17.0.2" + +# For workloads with more data than can fit in memory, Cassandra's +# bottleneck will be reads that need to fetch data from +# disk. "concurrent_reads" should be set to (16 * number_of_drives) in +# order to allow the operations to enqueue low enough in the stack +# that the OS and drives can reorder them. Same applies to +# "concurrent_counter_writes", since counter writes read the current +# values before incrementing and writing them back. +# +# On the other hand, since writes are almost never IO bound, the ideal +# number of "concurrent_writes" is dependent on the number of cores in +# your system; (8 * number_of_cores) is a good rule of thumb. +concurrent_reads: 32 +concurrent_writes: 32 +concurrent_counter_writes: 32 + +# For materialized view writes, as there is a read involved, so this should +# be limited by the less of concurrent reads or concurrent writes. +concurrent_materialized_view_writes: 32 + +# Maximum memory to use for sstable chunk cache and buffer pooling. +# 32MB of this are reserved for pooling buffers, the rest is used as an +# cache that holds uncompressed sstable chunks. +# Defaults to the smaller of 1/4 of heap or 512MB. This pool is allocated off-heap, +# so is in addition to the memory allocated for heap. The cache also has on-heap +# overhead which is roughly 128 bytes per chunk (i.e. 0.2% of the reserved size +# if the default 64k chunk size is used). +# Memory is only allocated when needed. +# file_cache_size_in_mb: 512 + +# Flag indicating whether to allocate on or off heap when the sstable buffer +# pool is exhausted, that is when it has exceeded the maximum memory +# file_cache_size_in_mb, beyond which it will not cache buffers but allocate on request. + +# buffer_pool_use_heap_if_exhausted: true + +# The strategy for optimizing disk read +# Possible values are: +# ssd (for solid state disks, the default) +# spinning (for spinning disks) +# disk_optimization_strategy: ssd + +# Total permitted memory to use for memtables. Cassandra will stop +# accepting writes when the limit is exceeded until a flush completes, +# and will trigger a flush based on memtable_cleanup_threshold +# If omitted, Cassandra will set both to 1/4 the size of the heap. +# memtable_heap_space_in_mb: 2048 +# memtable_offheap_space_in_mb: 2048 + +# memtable_cleanup_threshold is deprecated. The default calculation +# is the only reasonable choice. See the comments on memtable_flush_writers +# for more information. +# +# Ratio of occupied non-flushing memtable size to total permitted size +# that will trigger a flush of the largest memtable. Larger mct will +# mean larger flushes and hence less compaction, but also less concurrent +# flush activity which can make it difficult to keep your disks fed +# under heavy write load. +# +# memtable_cleanup_threshold defaults to 1 / (memtable_flush_writers + 1) +# memtable_cleanup_threshold: 0.11 + +# Specify the way Cassandra allocates and manages memtable memory. +# Options are: +# +# heap_buffers +# on heap nio buffers +# +# offheap_buffers +# off heap (direct) nio buffers +# +# offheap_objects +# off heap objects +memtable_allocation_type: heap_buffers + +# Total space to use for commit logs on disk. +# +# If space gets above this value, Cassandra will flush every dirty CF +# in the oldest segment and remove it. So a small total commitlog space +# will tend to cause more flush activity on less-active columnfamilies. +# +# The default value is the smaller of 8192, and 1/4 of the total space +# of the commitlog volume. +# +# commitlog_total_space_in_mb: 8192 + +# This sets the number of memtable flush writer threads per disk +# as well as the total number of memtables that can be flushed concurrently. +# These are generally a combination of compute and IO bound. +# +# Memtable flushing is more CPU efficient than memtable ingest and a single thread +# can keep up with the ingest rate of a whole server on a single fast disk +# until it temporarily becomes IO bound under contention typically with compaction. +# At that point you need multiple flush threads. At some point in the future +# it may become CPU bound all the time. +# +# You can tell if flushing is falling behind using the MemtablePool.BlockedOnAllocation +# metric which should be 0, but will be non-zero if threads are blocked waiting on flushing +# to free memory. +# +# memtable_flush_writers defaults to two for a single data directory. +# This means that two memtables can be flushed concurrently to the single data directory. +# If you have multiple data directories the default is one memtable flushing at a time +# but the flush will use a thread per data directory so you will get two or more writers. +# +# Two is generally enough to flush on a fast disk [array] mounted as a single data directory. +# Adding more flush writers will result in smaller more frequent flushes that introduce more +# compaction overhead. +# +# There is a direct tradeoff between number of memtables that can be flushed concurrently +# and flush size and frequency. More is not better you just need enough flush writers +# to never stall waiting for flushing to free memory. +# +#memtable_flush_writers: 2 + +# Total space to use for change-data-capture logs on disk. +# +# If space gets above this value, Cassandra will throw WriteTimeoutException +# on Mutations including tables with CDC enabled. A CDCCompactor is responsible +# for parsing the raw CDC logs and deleting them when parsing is completed. +# +# The default value is the min of 4096 mb and 1/8th of the total space +# of the drive where cdc_raw_directory resides. +# cdc_total_space_in_mb: 4096 + +# When we hit our cdc_raw limit and the CDCCompactor is either running behind +# or experiencing backpressure, we check at the following interval to see if any +# new space for cdc-tracked tables has been made available. Default to 250ms +# cdc_free_space_check_interval_ms: 250 + +# A fixed memory pool size in MB for for SSTable index summaries. If left +# empty, this will default to 5% of the heap size. If the memory usage of +# all index summaries exceeds this limit, SSTables with low read rates will +# shrink their index summaries in order to meet this limit. However, this +# is a best-effort process. In extreme conditions Cassandra may need to use +# more than this amount of memory. +index_summary_capacity_in_mb: + +# How frequently index summaries should be resampled. This is done +# periodically to redistribute memory from the fixed-size pool to sstables +# proportional their recent read rates. Setting to -1 will disable this +# process, leaving existing index summaries at their current sampling level. +index_summary_resize_interval_in_minutes: 60 + +# Whether to, when doing sequential writing, fsync() at intervals in +# order to force the operating system to flush the dirty +# buffers. Enable this to avoid sudden dirty buffer flushing from +# impacting read latencies. Almost always a good idea on SSDs; not +# necessarily on platters. +trickle_fsync: false +trickle_fsync_interval_in_kb: 10240 + +# TCP port, for commands and data +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +storage_port: 7000 + +# SSL port, for encrypted communication. Unused unless enabled in +# encryption_options +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +ssl_storage_port: 7001 + +# Address or interface to bind to and tell other Cassandra nodes to connect to. +# You _must_ change this if you want multiple nodes to be able to communicate! +# +# Set listen_address OR listen_interface, not both. +# +# Leaving it blank leaves it up to InetAddress.getLocalHost(). This +# will always do the Right Thing _if_ the node is properly configured +# (hostname, name resolution, etc), and the Right Thing is to use the +# address associated with the hostname (it might not be). +# +# Setting listen_address to 0.0.0.0 is always wrong. +# +listen_address: 172.17.0.2 + +# Set listen_address OR listen_interface, not both. Interfaces must correspond +# to a single address, IP aliasing is not supported. +# listen_interface: eth0 + +# If you choose to specify the interface by name and the interface has an ipv4 and an ipv6 address +# you can specify which should be chosen using listen_interface_prefer_ipv6. If false the first ipv4 +# address will be used. If true the first ipv6 address will be used. Defaults to false preferring +# ipv4. If there is only one address it will be selected regardless of ipv4/ipv6. +# listen_interface_prefer_ipv6: false + +# Address to broadcast to other Cassandra nodes +# Leaving this blank will set it to the same value as listen_address +broadcast_address: 172.17.0.2 + +# When using multiple physical network interfaces, set this +# to true to listen on broadcast_address in addition to +# the listen_address, allowing nodes to communicate in both +# interfaces. +# Ignore this property if the network configuration automatically +# routes between the public and private networks such as EC2. +# listen_on_broadcast_address: false + +# Internode authentication backend, implementing IInternodeAuthenticator; +# used to allow/disallow connections from peer nodes. +# internode_authenticator: org.apache.cassandra.auth.AllowAllInternodeAuthenticator + +# Whether to start the native transport server. +# Please note that the address on which the native transport is bound is the +# same as the rpc_address. The port however is different and specified below. +start_native_transport: true +# port for the CQL native transport to listen for clients on +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +native_transport_port: 9042 +# Enabling native transport encryption in client_encryption_options allows you to either use +# encryption for the standard port or to use a dedicated, additional port along with the unencrypted +# standard native_transport_port. +# Enabling client encryption and keeping native_transport_port_ssl disabled will use encryption +# for native_transport_port. Setting native_transport_port_ssl to a different value +# from native_transport_port will use encryption for native_transport_port_ssl while +# keeping native_transport_port unencrypted. +# native_transport_port_ssl: 9142 +# The maximum threads for handling requests when the native transport is used. +# This is similar to rpc_max_threads though the default differs slightly (and +# there is no native_transport_min_threads, idle threads will always be stopped +# after 30 seconds). +# native_transport_max_threads: 128 +# +# The maximum size of allowed frame. Frame (requests) larger than this will +# be rejected as invalid. The default is 256MB. If you're changing this parameter, +# you may want to adjust max_value_size_in_mb accordingly. This should be positive and less than 2048. +# native_transport_max_frame_size_in_mb: 256 + +# The maximum number of concurrent client connections. +# The default is -1, which means unlimited. +# native_transport_max_concurrent_connections: -1 + +# The maximum number of concurrent client connections per source ip. +# The default is -1, which means unlimited. +# native_transport_max_concurrent_connections_per_ip: -1 + +# Whether to start the thrift rpc server. +start_rpc: false + +# The address or interface to bind the Thrift RPC service and native transport +# server to. +# +# Set rpc_address OR rpc_interface, not both. +# +# Leaving rpc_address blank has the same effect as on listen_address +# (i.e. it will be based on the configured hostname of the node). +# +# Note that unlike listen_address, you can specify 0.0.0.0, but you must also +# set broadcast_rpc_address to a value other than 0.0.0.0. +# +# For security reasons, you should not expose this port to the internet. Firewall it if needed. +rpc_address: 0.0.0.0 + +# Set rpc_address OR rpc_interface, not both. Interfaces must correspond +# to a single address, IP aliasing is not supported. +# rpc_interface: eth1 + +# If you choose to specify the interface by name and the interface has an ipv4 and an ipv6 address +# you can specify which should be chosen using rpc_interface_prefer_ipv6. If false the first ipv4 +# address will be used. If true the first ipv6 address will be used. Defaults to false preferring +# ipv4. If there is only one address it will be selected regardless of ipv4/ipv6. +# rpc_interface_prefer_ipv6: false + +# port for Thrift to listen for clients on +rpc_port: 9160 + +# RPC address to broadcast to drivers and other Cassandra nodes. This cannot +# be set to 0.0.0.0. If left blank, this will be set to the value of +# rpc_address. If rpc_address is set to 0.0.0.0, broadcast_rpc_address must +# be set. +broadcast_rpc_address: 172.17.0.2 + +# enable or disable keepalive on rpc/native connections +rpc_keepalive: true + +# Cassandra provides two out-of-the-box options for the RPC Server: +# +# sync +# One thread per thrift connection. For a very large number of clients, memory +# will be your limiting factor. On a 64 bit JVM, 180KB is the minimum stack size +# per thread, and that will correspond to your use of virtual memory (but physical memory +# may be limited depending on use of stack space). +# +# hsha +# Stands for "half synchronous, half asynchronous." All thrift clients are handled +# asynchronously using a small number of threads that does not vary with the amount +# of thrift clients (and thus scales well to many clients). The rpc requests are still +# synchronous (one thread per active request). If hsha is selected then it is essential +# that rpc_max_threads is changed from the default value of unlimited. +# +# The default is sync because on Windows hsha is about 30% slower. On Linux, +# sync/hsha performance is about the same, with hsha of course using less memory. +# +# Alternatively, can provide your own RPC server by providing the fully-qualified class name +# of an o.a.c.t.TServerFactory that can create an instance of it. +rpc_server_type: sync + +# Uncomment rpc_min|max_thread to set request pool size limits. +# +# Regardless of your choice of RPC server (see above), the number of maximum requests in the +# RPC thread pool dictates how many concurrent requests are possible (but if you are using the sync +# RPC server, it also dictates the number of clients that can be connected at all). +# +# The default is unlimited and thus provides no protection against clients overwhelming the server. You are +# encouraged to set a maximum that makes sense for you in production, but do keep in mind that +# rpc_max_threads represents the maximum number of client requests this server may execute concurrently. +# +# rpc_min_threads: 16 +# rpc_max_threads: 2048 + +# uncomment to set socket buffer sizes on rpc connections +# rpc_send_buff_size_in_bytes: +# rpc_recv_buff_size_in_bytes: + +# Uncomment to set socket buffer size for internode communication +# Note that when setting this, the buffer size is limited by net.core.wmem_max +# and when not setting it it is defined by net.ipv4.tcp_wmem +# See also: +# /proc/sys/net/core/wmem_max +# /proc/sys/net/core/rmem_max +# /proc/sys/net/ipv4/tcp_wmem +# /proc/sys/net/ipv4/tcp_wmem +# and 'man tcp' +# internode_send_buff_size_in_bytes: + +# Uncomment to set socket buffer size for internode communication +# Note that when setting this, the buffer size is limited by net.core.wmem_max +# and when not setting it it is defined by net.ipv4.tcp_wmem +# internode_recv_buff_size_in_bytes: + +# Frame size for thrift (maximum message length). +thrift_framed_transport_size_in_mb: 15 + +# Set to true to have Cassandra create a hard link to each sstable +# flushed or streamed locally in a backups/ subdirectory of the +# keyspace data. Removing these links is the operator's +# responsibility. +incremental_backups: false + +# Whether or not to take a snapshot before each compaction. Be +# careful using this option, since Cassandra won't clean up the +# snapshots for you. Mostly useful if you're paranoid when there +# is a data format change. +snapshot_before_compaction: false + +# Whether or not a snapshot is taken of the data before keyspace truncation +# or dropping of column families. The STRONGLY advised default of true +# should be used to provide data safety. If you set this flag to false, you will +# lose data on truncation or drop. +auto_snapshot: true + +# Granularity of the collation index of rows within a partition. +# Increase if your rows are large, or if you have a very large +# number of rows per partition. The competing goals are these: +# +# - a smaller granularity means more index entries are generated +# and looking up rows withing the partition by collation column +# is faster +# - but, Cassandra will keep the collation index in memory for hot +# rows (as part of the key cache), so a larger granularity means +# you can cache more hot rows +column_index_size_in_kb: 64 + +# Per sstable indexed key cache entries (the collation index in memory +# mentioned above) exceeding this size will not be held on heap. +# This means that only partition information is held on heap and the +# index entries are read from disk. +# +# Note that this size refers to the size of the +# serialized index information and not the size of the partition. +column_index_cache_size_in_kb: 2 + +# Number of simultaneous compactions to allow, NOT including +# validation "compactions" for anti-entropy repair. Simultaneous +# compactions can help preserve read performance in a mixed read/write +# workload, by mitigating the tendency of small sstables to accumulate +# during a single long running compactions. The default is usually +# fine and if you experience problems with compaction running too +# slowly or too fast, you should look at +# compaction_throughput_mb_per_sec first. +# +# concurrent_compactors defaults to the smaller of (number of disks, +# number of cores), with a minimum of 2 and a maximum of 8. +# +# If your data directories are backed by SSD, you should increase this +# to the number of cores. +#concurrent_compactors: 1 + +# Throttles compaction to the given total throughput across the entire +# system. The faster you insert data, the faster you need to compact in +# order to keep the sstable count down, but in general, setting this to +# 16 to 32 times the rate you are inserting data is more than sufficient. +# Setting this to 0 disables throttling. Note that this account for all types +# of compaction, including validation compaction. +compaction_throughput_mb_per_sec: 16 + +# When compacting, the replacement sstable(s) can be opened before they +# are completely written, and used in place of the prior sstables for +# any range that has been written. This helps to smoothly transfer reads +# between the sstables, reducing page cache churn and keeping hot rows hot +sstable_preemptive_open_interval_in_mb: 50 + +# Throttles all outbound streaming file transfers on this node to the +# given total throughput in Mbps. This is necessary because Cassandra does +# mostly sequential IO when streaming data during bootstrap or repair, which +# can lead to saturating the network connection and degrading rpc performance. +# When unset, the default is 200 Mbps or 25 MB/s. +# stream_throughput_outbound_megabits_per_sec: 200 + +# Throttles all streaming file transfer between the datacenters, +# this setting allows users to throttle inter dc stream throughput in addition +# to throttling all network stream traffic as configured with +# stream_throughput_outbound_megabits_per_sec +# When unset, the default is 200 Mbps or 25 MB/s +# inter_dc_stream_throughput_outbound_megabits_per_sec: 200 + +# How long the coordinator should wait for read operations to complete +read_request_timeout_in_ms: 5000 +# How long the coordinator should wait for seq or index scans to complete +range_request_timeout_in_ms: 10000 +# How long the coordinator should wait for writes to complete +write_request_timeout_in_ms: 2000 +# How long the coordinator should wait for counter writes to complete +counter_write_request_timeout_in_ms: 5000 +# How long a coordinator should continue to retry a CAS operation +# that contends with other proposals for the same row +cas_contention_timeout_in_ms: 1000 +# How long the coordinator should wait for truncates to complete +# (This can be much longer, because unless auto_snapshot is disabled +# we need to flush first so we can snapshot before removing the data.) +truncate_request_timeout_in_ms: 60000 +# The default timeout for other, miscellaneous operations +request_timeout_in_ms: 10000 + +# How long before a node logs slow queries. Select queries that take longer than +# this timeout to execute, will generate an aggregated log message, so that slow queries +# can be identified. Set this value to zero to disable slow query logging. +slow_query_log_timeout_in_ms: 500 + +# Enable operation timeout information exchange between nodes to accurately +# measure request timeouts. If disabled, replicas will assume that requests +# were forwarded to them instantly by the coordinator, which means that +# under overload conditions we will waste that much extra time processing +# already-timed-out requests. +# +# Warning: before enabling this property make sure to ntp is installed +# and the times are synchronized between the nodes. +cross_node_timeout: false + +# Set keep-alive period for streaming +# This node will send a keep-alive message periodically with this period. +# If the node does not receive a keep-alive message from the peer for +# 2 keep-alive cycles the stream session times out and fail +# Default value is 300s (5 minutes), which means stalled stream +# times out in 10 minutes by default +# streaming_keep_alive_period_in_secs: 300 + +# phi value that must be reached for a host to be marked down. +# most users should never need to adjust this. +# phi_convict_threshold: 8 + +# endpoint_snitch -- Set this to a class that implements +# IEndpointSnitch. The snitch has two functions: +# +# - it teaches Cassandra enough about your network topology to route +# requests efficiently +# - it allows Cassandra to spread replicas around your cluster to avoid +# correlated failures. It does this by grouping machines into +# "datacenters" and "racks." Cassandra will do its best not to have +# more than one replica on the same "rack" (which may not actually +# be a physical location) +# +# CASSANDRA WILL NOT ALLOW YOU TO SWITCH TO AN INCOMPATIBLE SNITCH +# ONCE DATA IS INSERTED INTO THE CLUSTER. This would cause data loss. +# This means that if you start with the default SimpleSnitch, which +# locates every node on "rack1" in "datacenter1", your only options +# if you need to add another datacenter are GossipingPropertyFileSnitch +# (and the older PFS). From there, if you want to migrate to an +# incompatible snitch like Ec2Snitch you can do it by adding new nodes +# under Ec2Snitch (which will locate them in a new "datacenter") and +# decommissioning the old ones. +# +# Out of the box, Cassandra provides: +# +# SimpleSnitch: +# Treats Strategy order as proximity. This can improve cache +# locality when disabling read repair. Only appropriate for +# single-datacenter deployments. +# +# GossipingPropertyFileSnitch +# This should be your go-to snitch for production use. The rack +# and datacenter for the local node are defined in +# cassandra-rackdc.properties and propagated to other nodes via +# gossip. If cassandra-topology.properties exists, it is used as a +# fallback, allowing migration from the PropertyFileSnitch. +# +# PropertyFileSnitch: +# Proximity is determined by rack and data center, which are +# explicitly configured in cassandra-topology.properties. +# +# Ec2Snitch: +# Appropriate for EC2 deployments in a single Region. Loads Region +# and Availability Zone information from the EC2 API. The Region is +# treated as the datacenter, and the Availability Zone as the rack. +# Only private IPs are used, so this will not work across multiple +# Regions. +# +# Ec2MultiRegionSnitch: +# Uses public IPs as broadcast_address to allow cross-region +# connectivity. (Thus, you should set seed addresses to the public +# IP as well.) You will need to open the storage_port or +# ssl_storage_port on the public IP firewall. (For intra-Region +# traffic, Cassandra will switch to the private IP after +# establishing a connection.) +# +# RackInferringSnitch: +# Proximity is determined by rack and data center, which are +# assumed to correspond to the 3rd and 2nd octet of each node's IP +# address, respectively. Unless this happens to match your +# deployment conventions, this is best used as an example of +# writing a custom Snitch class and is provided in that spirit. +# +# You can use a custom Snitch by setting this to the full class name +# of the snitch, which will be assumed to be on your classpath. +endpoint_snitch: SimpleSnitch + +# controls how often to perform the more expensive part of host score +# calculation +dynamic_snitch_update_interval_in_ms: 100 +# controls how often to reset all host scores, allowing a bad host to +# possibly recover +dynamic_snitch_reset_interval_in_ms: 600000 +# if set greater than zero and read_repair_chance is < 1.0, this will allow +# 'pinning' of replicas to hosts in order to increase cache capacity. +# The badness threshold will control how much worse the pinned host has to be +# before the dynamic snitch will prefer other replicas over it. This is +# expressed as a double which represents a percentage. Thus, a value of +# 0.2 means Cassandra would continue to prefer the static snitch values +# until the pinned host was 20% worse than the fastest. +dynamic_snitch_badness_threshold: 0.1 + +# request_scheduler -- Set this to a class that implements +# RequestScheduler, which will schedule incoming client requests +# according to the specific policy. This is useful for multi-tenancy +# with a single Cassandra cluster. +# NOTE: This is specifically for requests from the client and does +# not affect inter node communication. +# org.apache.cassandra.scheduler.NoScheduler - No scheduling takes place +# org.apache.cassandra.scheduler.RoundRobinScheduler - Round robin of +# client requests to a node with a separate queue for each +# request_scheduler_id. The scheduler is further customized by +# request_scheduler_options as described below. +request_scheduler: org.apache.cassandra.scheduler.NoScheduler + +# Scheduler Options vary based on the type of scheduler +# +# NoScheduler +# Has no options +# +# RoundRobin +# throttle_limit +# The throttle_limit is the number of in-flight +# requests per client. Requests beyond +# that limit are queued up until +# running requests can complete. +# The value of 80 here is twice the number of +# concurrent_reads + concurrent_writes. +# default_weight +# default_weight is optional and allows for +# overriding the default which is 1. +# weights +# Weights are optional and will default to 1 or the +# overridden default_weight. The weight translates into how +# many requests are handled during each turn of the +# RoundRobin, based on the scheduler id. +# +# request_scheduler_options: +# throttle_limit: 80 +# default_weight: 5 +# weights: +# Keyspace1: 1 +# Keyspace2: 5 + +# request_scheduler_id -- An identifier based on which to perform +# the request scheduling. Currently the only valid option is keyspace. +# request_scheduler_id: keyspace + +# Enable or disable inter-node encryption +# JVM defaults for supported SSL socket protocols and cipher suites can +# be replaced using custom encryption options. This is not recommended +# unless you have policies in place that dictate certain settings, or +# need to disable vulnerable ciphers or protocols in case the JVM cannot +# be updated. +# FIPS compliant settings can be configured at JVM level and should not +# involve changing encryption settings here: +# https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/FIPS.html +# *NOTE* No custom encryption options are enabled at the moment +# The available internode options are : all, none, dc, rack +# +# If set to dc cassandra will encrypt the traffic between the DCs +# If set to rack cassandra will encrypt the traffic between the racks +# +# The passwords used in these options must match the passwords used when generating +# the keystore and truststore. For instructions on generating these files, see: +# http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore +# +server_encryption_options: + internode_encryption: none + keystore: conf/.keystore + keystore_password: cassandra + truststore: conf/.truststore + truststore_password: cassandra + # More advanced defaults below: + # protocol: TLS + # algorithm: SunX509 + # store_type: JKS + # cipher_suites: [TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA] + # require_client_auth: false + # require_endpoint_verification: false + +# enable or disable client/server encryption. +client_encryption_options: + enabled: false + # If enabled and optional is set to true encrypted and unencrypted connections are handled. + optional: false + keystore: conf/.keystore + keystore_password: cassandra + # require_client_auth: false + # Set trustore and truststore_password if require_client_auth is true + # truststore: conf/.truststore + # truststore_password: cassandra + # More advanced defaults below: + # protocol: TLS + # algorithm: SunX509 + # store_type: JKS + # cipher_suites: [TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_DHE_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA] + +# internode_compression controls whether traffic between nodes is +# compressed. +# Can be: +# +# all +# all traffic is compressed +# +# dc +# traffic between different datacenters is compressed +# +# none +# nothing is compressed. +internode_compression: dc + +# Enable or disable tcp_nodelay for inter-dc communication. +# Disabling it will result in larger (but fewer) network packets being sent, +# reducing overhead from the TCP protocol itself, at the cost of increasing +# latency if you block for cross-datacenter responses. +inter_dc_tcp_nodelay: false + +# TTL for different trace types used during logging of the repair process. +tracetype_query_ttl: 86400 +tracetype_repair_ttl: 604800 + +# By default, Cassandra logs GC Pauses greater than 200 ms at INFO level +# This threshold can be adjusted to minimize logging if necessary +# gc_log_threshold_in_ms: 200 + +# If unset, all GC Pauses greater than gc_log_threshold_in_ms will log at +# INFO level +# UDFs (user defined functions) are disabled by default. +# As of Cassandra 3.0 there is a sandbox in place that should prevent execution of evil code. +enable_user_defined_functions: false + +# Enables scripted UDFs (JavaScript UDFs). +# Java UDFs are always enabled, if enable_user_defined_functions is true. +# Enable this option to be able to use UDFs with "language javascript" or any custom JSR-223 provider. +# This option has no effect, if enable_user_defined_functions is false. +enable_scripted_user_defined_functions: false + +# The default Windows kernel timer and scheduling resolution is 15.6ms for power conservation. +# Lowering this value on Windows can provide much tighter latency and better throughput, however +# some virtualized environments may see a negative performance impact from changing this setting +# below their system default. The sysinternals 'clockres' tool can confirm your system's default +# setting. +windows_timer_interval: 1 + + +# Enables encrypting data at-rest (on disk). Different key providers can be plugged in, but the default reads from +# a JCE-style keystore. A single keystore can hold multiple keys, but the one referenced by +# the "key_alias" is the only key that will be used for encrypt opertaions; previously used keys +# can still (and should!) be in the keystore and will be used on decrypt operations +# (to handle the case of key rotation). +# +# It is strongly recommended to download and install Java Cryptography Extension (JCE) +# Unlimited Strength Jurisdiction Policy Files for your version of the JDK. +# (current link: http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) +# +# Currently, only the following file types are supported for transparent data encryption, although +# more are coming in future cassandra releases: commitlog, hints +transparent_data_encryption_options: + enabled: false + chunk_length_kb: 64 + cipher: AES/CBC/PKCS5Padding + key_alias: testing:1 + # CBC IV length for AES needs to be 16 bytes (which is also the default size) + # iv_length: 16 + key_provider: + - class_name: org.apache.cassandra.security.JKSKeyProvider + parameters: + - keystore: conf/.keystore + keystore_password: cassandra + store_type: JCEKS + key_password: cassandra + + +##################### +# SAFETY THRESHOLDS # +##################### + +# When executing a scan, within or across a partition, we need to keep the +# tombstones seen in memory so we can return them to the coordinator, which +# will use them to make sure other replicas also know about the deleted rows. +# With workloads that generate a lot of tombstones, this can cause performance +# problems and even exaust the server heap. +# (http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets) +# Adjust the thresholds here if you understand the dangers and want to +# scan more tombstones anyway. These thresholds may also be adjusted at runtime +# using the StorageService mbean. +tombstone_warn_threshold: 1000 +tombstone_failure_threshold: 100000 + +# Log WARN on any multiple-partition batch size exceeding this value. 5kb per batch by default. +# Caution should be taken on increasing the size of this threshold as it can lead to node instability. +batch_size_warn_threshold_in_kb: 5 + +# Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. +batch_size_fail_threshold_in_kb: 50 + +# Log WARN on any batches not of type LOGGED than span across more partitions than this limit +unlogged_batch_across_partitions_warn_threshold: 10 + +# Log a warning when compacting partitions larger than this value +compaction_large_partition_warning_threshold_mb: 100 + +# GC Pauses greater than gc_warn_threshold_in_ms will be logged at WARN level +# Adjust the threshold based on your application throughput requirement +# By default, Cassandra logs GC Pauses greater than 200 ms at INFO level +gc_warn_threshold_in_ms: 1000 + +# Maximum size of any value in SSTables. Safety measure to detect SSTable corruption +# early. Any value size larger than this threshold will result into marking an SSTable +# as corrupted. This should be positive and less than 2048. +# max_value_size_in_mb: 256 + +# Back-pressure settings # +# If enabled, the coordinator will apply the back-pressure strategy specified below to each mutation +# sent to replicas, with the aim of reducing pressure on overloaded replicas. +back_pressure_enabled: false +# The back-pressure strategy applied. +# The default implementation, RateBasedBackPressure, takes three arguments: +# high ratio, factor, and flow type, and uses the ratio between incoming mutation responses and outgoing mutation requests. +# If below high ratio, outgoing mutations are rate limited according to the incoming rate decreased by the given factor; +# if above high ratio, the rate limiting is increased by the given factor; +# such factor is usually best configured between 1 and 10, use larger values for a faster recovery +# at the expense of potentially more dropped mutations; +# the rate limiting is applied according to the flow type: if FAST, it's rate limited at the speed of the fastest replica, +# if SLOW at the speed of the slowest one. +# New strategies can be added. Implementors need to implement org.apache.cassandra.net.BackpressureStrategy and +# provide a public constructor accepting a Map. +back_pressure_strategy: + - class_name: org.apache.cassandra.net.RateBasedBackPressure + parameters: + - high_ratio: 0.90 + factor: 5 + flow: FAST + +# Coalescing Strategies # +# Coalescing multiples messages turns out to significantly boost message processing throughput (think doubling or more). +# On bare metal, the floor for packet processing throughput is high enough that many applications won't notice, but in +# virtualized environments, the point at which an application can be bound by network packet processing can be +# surprisingly low compared to the throughput of task processing that is possible inside a VM. It's not that bare metal +# doesn't benefit from coalescing messages, it's that the number of packets a bare metal network interface can process +# is sufficient for many applications such that no load starvation is experienced even without coalescing. +# There are other benefits to coalescing network messages that are harder to isolate with a simple metric like messages +# per second. By coalescing multiple tasks together, a network thread can process multiple messages for the cost of one +# trip to read from a socket, and all the task submission work can be done at the same time reducing context switching +# and increasing cache friendliness of network message processing. +# See CASSANDRA-8692 for details. + +# Strategy to use for coalescing messages in OutboundTcpConnection. +# Can be fixed, movingaverage, timehorizon, disabled (default). +# You can also specify a subclass of CoalescingStrategies.CoalescingStrategy by name. +# otc_coalescing_strategy: DISABLED + +# How many microseconds to wait for coalescing. For fixed strategy this is the amount of time after the first +# message is received before it will be sent with any accompanying messages. For moving average this is the +# maximum amount of time that will be waited as well as the interval at which messages must arrive on average +# for coalescing to be enabled. +# otc_coalescing_window_us: 200 + +# Do not try to coalesce messages if we already got that many messages. This should be more than 2 and less than 128. +# otc_coalescing_enough_coalesced_messages: 8 + +# How many milliseconds to wait between two expiration runs on the backlog (queue) of the OutboundTcpConnection. +# Expiration is done if messages are piling up in the backlog. Droppable messages are expired to free the memory +# taken by expired messages. The interval should be between 0 and 1000, and in most installations the default value +# will be appropriate. A smaller value could potentially expire messages slightly sooner at the expense of more CPU +# time and queue contention while iterating the backlog of messages. +# An interval of 0 disables any wait time, which is the behavior of former Cassandra versions. +# +# otc_backlog_expiration_interval_ms: 200 From cd0e35f0d695b0e80192926b47b2032b23fc5d52 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Thu, 4 Jul 2024 21:24:02 +0200 Subject: [PATCH 10/14] Improve documentation and do some refactoring --- docs/modules/databases/cassandra.md | 16 ++++++++++ .../cassandra/CassandraContainer.java | 30 ++++--------------- .../cassandra/CassandraContainerTest.java | 2 ++ 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index aa5388e9a04..509ce0f2de7 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -14,6 +14,22 @@ This example connects to the Cassandra cluster: [Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:cql-session +!!!hint + If you override the Cassandra configuration (using `CassandraContainer.withConfigurationOverride(String)`) to make + the authentication mandatory (using `PasswordAuthenticator` for the property `authenticator`), it's strongly + recommended to also use the `org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy` in order to guarantee + the init script will be executed once the Cassandra node is really ready to execute authenticated queries, otherwise + you may encounter an error like this one: + ``` + AuthenticationFailed('Failed to authenticate to x.x.x.x: Error from server: code=0100 [Bad credentials] + ``` + + For example, assuming your custom `cassandra.yaml` configuration is located in a directory `cassandra-auth-required-configuration`: + + + [Running init script with required authentication](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java) inside_block:init-with-auth + + ## Adding this module to your project dependencies Add the following dependency to your `pom.xml`/`build.gradle` file: diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index 7558b454c0d..75473952ede 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -55,7 +55,12 @@ public CassandraContainer(DockerImageName dockerImageName) { @Override protected void configure() { - optionallyMapResourceParameterAsVolume(CONTAINER_CONFIG_LOCATION, configLocation); + // Map (effectively replace) directory in Docker with the content of resourceLocation if resource location is + // not null. + Optional + .ofNullable(configLocation) + .map(MountableFile::forClasspathResource) + .ifPresent(mountableFile -> withCopyFileToContainer(mountableFile, CONTAINER_CONFIG_LOCATION)); } @Override @@ -93,21 +98,6 @@ private void runInitScriptIfRequired() { } } - /** - * Map (effectively replace) directory in Docker with the content of resourceLocation if resource location is not null - * - * Protected to allow for changing implementation by extending the class - * - * @param pathNameInContainer path in docker - * @param resourceLocation relative classpath to resource - */ - protected void optionallyMapResourceParameterAsVolume(String pathNameInContainer, String resourceLocation) { - Optional - .ofNullable(resourceLocation) - .map(MountableFile::forClasspathResource) - .ifPresent(mountableFile -> withCopyFileToContainer(mountableFile, pathNameInContainer)); - } - /** * Initialize Cassandra with the custom overridden Cassandra configuration *

@@ -126,14 +116,6 @@ public CassandraContainer withConfigurationOverride(String configLocation) { *

* CQL script will be applied after container is started (see using WaitStrategy). *

- *

- * If you override the Cassandra configuration (see {@link #withConfigurationOverride(String)}) to make the - * authentication mandatory (using {@code PasswordAuthenticator} for the property {@code authenticator}), it's - * strongly recommended to also use the {@link org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy} - * in order to guarantee the init script will be executed once the Cassandra node is really ready to execute - * authenticated queries, otherwise you may encounter an error like this one: - * "AuthenticationFailed('Failed to authenticate to 127.0.0.1: Error from server: code=0100 [Bad credentials]". - *

* * @param initScriptPath relative classpath resource */ diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index c57d61706e6..ae374ae9942 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -81,10 +81,12 @@ public void testInitScript() { @Test public void testInitScriptWithRequiredAuthentication() { try ( + // init-with-auth { CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withConfigurationOverride("cassandra-auth-required-configuration") .waitingFor(new CassandraQueryWaitStrategy()) .withInitScript("initial.cql") + // } ) { cassandraContainer.start(); testInitScript(cassandraContainer, true); From 01790ae9c7fbbbf7bf82076b8beb6c6b419fa886 Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora <48218208+maximevw@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:39:40 +0200 Subject: [PATCH 11/14] Update modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Eddú Meléndez Gonzales --- .../java/org/testcontainers/cassandra/CassandraContainer.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index 75473952ede..1c9ac591df4 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -38,7 +38,9 @@ public class CassandraContainer extends GenericContainer { private String configLocation; private String initScriptPath; - + public CassandraContainer(String dockerImageName) { + this(DockerImageName.parse(dockerImageName); + } public CassandraContainer(DockerImageName dockerImageName) { super(dockerImageName); dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); From ebeffab9e83f209402bb332a19431b2a72a05bfe Mon Sep 17 00:00:00 2001 From: Maxime Wiewiora Date: Tue, 13 Aug 2024 18:18:21 +0200 Subject: [PATCH 12/14] Set CassandraQueryWaitStrategy by default --- docs/modules/databases/cassandra.md | 6 ++--- .../cassandra/CassandraContainer.java | 8 ++++++- .../cassandra/CassandraContainerTest.java | 22 +++++-------------- .../cassandra/CassandraDriver4Test.java | 3 +-- .../cassandra/CassandraServer4Test.java | 3 +-- .../cassandra/CassandraServer5Test.java | 3 +-- 6 files changed, 18 insertions(+), 27 deletions(-) diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index 509ce0f2de7..921b4a89fd8 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -17,9 +17,9 @@ This example connects to the Cassandra cluster: !!!hint If you override the Cassandra configuration (using `CassandraContainer.withConfigurationOverride(String)`) to make the authentication mandatory (using `PasswordAuthenticator` for the property `authenticator`), it's strongly - recommended to also use the `org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy` in order to guarantee - the init script will be executed once the Cassandra node is really ready to execute authenticated queries, otherwise - you may encounter an error like this one: + recommended to keep the default waiting strategy (`org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy`) + in order to guarantee the init script will be executed once the Cassandra node is really ready to execute + authenticated queries, otherwise you may encounter an error like this one: ``` AuthenticationFailed('Failed to authenticate to x.x.x.x: Error from server: code=0100 [Bad credentials] ``` diff --git a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java index 1c9ac591df4..f8fc5d58dbb 100644 --- a/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java +++ b/modules/cassandra/src/main/java/org/testcontainers/cassandra/CassandraContainer.java @@ -2,6 +2,7 @@ import com.github.dockerjava.api.command.InspectContainerResponse; import org.testcontainers.cassandra.delegate.CassandraDatabaseDelegate; +import org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy; import org.testcontainers.containers.GenericContainer; import org.testcontainers.ext.ScriptUtils; import org.testcontainers.ext.ScriptUtils.ScriptLoadException; @@ -38,9 +39,11 @@ public class CassandraContainer extends GenericContainer { private String configLocation; private String initScriptPath; + public CassandraContainer(String dockerImageName) { - this(DockerImageName.parse(dockerImageName); + this(DockerImageName.parse(dockerImageName)); } + public CassandraContainer(DockerImageName dockerImageName) { super(dockerImageName); dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME); @@ -53,6 +56,9 @@ public CassandraContainer(DockerImageName dockerImageName) { withEnv("MAX_HEAP_SIZE", "1024M"); withEnv("CASSANDRA_ENDPOINT_SNITCH", "GossipingPropertyFileSnitch"); withEnv("CASSANDRA_DC", DEFAULT_LOCAL_DATACENTER); + + // Use the CassandraQueryWaitStrategy by default to avoid potential issues when the authentication is enabled. + waitingFor(new CassandraQueryWaitStrategy()); } @Override diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index ae374ae9942..03257e6a27c 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -5,7 +5,6 @@ import com.datastax.oss.driver.api.core.cql.ResultSet; import com.datastax.oss.driver.api.core.cql.Row; import org.junit.Test; -import org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy; import org.testcontainers.containers.ContainerLaunchException; import org.testcontainers.utility.DockerImageName; @@ -13,7 +12,7 @@ public class CassandraContainerTest { - private static final DockerImageName CASSANDRA_IMAGE = DockerImageName.parse("cassandra:3.11.2"); + private static final String CASSANDRA_IMAGE = "cassandra:3.11.2"; private static final String TEST_CLUSTER_NAME_IN_CONF = "Test Cluster Integration Test"; @@ -33,7 +32,9 @@ public void testSimple() { public void testSpecificVersion() { String cassandraVersion = "3.0.15"; try ( - CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE.withTag(cassandraVersion)) + CassandraContainer cassandraContainer = new CassandraContainer( + DockerImageName.parse("cassandra").withTag(cassandraVersion) + ) ) { cassandraContainer.start(); ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); @@ -84,7 +85,6 @@ public void testInitScriptWithRequiredAuthentication() { // init-with-auth { CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) .withConfigurationOverride("cassandra-auth-required-configuration") - .waitingFor(new CassandraQueryWaitStrategy()) .withInitScript("initial.cql") // } ) { @@ -106,7 +106,7 @@ public void testInitScriptWithError() { @Test public void testInitScriptWithLegacyCassandra() { try ( - CassandraContainer cassandraContainer = new CassandraContainer(DockerImageName.parse("cassandra:2.2.11")) + CassandraContainer cassandraContainer = new CassandraContainer("cassandra:2.2.11") .withInitScript("initial.cql") ) { cassandraContainer.start(); @@ -114,18 +114,6 @@ public void testInitScriptWithLegacyCassandra() { } } - @Test - public void testCassandraQueryWaitStrategy() { - try ( - CassandraContainer cassandraContainer = new CassandraContainer(CASSANDRA_IMAGE) - .waitingFor(new CassandraQueryWaitStrategy()) - ) { - cassandraContainer.start(); - ResultSet resultSet = performQuery(cassandraContainer, BASIC_QUERY); - assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); - } - } - private void testInitScript(CassandraContainer cassandraContainer, boolean withCredentials) { ResultSet resultSet = performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category", withCredentials); diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java index 20a0ac78684..5e1b682e878 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java @@ -5,7 +5,6 @@ import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; import org.junit.Rule; import org.junit.Test; -import org.testcontainers.utility.DockerImageName; import static org.assertj.core.api.Assertions.assertThat; @@ -13,7 +12,7 @@ public class CassandraDriver4Test { @Rule // container-definition { - public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:3.11.2")); + public CassandraContainer cassandra = new CassandraContainer("cassandra:3.11.2"); // } diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java index 0b90ac4cd91..b509a77e9e8 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer4Test.java @@ -5,14 +5,13 @@ import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; import org.junit.Rule; import org.junit.Test; -import org.testcontainers.utility.DockerImageName; import static org.assertj.core.api.Assertions.assertThat; public class CassandraServer4Test { @Rule - public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:4.1.1")); + public CassandraContainer cassandra = new CassandraContainer("cassandra:4.1.1"); @Test public void testCassandraGetContactPoint() { diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java index 03f1d008f0f..d4e1c858382 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraServer5Test.java @@ -5,14 +5,13 @@ import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata; import org.junit.Rule; import org.junit.Test; -import org.testcontainers.utility.DockerImageName; import static org.assertj.core.api.Assertions.assertThat; public class CassandraServer5Test { @Rule - public CassandraContainer cassandra = new CassandraContainer(DockerImageName.parse("cassandra:5")); + public CassandraContainer cassandra = new CassandraContainer("cassandra:5"); @Test public void testCassandraGetContactPoint() { From e5db72d27571c0e20d31a817fe6ad06d794613da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez=20Gonzales?= Date: Tue, 13 Aug 2024 13:17:05 -0500 Subject: [PATCH 13/14] Update docs/modules/databases/cassandra.md --- docs/modules/databases/cassandra.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/modules/databases/cassandra.md b/docs/modules/databases/cassandra.md index 921b4a89fd8..72213dad4a7 100644 --- a/docs/modules/databases/cassandra.md +++ b/docs/modules/databases/cassandra.md @@ -14,17 +14,7 @@ This example connects to the Cassandra cluster: [Building CqlSession](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraDriver4Test.java) inside_block:cql-session -!!!hint - If you override the Cassandra configuration (using `CassandraContainer.withConfigurationOverride(String)`) to make - the authentication mandatory (using `PasswordAuthenticator` for the property `authenticator`), it's strongly - recommended to keep the default waiting strategy (`org.testcontainers.cassandra.wait.CassandraQueryWaitStrategy`) - in order to guarantee the init script will be executed once the Cassandra node is really ready to execute - authenticated queries, otherwise you may encounter an error like this one: - ``` - AuthenticationFailed('Failed to authenticate to x.x.x.x: Error from server: code=0100 [Bad credentials] - ``` - - For example, assuming your custom `cassandra.yaml` configuration is located in a directory `cassandra-auth-required-configuration`: +3. Define a container with custom `cassandra.yaml` located in a directory `cassandra-auth-required-configuration`: [Running init script with required authentication](../../../modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java) inside_block:init-with-auth From 2314621c6e3bdd3e3c840b8285c7d85092f042cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Tue, 13 Aug 2024 12:18:45 -0600 Subject: [PATCH 14/14] Fix format --- .../testcontainers/cassandra/CassandraContainerTest.java | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java index 03257e6a27c..4bf776b96c8 100644 --- a/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java +++ b/modules/cassandra/src/test/java/org/testcontainers/cassandra/CassandraContainerTest.java @@ -115,8 +115,11 @@ public void testInitScriptWithLegacyCassandra() { } private void testInitScript(CassandraContainer cassandraContainer, boolean withCredentials) { - ResultSet resultSet = - performQuery(cassandraContainer, "SELECT * FROM keySpaceTest.catalog_category", withCredentials); + ResultSet resultSet = performQuery( + cassandraContainer, + "SELECT * FROM keySpaceTest.catalog_category", + withCredentials + ); assertThat(resultSet.wasApplied()).as("Query was applied").isTrue(); Row row = resultSet.one(); assertThat(row.getLong(0)).as("Inserted row is in expected state").isEqualTo(1);