health_check 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80358069f525f51e0fc2751abe438c1d724fb3a0
-  data.tar.gz: 37280de5cb5c4ef5b713069321d5ad82fb0aa0ed
+  metadata.gz: 4b5a934dfee4618efc3d217163112b251e926879
+  data.tar.gz: 811fdba5dd439ef0016ca94c8c2b0b6dbac19a99
 SHA512:
-  metadata.gz: b5381bdf60fa524ca2bdd072655b83e036938b0a4d325183af6431366b77f34121b8b12ace9e7404e921248a84fc347caf549208b8062001ad10f38916ff127a
-  data.tar.gz: 82da4951b07dd4e420c570a9469ff722fa2c726b5f9d9f2961df4830abbe02e71085c18dda5449d0c0f800f3f43d029d781a05bd28d30ededef039b4059264e5
+  metadata.gz: fd09549905a225cc3c25a02f295335dcb013cb565c52095d4b87e1fb4e74552d4231637d7a4e9b7698c28f896103cf529cd1aefbbf1089dfb1b161c650ca11da
+  data.tar.gz: 44fc64d17c2722c5bd3841d65dabf2bc5f55b0a61b01a862484ea79f4b64ebe29d4300667b5c6f572eb50f5c90c8be59bcb783517721c2de18e3bbdc54929f42

data/CHANGELOG

@@ -1,5 +1,16 @@
 = Change Log =
 
+* 2.5.0
+ * Added whitelist for IP# (Thanks Fernando Alvarez)
+ * reworked whitelist PR
+ * Expanded tests for whitelist and basic authentication
+ * reworked middleware, simplified error codes, added whitelist and basic authentication into middleware
+ * Removed unit tests as they where aonly applicable under rails 2.3 when installed in vendor/plugins
+ * #55 by mnoack - correct binstubs arg in test
+ * #54 by gkop - Lograge config snippet works with Rails 4.2.7.1, lograge 0.4.1 
+ * Used ideas from #52 - use middleware to catch Rails stack exceptions
+ * #51 by tokenshift - Fixing NameError on `basic_auth_username`.
+ * Changes to address #50 by fillphafftek - allow standard check to be run from middleware if configured to do so, removed requirement for "middleware" to be passed in url for middleware tests
 * 2.4.0
  * Added tests for middleware
  * Changed contributed middleware code to conform to existing url scheme

data/README.rdoc

@@ -76,7 +76,7 @@ To change the configuration of health_check, create a file `config/initializers/
 
     HealthCheck.setup do |config|
 
-      # uri prefix
+      # uri prefix (no leading slash)
       config.uri = 'health_check'
 
       # Text output upon success
@@ -124,6 +124,13 @@ To change the configuration of health_check, create a file `config/initializers/
       # These default to nil and the endpoint is not protected
       config.basic_auth_username = 'my_username'
       config.basic_auth_password = 'my_password'
+
+      # Whitelist requesting IPs
+      # Defaults to blank and allows any IP
+      config.origin_ip_whitelist = %w(123.123.123.123)
+
+      # http status code used when the ip is not allowed for the request
+      config.http_status_for_ip_whitelist_error = 403
     end
 
 You may call add_custom_check multiple times with different tests. These tests will be included in the default list ("standard").
@@ -133,15 +140,21 @@ If you have a catchall route then add the following line above the catch all rou
 
 === Installing As Middleware
 
-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.
+Install health_check as middleware if you want to sometimes ignore exceptions from later parts of the Rails middleware stack,
+eg DB connection errors from QueryCache. 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.
+remaining checks continue to run through the complete rails stack.
+
+You can also adjust what checks are run from middleware, eg if you want to exclude the checking of the database etc, then set
+  config.middleware_checks = ['middleware', 'standard', 'custom']
+  config.standard_checks = ['middleware', 'custom']
+
+Middleware checks are run first, and then full stack checks.
+When installed as middleware, exceptions thrown when running the full stack tests are formatted in the standard way.
 
 == Uptime Monitoring
 
@@ -200,7 +213,7 @@ It is recomended that you use silencer, lograge or one of the other log filterin
 
 For example, with lograge use the following to exclude health_check from being logged:
 
-    config.lograge.ignore_actions = ["health_check/health_check#index"]
+    config.lograge.ignore_actions = ["HealthCheck::HealthCheckController#index"]
 
 Likewise you will probably want to exclude health_check from monitoring systems like newrelic.
 
@@ -277,7 +290,7 @@ The command `rake test` will also launch these tests, except it cannot install t
 
 == Copyright
 
-Copyright (c) 2010-2014 Ian Heggie, released under the MIT license.
+Copyright (c) 2010-2016 Ian Heggie, released under the MIT license.
 See MIT-LICENSE for details.
 
 == Contributors

data/Rakefile

@@ -3,38 +3,9 @@ require "bundler/gem_tasks"
 #require 'rubygems'
 require 'rake'
 
-# Tests are conducted with health_test as a plugin
-environment_file = File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'environment.rb')
-plugin_dir = File.join(File.dirname(__FILE__), '..', 'plugins')
-
-if File.exists?(environment_file) and File.directory?(plugin_dir)
-  # test as plugin
-  
-  require 'rake/testtask'
-  Rake::TestTask.new(:test) do |test|
-    test.libs << 'lib' << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-
-  begin
-    require 'rcov/rcovtask'
-    Rcov::RcovTask.new do |test|
-      test.libs << 'test'
-      test.pattern = 'test/**/*_test.rb'
-      test.verbose = true
-    end
-  rescue LoadError
-    task :rcov do
-      abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-    end
-  end
-
-else
-  #tests as gem
-  task :test do
-    exec '/bin/bash', './test/test_with_railsapp'
-  end
+#tests as gem
+task :test do
+  exec '/bin/bash', './test/test_with_railsapp'
 end
 
 task :default => :test

data/lib/health_check.rb

@@ -23,6 +23,14 @@ module HealthCheck
   mattr_accessor :http_status_for_error_object
   self.http_status_for_error_object = 500
 
+  # http status code used when the ip is not allowed for the request
+  mattr_accessor :http_status_for_ip_whitelist_error
+  self.http_status_for_ip_whitelist_error = 403
+
+  # ips allowed to perform requests
+  mattr_accessor :origin_ip_whitelist
+  self.origin_ip_whitelist = []
+
   # max-age of response in seconds
   # cache-control is public when max_age > 1 and basic authentication is used
   mattr_accessor :max_age
@@ -32,7 +40,7 @@ module HealthCheck
   mattr_accessor :buckets
   self.buckets = {}
 
-  # health check uri path for middleware check
+  # health check uri path
   mattr_accessor :uri
   self.uri = 'health_check'
 
@@ -49,6 +57,12 @@ module HealthCheck
   self.full_checks = ['database', 'migrations', 'custom', 'email', 'cache', 'redis-if-present', 'sidekiq-redis-if-present', 'resque-redis-if-present', 's3-if-present']
   self.standard_checks = [ 'database', 'migrations', 'custom', 'emailconf' ]
 
+  # Middleware based checks
+  mattr_accessor :middleware_checks
+  self.middleware_checks = [ 'middleware' ]
+
+  mattr_accessor :installed_as_middleware
+
   def self.add_custom_check(&block)
     custom_checks << block
   end

data/lib/health_check/health_check_controller.rb

@@ -5,6 +5,7 @@ module HealthCheck
   class HealthCheckController < ActionController::Base
 
     layout false if self.respond_to? :layout
+    before_action :check_origin_ip
     before_action :authenticate
 
     def index
@@ -13,34 +14,21 @@ module HealthCheck
       if max_age > 1
         last_modified = Time.at((last_modified.to_f / max_age).floor * max_age).utc
       end
-      public = (max_age > 1) && ! basic_auth_username
+      public = (max_age > 1) && ! HealthCheck.basic_auth_username
       if stale?(:last_modified => last_modified, :public => public)
-        # Rails 4.0 doesn't have :plain, but it is deprecated later on
-        plain_key = Rails.version < '4.1' ? :text : :plain
-        checks = params[:checks] || 'standard'
+        checks = params[:checks] ? params[:checks].split('_') : ['standard']
+        checks -= HealthCheck.middleware_checks if HealthCheck.installed_as_middleware
         begin
           errors = HealthCheck::Utils.process_checks(checks)
         rescue Exception => e
           errors = e.message.blank? ? e.class.to_s : e.message.to_s
-        end     
+        end
         response.headers['Cache-control'] = (public ? 'public' : 'private') + ', no-cache, must-revalidate' + (max_age > 0 ? ", max-age=#{max_age}" : '')
         if errors.blank?
-          obj = { :healthy => true, :message => HealthCheck.success }
-          respond_to do |format|
-            format.html { render plain_key => HealthCheck.success, :content_type => 'text/plain' }
-            format.json { render :json => obj }
-            format.xml { render :xml => obj }
-            format.any { render plain_key => HealthCheck.success, :content_type => 'text/plain' }
-          end
+          send_response nil, :ok, :ok
         else
           msg = "health_check failed: #{errors}"
-          obj = { :healthy => false, :message => msg }
-          respond_to do |format|
-            format.html { render plain_key => msg, :status => HealthCheck.http_status_for_error_text, :content_type => 'text/plain'  }
-            format.json { render :json => obj, :status => HealthCheck.http_status_for_error_object}
-            format.xml { render :xml => obj, :status => HealthCheck.http_status_for_error_object }
-            format.any { render plain_key => msg, :status => HealthCheck.http_status_for_error_text, :content_type => 'text/plain'  }
-          end
+          send_response msg, HealthCheck.http_status_for_error_text, HealthCheck.http_status_for_error_object
           # Log a single line as some uptime checkers only record that it failed, not the text returned
           if logger
             logger.info msg
@@ -49,20 +37,44 @@ module HealthCheck
       end
     end
 
-
     protected
 
+    def send_response(msg, text_status, obj_status)
+      healthy = !msg
+      msg ||= HealthCheck.success
+      obj = { :healthy => healthy, :message => msg}
+      respond_to do |format|
+        format.html { render plain_key => msg, :status => text_status, :content_type => 'text/plain' }
+        format.json { render :json => obj, :status => obj_status }
+        format.xml { render :xml => obj, :status => obj_status }
+        format.any { render plain_key => msg, :status => text_status, :content_type => 'text/plain' }
+      end
+    end
+
     def authenticate
       return unless HealthCheck.basic_auth_username && HealthCheck.basic_auth_password
-      authenticate_or_request_with_http_basic do |username, password|
+      authenticate_or_request_with_http_basic('Health Check') do |username, password|
         username == HealthCheck.basic_auth_username && password == HealthCheck.basic_auth_password
       end
     end
 
+    def check_origin_ip
+      unless HealthCheck.origin_ip_whitelist.blank? ||
+          HealthCheck.origin_ip_whitelist.include?(request.ip)
+        render plain_key => 'Health check is not allowed for the requesting IP',
+               :status => HealthCheck.http_status_for_ip_whitelist_error,
+               :content_type => 'text/plain'
+      end
+    end
+
     # turn cookies for CSRF off
     def protect_against_forgery?
       false
     end
 
+    def plain_key
+      # Rails 4.0 doesn't have :plain, but it is deprecated later on
+      Rails.version < '4.1' ? :text : :plain
+    end
   end
 end

data/lib/health_check/health_check_routes.rb

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

data/lib/health_check/middleware_health_check.rb

@@ -6,13 +6,20 @@ module HealthCheck
     end
 
     def call(env)
-      uri = env['PATH_INFO']
-      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
+      (response_type, middleware_checks, full_stack_checks) = parse_env(env)
+      if response_type
+        if error_response = (ip_blocked(env) || not_authenticated(env))
+          return error_response
+        end
+        HealthCheck.installed_as_middleware = true
+        errors = ''
         begin
-          errors = HealthCheck::Utils.process_checks(checks)
+          # Process the checks to be run from middleware
+          errors = HealthCheck::Utils.process_checks(middleware_checks, true)
+          # Process remaining checks through the full stack if there are any
+          unless full_stack_checks.empty?
+            return @app.call(env)
+          end
         rescue => e
           errors = e.message.blank? ? e.class.to_s : e.message.to_s
         end
@@ -21,17 +28,75 @@ module HealthCheck
         if response_type == 'xml'
           content_type = 'text/xml'
           msg = { healthy: healthy, message: msg }.to_xml
+          error_code = HealthCheck.http_status_for_error_object
         elsif response_type == 'json'
           content_type = 'application/json'
           msg = { healthy: healthy, message: msg }.to_json
+          error_code = HealthCheck.http_status_for_error_object
         else
           content_type = 'text/plain'
+          error_code = HealthCheck.http_status_for_error_text
         end
-        [ (healthy ? 200 : 500), { 'Content-Type' => content_type }, [msg] ]
+        [ (healthy ? 200 : error_code), { 'Content-Type' => content_type }, [msg] ]
       else
         @app.call(env)
       end
     end
 
+    protected
+
+    def parse_env(env)
+      uri = env['PATH_INFO']
+      if uri =~ /^\/#{Regexp.escape HealthCheck.uri}(\/([-_0-9a-zA-Z]*))?(\.(\w*))?$/
+        checks = $2.to_s == '' ? ['standard'] : $2.split('_')
+        response_type = $4.to_s
+        middleware_checks = checks & HealthCheck.middleware_checks
+        full_stack_checks = (checks - HealthCheck.middleware_checks) - ['and']
+        [response_type, middleware_checks, full_stack_checks ]
+      end
+    end
+
+    def ip_blocked(env)
+      return false if HealthCheck.origin_ip_whitelist.blank?
+      req = Rack::Request.new(env)
+      unless HealthCheck.origin_ip_whitelist.include?(req.ip)
+        [ HealthCheck.http_status_for_ip_whitelist_error,
+          { 'Content-Type' => 'text/plain' },
+          [ 'Health check is not allowed for the requesting IP' ]
+        ]
+      end
+    end
+
+    def not_authenticated(env)
+      return false unless HealthCheck.basic_auth_username && HealthCheck.basic_auth_password
+      auth = MiddlewareHealthcheck::Request.new(env)
+      if auth.provided? && auth.basic? && Rack::Utils.secure_compare(HealthCheck.basic_auth_username, auth.username) && Rack::Utils.secure_compare(HealthCheck.basic_auth_password, auth.password)
+        env['REMOTE_USER'] = auth.username
+        return false
+      end
+      [ 401,
+        { 'Content-Type' => 'text/plain', 'WWW-Authenticate' => 'Basic realm="Health Check"' },
+        [ ]
+      ]
+    end
+
+    class Request < Rack::Auth::AbstractRequest
+      def basic?
+        "basic" == scheme
+      end
+
+      def credentials
+        @credentials ||= params.unpack("m*").first.split(/:/, 2)
+      end
+
+      def username
+        credentials.first
+      end
+
+      def password
+        credentials.last
+      end
+    end
+
   end
 end

data/lib/health_check/utils.rb

@@ -17,9 +17,10 @@ module HealthCheck
 
     cattr_accessor :default_smtp_settings
 
-    def self.process_checks(checks)
+    # process an array containing a list of checks
+    def self.process_checks(checks, called_from_middleware = false)
       errors = ''
-      checks.split('_').each do |check|
+      checks.each do |check|
         case check
           when 'and', 'site'
             # do nothing
@@ -63,15 +64,17 @@ module HealthCheck
           when 's3'
             errors << HealthCheck::S3HealthCheck.check
           when "standard"
-            errors << HealthCheck::Utils.process_checks(HealthCheck.standard_checks.join('_'))
+            errors << HealthCheck::Utils.process_checks(HealthCheck.standard_checks, called_from_middleware)
+          when "middleware"
+            errors << "Health check not called from middleware - probably not installed as middleware." unless called_from_middleware
           when "custom"
             HealthCheck.custom_checks.each do |custom_check|
               errors << custom_check.call(self)
             end
           when "all", "full"
-            errors << HealthCheck::Utils.process_checks(HealthCheck.full_checks.join('_'))
+            errors << HealthCheck::Utils.process_checks(HealthCheck.full_checks, called_from_middleware)
           else
-            return "invalid argument to health_test. "
+            return "invalid argument to health_test."
         end
       end
       return errors

data/lib/health_check/version.rb

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

data/test/setup_railsapp

@@ -70,16 +70,16 @@ rake="$base_dir/test/bin/rake"
 
 echo Checking $rails is present ...
 [ -f $rails -a -f $rake ] || bundle exec rake rails:update:bin || echo '(ignored rake rails:update:bin exit status)'
-[ -f $rails ] || bundle binstub railties || echo '(ignored bundle exit status)'
-[ -f $rails ] || bundle binstub rails || echo '(ignored bundle exit status)'
+[ -f $rails ] || bundle binstubs railties || echo '(ignored bundle exit status)'
+[ -f $rails ] || bundle binstubs rails || echo '(ignored bundle exit status)'
 if [ ! -f $rails ]; then
     echo "Test aborted (unable to create $rails)"
     exit 2
 fi
 
 if [ ! -f $rake ]; then
-    echo "Running bundle --binstub rake ..."
-    if ! bundle --binstub rake || [ ! -f $rake ]; then
+    echo "Running bundle binstubs rake ..."
+    if ! bundle binstubs rake || [ ! -f $rake ]; then
         echo "Test aborted (unable to create $rake)"
         exit 2
     fi
@@ -168,6 +168,9 @@ HealthCheck.setup do |config|
   config.http_status_for_error_text = 550
   config.http_status_for_error_object = 555
   config.uri = '$route_prefix'
+  config.origin_ip_whitelist = ENV['IP_WHITELIST'].split(',') unless ENV['IP_WHITELIST'].blank?
+  config.basic_auth_username = ENV['AUTH_USER'] unless ENV['AUTH_USER'].blank?
+  config.basic_auth_password = ENV['AUTH_PASSWORD'] unless ENV['AUTH_PASSWORD'].blank?
 
   config.add_custom_check do
     File.exists?("$custom_file") ? '' : '$custom_file is missing!'
@@ -208,15 +211,15 @@ then
 
     echo Checking $rails is present ...
     [ -f $rails -a -f $rake ] || bundle exec rake rails:update:bin || echo '(ignored rake rails:update:bin exit status)'
-    [ -f $rails ] || bundle binstub railties || echo '(ignored bundle exit status)'
-    [ -f $rails ] || bundle binstub rails || echo '(ignored bundle exit status)'
+    [ -f $rails ] || bundle binstubs railties || echo '(ignored bundle exit status)'
+    [ -f $rails ] || bundle binstubs rails || echo '(ignored bundle exit status)'
     if [ ! -f $rails ]; then
         echo "Test aborted (unable to create $rails)"
         exit 2
     fi
 
     echo Checking $rake is present ...
-    [ -f $rake ] || bundle binstub rake || echo '(ignored bundle exit status)'
+    [ -f $rake ] || bundle binstubs rake || echo '(ignored bundle exit status)'
     if [ ! -f $rake ]; then
         echo "Test aborted (unable to create $rake)"
         exit 2

data/test/test_with_railsapp

@@ -141,24 +141,33 @@ stop_server()
         [0-9]*)
             echo ========================================================
             echo "Killing rails server [pid: $server_pid]"
-            kill -1 $server_pid  || true
-            [ ! -x bin/spring ] || bin/spring stop || true
-            sleep 2
-            kill -9 $server_pid  || true
+            kill -QUIT $server_pid  || echo server has already exited ..
+            if [ -x bin/spring ] ; then
+                echo Stopping spring ...
+                bin/spring stop || echo spring had already exited ..
+            fi
+            sleep 1
+            kill -9 $server_pid  || echo server had already exited ...
+            sleep 1
+            # needed for unicorn - it doesn't die when it is supposed to
+            killall "$server_arg" || echo server and child processes had already stopped ...
             ;;
     esac
     case "$fake_smtp_pid" in
         [0-9]*)
             echo ========================================================
             echo "Killing fake smtp server [pid: $fake_smtp_pid]"
-            kill -1 $fake_smtp_pid || true
+            kill -QUIT $fake_smtp_pid || echo fake_smtp had already exited ..
             sleep 2
-            kill -9 $fake_smtp_pid || true
+            kill -9 $fake_smtp_pid || echo fake_smtp had already exited ..
             ;;
     esac
     server_pid=''
     fake_smtp_pid=''
+    ps -f
+    echo Waiting for sub processes to complete ...
     wait
+    echo Finished waiting for sub processes, sleeping 2 seconds ...
     sleep 2
 }
 
@@ -188,7 +197,9 @@ finish()
     stop_server
     trap "" 0
     echo ========================================================
-    echo TEST ${1:-FAILED}
+    ps uxf || echo ps failed
+    echo ========================================================
+    echo TEST ${1:-FAILED}, exiting with status ${2:-2}
     echo ========================================================
     exit ${2:-2}
 }
@@ -476,22 +487,114 @@ common_tests()
     date > $custom_file
 }
 
-
 # required for rails 4.1+ in production mode
 export SECRET_KEY_BASE=cf2f49c38a3fe67416ddf680f4f3187c0fce7dd1b9b117b34d195df75b274e08a04877e23803b2fdf1aa9a655269d94bc4888aa325cf7e721cc47368cfe56a80
 
 # required for rails 5 to server static files
 export RAILS_SERVE_STATIC_FILES=on
 
+export IP_WHITELIST='123.123.123.123'
+unset AUTH_USER
+unset AUTH_PASSWORD
+
 case "$run_test" in
-???)
+''|[12])
+    echo ========================================================
+    echo TESTING whitelist ban WITHOUT CATCHALL in test env
+    echo ========================================================
+    export RAILS_ENV=test RACK_ENV=test
+
+    start_server
+
+    echo '1: TESTING controller prohibited by ip...'
+    expected_status=403
+    $testurl ${host}/${route_prefix}/site $expected_status
+
+    if $has_middleware; then
+        echo
+        echo '2: TESTING middleware prohibited by ip...'
+        expected_status=403
+        $testurl ${host}/${route_prefix}/middleware $expected_status
+    fi
     ;;
-*)
+esac
+
+export IP_WHITELIST=''
+export AUTH_USER='someone'
+export AUTH_PASSWORD='secret'
+
+case "$run_test" in
+''|[3456789]|10)
     echo ========================================================
-    echo TESTING WITHOUT CATCHALL in test env
+    echo TESTING basic auth, no whitelist WITHOUT CATCHALL in test env
     echo ========================================================
     export RAILS_ENV=test RACK_ENV=test
 
+    case "$run_trest" in
+     '')
+        stop_server
+        cleanup_db
+        ;;
+    esac
+
+    start_server
+
+    expected_status=401
+    echo '3: TESTING controller without authentication insists on authentication ...'
+    AUTH_USER= $testurl ${host}/${route_prefix}/site $expected_status
+
+    echo '4: TESTING controller with wrong password insists on authentication ...'
+    AUTH_PASSWORD=wrong $testurl ${host}/${route_prefix}/site $expected_status
+
+    echo '5: TESTING controller with wrong user insists on authentication ...'
+    AUTH_USER=wrong $testurl ${host}/${route_prefix}/site $expected_status
+
+    echo '6: TESTING controller with authentication works ...'
+    expected_status=200
+    $testurl ${host}/${route_prefix}/site $expected_status
+
+    if $has_middleware; then
+        echo
+        echo '7: TESTING middleware without authentication insists on authentication ...'
+        expected_status=401
+        AUTH_USER= $testurl ${host}/${route_prefix}/middleware $expected_status
+
+        echo
+        echo '8: TESTING middleware with wrong password insists on authentication ...'
+        AUTH_PASSWORD=wrong $testurl ${host}/${route_prefix}/middleware $expected_status
+
+        echo
+        echo '9: TESTING middleware with wrong user insists on authentication ...'
+        AUTH_USER=wrong $testurl ${host}/${route_prefix}/middleware $expected_status
+
+        echo
+        echo '10: TESTING middleware with authentication works ...'
+        expected_status=200
+        $testurl ${host}/${route_prefix}/middleware $expected_status
+    else
+        echo
+        echo "Skipped middleware tests as it is not configured..."
+    fi
+    ;;
+esac
+
+unset AUTH_USER
+unset AUTH_PASSWORD
+
+case "$run_test" in
+''|1??)
+    echo ========================================================
+    echo TESTING WITHOUT CATCHALL, no whitelist or user in test env
+    echo ========================================================
+    export RAILS_ENV=test RACK_ENV=test
+
+    case "$run_trest" in
+     '')
+        stop_server
+        cleanup_db
+        ;;
+    esac
+
     start_server
 
     # get a static file
@@ -505,15 +608,18 @@ case "$run_test" in
     expected_status=404,500,502
     $testurl ${host}/health_check/site $expected_status
 
-    common_tests 1
+    common_tests 100
     ;;
 esac
 
+export IP_WHITELIST='127.0.0.1'
+export AUTH_USER='someone'
+export AUTH_PASSWORD='secret'
 
 case "$run_test" in
-''|???)
+''|2??)
     echo ========================================================
-    echo TESTING WITH CATCHALL in ${RAILS_ENV2:-production} env
+    echo TESTING WITH CATCHALL with whitelist and user in ${RAILS_ENV2:-production} env
     echo ========================================================
     export RAILS_ENV=${RAILS_ENV2:-production} RACK_ENV=${RAILS_ENV2:-production}
 
@@ -533,7 +639,7 @@ case "$run_test" in
     $testurl ${host}/another/url 200 text/html 'catch all route'
     echo
 
-    common_tests 101
+    common_tests 200
     ;;
 esac
 
@@ -542,4 +648,4 @@ rm -f $catchall_file
 finish PASSED 0
 exit 0
 
-# vi: sw=4 ai sm:
+# vi: sw=4 ai sm:

data/test/testurl

@@ -3,7 +3,11 @@ require 'net/http'
 require 'uri'
 
 def open(url)
-  Net::HTTP.get_response(URI.parse(url))
+  parsed_uri = URI.parse(url)
+  http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+  req = Net::HTTP::Get.new(parsed_uri.request_uri)
+  req.basic_auth(ENV['AUTH_USER'], ENV['AUTH_PASSWORD'].to_s) if ENV['AUTH_USER']
+  http.request(req)
 end
 
 response = open(ARGV[0]) rescue nil
@@ -11,6 +15,7 @@ unless response
   i=0
   print "waiting.."
   while i < 120 and not response
+    #puts 'RESPONSE:', response.inspect
     print "."
     STDOUT.flush
     i += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health_check
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Ian Heggie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,11 +110,8 @@ files:
 - test/rails_5.0.gemfile
 - test/rails_edge.gemfile
 - test/setup_railsapp
-- test/test_helper.rb
 - test/test_with_railsapp
 - test/testurl
-- test/unit/health_check_controller_test.rb
-- test/unit/routes_test.rb
 homepage: https://github.com/ianheggie/health_check
 licenses: []
 metadata: {}
@@ -153,8 +150,5 @@ test_files:
 - test/rails_5.0.gemfile
 - test/rails_edge.gemfile
 - test/setup_railsapp
-- test/test_helper.rb
 - test/test_with_railsapp
 - test/testurl
-- test/unit/health_check_controller_test.rb
-- test/unit/routes_test.rb

data/test/test_helper.rb

@@ -1,68 +0,0 @@
-ENV['RAILS_ENV'] = 'test'
-
-require 'test/unit'
-require 'rubygems'
-
-# Tests are conducted with health_test as a plugin
-environment_file = File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'config', 'environment.rb')
-if File.exists?(environment_file)
-  # test as plugin
-  require environment_file
-else
-  #tests as gem
-  fail "TODO: Work out how to test as a gem (test as a plugin instead)"
-end
-
-gem "shoulda"
-require 'shoulda'
-require 'shoulda/action_controller'
-
-# rails test help
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-# gem init
-#require 'health_check'
-
-# plugin init
-require File.join(File.dirname(__FILE__), '..', 'init')
-
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:", :database => 'health_test_test')
-
-EXAMPLE_SMTP_SETTINGS = {
-  :address => "smtp.gmail.com",
-  :domain => "test.example.com",
-  :port => 587
-}
-
-ActionMailer::Base.delivery_method = :test
-
-# Make sure sendmail settings are set to something that is executrable (we wont actually execute it)
-sendmail_path = '/usr/sbin/sendmail'
-['/bin/true', 'c:/windows/explorer.exe', 'c:/winnt/explorer.exe',
-  File.join(Rails.root, 'script', 'about')].each do |f|
-  sendmail_path = f if File.executable? f
-end
-
-EXAMPLE_SENDMAIL_SETTINGS = {
-  :location => sendmail_path,
-  :arguments => '--help'
-}
-
-def setup_db(version)
-  ActiveRecord::Base.connection.initialize_schema_migrations_table
-  ActiveRecord::Schema.define(:version => version) do
-    create_table :kitchen do |t|
-      t.column :owner, :string
-      t.column :description, :string
-    end
-  end if version
-end
-
-def teardown_db
-  ActiveRecord::Base.connection.tables.each do |table|
-    ActiveRecord::Base.connection.drop_table(table)
-  end
-end
-

data/test/unit/health_check_controller_test.rb

@@ -1,175 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper'
-
-class HealthCheckControllerTest < ActionController::TestCase
-  #context "HealthCheck plugin" do
-  #   should route :get, "/health_check", :controller => :health_check, :action => :index
-  #    should route :get, "/health_check/two_checks", :controller => :health_check, :action => :index, :checks => 'two_checks'
-  #end
-
-  context "GET standard on empty db" do
-    setup do
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'empty')
-      setup_db(nil)
-      ActionMailer::Base.delivery_method = :test
-      get :index
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with :success
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "return 'success' text" do
-      assert_equal HealthCheck.success, @response.body
-    end
-  end
-
-  context "GET migrations on db with migrations" do
-    setup do
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'twelve')
-      setup_db(12)
-      ActionMailer::Base.delivery_method = :test
-      get :check, :checks => 'migrations'
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with :success
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "return 'success' text" do
-      assert_equal HealthCheck.success, @response.body
-    end
-  end
-
-  context "GET standard with unactioned migrations" do
-    setup do
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'twelve')
-      setup_db(nil)
-      ActionMailer::Base.delivery_method = :test
-      get :index
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with 500
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "not return 'success' text" do
-      assert_not_equal HealthCheck.success, @response.body
-    end
-  end
-
-  context "GET email with :test" do
-    setup do
-      ActionMailer::Base.delivery_method = :test
-      get :check, :checks => 'email'
-    end
-
-    should respond_with :success
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "return 'success' text" do
-      assert_equal HealthCheck.success, @response.body
-    end
-  end
-
-  context "GET standard with bad smtp" do
-    setup do
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'twelve')
-      setup_db(12)
-      HealthCheck.smtp_timeout = 2.0
-      ActionMailer::Base.delivery_method = :smtp
-      ActionMailer::Base.smtp_settings = {
-        :address => "127.0.0.1",
-        :domain => "testing.example.com",
-        :port => 7
-      }
-      get :index
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with 500
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "not return 'success' text" do
-      assert_not_equal HealthCheck.success, @response.body
-    end
-  end
-
-
-  context "GET email with :smtp" do
-    setup do
-      # it should not care that the database isnt setup correctly
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'empty')
-      setup_db(nil)
-      ActionMailer::Base.delivery_method = :smtp
-      HealthCheck.smtp_timeout = 60.0
-      ActionMailer::Base.smtp_settings = EXAMPLE_SMTP_SETTINGS
-      get :check, :checks => 'email'
-    end
-
-    should respond_with :success
-    should respond_with_content_type 'text/plain'
-    should "return 'success' text" do
-      assert_equal HealthCheck.success, @response.body
-    end
-  end
-
-
-  context "GET database_migration_email with missing sendmail" do
-    setup do
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'twelve')
-      setup_db(12)
-      ActionMailer::Base.delivery_method = :sendmail
-      ActionMailer::Base.sendmail_settings = { :location => '/no/such/executable', :arguments => '' }
-      get :check, :checks => 'database_migration_email'
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with 500
-    should_not set_the_flash
-    should respond_with_content_type 'text/plain'
-    should_not render_with_layout
-    should "not return 'success' text" do
-      assert_not_equal HealthCheck.success, @response.body
-    end
-  end
-
-  context "GET all with :sendmail" do
-    setup do
-      ActionMailer::Base.delivery_method = :sendmail
-      ActionMailer::Base.sendmail_settings = EXAMPLE_SENDMAIL_SETTINGS
-      HealthCheck.db_migrate_path = File.join(File.dirname(__FILE__), 'migrate', 'empty')
-      setup_db(nil)
-      get :check, :checks => 'all'
-    end
-
-    teardown do
-      teardown_db
-    end
-
-    should respond_with :success
-    should respond_with_content_type 'text/plain'
-    should "return 'success' text" do
-      assert_equal HealthCheck.success, @response.body
-    end
-  end
-end

data/test/unit/routes_test.rb

@@ -1,42 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper'
-
-class RoutingTest < Test::Unit::TestCase
-
-  def setup
-    if defined?(Rails) and defined?(Rails.application) and Rails.application.routes
-      Rails.application.routes.draw do |map|
-	 # do nothing - routes should be added automatically
-      end
-    else
-      ActionController::Routing::Routes.draw do |map|
-	 # do nothing - routes should be added automatically
-      end
-    end
-  end
-
-  def test_health_check_plain_route
-    assert_recognition :get, "/health_check", :controller => "health_check", :action => "index"
-  end
-
-  def test_health_check_checks_specified_route
-    assert_recognition :get, "/health_check/two_checks", :controller => "health_check", :action => "check", :checks => 'two_checks'
-  end
-
-  private
-
-  # yes, I know about assert_recognizes, but it has proven problematic to
-  # use in these tests, since it uses RouteSet#recognize (which actually
-  # tries to instantiate the controller) and because it uses an awkward
-  # parameter order.
-  def assert_recognition(method, path, options)
-    if defined?(Rails) and defined?(Rails.application) and Rails.application.routes
-      result = Rails.application.routes.recognize_path(path, :method => method)
-    else
-      result = ActionController::Routing::Routes.recognize_path(path, :method => method)
-    end
-    assert_equal options, result
-  end
-
-  # with Thanks to http://izumi.plan99.net/manuals/creating_plugins-8f53e4d6.html
-
-end