right_support 2.6.17 → 2.7.0

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--format=nested
+--backtrace
+--debugger

data/CHANGELOG.rdoc

@@ -0,0 +1,37 @@
+== 2.0
+
+=== Interface-breaking changes
+
+* Changed some of the more esoteric options of RequestBalancer
+* Removed TagLogger and CustomLogger middlwares
+* Renamed Balancing module to LB
+* Renamed StickyPolicy class to Sticky
+* Removed Object#if_require_succeeds(&block); too dangerous -- use
+  Object#require_succeeds instead!
+
+=== New functionality
+
+* Several new Rack middlewares for request logging & tracking
+* Statistics gathering, string extensions,
+* HTTPClient methods can accept query-strings (:query) and/or request body
+  (:payload)
+
+== 1.0
+
+=== Interface-breaking changes
+
+* Moved logging classes (FilterLogger, SystemLogger, TagLogger) into RightSupport::Log namespace
+* Moved CassandraModel into RightSupport::DB
+* Removed RightSupport::REST module entirely. Replaced by RightSupport::Net::HTTPClient class.
+
+=== New functionality
+
+* RequestBalancer now capable of using multiple policies for endpoint selection.
+  Default is RoundRobin (previously the only option); now you can choose HealthCheck
+  in addition. See rdoc for more info.
+* RequestBalancer can accept a logger as a class attribute. If supplied, any failed requests
+  will be logged with the error severity, including detailed information about exception type,
+  retryability, etc.
+* HTTPClient object is a thin wrapper around RestClient that adds some default timeouts.
+  It's appropriate for low-latency REST requests to nearby services; by tweaking the
+  defaults, you can use it for various other scenarios.

data/Gemfile

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+
+# Gems that RightSupport can optionally make use of, but which it does
+# not require to be installed. These would be "optional dependencies"
+# if gemspecs allowed for them.
+group :optional do
+  gem "net-ssh", "~> 2.0"
+  gem "rest-client", "~> 1.6"
+  gem "addressable", "~> 2.2.7"
+  gem "uuidtools", "~> 2.0", :require => nil
+  gem "simple_uuid", "~> 0.2", :require => nil
+  gem "uuid", "~> 2.3", :require => nil
+  gem "yajl-ruby", "~> 1.1"
+end
+
+# Gems used during test and development of RightSupport.
+group :development do
+  gem "rake", "~> 0.9"
+  gem "jeweler", "~> 1.8.3"
+  gem "right_develop", "~> 1.0",
+	 :git => "git@github.com:rightscale/right_develop.git",
+	 :branch => "master"
+  gem "ruby-debug", ">= 0.10", :platforms => :ruby_18
+  gem "ruby-debug19", ">= 0.11.6", :platforms => :ruby_19
+  gem "rdoc", ">= 2.4.2"
+  gem "flexmock", "~> 0.8"
+  gem "syntax", "~> 1.0.0" #rspec will syntax-highlight code snippets if this gem is available
+  gem "nokogiri", "~> 1.5"
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+GIT
+  remote: git@github.com:rightscale/right_develop.git
+  revision: baabb68c392e1afdbff7d6cc21d87f9b1cdb2db6
+  branch: master
+  specs:
+    right_develop (1.1.0)
+      actionpack (>= 2.3.0, < 4.0)
+      builder (~> 3.0)
+      cucumber (~> 1.0)
+      rake (>= 0.8.7, < 0.10)
+      right_support (~> 2.0)
+      rspec (>= 1.3, < 3.0)
+      trollop (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.18)
+      activesupport (= 2.3.18)
+      rack (~> 1.1.0)
+    activesupport (2.3.18)
+    addressable (2.2.8)
+    archive-tar-minitar (0.5.2)
+    builder (3.2.0)
+    columnize (0.3.6)
+    cucumber (1.2.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.7)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.2)
+    flexmock (0.9.0)
+    gherkin (2.11.8)
+      multi_json (~> 1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    net-ssh (2.6.6)
+    nokogiri (1.5.9)
+    rack (1.1.6)
+    rake (0.9.6)
+    rbx-require-relative (0.0.9)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    right_support (2.6.17)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simple_uuid (0.3.0)
+    syntax (1.0.0)
+    systemu (2.5.2)
+    trollop (1.16.2)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
+    uuidtools (2.1.3)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable (~> 2.2.7)
+  flexmock (~> 0.8)
+  jeweler (~> 1.8.3)
+  net-ssh (~> 2.0)
+  nokogiri (~> 1.5)
+  rake (~> 0.9)
+  rdoc (>= 2.4.2)
+  rest-client (~> 1.6)
+  right_develop (~> 1.0)!
+  ruby-debug (>= 0.10)
+  ruby-debug19 (>= 0.11.6)
+  simple_uuid (~> 0.2)
+  syntax (~> 1.0.0)
+  uuid (~> 2.3)
+  uuidtools (~> 2.0)
+  yajl-ruby (~> 1.1)

data/README.rdoc

@@ -1,5 +1,7 @@
 RightSupport is a library of reusable, unit- and functional-tested Ruby code that RightScale has found broadly useful.
 
+Maintained by the RightScale Teal Team
+
 == What Does It Do?
 
 === Logging

data/Rakefile

@@ -0,0 +1,62 @@
+# -*-ruby-*-
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+require 'right_develop/ci/rake_task'
+
+# But, we have a very special need, because OUR Cucumbers need to run with a pristine
+# environment that isn't polluted by RVM or RubyGems or anyone else, in order to validate
+# that RightSupport's CI harness doesn't break your app if those gems are unavailable.
+# Thus when our own Rake task runs spec or cucumber as a subprocess, we need to give it
+# a pristine non-bundled environment, so it can use Bundler.with_clean_env to launch
+# subprocesses.
+require File.expand_path('../features/support/file_utils_bundler_mixin', __FILE__)
+
+desc "Run unit tests"
+task :default => :spec
+
+desc "Run unit tests"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = Dir['**/*_spec.rb']
+end
+
+desc "Run functional tests"
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--color --format pretty}
+end
+
+desc 'Generate documentation for the right_support gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'RightSupport'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('features/**/*')
+  rdoc.rdoc_files.exclude('spec/**/*')
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification; see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "right_support"
+  gem.homepage = "https://github.com/rightscale/right_support"
+  gem.license = "MIT"
+  gem.summary = %Q{Reusable foundation code.}
+  gem.description = %Q{A toolkit of useful, reusable foundation code created by RightScale.}
+  gem.email = "support@rightscale.com"
+  gem.authors = ['Tony Spataro', 'Sergey Sergyenko', 'Ryan Williamson', 'Lee Kirchhoff', 'Alexey Karpik', 'Scott Messier']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+CLEAN.include('pkg')
+
+RightDevelop::CI::RakeTask.new

data/VERSION

@@ -0,0 +1 @@
+2.7.0

data/features/balancer_error_handling.feature

@@ -0,0 +1,34 @@
+Feature: request balancer error handling
+  In order to enhance app availability and development velocity
+  RequestBalancer should consider certain errors as fatal by default
+  So careless developers do not cause unexpected behavior when failures occur
+
+  Scenario: well-behaved servers
+    Given 5 servers that respond with 200
+    When a client makes a load-balanced request to '/'
+    Then the request should complete
+    And the request should be attempted once
+
+  Scenario: resource not found
+    Given 4 servers that respond with 404
+    When a client makes a load-balanced request to '/'
+    Then the request should raise ResourceNotFound
+    And the request should be attempted once
+
+  Scenario: client-side error
+    Given a server that responds with 200
+    When a client makes a buggy load-balanced request to '/'
+    Then the request should raise ArgumentError
+    And the request should be attempted once
+
+  Scenario: socket open timeout
+    Given 2 blackholed servers
+    When a client makes a load-balanced request to '/'
+    Then the request should be attempted 2 times
+    And the request should raise NoResult
+
+  Scenario: HTTP request timeout
+    Given 2 overloaded servers
+    When a client makes a load-balanced request to '/'
+    Then the request should be attempted 2 times
+    And the request should raise NoResult

data/features/balancer_health_check.feature

@@ -0,0 +1,33 @@
+Feature: request balancer health check
+  In order to enhance system availability for customers
+  RightSupport should track endpoint health when making load-balanced REST requests
+  So apps do not become hung during network failures
+
+Scenario: mixed servers (overloaded, blackholed) using health check
+  Given 4 overloaded servers
+  And 4 blackholed servers
+  And HealthCheck balancing policy
+  When a client makes a load-balanced request to '/' with timeout 1 and open_timeout 2
+  Then the request should raise in less than 12 seconds
+
+Scenario: mixed servers (well-behaved, blackholed) using health check
+  Given 4 servers that respond with 200
+  And 4 blackholed servers
+  And HealthCheck balancing policy
+  When a client makes a load-balanced request to '/' with timeout 1 and open_timeout 2
+  Then the request should complete in less than 8 seconds
+
+Scenario: mixed servers (overloaded, well-behaved, blackholed) using health check
+  Given 1 overloaded server
+  And 1 server that responds with 200
+  And 1 blackholed server
+  And HealthCheck balancing policy
+  When a client makes a load-balanced request to '/' with timeout 1 and open_timeout 2
+  Then the request should complete in less than 3 seconds
+
+Scenario: mixed servers (condition commented by Tony https://rightscale.acunote.com/projects/2091/tasks/23987#comments) using health check
+  Given 3 overloaded servers
+  And 1 server that responds with 200
+  And HealthCheck balancing policy
+  When a client makes a load-balanced request to '/' with timeout 1 and open_timeout 2
+  Then the request should complete in less than 3 seconds

data/features/continuous_integration.feature

@@ -0,0 +1,51 @@
+Feature: continuous integration disabled
+  In order to let minimize runtime dependencies
+  RightSupport's Rake CI harness should gracefully handle missing gems
+  So it runs predictably and reliably in production
+
+  Background:
+    Given a Ruby application
+    And a Gemfile
+    And a gem dependency on 'rake ~> 0.9'
+
+  Scenario: all gems unavailable
+    Given the Rakefile contains a RightSupport::CI::RakeTask
+    When I install the bundle
+    And I rake '-T'
+    Then the output should not contain 'ci:cucumber'
+    And the output should not contain 'ci:spec'
+
+  Scenario: conditional availability of ci:cucumber
+    Given a gem dependency on 'rspec ~> 1.0'
+    And a gem dependency on 'builder ~> 3.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+    When I install the bundle
+    And I rake '-T'
+    Then the output should contain 'ci:spec'
+    And the output should not contain 'ci:cucumber'
+
+  Scenario: conditional availability of ci:rspec
+    Given a gem dependency on 'cucumber ~> 1.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+    When I install the bundle
+    And I rake '-T'
+    Then the output should contain 'ci:cucumber'
+    And the output should not contain 'ci:spec'
+
+  Scenario: list Rake tasks
+    Given a gem dependency on 'rspec ~> 2.0'
+    And a gem dependency on 'cucumber ~> 1.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+    When I install the bundle
+    And I rake '-T'
+    And the output should contain 'ci:cucumber'
+    And the output should contain 'ci:spec'
+
+  Scenario: override namespace
+    Given a gem dependency on 'rspec ~> 2.0'
+    And a gem dependency on 'cucumber ~> 1.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask with parameter ':funkalicious'
+    When I install the bundle
+    And I rake '-T'
+    Then the output should contain 'funkalicious:cucumber'
+    Then the output should contain 'funkalicious:spec'

data/features/continuous_integration_cucumber.feature

@@ -0,0 +1,28 @@
+Feature: continuous integration of Cucumber features
+  In order to facilitate TDD and enhance code quality
+  RightSupport should provide CI tasks with Cucumber with JUnit XML output
+  So any Ruby project can have a beautiful, info-rich Jenkins project
+
+  Background:
+    Given a Ruby application
+    And a Gemfile
+    And a gem dependency on 'rake ~> 0.9'
+    And a gem dependency on 'builder ~> 3.0'
+    And a gem dependency on 'cucumber ~> 1.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+
+  Scenario: passing Cucumber features
+    Given a trivial Cucumber feature
+    When I install the bundle
+    And I rake 'ci:cucumber'
+    Then the command should succeed
+    And the output should contain '** Execute ci:cucumber'
+    And the directory 'measurement/cucumber' should contain files
+
+  Scenario: failing Cucumber features
+    Given a trivial failing Cucumber feature
+    When I install the bundle
+    And I rake 'ci:cucumber'
+    Then the command should fail
+    And the output should contain '** Execute ci:cucumber'
+    And the directory 'measurement/cucumber' should contain files

data/features/continuous_integration_rspec1.feature

@@ -0,0 +1,28 @@
+Feature: continuous integration of RSpec 1.x specs
+  In order to facilitate TDD and enhance code quality
+  RightSupport should provide a Rake CI harness with JUnit XML output
+  So any Ruby project can have a beautiful, info-rich Jenkins project
+
+  Background:
+    Given a Ruby application
+    And a Gemfile
+    And a gem dependency on 'rake ~> 0.9'
+    And a gem dependency on 'rspec ~> 1.0'
+    And a gem dependency on 'builder ~> 3.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+
+  Scenario: passing RSpec 1.x examples
+    Given a trivial RSpec spec
+    When I install the bundle
+    And I rake 'ci:spec'
+    Then the command should succeed
+    And the file 'measurement/rspec/rspec.xml' should mention 2 passing test cases
+    And the file 'measurement/rspec/rspec.xml' should mention 0 failing test cases
+
+  Scenario: failing RSpec 1.x examples
+    Given a trivial failing RSpec spec
+    When I install the bundle
+    And I rake 'ci:spec'
+    Then the command should fail
+    And the file 'measurement/rspec/rspec.xml' should mention 2 passing test cases
+    And the file 'measurement/rspec/rspec.xml' should mention 1 failing test case

data/features/continuous_integration_rspec2.feature

@@ -0,0 +1,28 @@
+Feature: continuous integration of RSpec 2.x specs
+  In order to facilitate TDD and enhance code quality
+  RightSupport should provide a Rake CI harness with JUnit XML output
+  So any Ruby project can have a beautiful, info-rich Jenkins project
+
+  Background:
+    Given a Ruby application
+    And a Gemfile
+    And a gem dependency on 'rake ~> 0.9'
+    And a gem dependency on 'rspec ~> 2.0'
+    And a gem dependency on 'builder ~> 3.0'
+    And the Rakefile contains a RightSupport::CI::RakeTask
+
+  Scenario: passing examples
+    And a trivial RSpec spec
+    When I install the bundle
+    And I rake 'ci:spec'
+    Then the command should succeed
+    And the file 'measurement/rspec/rspec.xml' should mention 2 passing test cases
+    And the file 'measurement/rspec/rspec.xml' should mention 0 failing test cases
+
+  Scenario: failing examples
+    And a trivial failing RSpec spec
+    When I install the bundle
+    And I rake 'ci:spec'
+    Then the command should fail
+    And the file 'measurement/rspec/rspec.xml' should mention 2 passing test cases
+    And the file 'measurement/rspec/rspec.xml' should mention 1 failing test case

data/features/http_client_timeout.feature

@@ -0,0 +1,19 @@
+Feature: HTTP client request timeout
+  In order to enhance system availability for customers
+  RightSupport should provide robust REST query interfaces 
+  So apps do not become hung during network failures
+
+  Scenario: well-behaved server
+    Given a server that responds with 200
+    When a client makes a request to '/' with timeout 1 and open_timeout 2
+    Then the request should complete in less than 3 seconds
+
+  Scenario: overloaded server
+    Given an overloaded server
+    When a client makes a request to '/' with timeout 1 and open_timeout 2
+    Then the request should raise in less than 3 seconds
+
+  Scenario: blackholed servers
+    Given a blackholed server
+    When a client makes a load-balanced request to '/' with timeout 1 and open_timeout 2
+    Then the request should raise in less than 3 seconds

data/features/serialization.feature

@@ -0,0 +1,95 @@
+Feature: JSON serialization
+  In order to facilitate Ruby apps' use of external JSON data stores
+  RightSupport should cleanly serialize arbitrary Ruby objects to JSON without data loss or semantic ambiguity
+  So app code can be idiomatic and focus on the business problem, not the encoding details
+
+  Background:
+    Given a serializer named 'RightSupport::Data::Serializer'
+    And a stateful Ruby class named 'GotState'
+
+  Scenario Outline: Ruby types with a native JSON representation
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be: <json>
+    And the serialized value should round-trip cleanly
+
+  Examples:
+    | ruby                                  | json                               |
+    | true                                  | true                               |
+    | false                                 | false                              |
+    | nil                                   | null                               |
+    | 0                                     | 0                                  |
+    | 42                                    | 42                                 |
+    | -32                                   | -32                                |
+    | 3.1415926535                          | 3.1415926535                       |
+    | 0xFFFFFFFFFFFFFFFFFFFFFFFF            | 79228162514264337593543950335      |
+    | "hello, world!"                       | "hello, world!"                    |
+    | [0,true,nil,['a',false]]              | [0,true,null,["a",false]]          |
+    | {"one"=>2}                            | {"one":2}                          |
+    | {"hash"=>{"lucky"=>777,"seq"=>[2,3]}} | {"hash":{"lucky":777,"seq":[2,3]}} |
+
+  Scenario: complex Ruby structures with a native JSON representation
+    When I serialize a complex random data structure
+    Then the serialized value should round-trip cleanly
+
+  Scenario Outline: object-escaped Symbol
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be: <json>
+    And the serialized value should round-trip cleanly
+
+  Examples:
+    | ruby            | json            |
+    | :my_symbol      | ":my_symbol"    |
+    | :'weird symbol' | ":weird symbol" |
+
+  Scenario Outline: object-escaped Time
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be: <json>
+    And the serialized value should round-trip cleanly
+
+  Examples:
+    | ruby                                                 | json                   |
+    | Time.at(1234567890)                                  | "2009-02-13T23:31:30Z" |
+    | Time.at(1234567890).utc                              | "2009-02-13T23:31:30Z" |
+
+  Scenario Outline: object-escaped String
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be: <json>
+    And the serialized value should round-trip cleanly
+
+  Examples:
+    | ruby            | json                                             |
+    | ":not_a_symbol" | {"_ruby_class":"String","value":":not_a_symbol"} |
+
+  Scenario Outline: Ruby Class and Module types
+
+  Scenario Outline: Ruby Class and Module types
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be a JSON object
+    And the serialized value should round-trip cleanly
+
+  Examples:
+    | ruby                              |
+    | String                            |
+    | RightSupport::Ruby::EasySingleton |
+    | RightSupport::Net::HTTPClient     |
+    | Hash                              |
+    | Kernel                            |
+
+  Scenario Outline: arbitrary Ruby objects
+    When I serialize the Ruby value: <ruby>
+    Then the serialized value should be a JSON object
+    And the serialized value should have a suitable _ruby_class
+
+  Examples:
+    | ruby                                   |
+    | RightSupport::Crypto::SignedHash.new() |
+    | GotState.new                           |
+
+  Scenario: arbitrary Ruby object round-trip, happy path
+    When I serialize the Ruby value: GotState.new
+    Then the serialized value should round-trip cleanly
+
+  Scenario: arbitrary Ruby object round-trip, sad path
+    When I serialize the Ruby value: GotState.new
+    And an eldritch force deletes a key from the serialized value
+    And the serialized value should fail to round-trip

data/features/step_definitions/http_client_steps.rb

@@ -0,0 +1,27 @@
+When /^a client makes a (buggy )?request to '(.*)'$/ do |buggy, path|
+  t = RightSupport::Net::HTTPClient::DEFAULT_OPTIONS[:timeout]
+  o = RightSupport::Net::HTTPClient::DEFAULT_OPTIONS[:open_timeout]
+  When "a client makes a #{buggy}request to '#{path}' with timeout #{t} and open_timeout #{o}"
+end
+
+
+When /^a client makes a (buggy )?request to '(.*)' with timeout (\d+) and open_timeout (\d+)$/ do |buggy, path, timeout, open_timeout|
+  buggy = !(buggy.nil? || buggy.empty?)
+
+  @mock_servers.should_not be_nil
+  @mock_servers.size.should == 1
+
+  timeout = timeout.to_i
+  open_timeout = open_timeout.to_i
+  url = @mock_servers.first.url
+
+  @http_client = RightSupport::Net::HTTPClient.new(:timeout=>timeout, :open_timeout=>open_timeout)
+  @request_t0 = Time.now
+  begin
+    raise ArgumentError, "Fall down go boom!" if buggy
+    @http_client.get("#{url}#{path}", {:timeout => timeout, :open_timeout => open_timeout})
+  rescue Exception => e
+    @request_error = e
+  end
+  @request_t1 = Time.now
+end