health_check_rb 4.0.0

data/spec/health_check_rb_spec.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckRb, type: :request do
+  context 'with /custom_route_prefix' do
+    it 'works with smtp server and valid custom_check' do
+      enable_custom_check do
+        mock_smtp_server do
+          get '/custom_route_prefix'
+          expect(response).to be_ok
+        end
+      end
+    end
+
+    it 'fails with no smtp server and valid custom_check' do
+      enable_custom_check do
+        get '/custom_route_prefix'
+        expect(response.status).to eq(550)
+        expect(response.body).to include 'health_check failed'
+      end
+    end
+
+    it 'fails with smtp server and invalid custom_check' do
+      mock_smtp_server do
+        get '/custom_route_prefix'
+        expect(response.status).to eq(550)
+        expect(response.body).to include 'health_check failed'
+      end
+    end
+  end
+
+  context 'with /custom_route_prefix/all' do
+    it 'works with smtp server and valid custom_check' do
+      enable_custom_check do
+        mock_smtp_server do
+          get '/custom_route_prefix/all'
+          expect(response).to be_ok
+        end
+      end
+    end
+
+    it 'fails with no smtp server and valid custom_check' do
+      enable_custom_check do
+        get '/custom_route_prefix/all'
+        expect(response.status).to eq(550)
+        expect(response.body).to include 'health_check failed'
+      end
+    end
+
+    it 'fails with smtp server and invalid custom_check' do
+      mock_smtp_server do
+        get '/custom_route_prefix/all'
+        expect(response.status).to eq(550)
+        expect(response.body).to include 'health_check failed'
+      end
+    end
+  end
+
+  context 'with /custom_route_prefix/migration' do
+    before { reconnect_database }
+
+    after do
+      Dir.glob('spec/dummy/db/migrate/*').each do |f|
+        FileUtils.rm f
+      end
+      FileUtils.rm 'spec/dummy/db/schema.rb' if File.exist? 'spec/dummy/db/schema.rb'
+      FileUtils.cd FakeApp.config.root do
+        ActiveRecord::Tasks::DatabaseTasks.drop_current
+      end
+    end
+
+    it 'works with no migration files' do
+      get '/custom_route_prefix/migration'
+      expect(response).to be_ok
+    end
+
+    it 'fails with pending migration files' do
+      FileUtils.cp 'spec/fixtures/migrate/9_create_countries.rb', 'spec/dummy/db/migrate/9_create_countries.rb'
+      FileUtils.cd FakeApp.config.root do
+        get '/custom_route_prefix/migration'
+      end
+      expect(response.status).to eq(550)
+    end
+
+    it 'works with applied migration files' do
+      FileUtils.cp 'spec/fixtures/migrate/9_create_countries.rb', 'spec/dummy/db/migrate/9_create_countries.rb'
+      FileUtils.cd FakeApp.config.root do
+        db_migrate
+        get '/custom_route_prefix/migration'
+      end
+      expect(response).to be_ok
+    end
+  end
+
+  describe '/custom_route_prefix/database' do
+    after do
+      Dir.glob('spec/dummy/db/migrate/*').each do |f|
+        FileUtils.rm f
+      end
+      FileUtils.rm 'spec/dummy/db/schema.rb' if File.exist? 'spec/dummy/db/schema.rb'
+      FileUtils.cd FakeApp.config.root do
+        ActiveRecord::Tasks::DatabaseTasks.drop_current
+      end
+    end
+
+    it 'works with no database' do
+      get '/custom_route_prefix/database'
+      expect(response).to be_ok
+    end
+
+    it 'works with valid database' do
+      FileUtils.cp 'spec/fixtures/migrate/9_create_countries.rb', 'spec/dummy/db/migrate/9_create_countries.rb'
+      FileUtils.cd FakeApp.config.root do
+        db_migrate
+        get '/custom_route_prefix/database'
+      end
+      expect(response).to be_ok
+    end
+
+    it 'fails with invalid database' do
+      disconnect_database
+      Rails.root.join('db/test.sqlite3').write('invalid')
+      get '/custom_route_prefix/database'
+      expect(response.status).to eq(550)
+      expect(response.body).to include 'health_check failed'
+    end
+  end
+
+  describe '/custom_route_prefix/email' do
+    it 'works with smtp server' do
+      mock_smtp_server do
+        get '/custom_route_prefix/email'
+        expect(response).to be_ok
+      end
+    end
+
+    it 'fails with no smtp server' do
+      get '/custom_route_prefix/email'
+      expect(response.status).to eq(550)
+      expect(response.body).to include 'health_check failed'
+    end
+  end
+
+  describe '/custom_route_prefix/pass (a custom check does nothing)' do
+    it 'works if another custom check is invalid' do
+      get '/custom_route_prefix/pass'
+      expect(response).to be_ok
+    end
+
+    it 'works if another custom check is valid' do
+      enable_custom_check do
+        get '/custom_route_prefix/pass'
+        expect(response).to be_ok
+      end
+    end
+  end
+
+  describe '/heath_check/custom' do
+    it 'works with valid custom check' do
+      enable_custom_check do
+        get '/custom_route_prefix/custom'
+      end
+      expect(response).to be_ok
+    end
+
+    it 'fails with invalid custom check' do
+      get '/custom_route_prefix/custom'
+      expect(response.status).to eq(550)
+      expect(response.body).to include 'health_check failed'
+    end
+
+    context 'with specified format' do
+      it 'returns plain text if client requests html format' do
+        enable_custom_check do
+          get '/custom_route_prefix/custom.html'
+        end
+        expect(response).to be_ok
+        expect(response.content_type).to include('text/plain')
+      end
+
+      it 'returns json if client requests json format' do
+        enable_custom_check do
+          get '/custom_route_prefix/custom.json'
+        end
+        expect(response).to be_ok
+        expect(response.content_type).to include('application/json')
+        expect(response.parsed_body).to include('healthy' => true, 'message' => 'custom_success_message')
+      end
+
+      it 'returns json if client requests json format and custom check is invalid' do
+        get '/custom_route_prefix/custom.json'
+        expect(response.status).to eq(555) # config.http_status_for_error_object = 555
+        expect(response.content_type).to include('application/json')
+        expect(response.parsed_body).to include('healthy' => false)
+      end
+
+      it 'returns xml if client requests xml format' do
+        enable_custom_check do
+          get '/custom_route_prefix/custom.xml'
+        end
+        expect(response).to be_ok
+        expect(response.content_type).to include('application/xml')
+        expect(response.body).to include('<healthy type="boolean">true</healthy>')
+        expect(response.body).to include('<message>custom_success_message</message>')
+      end
+
+      it 'returns xml if client requests xml format and custom check is invalid' do
+        get '/custom_route_prefix/custom.xml'
+        expect(response.status).to eq(555) # config.http_status_for_error_object = 555
+        expect(response.content_type).to include('application/xml')
+        expect(response.body).to include('<healthy type="boolean">false</healthy>')
+      end
+    end
+  end
+
+  describe '/custom_route_prefix/middleware' do
+    if ENV['MIDDLEWARE'] == 'true'
+      context 'when using middleware' do
+        it 'works with valid custom check' do
+          enable_custom_check do
+            get '/custom_route_prefix/middleware'
+          end
+          expect(response).to be_ok
+        end
+      end
+    end
+    if ENV['MIDDLEWARE'] != 'true'
+      context 'when not using middleware' do
+        it 'fails with invalid custom check' do
+          get '/custom_route_prefix/middleware'
+          expect(response.status).to eq(550)
+          expect(response.body).to include 'health_check failed'
+        end
+      end
+    end
+  end
+
+  context 'with whitelisted ip' do
+    after { HealthCheckRb.origin_ip_whitelist.clear }
+
+    it 'works with access from valid ip address' do
+      HealthCheckRb.origin_ip_whitelist << '127.0.0.1'
+      get '/custom_route_prefix/site'
+      expect(response).to be_ok
+    end
+
+    it 'fails with access from invalid ip address' do
+      HealthCheckRb.origin_ip_whitelist << '123.123.123.123'
+      get '/custom_route_prefix/site'
+      expect(response.status).to eq(403)
+    end
+
+    it 'does not affect paths other than health_check' do
+      HealthCheckRb.origin_ip_whitelist << '123.123.123.123'
+      get '/example'
+      expect(response).to be_ok
+    end
+  end
+
+  context 'with basic auth' do
+    before do
+      HealthCheckRb.basic_auth_username = 'username'
+      HealthCheckRb.basic_auth_password = 'password'
+    end
+
+    after do
+      HealthCheckRb.basic_auth_username = nil
+      HealthCheckRb.basic_auth_password = nil
+    end
+
+    it 'works with valid credentials' do
+      get '/custom_route_prefix/site',
+          headers: { 'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials('username', 'password') }
+      expect(response).to be_ok
+    end
+
+    it 'fails with wrong password' do
+      get '/custom_route_prefix/site',
+          headers: { 'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials('username', 'wrong_password') }
+      expect(response.status).to eq(401)
+    end
+
+    it 'fails with wrong username' do
+      get '/custom_route_prefix/site',
+          headers: { 'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials('wrong_username', 'password') }
+      expect(response.status).to eq(401)
+    end
+
+    it 'fails with no credentials' do
+      get '/custom_route_prefix/site'
+      expect(response.status).to eq(401)
+    end
+
+    it 'does not affect paths other than health_check' do
+      get '/example'
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'dummy/fake_app'
+require 'rspec/rails'
+require 'smtp_mock/test_framework/rspec'
+
+RSpec.configure do |config|
+  config.include SmtpMock::TestFramework::RSpec::Helper
+end
+
+# see https://github.com/mocktools/ruby-smtp-mock
+def mock_smtp_server(&)
+  smtp_mock_server port: 3555 do
+    sleep 1
+    yield
+  end
+end
+
+def enable_custom_check(&)
+  File.write CUSTOM_CHECK_FILE_PATH, 'hello'
+  yield
+ensure
+  FileUtils.rm CUSTOM_CHECK_FILE_PATH if File.exist? CUSTOM_CHECK_FILE_PATH
+end
+
+def disconnect_database
+  ActiveRecord::Tasks::DatabaseTasks.migration_connection.disconnect!
+end
+
+def reconnect_database
+  ActiveRecord::Tasks::DatabaseTasks.migration_connection.reconnect!
+end
+
+def db_migrate
+  system 'RAILS_ENV=test bundle exec rake db:migrate'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: health_check_rb
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Ian Heggie
+- Alexander Meindl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: "  \tSimple health check of Rails app for uptime monitoring with Pingdom,
+  NewRelic, EngineYard etc.\n"
+email:
+- ian@heggie.biz
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/workflows/linters.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/routes.rb
+- health_check_rb.gemspec
+- init.rb
+- lib/health_check_rb.rb
+- lib/health_check_rb/base_health_check.rb
+- lib/health_check_rb/check/elasticsearch.rb
+- lib/health_check_rb/check/rabbitmq.rb
+- lib/health_check_rb/check/redis.rb
+- lib/health_check_rb/check/resque.rb
+- lib/health_check_rb/check/s3.rb
+- lib/health_check_rb/check/sidekiq.rb
+- lib/health_check_rb/health_check_controller.rb
+- lib/health_check_rb/health_check_routes.rb
+- lib/health_check_rb/middleware_health_check.rb
+- lib/health_check_rb/utils.rb
+- lib/health_check_rb/version.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/controllers/example_controller.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/initializers/health_check.rb
+- spec/dummy/config/initializers/middleware.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/.keep
+- spec/dummy/fake_app.rb
+- spec/dummy/tmp/.keep
+- spec/fixtures/migrate/9_create_countries.rb
+- spec/health_check_rb_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alphanodes/health_check_rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Simple health check of Rails app for uptime monitoring with Pingdom, NewRelic,
+  EngineYard etc.
+test_files: []