rack-ecg 0.0.1 → 0.1.0

data/examples/mounted_path.ru

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG, at: "/health_check"
-use Rack::Reloader
+use(Rack::ECG, at: "/health_check")
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/parameters.ru

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'rack/ecg'
+require 'sequel'
+require 'sqlite3'
+
+use(Rack::ECG, checks: [
+  :http,
+  [:sequel, { connection: 'sqlite://events.db', name: 'events' }],
+  [:sequel, { connection: 'sqlite://projections.db', name: 'projections' }],
+])
+
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/stand_alone.ru

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'rack/ecg'
+
+run(Rack::ECG.new)

data/lib/rack-ecg.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'rack/ecg'

data/lib/rack/ecg.rb

@@ -1,80 +1,62 @@
+# frozen_string_literal: true
 require "rack/ecg/version"
 require "json"
 require "open3"
+require "rack/ecg/check_factory"
 
 module Rack
   class ECG
+    # Default mount path.
     DEFAULT_MOUNT_AT = "/_ecg"
-    DEFAULT_CHECKS = [ :check_http ]
-
-    def initialize(app, options={})
+    # Checks enabled by default.
+    DEFAULT_CHECKS = [:http]
+
+    # Constructs an instance of ECG Rack middleware with the specified
+    # options.
+    #
+    # @param app [Object,nil] Underlying Rack application to receive unmatched
+    #   requests. If unset, any unmatched requests will return a 404.
+    # @param checks [Array<Symbol, Array<Symbol, Object>>] Sets and
+    #   configures the checks run by this instance.
+    # @param at [String, nil] Path which this ECG instance handles.
+    # @param hook [#call, nil] Callable which receives the success status and
+    #   check results
+    def initialize(app = nil, checks: DEFAULT_CHECKS, at: DEFAULT_MOUNT_AT, hook: nil)
       @app = app
-      option_checks = options.delete(:checks) || []
-      option_checks = option_checks.map{|check| "check_#{check}".to_sym }
-      @checks = DEFAULT_CHECKS + option_checks
-      @at = options.delete(:at) || DEFAULT_MOUNT_AT
+
+      check_configuration = checks || []
+      @check_factory = CheckFactory.new(check_configuration, DEFAULT_CHECKS)
+      @mount_at = at || DEFAULT_MOUNT_AT
+
+      @result_hook = hook
     end
 
+    # Rack compatible call method. Not intended for direct usage.
     def call(env)
-      if env["PATH_INFO"] == @at
+      if env["PATH_INFO"] == @mount_at
+        check_results = @check_factory.build_all.inject({}) do |results, check|
+          results.merge(check.result.as_json)
+        end
+
+        success = check_results.none? { |check| check[1][:status] == Check::Status::ERROR }
 
-        check_results = @checks.inject({}){|results, check_method| results.merge(send(check_method)) }
+        response_status = success ? 200 : 500
 
-        response_status = check_results.any?{|check| check[1][:status] == "error" } ? 500 : 200
+        @result_hook&.call(success, check_results)
 
         response_headers = {
-          "X-Rack-ECG-Version"  => Rack::ECG::VERSION,
-          "Content-Type"        => "application/json"
+          "X-Rack-ECG-Version" => Rack::ECG::VERSION,
+          "Content-Type" => "application/json",
         }
 
         response_body = JSON.pretty_generate(check_results)
 
         [response_status, response_headers, [response_body]]
-      else
+      elsif @app
         @app.call(env)
+      else
+        [404, {}, []]
       end
     end
-
-    private
-    def check_http
-      # if rack-ecg is serving a request - http is obviously working so far...
-      # this is basically a "hello-world"
-      {http: {status: "ok", value: "online" } }
-    end
-
-    def check_error
-      # this always fails. mainly for testing
-      {error: {status: "error", value: "PC LOAD LETTER" } }
-    end
-
-    def check_git_revision
-      _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
-
-      success = wait_thread.value.success?
-      status = success ? "ok" : "error"
-      value = success ? stdout.read : stderr.read
-      value = value.strip
-      {git_revision: {status: status, value: value} }
-    end
-
-    def check_migration_version
-      value = ""
-      status = "ok"
-      begin
-        if defined?(ActiveRecord)
-          connection = ActiveRecord::Base.connection
-          result_set = connection.execute("select max(version) as version from schema_migrations")
-          version = result_set.first
-          value = version["version"]
-        else
-          status = "error"
-          value = "ActiveRecord not found"
-        end
-      rescue => e
-        status = "error"
-        value = e.message
-      end
-      {migration_version: {status: status, value: value} }
-    end
   end
 end

data/lib/rack/ecg/check.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require "rack/ecg/check_registry"
+require "rack/ecg/check/error"
+require "rack/ecg/check/git_revision"
+require "rack/ecg/check/http"
+require "rack/ecg/check/migration_version"
+require "rack/ecg/check/active_record_connection"
+require "rack/ecg/check/redis_connection"
+require "rack/ecg/check/sequel_connection"
+
+module Rack
+  class ECG
+    module Check
+      # Possible recognised check statuses.
+      module Status
+        # Indicates the check was successful.
+        OK = "ok"
+        # Indicates the check errored.
+        ERROR = "error"
+      end
+
+      class Result < Struct.new(:name, :status, :value)
+        # Format the result as a JSON compatible hash.
+        #
+        # @return [Hash<Object, Hash<Symbol, Object>>] Result in a hash format.
+        # @example A HTTP success response
+        #   puts result.as_json
+        #   # {:http=>{:status=>"ok", :value=>"online"}}
+        def as_json
+          { name => { status: status, value: value } }
+        end
+
+        # Return the result as a JSON object.
+        #
+        # @return [String] Result in a JSON object string.
+        # @example A HTTP success response
+        #   puts result.to_json
+        #   # {"http": {"status": "ok", "value": "online"}}
+        def to_json
+          JSON.dump(as_json)
+        end
+      end
+    end
+  end
+end

data/lib/rack/ecg/check/active_record_connection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Checks whether ActiveRecord is currently connected to the default
+      #   database.
+      class ActiveRecordConnection
+        def result
+          value = ""
+          status = Status::OK
+          begin
+            if defined?(ActiveRecord)
+              value = ::ActiveRecord::Base.connection.active?
+              status = value ? Status::OK : Status::ERROR
+            else
+              status = Status::ERROR
+              value = "ActiveRecord not found"
+            end
+          rescue => e
+            status = Status::ERROR
+            value = e.message
+          end
+
+          Result.new(:active_record, status, value.to_s)
+        end
+
+        CheckRegistry.instance.register(:active_record, ActiveRecordConnection)
+      end
+    end
+  end
+end

data/lib/rack/ecg/check/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Always returns a basic error for testing purposes.
+      class Error
+        def result
+          Result.new(:error, Status::ERROR, "PC LOAD LETTER")
+        end
+      end
+
+      CheckRegistry.instance.register(:error, Error)
+    end
+  end
+end

data/lib/rack/ecg/check/git_revision.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Returns the SHA1 of the current commit, as reported by the git
+      #   executable.
+      class GitRevision
+        def result
+          _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
+
+          success = wait_thread.value.success?
+
+          status = success ? Status::OK : Status::ERROR
+
+          value = success ? stdout.read : stderr.read
+          value = value.strip
+
+          Result.new(:git_revision, status, value)
+        end
+      end
+
+      CheckRegistry.instance.register(:git_revision, GitRevision)
+    end
+  end
+end

data/lib/rack/ecg/check/http.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Always returns a success.
+      class Http
+        def result
+          Result.new(:http, Status::OK, "online")
+        end
+      end
+
+      CheckRegistry.instance.register(:http, Http)
+    end
+  end
+end

data/lib/rack/ecg/check/migration_version.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Returns the latest applied ActiveRecord migration in the default
+      #   database.
+      class MigrationVersion
+        def result
+          value = ""
+          status = Status::OK
+          begin
+            if defined?(ActiveRecord)
+              connection = ActiveRecord::Base.connection
+              value = connection.select_value("select max(version) from schema_migrations")
+            else
+              status = Status::ERROR
+              value = "ActiveRecord not found"
+            end
+          rescue => e
+            status = Status::ERROR
+            value = e.message
+          end
+
+          Result.new(:migration_version, status, value)
+        end
+      end
+
+      CheckRegistry.instance.register(:migration_version, MigrationVersion)
+    end
+  end
+end

data/lib/rack/ecg/check/redis_connection.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      # @!method initialize
+      #   Checks whether the global Redis client is currently connected to the
+      #   database.
+      #
+      #   Does not take any options.
+      class RedisConnection
+        def result
+          value = ""
+          status = Status::OK
+          begin
+            if defined?(::Redis)
+              value = ::Redis.current.connected?
+              status = value ? Status::OK : Status::ERROR
+            else
+              status = Status::ERROR
+              value = "Redis not found"
+            end
+          rescue => e
+            status = Status::ERROR
+            value = e.message
+          end
+
+          Result.new(:redis, status, value.to_s)
+        end
+
+        CheckRegistry.instance.register(:redis, RedisConnection)
+      end
+    end
+  end
+end

data/lib/rack/ecg/check/sequel_connection.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+module Rack
+  class ECG
+    module Check
+      class SequelConnection
+        attr_reader :connection_parameters, :name
+
+        # Checks whether Sequel can connect to the database identified by the
+        # ++connection++ option.
+        #
+        # @option parameters connection [String,Hash] Sequel connection parameters to check
+        # @option parameters name [String,nil] Name to distinguish multiple Sequel checks
+        def initialize(parameters = {})
+          @connection_parameters = parameters[:connection]
+          @name = parameters[:name]
+        end
+
+        def result
+          value = ""
+          status = Status::OK
+          begin
+            if connection_parameters.nil?
+              status = Status::ERROR
+              value = "Sequel Connection parameters not found"
+            elsif defined?(::Sequel)
+              ::Sequel.connect(connection_parameters) do |db|
+                value = db.test_connection
+                status = Status::OK
+              end
+            else
+              status = Status::ERROR
+              value = "Sequel not found"
+            end
+          rescue => e
+            status = Status::ERROR
+            value = e.message
+          end
+
+          Result.new(result_key.to_sym, status, value.to_s)
+        end
+
+        def result_key
+          if name
+            "sequel #{name.downcase}".gsub(/\W+/, '_')
+          else
+            "sequel"
+          end
+        end
+
+        CheckRegistry.instance.register(:sequel, SequelConnection)
+      end
+    end
+  end
+end

data/lib/rack/ecg/check_factory.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "rack/ecg/check"
+
+module Rack
+  class ECG
+    class CheckFactory
+      CheckDefinition = Struct.new(:check_class, :parameters)
+
+      def initialize(definitions, default_checks = [])
+        definitions = Array(definitions) | default_checks
+
+        @checks = definitions.map do |check_name, check_parameters|
+          CheckDefinition.new(CheckRegistry.lookup(check_name), check_parameters)
+        end
+      end
+
+      def build_all
+        @checks.map do |check_definition|
+          build(check_definition.check_class, check_definition.parameters)
+        end
+      end
+
+      def build(check_class, parameters = nil)
+        parameters.nil? ? check_class.new : check_class.new(parameters)
+      end
+    end
+  end
+end