health_check 1.0.1 → 1.0.2

data/.travis.yml

@@ -0,0 +1,62 @@
+language: ruby
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+  #- jruby-head
+  #- ruby-head
+  - ree
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+  - bundle --version
+  - mkdir -p tmp/bundle
+
+gemfile:
+  - gemfiles/rails2_3.gemfile
+  - gemfiles/rails3_0.gemfile
+  - gemfiles/rails3_1.gemfile
+  - gemfiles/rails3_2.gemfile
+  #- gemfiles/rails_edge.gemfile
+
+bundler_args: "--binstubs"
+
+script: ./test/test_with_railsapp
+
+matrix:
+  exclude:
+    - rvm: rbx-18mode
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: rbx-19mode
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: jruby-18mode
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: jruby-head
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails2_3.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails2_3.gemfile
+
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: rbx-18mode
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: jruby-18mode
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: ree
+      gemfile: gemfiles/rails_edge.gemfile
+  allow_failures:
+    - gemfile: gemfiles/rails_edge.gemfile
+    - rvm: jruby-head
+    - rvm: ruby-head

data/README.rdoc

@@ -22,9 +22,11 @@ health_check provides various monitoring URIs
     % curl localhost:3000/health_check/site_and_database_and_email_migrations
     success
 
+The health_check controller disables sessions and logging for its actions to minimise the impact of frequent uptime checks on the session store and the log file.
+
 == Installation
 
-*As a Gem from rubygems (Rails 3.0 and above)*
+=== As a Gem from rubygems (Rails 3.0 and above)
 
 Add the following line to Gemfile
 
@@ -34,7 +36,7 @@ Then run
 
     % bundle
 
-*As a Gem from rubygems (Rails 2.3)*
+=== As a Gem from rubygems (Rails 2.3)
 
 Install the gem using the following command
 
@@ -44,7 +46,7 @@ Then add the following line to config/environment.rb within the config block
 
     config.gem "health_check"
 
-*As a Plugin (Rails 2.3.x)*
+=== As a Plugin (Rails 2.3.x)
 
 Run the following commands from the root of your rails application
 
@@ -56,10 +58,10 @@ Run the following commands from the root of your rails application
 Use a website monitoring service to check the url regularly for the word "success" rather than just a 200 return code.
 
 See
-* [Pingdom Website Monitoring](https://www.pingdom.com)
-* [NewRelic Availability Monitoring](http://newrelic.com/docs/features/availability-monitoring-faq)
-* [Uptime by OpenACS](http://uptime.openacs.org/uptime/)
-* [Engine Yard's guide](https://support.cloud.engineyard.com/entries/20996821-monitor-application-uptime) although the guide is based on fitter_happier plugin it will also work with this gem
+* Pingdom Website Monitoring - https://www.pingdom.com
+* NewRelic Availability Monitoring - http://newrelic.com/docs/features/availability-monitoring-faq
+* Uptime by OpenACS - http://uptime.openacs.org/uptime/
+* Engine Yard's guide - https://support.cloud.engineyard.com/entries/20996821-monitor-application-uptime (although the guide is based on fitter_happier plugin it will also work with this gem)
 * Any other montoring service that can be set to check for the word success in the test returned from a url
 
 == Checks
@@ -89,7 +91,6 @@ See MIT-LICENSE for details.
 == Known Issues
 
 * No inline documentation for methods
-
 * Feedback welcome especially with suggested replacement code and corresponding tests
 
 == Similar projects
@@ -98,5 +99,10 @@ See MIT-LICENSE for details.
 
 == Continuous integration tests
 
-Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/health_check.png" />}[https://travis-ci.org/ianheggie/health_check]
+See Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/health_check.png" />}[https://travis-ci.org/ianheggie/health_check]
+
+== Versions
 
+* 0.x - Rails 2.3
+* 1.x - Includes Rails 3.x suppprt as an Engine
+* 1.0.2 - Included travis config and gemfiles used in travis tests in gem and changes to test setup so that gem test 

data/Rakefile

@@ -12,7 +12,6 @@ begin
     gem.authors = ["Ian Heggie"]
     # Gemfile contains gem dependencies, apart from bundler itself
     gem.add_development_dependency 'bundler', '~> 1.2.0'
-    gem.files.exclude 'gemfiles/*', '.travis.yml'
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -26,6 +25,7 @@ end
 # 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
   

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/gemfiles/rails1_2.gemfile

@@ -0,0 +1,13 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+gem 'rails', "~> 1.2.6"
+gem 'sqlite3', "~> 1.3.7"
+
+group :development, :test do
+  # rails requires rake >= 0.8.3 
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+end
+

data/gemfiles/rails2_3.gemfile

@@ -0,0 +1,18 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+gem 'rails', "~> 2.3.15"
+# rails requires rake >= 0.8.3 
+if defined?(JRUBY_VERSION)
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+else
+  gem 'sqlite3', "~> 1.3.7"
+end
+
+group :development, :test do
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+end
+

data/gemfiles/rails3_0.gemfile

@@ -0,0 +1,18 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+gem 'rails', "~> 3.0.19"
+gem 'rake', '>= 0.8.3'
+if defined?(JRUBY_VERSION)
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+else
+  gem 'sqlite3', "~> 1.3.7"
+end
+
+group :development, :test do
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+end
+

data/gemfiles/rails3_1.gemfile

@@ -0,0 +1,18 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+gem 'rails', "~> 3.1.0"
+gem 'rake', '>= 0.8.3'
+if defined?(JRUBY_VERSION)
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+else
+  gem 'sqlite3', "~> 1.3.7"
+end
+
+group :development, :test do
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+end
+

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,18 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+gem 'rails', "~> 3.2.0"
+gem 'rake', '>= 0.8.3'
+if defined?(JRUBY_VERSION)
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+else
+  gem 'sqlite3', "~> 1.3.7"
+end
+
+group :development, :test do
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+end
+

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,24 @@
+# Gemfile for health_test testing
+
+source :rubygems
+
+# Bundle edge Rails instead:
+
+gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'arel', :git => 'git://github.com/rails/arel.git'
+
+gem "rack", '~> 1.4.3'
+
+if defined?(JRUBY_VERSION)
+  gem 'jruby-openssl'
+  gem 'activerecord-jdbcsqlite3-adapter'
+else
+  gem 'sqlite3', "~> 1.3.7"
+end
+
+group :development, :test do
+  gem 'jeweler'
+  gem 'shoulda'
+end
+

data/health_check.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "health_check"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ian Heggie"]
-  s.date = "2013-01-23"
+  s.date = "2013-01-24"
   s.description = "Simple health check of Rails app for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc."
   s.email = "ian@heggie.biz"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "MIT-LICENSE",
@@ -24,12 +25,19 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "config/routes.rb",
+    "gemfiles/rails1_2.gemfile",
+    "gemfiles/rails2_3.gemfile",
+    "gemfiles/rails3_0.gemfile",
+    "gemfiles/rails3_1.gemfile",
+    "gemfiles/rails3_2.gemfile",
+    "gemfiles/rails_edge.gemfile",
     "health_check.gemspec",
     "init.rb",
     "lib/health_check.rb",
     "lib/health_check/add_23_routes.rb",
     "lib/health_check/health_check_controller.rb",
     "lib/health_check/utils.rb",
+    "test/fake_smtp_server",
     "test/migrate/empty/do_not_remove.txt",
     "test/migrate/nine/9_create_countries.rb",
     "test/migrate/twelve/012_create_users.rb",

data/lib/health_check/health_check_controller.rb

@@ -4,8 +4,7 @@
 module HealthCheck
   class HealthCheckController < ActionController::Base
 
-    # turn sessions off if we can
-    session(:off) rescue nil
+    session(:off) if Rails.version < '3.0'
 
     layout nil
 

data/test/fake_smtp_server

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'socket'
+
+port = 3555
+
+
+server = TCPServer.new port
+puts "fake_smtp_server: Waiting for one connection to port #{port} ..."
+
+def send(client, line)
+  client.puts line
+  puts "> #{line}"
+end
+
+def receive(client)
+  line = client.gets
+  puts "< #{line}"
+  line
+end
+
+client = server.accept    # Wait for a client to connect
+send(client, "220 dummy-smtp.example.com SMTP")
+cmd = receive(client)
+
+while cmd !~ /^QUIT/
+  if cmd =~ /^HELO/
+    send(client, "250 Welcome to a dummy smtp server")
+  else
+    send(client, "502 I am so dumb I only understand HELO and QUIT")
+  end
+  cmd = receive(client)
+end
+send(client, "221 Bye Bye")
+
+client.close
+puts "fake_smtp_server: Exiting now the conversation has finished."
+exit 0

data/test/test_with_railsapp

@@ -5,7 +5,8 @@ set -e
 
 base_dir=`pwd`
 
-testurl=$base_dir/test/testurl
+testurl="$base_dir/test/testurl"
+fake_smtp_server="$base_dir/test/fake_smtp_server"
 
 test_dir=`pwd`/tmp
 rm -rf tmp/Gemfile* tmp/railsapp tmp/bin tmp/gems
@@ -24,7 +25,7 @@ echo GEM LIST
 gem list
 
 echo Environment:
-env | egrep 'TRAVIS|RAILS|RUBY|_ENV'
+env | egrep 'TRAVIS|RAILS|RUBY|_ENV|GEM|BUNDLE'
 
 server_pid=''
 
@@ -35,11 +36,14 @@ finish()
     echo ========================================================
     echo TEST ${1:-FAILED}
     echo ========================================================
+    ls -lR $test_dir/railsapp/log $test_dir/railsapp/db
+
     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]"
@@ -53,17 +57,40 @@ finish()
 
 trap "finish FAILED 1" 0
 
-actual_rails_version=`rails -v`
-echo "Creating $actual_rails_version app in $test_dir/railsapp"
+rails='rails'
+if [ -x bin/rails ]
+then
+    rails="`pwd`/bin/rails"
+    echo "Using binstub: $rails for rails command"
+fi
+rake='rake'
+if [ -x bin/rake ]
+then
+    rake="`pwd`/bin/rake"
+    echo "Using binstub: $rake for rake command"
+fi
 
 cd $test_dir
 
+actual_rails_version=`$rails -v`
+
+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 $test_dir/railsapp using adapter $db"
 case "$actual_rails_version" in
     *' '[12].*)
-        rails railsapp
+        $rails railsapp -d $db
         ;;
     *' '[34].*)
-        rails new railsapp
+        $rails new railsapp -d $db
         ;;
     *)
         echo "Unknown rails version"
@@ -74,39 +101,73 @@ 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
+ruby -p -i.bak -e '$_.gsub!(/rake.rdoctask/, "rdoc/task")' Rakefile
 
-if [ -f Gemfile ]
+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 "Last ten lines of config/environment.rb:"
+tail -10 config/environment.rb
+echo 
+
+if [ -s 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
+    echo
+    echo Gemfile contents:
+    cat Gemfile
+    echo
+    echo running bundle --binstubs
+    bundle --binstubs
+    echo "Using binstubs in `pwd`/bin for rails and rake commands"
+    rails="`pwd`/bin/rails"
+    rake="`pwd`/bin/rake"
 else
-    echo Installing health_check as plugin ...
     dest=`pwd`/vendor/plugins/health_check
+    echo Installing health_check as plugin in $dest ...
     mkdir -p $dest
     (
         cd $base_dir
         find . | egrep -v '/tmp|/\.git|\.gem$' | cpio -pdl $dest
+        cd $dest
+        echo Files installed as plugin:
+        find . -type f
+        echo
     )
 fi
 
+export RAILS_ENV=test RACK_ENV=test
+
+case $db in
+    jdbcsqlite3)
+        echo
+        echo 'Jruby requires the dastabase to be created before the server is started: running rake db:migrate'
+        $rake db:migrate 
+        echo
+        ;;
+esac
+
 port=3456
 echo Starting server on port $port ...
 
-export RAILS_ENV=test
-
 if [ -x script/server ]
 then
-    script/server webrick -p $port &
+    bundle exec ./script/server webrick -p $port &
 else
-    rails s webrick -p $port &
+    $rails s webrick -p $port &
 fi
 server_pid=$!
 
@@ -120,43 +181,76 @@ echo 'TESTING can get a static file ...'
 $testurl ${host}/static.txt STATIC-FILE
 echo
 
-echo 'TESTING health_check should pass with no database migrations ...'
+echo 'TESTING health_check/migration should pass with no database migrations ...'
 mkdir -p db/migrate
 ls db/migrate
-$testurl ${host}/health_check success
+$testurl ${host}/health_check/migration success
 echo
 
-echo 'TESTING health_check should fail without initial database migration ...'
+echo 'TESTING health_check/migration should fail without initial database migration ...'
 cp $base_dir/test/migrate/nine/* db/migrate
 ls db/migrate
-$testurl ${host}/health_check failed
+$testurl ${host}/health_check/migration failed
 echo
 
-echo 'TESTING health_check should pass after initial database migration ...'
-rake db:migrate 
-$testurl ${host}/health_check success
+echo 'TESTING health_check/database should pass without initial database migration (since it ignores the difference) ...'
+$testurl ${host}/health_check/database success
+echo
+
+echo 'TESTING health_check/site should pass ...'
+$testurl ${host}/health_check/site success
+echo
+
+echo 'TESTING health_check/migration should pass after initial database migration ...'
+$rake db:migrate 
+$testurl ${host}/health_check/migration success
 echo
 
-echo 'TESTING health_check should fail without all migrations ...'
+echo 'TESTING health_check/migration should fail without all migrations ...'
 cp $base_dir/test/migrate/twelve/* db/migrate
 ls db/migrate
+$testurl ${host}/health_check/migration failed
+echo
+
+echo 'TESTING health_check/migration should pass after both database migrations ...'
+$rake db:migrate 
+$testurl ${host}/health_check/migration success
+echo
+
+echo 'TESTING health_check/migration should pass after both database migrations ...'
+$rake db:migrate 
+$testurl ${host}/health_check/migration success
+echo
+
+echo 'TESTING health_check/email should fail without smtp available ...'
+$testurl ${host}/health_check/email failed
+echo
+
+echo 'TESTING health_check/email should pass with smtp available ...'
+$fake_smtp_server &
+sleep 5
+$testurl ${host}/health_check/email success
+echo
+
+echo 'TESTING health_check (all) should fail without smtp available ...'
 $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 'TESTING health_check/all should fail without smtp available ...'
+$testurl ${host}/health_check failed
 echo
 
-echo "Killing rails server [pid: $server_pid]"
-kill -9 $server_pid 
-server_pid=''
+echo 'TESTING health_check (all) should pass with smtp available ...'
+$fake_smtp_server &
+sleep 5
+$testurl ${host}/health_check success
+echo
 
-#if [ -d vendor/plugins/health_check ]
-#then
-#    echo "RUNNING UNIT TESTS...."
-#    rake test:plugins
-#fi
+echo 'TESTING health_check/all should pass with smtp available ...'
+$fake_smtp_server &
+sleep 5
+$testurl ${host}/health_check/all success
+echo
 
 finish PASSED 0
 exit 0

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: health_check
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Ian Heggie
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-23 00:00:00 Z
+date: 2013-01-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -123,6 +123,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -130,12 +131,19 @@ files:
 - Rakefile
 - VERSION
 - config/routes.rb
+- gemfiles/rails1_2.gemfile
+- gemfiles/rails2_3.gemfile
+- gemfiles/rails3_0.gemfile
+- gemfiles/rails3_1.gemfile
+- gemfiles/rails3_2.gemfile
+- gemfiles/rails_edge.gemfile
 - health_check.gemspec
 - init.rb
 - lib/health_check.rb
 - lib/health_check/add_23_routes.rb
 - lib/health_check/health_check_controller.rb
 - lib/health_check/utils.rb
+- test/fake_smtp_server
 - test/migrate/empty/do_not_remove.txt
 - test/migrate/nine/9_create_countries.rb
 - test/migrate/twelve/012_create_users.rb