waitutil 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.1.1

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private --protected lib/**/*.rb -m markdown - README.md
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+## waitutil
+
+[![Build Status](https://travis-ci.org/mbautin/waitutil.png?branch=master)](https://travis-ci.org/mbautin/waitutil)
+
+`waitutil` provides tools for waiting for various conditions to occur, with a configurable
+delay time, timeout, and logging.
+
+### Examples
+
+#### 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:
+```ruby
+WaitUtil.wait_for_condition("my_event to happen", :timeout_sec => 30, :delay_sec => 0.5) do
+  check_if_my_event_happened
+end
+```
+
+#### Waiting for service availability
+
+Wait for a TCP server to be available:
+```ruby
+WaitUtil.wait_for_service('example.com', 8080)
+```
+
+### License
+
+[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

data/Rakefile

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+require 'rubygems/tasks'
+
+CLEAN.include("**/*.gem")
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/waitutil/version.rb

@@ -0,0 +1,3 @@
+module WaitUtil
+  VERSION = IO.read(File.expand_path("../../../VERSION", __FILE__))
+end

data/lib/waitutil.rb

@@ -0,0 +1,78 @@
+require 'logger'
+
+module WaitUtil
+
+  extend self
+
+  class TimeoutError < StandardError
+  end
+
+  DEFAULT_TIMEOUT_SEC = 60
+  DEFAULT_DELAY_SEC = 1
+
+  @@logger = Logger.new(STDOUT)
+  @@logger.level = Logger::INFO
+
+  def self.logger
+    @@logger
+  end
+
+  # Wait until the condition computed by the given block is met. The supplied block may return a
+  # boolean or an array of two elements: whether the condition has been met and an additional
+  # message to display in case of timeout.
+  def wait_for_condition(description, options = {}, &block)
+    delay_sec = options.delete(:delay_sec) || DEFAULT_DELAY_SEC
+    timeout_sec = options.delete(:timeout_sec) || DEFAULT_TIMEOUT_SEC
+    verbose = options.delete(:verbose)
+    unless options.empty?
+      raise "Invalid options: #{options}"
+    end
+
+    if verbose
+      @@logger.info("Waiting for #{description} for up to #{timeout_sec} seconds")
+    end
+
+    start_time = Time.now
+    iteration = 0
+    until is_condition_met(condition_result = yield(iteration))
+      if Time.now - 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)
+      iteration += 1
+    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.
+  def wait_for_service(description, host, port, options = {})
+    wait_for_condition("#{description} port #{port} to become available on #{host}",
+                       options) do
+      begin
+        s = TCPSocket.new(host, port)
+        s.close
+        true
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+        false
+      end
+    end
+  end
+
+  private
+
+  def is_condition_met(condition_result)
+    condition_result.kind_of?(Array) ? condition_result[0] : condition_result
+  end
+
+  def get_additional_message(condition_result)
+    condition_result.kind_of?(Array) ? ': ' + condition_result[1] : ''
+  end
+
+  extend WaitUtil
+end

data/spec/waitutil_spec.rb

@@ -0,0 +1,135 @@
+require 'waitutil'
+require 'socket'
+
+RSpec.configure do |configuration|
+  configuration.include WaitUtil
+end
+
+describe WaitUtil do
+  describe '.wait_for_condition' do
+    it 'logs if the verbose option is specified' do
+      iterations = []
+      WaitUtil.logger.should_receive(:info).with('Waiting for true for up to 60 seconds')
+      WaitUtil.logger.should_receive(:info) do |msg|
+        msg =~ /^Success waiting for true \(.*\)$/
+      end
+
+      ret = wait_for_condition('true', :verbose => true) do |iteration|
+        iterations << iteration
+        true
+      end
+      expect(ret).to be_true
+      expect(iterations).to eq([0])
+    end
+
+    it 'returns immediately if the condition is true' do
+      iterations = []
+      ret = wait_for_condition('true') {|iteration| iterations << iteration; true }
+      expect(ret).to be_true
+      expect(iterations).to eq([0])
+    end
+
+    it 'should time out if the condition is always false' do
+      iterations = []
+      start_time = Time.now
+      begin
+        wait_for_condition('false', :timeout_sec => 0.1, :delay_sec => 0.01) do |iteration|
+          iterations << iteration
+          false
+        end
+        fail 'Expected an exception'
+      rescue WaitUtil::TimeoutError => ex
+        expect(ex.to_s).to match(/^Timed out waiting for false /)
+      end
+      elapsed_sec = Time.now - start_time
+      expect(elapsed_sec).to be >= 0.1
+      expect(iterations.length).to be >= 9
+      expect(iterations.length).to be <= 11
+      expect(iterations).to eq((0..iterations.length - 1).to_a)
+    end
+
+    it 'should handle additional messages from the block' do
+      begin
+        wait_for_condition('false', :timeout_sec => 0.01, :delay_sec => 0.05) do |iteration|
+          [false, 'Some error']
+        end
+        fail 'Expected an exception'
+      rescue WaitUtil::TimeoutError => ex
+        expect(ex.to_s).to match(/^Timed out waiting for false (.*): Some error$/)
+      end
+    end
+
+    it 'should treat the first element of returned tuple as condition status' do
+      iterations = []
+      ret = wait_for_condition('some condition', :timeout_sec => 1, :delay_sec => 0) do |iteration|
+        iterations << iteration
+        [iteration >= 3, 'some message']
+      end
+      expect(ret).to be_true
+      expect(iterations).to eq([0, 1, 2, 3])
+    end
+
+    it 'should evaluate the block return value as a boolean if it is not an array' do
+      iterations = []
+      ret = wait_for_condition('some condition', :timeout_sec => 1, :delay_sec => 0) do |iteration|
+        iterations << iteration
+        iteration >= 3
+      end
+      expect(ret).to be_true
+      expect(iterations).to eq([0, 1, 2, 3])
+    end
+  end
+
+  describe '.wait_for_service' do
+    BIND_IP = '127.0.0.1'
+
+    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")
+      else
+        Addrinfo.tcp(BIND_IP, 0)
+      end
+      socket.bind(sockaddr)
+      port = socket.local_address.ip_port
+      socket.close
+
+      server_thread = Thread.new do
+        server = TCPServer.new(port)
+        loop do
+          client = server.accept  # Wait for a client to connect
+          client.puts "Hello !"
+          client.close
+          break
+        end
+      end
+
+      wait_for_service('wait for my service', BIND_IP, port, :delay_sec => 0.1, :timeout_sec => 0.3)
+    end
+
+    it 'should fail when there is no TCP server listening' do
+      port = nil
+      # Find a port that no one is listening on.
+      attempts = 0
+      while attempts < 100
+        port = 32768 + rand(61000 - 32768)
+        begin
+          TCPSocket.new(BIND_IP, port)
+          port = nil
+        rescue Errno::ECONNREFUSED
+          break
+        end
+        attempts += 1
+      end
+      fail 'Could not find a port no one is listening on' unless port
+
+      expect {
+        wait_for_service(
+          'wait for non-existent service', BIND_IP, port, :delay_sec => 0.1, :timeout_sec => 0.3
+        )
+      }.to raise_error(WaitUtil::TimeoutError)
+    end
+
+  end
+end

data/waitutil.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+GEM_NAME = 'waitutil'
+
+require File.expand_path("../lib/#{GEM_NAME}/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Mikhail Bautin']
+  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.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n").map(&:strip)
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = GEM_NAME
+  gem.require_paths = ['lib']
+  gem.version       = WaitUtil::VERSION
+
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_development_dependency 'webrick'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: waitutil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikhail Bautin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: Utilities for waiting for various conditions
+email:
+- mbautin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- lib/waitutil.rb
+- lib/waitutil/version.rb
+- spec/Rakefile
+- spec/waitutil_spec.rb
+- waitutil.gemspec
+homepage: http://github.com/mbautin/waitutil
+licenses: []
+metadata: {}
+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: 
+specification_version: 4
+summary: Utilities for waiting for various conditions
+test_files:
+- spec/Rakefile
+- spec/waitutil_spec.rb