pinglish 0.0.0 → 0.0.1

data/Gemfile.lock

@@ -9,6 +9,8 @@ GEM
   specs:
     minitest (4.5.0)
     rack (1.5.0)
+    rack-test (0.6.2)
+      rack (>= 1.0)
 
 PLATFORMS
   ruby
@@ -16,3 +18,4 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 4.5)
   pinglish!
+  rack-test (~> 0.6)

data/README.md

@@ -22,9 +22,6 @@ conforms to the spec below.
 0. The response __must__ return an `HTTP 503 SERVICE UNAVAILABLE`
    status code if any health checks fail.
 
-0. The response __must__ return an `HTTP 418 I'M A TEAPOT` status code
-   if the request asks for any content-type but `application/json`.
-
 0. The response __must__ be of Content-Type `application/json;
    charset=UTF-8`.
 

data/lib/pinglish.rb

@@ -1,5 +1,6 @@
 require "json"
 require "timeout"
+require "rack/request"
 
 # This Rack middleware provides a "/_ping" endpoint for configurable
 # system health checks. It's intended to be consumed by machines.
@@ -17,11 +18,6 @@ class Pinglish
 
   MAX_TOTAL_TIME = 29
 
-  # This triple is returned if the request media type isn't
-  # "application/json".
-
-  TEAPOT = [418, HEADERS, ['{"teapot":"true"}']]
-
   # Represents a check, which is a behavior block with a name and
   # timeout in seconds.
 
@@ -64,7 +60,6 @@ class Pinglish
     request = Rack::Request.new env
 
     return @app.call env unless request.path == @path
-    return TEAPOT unless request.media_type == "application/json"
 
     timeout MAX_TOTAL_TIME do
       results = {}
@@ -135,11 +130,11 @@ class Pinglish
   end
 
   # Does `value` represent a check failure? This default
-  # implementation returns `true` for any value that is an Exception.
+  # implementation returns `true` for any value that is an Exception or false.
   # Subclasses can override this method for different behavior.
 
   def failure?(value)
-    value.is_a? Exception
+    value.is_a?(Exception) || value == false
   end
 
   # Raise Pinglish::TooLong after `seconds` has elapsed. This default

data/pinglish.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "pinglish"
-  gem.version       = "0.0.0"
+  gem.version       = "0.0.1"
   gem.authors       = ["John Barnette", "Will Farrington"]
   gem.email         = ["jbarnette@github.com", "wfarr@github.com"]
   gem.description   = "A simple Rack middleware for checking app health."
@@ -15,4 +15,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack"
   gem.add_development_dependency "minitest", "~> 4.5"
+  gem.add_development_dependency "rack-test", "~> 0.6"
 end

data/script/tests

@@ -5,5 +5,5 @@ set -e
 
 cd $(dirname "$0")/..
 
-script/bootstrap && ruby -I lib -rubygems \
+script/bootstrap && ruby -I lib -I test -rubygems \
   -e 'require "bundler/setup"; Dir["test/**/*_test.rb"].each { |f| load f }' "$@"

data/test/check_test.rb

@@ -0,0 +1,23 @@
+require "helper"
+
+class PinglishCheckTest < MiniTest::Unit::TestCase
+  def test_initialize
+    check = Pinglish::Check.new(:db)
+    assert_equal :db, check.name
+  end
+
+  def test_initialize_default_timeout
+    check = Pinglish::Check.new(:db)
+    assert_equal 1, check.timeout
+  end
+
+  def test_initialize_override_timeout
+    check = Pinglish::Check.new(:db, :timeout => 2)
+    assert_equal 2, check.timeout
+  end
+
+  def test_call
+    check = Pinglish::Check.new(:db) { :result_of_block }
+    assert_equal :result_of_block, check.call
+  end
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "pinglish"

data/test/pinglish_test.rb

@@ -1,7 +1,177 @@
-require "minitest/autorun"
+require "helper"
+require "rack/test"
 
 class PinglishTest < MiniTest::Unit::TestCase
-  def test_sanity
-    assert true
+  FakeApp = lambda { |env| [404, {}, []] }
+
+  def build_app(*args, &block)
+    Rack::Builder.new do |builder|
+      builder.use Pinglish, *args, &block
+      builder.run FakeApp
+    end
+  end
+
+  def test_with_defaults
+    app = build_app
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+    assert_equal 200, session.last_response.status
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'ok', json['status']
+  end
+
+  def test_with_good_check
+    app = build_app do |ping|
+      ping.check(:db) { :up_and_at_em }
+      ping.check(:queue) { :pushin_and_poppin }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'ok', json['status']
+    assert_equal 'up_and_at_em', json['db']
+    assert_equal 'pushin_and_poppin', json['queue']
+  end
+
+  def test_with_unnamed_check
+    app = build_app do |ping|
+      ping.check { :yohoho }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'ok', json['status']
+  end
+
+  def test_with_check_that_raises
+    app = build_app do |ping|
+      ping.check(:db) { :ok }
+      ping.check(:raise) { raise 'nooooope' }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+
+    assert_equal 503, session.last_response.status
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'fail', json['status']
+  end
+
+  def test_with_check_that_returns_false
+    app = build_app do |ping|
+      ping.check(:db) { :ok }
+      ping.check(:fail) { false }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+
+    assert_equal 503, session.last_response.status
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'fail', json['status']
+    assert_equal ['fail'], json['failures']
+  end
+
+  def test_with_check_that_times_out
+    app = build_app do |ping|
+      ping.check(:db) { :ok }
+      ping.check(:long, :timeout => 0.001) { sleep 0.003 }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_ping'
+
+    assert_equal 503, session.last_response.status
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'fail', json['status']
+    assert_equal ['long'], json['timeouts']
+  end
+
+  def test_with_custom_path
+    app = build_app("/_piiiiing")
+
+    session = Rack::Test::Session.new(app)
+    session.get '/_piiiiing'
+    assert_equal 200, session.last_response.status
+    assert_equal 'application/json; charset=UTF-8',
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?('now')
+    assert_equal 'ok', json['status']
+  end
+
+  def test_check_without_name
+    pinglish = Pinglish.new(FakeApp)
+    check = pinglish.check { :ok }
+    assert_instance_of Pinglish::Check, check
+  end
+
+  def test_check_with_name
+    pinglish = Pinglish.new(FakeApp)
+    check = pinglish.check(:db) { :ok }
+    assert_instance_of Pinglish::Check, check
+    assert_equal :db, check.name
+  end
+
+  def test_failure_boolean
+    pinglish = Pinglish.new(FakeApp)
+
+    assert pinglish.failure?(Exception.new),
+      "Expected failure with exception to be true"
+
+    assert pinglish.failure?(false),
+      "Expected failure with false to be true"
+
+    assert !pinglish.failure?(true),
+      "Expected failure with true value to be false"
+
+    assert !pinglish.failure?(:ok),
+      "Expected failure with non-false and non-exception to be false"
+  end
+
+  def test_timeout
+    pinglish = Pinglish.new(FakeApp)
+    begin
+      pinglish.timeout(0.001) { sleep 0.003 }
+      assert false, "Timeout did not happen, but should have."
+    rescue Pinglish::TooLong => e
+      # all good
+    end
+  end
+
+  def test_timeout_boolean
+    pinglish = Pinglish.new(FakeApp)
+    assert_equal true, pinglish.timeout?(Pinglish::TooLong.new)
+    assert_equal false, pinglish.timeout?(Exception.new)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinglish
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,6 +44,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: A simple Rack middleware for checking app health.
 email:
 - jbarnette@github.com
@@ -62,6 +78,8 @@ files:
 - script/bootstrap
 - script/release
 - script/tests
+- test/check_test.rb
+- test/helper.rb
 - test/pinglish_test.rb
 homepage: https://github.com/jbarnette/pinglish
 licenses: []
@@ -88,4 +106,6 @@ signing_key:
 specification_version: 3
 summary: /_ping your way to freedom.
 test_files:
+- test/check_test.rb
+- test/helper.rb
 - test/pinglish_test.rb