health-reporter 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155d97c5b4cc48d064e2d0c3ba40c19094a6c700
-  data.tar.gz: 2e1bc68f9c30819cd1fd586ce1a7f01552e038dc
+  metadata.gz: 0cb4fa023528d34cc49ead890ceefdd3e4ea4c27
+  data.tar.gz: 917837548ae64725f7d6810f12359739beff2549
 SHA512:
-  metadata.gz: 049f9b1956fccdd9d144bcb087e159b8555e2e861d239a0f32929209ce65c88426586fa5d2b18647656f02e50e4be0e08e1ba1d426d30427f36b6dd007bdd9a8
-  data.tar.gz: 1a538e5844bff5fd7c8ac3a0e29d1814e86884ffb03f040959dfdc731944865e64960237453c9f10ef6d3eb73581cec4f276980e0f601c42f0d9b836373bdb46
+  metadata.gz: ab251e2c390fbcd452c91fd626a7f9cb0064495bb1c1474657e0840206a9a1ee20d03846b1559e51d989c5c2434a4ff06d48586f2a84a072c10ba5b9ec477896
+  data.tar.gz: 9ecfa361f55d9663da8475b996c8e17fbf5d9a6a98fad32e13c0b4a123bfac4acd30fda40648b90140aec044d5a429e43426cb29d98433b9f8d15259aed93506

data/README.md

@@ -72,9 +72,19 @@ In the controller/model of the health check you simply call the following and ba
   => false
 ```
 
-## Future
+### Add service dependencies to check
 
-### Add dependency registration and calling
+In a microservices environment the health of a service is also determined by the health of other services it is reaching out to during normal operation.  This gem allows you to register those dependency services to also be checked.  The dependencies are checked along with the service self-check.  The combined health state will be cached.  Therefore whilst the cache is still valid, the dependencies will also not be rechecked.
+
+```ruby
+  HealthReporter.register_dependency(url: 'https://hardware-store/status')
+```
+
+Or with specific status code and timeout configuration:
+
+```ruby
+  HealthReporter.register_dependency(url: 'https://hardware-store/status', code: 200, timeout: 3)
+```
 
 ## Contributing
 

data/health-reporter.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'faraday', '~> 0.14.0'
+
+  spec.add_development_dependency 'webmock', '~> 2.1'
   spec.add_development_dependency 'timecop', '~> 0.8.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/health_reporter/reporter.rb

@@ -1,4 +1,6 @@
 require 'singleton'
+require 'uri'
+require 'faraday'
 
 class HealthReporter
   include Singleton
@@ -30,16 +32,23 @@ class HealthReporter
   @@self_test = lambda{ true }
   @@unhealthy_cache_ttl = 30
   @@healthy_cache_ttl   = 60
+  @@dependencies        = {}
   @@last_check_time     = nil
   @@healthy             = nil #Initialized as nil so that first call will set it
   @@semaphore           = Mutex.new
 
-  # TODO
-  # def register_dependency_check(url:, code: 200)
-  #   raise "Configured URL #{url} is invalid" unless url =~ URI::regexp
-  #
-  #   dependencies[]
-  # end
+  def self.clear_dependencies
+    @@dependencies = {}
+  end
+
+  def self.dependencies
+    @@dependencies
+  end
+
+  def self.register_dependency(url:, code: 200, timeout: 2)
+    raise "Configured URL #{url} is invalid" unless url =~ URI::regexp
+    dependencies[url] = { :code => code, :timeout => timeout }
+  end
 
   def self.healthy?
     @@semaphore.synchronize {
@@ -51,8 +60,31 @@ class HealthReporter
   private
 
   def self.perform_health_check
-    @@healthy = sanitize(@@self_test.call)
     @@last_check_time = Time.now
+    @@healthy = sanitize(@@self_test.call)
+    check_dependencies if @@healthy
+  end
+
+  def self.check_dependencies
+    @@dependencies.each { |url, configuration|
+      check_dependency(url: url, configuration: configuration)
+    }
+    @@healthy = true
+  end
+
+  def self.check_dependency(url:, configuration:)
+    conn = Faraday.new(:url => url)
+    response = conn.get do |request|
+      request.options.timeout = configuration[:timeout]
+      request.options.open_timeout = configuration[:timeout]
+    end
+
+    unless response.status == configuration[:code]
+      raise "Response expected to be #{configuration[:code]} but is #{response.status}"
+    end
+  rescue => exception
+    @@healthy = false
+    raise "Dependency <#{url}> failed check due to #{exception.class}: #{exception.message}"
   end
 
   def self.sanitize(result)

data/lib/health_reporter/version.rb

@@ -1,3 +1,3 @@
 class HealthReporter
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/reporter.rb

@@ -13,6 +13,7 @@ describe HealthReporter do
     subject.self_test = lambda{ true }
     subject.class_variable_set(:@@last_check_time, nil)
     subject.class_variable_set(:@@healthy, nil)
+    subject.clear_dependencies
     Timecop.return
     reset_lambda_runner_spy
   end
@@ -41,6 +42,38 @@ describe HealthReporter do
       subject.unhealthy_cache_ttl = 5
       expect(subject.unhealthy_cache_ttl).to eq 5
     end
+
+    it 'remembers when you add a dependencies' do
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      expect(subject.dependencies).to eq({
+        'https://hardware-store/status' => { :code => 123, :timeout => 1 }
+      })
+    end
+
+    it 'validates the urls of the dependencies during registration' do
+      expect{subject.register_dependency(url: 'no-valid-url')}.to raise_error RuntimeError, "Configured URL no-valid-url is invalid"
+    end
+
+    it 'adds dependencies without removing the dependencies already registered' do
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      subject.register_dependency(url: 'https://grocery-store/status', code: 123, timeout: 1)
+      expect(subject.dependencies).to eq({
+        'https://hardware-store/status' => { :code => 123, :timeout => 1 },
+        'https://grocery-store/status' => { :code => 123, :timeout => 1 }
+      })
+    end
+
+    it 'does not duplicate similar dependency urls' do
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      subject.register_dependency(url: 'https://hardware-store/status', code: 123, timeout: 1)
+      subject.register_dependency(url: 'https://grocery-store/status', code: 123, timeout: 1)
+      expect(subject.dependencies).to eq({
+        'https://hardware-store/status' => { :code => 123, :timeout => 1 },
+        'https://grocery-store/status' => { :code => 123, :timeout => 1 }
+      })
+    end
   end
 
   context 'when exercising self-test lambda' do
@@ -196,4 +229,51 @@ describe HealthReporter do
       end
     end
   end
+
+  context 'when checking dependencies' do
+    context 'when there are no dependencies registered' do
+      it 'only performs the self-test' do
+        subject.self_test = spy_lambda_returning_false
+        expect(subject.healthy?).to be false
+        expect(spy_lambda_was_run?).to eq true
+      end
+    end
+
+    context 'when there are multiple dependencies registered' do
+      before(:each) do
+        subject.register_dependency(url: 'https://hardware-store/status')
+        subject.register_dependency(url: 'https://grocery-store/status')
+        subject.self_test = spy_lambda_returning_true
+      end
+
+      it 'performs the self-test and checks all dependencies' do
+        stub_request(:get, "https://hardware-store/status").to_return(:status => 200, :body => "", :headers => {})
+        stub_request(:get, "https://grocery-store/status").to_return(:status => 200, :body => "", :headers => {})
+        expect(subject.healthy?).to be true
+        expect(spy_lambda_was_run?).to eq true
+      end
+
+      it 'indicates healthy if all of the dependencies are healthy' do
+        stub_request(:get, "https://hardware-store/status").to_return(:status => 200, :body => "", :headers => {})
+        stub_request(:get, "https://grocery-store/status").to_return(:status => 200, :body => "", :headers => {})
+        expect(subject.healthy?).to be true
+        expect(spy_lambda_was_run?).to eq true
+      end
+
+      it 'raises a detailed exception indicating why a dependency was determined to be unhealthy state was uncached' do
+        stub_request(:get, "https://hardware-store/status").to_return(:status => 500, :body => "", :headers => {})
+        stub_request(:get, "https://grocery-store/status").to_return(:status => 200, :body => "", :headers => {})
+        expect{subject.healthy?}.to raise_error RuntimeError, "Dependency <https://hardware-store/status> failed check due to RuntimeError: Response expected to be 200 but is 500"
+      end
+
+      it 'indicates cached unhealthy state if it is unhealthy because a dependency was unhealthy' do
+        stub_request(:get, "https://hardware-store/status").to_return(:status => 500, :body => "", :headers => {})
+        stub_request(:get, "https://grocery-store/status").to_return(:status => 200, :body => "", :headers => {})
+        expect{subject.healthy?}.to raise_error RuntimeError, "Dependency <https://hardware-store/status> failed check due to RuntimeError: Response expected to be 200 but is 500"
+        reset_lambda_runner_spy
+        expect(subject.healthy?).to be false
+        expect(spy_lambda_was_run?).to eq false
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'simplecov'
 require 'simplecov-rcov'
 require 'timecop'
+require 'webmock/rspec'
 
 SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 SimpleCov.start do

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: health-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Barney de Villiers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement