health_check 2.3.0 → 2.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80358069f525f51e0fc2751abe438c1d724fb3a0
+  data.tar.gz: 37280de5cb5c4ef5b713069321d5ad82fb0aa0ed
+SHA512:
+  metadata.gz: b5381bdf60fa524ca2bdd072655b83e036938b0a4d325183af6431366b77f34121b8b12ace9e7404e921248a84fc347caf549208b8062001ad10f38916ff127a
+  data.tar.gz: 82da4951b07dd4e420c570a9469ff722fa2c726b5f9d9f2961df4830abbe02e71085c18dda5449d0c0f800f3f43d029d781a05bd28d30ededef039b4059264e5

data/.travis.yml

@@ -23,45 +23,110 @@ bundler_args: "--binstubs"
 script: ./test/test_with_railsapp
 
 matrix:
+  fast_finish: true
+
   allow_failures:
     - rvm: 2.3.1
       gemfile: test/rails_edge.gemfile
-      env: RAILS_VERSION=edge
+      env: RAILS_VERSION=edge MIDDLEWARE=YES
 
     - rvm: ruby-head
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0
+      env: RAILS_VERSION=5.0 MIDDLEWARE=YES
 
   include:
+    # -------------------------------------
+    # Standard
+    
+    # ruby 5.0  Jun. 2016
+    
+    - rvm: 2.3.1
+      gemfile: test/rails_5.0.gemfile
+      env: RAILS_VERSION=5.0 MIDDLEWARE=no
+
+    - rvm: 2.2.2
+      gemfile: test/rails_5.0.gemfile
+      env: RAILS_VERSION=5.0 MIDDLEWARE=no
+
+    # rails 4.2  Dec, 2014 
+    
+    - rvm: 2.2.0
+      gemfile: test/rails_4.2.gemfile
+      env: RAILS_VERSION=4.2 MIDDLEWARE=no
+
+    - rvm: 2.1.2
+      gemfile: test/rails_4.2.gemfile
+      env: RAILS_SERVER=puma RAILS_VERSION=4.2 MIDDLEWARE=no
+
+    # Can't find i18n?? because it can't compile?
+    #- rvm: 2.1.2
+    #  gemfile: test/rails_4.2.gemfile
+    #  env: RAILS_SERVER=passenger RAILS_VERSION=4.2
+
+    - rvm: 2.1.2
+      gemfile: test/rails_4.2.gemfile
+      env: RAILS_SERVER=thin RAILS_VERSION=4.2 MIDDLEWARE=no
+
+    # No longer supported by travis
+    #- rvm: rbx-2.2.6
+    #  gemfile: test/rails_4.0.gemfile
+    #  env: RAILS_ENV2=development RAILS_VERSION=4.0
+
+    - rvm: 2.1.2
+      gemfile: test/rails_4.2.gemfile
+      env: RAILS_SERVER=unicorn RAILS_VERSION=4.2 MIDDLEWARE=no
+
+    # Disabled because it takes way too long (40+ mins)
+    # Temporary version lock until Bundler >= 1.13.2
+    # https://github.com/bundler/bundler/issues/4975
+    #- rvm: jruby-19mode
+    #  gemfile: test/rails_4.2.gemfile
+    #  env: BUNDLER_VERSION=1.12.5 RAILS_VERSION=4.2
+
+    # rails 4.1  April 8, 2014 
+    
+    - rvm: 2.1.2
+      gemfile: test/rails_4.1.gemfile
+      env: RAILS_VERSION=4.1 MIDDLEWARE=no
+
+    # rails 4.0
+    
+    - rvm: 1.9.3
+      gemfile: test/rails_4.0.gemfile
+      env: RAILS_VERSION=4.0 MIDDLEWARE=no
+
+    # -------------------------------------
+    # INSTALLED AS MIDDLEWARE
+    
     # ruby / rails edge
     
     - rvm: 2.3.1
       gemfile: test/rails_edge.gemfile
-      env: RAILS_VERSION=edge
+      env: RAILS_VERSION=edge MIDDLEWARE=YES
 
     # ruby 5.0  Jun. 2016
     
     - rvm: 2.3.1
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0
+      env: RAILS_VERSION=5.0 MIDDLEWARE=YES
 
     - rvm: 2.2.2
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0
+      env: RAILS_VERSION=5.0 MIDDLEWARE=YES
 
     - rvm: ruby-head
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0
+      env: RAILS_VERSION=5.0 MIDDLEWARE=YES
 
     # rails 4.2  Dec, 2014 
     
     - rvm: 2.2.0
       gemfile: test/rails_4.2.gemfile
-      env: RAILS_VERSION=4.2
+      env: RAILS_VERSION=4.2 MIDDLEWARE=YES
 
     - rvm: 2.1.2
       gemfile: test/rails_4.2.gemfile
-      env: RAILS_SERVER=puma RAILS_VERSION=4.2
+      env: RAILS_SERVER=puma RAILS_VERSION=4.2 MIDDLEWARE=YES
 
     # Can't find i18n?? because it can't compile?
     #- rvm: 2.1.2
@@ -70,33 +135,33 @@ matrix:
 
     - rvm: 2.1.2
       gemfile: test/rails_4.2.gemfile
-      env: RAILS_SERVER=thin RAILS_VERSION=4.2
+      env: RAILS_SERVER=thin RAILS_VERSION=4.2 MIDDLEWARE=YES
 
     # No longer supported by travis
     #- rvm: rbx-2.2.6
     #  gemfile: test/rails_4.0.gemfile
-    #  env: RAILS_ENV2=development RAILS_VERSION=4.0
+    #  env: RAILS_ENV2=development RAILS_VERSION=4.0 MIDDLEWARE=YES
 
     - rvm: 2.1.2
       gemfile: test/rails_4.2.gemfile
-      env: RAILS_SERVER=unicorn RAILS_VERSION=4.2
+      env: RAILS_SERVER=unicorn RAILS_VERSION=4.2 MIDDLEWARE=YES
 
     # Disabled because it takes way too long (40+ mins)
     # Temporary version lock until Bundler >= 1.13.2
     # https://github.com/bundler/bundler/issues/4975
     #- rvm: jruby-19mode
     #  gemfile: test/rails_4.2.gemfile
-    #  env: BUNDLER_VERSION=1.12.5 RAILS_VERSION=4.2
+    #  env: BUNDLER_VERSION=1.12.5 RAILS_VERSION=4.2 MIDDLEWARE=YES
 
     # rails 4.1  April 8, 2014 
     
     - rvm: 2.1.2
       gemfile: test/rails_4.1.gemfile
-      env: RAILS_VERSION=4.1
+      env: RAILS_VERSION=4.1 MIDDLEWARE=YES
 
     # rails 4.0
     
     - rvm: 1.9.3
       gemfile: test/rails_4.0.gemfile
-      env: RAILS_VERSION=4.0
+      env: RAILS_VERSION=4.0 MIDDLEWARE=YES
 

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Change Log =
 
+* 2.4.0
+ * Added tests for middleware
+ * Changed contributed middleware code to conform to existing url scheme
+ * Allow both GET and POST calls
+ * Prefer config.uri for changing route prefix
 * 2.3.0
  * Fix route reload issue
  * Various fixes to get tests working with bundle/jruby and other gem issues

data/README.rdoc

@@ -24,7 +24,9 @@ health_check provides various monitoring URIs, for example:
       <message>success</message>
     </hash>
 
-On failure a 500 http status is returned with a simple explanation of the failure
+You may also issue POST calls instead of GET to these urls.
+
+On failure (detected by health_check) a 500 http status is returned with a simple explanation of the failure
 
     curl localhost:3000/health_check/fail
     health_check failed: invalid argument to health_test.
@@ -74,6 +76,9 @@ To change the configuration of health_check, create a file `config/initializers/
 
     HealthCheck.setup do |config|
 
+      # uri prefix
+      config.uri = 'health_check'
+
       # Text output upon success
       config.success = 'success'
 
@@ -126,14 +131,17 @@ You may call add_custom_check multiple times with different tests. These tests w
 If you have a catchall route then add the following line above the catch all route (in `config/routes.rb`):
    health_check_routes
 
-To change the url prefix (eg to /ping), add the following line in `config/routes.rb`:
-   health_check_routes('ping')
-
 === Installing As Middleware
 
-To use health_check as middleware add the following line to the config/application.rb:
-  `config.middleware.insert_after "Rails::Rack::Logger", HealthCheck::MiddlewareHealthcheck`
-In config/initializers/health_check.rb config.uri can be changed to other than default 'health_check'
+Install health_check as middleware if you want to ignore exceptions from later parts of the Rails middleware stack,
+eg DB connection errors from QueryCache. Include "middleware" in the list of checks to have the checks processed by the middleware
+health check rather than the full stack check. The "middleware" check will fail if you have not installed health_check as middleware.
+
+To install health_check as middleware add the following line to the config/application.rb:
+    config.middleware.insert_after "Rails::Rack::Logger", HealthCheck::MiddlewareHealthcheck
+
+Note: health_check is installed as a full rails engine even if it has been installed as middleware. This is so the
+standard checks continue to test the complete rails stack.
 
 == Uptime Monitoring
 

data/lib/health_check/health_check_routes.rb

@@ -7,7 +7,8 @@ module ActionDispatch::Routing
     end
 
     def add_health_check_routes(prefix = nil)
-      get "#{prefix || 'health_check'}(/:checks)(.:format)", :to => 'health_check/health_check#index'
+      HealthCheck.uri = prefix if prefix
+      match "#{HealthCheck.uri}(/:checks)(.:format)", :to => 'health_check/health_check#index', via: [:get, :post]
     end
 
   end

data/lib/health_check/middleware_health_check.rb

@@ -7,38 +7,31 @@ module HealthCheck
 
     def call(env)
       uri = env['PATH_INFO']
-      if uri.include? HealthCheck.uri
-        response_type = uri[/\.(json|xml)/,1] || 'plain'
-        response_method = 'response_' + response_type
-        checks = env['QUERY_STRING'][/checks=([a-z0-9\-_]*)/,1] || 'standard'
+      if uri =~ /^\/?#{HealthCheck.uri}\/([-_0-9a-zA-Z]*)middleware_?([-_0-9a-zA-Z]*)(\.(\w*))?/
+        checks = $1 + ($1 != '' && $2 != '' ? '_' : '') + $2
+        checks = 'standard' if checks == ''
+        response_type = $4
         begin
           errors = HealthCheck::Utils.process_checks(checks)
         rescue => e
           errors = e.message.blank? ? e.class.to_s : e.message.to_s
         end
-        if errors.blank?
-          send(response_method, 200, HealthCheck.success, true)
+        healthy = errors.blank?
+        msg = healthy ? HealthCheck.success : "health_check failed: #{errors}"
+        if response_type == 'xml'
+          content_type = 'text/xml'
+          msg = { healthy: healthy, message: msg }.to_xml
+        elsif response_type == 'json'
+          content_type = 'application/json'
+          msg = { healthy: healthy, message: msg }.to_json
         else
-          msg = "health_check failed: #{errors}"
-          send(response_method, 500, msg, false)
+          content_type = 'text/plain'
         end
+        [ (healthy ? 200 : 500), { 'Content-Type' => content_type }, [msg] ]
       else
         @app.call(env)
       end
     end
 
-    def response_json code, msg, healthy
-      obj = { healthy: healthy, message: msg }
-      [ code, { 'Content-Type' => 'application/json' }, [obj.to_json] ]
-    end
-
-    def response_xml code, msg, healthy
-      obj = { healthy: healthy, message: msg }
-      [ code, { 'Content-Type' => 'text/xml' }, [obj.to_xml] ]
-    end
-
-    def response_plain code, msg, healthy
-      [ code, { 'Content-Type' => 'text/plain' }, [msg] ]
-    end
   end
 end

data/lib/health_check/version.rb

@@ -1,3 +1,3 @@
 module HealthCheck
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/test/setup_railsapp

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+route_prefix=medical_check
+
 err_report() {
     echo "$0: Error on line $1 - aborted"
     exit 1
@@ -38,6 +40,11 @@ do
     export BUNDLE_GEMFILE=$PWD/test/rails_$x.gemfile
 done
 
+if [ -z  "$MIDDLEWARE" ]; then
+  echo -n "Add as middleware [N/y] : "
+  read MIDDLEWARE
+  export MIDDLEWARE
+fi
 rm -rf tmp/Gemfile* tmp/railsapp tmp/bin tmp/gems test/bin test/rails*.gemfile.lock
 
 mkdir -p tmp/gems
@@ -160,6 +167,7 @@ HealthCheck.setup do |config|
   config.smtp_timeout = 60.0
   config.http_status_for_error_text = 550
   config.http_status_for_error_object = 555
+  config.uri = '$route_prefix'
 
   config.add_custom_check do
     File.exists?("$custom_file") ? '' : '$custom_file is missing!'
@@ -354,6 +362,45 @@ end
 
 EOF
 
+echo =======================================
+
+case "$MIDDLEWARE" in
+[Yy]*)
+  if [ -s config/application.rb ]; then
+    mv -f config/application.rb config/application.rb-old
+    (
+      ruby -n -e 'print if not /^  *end/..9999' config/application.rb-old | tee /tmp/t$$
+      if [ ! -s /tmp/t$$ ]; then
+        echo "WARNING: ruby -n -e failed silently - using sed instead!! (rbx-19mode has that problem)" >&3
+        sed -e '/^  *end/,$d' config/application.rb-old
+      fi
+
+      echo "    # -----------------------------------------"
+      echo "    # START OF SECTION FOR TESTING HEALTH_CHECK"
+      echo "    config.middleware.insert_after 'Rails::Rack::Logger', HealthCheck::MiddlewareHealthcheck"
+      echo "    # END OF SECTION FOR TESTING HEALTH_CHECK"
+      echo "    # ---------------------------------------"
+      ruby -n -e 'print if /^  *end/..9999' config/application.rb-old | tee /tmp/t$$
+      if [ ! -s /tmp/t$$ ]; then
+        echo "WARNING: ruby -n -e failed silently - using sed instead!! (rbx-19mode has that problem)" >&3
+        sed -n -e '/^  *end/,$p' config/application.rb-old
+      fi
+    ) 3>&1 > config/application.rb
+
+    #echo =============== config/application.rb-old ========================
+    #cat config/application.rb-old
+    echo =============== config/application.rb ========================
+    cat config/application.rb
+  else
+    echo FAILED: NO config/application.rb file!!
+    exit 2
+  fi
+
+  echo =======================================
+
+  ;;
+esac
+
 if [ -s config/routes.rb ]; then
   mv -f config/routes.rb config/routes.rb-old
   (
@@ -386,7 +433,8 @@ if [ -s config/routes.rb ]; then
   echo =============== config/routes.rb ========================
   cat config/routes.rb
 else
-  echo NO config/routes.rb file!!
+  echo FAILED: NO config/routes.rb file!!
+  exit 2
 fi
 echo =======================================
 

data/test/test_with_railsapp

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+route_prefix=medical_check
+
 err_report() {
     echo "$0: Error on line $1 - aborted"
     exit 1
@@ -43,6 +45,16 @@ cd $railsapp
 date > $custom_file
 rm -f $catchall_file
 
+case `egrep '^[^#]*MiddlewareHealthcheck' config/application.rb` in
+'')
+  export has_middleware=false
+  ;;
+?*)
+  export has_middleware=true
+  ;;
+esac
+
+
 testurl="$base_dir/test/testurl"
 fake_smtp_server="$base_dir/test/fake_smtp_server"
 
@@ -253,6 +265,8 @@ common_tests()
         echo
     fi
 
+
+
     test_no=`expr 1 + $test_no`
     if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
         echo "${test_no}: TESTING ${route_prefix}/site should pass ..."
@@ -268,6 +282,36 @@ common_tests()
         echo
     fi
 
+    #test with coruppted DB
+    rm -rf db.bak
+    cp -R db db.bak
+    for f in db/*.sqlite3
+    do
+        echo CORRUPTED > $f
+    done
+
+    test_no=`expr 1 + $test_no`
+    if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
+        echo "${test_no}: TESTING ${route_prefix}/database should fail if the database has been corrupted ..."
+
+        $testurl ${host}/${route_prefix}/database 550 text/plain failed
+        echo
+    fi
+
+    test_no=`expr 1 + $test_no`
+    if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
+        echo "${test_no}: TESTING ${route_prefix}/site should pass ..."
+        $testurl ${host}/${route_prefix}/site 200 text/plain $success
+        if $has_middleware; then
+            echo "${test_no}: TESTING ${route_prefix}/middleware_site should pass ..."
+            $testurl ${host}/${route_prefix}/middleware_site 200 text/plain $success
+        fi
+        echo
+    fi
+
+    # Restore database
+    cp -f db.bak/*.sqlite3 db/
+
     test_no=`expr 1 + $test_no`
     if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
         echo "${test_no}: TESTING ${route_prefix}/migration should fail without all migrations ..."
@@ -407,6 +451,18 @@ common_tests()
         echo
     fi
 
+    test_no=`expr 1 + $test_no`
+    if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
+        if $has_middleware; then
+            echo "${test_no}: TESTING ${route_prefix}/middleware_site should pass ..."
+            $testurl ${host}/${route_prefix}/middleware_site 200 text/plain $success
+        else
+            echo "${test_no}: TESTING ${route_prefix}/middleware_site should fail ..."
+            $testurl ${host}/${route_prefix}/middleware_site 550 text/plain failed
+        fi
+        echo
+    fi
+
     test_no=`expr 1 + $test_no`
     if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
         echo "${test_no}: TESTING log files to check for deprecation warnings ..."
@@ -440,13 +496,15 @@ case "$run_test" in
 
     # get a static file
 
-    route_prefix=health_check
-
     echo
     echo 'TESTING no catchall route active ...'
     expected_status=404,500,502
     $testurl ${host}/another/url $expected_status
 
+    echo 'TESTING default route has been overriden ...'
+    expected_status=404,500,502
+    $testurl ${host}/health_check/site $expected_status
+
     common_tests 1
     ;;
 esac

metadata

@@ -1,81 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: health_check
 version: !ruby/object:Gem::Version
-  version: 2.3.0
-  prerelease: 
+  version: 2.4.0
 platform: ruby
 authors:
 - Ian Heggie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: ! "  \tSimple health check of Rails app for uptime monitoring with Pingdom,
+description: "  \tSimple health check of Rails app for uptime monitoring with Pingdom,
   NewRelic, EngineYard or uptime.openacs.org etc.\n"
 email:
 - ian@heggie.biz
@@ -84,9 +75,9 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- .document
-- .gitignore
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
@@ -126,27 +117,26 @@ files:
 - test/unit/routes_test.rb
 homepage: https://github.com/ianheggie/health_check
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple health check of Rails app for uptime monitoring with Pingdom, NewRelic,
   EngineYard or uptime.openacs.org etc.
 test_files: