aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorGareth Rees <gareth@mysociety.org>2014-09-17 13:08:05 +0100
committerGareth Rees <gareth@mysociety.org>2014-09-25 12:57:55 +0100
commit66356f84ff478cc785bc1fb1d976a8f661ca79ab (patch)
treed65e5d108a7be9ed18940ede7fc554e32b395b7d /lib
parent1abc8026afed626676ce4ca156f93962b93aab3f (diff)
Add HealthCheck and HealthCheckable
HealthCheck is a basic library for creating health checks. HealthCheck works with any class so long as it includes HealthCheckable and defines the `check` method.
Diffstat (limited to 'lib')
-rw-r--r--lib/health_checks/health_checkable.rb28
-rw-r--r--lib/health_checks/health_checks.rb37
2 files changed, 65 insertions, 0 deletions
diff --git a/lib/health_checks/health_checkable.rb b/lib/health_checks/health_checkable.rb
new file mode 100644
index 000000000..5d674ca32
--- /dev/null
+++ b/lib/health_checks/health_checkable.rb
@@ -0,0 +1,28 @@
+module HealthChecks
+ module HealthCheckable
+
+ attr_accessor :failure_message, :success_message
+
+ def initialize(args = {})
+ self.failure_message = args.fetch(:failure_message) { _('Failed') }
+ self.success_message = args.fetch(:success_message) { _('Success') }
+ end
+
+ def name
+ self.class.to_s
+ end
+
+ def check
+ raise NotImplementedError
+ end
+
+ def ok?
+ check ? true : false
+ end
+
+ def message
+ ok? ? success_message : failure_message
+ end
+
+ end
+end
diff --git a/lib/health_checks/health_checks.rb b/lib/health_checks/health_checks.rb
new file mode 100644
index 000000000..6f0c9de8e
--- /dev/null
+++ b/lib/health_checks/health_checks.rb
@@ -0,0 +1,37 @@
+require 'health_checkable'
+
+Dir[File.dirname(__FILE__) + '/checks/*.rb'].each do |file|
+ require file
+end
+
+module HealthChecks
+ extend self
+
+ def all
+ @checks ||= []
+ end
+
+ def add(check)
+ if assert_valid_check(check)
+ all << check
+ check
+ else
+ false
+ end
+ end
+
+ def each(&block)
+ all.each(&block)
+ end
+
+ def ok?
+ all.all? { |check| check.ok? }
+ end
+
+ private
+
+ def assert_valid_check(check)
+ check.respond_to?(:check)
+ end
+
+end