An in-memory Ruby Riak driver for testing and machines without Riak.
Ruby JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets/js
gemfiles
lib
spec
.gitignore
.rspec
Appraisals
Gemfile
LICENSE
README.md
Rakefile
fakeriak.gemspec

README.md

fakeriak

An in-memory driver implementation of the Riak API. This is designed to be used in test environments to remove the external dependency of a running Riak server.

Features

The following Riak features are supported:

  • Server Info
  • Basic stats
  • Object lookups
  • Pre-2.0 counters
  • Bucket / Bucket Type props
  • List keys / buckets
  • Map/Reduce with Javascript
  • Secondary indexes
  • Search indexes / schemas
  • CRDTs

The following Riak features are currently not implemented:

  • Search queries with Solr
  • Map/Reduce with Erlang

The following Riak features are deprecated in Riak 1.x, removed in Riak 2.x, and therefore will not be supported:

  • Luwak file storage
  • Link walking

Usage

On Riak 1.x:

riak = Riak::Client.new(:nodes => ["127.0.0.1"], :protobuffs_backend => :Memory, :http_backend => :Memory)

On Riak 2.x:

riak = Riak::Client.new(:nodes => ["127.0.0.1"], :protobuffs_backend => :Memory)

To reset all the data:

riak.buckets.each do |bucket|
  bucket.keys.each {|key| bucket.delete(key)}
end

Within RSpec:

Typically this gem is used within specs in order to avoid external dependencies when running the spec suite. In order to ensure that the data is reset in each spec, you'll need to explicitly do so as part of a before or after hook in the spec helper. For example:

$riak = Riak::Client.new(:nodes => ["127.0.0.1"], :protobuffs_backend => :Memory)

RSpec.configure do |config|
  # ...

  config.before(:each) do
    $riak.buckets.each do |bucket|
      bucket.keys.each {|key| bucket.delete(key)}
    end
  end
end

Notes

Server data

One important note that is that data will be shared across servers that are configured in the same client. For example, support you configured your client like so:

riak = Riak::Client.new(:nodes => ["10.0.0.1", "10.0.0.2"], :protobuffs_backend => :Memory)

This would force data to be consistent across both the 10.0.0.1 node and the 10.0.0.2 node. As a result, creating a client with only one of those nodes would return the same results.

Testing

To test, you should use appraisal like so:

bundle exec appraisal riak-1.4 rspec
bundle exec appraisal riak-2.0 rspec
bundle exec appraisal riak-2.1 rspec

Dependencies

fakeriak has been tested and verified with with the following dependencies: