health_check 1.1.2 → 1.2.0

data/lib/health_check/utils.rb

@@ -4,30 +4,54 @@
 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,
+        }
 
-    @@error_status_code = 500
+    cattr_accessor :default_smtp_settings
 
-    cattr_accessor :error_status_code
 
-    @@default_smtp_settings =
-      {
-      :address              => "localhost",
-      :port                 => 25,
-      :domain               => 'localhost.localdomain',
-      :user_name            => nil,
-      :password             => nil,
-      :authentication       => nil,
-      :enable_starttls_auto => true,
-    }
+    def self.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 'cache'
+            errors << HealthCheck::Utils.check_cache
+          when "standard"
+            errors << HealthCheck::Utils.process_checks("database_migrations_custom")
+            errors << HealthCheck::Utils.process_checks("email") unless HealthCheck::Utils.default_action_mailer_configuration?
+          when "custom"
+            HealthCheck.custom_checks.each do |custom_check|
+              errors << custom_check.call(self)
+            end
+          when "all", "full"
+            errors << HealthCheck::Utils.process_checks("database_migrations_custom_email_cache")
+          else
+            return "invalid argument to health_test. "
+        end
+      end
+      return errors
+    end
 
-    cattr_accessor :default_smtp_settings
 
     def self.db_migrate_path
       # Lazy initialisation so Rails.root will be defined
@@ -57,12 +81,12 @@ module HealthCheck
 
     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
-        ''
+        when :smtp
+          HealthCheck::Utils.check_smtp(ActionMailer::Base.smtp_settings, HealthCheck.smtp_timeout)
+        when :sendmail
+          HealthCheck::Utils.check_sendmail(ActionMailer::Base.sendmail_settings)
+        else
+          ''
       end
     end
 
@@ -95,7 +119,7 @@ module HealthCheck
             end
           end
         end
-      rescue  Errno::EBADF => ex
+      rescue Errno::EBADF => ex
         status = "Unable to connect to service"
       rescue Exception => ex
         status = ex.to_s

data/lib/health_check/version.rb

@@ -1,4 +1,4 @@
 module HealthCheck
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end
 

data/test/init_variables

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+# Any failure causes exit
+set -e
+
+echo Setting RAILS_ENV=test RACK_ENV=test
+export RAILS_ENV=test RACK_ENV=test
+
+base_dir=$PWD
+tmp_dir=$base_dir/tmp
+railsapp=$tmp_dir/railsapp
+custom_file="$railsapp/tmp/custom_check.ok"
+success=successful
+
+rehash=''
+rbenv_which='which'
+
+if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+  echo "Detected user installed rvm"
+elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+  echo "Detected root installed rvm"
+elif [[ -d "$HOME/.rbenv" ]] ; then
+  echo "Detected rbenv: `rbenv version`"
+  rehash='rbenv rehash'
+  rbenv_which='rbenv which'
+else
+  printf "Note: Neither rvm nor rbenv was not found.\n"
+fi
+
+echo "Checking required commands exist:"
+for cmd in bash gem egrep ls tail kill find cpio
+do
+    echo -n "  "
+    which $cmd || ( echo "Aborting setup_railsapp: Missing $cmd command!" && exit 2 )
+done
+for cmd in ruby gem
+do
+    echo -n "  "
+    $rbenv_which $cmd || ( echo "Aborting setup_railsapp: Missing $cmd command!" && exit 2 )
+done
+
+rails="rails"
+rake="rake"
+
+if [ -x $base_dir/test/bin/rails ]
+then
+    rails="$base_dir/test/bin/rails"
+    rake="$base_dir/test/bin/rake"
+    export PATH="$base_dir/test/bin:$PATH"
+fi
+
+if [ -x $railsapp/bin/rails ]
+then
+    rails="$railsapp/bin/rails"
+    rake="$railsapp/bin/rake"
+    export PATH="$railsapp/bin:$PATH"
+fi
+
+echo "Using rails=$rails, rake=$rake"
+

data/{rails2_3.gemfile → test/rails_2.3.gemfile}

@@ -2,9 +2,17 @@
 
 source 'https://rubygems.org'
 
+# Last rubygems version before 2.0.0 (which breaks rails 2.3)
+#rubygems 1.8.25
+
+ruby "1.8.7"
+
 gem 'rails', "~> 2.3.15"
 # rails requires rake >= 0.8.3 
 
+gem 'rdoc'
+gem 'rdoc-data'
+
 group :development, :test do
   if defined?(JRUBY_VERSION)
     gem 'jruby-openssl'
@@ -12,6 +20,5 @@ group :development, :test do
   else
     gem 'sqlite3', "~> 1.3.7"
   end
-  gem 'jeweler', '~> 1.8.4'
   gem 'shoulda', "~> 2.11.0"
 end

data/{rails3_0.gemfile → test/rails_3.0.gemfile}

@@ -12,6 +12,5 @@ group :development, :test do
   else
     gem 'sqlite3', "~> 1.3.7"
   end
-  gem 'jeweler', '~> 1.8.4'
   gem 'shoulda', "~> 2.11.0"
 end

data/{rails3_1.gemfile → test/rails_3.1.gemfile}

@@ -12,6 +12,5 @@ group :development, :test do
   else
     gem 'sqlite3', "~> 1.3.7"
   end
-  gem 'jeweler', '~> 1.8.4'
   gem 'shoulda', "~> 2.11.0"
 end

data/{rails3_2.gemfile → test/rails_3.2.gemfile}

@@ -12,6 +12,5 @@ group :development, :test do
   else
     gem 'sqlite3', "~> 1.3.7"
   end
-  gem 'jeweler', '~> 1.8.4'
   gem 'shoulda', "~> 2.11.0"
 end

data/{rails_edge.gemfile → test/rails_4.0-beta.gemfile}

@@ -4,11 +4,11 @@ source 'https://rubygems.org'
 
 # Bundle edge Rails instead:
 
-gem 'rails', :git => 'git://github.com/rails/rails.git'
+ruby "1.9.3" if RUBY_VERSION < '1.9'
 
-gem 'arel', :git => 'git://github.com/rails/arel.git'
-
-gem "rack", '~> 1.4.3'
+gem 'rails', "~> 4.0.0.beta1"
+gem 'rake', '>= 0.8.3'
+gem "rack", '~> 1.5.2'
 
 group :development, :test do
   if defined?(JRUBY_VERSION)
@@ -17,6 +17,5 @@ group :development, :test do
   else
     gem 'sqlite3', "~> 1.3.7"
   end
-  gem 'jeweler'
   gem 'shoulda'
 end

data/test/setup_railsapp

@@ -0,0 +1,258 @@
+#!/bin/bash
+
+# Any failure causes exit
+set -e
+
+while :
+do
+    case "$BUNDLE_GEMFILE" in
+    */test/rails_[Qq].gemfile)
+        echo "Aborting..."
+        exit 2
+        ;;
+    */test/rails_[0-9].[0-9]*.gemfile)
+        if [ -f "$BUNDLE_GEMFILE" ]; then
+            break
+        fi
+        ;;
+    esac
+    echo "== SELECT GEMFILE =="
+    echo
+    echo "Please select the gemfile for the required rails series:"
+    (cd test ; ls rails*gemfile | ruby -p -e '$_.sub!(/rails_(.*).gemfile/, "    \\1")' )
+    echo
+    echo -n "Enter choice (or q to quit): "
+    read x
+    export BUNDLE_GEMFILE=$PWD/test/rails_$x.gemfile
+done
+
+rm -rf tmp/Gemfile* tmp/railsapp tmp/bin tmp/gems test/bin test/rails*.gemfile.lock
+
+mkdir -p tmp/gems
+
+. test/init_variables
+
+if $rbenv_which bundle ; then
+  echo Bundler is installed
+else
+  gem install bundler
+  $rehash
+fi
+
+echo "Running bundle --binstubs with BUNDLE_GEMFILE=$BUNDLE_GEMFILE ..."
+if ! bundle --binstubs ; then
+    echo "Test aborted (missing required gems)"
+    exit 2
+fi
+$rehash
+
+rails="$base_dir/test/bin/rails"
+rake="$base_dir/test/bin/rake"
+
+actual_rails_version=`$rails -v`
+
+[ -d lib/health_check ] || exec echo setup_railsapp MUST be executed in the base of the health_check gem/clone of git repository
+
+echo Installing health_check as a gem into tmp/gems
+env GEM_HOME=$tmp_dir/gems rake install
+
+export GEM_PATH="$tmp_dir/gems:`gem environment gempath`"
+echo Set GEM_PATH=$GEM_PATH
+
+echo Gems in tmp/gems:
+ls tmp/gems
+
+echo Environment:
+env | egrep 'TRAVIS|RAILS|RUBY|_ENV|GEM|BUNDLE'
+
+cd $tmp_dir
+
+case `ruby -e 'puts JRUBY_VERSION' 2> /dev/null` in
+    [0-9]*)
+        db=jdbcsqlite3
+        # Appears to need a bit extra time
+        ;;
+    *)
+        db=sqlite3
+        ;;
+esac
+
+echo "Creating $actual_rails_version app in $tmp_dir/railsapp using adapter $db"
+case "$actual_rails_version" in
+    *' '[12].*)
+        $rails railsapp -d $db
+        ;;
+    *' '[34].*)
+        $rails new railsapp -d $db
+        ;;
+    *)
+        echo "Unknown rails version"
+        ;;
+esac
+
+cd $railsapp
+
+[ -z "$rehash" ] || rbenv local `rbenv version-name`
+
+echo "Changed current directory to railsapp root: $railsapp"
+
+echo "Fixing rdoc require in Rakefile if needed"
+ruby -p -i.bak -e '$_.gsub!(/rake.rdoctask/, "rdoc/task")' Rakefile
+
+echo "Configuring mailer to point to fake_smtp_server port 3555"
+cat >> config/environment.rb <<'!EOF!'
+
+ActionMailer::Base.delivery_method = :smtp
+ActionMailer::Base.smtp_settings = { :address => "localhost", :port => 3555 }
+
+!EOF!
+
+echo Adding an initializer for health_check gem ...
+mkdir -p config/initializers
+tee config/initializers/health_check.rb <<!
+HealthCheck.setup do |config|
+  config.success = "$success"
+  config.smtp_timeout = 60.0
+  config.http_status_for_error_text = 550
+  config.http_status_for_error_object = 555
+
+  config.add_custom_check do
+    File.exists?("$custom_file") ? '' : '$custom_file is missing!'
+  end
+end
+!
+
+echo "Last ten lines of config/environment.rb:"
+tail -10 config/environment.rb
+echo 
+
+echo Unsetting BUNDLE_GEMFILE '(so Gemfile for rails application will be used)'
+unset BUNDLE_GEMFILE
+
+if [ -s Gemfile ]
+then
+    echo Adding health_check as gem to Gemfile...
+    echo "gem 'health_check', :path => '$base_dir'" >> Gemfile
+
+    echo
+    echo Gemfile contents:
+    cat Gemfile
+    echo
+    echo running bundle install --binstubs
+    bundle install --binstubs
+    case "$actual_rails_version" in
+    *' '4.*)
+        echo "Running rake rails:update:binstubs to fix up binstubs bundle has overwritten"
+        echo a | rake rails:update:bin
+        ;;
+    esac
+    $rehash
+    echo "Using binstubs in $railsapp/bin for rails and rake commands"
+    rails="$railsapp/bin/rails"
+    rake="$railsapp/bin/rake"
+    # Fix for rvm, otherwise bundle run from rails create fails
+    export PATH="`pwd`/bin:$PATH"
+else
+    dest=$railsapp/vendor/plugins/health_check
+    echo Installing health_check as plugin in $dest ...
+    mkdir -p $dest
+    (
+	cd $base_dir
+
+        git ls-files | cpio -pdl $dest
+        
+	cd $dest
+
+        echo Files installed as plugin:
+        find . -type f
+        echo
+    )
+fi
+
+echo Setting RAILS_ENV=test RACK_ENV=test
+export RAILS_ENV=test RACK_ENV=test
+
+case $db in
+    jdbcsqlite3)
+        echo
+        echo 'Jruby requires the database to be created before the server is started: running rake db:migrate'
+        $rake db:migrate 
+        echo
+        ;;
+esac
+
+cat > public/ajax_example.html <<'EOF'
+    <html>
+    <head>
+      <title>Example static and dynamic calls to health_check</title>
+      <script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+      <script>
+	function parse_result(result, callback) {
+	    $("#html_status_"+callback).text(result.status);
+	    $("#html_body_"+callback).text(result.responseText);
+	    alert(callback + " callback called");
+	};
+
+	function dynamic_call(dataType, url) {
+	  $.ajax({
+	    dataType: dataType,
+	    url: url,
+	    success: function(data, textStatus, result) {
+	      $("#data_success").text(data);
+	      parse_result(result, "success");
+	    },
+	    error: function(result, textStatus) {
+	      parse_result(result, "error");
+	    },
+	    complete: function(result, textStatus) {
+	      parse_result(result, "complete");
+	    }
+	  });
+	};
+      </script>
+    </head>
+    <body>
+      <h1>Static calls</h1>
+      <ul>
+	<li><a href="http://localhost:3000/health_check/site" target="_blank">Minimal health check should always work</a>
+	  (<a href="http://localhost:3000/health_check/site.json" target="_blank">json</a>,
+	  <a href="http://localhost:3000/health_check/site.xml" target="_blank">xml</a>,
+	  <a href="http://localhost:3000/health_check/site.html" target="_blank">html</a>)
+	<li><a href="http://localhost:3000/health_check/fail" target="_blank">Force health check to fail!</a>
+	  (<a href="http://localhost:3000/health_check/fail.json" target="_blank">json</a>,
+	  <a href="http://localhost:3000/health_check/fail.xml" target="_blank">xml</a>,
+	  <a href="http://localhost:3000/health_check/fail.html" target="_blank">html</a>)
+      </ul>
+      <h1>Dynamic calls</h1>
+      <ul>
+	<li><a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/site');">Minimal health check should always work</a>
+	  (<a href="#" onclick="dynamic_call('json', 'http://localhost:3000/health_check/site.json');">json</a>,
+	  <a href="#" onclick="dynamic_call('site', 'http://localhost:3000/health_check/site.xml');">xml</a>,
+	  <a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/site.html');">html</a>)
+
+	<li><a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/fail');">Force health check to fail!</a>
+	  (<a href="#" onclick="dynamic_call('json', 'http://localhost:3000/health_check/fail.json');">json</a>,
+	  <a href="#" onclick="dynamic_call('site', 'http://localhost:3000/health_check/fail.xml');">xml</a>,
+	  <a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/fail.html');">html</a>)
+	<li>Last results sent to success:<ul>
+	  <li><b>Data:</b><span id=data_success></span>
+	  <li><b>result.status:</b><span id=html_status_success></span>
+	  <li><b>result.responseText:</b><span id=html_body_success></span>
+	</ul>
+	<li>Last results sent to error:<ul>
+	  <li><b>result.status:</b><span id=html_status_error></span>
+	  <li><b>result.responseText:</b><span id=html_body_error></span>
+	</ul>
+	<li>Last results sent to complete:<ul>
+	  <li><b>result.status:</b><span id=html_status_complete></span>
+	  <li><b>result.responseText:</b><span id=html_body_complete></span>
+	</ul>
+      </ul>
+    </body>
+    </html>
+EOF
+
+echo
+echo "Created $actual_rails_version app in $railsapp using adapter $db"
+echo -n "Using "
+ruby --version