fettle 0.1.0 → 0.2.0

data/spec/examples.txt

@@ -1,3 +1,24 @@
-example_id                                                   | status | run_time        |
------------------------------------------------------------- | ------ | --------------- |
-./spec/controllers/fettle/health_controller_spec.rb[1:1:1:1] | passed | 0.00815 seconds |
+example_id                                                     | status | run_time        |
+-------------------------------------------------------------- | ------ | --------------- |
+./spec/controllers/fettle/health_controller_spec.rb[1:1:1:1]   | passed | 0.01177 seconds |
+./spec/controllers/fettle/health_controller_spec.rb[1:1:1:2:1] | passed | 0.00176 seconds |
+./spec/controllers/fettle/health_controller_spec.rb[1:1:2:1]   | passed | 0.00158 seconds |
+./spec/controllers/fettle/health_controller_spec.rb[1:1:2:2:1] | passed | 0.00166 seconds |
+./spec/lib/fettle/check_result_spec.rb[1:1:1:1]                | passed | 0.00044 seconds |
+./spec/lib/fettle/check_result_spec.rb[1:1:2:1]                | passed | 0.00044 seconds |
+./spec/lib/fettle/check_result_spec.rb[1:2:1:1]                | passed | 0.00044 seconds |
+./spec/lib/fettle/check_result_spec.rb[1:2:2:1]                | passed | 0.00086 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:1:1]                     | passed | 0.00063 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:1:2:1]                   | passed | 0.00063 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:2:1]                     | passed | 0.00063 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:2:2:1]                   | passed | 0.00069 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:3:1]                     | passed | 0.00131 seconds |
+./spec/lib/fettle/checker_spec.rb[1:1:3:2:1]                   | passed | 0.00068 seconds |
+./spec/lib/fettle/checks/active_record_check_spec.rb[1:1:1:1]  | passed | 0.00922 seconds |
+./spec/lib/fettle/checks/active_record_check_spec.rb[1:1:2:1]  | passed | 0.00154 seconds |
+./spec/lib/fettle/configuration_spec.rb[1:1:1]                 | passed | 0.00228 seconds |
+./spec/lib/fettle/configuration_spec.rb[1:2:1:1:1]             | passed | 0.00142 seconds |
+./spec/lib/fettle/liveness_check_result_spec.rb[1:1:1:1]       | passed | 0.0005 seconds  |
+./spec/lib/fettle/liveness_check_result_spec.rb[1:1:2:1]       | passed | 0.00049 seconds |
+./spec/lib/fettle/liveness_check_result_spec.rb[1:2:1:1]       | passed | 0.00045 seconds |
+./spec/lib/fettle/liveness_check_result_spec.rb[1:2:2:1]       | passed | 0.00041 seconds |

data/spec/lib/fettle/check_result_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'fettle/check_result'
+
+module Fettle
+  RSpec.describe CheckResult do
+    describe '#healthy?' do
+      subject { described_class.new(status) }
+
+      let(:status) { true }
+
+      context 'for successful checks' do
+        it { is_expected.to be_healthy }
+      end
+
+      context 'for failed checks' do
+        let(:status) { false }
+
+        it { is_expected.to_not be_healthy }
+      end
+    end
+
+    describe '#status_code' do
+      subject { described_class.new(status).status_code }
+
+      let(:status) { true }
+
+      context 'for successful checks' do
+        it { is_expected.to eq(:ok) }
+      end
+
+      context 'for failed checks' do
+        let(:status) { false }
+
+        it { is_expected.to eq(:service_unavailable) }
+      end
+    end
+  end
+end

data/spec/lib/fettle/checker_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'fettle/checker'
+
+module Fettle
+  RSpec.describe Checker do
+    describe '.run' do
+      subject(:result) { described_class.run(tag: tag) }
+
+      before do
+        allow(Configuration).to receive(:checks).and_return(checks)
+      end
+      let(:checks) do
+        [ check ]
+      end
+
+      let(:tag) { nil }
+
+      let(:check) do
+        Class.new do
+          def self.call
+            true
+          end
+        end
+      end
+
+      context 'when all checks are successful' do
+        it 'returns a successful CheckResult' do
+          expect(result).to be_an_instance_of(CheckResult)
+          expect(result.healthy?).to be_truthy
+        end
+
+        context 'and the liveness tag is passed' do
+          let(:tag) { 'liveness' }
+
+          it 'returns a successful LivenessCheckResult' do
+            expect(result).to be_an_instance_of(LivenessCheckResult)
+            expect(result.healthy?).to be_truthy
+          end
+        end
+      end
+
+      context 'when a check fails' do
+        let(:check) do
+          Class.new do
+            def self.call
+              false
+            end
+          end
+        end
+
+        it 'returns a failed CheckResult' do
+          expect(result).to be_an_instance_of(CheckResult)
+          expect(result.healthy?).to be_falsey
+        end
+
+        context 'and the liveness tag is passed' do
+          let(:tag) { 'liveness' }
+
+          it 'returns a failed LivenessCheckResult' do
+            expect(result).to be_an_instance_of(LivenessCheckResult)
+            expect(result.healthy?).to be_falsey
+          end
+        end
+      end
+
+      context 'when a check errors' do
+        let(:check) do
+          Class.new do
+            def self.call
+              raise
+            end
+          end
+        end
+
+        it 'returns a failed CheckResult' do
+          expect(result).to be_an_instance_of(CheckResult)
+          expect(result.healthy?).to be_falsey
+        end
+
+        context 'and the liveness tag is passed' do
+          let(:tag) { 'liveness' }
+
+          it 'returns a failed LivenessCheckResult' do
+            expect(result).to be_an_instance_of(LivenessCheckResult)
+            expect(result.healthy?).to be_falsey
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fettle/checks/active_record_check_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+require 'fettle/checks/active_record_check'
+
+module Fettle
+  module Checks
+    RSpec.describe ActiveRecordCheck do
+      describe '.call' do
+        subject(:check) { described_class.call }
+
+        context 'when a connection can be established' do
+          before do
+            allow(ActiveRecord::Base)
+              .to receive(:connected?).and_return(true)
+          end
+
+          it { is_expected.to be_truthy }
+        end
+
+        context 'when a connection can not be established' do
+          before do
+            allow(ActiveRecord::Base)
+              .to receive(:connected?).and_return(false)
+          end
+
+          it 'raises a failed check error' do
+            expect { check }.to raise_error(
+              FailedCheck,
+              'Failed to establish database connection'
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fettle/configuration_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+module Fettle
+  RSpec.describe Configuration do
+    describe '.configure' do
+      it 'yields itself' do
+        expect { |b| described_class.configure(&b) }
+          .to yield_with_args(described_class)
+      end
+    end
+
+    describe '.add_check' do
+      after { described_class.clear_checks! }
+
+      context 'when a symbol is passed' do
+        context 'and references a valid check' do
+          it 'adds the check' do
+            described_class.add_check(:active_record)
+
+            expect(described_class.checks)
+              .to include(Checks::ActiveRecordCheck)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/fettle/liveness_check_result_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'fettle/liveness_check_result'
+
+module Fettle
+  RSpec.describe LivenessCheckResult do
+    describe '#healthy?' do
+      subject { described_class.new(status) }
+
+      let(:status) { true }
+
+      context 'for successful checks' do
+        it { is_expected.to be_healthy }
+      end
+
+      context 'for failed checks' do
+        let(:status) { false }
+
+        it { is_expected.to_not be_healthy }
+      end
+    end
+
+    describe '#status_code' do
+      subject { described_class.new(status).status_code }
+
+      let(:status) { true }
+
+      context 'for successful checks' do
+        it { is_expected.to eq(:ok) }
+      end
+
+      context 'for failed checks' do
+        let(:status) { false }
+
+        it { is_expected.to eq(:ok) }
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -9,6 +9,8 @@ if Rails.env.production?
 end
 require 'rspec/rails'
 
+require 'fettle'
+
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fettle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sean Kenny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,7 +88,12 @@ files:
 - app/views/layouts/fettle/application.html.erb
 - config/routes.rb
 - lib/fettle.rb
+- lib/fettle/check_result.rb
+- lib/fettle/checker.rb
+- lib/fettle/checks/active_record_check.rb
+- lib/fettle/configuration.rb
 - lib/fettle/engine.rb
+- lib/fettle/liveness_check_result.rb
 - lib/fettle/version.rb
 - lib/tasks/fettle_tasks.rake
 - spec/controllers/fettle/health_controller_spec.rb
@@ -125,6 +130,7 @@ files:
 - spec/dummy/config/initializers/application_controller_renderer.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/fettle.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
@@ -146,6 +152,11 @@ files:
 - spec/dummy/public/apple-touch-icon.png
 - spec/dummy/public/favicon.ico
 - spec/examples.txt
+- spec/lib/fettle/check_result_spec.rb
+- spec/lib/fettle/checker_spec.rb
+- spec/lib/fettle/checks/active_record_check_spec.rb
+- spec/lib/fettle/configuration_spec.rb
+- spec/lib/fettle/liveness_check_result_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 homepage: https://git.thebeansgroup.com/utilities/fettle
@@ -205,6 +216,7 @@ test_files:
 - spec/dummy/config/initializers/application_controller_renderer.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/fettle.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
@@ -228,5 +240,10 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/examples.txt
+- spec/lib/fettle/check_result_spec.rb
+- spec/lib/fettle/checker_spec.rb
+- spec/lib/fettle/checks/active_record_check_spec.rb
+- spec/lib/fettle/configuration_spec.rb
+- spec/lib/fettle/liveness_check_result_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb