Merge pull request #575 from Crown-Commercial-Service/add-healthcheck…

…-endpoint

Add the healthcheck endpoint

app/controllers/health_check_controller.rb

@@ -0,0 +1,5 @@
+class HealthCheckController < ApplicationController
+  def index
+    render json: { status: 'ok' }
+  end
+end

config/environments/production.rb

@@ -37,6 +37,12 @@
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   config.force_ssl = true
 
+  config.ssl_options = {
+    redirect: {
+      exclude: ->(request) { request.path.include?('health_check') }
+    }
+  }
+
   # Log to STDOUT by default
   config.logger = ActiveSupport::Logger.new(STDOUT)
     .tap  { |logger| logger.formatter = ::Logger::Formatter.new }
@@ -84,4 +90,8 @@
   ENV.fetch('ALLOWED_HOST_DOMAINS', '').split(',').each do |application_domain|
     config.hosts << application_domain
   end
+
+  config.host_authorization = {
+    exclude: ->(request) { request.path.include?('health_check') }
+  }
 end

config/routes.rb

@@ -6,6 +6,7 @@
   get '/cookie-settings', to: 'home#cookie_settings'
   get '/cookie-settings/update', to: 'home#update_cookie_settings'
   get '/cookie-policy', to: 'home#cookie_policy'
+  get '/health_check', to: 'health_check#index'
 
   # API endpoints here
   namespace :api do

spec/controllers/health_check_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+RSpec.describe HealthCheckController do
+  describe 'GET #index' do
+    it 'returns a JSON response with status ok' do
+      get :index
+
+      expect(response).to have_http_status(:success)
+      expect(response.content_type).to eq('application/json; charset=utf-8')
+
+      json_response = response.parsed_body
+      expect(json_response).to eq({ 'status' => 'ok' })
+    end
+  end
+end