health_check 0.2.4 → 1.0.1

data/lib/health_check/health_check_controller.rb

@@ -1,70 +1,99 @@
-class HealthCheckController < ActionController::Base
-  session(:off) if Rails::VERSION::STRING < '2.3'
-  layout nil
+# Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
+# See MIT-LICENSE for details.
 
-  def index
-    do_check('standard')
-  end
+module HealthCheck
+  class HealthCheckController < ActionController::Base
 
-  def check
-    do_check(params[:checks])
-  end
+    # turn sessions off if we can
+    session(:off) rescue nil
 
-  private
+    layout nil
 
-  def do_check(checks)
-    begin
-      errors = process_checks(checks)
-    rescue Exception => e
-      errors = e.message
-    end     
-    if errors.blank?
-      render :text => HealthCheck.success, :content_type => 'text/plain'
-    else
-      msg = "health_check failed: #{errors}"
-      render :text => msg, :status => 500, :content_type => 'text/plain'
-      # Log a single line as some uptime checkers only record that it failed, not the text returned
-      silence_level, logger.level = logger.level, @old_logger_level
-      logger.info msg
-      logger.level = silence_level
+    def index
+      do_check('standard')
     end
-  end
 
-  def process_checks(checks)
-    errors = ''
-    checks.split('_').each do |check|
-      case check
-      when 'and', 'site'
-        # do nothing
-      when "database"
-        HealthCheck.get_database_version
-      when "email"
-        errors << HealthCheck.check_email
-      when "migrations", "migration"
-        database_version = HealthCheck.get_database_version
-        migration_version = HealthCheck.get_migration_version
-        if database_version.to_i != migration_version.to_i
-          errors << "Current database version (#{database_version}) does not match latest migration (#{migration_version}). "
-        end
-      when "standard"
-        errors << process_checks("database_migrations")
-        errors << process_checks("email") unless HealthCheck.default_action_mailer_configuration?
-      when "all", "full"
-        errors << process_checks("database_migrations_email")
+    def check
+      do_check(params[:checks])
+    end
+
+    private
+
+    def do_check(checks)
+      begin
+        errors = process_checks(checks)
+      rescue Exception => e
+        errors = e.message
+      end     
+      if errors.blank?
+        render :text => HealthCheck::Utils.success, :content_type => 'text/plain'
       else
-        return "invalid argument to health_test. "
+        msg = "health_check failed: #{errors}"
+        render :text => msg, :status => 500, :content_type => 'text/plain'
+        # Log a single line as some uptime checkers only record that it failed, not the text returned
+        if logger
+          silence_level, logger.level = logger.level, @old_logger_level
+          logger.info msg
+          logger.level = silence_level
+        end
       end
     end
-    return errors
-  end
 
+    def process_checks(checks)
+      errors = ''
+      checks.split('_').each do |check|
+        case check
+        when 'and', 'site'
+          # do nothing
+        when "database"
+          HealthCheck::Utils.get_database_version
+        when "email"
+          errors << HealthCheck::Utils.check_email
+        when "migrations", "migration"
+          database_version = HealthCheck::Utils.get_database_version
+          migration_version = HealthCheck::Utils.get_migration_version
+          if database_version.to_i != migration_version.to_i
+            errors << "Current database version (#{database_version}) does not match latest migration (#{migration_version}). "
+          end
+        when "standard"
+          errors << process_checks("database_migrations")
+          errors << process_checks("email") unless HealthCheck::Utils.default_action_mailer_configuration?
+        when "all", "full"
+          errors << process_checks("database_migrations_email")
+        else
+          return "invalid argument to health_test. "
+        end
+      end
+      return errors
+    end
+
+    protected
 
-  def process_with_silence(*args)
-    @old_logger_level = logger.level
-    logger.silence do
-      process_without_silence(*args)
+    # turn cookies for CSRF off
+    def protect_against_forgery?
+      false
     end
-  end
 
-  alias_method_chain :process, :silence
+    # Silence logger as much as we can
+
+    def process_with_silent_log(method_name, *args)
+      if logger
+        @old_logger_level = logger.level
+        if Rails.version >= '3.2'
+          silence do
+            process_without_silent_log(method_name, *args)
+          end
+        else
+          logger.silence do
+            process_without_silent_log(method_name, *args)
+          end
+        end
+      else
+        process_without_silent_log(method_name, *args)
+      end
+    end
+
+    alias_method_chain :process, :silent_log
+
+  end
 end

data/lib/health_check/utils.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
+# See MIT-LICENSE for details.
+
+module HealthCheck
+  class Utils
+
+    @@success = "success"
+
+    cattr_accessor :success
+
+    @@smtp_timeout = 30.0
+
+    cattr_accessor :smtp_timeout
+
+    @@default_smtp_settings =
+      {
+      :address              => "localhost",
+      :port                 => 25,
+      :domain               => 'localhost.localdomain',
+      :user_name            => nil,
+      :password             => nil,
+      :authentication       => nil,
+      :enable_starttls_auto => true,
+    }
+
+    cattr_accessor :default_smtp_settings
+
+    def self.db_migrate_path
+      # Lazy initialisation so Rails.root will be defined
+      @@db_migrate_path ||= File.join(Rails.root, 'db', 'migrate')
+    end
+
+    def self.db_migrate_path=(value)
+      @@db_migrate_path = value
+    end
+
+    def self.default_action_mailer_configuration?
+      ActionMailer::Base.delivery_method == :smtp && HealthCheck::Utils.default_smtp_settings == ActionMailer::Base.smtp_settings
+    end
+
+    def self.get_database_version
+      ActiveRecord::Migrator.current_version
+    end
+
+    def self.get_migration_version(dir = self.db_migrate_path)
+      latest_migration = nil
+      Dir[File.join(dir, "[0-9]*_*.rb")].each do |f|
+        l = f.scan(/0*([0-9]+)_[_a-zA-Z0-9]*.rb/).first.first
+        latest_migration = l if !latest_migration || l.to_i > latest_migration.to_i
+      end
+      latest_migration
+    end
+
+    def self.check_email
+      case ActionMailer::Base.delivery_method
+      when :smtp
+        HealthCheck::Utils.check_smtp(ActionMailer::Base.smtp_settings, HealthCheck::Utils.smtp_timeout)
+      when :sendmail
+        HealthCheck::Utils.check_sendmail(ActionMailer::Base.sendmail_settings)
+      else
+        ''
+      end
+    end
+
+
+    def self.check_sendmail(settings)
+      File.executable?(settings[:location]) ? '' : 'no sendmail executable found. '
+    end
+
+    def self.check_smtp(settings, timeout)
+      status = ''
+      begin
+        if @skip_external_checks
+          status = '221'
+        else
+          Timeout::timeout(timeout) do |timeout_length|
+            t = TCPSocket.new(settings[:address], settings[:port])
+            begin
+              status = t.gets
+              while status != nil && status !~ /^2/
+                status = t.gets
+              end
+              t.puts "HELO #{settings[:domain]}"
+              while status != nil && status !~ /^250/
+                status = t.gets
+              end
+              t.puts "QUIT"
+              status = t.gets
+            ensure
+              t.close
+            end
+          end
+        end
+      rescue  Errno::EBADF => ex
+        status = "Unable to connect to service"
+      rescue Exception => ex
+        status = ex.to_s
+      end
+      (status =~ /^221/) ? '' : "SMTP: #{status || 'unexpected EOF on socket'}. "
+    end
+
+  end
+end

data/test/migrate/nine/9_create_countries.rb

@@ -0,0 +1,11 @@
+class CreateCountries < ActiveRecord::Migration
+  def self.up
+    create_table :countries do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :countries
+  end
+end

data/test/migrate/twelve/012_create_users.rb

@@ -1,7 +1,8 @@
 class CreateUsers < ActiveRecord::Migration
   def self.up
     create_table "users", :force => true do |t|
-      t.column :name,                :string
+      t.column :name, :string
+    end
   end
 
   def self.down

data/test/{helper.rb → test_helper.rb}

@@ -13,7 +13,6 @@ else
   fail "TODO: Work out how to test as a gem (test as a plugin instead)"
 end
 
-
 gem "shoulda"
 require 'shoulda'
 require 'shoulda/action_controller'

data/test/test_with_railsapp

@@ -0,0 +1,164 @@
+#!/bin/bash
+
+# Any failure causes exit
+set -e
+
+base_dir=`pwd`
+
+testurl=$base_dir/test/testurl
+
+test_dir=`pwd`/tmp
+rm -rf tmp/Gemfile* tmp/railsapp tmp/bin tmp/gems
+mkdir -p tmp/gems
+
+echo Installing health_check as a gem into tmp/gems
+env GEM_HOME=$test_dir/gems rake install
+
+export GEM_PATH="$test_dir/gems:`gem environment gempath`"
+echo Set GEM_PATH=$GEM_PATH
+
+echo Gems in tmp/gems:
+ls tmp/gems
+
+echo GEM LIST
+gem list
+
+echo Environment:
+env | egrep 'TRAVIS|RAILS|RUBY|_ENV'
+
+server_pid=''
+
+finish()
+{
+    set +e
+    set +x
+    echo ========================================================
+    echo TEST ${1:-FAILED}
+    echo ========================================================
+    if [ -s $test_dir/railsapp/log/test.log ]
+    then
+        echo Last 300 lines of test log
+        tail -300 $test_dir/railsapp/log/test.log
+    fi
+    case "$server_pid" in
+        [0-9]*)
+            echo "Killing rails server [pid: $server_pid]"
+            kill -9 $server_pid 
+            wait
+            ;;
+    esac
+    trap "" 0
+    exit ${2:-2}
+}
+
+trap "finish FAILED 1" 0
+
+actual_rails_version=`rails -v`
+echo "Creating $actual_rails_version app in $test_dir/railsapp"
+
+cd $test_dir
+
+case "$actual_rails_version" in
+    *' '[12].*)
+        rails railsapp
+        ;;
+    *' '[34].*)
+        rails new railsapp
+        ;;
+    *)
+        echo "Unknown rails version"
+        ;;
+esac
+
+cd railsapp
+echo "Changed current directory to railsapp root: `pwd`"
+
+echo "Fixing rdoc require in Rakefile if needed"
+ruby -pi.bak -e "gsub(/rake.rdoctask/, 'rdoc/task')" Rakefile
+
+if [ -f Gemfile ]
+then
+    echo Installing health_check as gem ...
+    echo "gem 'health_check', :path => '$base_dir'" >> Gemfile
+    case "$BUNDLE_GEMFILE" in
+        ?*)
+            echo Unsetting BUNDLE_GEMFILE '(so Gemfile will be used)'
+            unset BUNDLE_GEMFILE
+            ;;
+    esac
+    bundle
+else
+    echo Installing health_check as plugin ...
+    dest=`pwd`/vendor/plugins/health_check
+    mkdir -p $dest
+    (
+        cd $base_dir
+        find . | egrep -v '/tmp|/\.git|\.gem$' | cpio -pdl $dest
+    )
+fi
+
+port=3456
+echo Starting server on port $port ...
+
+export RAILS_ENV=test
+
+if [ -x script/server ]
+then
+    script/server webrick -p $port &
+else
+    rails s webrick -p $port &
+fi
+server_pid=$!
+
+echo STATIC-FILE > public/static.txt
+
+host=http://localhost:${port}
+
+# get a static file
+echo
+echo 'TESTING can get a static file ...'
+$testurl ${host}/static.txt STATIC-FILE
+echo
+
+echo 'TESTING health_check should pass with no database migrations ...'
+mkdir -p db/migrate
+ls db/migrate
+$testurl ${host}/health_check success
+echo
+
+echo 'TESTING health_check should fail without initial database migration ...'
+cp $base_dir/test/migrate/nine/* db/migrate
+ls db/migrate
+$testurl ${host}/health_check failed
+echo
+
+echo 'TESTING health_check should pass after initial database migration ...'
+rake db:migrate 
+$testurl ${host}/health_check success
+echo
+
+echo 'TESTING health_check should fail without all migrations ...'
+cp $base_dir/test/migrate/twelve/* db/migrate
+ls db/migrate
+$testurl ${host}/health_check failed
+echo
+
+echo 'TESTING health_check should pass after both database migrations ...'
+rake db:migrate 
+$testurl ${host}/health_check success
+echo
+
+echo "Killing rails server [pid: $server_pid]"
+kill -9 $server_pid 
+server_pid=''
+
+#if [ -d vendor/plugins/health_check ]
+#then
+#    echo "RUNNING UNIT TESTS...."
+#    rake test:plugins
+#fi
+
+finish PASSED 0
+exit 0
+
+# vi: sw=4 ai sm: