riak-client 0.8.0 → 0.8.1

data/Gemfile

@@ -1,10 +1,10 @@
 # A sample Gemfile
 source :gemcutter
 
-gem 'activesupport', '~>2.3.5' # '3.0.0'
+gem 'activesupport', '~>2.3.5' #'~>3.0.0'
 gem 'i18n'
 
-gem 'rspec', "~>2.0.0.beta.18"
+gem 'rspec', "~>2.0.0"
 gem 'fakeweb', ">=1.2"
 gem 'rack', '>=1.0'
 gem 'curb', '>=0.6'

data/Gemfile.lock

@@ -1,22 +1,24 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (2.3.8)
+    activesupport (2.3.9)
     curb (0.7.8)
     diff-lcs (1.1.2)
     fakeweb (1.3.0)
     i18n (0.4.1)
     rack (1.2.1)
     rake (0.8.7)
-    rspec (2.0.0.beta.20)
-      rspec-core (= 2.0.0.beta.20)
-      rspec-expectations (= 2.0.0.beta.20)
-      rspec-mocks (= 2.0.0.beta.20)
-    rspec-core (2.0.0.beta.20)
-    rspec-expectations (2.0.0.beta.20)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
       diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.20)
-    yajl-ruby (0.7.7)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+    yajl-ruby (0.7.8)
 
 PLATFORMS
   ruby
@@ -29,5 +31,5 @@ DEPENDENCIES
   i18n
   rack (>= 1.0)
   rake
-  rspec (~> 2.0.0.beta.18)
+  rspec (~> 2.0.0)
   yajl-ruby

data/bin/htmldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rackup

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rake

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/erl_src/riak_kv_test_backend.erl

@@ -0,0 +1,173 @@
+%% -------------------------------------------------------------------
+%%
+%% riak_kv_test_backend: storage engine based on ETS tables
+%%
+%% Copyright (c) 2007-2010 Basho Technologies, Inc.  All Rights Reserved.
+%%
+%% This file is provided to you 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.
+%%
+%% -------------------------------------------------------------------
+
+% @doc riak_kv_test_backend is a Riak storage backend using ets that exposes a reset function for efficiently clearing stored data.
+
+-module(riak_kv_test_backend).
+-behavior(riak_kv_backend).
+-behavior(gen_server).
+-ifdef(TEST).
+-include_lib("eunit/include/eunit.hrl").
+-endif.
+-export([start/2,stop/1,get/2,put/3,list/1,list_bucket/2,delete/2,
+         is_empty/1, drop/1, fold/3, callback/3, reset/0]).
+
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+         terminate/2, code_change/3]).
+
+% @type state() = term().
+-record(state, {t}).
+
+% @spec start(Partition :: integer(), Config :: proplist()) ->
+%                        {ok, state()} | {{error, Reason :: term()}, state()}
+start(Partition, _Config) ->
+    gen_server:start_link(?MODULE, [Partition], []).
+
+% @spec reset() -> ok
+reset() ->
+    Pids = lists:filter(fun(Item) ->
+                                lists:prefix("test_backend", atom_to_list(Item))
+                        end, registered()),
+    [gen_server:call(Pid, reset) || Pid <- Pids],
+    ok.
+
+%% @private
+init([Partition]) ->
+    PName = list_to_atom("test_backend" ++ integer_to_list(Partition)),
+    register(PName, self()),
+    {ok, #state{t=ets:new(list_to_atom(integer_to_list(Partition)),[])}}.
+
+%% @private
+handle_cast(_, State) -> {noreply, State}.
+
+%% @private
+handle_call(stop,_From,State) -> {reply, srv_stop(State), State};
+handle_call({get,BKey},_From,State) -> {reply, srv_get(State,BKey), State};
+handle_call({put,BKey,Val},_From,State) ->
+    {reply, srv_put(State,BKey,Val),State};
+handle_call({delete,BKey},_From,State) -> {reply, srv_delete(State,BKey),State};
+handle_call(list,_From,State) -> {reply, srv_list(State), State};
+handle_call({list_bucket,Bucket},_From,State) ->
+    {reply, srv_list_bucket(State, Bucket), State};
+handle_call(is_empty, _From, State) ->
+    {reply, ets:info(State#state.t, size) =:= 0, State};
+handle_call(drop, _From, State) ->
+    ets:delete(State#state.t),
+    {reply, ok, State};
+handle_call({fold, Fun0, Acc}, _From, State) ->
+    Fun = fun({{B,K}, V}, AccIn) -> Fun0({B,K}, V, AccIn) end,
+    Reply = ets:foldl(Fun, Acc, State#state.t),
+    {reply, Reply, State};
+handle_call(reset, _From, State) ->
+    ets:delete_all_objects(State#state.t),
+    {reply, ok, State}.
+
+% @spec stop(state()) -> ok | {error, Reason :: term()}
+stop(SrvRef) -> gen_server:call(SrvRef,stop).
+srv_stop(State) ->
+    true = ets:delete(State#state.t),
+    ok.
+
+% get(state(), riak_object:bkey()) ->
+%   {ok, Val :: binary()} | {error, Reason :: term()}
+% key must be 160b
+get(SrvRef, BKey) -> gen_server:call(SrvRef,{get,BKey}).
+srv_get(State, BKey) ->
+    case ets:lookup(State#state.t,BKey) of
+        [] -> {error, notfound};
+        [{BKey,Val}] -> {ok, Val};
+        Err -> {error, Err}
+    end.
+
+% put(state(), riak_object:bkey(), Val :: binary()) ->
+%   ok | {error, Reason :: term()}
+% key must be 160b
+put(SrvRef, BKey, Val) -> gen_server:call(SrvRef,{put,BKey,Val}).
+srv_put(State,BKey,Val) ->
+    true = ets:insert(State#state.t, {BKey,Val}),
+    ok.
+
+% delete(state(), riak_object:bkey()) ->
+%   ok | {error, Reason :: term()}
+% key must be 160b
+delete(SrvRef, BKey) -> gen_server:call(SrvRef,{delete,BKey}).
+srv_delete(State, BKey) ->
+    true = ets:delete(State#state.t, BKey),
+    ok.
+
+% list(state()) -> [riak_object:bkey()]
+list(SrvRef) -> gen_server:call(SrvRef,list).
+srv_list(State) ->
+    MList = ets:match(State#state.t,{'$1','_'}),
+    list(MList,[]).
+list([],Acc) -> Acc;
+list([[K]|Rest],Acc) -> list(Rest,[K|Acc]).
+
+% list_bucket(term(), Bucket :: riak_object:bucket()) -> [Key :: binary()]
+list_bucket(SrvRef, Bucket) ->
+    gen_server:call(SrvRef,{list_bucket, Bucket}).
+srv_list_bucket(State, {filter, Bucket, Fun}) ->
+    MList = lists:filter(Fun, ets:match(State#state.t,{{Bucket,'$1'},'_'})),
+    list(MList,[]);
+srv_list_bucket(State, Bucket) ->
+    case Bucket of
+        '_' -> MatchSpec = {{'$1','_'},'_'};
+        _ -> MatchSpec = {{Bucket,'$1'},'_'}
+    end,
+    MList = ets:match(State#state.t,MatchSpec),
+    list(MList,[]).
+
+is_empty(SrvRef) -> gen_server:call(SrvRef, is_empty).
+
+drop(SrvRef) -> gen_server:call(SrvRef, drop).
+
+fold(SrvRef, Fun, Acc0) -> gen_server:call(SrvRef, {fold, Fun, Acc0}, infinity).
+
+%% Ignore callbacks for other backends so multi backend works
+callback(_State, _Ref, _Msg) ->
+    ok.
+
+%% @private
+handle_info(_Msg, State) -> {noreply, State}.
+
+%% @private
+terminate(_Reason, _State) -> ok.
+
+%% @private
+code_change(_OldVsn, State, _Extra) -> {ok, State}.
+
+%%
+%% Test
+%%
+-ifdef(TEST).
+
+% @private
+simple_test() ->
+    riak_kv_backend:standard_test(?MODULE, []).
+
+-ifdef(EQC).
+%% @private
+eqc_test() ->
+    ?assertEqual(true, backend_eqc:test(?MODULE, true)).
+
+-endif. % EQC
+-endif. % TEST

data/lib/riak.rb

@@ -44,6 +44,9 @@ module Riak
   autoload :InvalidResponse, "riak/invalid_response"
   autoload :MapReduceError,  "riak/map_reduce_error"
 
+  # Test server
+  autoload :TestServer,      "riak/test_server"
+
   # Utility classes and mixins
   module Util
     autoload :Escape,        "riak/util/escape"

data/lib/riak/robject.rb

@@ -35,9 +35,6 @@ module Riak
     attr_accessor :vclock
     alias_attribute :vector_clock, :vclock
 
-    # @return [Object] the data stored in Riak at this object's key. Varies in format by content-type, defaulting to String from the response body.
-    attr_accessor :data
-
     # @return [Set<Link>] a Set of {Riak::Link} objects for relationships between this object and other resources
     attr_accessor :links
 
@@ -50,6 +47,10 @@ module Riak
     # @return [Hash] a hash of any X-Riak-Meta-* headers that were in the HTTP response, keyed on the trailing portion
     attr_accessor :meta
 
+    # @return [Boolean] whether to attempt to prevent stale writes using conditional PUT semantics, If-None-Match: * or If-Match: {#etag}
+    # @see http://wiki.basho.com/display/RIAK/REST+API#RESTAPI-Storeaneworexistingobjectwithakey Riak Rest API Docs
+    attr_accessor :prevent_stale_writes
+
     # Loads a list of RObjects that were emitted from a MapReduce
     # query.
     # @param [Client] client A Riak::Client with which the results will be associated
@@ -89,7 +90,7 @@ module Riak
       end
       @conflict = response[:code].try(:to_i) == 300 && content_type =~ /multipart\/mixed/
       @siblings = nil
-      @data = deserialize(response[:body]) if response[:body].present?
+      self.raw_data = response[:body] if response[:body].present?
       self
     end
 
@@ -115,12 +116,49 @@ module Riak
       self
     end
 
+    # @return [Object] the unmarshaled form of {#raw_data} stored in riak at this object's key 
+    def data
+      if @raw_data && !@data
+        @data = deserialize(@raw_data)
+        @raw_data = nil
+      end
+      @data
+    end
+
+    # @param [Object] unmarshaled form of the data to be stored in riak. Object will be serialized using {#serialize} if a known content_type is used. Setting this overrides values stored with {#raw_data=}
+    # @return [Object] the object stored
+    def data=(new_data)
+      @raw_data = nil
+      @data = new_data
+    end
+
+    # @return [String] raw data stored in riak for this object's key
+    def raw_data
+      if @data && !@raw_data
+        @raw_data = serialize(@data)
+        @data = nil
+      end
+      @raw_data
+    end
+
+    # @param [String, IO] the raw data to be stored in riak at this key, will not be marshaled or manipulated prior to storage. Overrides any data stored by {#data=}
+    # @return [String] the data stored
+    def raw_data=(new_raw_data)
+      @data = nil
+      @raw_data = new_raw_data
+    end
+
     # HTTP header hash that will be sent along when storing the object
     # @return [Hash] hash of HTTP Headers
     def store_headers
       {}.tap do |hash|
         hash["Content-Type"] = @content_type
         hash["X-Riak-Vclock"] = @vclock if @vclock
+        if @prevent_stale_writes && @etag.present?
+          hash["If-Match"] = @etag
+        elsif @prevent_stale_writes
+          hash["If-None-Match"] = "*"
+        end
         unless @links.blank?
           hash["Link"] = @links.reject {|l| l.rel == "up" }.map(&:to_s).join(", ")
         end
@@ -153,7 +191,7 @@ module Riak
       raise ArgumentError, t("content_type_undefined") unless @content_type.present?
       params = {:returnbody => true}.merge(options)
       method, codes, path = @key.present? ? [:put, [200,204,300], "#{escape(@bucket.name)}/#{escape(@key)}"] : [:post, 201, escape(@bucket.name)]
-      response = @bucket.client.http.send(method, codes, @bucket.client.prefix, path, params, serialize(data), store_headers)
+      response = @bucket.client.http.send(method, codes, @bucket.client.prefix, path, params, raw_data, store_headers)
       load(response)
     end
 

data/lib/riak/test_server.rb

@@ -0,0 +1,231 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    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.
+require 'riak'
+require 'tempfile'
+require 'expect'
+require 'open3'
+require 'riak/util/tcp_socket_extensions'
+
+module Riak
+  class TestServer
+    APP_CONFIG_DEFAULTS = {
+      :riak_core => {
+        :web_ip => "127.0.0.1",
+        :web_port => 9000,
+        :handoff_port => 9001,
+        :ring_creation_size => 64
+      },
+      :riak_kv => {
+        :storage_backend => :riak_kv_test_backend,
+        :pb_ip => "127.0.0.1",
+        :pb_port => 9002,
+        :js_vm_count => 8,
+        :js_max_vm_mem => 8,
+        :js_thread_stack => 16,
+        :riak_kv_stat => true
+      },
+      :luwak => {
+        :enabled => false
+      }
+    }
+    VM_ARGS_DEFAULTS = {
+      "-name" => "riaktest#{rand(1000000).to_s}@127.0.0.1",
+      "-setcookie" => "#{rand(1000000).to_s}_#{rand(1000000).to_s}",
+      "+K" => true,
+      "+A" => 64,
+      "-smp" => "enable",
+      "-env ERL_MAX_PORTS" => 4096,
+      "-env ERL_FULLSWEEP_AFTER" => 10,
+      "-pa" => File.expand_path("../../../erl_src", __FILE__)
+    }
+    DEFAULTS = {
+      :app_config => APP_CONFIG_DEFAULTS,
+      :vm_args => VM_ARGS_DEFAULTS,
+      :temp_dir => File.join(Dir.tmpdir,'riaktest'),
+    }
+    attr_accessor :temp_dir, :app_config, :vm_args, :cin, :cout, :cerr, :cpid
+
+    def initialize(options={})
+      options   = deep_merge(DEFAULTS.dup, options)
+      @temp_dir = File.expand_path(options[:temp_dir])
+      @bin_dir  = File.expand_path(options[:bin_dir])
+      options[:app_config][:riak_core][:ring_state_dir] ||= File.join(@temp_dir, "data", "ring")
+      @app_config = options[:app_config]
+      @vm_args    = options[:vm_args]
+      # For synchronizing start/stop/recycle
+      @mutex = Mutex.new
+    end
+
+    # Sets up the proper scripts, configuration and directories for
+    # the test server.  Call at the top of your test suite (not in a
+    # setup method).
+    def prepare!
+      unless @prepared
+        create_temp_directories
+        @riak_script = File.join(@temp_bin, 'riak')
+        write_riak_script
+        write_vm_args
+        write_app_config
+        @prepared = true
+      end
+    end
+
+    # Starts the test server if it is not already running, and waits
+    # for it to respond to pings.
+    def start
+      if @prepared && !@started
+        @mutex.synchronize do
+          @cin, @cout, @cerr, @cpid = Open3.popen3("#{@riak_script} console")
+          @cin.puts
+          wait_for_erlang_prompt
+          @started = true
+        end
+      end
+    end
+
+    # Stops the test server if it is running.
+    def stop
+      if @started
+        @mutex.synchronize do
+          begin
+            @cin.puts "init:stop()."
+          rescue Errno::EPIPE
+          ensure
+            register_stop
+          end
+        end
+        true
+      end
+    end
+
+    # Whether the server has been started.
+    def started?
+      @started
+    end
+
+    # Causes the entire contents of the Riak in-memory backends to be
+    # dumped by performing a soft restart.
+    def recycle
+      if @started
+        @mutex.synchronize do
+          begin
+            if @app_config[:riak_kv][:storage_backend] == :riak_kv_test_backend
+              @cin.puts "riak_kv_test_backend:reset()."
+              wait_for_erlang_prompt
+            else
+              @cin.puts "init:restart()."
+              wait_for_erlang_prompt
+              wait_for_startup
+            end
+          rescue Errno::EPIPE
+            warn "Broken pipe when recycling, is Riak alive?"
+            register_stop
+            return false
+          end
+        end
+        true
+      else
+        start
+      end
+    end
+
+    # Cleans up any files and directories generated by the test
+    # server.
+    def cleanup
+      stop if @started
+      FileUtils.rm_rf(@temp_dir)
+      @prepared = false
+    end
+
+    private
+    def create_temp_directories
+      %w{bin etc log data pipe}.each do |dir|
+        instance_variable_set("@temp_#{dir}", File.expand_path(File.join(@temp_dir, dir)))
+        FileUtils.mkdir_p(instance_variable_get("@temp_#{dir}"))
+      end
+    end
+
+    def write_riak_script
+      File.open(@riak_script, 'wb') do |f|
+        File.readlines(File.join(@bin_dir, 'riak')).each do |line|
+          line.sub!(/(RUNNER_SCRIPT_DIR=)(.*)/, '\1' + @temp_bin)
+          line.sub!(/(RUNNER_ETC_DIR=)(.*)/, '\1' + @temp_etc)
+          line.sub!(/(RUNNER_USER=)(.*)/, '\1')
+          line.sub!(/(RUNNER_LOG_DIR=)(.*)/, '\1' + @temp_log)
+          line.sub!(/(PIPE_DIR=)(.*)/, '\1' + @temp_pipe)
+          if line.strip == "RUNNER_BASE_DIR=${RUNNER_SCRIPT_DIR%/*}"
+            line = "RUNNER_BASE_DIR=#{File.expand_path("..",@bin_dir)}\n"
+          end
+          f.write line
+        end
+      end
+      FileUtils.chmod(0755,@riak_script)
+    end
+
+    def write_vm_args
+      File.open(File.join(@temp_etc, 'vm.args'), 'wb') do |f|
+        f.write @vm_args.map {|k,v| "#{k} #{v}" }.join("\n")
+      end
+    end
+
+    def write_app_config
+      File.open(File.join(@temp_etc, 'app.config'), 'wb') do |f|
+        f.write to_erlang_config(@app_config) + '.'
+      end
+    end
+
+    def deep_merge(source, target)
+      source.merge(target) do |key, old_val, new_val|
+        if Hash === old_val && Hash === new_val
+          deep_merge(old_val, new_val)
+        else
+          new_val
+        end
+      end
+    end
+
+    def to_erlang_config(hash, depth = 1)
+      padding = '    ' * depth
+      parent_padding = '    ' * (depth-1)
+      values = hash.map do |k,v|
+        printable = case v
+                    when Hash
+                      to_erlang_config(v, depth+1)
+                    when String
+                      "\"#{v}\""
+                    else
+                      v.to_s
+                    end
+        "{#{k}, #{printable}}"
+      end.join(",\n#{padding}")
+      "[\n#{padding}#{values}\n#{parent_padding}]"
+    end
+
+    def wait_for_startup
+      TCPSocket.wait_for_service_with_timeout(:host => @app_config[:riak_core][:web_ip],
+                                              :port => @app_config[:riak_core][:web_port], :timeout => 10)
+    end
+
+    def wait_for_erlang_prompt
+      @cout.expect(/\(#{Regexp.escape(vm_args["-name"])}\)\d+>/)
+    end
+
+    def register_stop
+      %w{@cin @cout @cerr}.each {|io| if instance_variable_get(io); instance_variable_get(io).close; instance_variable_set(io, nil) end }
+      _cpid = @cpid; @cpid = nil
+      at_exit { _cpid.join if _cpid.alive? }
+      @started = false
+    end
+  end
+end

data/lib/riak/util/headers.rb

@@ -21,7 +21,7 @@ module Net::HTTPHeader
     respond_to?(:enum_for) and (block_given? or return enum_for(__method__))
     @header.each do |k,v|
       base_length = "#{k}: \r\n".length
-      values = v.map {|i| i.split(", ") }.flatten
+      values = v.map {|i| i.to_s.split(", ") }.flatten
       while !values.empty?
         current_line = ""
         while values.first && current_line.length + base_length + values.first.length + 2 < 8192

data/lib/riak/util/tcp_socket_extensions.rb

@@ -0,0 +1,70 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    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.
+require 'timeout'
+require 'socket'
+
+# Borrowed from Webrat and Selenium client, watches for TCP port
+# liveness of the spawned server.
+# @private
+class TCPSocket  
+  def self.wait_for_service(options)
+    verbose_wait until listening_service?(options)
+  end
+
+  def self.wait_for_service_termination(options)
+    verbose_wait while listening_service?(options)
+  end
+
+  def self.listening_service?(options)
+    Timeout::timeout(options[:timeout] || 20) do
+      begin
+        socket = TCPSocket.new(options[:host], options[:port])
+        socket.close unless socket.nil?
+        true
+      rescue Errno::ECONNREFUSED,
+        Errno::EBADF           # Windows
+        false
+      end
+    end
+  end
+
+  def self.verbose_wait
+    # Removed the puts call so as not to clutter up test output.
+    sleep 2
+  end
+
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+
+    until listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+
+    while listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+end

data/spec/integration/riak/cache_store_spec.rb

@@ -14,15 +14,30 @@
 require File.expand_path("../../spec_helper", File.dirname(__FILE__))
 
 describe Riak::CacheStore do
+  before :all do
+    if $test_server
+      @web_port = 9000
+      $test_server.start
+    end
+  end
+
   before do
-    @cache = ActiveSupport::Cache.lookup_store(:riak_store)
+    @web_port ||= 8098
+    @cache = ActiveSupport::Cache.lookup_store(:riak_store, :port => @web_port)
     @cleanup = true
   end
 
   after do
-    @cache.bucket.keys(:force => true).each do |k|
-      @cache.bucket.delete(k, :rw => 1) unless k.blank?
-    end if @cleanup
+    if @cleanup
+      if $test_server
+        $test_server.recycle
+        Thread.current[:curl_easy_handle] = nil
+      else
+        @cache.bucket.keys(:force => true).each do |k|
+          @cache.bucket.delete(k, :rw => 1) unless k.blank?
+        end
+      end
+    end
   end
 
   describe "Riak integration" do
@@ -45,7 +60,7 @@ describe Riak::CacheStore do
     end
 
     it "should choose the bucket according to the initializer option" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :bucket => "foobar")
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :bucket => "foobar", :port => @web_port)
       @cache.bucket.name.should == "foobar"
     end
 
@@ -54,7 +69,7 @@ describe Riak::CacheStore do
     end
 
     it "should set the N value to the specified value" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :n_value => 1)
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :n_value => 1, :port => @web_port)
       @cache.bucket.n_value.should == 1
     end
 
@@ -63,7 +78,7 @@ describe Riak::CacheStore do
     end
 
     it "should set the bucket R default to the specified value" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :r => "quorum")
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :r => "quorum", :port => @web_port)
       @cache.bucket.r.should == "quorum"
     end
 
@@ -72,7 +87,7 @@ describe Riak::CacheStore do
     end
 
     it "should set the bucket W default to the specified value" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :w => "all")
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :w => "all", :port => @web_port)
       @cache.bucket.w.should == "all"
     end
 
@@ -81,7 +96,7 @@ describe Riak::CacheStore do
     end
 
     it "should set the bucket DW default to the specified value" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :dw => "quorum")
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :dw => "quorum", :port => @web_port)
       @cache.bucket.dw.should == "quorum"
     end
 
@@ -90,7 +105,7 @@ describe Riak::CacheStore do
     end
 
     it "should set the bucket RW default to the specified value" do
-      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :rw => "all")
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :rw => "all", :port => @web_port)
       @cache.bucket.rw.should == "all"
     end
   end

data/spec/integration/riak/test_server_spec.rb

@@ -0,0 +1,174 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    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.
+require File.expand_path("../../spec_helper", File.dirname(__FILE__))
+
+if $test_server
+  describe Riak::TestServer do
+    before do
+      @server = $test_server
+    end
+
+    after do
+      @server.stop
+      @server.cleanup
+    end
+
+    describe "isolation from and modification of the existing install" do
+      before do
+        @server.prepare!
+        @riak_bin    = "#{@server.temp_dir}/bin/riak"
+        @vm_args     = "#{@server.temp_dir}/etc/vm.args"
+        @app_config  = "#{@server.temp_dir}/etc/app.config"
+      end
+
+      describe "for app.config" do
+        it "should create the app.config file in the temporary directory" do
+          File.should be_exist(File.expand_path(@app_config))
+        end
+
+        it "should be a correct Erlang config" do
+          config = File.read(@app_config)
+          config[-2..-1].should == '].'
+          config[0..0].should == '['
+        end
+
+        it "should set the backend to use the cache backend" do
+          File.readlines(@app_config).should be_any do |line|
+            line =~ /\{storage_backend\s*,\s*(.*)\}/ && $1 == "riak_kv_cache_backend"
+          end
+        end
+
+        it "should set the default ports to 9000-9002" do
+          config = File.readlines(@app_config)
+          config.should be_any do |line|
+            line =~ /\{web_port\s*,\s*(.*)\}/ && $1 == "9000"
+          end
+          config.should be_any do |line|
+            line =~ /\{handoff_port\s*,\s*(.*)\}/ && $1 == "9001"
+          end
+          config.should be_any do |line|
+            line =~ /\{pb_port\s*,\s*(.*)\}/ && $1 == "9002"
+          end
+        end
+
+        it "should set the ring directory to point to the temporary directory" do
+          config = File.readlines(@app_config)
+          config.should be_any do |line|
+            line =~ /\{ring_state_dir\s*,\s*(.*)\}/ && $1 == File.join(@server.temp_dir, "data", "ring")
+          end
+        end
+      end
+
+      describe "for vm.args" do
+        it "should create the vm.args file in the temporary directory" do
+          File.should be_exist(File.expand_path(@vm_args))
+        end
+
+        it "should set a quasi-random node name" do
+          File.readlines(@vm_args).should be_any do |line|
+            line =~ /^-name (.*)/ && $1 =~ /riaktest\d+@/
+          end
+        end
+
+        it "should set a quasi-random cookie" do
+          File.readlines(@vm_args).should be_any do |line|
+            line =~ /^-setcookie (.*)/ && $1 != "riak"
+          end
+        end
+      end
+
+      describe "for the riak script" do
+        it "should create the script in the temporary directory" do
+          File.should be_exist(File.expand_path(@riak_bin))
+        end
+
+        it "should modify the RUNNER_SCRIPT_DIR to point to the temporary directory" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /RUNNER_SCRIPT_DIR=(.*)/ && $1 == File.expand_path("#{@server.temp_dir}/bin")
+
+          end
+        end
+
+        it "should modify the RUNNER_ETC_DIR to point to the temporary directory" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /RUNNER_ETC_DIR=(.*)/ && $1 == File.expand_path("#{@server.temp_dir}/etc")
+          end
+        end
+
+        it "should modify the RUNNER_USER to point to the current user" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /RUNNER_USER=(.*)/ && $1 == (ENV['USER'] || `whoami`)
+          end
+        end
+
+        it "should modify the RUNNER_LOG_DIR to point to the temporary directory" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /RUNNER_LOG_DIR=(.*)/ && $1 == File.expand_path("#{@server.temp_dir}/log")
+          end
+        end
+
+        it "should modify the RUNNER_BASE_DIR so that it is not relative" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /RUNNER_BASE_DIR=(.*)/ && $1.strip != "${RUNNER_SCRIPT_DIR%/*}" && File.directory?($1)
+          end
+        end
+
+        it "should modify the PIPE_DIR to point to the temporary directory" do
+          File.readlines(@riak_bin).should be_any do |line|
+            line =~ /PIPE_DIR=(.*)/ &&  $1 == File.expand_path("#{@server.temp_dir}/pipe") && File.directory?($1)
+          end
+        end
+      end
+    end
+
+    it "should cleanup the existing config" do
+      @server.prepare!
+      @server.cleanup
+      File.should_not be_directory(@server.temp_dir)
+    end
+
+    it "should start Riak in the background" do
+      @server.prepare!
+      @server.start.should be_true
+      @server.should be_started
+    end
+
+    it "should stop a started test server" do
+      @server.prepare!
+      @server.start.should be_true
+      @server.stop
+      @server.should_not be_started
+    end
+
+    it "should recycle the server contents" do
+      begin
+        @server.prepare!
+        @server.start.should be_true
+
+        client = Riak::Client.new(:port => 9000)
+        obj = client['test_bucket'].new("test_item")
+        obj.data = {"data" => "testing"}
+        obj.store rescue nil
+
+        @server.recycle
+        @server.should be_started
+        lambda do
+          client['test_bucket']['test_item']
+        end.should raise_error(Riak::FailedRequest)
+      ensure
+        @server.stop
+      end
+    end
+  end
+end

data/spec/riak/object_spec.rb

@@ -118,6 +118,64 @@ describe Riak::RObject do
     end
   end
 
+  describe "data access methods" do
+    before :each do
+      @object = Riak::RObject.new(@bucket, "bar")
+      @object.content_type = "application/json"
+    end
+
+    describe "for raw data" do
+      describe "when unserialized data was already provided" do
+        before do
+          @object.data = { :some => :data }
+        end
+
+        it "should reset unserialized forms when stored" do
+          @object.raw_data = value = '{ "raw": "json" }'
+
+          @object.raw_data.should == value
+          @object.data.should == { "raw" => "json" }
+        end
+
+        it "should lazily serialize when read" do
+          @object.raw_data.should == '{"some":"data"}'
+        end
+      end
+
+      it "should not unnecessarily marshal/demarshal" do
+        @object.should_not_receive(:serialize)
+        @object.should_not_receive(:deserialize)
+        @object.raw_data = value = "{not even valid json!}}"
+        @object.raw_data.should == value
+      end
+    end
+
+    describe "for unserialized data" do
+      describe "when raw data was already provided" do
+        before do
+          @object.raw_data = '{"some":"data"}'
+        end
+
+        it "should reset previously stored raw data" do
+          @object.data = value = { "new" => "data" }
+          @object.raw_data.should == '{"new":"data"}'
+          @object.data.should == value
+        end
+
+        it "should lazily deserialize when read" do
+          @object.data.should == { "some" => "data" }
+        end
+      end
+
+      it "should not unnecessarily marshal/demarshal" do
+        @object.should_not_receive(:serialize)
+        @object.should_not_receive(:deserialize)
+        @object.data = value = { "some" => "data" }
+        @object.data.should == value
+      end
+    end
+  end
+
   describe "loading data from the response" do
     before :each do
       @object = Riak::RObject.new(@bucket, "bar")
@@ -130,9 +188,16 @@ describe Riak::RObject do
 
     it "should load the body data" do
       @object.load({:headers => {"content-type" => ["application/json"]}, :body => '{"foo":"bar"}'})
+      @object.raw_data.should be_present
       @object.data.should be_present
     end
 
+    it "should handle raw data properly" do
+      @object.should_not_receive(:deserialize) # optimize for the raw_data case, don't penalize people for using raw_data
+      @object.load({:headers => {"content-type" => ["application/json"]}, :body => body = '{"foo":"bar"}'})
+      @object.raw_data.should == body
+    end
+
     it "should deserialize the body data" do
       @object.should_receive(:deserialize).with("{}").and_return({})
       @object.load({:headers => {"content-type" => ["application/json"]}, :body => "{}"})
@@ -335,6 +400,23 @@ describe Riak::RObject do
       @object.store_headers.should_not have_key("X-Riak-Vclock")
     end
 
+    describe "when conditional PUTs are requested" do
+      before :each do
+        @object.prevent_stale_writes = true
+      end
+
+      it "should include an If-None-Match: * header" do
+        @object.store_headers.should have_key("If-None-Match")
+        @object.store_headers["If-None-Match"].should == "*"
+      end
+
+      it "should include an If-Match header with the etag when an etag is present" do
+        @object.etag = "foobar"
+        @object.store_headers.should have_key("If-Match")
+        @object.store_headers["If-Match"].should == @object.etag
+      end
+    end
+
     describe "when links are defined" do
       before :each do
         @object.links << Riak::Link.new("/riak/foo/baz", "next")
@@ -447,6 +529,22 @@ describe Riak::RObject do
         @object.key = "bar"
       end
 
+      describe "when the content is of a known serializable type" do
+        before :each do
+          @object.content_type = "application/json"
+          @headers = @object.store_headers
+        end
+
+        it "should not serialize content if #raw_data is used" do
+          storing = @object.raw_data = "{this is probably invalid json}}"
+          @http.should_receive(:put).with([200,204,300], "/riak/", "foo/bar", {:returnbody => true}, storing, @headers).and_return({:headers => {"x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
+          @object.should_not_receive(:serialize)
+          @object.should_not_receive(:deserialize)
+          @object.store
+          @object.raw_data.should == storing
+        end
+      end
+
       it "should issue a PUT request to the bucket, and update the object properties (returning the body by default)" do
         @http.should_receive(:put).with([200,204,300], "/riak/", "foo/bar", {:returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
         @object.store

data/spec/spec_helper.rb

@@ -16,14 +16,26 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems' # Use the gems path only for the spec suite
 require 'riak'
-require 'rspec/autorun'
+require 'rspec'
 require 'fakeweb'
 
+begin
+  require 'yaml'
+  config = YAML.load_file("spec/support/test_server.yml")
+  $test_server = Riak::TestServer.new(config.symbolize_keys)
+  $test_server.prepare!
+  $test_server.start
+  at_exit { $test_server.cleanup }
+rescue => e
+  warn "Can't run Riak::TestServer specs. Specify the location of your Riak installation in spec/support/test_server.yml. See Riak::TestServer docs for more info."
+  warn e.inspect
+end
+
 Dir[File.join(File.dirname(__FILE__), "support", "*.rb")].each {|f| require f }
 
 Rspec.configure do |config|
   config.mock_with :rspec
-  
+
   config.before(:each) do
     FakeWeb.clean_registry
   end

data/spec/support/test_server.yml

@@ -0,0 +1,2 @@
+bin_dir: /Users/sean/Development/riak/rel/riak/bin
+temp_dir: /Users/sean/Development/ripple/.riaktest

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 1
+  version: 0.8.1
 platform: ruby
 authors: 
 - Sean Cribbs
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 -04:00
+date: 2010-10-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -115,6 +115,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- bin/htmldiff
+- bin/ldiff
+- bin/rackup
+- bin/rake
+- bin/rspec
+- erl_src/riak_kv_test_backend.beam
+- erl_src/riak_kv_test_backend.erl
 - Gemfile
 - Gemfile.lock
 - lib/active_support/cache/riak_store.rb
@@ -132,10 +139,12 @@ files:
 - lib/riak/map_reduce.rb
 - lib/riak/map_reduce_error.rb
 - lib/riak/robject.rb
+- lib/riak/test_server.rb
 - lib/riak/util/escape.rb
 - lib/riak/util/fiber1.8.rb
 - lib/riak/util/headers.rb
 - lib/riak/util/multipart.rb
+- lib/riak/util/tcp_socket_extensions.rb
 - lib/riak/util/translation.rb
 - lib/riak/walk_spec.rb
 - lib/riak.rb
@@ -144,6 +153,7 @@ files:
 - spec/fixtures/multipart-blank.txt
 - spec/fixtures/multipart-with-body.txt
 - spec/integration/riak/cache_store_spec.rb
+- spec/integration/riak/test_server_spec.rb
 - spec/riak/bucket_spec.rb
 - spec/riak/client_spec.rb
 - spec/riak/curb_backend_spec.rb
@@ -160,6 +170,7 @@ files:
 - spec/support/http_backend_implementation_examples.rb
 - spec/support/mock_server.rb
 - spec/support/mocks.rb
+- spec/support/test_server.yml
 has_rdoc: true
 homepage: http://seancribbs.github.com/ripple
 licenses: []
@@ -194,6 +205,7 @@ specification_version: 3
 summary: riak-client is a rich client for Riak, the distributed database by Basho.
 test_files: 
 - spec/integration/riak/cache_store_spec.rb
+- spec/integration/riak/test_server_spec.rb
 - spec/riak/bucket_spec.rb
 - spec/riak/client_spec.rb
 - spec/riak/curb_backend_spec.rb