roqua-support 0.1.29 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37d547c0a869c2c0e2a9ada0c1c81da42dd45633
-  data.tar.gz: 84acc128fb9a4dee25dd1c8e0e6109491db3976b
+  metadata.gz: 2a7e7e17065382daf49bff625d1a8008a0a4c0ba
+  data.tar.gz: 9a6b746e175193312045d7a94dc67a57d55577bb
 SHA512:
-  metadata.gz: cdc75baa084d6e000e2a2357f0ccd732c90dd228335110f7508a35066ec1680a410c614c32d9eb43ef73d4921521b0da739d3d0e764a9969353809915c917fa7
-  data.tar.gz: a074e16db2d3496285cdc293596fb6863e77089cbbd888f188f38037bb99c6917b158825ca9b375193c8addee071fe4061e63c1d57281e82437aac3ed7f8a1d6
+  metadata.gz: b507ccf0d36fc1941ad3bfb8f4a2714ce0da6e435a6c7356016ecdaffd7d77a6617822803b8ec8e4521b349d9befc228220f1f311248690f87880cfb2a46cfa8
+  data.tar.gz: 9140cb6bc4ea4b6c7b0e13276b0474b4cb3365238cb7e9166d717e85cc80d3eed2f47d7f0997c706cfe6be91afbb662d8abfa09f6dc2a7f536738718e1dd2374

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    roqua-support (0.1.29)
+    roqua-support (0.1.30)
       active_interaction (~> 3.0)
       activesupport (>= 3.2, < 6)
       naught (~> 1.0)

data/lib/roqua-support.rb

@@ -21,4 +21,10 @@ module Roqua
     autoload :Schedule, 'roqua/scheduling/schedule'
     autoload :Task, 'roqua/scheduling/task'
   end
+
+  module StatusChecks
+    autoload :CheckDbConnection, 'roqua/status_checks/check_db_connection'
+    autoload :CheckLoadBalancerMember, 'roqua/status_checks/check_load_balancer_member'
+    autoload :StatusController, 'roqua/status_checks/status_controller'
+  end
 end

data/lib/roqua-support/railtie.rb

@@ -13,4 +13,3 @@ module Roqua
     end
   end
 end
-  

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.29'.freeze
+    VERSION = '0.1.30'.freeze
   end
 end

data/lib/roqua/status_checks/check_db_connection.rb

@@ -0,0 +1,13 @@
+module Roqua
+  module StatusChecks
+    module CheckDbConnection
+      def self.connected?
+        ActiveRecord::Base.establish_connection
+        ActiveRecord::Base.connection
+        ActiveRecord::Base.connected?
+      rescue
+        false # Check must return boolean, not an exception.
+      end
+    end
+  end
+end

data/lib/roqua/status_checks/check_load_balancer_member.rb

@@ -0,0 +1,15 @@
+module Roqua
+  module StatusChecks
+    module CheckLoadBalancerMember
+      InvalidStatus = Class.new(StandardError)
+
+      VALID_STATES = %w(on off)
+
+      def self.balancer_member?(path)
+        state = ::File.read(path).strip
+        raise InvalidStatus, "Invalid state: #{state}" unless VALID_STATES.include?(state)
+        state == "on"
+      end
+    end
+  end
+end

data/lib/roqua/status_checks/status_controller.rb

@@ -0,0 +1,43 @@
+module Roqua
+  module StatusChecks
+    # To use this status controller in a Rails application, add a route:
+    #
+    # get '/status' => 'roqua/status_checks/status#balancer_status'
+    #
+    # If you want to add more logic to the status controller, extend it:
+    #
+    # get '/status' => 'status#balancer_status'
+    #
+    # class StatusController < Roqua::StatusChecks::StatusController
+    #   skip_before_action :foo
+    #   skip_before_action :bar
+    # end
+    class StatusController < ActionController::Base
+      def balancer_status
+        balancer_member = balancer_member?
+        db_connected = db_connected?
+
+        http_code = balancer_member && db_connected ? 200 : 503
+        status = db_connected ? 'ok' : 'error'
+
+        render json: {status: status, member: balancer_member}, status: http_code
+      rescue CheckLoadBalancerMember::InvalidStatus
+        render json: {status: "unknown status"}, status: 500
+      end
+
+      protected
+
+      def balancer_state_file
+        Rails.root.join('config/balancer_state')
+      end
+
+      def balancer_member?
+        CheckLoadBalancerMember.balancer_member?(balancer_state_file)
+      end
+
+      def db_connected?
+        CheckDbConnection.connected?
+      end
+    end
+  end
+end

data/spec/internal/config/balancer_state

@@ -0,0 +1 @@
+on

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/status' => 'roqua/status_checks/status#balancer_status', as: :balancer_status
+end

data/spec/roqua/status_checks/check_db_connection_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Roqua::StatusChecks::CheckDbConnection' do
+  it 'returns true when there is a db connection' do
+    allow(ActiveRecord::Base).to receive(:establish_connection).and_return(true)
+    allow(ActiveRecord::Base).to receive(:connection).and_return(true)
+    allow(ActiveRecord::Base).to receive(:connected?).and_return(true)
+
+    expect(Roqua::StatusChecks::CheckDbConnection.connected?).to be_truthy
+  end
+
+  it 'returns false when there is no db configured' do
+    expect(Roqua::StatusChecks::CheckDbConnection.connected?).to be_falsey
+  end
+end

data/spec/roqua/status_checks/check_load_balancer_member_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Roqua::StatusChecks::CheckLoadBalancerMember' do
+  it 'returns true when the status file contains on' do
+    allow(File).to receive(:read).and_return('on')
+
+    expect(Roqua::StatusChecks::CheckLoadBalancerMember.balancer_member?('foo/bar')).to be_truthy
+  end
+
+  it 'returns false when the status file does not contain off' do
+    allow(File).to receive(:read).and_return('off')
+
+    expect(Roqua::StatusChecks::CheckLoadBalancerMember.balancer_member?('foo/bar')).to be_falsey
+  end
+
+  it 'raises InvalidStatus error when the status file contains something else' do
+    allow(File).to receive(:read).and_return('foo')
+
+    expect { Roqua::StatusChecks::CheckLoadBalancerMember.balancer_member?('foo/bar') }
+      .to raise_error(Roqua::StatusChecks::CheckLoadBalancerMember::InvalidStatus, 'Invalid state: foo')
+  end
+end

data/spec/roqua/status_checks/status_controller_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Roqua::StatusChecks::StatusController, type: :controller do
+  context 'visiting the status page while balancer member and database is up' do
+    it 'returns the correct status' do
+      allow(Roqua::StatusChecks::CheckLoadBalancerMember).to receive(:balancer_member?).and_return(true)
+      allow(Roqua::StatusChecks::CheckDbConnection).to receive(:connected?).and_return(true)
+
+      get :balancer_status
+
+      expect(response.status).to eq(200)
+      expect(response.body).to eq("{\"status\":\"ok\",\"member\":true}")
+    end
+  end
+
+  context 'visiting the status page while not balancer member and database is up' do
+    it 'returns the correct status' do
+      allow(Roqua::StatusChecks::CheckLoadBalancerMember).to receive(:balancer_member?).and_return(false)
+      allow(Roqua::StatusChecks::CheckDbConnection).to receive(:connected?).and_return(true)
+
+      get :balancer_status
+
+      expect(response.status).to eq(503)
+      expect(response.body).to eq("{\"status\":\"ok\",\"member\":false}")
+    end
+  end
+
+  context 'visiting the status page while balancer member and database is down' do
+    it 'returns the correct status' do
+      allow(Roqua::StatusChecks::CheckLoadBalancerMember).to receive(:balancer_member?).and_return(true)
+      allow(Roqua::StatusChecks::CheckDbConnection).to receive(:connected?).and_return(false)
+
+      get :balancer_status
+
+      expect(response.status).to eq(503)
+      expect(response.body).to eq("{\"status\":\"error\",\"member\":true}")
+    end
+  end
+
+  context 'visiting the status page while not balancer member and database is down' do
+    it 'returns the correct status' do
+      allow(Roqua::StatusChecks::CheckLoadBalancerMember).to receive(:balancer_member?).and_return(false)
+      allow(Roqua::StatusChecks::CheckDbConnection).to receive(:connected?).and_return(false)
+
+      get :balancer_status
+
+      expect(response.status).to eq(503)
+      expect(response.body).to eq("{\"status\":\"error\",\"member\":false}")
+    end
+  end
+
+  context 'visiting the status page while balancer_state is on nor off' do
+    it 'returns the correct status' do
+      allow(Roqua::StatusChecks::CheckLoadBalancerMember).to receive(:balancer_member?)
+        .and_raise(Roqua::StatusChecks::CheckLoadBalancerMember::InvalidStatus)
+
+      get :balancer_status
+
+      expect(response.status).to eq(500)
+      expect(response.body).to eq("{\"status\":\"unknown status\"}")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.29
+  version: 0.1.30
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_interaction
@@ -221,6 +221,9 @@ files:
 - lib/roqua/scheduling/schedule.rb
 - lib/roqua/scheduling/scheduler.rb
 - lib/roqua/scheduling/task.rb
+- lib/roqua/status_checks/check_db_connection.rb
+- lib/roqua/status_checks/check_load_balancer_member.rb
+- lib/roqua/status_checks/status_controller.rb
 - lib/roqua/support.rb
 - lib/roqua/support/command_runner.rb
 - lib/roqua/support/errors.rb
@@ -231,6 +234,8 @@ files:
 - lib/roqua/support/stats/hosted_graphite_backend.rb
 - lib/roqua/validators/subset_validator.rb
 - roqua-support.gemspec
+- spec/internal/config/balancer_state
+- spec/internal/config/routes.rb
 - spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb
 - spec/roqua/core_ext/active_interaction/duration_filter_spec.rb
 - spec/roqua/core_ext/active_interaction/rails_intrumentation_spec.rb
@@ -244,6 +249,9 @@ files:
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/scheduling/scheduler_spec.rb
+- spec/roqua/status_checks/check_db_connection_spec.rb
+- spec/roqua/status_checks/check_load_balancer_member_spec.rb
+- spec/roqua/status_checks/status_controller_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/helpers_spec.rb
 - spec/roqua/support/logwrapper_spec.rb
@@ -273,11 +281,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Helper objects and proxies used by a lot of RoQua applications
 test_files:
+- spec/internal/config/balancer_state
+- spec/internal/config/routes.rb
 - spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb
 - spec/roqua/core_ext/active_interaction/duration_filter_spec.rb
 - spec/roqua/core_ext/active_interaction/rails_intrumentation_spec.rb
@@ -291,6 +301,9 @@ test_files:
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/scheduling/scheduler_spec.rb
+- spec/roqua/status_checks/check_db_connection_spec.rb
+- spec/roqua/status_checks/check_load_balancer_member_spec.rb
+- spec/roqua/status_checks/status_controller_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/helpers_spec.rb
 - spec/roqua/support/logwrapper_spec.rb