docker_helper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac34d2dde6a799aa2856fcb5fbf115920adc60e6
-  data.tar.gz: 0459f78e45e18567447af1684677ec8e50802413
+  metadata.gz: 281e717d31b942b1d9948fed9d4f652df44dac9b
+  data.tar.gz: e1a79e7764f8cc227f76b70543b0d09c211777c2
 SHA512:
-  metadata.gz: 95ca42aed3756679e9ef409b870330109c94f6f8e99b64864b14dd6579722f19f010907a1d138646bdd9195cf5e7da7d8ad9504096c751160dc39d9148e8d962
-  data.tar.gz: 4f88fd49be93a3ed3d77d20f72dc8c79e4c19e58be6870d6899915ac01b13faa3a3a52ea4b89d9cd355049a2f66282722e900ad5e9eb9eb3d33fca91a5c20fcb
+  metadata.gz: 0e1367bc8d01661f373f7dafbec395e1790ce1c3860d19106b6aa1fcf4900120c2ca69574d34bcfea733dc12a3152976c2ff7238a9df85116edb63d4459505c7
+  data.tar.gz: 86f1aabfa46d791af0462604572a9d4301681842a76dfe91b177750f96e5e445a892de409635f83376bd0693da6913d61dd6f1919307715758165774b5517443

data/ChangeLog

@@ -2,6 +2,12 @@
 
 = Revision history for docker_helper
 
+== 0.0.2 [2014-09-26]
+
+* Added DockerHelper#docker_ready.
+* Added DockerHelper#docker_port.
+* Added DockerHelper::Pool.
+
 == 0.0.1 [2014-08-05]
 
 * First release.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to docker_helper version 0.0.1.
+This documentation refers to docker_helper version 0.0.2.
 
 
 == DESCRIPTION

data/lib/docker_helper.rb

@@ -24,6 +24,8 @@
 ###############################################################################
 #++
 
+require 'net/http'
+
 # Various helper methods to control the Docker command-line client. Main
 # entrance point is the #docker helper. Use ::proxy for a self-contained
 # controller object to call these methods on.
@@ -208,17 +210,45 @@ module DockerHelper
   end
 
   # call-seq:
-  #   docker_url(port, name) -> aString
+  #   docker_port(port, name) -> aString
   #
-  # Returns the HTTP URL for container +name+ on port +port+. Fails
+  # Returns the host and port for container +name+ on port +port+. Fails
   # if container is not running or the specified port is not exposed.
   #
   # Command reference: {docker port
   # }[https://docs.docker.com/reference/commandline/cli/#port]
-  def docker_url(port, name = nil)
+  def docker_port(port, name = nil)
     name ||= docker_container_name
 
-    "http://#{docker(:port, name, port)}"
+    docker :port, name, port
+  end
+
+  # call-seq:
+  #   docker_url(port, name) -> aString
+  #
+  # Returns the HTTP URL for container +name+ on port +port+ (see
+  # #docker_port).
+  def docker_url(port, name = nil)
+    "http://#{docker_port(port, name)}"
+  end
+
+  # call-seq:
+  #   docker_ready(host_with_port[, path]) -> true or false
+  #
+  # Argument +host_with_port+ must be of the form <tt>host:port</tt>, as
+  # returned by #docker_port, or an array of host and port.
+  #
+  # Returns +true+ if and when the TCP port is available on the host and,
+  # if +path+ is given, a HTTP request for +path+ is successful.
+  #
+  # Returns +false+ if the port and the path haven't become available after
+  # 30 attempts each. Sleeps for 0.1 seconds inbetween attempts.
+  def docker_ready(host_with_port, path = nil, attempts = 30, sleep = 0.1)
+    host, port = host_with_port.is_a?(Array) ?
+      host_with_port : host_with_port.split(':')
+
+    docker_socket_ready(host, port, attempts, sleep) &&
+      (!path || docker_http_ready(host, port, path, attempts, sleep))
   end
 
   # call-seq:
@@ -355,7 +385,38 @@ module DockerHelper
     abort
   end
 
+  # Checks TCP connection.
+  def docker_socket_ready(host, port, attempts, sleep)
+    TCPSocket.new(host, port).close
+    true
+  rescue Errno::ECONNREFUSED
+    return false unless docker_ready_sleep(sleep, attempts -= 1)
+    retry
+  end
+
+  # Checks HTTP connection.
+  def docker_http_ready(host, port, path, attempts, sleep)
+    loop {
+      begin
+        break if Net::HTTP.get_response(host, path, port).is_a?(Net::HTTPSuccess)
+      rescue Errno::ECONNRESET, EOFError => err
+        return false unless docker_ready_sleep(sleep, attempts -= 1)
+        retry
+      end
+
+      return false unless docker_ready_sleep(sleep, attempts -= 1)
+    }
+
+    true
+  end
+
+  # Sleeps unless out of attempts.
+  def docker_ready_sleep(sleep, attempts)
+    sleep(sleep) unless attempts.zero?
+  end
+
 end
 
 require_relative 'docker_helper/version'
 require_relative 'docker_helper/proxy'
+require_relative 'docker_helper/pool'

data/lib/docker_helper/pool.rb

@@ -0,0 +1,103 @@
+#--
+###############################################################################
+#                                                                             #
+# docker_helper -- Helper methods to interact with Docker                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# docker_helper is free software; you can redistribute it and/or modify it    #
+# under the terms of the GNU Affero General Public License as published by    #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# docker_helper is distributed in the hope that it will be useful, but        #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with docker_helper. If not, see <http://www.gnu.org/licenses/>.       #
+#                                                                             #
+###############################################################################
+#++
+
+module DockerHelper
+
+  class Pool
+
+    DEFAULT_SIZE = 2
+
+    DEFAULT_BASENAME = 'docker_helper'
+
+    def initialize(size = nil, basename = nil, docker = nil)
+      @docker, @previous_name, @basename =
+        docker ||= DockerHelper.proxy, nil,
+        basename ||= self.class::DEFAULT_BASENAME
+
+      yield self if block_given?
+
+      @pool = Array.new(size ||= self.class::DEFAULT_SIZE) { |i|
+        spawn_thread("#{basename}-#{$$}-#{i}")
+      }
+
+      extend(SinglePool) if size == 1
+    end
+
+    attr_accessor :image, :port, :path
+
+    def fetch_url(name = @previous_name)
+      docker.url(port, @previous_name = fetch(name)) + path.to_s
+    end
+
+    def fetch(name = @previous_name)
+      pool.shift.tap { reclaim(name) }.value
+    end
+
+    def clean(name = @previous_name)
+      pool.map { |t| clean_thread(t.value) }.tap { |clean|
+        clean << clean_thread(name) if name
+      }.each(&:join)
+    end
+
+    def inspect
+      '#<%s:0x%x %s@%d>' % [self.class, object_id, basename, pool.size]
+    end
+
+    private
+
+    attr_reader :docker, :basename, :pool
+
+    def spawn_thread(name, clean = false)
+      Thread.new {
+        docker.clean(name) if clean
+        docker.start(name, image) if image
+        docker.ready(docker.port(port, name), path) if port
+
+        name
+      }
+    end
+
+    def clean_thread(name)
+      Thread.new { docker.clean(name) }
+    end
+
+    def reclaim(name)
+      pool << spawn_thread(name, true) if name
+    end
+
+    module SinglePool
+
+      def fetch(name = @previous_name)
+        name || !block_given? ? super : yield(new_name = super)
+      ensure
+        reclaim(new_name)
+      end
+
+    end
+
+  end
+
+end

data/lib/docker_helper/proxy.rb

@@ -31,8 +31,10 @@ module DockerHelper
 
   class Proxy
 
-    def initialize(prefix = 'docker')
-      self.proxy_prefix = prefix
+    DEFAULT_PREFIX = 'docker'
+
+    def initialize(prefix = nil)
+      self.proxy_prefix = prefix || self.class::DEFAULT_PREFIX
     end
 
     attr_accessor :proxy_prefix
@@ -46,6 +48,10 @@ module DockerHelper
       respond_to?(prefix_method(method))
     end
 
+    def pool(size = nil, basename = nil, &block)
+      Pool.new(size, basename, self, &block)
+    end
+
     private
 
     def prefix_method(method)

data/lib/docker_helper/version.rb

@@ -4,7 +4,7 @@ module DockerHelper
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     class << self
 

data/spec/docker_helper_spec.rb

@@ -44,6 +44,15 @@ quix                             1.0                 789                 a week
 
   end
 
+  describe '#port' do
+
+    it 'should return the port' do
+      expect_pipe('0.0.0.0:42', 'port', 'foo', '23', {})
+      expect(subject.docker_port(23, 'foo')).to eq('0.0.0.0:42')
+    end
+
+  end
+
   describe '#url' do
 
     it 'should return the URL' do
@@ -53,6 +62,128 @@ quix                             1.0                 789                 a week
 
   end
 
+  describe '#ready' do
+
+    def expect_socket(result)
+      expect(subject).to receive(:docker_socket_ready).with(
+        *@host_with_port_ary, a_kind_of(Integer), a_kind_of(Float)
+      ).and_return(result)
+    end
+
+    def expect_http(result)
+      expect(subject).to receive(:docker_http_ready).with(
+        *@host_with_port_ary, @path, a_kind_of(Integer), a_kind_of(Float)
+      ).and_return(result)
+    end
+
+    before do
+      @host_with_port_str = '0.0.0.0:42'
+      @host_with_port_ary = @host_with_port_str.split(':')
+    end
+
+    describe 'when socket ready' do
+
+      before do
+        expect_socket(true)
+      end
+
+      describe 'without path' do
+
+        before do
+          expect(subject).not_to receive(:docker_http_ready)
+        end
+
+        it 'should return true with string' do
+          expect(subject.docker_ready(@host_with_port_str)).to eq(true)
+        end
+
+        it 'should return true with array' do
+          expect(subject.docker_ready(@host_with_port_ary)).to eq(true)
+        end
+
+      end
+
+      describe 'with path' do
+
+        before do
+          @path = '/path'
+        end
+
+        describe 'when HTTP ready' do
+
+          before do
+            expect_http(true)
+          end
+
+          it 'should return true with string' do
+            expect(subject.docker_ready(@host_with_port_str, @path)).to eq(true)
+          end
+
+          it 'should return true with array' do
+            expect(subject.docker_ready(@host_with_port_ary, @path)).to eq(true)
+          end
+
+        end
+
+        describe 'when HTTP not ready' do
+
+          before do
+            expect_http(false)
+          end
+
+          it 'should return false with string' do
+            expect(subject.docker_ready(@host_with_port_str, @path)).to eq(false)
+          end
+
+          it 'should return false with array' do
+            expect(subject.docker_ready(@host_with_port_ary, @path)).to eq(false)
+          end
+
+        end
+
+      end
+
+    end
+
+    describe 'when socket ready' do
+
+      before do
+        expect_socket(false)
+        expect(subject).not_to receive(:docker_http_ready)
+      end
+
+      describe 'without path' do
+
+        it 'should return false with string' do
+          expect(subject.docker_ready(@host_with_port_str)).to eq(false)
+        end
+
+        it 'should return false with array' do
+          expect(subject.docker_ready(@host_with_port_ary)).to eq(false)
+        end
+
+      end
+
+      describe 'with path' do
+
+        before do
+          @path = '/path'
+        end
+
+        it 'should return false with string' do
+          expect(subject.docker_ready(@host_with_port_str, @path)).to eq(false)
+        end
+
+        it 'should return false with array' do
+          expect(subject.docker_ready(@host_with_port_ary, @path)).to eq(false)
+        end
+
+      end
+
+    end
+
+  end
+
   describe '#start' do
 
     it 'should start the container' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hen
@@ -66,6 +66,7 @@ files:
 - README
 - Rakefile
 - lib/docker_helper.rb
+- lib/docker_helper/pool.rb
 - lib/docker_helper/proxy.rb
 - lib/docker_helper/version.rb
 - spec/docker_helper_spec.rb
@@ -76,13 +77,15 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  docker_helper-0.0.1 [2014-08-05]:
+  docker_helper-0.0.2 [2014-09-26]:
 
-  * First release.
+  * Added DockerHelper#docker_ready.
+  * Added DockerHelper#docker_port.
+  * Added DockerHelper::Pool.
 
 rdoc_options:
 - "--title"
-- docker_helper Application documentation (v0.0.1)
+- docker_helper Application documentation (v0.0.2)
 - "--charset"
 - UTF-8
 - "--line-numbers"