govdelivery-proctor 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce8d79f6531e5607f2cc402de70da89aa6c961a
+  data.tar.gz: cc01c5f9d058db7f0aacff5ecffa1141417dac37
+SHA512:
+  metadata.gz: 1047b2266805be8100f8d365a36952e4a91afb18dac09a15a84c9563094971fbf3ace15ff6b5a0823aa0340c62eaf72a0f98f180e2c91392f016d3258e40cdd6
+  data.tar.gz: 75b16d48140304a9cab0cf1343b2f153cda23bd7ca0ee77a02ecd5d901fade3c8b3ba8be2269aae0ca67aba32400bf5247f255c70d8b1ae2ef8c267946f1391f

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+[How to use a CHANGELOG](http://keepachangelog.com/)
+## [1.3.0]
+### Added
+- Say hello to steady_check which sleeps for the increment passed to it
+### Fixed
+- accelerating_check algorithm was messed up, so now using `log` to better approximate reverse of backoff_check
+## [1.2.1]
+### Fixed
+- backoff_check and accelerating_check now reset the logger when finished.
+- Corrected README documentation about accelerating_check
+## [1.2.0]
+### Added
+- reverse backoff added for situations when the likelihood of the condition being true increases over time
+## [1.1.1]
+### Fixed
+- Removed references to the `colored` gem, which was never required, or that useful
+## [1.1.0]
+### Updated
+- backoff_check to only log out on failure.
+## [1.0.0] - 2016-03-21
+### Added
+- backoff_check, log, and suppress class methods on GovDelivery::Proctor

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    govdelivery-proctor (1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.5)
+    coderay (1.1.1)
+    method_source (0.8.2)
+    power_assert (0.3.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    slop (3.6.0)
+    test-unit (3.2.1)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  govdelivery-proctor!
+  pry-byebug (~> 3.4)
+  test-unit
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,93 @@
+Proctor
+===========
+
+Classes and functions to support feature testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'govdelivery-proctor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install govdelivery-proctor
+
+## Usage
+
+Include it: `require 'govdelivery-proctor'`
+
+### backoff_check
+
+`GovDelivery::Proctor.backoff_check` will run a provided block, over and over
+with longer and longer waits between runs, until the provided block either
+returns a truthy value or exceeds a provided max time to wait. At the end
+of each unsuccessful run - a run that does not return a truthy value - a
+message will be written to the log based on the provided message string.
+
+```
+tomorrow = Time.new.day + 1.day
+GovDelivery::Proctor.backoff_check(24.hours, "Waiting for tomorrow") do
+  Time.new.day == tomorrow
+end
+```
+
+### accelerating_check
+
+`GovDelivery::Proctor.accelerating_check` will run a provided block, over and over
+with shorter and shorter waits between runs, until the provided block either
+returns a truthy value or exceeds a provided max time to wait. At the end
+of each unsuccessful run - a run that does not return a truthy value - a
+message will be written to the log based on the provided message string.
+
+### steady_check
+
+`GovDelivery::Proctor.steady_check` will run a provided block, over and over
+with the specified wait between every run, until the provided block either
+returns a truthy value or exceeds a provided max time to wait. At the end
+of each unsuccessful run - a run that does not return a truthy value - a
+message will be written to the log based on the provided message string.
+
+### log
+
+Returns a logger object for logging/outputing. By default, this logger object
+will print to `STDOUT` and have a level of `INFO`. These can be set via the
+environment variables `TEST_LOG_FILE` and `TEST_LOG_LEVEL` respectively.
+
+```
+GovDelivery::Proctor.log.info('Nothing is real') unless 1 == 1
+```
+
+### suppress
+
+Runs a provided block and ignores if a specified exception is thrown.
+
+```
+GovDelivery::Proctor.suppress(ZeroDivisionError) do
+  1/0
+  puts 'Nothing wrong here'
+end
+```
+
+## Development
+### Get Dev Dependencies
+
+   $ bundle install
+
+### Build
+
+   $ gem build proctor.gemspec
+
+### Install locally
+
+   $ gem install govdelivery-proctor-1.2.0.gem
+
+### Test
+
+   $ rake test

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/govdelivery-proctor.rb

@@ -0,0 +1,6 @@
+module GovDelivery
+  module Proctor #:nodoc:
+  end
+end
+
+require 'govdelivery/proctor/base'

data/lib/govdelivery/proctor/base.rb

@@ -0,0 +1,109 @@
+module GovDelivery::Proctor
+  class CheckTimeExceeded < StandardError; end
+
+  def self.backoff_check(limit, desc = 'Backoff check', inc = 1)
+    raise 'Check requires a block' unless block_given?
+    check(limit, 'backoff', desc, inc) do
+      yield
+    end
+  end
+
+  # Sometimes you want to reverse backoff because as time
+  # passes it is more likely your condition is true
+  def self.accelerating_check(limit, desc = 'Backon check', inc = 1)
+    raise 'Check requires a block' unless block_given?
+    check(limit, 'accelerate', desc, inc) do
+      yield
+    end
+  end
+
+  def self.steady_check(limit, desc = 'Steady check', inc = 1)
+    raise 'Check requires a block' unless block_given?
+    check(limit, 'steady', desc, inc) do
+      yield
+    end
+  end
+
+  # if backoff, double the wait time each time
+  # if accelerating, ramp up after long pause
+  # if steady, just keep it steady
+  def self.sleep_time(check_type, limit, increment, iteration)
+    case check_type
+    when 'steady'
+      increment
+    when 'backoff'
+      (2**iteration) * increment
+    when 'accelerate'
+      val = Math.log(limit, iteration + 1)
+      val = val.to_f.infinite? ? limit / increment : val
+      val = val.to_f.nan? ? 1 : val.round
+      [increment, val * increment].max
+    else
+      raise "Check type #{check_type} invalid: choose backon, accelerate or steady."
+    end
+  end
+
+  def self.check(limit, check_type, desc, inc)
+    setup
+
+    slept_time = 0
+    x = 0
+    response = nil
+    Kernel.loop do
+      sleep_time = sleep_time(check_type, limit, inc, ++x)
+      sleep(sleep_time)
+      slept_time += sleep_time
+      response = yield
+      break if response
+      if slept_time >= limit
+        fail_message = "#{desc} has taken too long. Have waited #{slept_time} seconds\nlog: #{@backBuffer.string}"
+        raise CheckTimeExceeded, fail_message
+      end
+      # We're doing this twice, once for standard out so you can see it's still
+      # working, and then again inside the logged output if it fails.
+
+      getStandardLogger.info("Still waiting while #{desc}, current time=#{slept_time}")
+      log.info("Still waiting while #{desc}, current time=#{slept_time}")
+    end
+    teardown
+    response
+  end
+
+  def self.log
+    getStandardLogger
+  end
+
+  def self.suppress(*exception_classes)
+    yield
+  rescue *exception_classes
+  end
+
+  def self.getStandardLogger
+    @log ||= begin
+      logger = Logger.new(ENV['TEST_LOG_FILE'] || STDOUT)
+      logger.level = Logger.const_get(ENV['TEST_LOG_LEVEL'] || 'INFO')
+      logger
+    end
+  end
+
+  def self.setup
+    @backBuffer = StringIO.new
+    @backLog = Logger.new @backBuffer
+
+    # We're re-defining log in here so that we can log meaningful information
+    # out during the backoff check, but only for failed runs.
+    def self.log
+      @backLog
+    end
+  end
+
+  def self.teardown
+    # We have to re-define log back to it's original implementation
+    # so that we get normal logging after we're out of the backoff check.
+    def self.log
+      getStandardLogger
+    end
+  end
+
+  private_class_method :getStandardLogger, :setup, :teardown
+end

data/lib/govdelivery/proctor/version.rb

@@ -0,0 +1,5 @@
+module GovDelivery
+  module Proctor
+    VERSION = "1.3"
+  end
+end

data/proctor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'govdelivery/proctor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'govdelivery-proctor'
+  spec.version       = GovDelivery::Proctor::VERSION
+  spec.authors       = ['Bill Bushey']
+  spec.email         = ['bill.bushey@govdelivery.com']
+  spec.summary       = 'Classes and functions to support feature testing.'
+  spec.description   = 'Classes and functions to support feature testing.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH << File.expand_path("../lib/govdelivery/proctor", __FILE__)
+require 'bundler/setup'
+Bundler.require :default, :test
+
+require 'test/unit'
+require 'govdelivery-proctor'
+require 'pry-byebug'
+require 'logger'

data/test/test_proctor.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+module GovDelivery::Proctor
+  require 'logger'
+end
+
+class TestProctor < Test::Unit::TestCase
+  def test_sleep_time_steady
+    assert_equal 30, GovDelivery::Proctor.sleep_time('steady', 600, 30, 5)
+  end
+
+  def test_sleep_time_backoff_iteration_one
+    assert_equal 60, GovDelivery::Proctor.sleep_time('backoff', 600, 30, 1)
+  end
+
+  def test_sleep_time_backoff_iteration_four
+    assert_equal 480, GovDelivery::Proctor.sleep_time('backoff', 600, 30, 4)
+  end
+
+  def test_sleep_time_accelerate_iteration_default_to_minimum
+    assert_equal 10, GovDelivery::Proctor.sleep_time('accelerate', 1, 10, 2)
+  end
+
+  def test_sleep_time_accelerate_iteration_one
+    assert_equal 90, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 1)
+  end
+
+  def test_sleep_time_accelerate_iteration_four
+    assert_equal 40, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 4)
+  end
+
+  def test_sleep_time_accelerate_iteration_four_lower_sleep
+    assert_equal 4, GovDelivery::Proctor.sleep_time('accelerate', 600, 1, 4)
+  end
+
+  def test_backoff_check_condition_true
+    GovDelivery::Proctor.backoff_check 2 do
+      true
+    end
+  end
+
+  def test_accelerating_check_condition_true
+    GovDelivery::Proctor.accelerating_check 2 do
+      true
+    end
+  end
+
+  def test_steady_check_condition_true
+    GovDelivery::Proctor.steady_check 2 do
+      true
+    end
+  end
+
+  def test_backoff_check_condition_false
+    ex = assert_raises GovDelivery::Proctor::CheckTimeExceeded do
+      GovDelivery::Proctor.backoff_check 1 do
+        false
+      end
+    end
+    assert_equal "Backoff check has taken too long. Have waited 1 seconds\nlog: ", ex.message
+  end
+
+  def test_accelerating_check_condition_false
+    ex = assert_raises GovDelivery::Proctor::CheckTimeExceeded do
+      GovDelivery::Proctor.accelerating_check 1 do
+        false
+      end
+    end
+    assert_equal "Backon check has taken too long. Have waited 1 seconds\nlog: ", ex.message
+  end
+
+  def test_steady_check_condition_false
+    ex = assert_raises GovDelivery::Proctor::CheckTimeExceeded do
+      GovDelivery::Proctor.steady_check 1 do
+        false
+      end
+    end
+    assert_equal "Steady check has taken too long. Have waited 1 seconds\nlog: ", ex.message
+  end
+
+  def test_backoff_check_requires_block
+    ex = assert_raises RuntimeError do
+      GovDelivery::Proctor.backoff_check 1
+    end
+    assert_equal 'Check requires a block', ex.message
+  end
+
+  def test_accelerating_check_requires_block
+    ex = assert_raises RuntimeError do
+      GovDelivery::Proctor.accelerating_check 1
+    end
+    assert_equal 'Check requires a block', ex.message
+  end
+
+  def test_steady_check_requires_block
+    ex = assert_raises RuntimeError do
+      GovDelivery::Proctor.steady_check 1
+    end
+    assert_equal 'Check requires a block', ex.message
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: govdelivery-proctor
+version: !ruby/object:Gem::Version
+  version: '1.3'
+platform: ruby
+authors:
+- Bill Bushey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Classes and functions to support feature testing.
+email:
+- bill.bushey@govdelivery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/govdelivery-proctor.rb
+- lib/govdelivery/proctor/base.rb
+- lib/govdelivery/proctor/version.rb
+- proctor.gemspec
+- test/test_helper.rb
+- test/test_proctor.rb
+homepage: ''
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Classes and functions to support feature testing.
+test_files:
+- test/test_helper.rb
+- test/test_proctor.rb