goodguide-health 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0716629f003fdcec5f0910a175f16dd9ae662bd4
+  data.tar.gz: 560e32471355d373a7474acc50f8b4f88216e12a
+SHA512:
+  metadata.gz: b7f959dafdd143d1658e3ec17de56adf8702aee09bd2bb0d70b4861b735a9d2323ca7b6a366dd6654f5df8ad22fe8155ba56b1a866c1e73384c77ae97129607b
+  data.tar.gz: 35d470db29e4dc9b6deb1fdde865bac0ed2baf278a8029c7256c34f6680c6e25ce42b4d834da1492cda7b2606ba5e631420b6dea1863a947b259abf7f02f8911

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+pkg/
+Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 GoodGuide
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Goodguide::Health
+
+This is a very simple Rack application which provides GoodGuide's internal notion of a health-check endpoint to apps which embed it.
+
+## Configuration
+
+Goodguide::Health is mainly a wrapper around our fork of [Pinglish][], which is a simple Rack app which provides a "ping" endpoint which has a few powerful guarantees and enables the creation of arbitrary "health check" procs each of which are run during a status check.
+
+This is exposed for configuration as in the following example:
+
+```ruby
+# config/initializers/health.rb
+
+Goodguide::Health.configure do |health|
+  health.check :foo do
+    # health check logic
+  end
+end
+```
+
+Please see the Pinglish docs/source for more info on exactly the semantics of the health checks and how they are meant to be used.
+
+Goodguide::Health is a singleton class, which makes configuration easy when you usually will have to inject the configured instance into a Rails routes table earlier in the boot process.
+
+## Usage
+
+In the simple case, you can just `mount` it in a Rails app:
+
+```ruby
+# config/routes.rb
+MyAwesomeRailsApp::Application.routes.draw do
+  mount Goodguide::Health.app, at: '/health', as: 'health'
+end
+```
+
+(`#app` exposes the composed Rack app which mounts [Pinglish][] at `/status`)
+
+Or in a more basic Rack context, you can `run` it directly:
+
+```ruby
+# config.ru
+map '/health' do
+  run Goodguide::Health.app
+end
+
+run MyAwesomeRackApp
+```
+
+[Pinglish]: https://github.com/goodguide/pinglish

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/config.ru

@@ -0,0 +1,9 @@
+require 'goodguide/health'
+
+Goodguide::Health.configure do |health|
+  health.check :foo do
+    true
+  end
+end
+
+run Goodguide::Health.app

data/goodguide-health.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goodguide/health/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'goodguide-health'
+  spec.version       = Goodguide::Health::VERSION
+  spec.authors       = ['Ryan Taylor Long']
+  spec.email         = ['ryan.long@goodguide.com']
+  spec.summary       = 'application health summary check/endpoint'
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'goodguide-pinglish', '~> 1.0'
+  spec.add_dependency 'rack', '>= 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'timecop'
+end

data/lib/goodguide/health.rb

@@ -0,0 +1,98 @@
+require 'time'
+require 'forwardable'
+require 'rack/builder'
+require 'rack/urlmap'
+require 'pinglish'
+require 'goodguide/health/version'
+require 'goodguide/health/newline_middleware'
+
+module Goodguide
+  class Health
+    class <<self
+      extend Forwardable
+
+      def app
+        health = instance
+        Rack::Builder.app do
+          use NewlineMiddleware
+
+          map '/status' do
+            run health.pinglish
+          end
+          map '/' do
+            run health
+          end
+        end
+      end
+
+      def reset
+        @instance = nil
+      end
+
+      def_delegator :instance, :configure
+
+      private
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    def initialize
+      @booted_at = Time.now.utc
+    end
+
+    attr_reader :booted_at
+    attr_writer :revision, :deployed_at, :hostname, :gg_env
+
+    def hostname
+      @hostname ||= ENV.fetch('DEPLOYMENT_HOST') {
+        ENV.fetch('HOSTNAME') {
+          output = `hostname 2>/dev/null`
+          $? == 0 ? output.chomp : nil
+        }
+      }
+    end
+
+    def revision
+      @revision ||= ENV.fetch('GIT_REVISION') {
+        ENV.fetch('DEPLOYMENT_REVISION') {
+          output = `git rev-parse HEAD 2>/dev/null`
+          $? == 0 ? output.chomp : nil
+        }
+      }
+    end
+
+    def deployed_at
+      @deployed_at ||= ENV.key?('DEPLOYMENT_TIMESTAMP') ?
+        Time.at(ENV['DEPLOYMENT_TIMESTAMP'].to_i).utc :
+        booted_at
+    end
+
+    def gg_env
+      @gg_env ||= ENV['GG_ENV']
+    end
+
+    def call(env)
+      [200, { 'Content-Type' => 'text/plain' }, ["OK\n"]]
+    end
+
+    def configure(&block)
+      block.call(self)
+    end
+
+    def pinglish
+      @pinglish ||= Pinglish.new do |ping|
+        ping.check(:host) { hostname }
+        ping.check(:deployed_at) { deployed_at.iso8601 }
+        ping.check(:revision) { revision }
+        ping.check(:started_at) { booted_at.iso8601 }
+        ping.check(:gg_env) { gg_env }
+      end
+    end
+
+    def check(*args, &block)
+      pinglish.check(*args, &block)
+    end
+  end
+end

data/lib/goodguide/health/newline_middleware.rb

@@ -0,0 +1,19 @@
+module Goodguide
+  class Health
+    class NewlineMiddleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+
+        unless body.last.end_with?("\n")
+          body.push("\n")
+        end
+
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/goodguide/health/version.rb

@@ -0,0 +1,5 @@
+module Goodguide
+  class Health
+    VERSION = "1.1.2"
+  end
+end

data/test/goodguide/health_test.rb

@@ -0,0 +1,168 @@
+require 'test_helper'
+require 'timecop'
+
+class Goodguide::HealthTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def app_boot_time
+    Time.at(1430161200)
+  end
+
+  attr_reader :app
+
+  def setup
+    Goodguide::Health.reset
+    Timecop.freeze(app_boot_time) do
+      # force initialization of the instance with time frozen
+      @app = Goodguide::Health.app
+    end
+    Timecop.freeze(Time.now)
+  end
+
+  def teardown
+    Timecop.return
+  end
+
+  def test_root_path
+    get '/'
+
+    assert last_response.ok?
+    assert_equal "OK\n", last_response.body
+  end
+
+  def test_status_default
+    get '/status'
+
+    assert last_response.ok?
+    assert_status_response_matches parsed_response, default_status_response
+  end
+
+  def test_status_termination
+    get '/status'
+
+    assert last_response.ok?
+    assert last_response.body.end_with?("\n"), 'Output should end with an ASCII newline char'
+  end
+
+  def test_status_with_deployment_info
+    timestamp = 1430162520
+    Goodguide::Health.configure do |health|
+      health.revision = 'foo'
+      health.deployed_at = Time.at(timestamp).utc
+    end
+    get '/status'
+
+    assert last_response.ok?
+    assert_status_response_matches parsed_response, default_status_response.merge(
+      deployed_at: Time.at(timestamp).utc.iso8601,
+      revision: 'foo'
+    )
+  end
+
+  def test_status_with_gg_env
+    Goodguide::Health.configure do |health|
+      health.gg_env = 'production'
+    end
+    get '/status'
+
+    assert last_response.ok?
+    assert_status_response_matches parsed_response, default_status_response.merge(gg_env: 'production')
+  end
+
+  def test_status_with_custom_checks
+    Goodguide::Health.configure do |health|
+      health.check :custom_check do
+        :foobarbaz
+      end
+    end
+    get '/status'
+
+    assert last_response.ok?
+    assert_status_response_matches parsed_response, default_status_response.merge(
+      custom_check: 'foobarbaz'
+    )
+  end
+
+  def test_status_with_custom_checks_which_fail
+    Goodguide::Health.configure do |health|
+      health.check :custom_check_that_fails do
+        raise "foo"
+      end
+    end
+    get '/status'
+
+    assert_equal 503, last_response.status
+    assert_status_response_matches parsed_response, default_status_response.merge(
+      status: 'failures',
+      failures: ['custom_check_that_fails'],
+      custom_check_that_fails: {
+        'state' => 'error',
+        'exception' => 'RuntimeError',
+        'message' => 'foo',
+      }
+    )
+  end
+
+  def test_status_with_custom_checks_which_timeout
+    Goodguide::Health.configure do |health|
+      health.check :custom_check_that_times_out, timeout: 0.01 do
+        sleep 1
+      end
+    end
+    get '/status'
+
+    assert_equal 503, last_response.status
+    assert_status_response_matches parsed_response, default_status_response.merge(
+      status: 'failures',
+      timeouts: ['custom_check_that_times_out'],
+    )
+  end
+
+  def test_status_with_subset_of_checks
+    Goodguide::Health.configure do |health|
+      health.check :custom_check_that_times_out, timeout: 0.01 do
+        sleep 1
+      end
+
+      health.check :foobar do
+        123
+      end
+    end
+    get '/status?checks=foobar'
+
+    assert_equal 200, last_response.status
+    assert_status_response_matches parsed_response, {
+      status: 'ok',
+      now: Time.now.to_i,
+      foobar: 123,
+    }
+  end
+
+  private
+
+  def git_revision
+    `git rev-parse HEAD`.chomp
+  end
+
+  def parsed_response
+    JSON.parse(last_response.body)
+  end
+
+  def default_status_response
+    {
+      status: 'ok',
+      now: Time.now.utc.to_i,
+      deployed_at: app_boot_time.utc.iso8601,
+      started_at: app_boot_time.utc.iso8601,
+      host: `hostname`.chomp,
+      revision: git_revision,
+    }
+  end
+
+  def assert_status_response_matches(actual, expected)
+    expected.each do |key, value|
+      assert_equal value, actual[key.to_s], "value for `#{key}` did not match"
+    end
+    assert_equal expected.keys.map(&:to_s).sort, actual.keys.sort, "keys did not match"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+require 'rack/test'
+
+require 'goodguide/health'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: goodguide-health
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- Ryan Taylor Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: goodguide-pinglish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rack-test
+  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: timecop
+  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: 
+email:
+- ryan.long@goodguide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- goodguide-health.gemspec
+- lib/goodguide/health.rb
+- lib/goodguide/health/newline_middleware.rb
+- lib/goodguide/health/version.rb
+- test/goodguide/health_test.rb
+- test/test_helper.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.6.6
+signing_key: 
+specification_version: 4
+summary: application health summary check/endpoint
+test_files:
+- test/goodguide/health_test.rb
+- test/test_helper.rb