health_check 3.0.0 → 3.1.0

data/lib/health_check/version.rb

@@ -1,3 +1,3 @@
 module HealthCheck
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/test/fake_smtp_server

@@ -1,38 +1,157 @@
 #!/usr/bin/env ruby
 
 require 'socket'
+require 'openssl'
 
-port = 3555
+class FakeSmtpServer
+  def initialize(port)
+    @port = port
+    @socket = TCPServer.new(@port)
+    @client = @orig_client = nil
+  end
 
+  def start
+    return unless @client.nil?
 
-server = TCPServer.new port
-puts "fake_smtp_server: Waiting for one connection to port #{port} ..."
+    puts "fake_smtp_server: Waiting for one connection to port #{@port} ..."
+    @client = @socket.accept
 
-def send(client, line)
-  client.puts line
-  puts "> #{line}"
-end
+    send '220 dummy-smtp.example.com SMTP'
+    cmd = receive
 
-def receive(client)
-  line = client.gets
-  puts "< #{line}"
-  line
-end
+    while cmd !~ /^QUIT\r/
+      if cmd =~ /^HELO(.*)\r/
+        if ENV['FAIL_SMTP'] == 'HELO'
+          send '550 Access Denied – Invalid HELO name'
+        else
+          send '250-Welcome to a dummy smtp server'
+          unless ENV['SMTP_STARTTLS'] == 'DISABLED'
+            send '250-STARTTLS'
+          end
+          send '250-AUTH PLAIN LOGIN'
+          send '250 Ok'
+        end
+      elsif cmd =~ /^AUTH(.*)\r/
+        if ENV['FAIL_SMTP'] == 'AUTH'
+          send '535 5.7.8 Authentication credentials invalid'
+        else
+          send '235 2.7.0 Authentication successful'
+        end
+      elsif cmd =~ /^STARTTLS\r/
+        if ENV['SMTP_STARTTLS'] == 'DISABLED'
+          send '502 STARTTLS is disabled!'
+        end
+        send '220 Ready to start TLS'
+        if ENV['FAIL_SMTP'] == 'STARTTLS'
+          cmd = receive
+          return close
+        end
+        @orig_client = @client
+        @client = tlsconnect(@client)
+      else
+        send '502 I am so dumb I only understand HELO, AUTH, STARTTLS and QUIT which always return a success status'
+      end
+
+      cmd = receive
+    end
+    send '221 Bye Bye'
+
+    close
+  end
+
+  private
+
+  def close
+    @client.close unless @client.nil?
+    @orig_client.close unless @orig_client.nil?
+  end
+
+  def send(line)
+    @client.puts line
+    puts "-> #{line}"
+  end
+
+  def receive
+    line = @client.gets
+    puts "<- #{line}"
+    line
+  end
+
+  def ssl_socket(client, context)
+    OpenSSL::SSL::SSLSocket.new(client, context)
+  end
+
+  def ssl_context
+    @_ssl_context ||= begin
+      key, cert = generate_certificate
+
+      context = OpenSSL::SSL::SSLContext.new
+      context.key = key
+      context.cert = cert
+      context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      context.min_version = nil
+      context
+    end
+  end
+
+  # Pass socket from TCPServer.new accept
+  def tlsconnect(client)
+    ssl_client = ssl_socket(client, ssl_context)
+    puts '=> TLS connection started'
+    ssl_client.accept
+    puts '=> TLS connection established'
+
+    ssl_client
+  end
 
-client = server.accept    # Wait for a client to connect
-send(client, "220 dummy-smtp.example.com SMTP")
-cmd = receive(client)
+  def generate_certificate
+    key = OpenSSL::PKey::RSA.new(2048)
+    name = OpenSSL::X509::Name.parse('CN=localhost')
 
-while cmd !~ /^QUIT\r/
-  if cmd =~ /^HELO(.*)\r/
-    send(client, "250 Welcome to a dummy smtp server")
-  else
-    send(client, "502 I am so dumb I only understand HELO and QUIT")
+    cert = OpenSSL::X509::Certificate.new
+    cert.version = 2
+    cert.serial = 0
+    cert.not_before = Time.now
+    cert.not_after = Time.now + 3600
+
+    cert.public_key = key.public_key
+    cert.subject = name
+
+    extension_factory = OpenSSL::X509::ExtensionFactory.new nil, cert
+
+    cert.add_extension extension_factory.create_extension('basicConstraints', 'CA:FALSE', true)
+    cert.add_extension extension_factory.create_extension('keyUsage', 'keyEncipherment,dataEncipherment,digitalSignature')
+    cert.add_extension extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+
+    cert.issuer = name
+    cert.sign key, OpenSSL::Digest::SHA256.new
+
+    [key, cert]
   end
-  cmd = receive(client)
 end
-send(client, "221 Bye Bye")
 
-client.close
-puts "fake_smtp_server: Exiting now the conversation has finished."
+FakeSmtpServer.new(3555).start
+
+puts 'fake_smtp_server: Exiting now the conversation has finished.'
 exit 0
+
+# Tested with irb script:
+# require 'net/smtp'
+# 
+# status = ''
+# begin
+#   if @skip_external_checks
+#     status = '250'
+#   else
+#     smtp = Net::SMTP.new('localhost', 3555)
+#     smtp.enable_starttls 
+#     smtp.open_timeout = 10
+#     smtp.read_timeout = 10
+#     smtp.start('domain', 'user_name', 'password', :plain) do
+#       status = smtp.helo('domain').status
+#     end
+#   end
+# rescue Exception => ex
+#   status = ex.to_s
+# end
+# (status =~ /^250/) ? 'PASS' : "FAILED SMTP: #{status || 'unexpected error'}. "

data/test/init_variables

@@ -1,7 +1,25 @@
 #!/bin/bash
 
 # Any failure causes exit
-set -e
+set -eE -o functrace
+
+report_failure() {
+  local lineno=$2
+  local fn=$3
+  local exitstatus=$4
+  local msg=$5
+  local lineno_fns=${1% 0}
+  if [[ $lineno_fns != "0" ]] ; then
+    lineno="${lineno} ${lineno_fns}"
+  fi
+  if [[ $exitstatus == 0 ]] ; then
+    echo "${BASH_SOURCE[1]}: Finished!"
+  else
+    echo "${BASH_SOURCE[1]}:${fn}[${lineno}] Failed with status ${exitstatus}: $msg"
+  fi
+}
+
+trap 'report_failure "${BASH_LINENO[*]}" "$LINENO" "${FUNCNAME[*]:-script}" "$?" "$BASH_COMMAND"' ERR
 
 echo Setting RAILS_ENV=test RACK_ENV=test
 export RAILS_ENV=test RACK_ENV=test

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

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

data/test/provision_vagrant

@@ -7,22 +7,55 @@ case `id` in
         exec echo Must be run as root
         ;;
 esac
-set -xe
+
+chruby_version=0.3.9
+chruby=chruby-${chruby_version}
+set -x
+set -eE -o functrace
+
+report_failure() {
+  local lineno=$2
+  local fn=$3
+  local exitstatus=$4
+  local msg=$5
+  local lineno_fns=${1% 0}
+  if [[ $lineno_fns != "0" ]] ; then
+    lineno="${lineno} ${lineno_fns}"
+  fi
+  if [[ $exitstatus == 0 ]] ; then
+    echo "${BASH_SOURCE[1]}: Finished!"
+  else
+    echo "${BASH_SOURCE[1]}:${fn}[${lineno}] Failed with status ${exitstatus}: $msg"
+  fi
+}
+
+trap 'report_failure "${BASH_LINENO[*]}" "$LINENO" "${FUNCNAME[*]:-script}" "$?" "$BASH_COMMAND"' ERR
+
+
 id
 pwd
 export DEBIAN_FRONTEND=noninteractive
 find /tmp/got-apt-update -mtime -1 || ( apt-get update && touch /tmp/got-apt-update )
-apt install --yes --force-yes -q build-essential ruby ruby-dev sqlite3 libsqlite3-dev nodejs
-
+apt install --yes -q build-essential ruby ruby-dev sqlite3 libsqlite3-dev nodejs git git-core
+apt install --yes -q gcc autoconf bison libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm-dev
+apt install --yes -q libgdbm3
+# useful when debugging
+apt install --yes -q silversearcher-ag vim exuberant-ctags
+apt install --yes -q unattended-upgrades
+unattended-upgrade
+# The following is not required for testing, install if you are doing manual tests with extra gems
+# apt install --yes -q mysql-client mysql-server libmysqlclient-dev
+# apt install --yes -q libcurl4-openssl-dev libncurses5-dev libxml2-dev libxslt1-dev
 (
   echo Install chruby
-  [ -s chruby-0.3.9.tar.gz ] || wget -q -O chruby-0.3.9.tar.gz https://github.com/postmodern/chruby/archive/v0.3.9.tar.gz
-  [ chruby-0.3.9 ] || tar -xzf chruby-0.3.9.tar.gz
-  cd chruby-0.3.9/
+  [ -s ${chruby}.tar.gz ] || wget -q -O ${chruby}.tar.gz https://github.com/postmodern/chruby/archive/v${chruby_version}.tar.gz
+  [ -d ${chruby} ] || tar -xzf ${chruby}.tar.gz
+  cd ${chruby}/
   ./scripts/setup.sh
   cat > /etc/profile.d/chruby.sh <<'EOF'
 if [ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ]; then
   source /usr/local/share/chruby/chruby.sh
+  #source /usr/local/share/chruby/auto
 fi
 EOF
   chmod a+r /etc/profile.d/chruby.sh
@@ -33,29 +66,38 @@ EOF
   which ruby-build || PREFIX=/usr/local ./ruby-build/install.sh
 
   mkdir -p /opt/rubies
-  [ -x /opt/rubies/1.9.3-p551/bin/bundle ] || ( ruby-build 1.9.3-p551 /opt/rubies/1.9.3-p551 && /opt/rubies/1.9.3-p551/bin/gem install bundler )
-
-  for v in 2.2.0
+  for v in 2.2.2
   do
-    [ -x /opt/rubies/$v/bin/bundle ] || ( ruby-build $v /opt/rubies/$v && /opt/rubies/$v/bin/gem install bundler )
+    [ -x /opt/rubies/$v/bin/ruby ] || ( ruby-build $v /opt/rubies/$v )
+    [ -x /opt/rubies/${v}/bin/bundle ] || ( /opt/rubies/${v}/bin/gem install bundler -v '<2.0' )
+  done
+  
+  for v in 2.3.8 2.4.10 2.5.9 2.5.0 2.6.6 2.6.7 2.7.1 2.7.3 3.0.1
+  do
+    [ -x /opt/rubies/$v/bin/ruby ] || ( ruby-build $v /opt/rubies/$v )
+    [ -x /opt/rubies/$v/bin/bundle ] || ( /opt/rubies/$v/bin/gem install bundler )
   done
 )
 
 echo Setup system ruby
-which bundle || gem install bundler 
+which bundle || gem install bundler || gem install bundler -v '<2.0'
+which bundle || gem install bundler -v '< 2.0'
 bundle --version
 set +x
 cat <<EOF
 
 Now test by running the following commands:
 
+  vagrant ssh
+  cd /vagrant
+
   chruby RUBY_VERSION
   or
   chruby system # for system version 2.3.1
 
-  vagrant ssh
-  cd /vagrant
   ./test/test_with_railsapp
 
+  exit
+
 EOF
 exit

data/test/rails_5.0.gemfile

@@ -17,12 +17,13 @@ group :development, :test do
     gem 'sqlite3', "~> 1.3.7"
   end
   gem 'shoulda'
-  
-  # redis based checks
-  gem 'sidekiq', :require => !ENV['SIDEKIQ'].nil?
-  gem 'redis', :require => !ENV['REDIS_URL'].nil?
-  gem 'resque', :require => !ENV['RESQUE'].nil?
-  # s3 check
-  gem 'aws-sdk', :require => !ENV['AWS_ACCESS_KEY_ID'].nil?
 end
+  
+# redis based checks
+gem 'sidekiq', '~> 5.2.9', require: !ENV['SIDEKIQ'].nil? # REQUIRED
+gem 'redis', '~> 4.0.3', require: !ENV['REDIS_URL'].nil? # REQUIRED
+gem 'resque', '~> 1.27.4', require: !ENV['RESQUE'].nil? # REQUIRED
+gem 'elasticsearch', '~> 6.3.1', require: !ENV['ELASTICSEARCH_URL'].nil? # REQUIRED
+# s3 check
+gem 'aws-sdk-s3', require: !ENV['AWS_ACCESS_KEY_ID'].nil? # REQUIRED
 

data/test/rails_5.1.gemfile

@@ -23,13 +23,12 @@ group :development, :test do
     gem 'sqlite3', "~> 1.3.7"
   end
   gem 'shoulda'
-  
-  # redis based checks
-  gem 'sidekiq', :require => !ENV['SIDEKIQ'].nil?
-  gem 'redis', :require => !ENV['REDIS_URL'].nil?
-  gem 'resque', :require => !ENV['RESQUE'].nil?
-  # s3 check
-  gem 'aws-sdk', :require => !ENV['AWS_ACCESS_KEY_ID'].nil?
-
 end
 
+# redis based checks
+gem 'sidekiq', '~> 5.2.9', require: !ENV['SIDEKIQ'].nil? # REQUIRED
+gem 'redis', '~> 4.0.3', require: !ENV['REDIS_URL'].nil? # REQUIRED
+gem 'resque', '~> 1.27.4', require: !ENV['RESQUE'].nil? # REQUIRED
+gem 'elasticsearch', '~> 6.3.1', require: !ENV['ELASTICSEARCH_URL'].nil? # REQUIRED
+# s3 check
+gem 'aws-sdk', require: !ENV['AWS_ACCESS_KEY_ID'].nil? # REQUIRED

data/test/rails_5.2.gemfile

@@ -0,0 +1,34 @@
+# Gemfile for health_test testing
+
+source 'https://rubygems.org'
+
+ruby RUBY_VERSION < '2.2.2' ? '2.2.2' : RUBY_VERSION
+
+gem 'rails', '~> 5.2.0'
+gem 'rake', '>= 0.8.7'
+
+#  spring-watcher-listen was resolved to 2.0.1, which depends on
+#    listen was resolved to 3.1.5, which depends on
+#      ruby_dep
+#      and ruby_dep 1.5 requires 2.2.3 or later
+gem 'ruby_dep', '~> 1.3.0'  # REQUIRED
+
+gem 'listen', '<3.1.2' # REQUIRED
+
+group :development, :test do
+  if defined?(JRUBY_VERSION)
+    gem 'jruby-openssl'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  else
+    gem 'sqlite3', "~> 1.3.7"
+  end
+  gem 'shoulda'
+end
+
+# redis based checks
+gem 'sidekiq', '~> 5.2.9', require: !ENV['SIDEKIQ'].nil? # REQUIRED
+gem 'redis', '~> 4.0.3', require: !ENV['REDIS_URL'].nil? # REQUIRED
+gem 'resque', '~> 1.27.4', require: !ENV['RESQUE'].nil? # REQUIRED
+gem 'elasticsearch', '~> 6.3.1', require: !ENV['ELASTICSEARCH_URL'].nil? # REQUIRED
+# s3 check
+gem 'aws-sdk', require: !ENV['AWS_ACCESS_KEY_ID'].nil? # REQUIRED

data/test/rails_6.0.gemfile

@@ -0,0 +1,30 @@
+# Gemfile for health_test testing
+
+source 'https://rubygems.org'
+
+ruby RUBY_VERSION < '2.5' ? '2.5.0' : RUBY_VERSION
+
+gem 'rails', '~> 6.0.0'
+gem 'rake', '>= 0.8.7'
+
+gem 'listen', '<3.1.2' # REQUIRED
+
+group :development, :test do
+  if defined?(JRUBY_VERSION)
+    gem 'jruby-openssl'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  else
+    gem 'sqlite3', "~> 1.3.7"
+  end
+  gem 'shoulda'
+end
+
+# redis based checks
+gem 'sidekiq', '~> 5.2.9', require: !ENV['SIDEKIQ'].nil? # REQUIRED
+gem 'redis', '~> 4.0.3', require: !ENV['REDIS_URL'].nil? # REQUIRED
+gem 'resque', '~> 1.27.4', require: !ENV['RESQUE'].nil? # REQUIRED
+gem 'elasticsearch', '~> 6.3.1', require: !ENV['ELASTICSEARCH_URL'].nil? # REQUIRED
+# s3 check
+gem 'aws-sdk-s3', require: !ENV['AWS_ACCESS_KEY_ID'].nil? # REQUIRED
+
+gem 'webpacker', '~> 4.0.7' # REQUIRED

data/test/rails_6.1.gemfile

@@ -0,0 +1,29 @@
+# Gemfile for health_test testing
+
+source 'https://rubygems.org'
+
+ruby RUBY_VERSION < '2.5' ? '2.5.0' : RUBY_VERSION
+
+gem 'rails', '~> 6.1.0'
+gem 'rake', '>= 0.8.7'
+
+group :development, :test do
+  if defined?(JRUBY_VERSION)
+    gem 'jruby-openssl'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  else
+    gem 'sqlite3', "~> 1.3.7"
+  end
+  gem 'shoulda'
+end
+
+# redis based checks
+gem 'sidekiq', require: !ENV['SIDEKIQ'].nil? # REQUIRED
+gem 'redis', require: !ENV['REDIS_URL'].nil? # REQUIRED
+gem 'resque', require: !ENV['RESQUE'].nil? # REQUIRED
+# s3 check
+gem 'aws-sdk-s3', require: !ENV['AWS_ACCESS_KEY_ID'].nil? # REQUIRED
+
+gem 'webpacker', '~> 4.0.7' # REQUIRED
+gem 'rexml', '~> 3.2.4' # REQUIRED for ruby 3.0
+gem 'webrick' # REQUIRED for ruby 3.0