cassandra-spy's Introduction

Cassandra Spy

Test error cases in code that uses Cassandra.

Features

CassandraSpy is a library that helps you:

Start embedded Cassandra
Throw exceptions for certain queries so you can test how your application handles them
Query embedded Cassandra

Exceptions are triggered in Cassandra server so your application code does not need to be changed and does not need to use mocks.

Cassandra-Spy is implemented as a JUnit rule but can also be used in other contexts like Cucumber scenarios.

Usage

public class IntegrationTest {
    
    @ClassRule
    public static CassandraSpy cassandra = new CassandraSpy();
    
    @Before
    public void initApp() {
        String host = cassandra.getHost();
        int port = cassandra.getPort(); // started on random port
        // init app with host and port
    }
    
    @Test
    public void testInsertFails() throws Exception {
        cassandra.when(inserts("users")).willThrow(writeTimeout());
        
        app.addUser(1, "user"); // does an insert
        
        // assert app does the right thing
    }
    
    @Test
    public void testSelectFails() throws Exception {
        cassandra.when(selects("users")).willThrow(readTimeout());
        
        app.getUser(1); // does a select
        
        // assert app does the right thing
    }
    
    @Test
    public void testInsertWithValuesFails() throws Exception {
        cassandra.when(inserts("users", 2, "user2")).willThrow(writeTimeout());
        
        app.addUser(1, "user"); // will not fail
        app.addUser(2, "user2"); // will fail
        // ...
    }
}

Also see the tests for an example with more details.

Download

https://jitpack.io/#org.andrejs/cassandra-spy

    repositories {
        maven { url 'https://jitpack.io' }
    }
    
    dependencies {
        compile 'org.andrejs:cassandra-spy:{version}'
    }