50onred / mock-jedis Goto Github PK

Mock Jedis is a library for mocking out Jedis clients

License: MIT License

Java 100.00%

mock-jedis's Introduction

Mock Jedis

Mock Jedis is a library for mocking out Jedis clients. It's useful for testing your code without actually having a live redis server up. Currently, mock-jedis supports pipelining and all the basic Jedis commands, but if you find missing functionality you're welcome to submit a pull request.

Compile

with gradle (preferred method):

gradle build

Adding mock-jedis to your project

Add it as a dependency to your project.

Here's a sample gradle script that will pull mock-jedis 0.4.0 from maven-central

buildscript {
    repositories {
        mavenCentral()
    }
}

apply plugin: 'java'

dependencies {
  testCompile 'com.fiftyonred:mock-jedis:0.4.0'
}

Sample maven dependency definition:

<dependency>
    <groupId>com.fiftyonred</groupId>
    <artifactId>mock-jedis</artifactId>
    <version>0.4.0</version>
    <type>jar</type>
    <scope>test</scope>
</dependency>

Using mock-jedis

Jedis j = new MockJedis("test");
j.set("test", "123");
assertEquals("123", j.get("test"));

Supported Commands

Currently the following commands are supported by mock-jedis

KEYS: DEL DUMP EXISTS EXPIRE EXPIREAT KEYS PERSIST PEXPIRE PEXPIREAT PTTL RANDOMKEY RENAME RENAMENX RESTORE TTL TYPE
STRINGS: APPEND DECR DECRBY GET GETSET INCR INCRBY INCRBYFLOAT MGET MSET MSETNX PSETEX SET SETEX SETNX STRLEN
HASHES: HDEL HEXISTS HGET HGETALL HINCRBY HINCRBYFLOAT HKEYS HLEN HMGET HMSET HSET HSETNX HVALS
LISTS: LLEN LPOP LPUSH
SETS: SADD SCARD SDIFF SDIFFSTORE SINTER SINTERSTORE SISMEMBER SMEMBERS SMOVE SPOP SRANDMEMBER SREM SUNION SUNIONSTORE
CONNECTIONS: ECHO PING SELECT QUIT
SERVER: DBSIZE FLUSHALL FLUSHDB
PIPELINES

Unsupported Things

All commands not listed above

mock-jedis's People

Contributors

Stargazers

Watchers

mock-jedis's Issues

can you support rpush?

Getting a connection refused error currently when I try to call rpush because it is using the inherited method, which is trying to connect to the real thing. In general, it would be nice to override every method and make it do nothing as a default.

I'll fork and send a push request for this.

could you add zset support?

could you add zset support

Expiration support

Hi!

First, thank you for this project, really good idea.

Sadly it's not suitable for us because of expriration support.

Why it's not implemented? I mean, it's so because of some technical troubles or it's just not implemented yet?

Thanks!

lpush actually does an rpush

A test such as the following one fails. When retrieving the elements with lrange, they come out in reverse order.

    @Test
    public void lpushShouldPushToTheFrontOfAList() {

        // given
        MockJedis jedis = new MockJedis("localhost");
        jedis.lpush("list", "c");
        jedis.lpush("list", "b");
        jedis.lpush("list", "a");

        // when
        List<String> list = jedis.lrange("list", 0, -1);

        // then
        assertThat(list, is(asList("a", "b", "c")));
    }

I guess the root of the bug is in com.fiftyonred.mock_jedis.MockStorage#lpush where values are added via Collections.addAll.

Redundant host argument in MockJedis

Why MockJedis constructor has host argument?
You can set Jedis host argument to default value, "test" for example and add MockJedis() default constructor.

Add to official Maven repo

http://search.maven.org/#search|ga|1|mock%2Djedis

Document supported and unsupported Redis commands

Could we list supported and unsupported commands in the README? It's useful to know, for example, that lists are not yet supported, but hashes are.

unsupported method should throw UnsupportedOperationException

If you use a mehtod wich is not supported you got unexpected behaviour. It would be better is an UnsupportedOperationException would be thown in such case.

Is mock-jedis thread safe?

I'm currently using a real Redis database in my unit tests, and I'm curious if I could used mock-jedis instead.

My unit tests run multiple threads against the real Redis database--if I used mock-jedis instead, would that work?

Support for SCAN

Is there any work in progress to support SCAN?

NPE when renaming a set

When I rename a set and then try to access the new set, I get a NullPointerException. Here's a reproduction of the problem using Groovy shell, but I get the same problem using plain-old Java 1.7.

groovy:000> m.sadd('s', 'alpha'); ===> 1 groovy:000> m.sadd('s', 'beta'); ===> 1 groovy:000> m.smembers('s'); ===> [beta, alpha] groovy:000> m.rename('s','s2'); ===> OK groovy:000> m.smembers('s'); ===> [] groovy:000> m.smembers('s2'); ERROR java.lang.NullPointerException: null at com.fiftyonred.mock_jedis.MockPipeline.smembers (MockPipeline.java:1516) at com.fiftyonred.mock_jedis.MockJedis.smembers (MockJedis.java:655) at redis.clients.jedis.JedisCommands$smembers.call (Unknown Source) at groovysh_evaluate.run (groovysh_evaluate:3) ...

Throws a NullPointerException on key not found.

redis.get("foo") throws a NullPointerException, unless I've put something at that key already.
Seems a more accurate mock of the Jedis API would be to return null in that case.

Feature request: Mock Server failures

An interesting test case would be test failure behavior.
This could be a flag passed into the constructor which throws JedisException for all API calls like get(), set(). A bit of more enhancement on top of this feature would be to have the possibility of failure on a random percentage.
This feature would make mock-jedis attain perfection 👍

mock-jedis in central maven repo could not running in JDK6

Current mock-jedis in central maven repo is compiled with JDK7. This prevents others using it in JDK 6 environment. Could you please help to fix it? Thanks very much.

hget refering to an non-existing field throws NullPointerException

in MockPipeline#hget(String key, String field)
you should account for the fact that hashStorage.get(key).get(field) can be null.
This is the case if the hash is defined but has no field with name field.

Fix:

if (hashStorage.containsKey(key)) {
Map<String, String> hash = hashStorage.get(key);
if (hash.containsKey(field)) {
response.set(hash.get(field).getBytes());
} else {
response.set(null); //important, otherwise we'll get an exception when retrieving the value
}
}

MockJedisPool not working for scala

Exception:
redis.clients.jedis.exceptions.JedisException: Could not return the resource to the pool
[info] at redis.clients.util.Pool.returnResourceObject(Pool.java:65)
[info] at org.sedis.Pool.withJedisClient(sedis.scala:105)
[info] at com.remarkmedia.dragon.service.infrastructure.oauth2.OauthClient$.validate(OauthClient.scala:39)
[info] at com.remarkmedia.dragon.service.infrastructure.oauth2.OauthClientSpec$$anonfun$1$$anonfun$apply$mcV$sp$1.apply$mcV$sp(OauthClientSpec.scala:23)
[info] at com.remarkmedia.dragon.service.infrastructure.oauth2.OauthClientSpec$$anonfun$1$$anonfun$apply$mcV$sp$1.apply(OauthClientSpec.scala:23)
[info] at com.remarkmedia.dragon.service.infrastructure.oauth2.OauthClientSpec$$anonfun$1$$anonfun$apply$mcV$sp$1.apply(OauthClientSpec.scala:23)

Code:
val jedisPool = new MockJedisPool(new JedisPoolConfig(), "localhost")
implicit val sedisPool = new Pool(jedisPool)

SRP ( spullara Redis Protocol) as alternative?

https://github.com/spullara/redis-protocol/blob/master/netty4-server/src/main/java/redis/server/netty/SimpleRedisServer.java

Today i found this. Please have a look, maybe you will find it usable for your requirements.