Add healthcheck endpoint (#740)

Add healthcheck endpoint

Author: Alan Gabbianelli

.rspec

@@ -1 +1,3 @@
---require spec_helper
+--colour
+--format=d
+--require rails_helper

Gemfile

@@ -8,6 +8,7 @@ gem 'elasticsearch', '~> 5.0.4'
 gem 'elasticsearch-model', '~> 5.0.1'
 gem 'elasticsearch-rails', '~> 5.0.1'
 gem 'gds-sso'
+gem 'govuk_app_config', '~> 1.16.1'
 gem 'govuk_elements_rails'
 gem 'govuk_sidekiq', '~> 3.0'
 gem 'govuk_template'

Gemfile.lock

@@ -45,6 +45,8 @@ GEM
     ast (2.4.0)
     audited (4.5.0)
       activerecord (>= 4.0, < 5.2)
+    aws-xray-sdk (0.10.2)
+      oj (~> 3.0)
     binding_of_caller (0.7.2)
       debug_inspector (>= 0.0.1)
     brakeman (4.2.1)
@@ -98,7 +100,7 @@ GEM
     factory_bot_rails (4.11.1)
       factory_bot (~> 4.11.1)
       railties (>= 3.0.0)
-    faraday (0.12.1)
+    faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.23)
     fugit (1.1.1)
@@ -126,7 +128,8 @@ GEM
       rubocop (~> 0.64)
       rubocop-rspec (~> 1.28)
       scss_lint
-    govuk_app_config (1.3.2)
+    govuk_app_config (1.16.1)
+      aws-xray-sdk (~> 0.10.0)
       logstasher (~> 1.2.2)
       sentry-raven (~> 2.7.1)
       statsd-ruby (~> 1.4.0)
@@ -208,7 +211,7 @@ GEM
     minitest (5.11.3)
     multi_json (1.12.1)
     multi_xml (0.6.0)
-    multipart-post (2.0.0)
+    multipart-post (2.1.0)
     netrc (0.11.0)
     nio4r (2.3.1)
     nokogiri (1.10.1)
@@ -220,6 +223,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    oj (3.7.12)
     omniauth (1.8.1)
       hashie (>= 3.4.6, < 3.6.0)
       rack (>= 1.6.2, < 3)
@@ -289,7 +293,8 @@ GEM
     redis (4.0.1)
     redis-namespace (1.6.0)
       redis (>= 3.0.4)
-    request_store (1.3.2)
+    request_store (1.4.1)
+      rack (>= 1.4)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
@@ -345,7 +350,7 @@ GEM
     scss_lint (0.57.1)
       rake (>= 0.9, < 13)
       sass (~> 3.5, >= 3.5.5)
-    sentry-raven (2.7.1)
+    sentry-raven (2.7.4)
       faraday (>= 0.7.6, < 1.0)
     sidekiq (5.1.1)
       concurrent-ruby (~> 1.0)
@@ -400,7 +405,7 @@ GEM
       unf_ext
     unf_ext (0.0.7.5)
     unicode-display_width (1.5.0)
-    unicorn (5.4.0)
+    unicorn (5.4.1)
       kgio (~> 2.6)
       raindrops (~> 0.7)
     warden (1.2.7)
@@ -439,6 +444,7 @@ DEPENDENCIES
   factory_bot_rails (~> 4.0)
   gds-sso
   govuk-lint (~> 3.11)
+  govuk_app_config (~> 1.16.1)
   govuk_elements_rails
   govuk_sidekiq (~> 3.0)
   govuk_template

app/models/healthcheck/recurring_jobs/package_sync.rb

@@ -0,0 +1,51 @@
+module Healthcheck
+  module RecurringJobs
+    class PackageSync
+      include ActionView::Helpers::DateHelper
+
+      JOB_NAME = 'ckan_v26_package_sync'.freeze
+      JOB_FREQUENCY = 10.minutes
+      WARNING_DELAY = 2.minutes
+      CRITICAL_DELAY = 1.hour
+
+      def name
+        :package_sync
+      end
+
+      def status
+        if Time.parse(when_last_run) <= critical_latency
+          :critical
+        elsif Time.parse(when_last_run) <= warning_latency
+          :warning
+        else
+          :ok
+        end
+      end
+
+      def details
+        {
+          critical: when_last_run,
+          warning: when_last_run
+        }
+      end
+
+      def message
+        "The job '#{JOB_NAME}' should run every #{distance_of_time_in_words(JOB_FREQUENCY)}. It was last run #{when_last_run}."
+      end
+
+    private
+
+      def when_last_run
+        SidekiqScheduler::RedisManager.get_job_last_time(JOB_NAME)
+      end
+
+      def critical_latency
+        (JOB_FREQUENCY + CRITICAL_DELAY).ago
+      end
+
+      def warning_latency
+        (JOB_FREQUENCY + WARNING_DELAY).ago
+      end
+    end
+  end
+end

config/routes.rb

@@ -67,4 +67,8 @@
   get 'manage/organisation', to: 'manage#manage_organisation'
 
   resource :session, only: %i[new create]
+
+  get "/healthcheck", to: GovukHealthcheck.rack_response(
+    Healthcheck::RecurringJobs::PackageSync.new
+  )
 end

spec/factories/ckan_v26_ckan_org.rb

@@ -1,15 +1,15 @@
 FactoryBot.define do
   factory :ckan_v26_ckan_org, class: CKAN::V26::CKANOrg do
-    id SecureRandom.uuid
-    name "Name"
-    category "Category"
-    title "Title"
+    id { SecureRandom.uuid }
+    name { "Name" }
+    category { "Category" }
+    title { "Title" }
 
-    add_attribute("contact-name", "Mr. Contact")
-    add_attribute("contact-email", "[email protected]")
-    add_attribute("foi-name", "Mr. FOI")
-    add_attribute("foi-email", "[email protected]")
-    add_attribute("foi-web", "http://foi.com")
+    add_attribute("contact-name") { "Mr. Contact" }
+    add_attribute("contact-email") { "[email protected]" }
+    add_attribute("foi-name") { "Mr. FOI" }
+    add_attribute("foi-email") { "[email protected]" }
+    add_attribute("foi-web") { "http://foi.com" }
 
     initialize_with do
       CKAN::V26::CKANOrg.new(attributes.stringify_keys)

spec/factories/ckan_v26_package.rb

@@ -1,51 +1,53 @@
 FactoryBot.define do
   factory :ckan_v26_package, class: CKAN::V26::Package do
-    name "Name"
-    title "Title"
-    notes "Notes"
-    metadata_created "2015-10-06T11:21:26.185852"
-    metadata_updated "2018-06-05T12:40:12.239474"
-    license_id "uk-ogl"
-    geographic_coverage %w[england scotland wales]
-    owner_org SecureRandom.uuid
+    name { "Name" }
+    title { "Title" }
+    notes { "Notes" }
+    metadata_created { "2015-10-06T11:21:26.185852" }
+    metadata_updated { "2018-06-05T12:40:12.239474" }
+    license_id { "uk-ogl" }
+    geographic_coverage { %w[england scotland wales] }
+    owner_org { SecureRandom.uuid }
 
-    add_attribute("theme-primary", "Environment & Fisheries")
-    add_attribute("contact-name", "Mr. Contact")
-    add_attribute("contact-email", "[email protected]")
-    add_attribute("foi-name", "Mr. FOI")
-    add_attribute("foi-email", "[email protected]")
-    add_attribute("foi-web", "http://foi.com")
-    add_attribute("schema", [{
-      "url" => "https://github.com/datagovuk/schemas/tree/master/organogram",
-      "id" => "d3c0b23f-6979-45e4-88ed-d2ab59b005d0",
-      "title" => "Organisation structure including senior roles & salaries (org chart / organogram for central government departments and agencies)",
-    }])
+    add_attribute("theme-primary") { "Environment & Fisheries" }
+    add_attribute("contact-name") { "Mr. Contact" }
+    add_attribute("contact-email") { "[email protected]" }
+    add_attribute("foi-name") { "Mr. FOI" }
+    add_attribute("foi-email") { "[email protected]" }
+    add_attribute("foi-web") { "http://foi.com" }
+    add_attribute("schema") do
+      [{
+        "url" => "https://github.com/datagovuk/schemas/tree/master/organogram",
+        "id" => "d3c0b23f-6979-45e4-88ed-d2ab59b005d0",
+        "title" => "Organisation structure including senior roles & salaries (org chart / organogram for central government departments and agencies)",
+      }]
+    end
 
     extras do
       [{ "licence" => "Open Government Licence 3.0 (United Kingdom)" }]
     end
 
     trait :inspire do
-      add_attribute("access_constraints", "[\"There are no public access constraints to this data. Use of this data is subject to the licence identified.\"]")
-      add_attribute("bbox-east-long", "2.072")
-      add_attribute("bbox-north-lat", "55.816")
-      add_attribute("bbox-south-lat", "49.943")
-      add_attribute("bbox-west-long", "-6.236")
-      add_attribute("coupled-resource", "[]")
-      add_attribute("dataset-reference-date", "[{\"type\": \"creation\", \"value\": \"2004-01-01\"}, {\"type\": \"revision\", \"value\": \"2018-04-30\"}]")
-      add_attribute("frequency-of-update", "quarterly")
-      add_attribute("harvest_object_id", SecureRandom.uuid)
-      add_attribute("harvest_source_reference", SecureRandom.uuid)
-      add_attribute("import_source", "harvest")
-      add_attribute("metadata-date", "2018-06-05")
-      add_attribute("metadata-language", "eng")
-      add_attribute("provider", "")
-      add_attribute("resource-type", "dataset")
-      add_attribute("responsible-party", "Environment Agency (pointOfContact)")
-      add_attribute("spatial", "{\"type\":\"Polygon\",\"coordinates\":[[[2.072, 49.943],[2.072, 55.816], [-6.236, 55.816], [-6.236, 49.943], [2.072, 49.943]]]}")
-      add_attribute("spatial-data-service-type", "")
-      add_attribute("spatial-reference-system", "http://www.opengis.net/def/crs/EPSG/0/27700")
-      add_attribute("guid", SecureRandom.uuid)
+      add_attribute("access_constraints") { "[\"There are no public access constraints to this data. Use of this data is subject to the licence identified.\"]" }
+      add_attribute("bbox-east-long") { "2.072" }
+      add_attribute("bbox-north-lat") { "55.816" }
+      add_attribute("bbox-south-lat") { "49.943" }
+      add_attribute("bbox-west-long") { "-6.236" }
+      add_attribute("coupled-resource") { "[]" }
+      add_attribute("dataset-reference-date") { "[{\"type\": \"creation\", \"value\": \"2004-01-01\"}, {\"type\": \"revision\", \"value\": \"2018-04-30\"}]" }
+      add_attribute("frequency-of-update") { "quarterly" }
+      add_attribute("harvest_object_id") { SecureRandom.uuid }
+      add_attribute("harvest_source_reference") { SecureRandom.uuid }
+      add_attribute("import_source") { "harvest" }
+      add_attribute("metadata-date") { "2018-06-05" }
+      add_attribute("metadata-language") { "eng" }
+      add_attribute("provider") { "" }
+      add_attribute("resource-type") { "dataset" }
+      add_attribute("responsible-party") { "Environment Agency (pointOfContact)" }
+      add_attribute("spatial") { "{\"type\":\"Polygon\",\"coordinates\":[[[2.072, 49.943],[2.072, 55.816], [-6.236, 55.816], [-6.236, 49.943], [2.072, 49.943]]]}" }
+      add_attribute("spatial-data-service-type") { "" }
+      add_attribute("spatial-reference-system") { "http://www.opengis.net/def/crs/EPSG/0/27700" }
+      add_attribute("guid") { SecureRandom.uuid }
     end
 
     trait :harvested do

spec/factories/ckan_v26_resource.rb

@@ -1,11 +1,11 @@
 FactoryBot.define do
   factory :ckan_v26_resource, class: CKAN::V26::Resource do
-    url "http://environment.data.gov.uk/ds/wms?SERVICE=WMS&INTERFACE=ENVIRONMENT--86ec354f-d465-11e4-b09e-f0def148f590&request=GetCapabilities"
-    format "WMS"
-    name "Resource locator"
-    description "Resource locator"
-    created "2016-04-05T09:48:43.164470"
-    resource_type "file"
+    url { "http://environment.data.gov.uk/ds/wms?SERVICE=WMS&INTERFACE=ENVIRONMENT--86ec354f-d465-11e4-b09e-f0def148f590&request=GetCapabilities" }
+    format { "WMS" }
+    name { "Resource locator" }
+    description { "Resource locator" }
+    created { "2016-04-05T09:48:43.164470" }
+    resource_type { "file" }
 
     initialize_with do
       CKAN::V26::Resource.new(attributes.stringify_keys)

spec/factories/datafile.rb

@@ -1,11 +1,11 @@
 FactoryBot.define do
   factory :datafile do
     dataset
-    url 'http://google.com'
-    name 'My Datafile'
-    format 'CSV'
-    start_date 1.month.ago
-    end_date 1.week.ago
-    type 'Datafile'
+    url { 'http://google.com' }
+    name { 'My Datafile' }
+    format { 'CSV' }
+    start_date { 1.month.ago }
+    end_date { 1.week.ago }
+    type { 'Datafile' }
   end
 end

spec/factories/dataset.rb

@@ -1,14 +1,14 @@
 FactoryBot.define do
   factory :dataset do
     organisation
-    title "Price paid for dragon glass"
-    summary "All transactions for dragon glass"
-    legacy_name "ye-olde-slug"
-    location1 "Westeros"
-    frequency "never"
-    licence_code "uk-ogl"
+    title { "Price paid for dragon glass" }
+    summary { "All transactions for dragon glass" }
+    legacy_name { "ye-olde-slug" }
+    location1 { "Westeros" }
+    frequency { "never" }
+    licence_code { "uk-ogl" }
     topic
-    status "published"
+    status { "published" }
 
     after(:create) do |dataset, _|
       dataset.publish if dataset.published? # Make sure it's in Elasticsearch

spec/factories/doc.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :doc do
     dataset
-    url 'http://google.com'
-    name 'My Doc'
+    url { 'http://google.com' }
+    name { 'My Doc' }
   end
 end

spec/factories/link.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :link do
     dataset
-    url 'http://google.com'
-    name 'My link'
+    url { 'http://google.com' }
+    name { 'My link' }
   end
 end

spec/factories/organisation.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :organisation do
-    name "land-registry"
-    title "Land Registry"
+    name { "land-registry" }
+    title { "Land Registry" }
     govuk_content_id { SecureRandom.uuid }
   end
 end

spec/factories/topic.rb

@@ -1,6 +1,6 @@
 FactoryBot.define do
   factory :topic do
-    name "business-and-economy"
-    title "Business and Economy"
+    name { "business-and-economy" }
+    title { "Business and Economy" }
   end
 end

spec/factories/user.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :user do
-    email '[email protected]'
-    name 'Test User'
+    email { '[email protected]' }
+    name { 'Test User' }
     organisation_content_id { SecureRandom.uuid }
   end
 end