qa_server 7.5.1 → 7.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c0138684332f934add8000e85d76c86264162963e7df49fa170ee894783aa17
-  data.tar.gz: 2f9e19975f53fa4e0d34feb8e4423f203e0d46bafe6bc30af614459256a6b66f
+  metadata.gz: 98c71b17c28452d0503ee1afd8ee920dbaa12332e578890d02527a402ce1a793
+  data.tar.gz: b569538f771243239ff2fe85428fbe11b9dd948947aa90e598a12c513aa2e4e2
 SHA512:
-  metadata.gz: bd9de3a942001f3e6eca2790441fa2ea2f8d386033c4af93cca230ac2ee3dbb357d44378535bdf521a89e196d29b6fd7308b1f1a6246ece9c1293c6c521deb7d
-  data.tar.gz: 933c7742a774144186e9a63f749a2b4d01c89c76b7849d8c18419e0ea95d0df28158ce5286ca694d516fa994f14796c8f668708e907ca2c037e880b101afc5e9
+  metadata.gz: 96ae15dfd8d90bab80600eea28865a6749347bd084df9771b0864e5d58c803bfb7dc23bff8025f4939ca78c5dfbbfa452a0a8f7fe028acb3c85ee7c3374d78ee
+  data.tar.gz: 04f668c250e1f95188ad2a0553b2ab8a09f33415e4a9028024e4ce97407aa1af041be643dbb6f7b603e61887df8f3b0d7b3b80d7a41c0c194aaa579cb07cd03d

data/.rubocop_fixme.yml

@@ -16,5 +16,6 @@ Style/SpecialGlobalVars:
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-#Layout/IndentationWidth:
-#  Enabled: false
+Layout/HashAlignment:
+  Exclude:
+    - 'spec/presenters/qa_server/monitor_status/history_presenter_spec.rb'

data/.travis.yml

@@ -26,7 +26,7 @@ env:
   # It should be sufficient to test only the latest of the patch versions for a minor version, they
   # should be compatible across patch versions (only bug fixes are released in patch versions).
   matrix:
-    - "RAILS_VERSION=5.2.4"
+    - "RAILS_VERSION=5.2.5"
 
 services:
   - redis-server

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+### 7.9.0 (2021-04-16)
+
+* Add chart showing simulated graph (in table) of the last 30 days of up-down connection data
+
+### 7.8.0 (2021-04-14)
+
+* add geographic subauth for Mesh-NLM
+* dogear expected and actual cells when accuracy test is pending
+
+### 7.7.1 (2021-04-14)
+
+* fix background colors in historical uptime table
+
+### 7.7.0 (2021-04-13)
+
+* remove unused translations
+* show notification when refreshing starts on monitor status page
+* hide data in Authority Connection History for non-active authorities
+* loosen threshold for caution in historical uptime table
+* minor tweaks missed in original sync
+
+### 7.6.0 (2021-04-12)
+
+* update authority configs and test scenarios to use the new cache indexing with results stored as blobs in the index
+* update to Rails 5.2.5
+* update dependencies
+* fix exception when first time running monitor status
+
 ### 7.5.1 (2020-12-08)
 
 * define missing i18n translations

data/app/assets/stylesheets/qa_server/_check-status.scss

@@ -88,6 +88,10 @@ td.bold-left-border {
   border-left: 2px solid black;
 }
 
+.status-dogear {
+  background: linear-gradient(135deg, #333 0%, #333 10%, transparent 10%, transparent 100%);
+}
+
 .status-good {
   text-align: center;
   background-color: #ccffcc;

data/app/assets/stylesheets/qa_server/_monitor-status.scss

@@ -53,3 +53,48 @@ div#performance-by-the-day {
 div#performance-by-the-month {
   display: none;
 }
+
+table.up-down-history {
+  border: none;
+}
+
+td.up-down-history {
+  font-size: .8em;
+  font-style: italic;
+  border: none;
+}
+th.up-down-history {
+  width: 20px;
+  border: none;
+}
+
+td.connection-up-down {
+  border-right: 8px white solid;
+  border-left: 8px white solid;
+  border-top: none;
+  border-bottom: 3px white solid;
+}
+
+td.connection-no-data {
+  background-color: white;
+}
+
+td.connection-fully-up {
+  background-color: #19AE19;
+}
+
+td.connection-mostly-up {
+  background-color: #19AEA7;
+}
+
+td.connection-timeouts {
+  background-color: #EDF908;
+}
+
+td.connection-barely-up {
+  background-color: #AE7619;
+}
+
+td.connection-down {
+  background-color: #CE0303;
+}

data/app/cache_processors/concerns/qa_server/cache_keys.rb

@@ -5,6 +5,7 @@ module QaServer
     SCENARIO_RUN_SUMMARY_DATA_CACHE_KEY = "QaServer--CacheKeys--scenario_run_summary_data"
     SCENARIO_RUN_FAILURE_DATA_CACHE_KEY = "QaServer--CacheKeys--scenario_run_failure_data"
     SCENARIO_RUN_HISTORY_DATA_CACHE_KEY = "QaServer--CacheKeys--scenario_run_history_data"
+    SCENARIO_RUN_HISTORY_UP_DOWN_DATA_CACHE_KEY = "QaServer--CacheKeys--history_up_down_data"
 
     PERFORMANCE_DATATABLE_DATA_CACHE_KEY = "QaServer--Cache--performance_datatable_data"
   end

data/app/cache_processors/qa_server/scenario_history_cache.rb

@@ -2,8 +2,9 @@
 # Maintain a cache of data for Authority Connection History table displayed on Monitor Status page
 module QaServer
   class ScenarioHistoryCache
-    class_attribute :scenario_history_class
+    class_attribute :scenario_history_class, :scenario_up_down_class
     self.scenario_history_class = QaServer::ScenarioRunHistory
+    self.scenario_up_down_class = QaServer::HistoryUpDownService
 
     class << self
       include QaServer::CacheKeys
@@ -21,12 +22,29 @@ module QaServer
         end
       end
 
+      # Get a status for each of the last 30 days for queries that succeeded or failed.
+      # @param force [Boolean] if true, run the tests even if the cache hasn't expired; otherwise, use cache if not expired
+      # @returns [Hash<Array>] status for the last 30 days for each authority
+      # @example { auth_name => [:fully_up, :fully_up, :down, :mostly_up, ... ], ... }
+      #   { 'agrovoc' => [ :fully_up, :fully_up, :down, :mostly_up, ...],
+      #     'geonames_ld4l_cache' => [ :fully_up, :mostly_up, :down, :fully_up, :timeouts, ...] }
+      def historical_up_down_data(force: false)
+        Rails.cache.fetch(cache_key_for_historical_up_down_data, expires_in: next_expiry, race_condition_ttl: 30.seconds, force: force) do
+          QaServer.config.monitor_logger.debug("(QaServer::ScenarioHistoryCache) - CALCULATING UP-DOWN STATUS HISTORY of scenario runs (force: #{force})")
+          scenario_up_down_class.new.last_30_days
+        end
+      end
+
     private
 
       def cache_key_for_historical_data
         SCENARIO_RUN_HISTORY_DATA_CACHE_KEY
       end
 
+      def cache_key_for_historical_up_down_data
+        SCENARIO_RUN_HISTORY_UP_DOWN_DATA_CACHE_KEY
+      end
+
       def next_expiry
         QaServer::CacheExpiryService.cache_expiry
       end

data/app/controllers/qa_server/monitor_status_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # Controller for Monitor Status header menu item
 module QaServer
-  class MonitorStatusController < ApplicationController
+  class MonitorStatusController < ApplicationController # rubocop:disable Metrics/ClassLength
     layout 'qa_server'
 
     include QaServer::AuthorityValidationBehavior
@@ -19,9 +19,10 @@ module QaServer
       @presenter = presenter_class.new(current_summary: latest_summary,
                                        current_failure_data: latest_failures,
                                        historical_summary_data: historical_data,
+                                       historical_up_down_data: historical_up_down_data,
                                        performance_data: performance_table_data)
       QaServer.config.monitor_logger.debug("~~~~~~~~ DONE rendering monitor status")
-      render 'index', status: :internal_server_error if latest_summary.failing_authority_count.positive?
+      render 'index', status: :internal_server_error if latest_summary&.failing_authority_count&.positive?
     end
 
   private
@@ -43,13 +44,13 @@ module QaServer
 
     # @returns [QaServer::ScenarioRunSummary] summary statistics on the latest run
     def latest_summary
-      QaServer::ScenarioRunSummaryCache.summary_for_run(run: latest_test_run)
+      latest_test_run ? QaServer::ScenarioRunSummaryCache.summary_for_run(run: latest_test_run) : nil
     end
 
     # @returns [Array<Hash>] scenario details for any failing scenarios in the latest run
     # @see QaServer::ScenarioRunHistory#run_failures for structure of output
     def latest_failures
-      QaServer::ScenarioRunFailuresCache.failures_for_run(run: latest_test_run)
+      latest_test_run ? QaServer::ScenarioRunFailuresCache.failures_for_run(run: latest_test_run) : nil
     end
 
     # Get a summary level of historical data
@@ -59,6 +60,13 @@ module QaServer
       @historical_data ||= QaServer::ScenarioHistoryCache.historical_summary(force: refresh_history?)
     end
 
+    # Get a summary level of historical data
+    # @returns [Array<Hash>] summary of passing/failing tests for each authority
+    # @see QaServer::ScenarioRunHistory#historical_summary for structure of output
+    def historical_up_down_data
+      @historical_up_down_data ||= QaServer::ScenarioHistoryCache.historical_up_down_data(force: refresh_history?)
+    end
+
     def update_historical_graph
       return unless QaServer.config.display_historical_graph?
       QaServer::ScenarioHistoryGraphCache.generate_graph(data: historical_data, force: refresh_history?)
@@ -77,7 +85,8 @@ module QaServer
     end
 
     def refresh?
-      params.key?(:refresh) && validate_auth_reload_token("refresh status")
+      return @refresh unless @refresh.nil?
+      @refresh ||= params.key?(:refresh) && validate_auth_reload_token("refresh status")
     end
 
     def refresh_all?
@@ -86,15 +95,36 @@ module QaServer
     end
 
     def refresh_tests?
-      refresh? ? (refresh_all? || params[:refresh].casecmp?('tests')) : false
+      return @refresh_tests unless @refresh_tests.nil?
+      @refresh_tests = refresh? && (refresh_all? || params[:refresh].casecmp?('tests'))
+      if @refresh_tests
+        msg = I18n.t('qa_server.monitor_status.refreshing_tests')
+        logger.info msg
+        flash.now[:success] = msg
+      end
+      @refresh_tests
     end
 
     def refresh_history?
-      refresh? ? (refresh_all? || params[:refresh].casecmp?('history')) : false
+      return @refresh_history unless @refresh_history.nil?
+      @refresh_history = refresh? && (refresh_all? || params[:refresh].casecmp?('history'))
+      if @refresh_history
+        msg = I18n.t('qa_server.monitor_status.refreshing_history')
+        logger.info msg
+        flash.now[:success] = msg
+      end
+      @refresh_history
     end
 
     def refresh_performance?
-      refresh? ? (refresh_all? || params[:refresh].casecmp?('performance')) : false
+      return @refresh_performance unless @refresh_performance.nil?
+      @refresh_performance = refresh? && (refresh_all? || params[:refresh].casecmp?('performance'))
+      if @refresh_performance
+        msg = I18n.t('qa_server.monitor_status.refreshing_performance')
+        logger.info msg
+        flash.now[:success] = msg
+      end
+      @refresh_performance
     end
 
     def refresh_performance_table?
@@ -117,7 +147,7 @@ module QaServer
       token = params.key?(:auth_token) ? params[:auth_token] : nil
       valid = Qa.config.valid_authority_reload_token?(token)
       return true if valid
-      msg = "Permission denied. Unable to #{action}."
+      msg = I18n.t('qa_server.monitor_status.permission_denied', action: action)
       logger.warn msg
       flash.now[:error] = msg
       false

data/app/models/qa_server/scenario_run_history.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # Provide access to the scenario_run_history database table which tracks scenario runs over time.
 module QaServer
-  class ScenarioRunHistory < ApplicationRecord
+  class ScenarioRunHistory < ApplicationRecord # rubocop:disable Metrics/ClassLength
     self.table_name = 'scenario_run_history'
     belongs_to :scenario_run_registry
     enum scenario_type: { connection: 0, accuracy: 1, performance: 2 }, _suffix: :type
@@ -11,9 +11,9 @@ module QaServer
     BAD_MARKER = 'X'
     UNKNOWN_MARKER = '?'
 
-    class_attribute :summary_class
-
+    class_attribute :summary_class, :authority_lister_class
     self.summary_class = QaServer::ScenarioRunSummary
+    self.authority_lister_class = QaServer::AuthorityListerService
 
     class << self
       # Save a scenario result
@@ -92,12 +92,21 @@ module QaServer
         days_unknown = count_days(:unknown)
         keys = (days_good.keys + days_bad.keys + days_unknown.keys).uniq.sort
         keys.each_with_object({}) do |auth, hash|
+          next unless active_authority? auth
           hash[auth] = { good: day_count(auth, days_good), bad: day_count(auth, days_bad) + day_count(auth, days_unknown) }
         end
       end
 
     private
 
+      def active_authority?(auth)
+        active_authorities.include? auth.to_sym
+      end
+
+      def active_authorities
+        @active_authorities = authority_lister_class.authorities_list
+      end
+
       def day_count(auth, days)
         days&.key?(auth) ? days[auth] : 0
       end

data/app/models/qa_server/search_scenario.rb

@@ -60,5 +60,11 @@ module QaServer
     def subauthority?
       subauthority_name.present?
     end
+
+    def context?
+      # don't include context for accuracy tests
+      return false if expected_by_position.present?
+      super
+    end
   end
 end

data/app/presenters/qa_server/check_status_presenter.rb

@@ -81,7 +81,7 @@ module QaServer
 
     # @return [String] the name of the css style class to use for the status cell based on the status of the scenario test.
     def status_style_class(status)
-      "status-#{status}"
+      status[:pending] ? "status-dogear status-#{status[:status]}" : "status-#{status[:status]}"
     end
 
     # @return [String] the name of the css style class to use for the status cell based on the status of the scenario test.

data/app/presenters/qa_server/monitor_status/current_status_presenter.rb

@@ -13,12 +13,13 @@ module QaServer::MonitorStatus
 
     # @return [ActiveSupport::TimeWithZone] date time stamp of last test run
     def last_updated_dt
-      @current_summary.run_dt_stamp
+      @current_summary ? @current_summary.run_dt_stamp : QaServer::TimeService.current_time
     end
 
     # @return [String] date with time of last test run
     def last_updated
-      QaServer::TimeService.pretty_time(last_updated_dt)
+      return I18n.t('qa_server.monitor_status.summary.no_data') if @current_summary.blank?
+      I18n.t('qa_server.monitor_status.summary.last_updated', date: QaServer::TimeService.pretty_time(last_updated_dt))
     end
 
     # @return [ActiveSupport::TimeWithZone] date time stamp of first recorded test run
@@ -33,12 +34,12 @@ module QaServer::MonitorStatus
 
     # @return [Integer] number of loaded authorities
     def authorities_count
-      @current_summary.authority_count
+      @current_summary ? @current_summary.authority_count : "N/A"
     end
 
     # @return [Integer] number of authorities with failing tests in the latest test run
     def failing_authorities_count
-      @current_failure_data.map { |f| f[:authority_name] }.uniq.count
+      @current_failure_data ? @current_failure_data.map { |f| f[:authority_name] }.uniq.count : "N/A"
     end
 
     # @return [String] css style class representing whether all tests passed or any failed
@@ -48,17 +49,17 @@ module QaServer::MonitorStatus
 
     # @return [Integer] number of tests in the latest test run
     def tests_count
-      @current_summary.total_scenario_count
+      @current_summary ? @current_summary.total_scenario_count : 0
     end
 
     # @return [Integer] number of passing tests in the latest test run
     def passing_tests_count
-      @current_summary.passing_scenario_count
+      @current_summary ? @current_summary.passing_scenario_count : 0
     end
 
     # @return [Integer] number of failing tests in the latest test run
     def failing_tests_count
-      @current_summary.failing_scenario_count
+      @current_summary ? @current_summary.failing_scenario_count : 0
     end
 
     # @return [String] css style class representing whether all tests passed or any failed
@@ -77,7 +78,7 @@ module QaServer::MonitorStatus
     #       url: '/qa/search/linked_data/locnames_ld4l_cache/person?q=mark twain&maxRecords=4',
     #       err_message: 'Exception: Something went wrong.' }, ... ]
     def failures
-      @current_failure_data
+      @current_failure_data ? @current_failure_data : []
     end
 
     # @return [Boolean] true if failure data exists for the latest test run; otherwise false

data/app/presenters/qa_server/monitor_status/history_presenter.rb

@@ -2,8 +2,16 @@
 # This presenter class provides historical testing data needed by the view that monitors status of authorities.
 module QaServer::MonitorStatus
   class HistoryPresenter
+    CAUTION_THRESHOLD = 0.05
+    WARNING_THRESHOLD = 0.1
+
     # @param parent [QaServer::MonitorStatusPresenter] parent presenter
     # @param historical_summary_data [Array<Hash>] summary of past failuring runs per authority to drive chart
+    # @example historical_summary_data
+    # {
+    #   "AGROVOC_DIRECT"=>{:good=>4, :bad=>0},
+    #   "AGROVOC_LD4L_CACHE"=>{:good=>4, :bad=>0}
+    # }
     def initialize(parent:, historical_summary_data:)
       @parent = parent
       @historical_summary_data = historical_summary_data
@@ -11,8 +19,10 @@ module QaServer::MonitorStatus
 
     # @return [Array<Hash>] historical test data to be displayed (authname, failing, passing)
     # @example
-    #   [ [ 'agrovoc', 0, 24 ],
-    #     [ 'geonames_ld4l_cache', 2, 22 ] ... ]
+    # {
+    #   "AGROVOC_DIRECT"=>{:good=>4, :bad=>0},
+    #   "AGROVOC_LD4L_CACHE"=>{:good=>4, :bad=>0}
+    # }
     def historical_summary
       @historical_summary_data
     end
@@ -69,47 +79,88 @@ module QaServer::MonitorStatus
       end
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] name of the authority (e.g. 'AUTH_NAME')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def historical_data_authority_name(historical_entry)
       historical_entry[0]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days with passing tests (e.g. 949)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_passing(historical_entry)
       historical_entry[1][:good]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days with failing tests (e.g. 51)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_failing(historical_entry)
       historical_entry[1][:bad]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days tested (e.g. 1000)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_tested(historical_entry)
       days_authority_passing(historical_entry) + days_authority_failing(historical_entry)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Float] percent of failing to passing tests (e.g. 0.05374 )
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def percent_authority_failing(historical_entry)
       days_authority_failing(historical_entry).to_f / days_authority_tested(historical_entry)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] percent of failing to passing tests (e.g. '5.4%')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def percent_authority_failing_str(historical_entry)
       ActiveSupport::NumberHelper.number_to_percentage(percent_authority_failing(historical_entry) * 100, precision: 1)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] css class for background in Days Failing and Percent Failing columns (e.g. 'status-neutral', 'status-unknown', 'status-bad')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def failure_style_class(historical_entry)
-      return "status-neutral" if days_authority_failing(historical_entry) <= 0
-      percent_authority_failing(historical_entry) < 0.10 ? "status-unknown" : "status-bad"
+      case percent_authority_failing(historical_entry)
+      when 0.0...CAUTION_THRESHOLD
+        "status-neutral"
+      when CAUTION_THRESHOLD...WARNING_THRESHOLD
+        "status-unknown"
+      else
+        "status-bad"
+      end
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] css class for background in Days Passing column (e.g. 'status-good', 'status-bad')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def passing_style_class(historical_entry)
       days_authority_passing(historical_entry) <= 0 ? "status-bad" : "status-good"
     end
 
+    # @return [Boolean] true if historical section should be visible; otherwise false
     def display_history_details?
       display_historical_graph? || display_historical_datatable?
     end
 
+    # @return [Boolean] true if historical graph should be visible; otherwise false
     def display_historical_graph?
       QaServer.config.display_historical_graph? && QaServer::HistoryGraphingService.history_graph_image_exists?
     end
 
+    # @return [Boolean] true if historical datatable should be visible; otherwise false
     def display_historical_datatable?
       QaServer.config.display_historical_datatable?
     end