hot_tub 0.3.0 → 0.4.0

data/spec/hot_tub/pool_spec.rb

@@ -0,0 +1,247 @@
+require 'spec_helper'
+describe HotTub::Pool do
+
+  context 'default settings' do
+    let(:pool) { HotTub::Pool.new { MocClient.new } }
+
+    it "should have :size of 5" do
+      expect(pool.instance_variable_get(:@size)).to eql(5)
+    end
+
+    it "should have :wait_timeout of 0.5" do
+      expect(pool.instance_variable_get(:@wait_timeout)).to eql(10)
+    end
+
+    it "should have set the client" do
+      expect(pool.instance_variable_get(:@new_client).call).to be_a(MocClient)
+    end
+
+    it "should be true" do
+      expect(pool.instance_variable_get(:@max_size)).to eql(0)
+    end
+
+    it "should have a HotTub::Reaper" do
+      expect(pool.reaper).to be_a(Thread)
+    end
+  end
+
+  context 'custom settings' do
+
+    let(:pool) { HotTub::Pool.new(:size => 10, :wait_timeout => 1.0, :max_size => 20) { MocClient.new } }
+
+    it { expect(pool.instance_variable_get(:@size)).to eql(10) }
+
+    it { expect(pool.instance_variable_get(:@wait_timeout)).to eql(1.0) }
+
+    it { expect(pool.instance_variable_get(:@max_size)).to eql(20) }
+  end
+
+  describe '#run' do
+    let(:pool) { HotTub::Pool.new { MocClient.new} }
+
+    it "should remove connection from pool when doing work" do
+      pool.run do |connection|
+        conn = connection
+        expect(pool.instance_variable_get(:@_pool).select{|c| c.object_id == conn.object_id}.length).to eql(0)
+      end
+    end
+
+    it "should return the connection after use" do
+      conn = nil
+      pool.run do |connection|
+        conn = connection
+      end
+      # returned to pool after work was done
+      expect(pool.instance_variable_get(:@_pool).pop).to eql(conn)
+    end
+
+    it "should work" do
+      result = nil
+      pool.run{|clnt| result = clnt.get}
+      expect(result).to_not be_nil
+    end
+
+    context 'block not given' do
+      it "should raise ArgumentError" do
+        expect { pool.run }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ':max_size option' do
+
+    context 'is default' do
+      it "should add clients to pool as necessary" do
+        pool = HotTub::Pool.new({:size => 1}) { MocClient.new }
+        threads = []
+        5.times.each do
+          threads << Thread.new do
+            pool.run{|cltn| cltn.get }
+          end
+        end
+        threads.each do |t|
+          t.join
+        end
+        expect(pool.send(:_total_current_size)).to be > 1
+      end
+    end
+
+    context 'is set' do
+      it "should not add clients to pool beyond specified size" do
+        pool = HotTub::Pool.new({:size => 1, :max_size => 1, :wait_timeout => 100}) { MocClient.new }
+        threads = []
+        5.times.each do
+          threads << Thread.new do
+            pool.run{|cltn| cltn.get }
+          end
+        end
+        threads.each do |t|
+          t.join
+        end
+        expect(pool.send(:_total_current_size)).to eql(1)
+      end
+    end
+  end
+
+  describe '#drain!' do
+    let(:pool) { HotTub::Pool.new(:size => 4) { MocClient.new } }
+    before(:each) do
+      pool.instance_variable_set(:@_out, [MocClient.new,MocClient.new,MocClient.new])
+      pool.instance_variable_set(:@_pool, [MocClient.new,MocClient.new,MocClient.new])
+    end
+
+
+    it "should drain pool" do
+      pool.drain!
+      expect(pool.instance_variable_get(:@_pool).length).to eql(0)
+      expect(pool.instance_variable_get(:@_out).length).to eql(0)
+    end
+  end
+
+  describe '#reset!' do
+    let(:pool) { HotTub::Pool.new(:size => 4, :close => :close) { MocClient.new } }
+    let(:client) { MocClient.new }
+
+    before(:each) do
+      pool.instance_variable_set(:@_out, [client,MocClient.new,MocClient.new])
+      pool.instance_variable_set(:@_pool, [MocClient.new,MocClient.new,MocClient.new])
+    end
+
+    it "should reset pool" do
+      pool.reset!
+      expect(client).to be_closed
+      expect(pool.instance_variable_get(:@_pool).length).to eql(0)
+      expect(pool.instance_variable_get(:@_out).length).to eql(0)
+    end
+  end
+
+  describe '#clean!' do
+    let(:pool) { HotTub::Pool.new(:size => 3, :clean => lambda { |clnt| clnt.clean}) { MocClient.new } }
+
+    it "should clean pool" do
+      pool.instance_variable_set(:@_pool, [MocClient.new,MocClient.new,MocClient.new])
+      expect(pool.instance_variable_get(:@_pool).first).to_not be_cleaned
+      pool.clean!
+      pool.instance_variable_get(:@_pool).each do |clnt|
+        expect(clnt).to be_cleaned
+      end
+    end
+  end
+
+  describe '#shutdown!' do
+    let(:pool) { HotTub::Pool.new(:size => 4) { MocClient.new } }
+
+    it "should kill reaper" do
+      pool.shutdown!
+      sleep(0.01)
+      expect(pool.instance_variable_get(:@reaper)).to be_nil
+    end
+
+    it "should shutdown pool" do
+      pool.instance_variable_set(:@_pool, [MocClient.new,MocClient.new,MocClient.new])
+      pool.shutdown!
+      expect(pool.instance_variable_get(:@_pool).length).to eql(0)
+      expect(pool.send(:_total_current_size)).to eql(0)
+    end
+  end
+
+  describe '#reap!' do
+    it "should clients from the pool" do
+      pool = HotTub::Pool.new({ :size => 1, :close => :close }) { MocClient.new }
+      old_client = MocClient.new
+      pool.instance_variable_set(:@last_activity,(Time.now - 601))
+      pool.instance_variable_set(:@_pool, [old_client, MocClient.new, MocClient.new])
+      pool.reap!
+      expect(pool.current_size).to eql(1)
+      expect(old_client).to be_closed
+    end
+  end
+
+  context 'private methods' do
+    let(:pool) { HotTub::Pool.new { MocClient.new}  }
+
+    describe '#client' do
+      it "should raise HotTub::BlockingTimeout if an available is not found in time"do
+        pool.instance_variable_set(:@non_blocking,false)
+        pool.instance_variable_set(:@wait_timeout, 0.1)
+        allow(pool).to receive(:raise_alarm?).and_return(true)
+        expect { puts pool.send(:pop) }.to raise_error(HotTub::Pool::Timeout)
+      end
+
+      it "should return an instance of the client" do
+        expect(pool.send(:client)).to be_instance_of(MocClient)
+      end
+    end
+
+    describe '#pop' do
+      context "is allowed" do
+        it "should work" do
+          expect(pool.send(:pop)).to be_a(MocClient)
+        end
+      end
+    end
+
+    describe '#push' do
+      context "client is registered" do
+        it "should push client back to pool" do
+          clnt = pool.send(:pop)
+          pool.send(:push,clnt)
+          expect(pool.instance_variable_get(:@_pool).include?(clnt)).to eql(true)
+        end
+      end
+      context "client is not registered" do
+        it "should push client back to pool" do
+          clnt = pool.send(:pop)
+          pool.instance_variable_get(:@_out).delete(clnt)
+          pool.send(:push,clnt)
+          expect(pool.instance_variable_get(:@_pool).include?(clnt)).to eql(false)
+        end
+      end
+      context "client is nil" do
+        it "should not push client back to pool" do
+          pool.send(:push,nil)
+          expect(pool.instance_variable_get(:@_pool).include?(nil)).to eql(false)
+        end
+      end
+    end
+  end
+
+  context 'thread safety' do
+    it "should grow" do
+      pool = HotTub::Pool.new({:size => 4}) { MocClient.new }
+      failed = false
+      expect {
+        threads = []
+        20.times.each do
+          threads << Thread.new do
+            pool.run{|connection| connection.get }
+          end
+        end
+        threads.each do |t|
+          t.join
+        end
+      }.to_not raise_error
+      expect(pool.current_size).to be >= 4
+    end
+  end
+end

data/spec/{reaper_mixin_spec.rb → hot_tub/reaper_mixin_spec.rb}

@@ -1,29 +1,28 @@
 require 'spec_helper'
 describe HotTub::Reaper::Mixin do
-  before(:each) do
-    @pool = MocMixinPool.new
-  end
+  let(:pool) { MocMixinPool.new }
+
   describe '#reaper' do
     it "should be defined" do
-      @pool.should respond_to(:reaper)
+      expect(pool).to respond_to(:reaper)
     end
   end
   describe '#reap_timeout' do
     it "should be defined" do
-      @pool.should respond_to(:reap_timeout)
+      expect(pool).to respond_to(:reap_timeout)
     end
   end
   describe '#shutdown' do
     it "should be defined" do
-      @pool.should respond_to(:shutdown)
+      expect(pool).to respond_to(:shutdown)
     end
   end
   describe '#reap!' do
     it "should be defined" do
-      @pool.should respond_to(:reap!)
+      expect(pool).to respond_to(:reap!)
     end
     it "should raise NoMethodError if called" do
-      lambda {@pool.reap!}.should raise_error(NoMethodError)
+      expect { pool.reap! }.to raise_error(NoMethodError)
     end
   end
 end

data/spec/hot_tub/reaper_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe HotTub::Reaper do
+  
+  let(:pool) { MocReaperPool.new }
+  let(:reaper) { pool.reaper }
+
+  it "should be a HotTub::Reaper Thread" do
+    expect(reaper).to be_a(Thread)
+  end
+
+  it "should reap!" do
+    expect(pool.reaped).to eql(false)
+    pool.lets_reap = true
+    reaper.wakeup
+    sleep(0.01)
+    expect(pool.reaped).to eql(true)
+  end
+
+  it "should sleep after reap!" do
+    expect(pool.reaped).to eql(false)
+    pool.lets_reap = true
+    reaper.wakeup
+    sleep(0.01)
+    expect(reaper.status).to eql('sleep')
+  end
+end

data/spec/hot_tub/sessions_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'hot_tub/sessions'
+require 'uri'
+require 'time'
+describe HotTub::Sessions do
+
+  context 'initialized without a block' do
+    it "should raise error if block is not supplied" do
+      expect { HotTub::Sessions.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'initialized with a block' do
+
+    let(:url) { "https://www.somewebsite.com" }
+    let(:uri) { URI(url) }
+
+    let(:sessions) { HotTub::Sessions.new { |url| MocClient.new(url) } }
+
+
+    describe '#to_url' do
+      context "passed URL string" do
+        it "should return key with URI scheme-domain" do
+          expect(sessions.send(:to_key,url)).to eql("#{uri.scheme}://#{uri.host}:#{uri.port}")
+        end
+      end
+
+      context "passed URI" do
+        it "should return key with URI scheme-domain" do
+          expect(sessions.send(:to_key,uri)).to eql("#{uri.scheme}://#{uri.host}:#{uri.port}")
+        end
+      end
+
+      context "invalid argument" do
+        it "should raise an ArgumentError" do
+          expect { sessions.send(:to_key, nil) }.to raise_error(ArgumentError)
+        end
+        it  "should raise URI::InvalidURIError with bad url" do
+          expect { sessions.send(:to_key,"bad url") }.to raise_error(URI::InvalidURIError)
+        end
+      end
+    end
+
+    describe '#sessions' do
+      context 'HotTub::Pool as client' do
+        it "should add a new client for the url" do
+          with_pool_options = HotTub::Sessions.new { |url| HotTub::Pool.new(:size => 13) { MocClient.new(url) } }
+          with_pool_options.sessions(url)
+          sessions = with_pool_options.instance_variable_get(:@sessions)
+          expect(sessions.size).to eql(1)
+          sessions.each_value {|v| expect(v).to be_a( HotTub::Pool)}
+        end
+      end
+      context "passed URL string" do
+        it "should set key with URI scheme-domain" do
+          sessions.sessions(url)
+          sns = sessions.instance_variable_get(:@sessions)
+          expect(sns["#{uri.scheme}://#{uri.host}:#{uri.port}"]).to be_a(HotTub::Pool)
+        end
+      end
+      context "passed URI" do
+        it "should set key with URI scheme-domain" do
+          sessions.sessions(uri)
+          sns = sessions.instance_variable_get(:@sessions)
+          expect(sns["#{uri.scheme}://#{uri.host}:#{uri.port}"]).to be_a(HotTub::Pool)
+        end
+      end
+    end
+  end
+
+  describe '#run' do
+    it "should pass run to pool" do
+      url = HotTub::Server.url
+      session_with_pool = HotTub::Sessions.new({:with_pool => true})  { |url|
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = false
+        http.start
+        http
+      }
+      result = nil
+      session_with_pool.run(url) do |conn|
+        uri = URI.parse(url)
+        result = conn.get(uri.path).code
+      end
+      expect(result).to eql('200')
+    end
+  end
+
+  describe '#clean!' do
+    it "should clean all pools in sessions" do
+      sessions = HotTub::Sessions.new(:with_pool => true, :clean => lambda { |clnt| clnt.clean}) { |url| MocClient.new(url) }
+      sessions.sessions('foo')
+      sessions.sessions('bar')
+      sessions.clean!
+      sessions.instance_variable_get(:@sessions).each_pair do |k,v|
+        v.instance_variable_get(:@_pool).each do |c|
+          expect(c).to be_cleaned
+        end
+      end
+    end
+  end
+
+  describe '#drain!' do
+    it "should drain all pools in sessions" do
+      sessions = HotTub::Sessions.new(:with_pool => true) { |url| MocClient.new(url) }
+      sessions.sessions('foo')
+      sessions.sessions('bar')
+      sessions.drain!
+      expect(sessions.instance_variable_get(:@sessions)).to_not be_empty
+    end
+  end
+
+  describe '#reap!' do
+    it "should clean all pools in sessions" do
+      sessions = HotTub::Sessions.new(:with_pool => true, :reap => lambda { |clnt| clnt.reap}) { |url| MocClient.new(url) }
+      sessions.sessions('foo')
+      sessions.sessions('bar')
+      sessions.reap!
+      sessions.instance_variable_get(:@sessions).each_pair do |k,v|
+        v.instance_variable_get(:@_pool).each do |c|
+          expect(c).to be_reaped
+        end
+      end
+    end
+  end
+
+  describe '#reset!' do
+    it "should reset all pools in sessions" do
+      sessions = HotTub::Sessions.new(:with_pool => true) { |url| MocClient.new(url) }
+      sessions.sessions('foo')
+      sessions.sessions('bar')
+      sessions.reset!
+      expect(sessions.instance_variable_get(:@sessions)).to be_empty
+    end
+  end
+end

data/spec/hot_tub_spec.rb

@@ -5,14 +5,14 @@ describe HotTub do
     describe '#new' do
 
       it "should return a HotTub::Pool" do
-        (HotTub.new { |url| MocClient.new(url) }).should be_a(HotTub::Pool)
+        expect(HotTub.new { |url| MocClient.new(url) }).to be_a(HotTub::Pool)
       end
 
       context ':sessions => true' do
         it "should be a HotTub::Sessions with HotTub::Pool as client" do
           session_with_pool = HotTub.new(:sessions => true)  { |url| MocClient.new(url) }
           pool = session_with_pool.sessions("http://test.com")
-          pool.should be_a(HotTub::Pool)
+          expect(pool).to be_a(HotTub::Pool)
         end
       end
     end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'helpers/moc_pool'
 require 'helpers/moc_client'
 require 'helpers/server'
 require 'net/https'
+
 unless HotTub.jruby? || HotTub.rbx?
   require 'coveralls'
   Coveralls.wear!
@@ -14,9 +15,8 @@ end
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-HotTub.logger.level = Logger::ERROR
-
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# HotTub.logger = Logger.new(STDOUT)
 RSpec.configure do |config|
   config.before(:suite) do
     HotTub::Server.run

metadata

@@ -1,83 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: hot_tub
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Mckinney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: rspec-autotest
+  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: autotest
+  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: sinatra
   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: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.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'
 description: A dynamic thread-safe pooling gem, when you need more than a standard
@@ -88,14 +116,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/hot_tub.rb
 - hot_tub.gemspec
 - lib/hot_tub.rb
 - lib/hot_tub/known_clients.rb
@@ -106,11 +135,14 @@ files:
 - spec/helpers/moc_client.rb
 - spec/helpers/moc_pool.rb
 - spec/helpers/server.rb
+- spec/hot_tub/integration/excon_spec.rb
+- spec/hot_tub/integration/net_http_spec.rb
+- spec/hot_tub/integration/sessions_spec.rb
+- spec/hot_tub/pool_spec.rb
+- spec/hot_tub/reaper_mixin_spec.rb
+- spec/hot_tub/reaper_spec.rb
+- spec/hot_tub/sessions_spec.rb
 - spec/hot_tub_spec.rb
-- spec/pool_spec.rb
-- spec/reaper_mixin_spec.rb
-- spec/reaper_spec.rb
-- spec/sessions_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/JoshMcKin/hot_tub
 licenses:
@@ -122,17 +154,17 @@ require_paths:
 - lib
 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: hot_tub
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A dynamic thread-safe pooling gem.
@@ -140,9 +172,12 @@ test_files:
 - spec/helpers/moc_client.rb
 - spec/helpers/moc_pool.rb
 - spec/helpers/server.rb
+- spec/hot_tub/integration/excon_spec.rb
+- spec/hot_tub/integration/net_http_spec.rb
+- spec/hot_tub/integration/sessions_spec.rb
+- spec/hot_tub/pool_spec.rb
+- spec/hot_tub/reaper_mixin_spec.rb
+- spec/hot_tub/reaper_spec.rb
+- spec/hot_tub/sessions_spec.rb
 - spec/hot_tub_spec.rb
-- spec/pool_spec.rb
-- spec/reaper_mixin_spec.rb
-- spec/reaper_spec.rb
-- spec/sessions_spec.rb
 - spec/spec_helper.rb