asarkar / cassandra-unit-spring

cassandra-unit-spring

Starts the Cassandra server and makes the ports available as Spring Boot environment properties.

Requires Java 8 or later. Uses cassandra-unit and Spring Boot.

Installation

You can find the latest version on Maven Central.

Usage

You will need to add a test runtime dependency on org.cassandraunit:cassandra-unit. If using Gradle, it can be done with testRuntimeOnly("org.cassandraunit:cassandra-unit:$someVersion").

The only thing you need is the AutoConfigureCassandraUnit annotation:

@SpringBootTest
@AutoConfigureCassandraUnit(config = EmbeddedCassandraServerHelper.CASSANDRA_RNDPORT_YML_FILE)
public class AutoConfigureWithRandomPortsTest {
    @Value("${cassandra-unit.native-transport-port:-1}")
    private int nativeTransportPort = -1;

    @Value("${cassandra-unit.rpc-port:-1}")
    private int rpcPort = -1;

    @Test
    public void testUseRandomPorts() {
        Assertions.assertEquals(EmbeddedCassandraServerHelper.getNativeTransportPort(), nativeTransportPort);
        Assertions.assertEquals(EmbeddedCassandraServerHelper.getRpcPort(), rpcPort);
    }
}

See KDoc for more details.

This library aims to be minimal and manages only the lifecycle of the Cassandra server during testing; it does not run initialization scripts or clean the database between tests, because you can do those things yourself.

ℹ️ If you use Spring Data, you can set spring.data.cassandra.port=${cassandra-unit.rpc-port:-1} property in src/test/application.properties or @SpringBootTest.properties attribute.

ℹ️ cassandra-unit can only run one Cassandra instance per JVM; thus, if AutoConfigureCassandraUnit annotation is present on more than one test classes, only the first one is used, the others are ignored. That means the port properties will not change once a Cassandra instance is started.

⚠️ If you abort a test or run two tests both of which start the server, you may be faced with a FileAlreadyExistsException. That is because of this bug. If using Maven, clean goal will delete the temporary directory; if using Gradle, you can either delete the target directory manually, or add it to the Gradle clean task.

⚠️ cassandra-unit doesn't work with Java 11; see this bug.

⚠️ cassandra-unit doesn't work with Java 17; see this bug.

Contribute

This project is a volunteer effort. You are welcome to send pull requests, ask questions, or create issues. If you like it, you can help by spreading the word and "Starring" the GitHub repo!

License

Copyright 2022 Abhijit Sarkar - Released under Apache License v2.0.