officer 0.8.4 → 0.8.5

data/.autotest

@@ -0,0 +1,10 @@
+# Override autotest default magic to rerun all tests every time a
+# change is detected on the file system.
+class Autotest
+  def get_to_green
+    begin
+      rerun_all_tests
+      wait_for_changes unless all_good
+    end until all_good
+  end
+end

data/README.markdown

@@ -1,11 +1,10 @@
-# Officer - Distributed Lock Server and Client
+# Officer - Ruby lock server and client built on EventMachine
 
-It is implemented using Ruby and Eventmachine. Inspiration comes from [elock](http://github.com/dustin/elock).
+Officer is designed to help you coordinate distributed processes and avoid race conditions.  Inspiration comes from [elock](http://github.com/dustin/elock).
 
 ## Installation
 
-    sudo gem install gemcutter
-    sudo gem install officer
+    gem install officer
 
 ## Usage
 
@@ -101,11 +100,6 @@ Options:
     client.my_locks
 
 
-## Planned Features
-
-- Server: configure the daemons gem to allow multiple server processes to run on one box.
-- Tests
-
 ## Copyright
 
 Copyright (c) 2010 Chad Remesch. See LICENSE for details.

data/Rakefile

@@ -7,8 +7,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "officer"
   gem.homepage = "http://github.com/chadrem/officer"
   gem.license = "MIT"
-  gem.summary = %Q{Distributed lock server and client}
-  gem.description = %Q{Distributed lock server and client written in Ruby and EventMachine}
+  gem.summary = %Q{Ruby lock server and client built on EventMachine.}
+  gem.description = %Q{Officer is designed to help you coordinate distributed processes and avoid race conditions.}
   gem.email = "chad@remesch.com"
   gem.authors = ["Chad Remesch"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

data/officer.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{officer}
-  s.version = "0.8.4"
+  s.version = "0.8.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]
   s.date = %q{2011-01-22}
   s.default_executable = %q{officer}
-  s.description = %q{Distributed lock server and client written in Ruby and EventMachine}
+  s.description = %q{Officer is designed to help you coordinate distributed processes and avoid race conditions.}
   s.email = %q{chad@remesch.com}
   s.executables = ["officer"]
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     "README.markdown"
   ]
   s.files = [
+    ".autotest",
     ".document",
     ".rspec",
     "LICENSE",
@@ -41,7 +42,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Distributed lock server and client}
+  s.summary = %q{Ruby lock server and client built on EventMachine.}
   s.test_files = [
     "spec/integration/officer_spec.rb",
     "spec/spec_helper.rb"

data/spec/integration/officer_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "benchmark"
 
 describe Officer do
   before do
@@ -11,7 +12,7 @@ describe Officer do
     @server_thread.terminate
   end
 
-  context "single client tests" do
+  describe "COMMAND: with_lock" do
     before do
       @client = Officer::Client.new
     end
@@ -21,22 +22,22 @@ describe Officer do
       @client = nil
     end
 
-    it "should allow a client to request its locks" do
-      @client.my_locks.should eq({"value"=>[], "result"=>"locks"})
-    end
-
-    it "should allow a client to request and release a lock using non-block syntax" do
-      @client.lock("testlock")
-      @client.my_locks.should eq({"value"=>["testlock"], "result"=>"locks"})
-      @client.unlock("testlock")
-      @client.my_locks.should eq({"value"=>[], "result"=>"locks"})
-    end
-
     it "should allow a client to request and release a lock using block syntax" do
       @client.with_lock("testlock") do
         @client.my_locks.should eq({"value"=>["testlock"], "result"=>"locks"})
       end
     end
+  end
+
+  describe "COMMAND: reset" do
+    before do
+      @client = Officer::Client.new
+    end
+
+    after do
+      @client.send("disconnect")
+      @client = nil
+    end
 
     it "should allow a client to reset all of its locks (release them all)" do
       @client.lock("testlock1")
@@ -47,10 +48,36 @@ describe Officer do
     end
   end
 
-  context "multi-client tests" do
+  describe "COMMAND: reconnect" do
+    before do
+      @client = Officer::Client.new
+    end
+
+    after do
+      @client.send("disconnect")
+      @client = nil
+    end
+
+    it "should allow a client to force a reconnect in order to get a new socket" do
+      original_socket = @client.instance_variable_get("@socket")
+      @client.reconnect
+      @client.instance_variable_get("@socket").should_not eq(original_socket)
+      @client.my_locks.should eq({"value"=>[], "result"=>"locks"})
+    end
+  end
+
+  describe "COMMAND: connections" do
     before do
       @client1 = Officer::Client.new
       @client2 = Officer::Client.new
+
+      @client1_src_port = @client1.instance_variable_get('@socket').addr[1]
+      @client2_src_port = @client2.instance_variable_get('@socket').addr[1]
+
+      @client1.lock("client1_testlock1")
+      @client1.lock("client1_testlock2")
+      @client2.lock("client2_testlock1")
+      @client2.lock("client2_testlock2")
     end
 
     after do
@@ -60,12 +87,177 @@ describe Officer do
       @client2 = nil
     end
 
-    it "should allow a client to see all the locks on a server (including those owned by other clients)" do
+    it "should allow a client to see all the connections to a server" do
+      connections = @client2.connections
+
+      connections["value"]["127.0.0.1:#{@client1_src_port}"].should eq(["client1_testlock1", "client1_testlock2"])
+      connections["value"]["127.0.0.1:#{@client2_src_port}"].should eq(["client2_testlock1", "client2_testlock2"])
+      connections["value"].keys.length.should eq(2)
+      connections["result"].should eq("connections")
+    end
+  end
+
+  describe "COMMAND: locks" do
+    before do
+      @client1 = Officer::Client.new
+      @client2 = Officer::Client.new
+
+      @client1_src_port = @client1.instance_variable_get('@socket').addr[1]
+      @client2_src_port = @client2.instance_variable_get('@socket').addr[1]
+
       @client1.lock("client1_testlock1")
       @client1.lock("client1_testlock2")
       @client2.lock("client2_testlock1")
       @client2.lock("client2_testlock2")
-      # @client2.locks.should eq(false)
+    end
+
+    after do
+      @client1.send("disconnect")
+      @client1 = nil
+      @client2.send("disconnect")
+      @client2 = nil
+    end
+
+    it "should allow a client to see all the locks on a server (including those owned by other clients)" do
+      locks = @client2.locks
+
+      locks["value"]["client1_testlock1"].should eq(["127.0.0.1:#{@client1_src_port}"])
+      locks["value"]["client1_testlock2"].should eq(["127.0.0.1:#{@client1_src_port}"])
+      locks["value"]["client2_testlock1"].should eq(["127.0.0.1:#{@client2_src_port}"])
+      locks["value"]["client2_testlock2"].should eq(["127.0.0.1:#{@client2_src_port}"])
+      locks["value"].length.should eq(4)
+      locks["result"].should eq("locks")
+    end
+  end
+
+  describe "COMMAND: my_locks" do
+    before do
+      @client = Officer::Client.new
+    end
+
+    after do
+      @client.send("disconnect")
+      @client = nil
+    end
+
+    it "should allow a client to request its locks" do
+      @client.my_locks.should eq({"value"=>[], "result"=>"locks"})
+    end
+  end
+
+  describe "COMMAND: lock & unlock" do
+    describe "basic functionality" do
+      before do
+        @client = Officer::Client.new
+      end
+
+      after do
+        @client.send("disconnect")
+        @client = nil
+      end
+
+      it "should allow a client to request and release a lock" do
+        @client.lock("testlock").should eq({"result" => "acquired", "name" => "testlock"})
+        @client.my_locks.should eq({"value"=>["testlock"], "result"=>"locks"})
+        @client.unlock("testlock")
+        @client.my_locks.should eq({"value"=>[], "result"=>"locks"})
+      end
+    end
+
+    describe "locking options" do
+      describe "OPTION: timeout" do
+        before do
+          @client1 = Officer::Client.new
+          @client2 = Officer::Client.new
+
+          @client1_src_port = @client1.instance_variable_get('@socket').addr[1]
+          @client2_src_port = @client2.instance_variable_get('@socket').addr[1]
+
+          @client1.lock("testlock")
+        end
+
+        after do
+          @client1.send("disconnect")
+          @client1 = nil
+          @client2.send("disconnect")
+          @client2 = nil
+        end
+
+        it "should allow a client to set an instant timeout when obtaining a lock" do
+          @client2.lock("testlock", :timeout => 0).should eq(
+            {"result"=>"timed_out", "name"=>"testlock", "queue"=>["127.0.0.1:#{@client1_src_port}"]}
+          )
+        end
+
+        it "should allow a client to set a positive integer timeout when obtaining a lock" do
+          time = Benchmark.realtime do
+            @client2.lock("testlock", :timeout => 1).should eq(
+              {"result"=>"timed_out", "name"=>"testlock", "queue"=>["127.0.0.1:#{@client1_src_port}"]}
+            )
+          end
+          time.should > 1
+          time.should < 1.5
+        end
+      end
+
+      describe "OPTION: queue_max" do
+        before do
+        end
+
+        after do
+          @thread1.terminate
+          @thread2.terminate
+        end
+
+        it "should allow a client to abort when obtaining a lock if too many other clients are waiting for the same lock" do
+          @client1 = Officer::Client.new
+          @client1.lock("testlock")
+
+          @thread1 = Thread.new {
+            @client2 = Officer::Client.new
+            @client2.lock("testlock")
+            raise "This should never execute since the lock request should block"
+          }
+
+          @thread2 = Thread.new {
+            @client3 = Officer::Client.new
+            @client3.lock("testlock")
+            raise "This should never execute since the lock request should block"
+          }
+
+          sleep(0.25)  # Allow thread 1 & 2 time to run.
+
+          @thread1.status.should eq("sleep")
+          @thread2.status.should eq("sleep")
+
+          client1_src_port = @client1.instance_variable_get('@socket').addr[1]
+          client2_src_port = @client2.instance_variable_get('@socket').addr[1]
+          client3_src_port = @client3.instance_variable_get('@socket').addr[1]
+
+          @client4 = Officer::Client.new
+          @client4.lock("testlock", :queue_max => 3).should eq(
+            {"result" => "queue_maxed", "name" => "testlock", "queue" =>
+              ["127.0.0.1:#{client1_src_port}", "127.0.0.1:#{client2_src_port}", "127.0.0.1:#{client3_src_port}"]}
+          )
+        end
+      end
+
+      describe "OPTION: namespace" do
+        before do
+          @client = Officer::Client.new(:namespace => "myapp")
+        end
+
+        after do
+          @client.send("disconnect")
+          @client = nil
+        end
+
+        it "should allow a client to set a namespace when obtaining a lock" do
+          @client.with_lock("testlock") do
+            @client.locks["value"]["myapp:testlock"].should_not eq(nil)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: false
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Chad Remesch
@@ -90,7 +90,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id005
-description: Distributed lock server and client written in Ruby and EventMachine
+description: Officer is designed to help you coordinate distributed processes and avoid race conditions.
 email: chad@remesch.com
 executables: 
 - officer
@@ -100,6 +100,7 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
+- .autotest
 - .document
 - .rspec
 - LICENSE
@@ -150,7 +151,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Distributed lock server and client
+summary: Ruby lock server and client built on EventMachine.
 test_files: 
 - spec/integration/officer_spec.rb
 - spec/spec_helper.rb