wellness 1.0.2 → 2.0.0

data/lib/wellness/simple_report.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module Wellness
+  class SimpleReport
+    STATUSES = {
+      'HEALTHY' => 200,
+      'DEGRADED' => 200,
+      'UNHEALTHY' => 500
+    }
+
+    def initialize(system)
+      @system = system
+    end
+
+    def call
+      non_criticals = []
+      criticals = []
+
+      @system.services.each do |name, service|
+        result = service.call['status']
+
+        if service.critical?
+          criticals << result
+        else
+          non_criticals << result
+        end
+      end
+
+      healthy = criticals.all? { |s| s == 'HEALTHY' }
+      degraded = non_criticals.any? { |s| s == 'UNHEALTHY' }
+
+      if healthy
+        if degraded
+          status = 'DEGRADED'
+        else
+          status = 'HEALTHY'
+        end
+      else
+        status = 'UNHEALTHY'
+      end
+
+      render({json: { 'status' => status }, status: STATUSES[status]})
+    end
+
+    # Behaves similar to Rail's controller render method
+    def render(options={})
+      status   = options[:status]  || 200
+      response = JSON.dump(options[:json])
+
+      [status, { 'Content-Type' => 'application/json' }, [response]]
+    end
+  end
+end

data/lib/wellness/system.rb

@@ -1,52 +1,23 @@
-require 'wellness/services/base'
-require 'wellness/report'
+require 'wellness/service'
 
 module Wellness
   # @author Matthew A. Johnston (warmwaffles)
   class System
-    attr_reader :name
+    attr_reader :name, :services, :details
 
     # @param name [String] the name of the system
     def initialize(name)
-      @name = name
-      @services = []
-      @details = []
-      @mutex = Mutex.new
+      @name     = name
+      @services = {}
+      @details  = {}
     end
 
-    def use(klass, *args)
-      @mutex.synchronize do
-        factory = Factory.new(klass, *args)
-        if klass <= Wellness::Services::Base
-          @services << factory
-        else
-          @details << factory
-        end
-      end
+    def add_service(name, service, options={})
+      @services[name] = Wellness::Service.new(service, options)
     end
 
-    def detailed_check
-      report = build_report
-      [report.status_code, { 'Content-Type' => 'application/json' }, [report.detailed.to_json]]
-    end
-
-    def simple_check
-      report = build_report
-      [report.status_code, { 'Content-Type' => 'application/json' }, [report.simple.to_json]]
-    end
-
-    def build_report
-      @mutex.synchronize do
-        Wellness::Report.new(services.map(&:call), details.map(&:call))
-      end
-    end
-
-    def services
-      @services.map(&:build)
-    end
-
-    def details
-      @details.map(&:build)
+    def add_detail(name, detail)
+      @details[name] = detail
     end
   end
 end

data/lib/wellness/version.rb

@@ -1,3 +1,3 @@
 module Wellness
-  VERSION = '1.0.2'
-end
+  VERSION = '2.0.0'
+end

data/lib/wellness.rb

@@ -4,9 +4,10 @@ module Wellness
 end
 
 require 'wellness/version'
-require 'wellness/services'
+require 'wellness/detail'
+require 'wellness/detailed_report'
 require 'wellness/middleware'
+require 'wellness/service'
+require 'wellness/services/base'
+require 'wellness/simple_report'
 require 'wellness/system'
-require 'wellness/detail'
-require 'wellness/report'
-require 'wellness/factory'

data/spec/spec_helper.rb

@@ -1,10 +1,7 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter('/spec')
-  add_group('Services', 'wellness/services')
-end
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
 
-require 'rspec'
 require 'wellness'
 
-Dir[Dir.pwd.concat('/spec/support/**/*.rb')].each { |f| require f }
+Dir.glob('./support/**/*.rb') { |f| require f }

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+
+Bundler.require
+
+Dir.glob('./support/**/*.rb') { |f| require f }

data/test/wellness/detail_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+require 'wellness/detail'
+
+module Wellness
+  class DetailTest < Minitest::Unit::TestCase
+    def setup
+      @options = {
+        a: 'foo'
+      }
+      @detail = Detail.new(@options)
+    end
+
+    def test_initialize
+      assert_equal(@options, @detail.options)
+    end
+
+    def test_check
+      assert_equal({}, @detail.check)
+    end
+
+    def test_call
+      assert_equal({}, @detail.call)
+    end
+  end
+end

data/test/wellness/detailed_report_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+require 'wellness/system'
+require 'wellness/detailed_report'
+
+module Wellness
+  class DetailedReportTest < Minitest::Unit::TestCase
+    def build_report(system)
+      Wellness::DetailedReport.new(system)
+    end
+
+    def test_call
+      system = Wellness::System.new('Healthy System')
+      system = System.new('Test System')
+      system.add_service('foo', healthy, { critical: true })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(200, status)
+      assert_equal('HEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Unhealthy System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: true })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('UNHEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Degraded System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: false })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('DEGRADED', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Unhealthy System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: true })
+      system.add_service('bar', unhealthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('UNHEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Degraded System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: false })
+      system.add_service('bar', unhealthy, { critical: false })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('DEGRADED', content['status'])
+    end
+
+    def unhealthy
+      Proc.new do
+        {
+          'status' => 'UNHEALTHY',
+          'details' => {
+            'something' => 1
+          }
+        }
+      end
+    end
+
+    def healthy
+      Proc.new do
+        {
+          'status' => 'HEALTHY',
+          'details' => {
+            'something' => 0
+          }
+        }
+      end
+    end
+
+    def some_detail
+      Proc.new do
+        {
+          'foo' => 1,
+          'bar' => 0
+        }
+      end
+    end
+  end
+end

data/test/wellness/simple_report_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+require 'wellness/system'
+require 'wellness/simple_report'
+
+module Wellness
+  class SimpleReportTest < Minitest::Unit::TestCase
+    def build_report(system)
+      Wellness::SimpleReport.new(system)
+    end
+
+    def test_call
+      system = Wellness::System.new('Healthy System')
+      system = System.new('Test System')
+      system.add_service('foo', healthy, { critical: true })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(200, status)
+      assert_equal('HEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Unhealthy System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: true })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('UNHEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Degraded System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: false })
+      system.add_service('bar', healthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(200, status)
+      assert_equal('DEGRADED', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Unhealthy System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: true })
+      system.add_service('bar', unhealthy, { critical: true })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(500, status)
+      assert_equal('UNHEALTHY', content['status'])
+
+      # ###################################################
+
+      system = Wellness::System.new('Degraded System')
+      system = System.new('Test System')
+      system.add_service('foo', unhealthy, { critical: false })
+      system.add_service('bar', unhealthy, { critical: false })
+      system.add_detail('something', some_detail)
+
+      result = build_report(system).call
+
+      status  = result[0]
+      headers = result[1]
+      content = JSON.parse(result[2].last)
+
+      assert_equal(200, status)
+      assert_equal('DEGRADED', content['status'])
+    end
+
+    def unhealthy
+      Proc.new do
+        {
+          'status' => 'UNHEALTHY',
+          'details' => {
+            'something' => 1
+          }
+        }
+      end
+    end
+
+    def healthy
+      Proc.new do
+        {
+          'status' => 'HEALTHY',
+          'details' => {
+            'something' => 0
+          }
+        }
+      end
+    end
+
+    def some_detail
+      Proc.new do
+        {
+          'foo' => 1,
+          'bar' => 0
+        }
+      end
+    end
+  end
+end

data/test/wellness/system_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+require 'wellness/system'
+
+module Wellness
+  class SystemTest < Minitest::Unit::TestCase
+    def test_add_service
+      system = System.new('Test System')
+      service = Proc.new do
+        raise(RuntimeError, 'called when it should not be')
+      end
+      system.add_service('test', service)
+    end
+
+    def test_add_detail
+      system = System.new('Test System')
+      detail = Proc.new do
+        raise(RuntimeError, 'called when it should not be')
+      end
+      system.add_detail('test', detail)
+    end
+
+    def unhealthy
+      Proc.new do
+        {
+          'status' => 'UNHEALTHY',
+          'details' => {
+            'something' => 1
+          }
+        }
+      end
+    end
+
+    def healthy
+      Proc.new do
+        {
+          'status' => 'HEALTHY',
+          'details' => {
+            'something' => 0
+          }
+        }
+      end
+    end
+
+    def some_detail
+      Proc.new do
+        {
+          'foo' => 1,
+          'bar' => 0
+        }
+      end
+    end
+  end
+end

data/wellness.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency('bundler', '~> 1.3')
   spec.add_development_dependency('rake')
-  spec.add_development_dependency('rspec')
-  spec.add_development_dependency('simplecov')
 
   # service dependencies
   spec.add_development_dependency('pg')