Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sangupta/dry-run

Mocked classes for unit testing
https://github.com/sangupta/dry-run

Last synced: 4 days ago
JSON representation

Mocked classes for unit testing

Awesome Lists containing this project

README

        

# dryrun

[![Build Status](https://travis-ci.org/sangupta/dryrun.svg?branch=master)](https://travis-ci.org/sangupta/dryrun)
[![Coverage Status](https://coveralls.io/repos/github/sangupta/dryrun/badge.svg?branch=master)](https://coveralls.io/github/sangupta/dryrun?branch=master)
[![Maven Version](https://maven-badges.herokuapp.com/maven-central/com.sangupta/dryrun/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.sangupta/dryrun)

**dryrun** is a collection of already-mocked classes that aid in during unit-testing of Java code.

For example unit testing code with `RedisTemplate` usually involves spinning a Redis instance.
Our `DryRunRedisTemplate` uses the `Dry-Redis` framework to connect to an in-memory Redis, that
connects uses pure Java method calls than running in an in-process server.

## Features

* Mocked implementation to `RedisTemplate` using `MockJedis`. Following are supported:
* Value operations
* List operations
* Set operations except `sscan`
* Mocked implementation to `GridFSTemplate` using in-memory storage.

## Examples

### RedisTemplate

To test code that uses `RedisTemplate` as a service, just inject the mocked template as:

```java
// create a DryRedis instance
DryRedis dryRedis = DryRedis.getDatabase("testdb");

// create an instance of RedisTemplate
RedisTemplate template = new DryRunRedisTemplate(dryRedis);

// must specify the key and value serializers
template.setKeySerializer(new StringRedisSerializer());
template.setValueSerializer(new StringRedisSerializer());

// inject in your service for unit testing
MyTestableService service = new DefaultMyTestableServiceImpl();
service.setRedisTemplate(redisTemplate);
```

### GridFSTemplate

```java
// create a new in-memory GridFSTemplate
GridFSTemplate template = new DryRunGridFSTemplate("myBucket");

// start using it
template.store(stream, "myfile.txt");
```

## Dependencies

The library depends on the following external libraries to accomplish its goal:

* Dry-Redis: in-memory Redis clone

The library is tested on the following JDK versions:

* Oracle JDK 8
* Oracle JDK 7
* Open JDK 7

## Downloads

The library can be downloaded from Maven Central using:

```xml

com.sangupta
dryrun
0.1.0

```

## Release Notes

**Development Snapshot**

* Partial RedisTemplate methods
* RedisTemplate.opsForValue() implemented completely

## Semantic Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility,
`dryrun` will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the follow format:

`..`

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
* Bug fixes and misc changes bump the patch

For more information on SemVer, please visit http://semver.org/.

## License

```
dryrun - Mocked classes for unit testing
Copyright (c) 2016-2017, Sandeep Gupta

https://sangupta.com/projects/dryrun

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```