waitutil 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjhlODkyZTdjOTQwNjVjNTFmZGMzYjkwYjdkNWRjOWZlZWM1NzQ3Mw==
-  data.tar.gz: !binary |-
-    ZTc0Y2RlYTM5MjZmZjI2YjIxMmYzNDZmY2U4OGJmYzljOTljNzljZQ==
+SHA1:
+  metadata.gz: 0f139cee6a8804a8beddc4adb4adfe9cf1c2e8d8
+  data.tar.gz: ef6a331a094e72d2b7b877a75d1cd38ff6962c1e
 SHA512:
-  metadata.gz: !binary |-
-    NDhkZWMzZWE1MDEyMDYxYmNjNTZhMDBlNDIxYjkwOWU4ZWM4NjBiOWRiMWVj
-    MjU2YjNmZWRlMjFjZGIxY2Y5YWRmMDhlZDQyY2ZmNmU1MDJlZmQxNDRkMDBk
-    N2IyM2Y0N2JiNmYyYTBjYmNmNGUzYmJlZDY5OGEyNmE0ZTA5ZWE=
-  data.tar.gz: !binary |-
-    NDM4N2Q3YTMxZGEwNmIwMzdlZDViYWZkOWQ3ODM3ODk2NDM1ODIwNjRkYzRh
-    NmFkMjIxODkyODQwNDlkOTYxNDgwZmI1MmM3YThhYjdhN2M3NzhhYTIxNDAw
-    NjYyYjkzOGUyOWFkMWU2NmViMjI4ODQ2MjcyODc5ZGJmOGMyMzE=
+  metadata.gz: 2af4abd0f7f6f8b115cf6dd6058bb93496dbd686eba63530106d84c9a571420709339220c9e2857dca00f4af4b2a111b59ece159a4288ea46cd98cfcfd23ee9b
+  data.tar.gz: 2e437fd465f552294ad4698359d58e24c15d2970215a7e24224acd7f4512684cd7578654d1658ac909bc85ae65c941fc9a2d2efbdc67da317576dcf3324e68c3

data/.gitignore

@@ -26,3 +26,5 @@ Gemfile.lock
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
+/.idea
+*.iml

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 2.0.0
   - 2.1.0
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-2.1.1
+  # TODO: resolve issues and re-enable:
+  #- rbx-2.1.1

data/README.md

@@ -1,33 +1,78 @@
 ## waitutil
 
-[![Build Status](https://travis-ci.org/mbautin/waitutil.png?branch=master)](https://travis-ci.org/mbautin/waitutil)
+[![Build Status](https://travis-ci.org/rubytools/waitutil.png?branch=master)](https://travis-ci.org/rubytools/waitutil)
 
 `waitutil` provides tools for waiting for various conditions to occur, with a configurable
 delay time, timeout, and logging.
 
+GitHub: https://github.com/rubytools/waitutil
+
+RubyGems: http://rubygems.org/gems/waitutil
+
+Documentation: http://rubytools.github.io/waitutil/
+
 ### Examples
 
+Wait methods take a block that returns `true` or `false`.
+
 #### Waiting for conditions
 
 Maximum wait time is one minute by default, and the delay time is one second.
+
 ```ruby
 WaitUtil.wait_for_condition("my_event to happen") do
   check_if_my_event_happened
 end
 ```
 
-Customized wait time and delay time:
+##### Customized wait time and delay time
+
 ```ruby
 WaitUtil.wait_for_condition("my_event to happen", :timeout_sec => 30, :delay_sec => 0.5) do
   check_if_my_event_happened
 end
 ```
 
+##### Verbose logging
+
+```ruby
+WaitUtil.wait_for_condition('my event', :verbose => true) { sleep(1) }
+```
+
+Output:
+
+```
+I, [2014-02-16T00:34:31.511915 #15897]  INFO -- : Waiting for my event for up to 60 seconds
+I, [2014-02-16T00:34:32.512223 #15897]  INFO -- : Success waiting for my event (1.000153273 seconds)
+```
+
+##### Returning additional information for the timeout log message
+
+```ruby
+attempt = 1
+WaitUtil.wait_for_condition('my event', :verbose => true, :timeout_sec => 3, :delay_sec => 1) do
+  sleep(1)
+  attempt += 1
+  [false, "attempt #{attempt}"]  # the second element goes into the log message
+end
+```
+
+Output:
+
+```
+I, [2014-02-16T00:46:53.647936 #17252]  INFO -- : Waiting for my event for up to 3 seconds
+WaitUtil::TimeoutError: Timed out waiting for my event (3 seconds elapsed): attempt 3
+        from /home/mbautin/.rvm/gems/ruby-2.1.0/gems/waitutil-0.1.0/lib/waitutil.rb:39:in `wait_for_condition'
+        from (irb):9
+        from /home/mbautin/.rvm/rubies/ruby-2.1.0/bin/irb:11:in `<main>'
+```
+
 #### Waiting for service availability
 
-Wait for a TCP server to be available:
+Wait for a TCP server to be available using [wait_for_service](http://rubytools.github.io/waitutil/WaitUtil.html#wait_for_service-instance_method):
+
 ```ruby
-WaitUtil.wait_for_service('example.com', 8080)
+WaitUtil.wait_for_service('my service', 'example.com', 80)
 ```
 
 ### License

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/waitutil.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'socket'
 
 module WaitUtil
 
@@ -33,32 +34,43 @@ module WaitUtil
     end
 
     start_time = Time.now
+    stop_time = start_time + timeout_sec
     iteration = 0
+
+    # Time when we started to evaluate the condition.
+    condition_eval_start_time = start_time
+
     until is_condition_met(condition_result = yield(iteration))
-      if Time.now - start_time >= timeout_sec
+      current_time = Time.now
+      if current_time - start_time >= timeout_sec
         raise TimeoutError.new(
           "Timed out waiting for #{description} (#{timeout_sec} seconds elapsed)" +
           get_additional_message(condition_result)
         )
       end
-      sleep(delay_sec)
+
+      # The condition evaluation function might have taken some time, so we subtract that time
+      # from the time we have to wait.
+      sleep_time_sec = condition_eval_start_time + delay_sec - current_time
+      sleep(sleep_time_sec) if sleep_time_sec > 0
+
       iteration += 1
+      condition_eval_start_time = Time.now  # we will evaluate the condition again immediately
     end
+
     if verbose
       @@logger.info("Success waiting for #{description} (#{Time.now - start_time} seconds)")
     end
     true
   end
 
-  # Wait until a service is available at the given host/port.
+  # Wait until a TCP service is available at the given host/port.
   def wait_for_service(description, host, port, options = {})
-    wait_for_condition("#{description} port #{port} to become available on #{host}",
+    wait_for_condition("#{description} to become available on #{host}, port #{port}",
                        options) do
       begin
-        s = TCPSocket.new(host, port)
-        s.close
-        true
-      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+        is_tcp_port_open(host, port, options[:delay_sec] || DEFAULT_DELAY_SEC)
+      rescue SocketError
         false
       end
     end
@@ -74,5 +86,56 @@ module WaitUtil
     condition_result.kind_of?(Array) ? ': ' + condition_result[1] : ''
   end
 
+  # Check if the given TCP port is open on the given port with a timeout.
+  def is_tcp_port_open(host, port, timeout_sec = nil)
+    if RUBY_PLATFORM == 'java'
+      # Unfortunately, our select-based approach does not work on JRuby.
+      begin
+        s = TCPSocket.new(host, port)
+        s.close
+        true
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+        false
+      end
+    else
+      addr_info = begin
+        Socket.getaddrinfo(host, port)
+      rescue SocketError
+        return false
+      end.select {|item| item[0] == 'AF_INET' }
+
+      return false if addr_info.empty?
+
+      socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+      ip_addr = addr_info[0][3]
+      sockaddr = Socket.sockaddr_in(port, ip_addr)
+      result = begin
+        begin
+          socket.connect_nonblock(sockaddr)
+          true
+        rescue Errno::EAFNOSUPPORT
+          @@logger.error("Address family not supported for #{ip_addr}")
+          false
+        end
+      rescue Errno::EINPROGRESS
+        reader, writer, error = IO.select([socket], [socket], [socket], timeout_sec)
+        if writer.nil? || writer.empty?
+          false
+        else
+          # Sometimes we have to write some data to the socket to find out whether we are really
+          # connected.
+          begin
+            writer[0].write_nonblock("\x0")
+            true
+          rescue Errno::ECONNREFUSED
+            false
+          end
+        end
+      end
+      socket.close
+      result
+    end
+  end
+
   extend WaitUtil
 end

data/spec/waitutil_spec.rb

@@ -83,13 +83,55 @@ describe WaitUtil do
   describe '.wait_for_service' do
     BIND_IP = '127.0.0.1'
 
+    it 'waits for service availability' do
+      WaitUtil.wait_for_service('Google', 'google.com', 80, :timeout_sec => 0.5)
+    end
+
+    it 'times out when host name does not exist' do
+      begin
+        WaitUtil.wait_for_service(
+          'non-existent service',
+          'nosuchhost_waitutil_ruby_module.com',
+          12345,
+          :timeout_sec => 0.2,
+          :delay_sec => 0.1
+        )
+        fail("Expecting WaitUtil::TimeoutError but nothing was raised")
+      rescue WaitUtil::TimeoutError => ex
+        expect(ex.to_s.gsub(/ \(.*/, '')).to eq(
+          'Timed out waiting for non-existent service to become available on ' \
+          'nosuchhost_waitutil_ruby_module.com, port 12345'
+        )
+      end
+    end
+
+    if RUBY_PLATFORM != 'java'
+      # Our current implementation will get stuck on this if running JRuby.
+      it 'times out when port is closed' do
+        begin
+          WaitUtil.wait_for_service(
+            'wrong port on Google',
+            'google.com',
+            12345,
+            :timeout_sec => 0.2,
+            :delay_sec => 0.1
+          )
+        rescue WaitUtil::TimeoutError => ex
+          expect(ex.to_s.gsub(/ \(.*/, '')).to eq(
+            'Timed out waiting for wrong port on Google to become available on google.com, ' \
+            'port 12345'
+          )
+        end
+      end
+    end
+
     it 'should succeed immediately when there is a TCP server listening' do
       # Find an unused port.
       socket = Socket.new(:INET, :STREAM, 0)
       sockaddr = if RUBY_ENGINE == 'jruby'
-        ServerSocket.pack_sockaddr_in(12345, "127.0.0.1")
+        ServerSocket.pack_sockaddr_in(0, "127.0.0.1")
       else
-        Addrinfo.tcp(BIND_IP, 0)
+        Socket.pack_sockaddr_in(0, "127.0.0.1")
       end
       socket.bind(sockaddr)
       port = socket.local_address.ip_port
@@ -130,6 +172,6 @@ describe WaitUtil do
         )
       }.to raise_error(WaitUtil::TimeoutError)
     end
-
   end
+
 end

data/waitutil.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['mbautin@gmail.com']
   gem.description   = 'Utilities for waiting for various conditions'
   gem.summary       = 'Utilities for waiting for various conditions'
-  gem.homepage      = "http://github.com/mbautin/#{GEM_NAME}"
+  gem.homepage      = "http://github.com/rubytools/#{GEM_NAME}"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n").map(&:strip)

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: waitutil
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mikhail Bautin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: webrick
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 description: Utilities for waiting for various conditions
 email:
 - mbautin@gmail.com
@@ -85,29 +85,27 @@ files:
 - spec/Rakefile
 - spec/waitutil_spec.rb
 - waitutil.gemspec
-homepage: http://github.com/mbautin/waitutil
+homepage: http://github.com/rubytools/waitutil
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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: 
-rubygems_version: 2.1.11
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
 specification_version: 4
 summary: Utilities for waiting for various conditions
-test_files:
-- spec/Rakefile
-- spec/waitutil_spec.rb
+test_files: []