health-reporter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bec795aa467f18c19a4082de1a606a7f9f85a1f1
-  data.tar.gz: 6cc065ff3b203db1b5ec80be22c143f98fc2ad70
+  metadata.gz: 90f655ef277bd77b6f90e6129976868c5c3f934f
+  data.tar.gz: d905978f2768c0472a238e4b5c8c3c0b3831e882
 SHA512:
-  metadata.gz: 9efeb9f05cbb9c332e41a742061b771a1e0fd396c93a98faa9dd98ad035e2dfdacf45e818cf5ff068d308bc9d41852bc96023d7aea6f490f5258b4716364a184
-  data.tar.gz: 6b5048d5c2ef58ae49363915fd62efa39307c13f01f0a05c272c7e1fdb958538190f43dd096de1a8d8e8eecdd6b6bf1d467e660fe3946b377a6b84ce75111363
+  metadata.gz: 9ab4e6974bcc5ffad2e8d454e28f21e87d1528c6bd3fbfc4fd13bdcd1850d57a0502df6e7000b9d2fa3d21fa0eabfcca69564b0495f2972f25d256aa8262fd0d
+  data.tar.gz: df47ccab910847e661cc3769594344408635bdced26e8c93563bfceb672fa6445ad332010ae94dc05cf0ede58be9fb7bcf80fec1cd13b8afb28a77eae4e935ac

data/.gitignore

@@ -50,3 +50,4 @@ build-iPhoneSimulator/
 .rvmrc
 
 Gemfile.lock
+.byebug_history

data/README.md

@@ -33,6 +33,7 @@ docker-compose run --rm health-reporter bundle exec rspec -cfd spec/*
 
 ## Usage
 
+#TODO add dependency registration and calling
 
 ## Contributing
 

data/health-reporter.gemspec

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

data/lib/health_reporter.rb

@@ -1,4 +1,4 @@
-module HealthReporter
+class HealthReporter
 end
 
 require 'health_reporter/reporter'

data/lib/health_reporter/reporter.rb

@@ -1,15 +1,74 @@
-require 'json'
+require 'singleton'
 
-module HealthReporter
-  class Reporter
-    def initialize(healthy: true)
-      @healthy = healthy
-    end
+class HealthReporter
+  include Singleton
+
+  def self.self_test
+    @@self_test
+  end
+
+  def self.self_test=(self_test)
+    @@self_test = self_test
+  end
+
+  def self.unhealthy_cache_ttl
+    @@unhealthy_cache_ttl
+  end
+
+  def self.unhealthy_cache_ttl=(unhealthy_cache_ttl)
+    @@unhealthy_cache_ttl = unhealthy_cache_ttl
+  end
+
+  def self.healthy_cache_ttl
+    @@healthy_cache_ttl
+  end
 
+  def self.healthy_cache_ttl=(healthy_cache_ttl)
+    @@healthy_cache_ttl = healthy_cache_ttl
+  end
+
+  @@self_test = lambda{ true }
+  @@unhealthy_cache_ttl = 30
+  @@healthy_cache_ttl   = 60
+  @@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.healthy?
+    @@semaphore.synchronize {
+      perform_health_check if @@healthy.nil? or cache_ttl_expired
+      @@healthy
+    }
+  end
+
+  private
 
-    def healthy
-      @healthy
+  def self.perform_health_check
+    @@healthy = sanitize(@@self_test.call)
+    @@last_check_time = Time.now
+  end
+
+  def self.sanitize(result)
+    unless [true, false].include?(result)
+      raise "Invalid non-boolean response from registered self-check lambda: #{result.to_s}"
     end
+    result
+  end
+
+  def self.cache_ttl_expired
+    return true if @@last_check_time.nil?
+    Time.now > (@@last_check_time + ttl)
+  end
+
+  def self.ttl
+    return @@healthy_cache_ttl if @@healthy
+    @@unhealthy_cache_ttl
   end
 end

data/lib/health_reporter/version.rb

@@ -1,3 +1,3 @@
-module HealthReporter
-  VERSION = '0.0.1'
+class HealthReporter
+  VERSION = '0.0.2'
 end

data/spec/reporter.rb

@@ -1,12 +1,199 @@
 require 'spec_helper'
-require 'yaml'
 
-describe HealthReporter::Reporter do
-  subject { HealthReporter::Reporter }
+describe HealthReporter do
+  subject { HealthReporter }
 
   it 'has a version number' do
     expect(HealthReporter::VERSION).not_to be nil
   end
 
+  before(:each) do
+    subject.healthy_cache_ttl = 60
+    subject.unhealthy_cache_ttl = 30
+    subject.self_test = lambda{ true }
+    subject.class_variable_set(:@@last_check_time, nil)
+    subject.class_variable_set(:@@healthy, nil)
+    Timecop.return
+    reset_lambda_runner_spy
+  end
+
+  context 'when configuring' do
+    it 'remembers the self-test lambda passed to it' do
+      test_lambda = lambda{ 'ab' == 'cd' }
+      subject.self_test = test_lambda
+      expect(subject.self_test).to be test_lambda
+    end
+
+    it 'uses the self-test lambda passed to it' do
+      test_lambda = spy_lambda_returning_false
+      subject.self_test = test_lambda
+      expect(subject.self_test).to be test_lambda
+      expect(subject.healthy?).to be false
+      expect(spy_lambda_was_run?).to eq true
+    end
+
+    it 'remembers the cache ttl when healthy' do
+      subject.healthy_cache_ttl = 10
+      expect(subject.healthy_cache_ttl).to eq 10
+    end
+
+    it 'remembers the cache ttl when not healthy' do
+      subject.unhealthy_cache_ttl = 5
+      expect(subject.unhealthy_cache_ttl).to eq 5
+    end
+  end
+
+  context 'when exercising self-test lambda' do
+    it 'allows true to be returned by self-test lambda' do
+      test_lambda = lambda{ true }
+      subject.self_test = test_lambda
+      expect(subject.healthy?).to be true
+    end
+
+    it 'allows false to be returned by self-test lambda' do
+      test_lambda = lambda{ false }
+      subject.self_test = test_lambda
+      expect(subject.healthy?).to be false
+    end
+
+    it 'raises an exception when non-boolean values are returned by self-test lambda' do
+      test_lambda = lambda{ "I don't feel well..." }
+      subject.self_test = test_lambda
+      expect{subject.healthy?}.to raise_error RuntimeError, "Invalid non-boolean response from registered self-check lambda: I don't feel well..."
+    end
+  end
+
+  context 'when initialized without any parameters' do
+    it 'sets the default self-test lambda to { true }' do
+      expect(subject.healthy?).to eq true
+    end
+
+    it 'sets the default healthy state cache ttl to 60 seconds' do
+      expect(subject.healthy_cache_ttl).to eq 60
+    end
+
+    it 'sets the default unhealthy state cache ttl to 30 seconds' do
+      expect(subject.unhealthy_cache_ttl).to eq 30
+    end
+  end
+
+  context 'when calling health check for first time (no cached health state)' do
+    it 'calls the configured self-test lambda and returns health' 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 current state is healty' do
+    before(:each) do
+      subject.self_test = spy_lambda_returning_true
+      subject.healthy? #force the self-test
+      reset_lambda_runner_spy #reset the spy so that we can see if it was run or not
+    end
+
+    context 'when neither healty-cache-ttl nor unhealty-cache-ttl has expired' do
+      before(:each) do
+        subject.unhealthy_cache_ttl = 10
+        subject.healthy_cache_ttl   = 10
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'does not call the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq false
+      end
+      it 'returns the current healthy state' do
+        expect(subject.healthy?).to be true
+      end
+    end
+
+    context 'when healty-cache-ttl has expired' do
+      before do
+        subject.unhealthy_cache_ttl = 10
+        subject.healthy_cache_ttl   =  3
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'calls the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq true
+      end
+      it 'returns the current healthy state' do
+        expect(subject.healthy?).to be true
+      end
+    end
+
+    context 'when unhealty-cache-ttl has expired' do
+      before(:each) do
+        subject.unhealthy_cache_ttl =  3
+        subject.healthy_cache_ttl   = 10
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'does not call the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq false
+      end
+      it 'returns the current healthy state' do
+        expect(subject.healthy?).to be true
+      end
+    end
+  end
+
+  context 'when current state is unhealty' do
+    before(:each) do
+      subject.self_test = spy_lambda_returning_false
+      subject.healthy? #force the self-test
+      reset_lambda_runner_spy #reset the spy so that we can see if it was run or not
+    end
+
+    context 'when neither healty-cache-ttl nor unhealty-cache-ttl has expired' do
+      before(:each) do
+        subject.unhealthy_cache_ttl = 10
+        subject.healthy_cache_ttl   = 10
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'does not call the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq false
+      end
+      it 'returns the current unhealthy state' do
+        expect(subject.healthy?).to be false
+      end
+    end
+
+    context 'when healty-cache-ttl has expired' do
+      before(:each) do
+        subject.unhealthy_cache_ttl = 10
+        subject.healthy_cache_ttl   =  3
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'does not call the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq false
+      end
+      it 'returns the current unhealthy state' do
+        expect(subject.healthy?).to be false
+      end
+    end
+
+    context 'when unhealty-cache-ttl has expired' do
+      before(:each) do
+        subject.unhealthy_cache_ttl =  3
+        subject.healthy_cache_ttl   = 10
+        Timecop.freeze(Time.now + 5)
+      end
+
+      it 'calls the registered self-test lambda' do
+        subject.healthy? #request here and test if it was run in expect below
+        expect(spy_lambda_was_run?).to eq true
+      end
+      it 'returns the current unhealthy state' do
+        expect(subject.healthy?).to be false
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,36 @@
 require 'simplecov'
 require 'simplecov-rcov'
+require 'timecop'
 
 SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 SimpleCov.start do
-  add_filter "/spec/"
+  add_filter "./spec/"
 end
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'health_reporter'
+
+
+def reset_lambda_runner_spy
+  @test_variable_from_sender = Random.new.rand(1...100000000000)
+  @test_variable_from_receiver = 0
+end
+
+def spy_lambda_was_run?
+  @test_variable_from_receiver == @test_variable_from_sender
+end
+
+def spy_lambda_returning_false
+  lambda{
+    @test_variable_from_receiver = @test_variable_from_sender
+    return false
+  }
+end
+
+def spy_lambda_returning_true
+  lambda{
+    @test_variable_from_receiver = @test_variable_from_sender
+    return true
+  }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Barney de Villiers
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement