app: Convert health checks to use OKComputer

Gemfile

@@ -27,6 +27,7 @@ gem 'lograge', '>=0.11.2'
 gem 'mutex_m'
 gem 'netaddr', '~> 1.5', '>= 1.5.1'
 gem 'net-ssh'
+gem 'okcomputer', '~> 1.19'
 gem 'omniauth', '~> 1.9', '>= 1.9.2'
 gem 'omniauth-cas', '~> 2.0'
 gem 'pg', '~> 1.2'

Gemfile.lock

@@ -74,6 +74,7 @@ GEM
       execjs (~> 2)
     awesome_print (1.9.2)
     base64 (0.3.0)
+    benchmark (0.5.0)
     berkeley_library-alma (0.1.1)
       berkeley_library-logging (~> 0.2)
       berkeley_library-marc (~> 0.3.1)
@@ -258,6 +259,8 @@ GEM
     oj (3.16.11)
       bigdecimal (>= 3.0)
       ostruct (>= 0.2)
+    okcomputer (1.19.1)
+      benchmark
     omniauth (1.9.2)
       hashie (>= 3.4.6)
       rack (>= 1.6.2, < 3)
@@ -500,6 +503,7 @@ DEPENDENCIES
   mutex_m
   net-ssh
   netaddr (~> 1.5, >= 1.5.1)
+  okcomputer (~> 1.19)
   omniauth (~> 1.9, >= 1.9.2)
   omniauth-cas (~> 2.0)
   pg (~> 1.2)

app/controllers/home_controller.rb

@@ -3,14 +3,6 @@
 # We'll likely be asked to remove this at some point, but for now it's useful
 # to have in development.
 class HomeController < ApplicationController
-
-  # TODO: Move this to a HealthController that extends ActionController::API
-  #       - note: may involve extracting some of ApplicationController into a mixin
-  def health
-    check = Health::Check.new
-    render json: check, status: check.http_status_code
-  end
-
   def admin
     render :admin if require_framework_admin!
   end

config/initializers/okcomputer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Health check configuration
+
+OkComputer.logger = Rails.logger
+OkComputer.check_in_parallel = true
+
+class AlmaPatronCheck < OkComputer::Check
+  TEST_PATRON_ID = '000311@lbl.gov'
+
+  def check
+    Alma::User.find(TEST_PATRON_ID)
+    mark_message 'Success'
+  rescue StandardError => e
+    mark_failure
+    Rails.logger.warn "Couldn't connect to Alma API during health check: #{e}"
+    mark_message 'Failed'
+  end
+end
+
+# Ensure Alma API is working.
+OkComputer::Registry.register 'alma-patron-lookup', AlmaPatronCheck.new
+
+# Ensure database migrations have been run.
+OkComputer::Registry.register 'database-migrations', OkComputer::ActiveRecordMigrationsCheck.new
+
+# Ensure connectivity to the mail system.
+OkComputer::Registry.register 'action-mailer', OkComputer::ActionMailerCheck.new

config/routes.rb

@@ -2,7 +2,7 @@
   root to: redirect('/forms/altmedia/new')
 
   get 'admin', to: 'home#admin'
-  get 'health', to: 'home#health'
+  get 'health', to: 'ok_computer/ok_computer#index', defaults: { format: :json }
   get 'home', to: 'home#index'
   get 'build_info', to: 'home#build_info'
 

spec/request/home_request_spec.rb

@@ -1,41 +1,6 @@
 require 'calnet_helper'
 
 describe HomeController, type: :request do
-  describe :health do
-    it 'returns OK for a successful patron lookup' do
-      patron = Alma::User.new
-
-      expect(Alma::User).to receive(:find).with(Health::Check::TEST_PATRON_ID).and_return(patron)
-      get health_path
-      expect(response).to have_http_status(:ok)
-      expected_body = {
-        'status' => 'pass',
-        'details' => {
-          'patron_api:find' => {
-            'status' => 'pass'
-          }
-        }
-      }
-      expect(JSON.parse(response.body)).to eq(expected_body)
-    end
-
-    it 'returns 429 Too Many Requests for a failure' do
-      expect(Alma::User).to receive(:find).and_raise('Something went wrong')
-      get health_path
-      expect(response).to have_http_status(:too_many_requests)
-      expected_body = {
-        'status' => 'warn',
-        'details' => {
-          'patron_api:find' => {
-            'status' => 'warn',
-            'output' => 'RuntimeError'
-          }
-        }
-      }
-      expect(JSON.parse(response.body)).to eq(expected_body)
-    end
-  end
-
   RSpec.shared_examples 'allow admin' do |page:|
 
     before do

spec/request/okcomputer_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+
+RSpec.describe 'OKComputer', type: :request do
+  before { allow(Alma::User).to receive(:find).and_return(Alma::User.new) }
+
+  it 'is mounted at /okcomputer' do
+    get '/okcomputer'
+    expect(response).to have_http_status :ok
+  end
+
+  it 'returns all checks to /health' do
+    get '/health'
+    expect(response.parsed_body.keys).to match_array %w[
+      action-mailer
+      alma-patron-lookup
+      default
+      database
+      database-migrations
+    ]
+    pending 'https://github.com/emmahsax/okcomputer/pull/21'
+    expect(response).to have_http_status :ok
+  end
+
+  it 'fails when Alma lookups fail' do
+    expect(Alma::User).to receive(:find).and_raise('Uh oh!')
+    get '/health'
+    expect(response).not_to have_http_status :ok
+  end
+end

spec/system/home_system_spec.rb

@@ -3,14 +3,6 @@
 require 'support/build_info_context'
 
 describe :home, type: :system do
-  describe :health do
-    it 'does something sensible for a general error' do
-      expect(Health::Check).to receive(:new).and_raise('Something went wrong')
-      visit health_path
-      expect(page).to have_content('Internal Server Error')
-    end
-  end
-
   describe :admin do
     context 'without login' do
       it 'redirects to login' do