riak_test_server 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a506f0cbd9517f343ef7858722f568b553534e
+  data.tar.gz: a7daf07b12c6accc1a364863ec8658551e2a938c
+SHA512:
+  metadata.gz: 50466f16b873b69a60ff6bf1fb4cda921e63c2bdc580d867ff0a493c4349047ea1be830c6a0c0a30735ebe3d7688587cd32a753e441e76f8cc19c60859ac6d79
+  data.tar.gz: 60c907d88d571b98160e7129e5c3d4ca81bfae980a1c70a6a72defc45c51c3fefa72a1dc3d2df279e787dafdaec5294b50dcdf94bdcb7711a22c1eba28bb2fee

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Talbott
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Riak Test Server
+
+Basho has (for good reasons) discontinued support for test servers in their
+client libraries, but it turns out the critical functionality is built into Riak
+regardless. This project wraps some drop in code (currently just Ruby) around a
+Docker container that gives the same functionality and allows rapidly resetting
+the Riak backend inbetween tests.
+
+## Pre-requisites
+
+* [docker](https://docs.docker.com/installation/)
+* A working docker host environment (I like [dvm](https://github.com/fnichol/dvm) on OS X)
+* A hostname of `docker` mapped to the IP of your container host (192.168.42.43 for dvm)
+
+## Installation
+
+Add this line to your application's Gemfile and `bundle`:
+
+    gem 'riak_test_server'
+
+Or install it yourself as:
+
+    $ gem install riak_test_server
+
+## Usage
+
+### Setup
+
+Near the top of `test_helper.rb` or the like:
+
+```
+require "riak_test_server"
+RiakTestServer.setup
+```
+
+### Clearing
+
+Wherever you want to clear out Riak, say in `setup`:
+
+```
+RiakTestServer.clear
+```
+
+### Options
+
+You can override a bunch of defaults by passing options to `RiakTestServer.setup`:
+
+* `:container_host` - hostname or IP of the container host [default: `"docker"`]
+* `:http_port` - port to expose Riak HTTP on on the `container_host` [default: `"8098"`]
+* `:pb_port` - port to expose Riak Protocol Buffers on on the `container_host` [default: `"8087"`]
+* `:container_name` - name to use for the container when `docker run`-ing it; handy to change if you want different containers for different apps [default: `"riak_test_server"`]
+* `:repository` - supplier of docker images [default: `"ntalbott/riak_test_server"`]
+* `:tag` - docker image to use; `docker search ntalbott/riak_test_server` to see if other Riak versions are available [default: `"latest"`]
+* `:docker_bin` - name of the docker binary [default: `"docker"`]

data/ruby/riak_test_server/version.rb

@@ -0,0 +1,3 @@
+module RiakTestServer
+  VERSION = "1.0.0"
+end

data/ruby/riak_test_server.rb

@@ -0,0 +1,110 @@
+require "expect"
+
+module RiakTestServer
+  def self.setup(options={})
+    @server.stop if @server
+    @server = Server.new(options)
+
+    @server.setup
+    @server.start
+    @server.check
+    @server.clear
+  end
+
+  def self.clear
+    @server.clear
+  end
+
+  class Server
+    attr_reader :repository, :tag
+    def initialize(options)
+      @container_host = (options[:container_host] || "docker")
+      @container_name = (options[:container_name] || "riak_test_server")
+      @http_port = (options[:http_port] || "8098")
+      @pb_port = (options[:pb_port] || "8087")
+      @repository = (options[:docker_repository] || "ntalbott/riak_test_server")
+      @tag = (options[:docker_tag] || "latest")
+      @docker_bin = (options[:docker_bin] || "docker")
+    end
+
+    def start
+      if docker("ps -a") =~ /\b#{@container_name}\b/
+        docker "stop #{@container_name}"
+        docker "rm #{@container_name}"
+      end
+
+      docker %W(
+        run
+        --name #{@container_name}
+        --detach=true
+        --interactive=true
+        --publish=#{@http_port}:8098
+        --publish=#{@pb_port}:8087
+        #{@repository}:#{@tag}
+      ).join(" ")
+    end
+
+    def stop
+      @console_io.close if @console_io
+      docker "stop #{@container_name}"
+    end
+
+    def setup
+      unless docker("images") =~ /#{repository}\s+#{tag}/
+        docker "pull #{repository}:#{tag}"
+      end
+    end
+
+    def clear
+      result = console("{riak_kv_memory_backend:reset(), boom}.").chomp.strip
+      raise "Unable to reset backend (#{result})" unless result == "{ok,boom}"
+    end
+
+    def check
+      retries = 20
+      loop do
+        result = console("riak_kv_console:vnode_status([]).")
+        break if result.split(/^VNode: \w+$/i).size >= 4 # at least 3 vnodes are available
+
+        raise "vnodes not starting in time" if retries == 0
+        retries -= 1
+        sleep 1
+      end
+    end
+
+    private
+
+    def docker(command)
+      full_command = "#{@docker_bin} #{command}"
+      `#{full_command} 2>&1`.tap do |output|
+        raise "#{full_command} failed: #{output}" unless $?.exitstatus == 0
+      end
+    end
+
+    PROMPT = /\(riak@[\w\.]+\)(\d+)>\s*/
+    def console(command)
+      raise "Command not terminated with a `.`: #{command}" unless command =~ /\.\s*\z/
+      attach do |io|
+        io.puts(command)
+        response = io.expect(PROMPT, 10)
+        if response
+          PROMPT.match(response.first).pre_match
+        else
+          raise "Prompt not returned after sending #{command} to Riak console"
+        end
+      end
+    end
+
+    def attach
+      unless @console_io
+        @console_io = IO.popen([@docker_bin, "attach", @container_name], "r+", err: :out).tap{|io| io.sync = true}
+        @console_io.puts("ok.")
+        unless @console_io.expect(PROMPT, 10)
+          raise "Unable to get a prompt on the console"
+        end
+      end
+
+      yield(@console_io)
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: riak_test_server
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathaniel Talbott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes it easy to run tests against Riak and wipe all data between each
+  test (or whenever you want).
+email:
+- nathaniel@talbott.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- ruby/riak_test_server.rb
+- ruby/riak_test_server/version.rb
+homepage: https://github.com/ntalbott/riak_test_server
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ruby
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A drop-in Riak test server. Uses Docker.
+test_files: []
+has_rdoc: