qa_server 7.3.0 → 7.7.0

data/app/cache_processors/qa_server/scenario_run_summary_cache.rb

@@ -26,15 +26,15 @@ module QaServer
         end
       end
 
-      private
+    private
 
-        def cache_key_for_run_summary(id)
-          "#{SCENARIO_RUN_SUMMARY_DATA_CACHE_KEY}--#{id}"
-        end
+      def cache_key_for_run_summary(id)
+        "#{SCENARIO_RUN_SUMMARY_DATA_CACHE_KEY}--#{id}"
+      end
 
-        def next_expiry
-          QaServer::CacheExpiryService.cache_expiry
-        end
+      def next_expiry
+        QaServer::CacheExpiryService.cache_expiry
+      end
     end
   end
 end

data/app/controllers/concerns/qa_server/authority_validation_behavior.rb

@@ -6,6 +6,7 @@ module QaServer
     VALIDATION_TYPE_PARAM = :validation_type
     VALIDATE_CONNECTIONS = 'connections'
     VALIDATE_ACCURACY = 'accuracy'
+    VALIDATE_ACCURACY_COMPARISON = 'accuracy_comparison'
     ALL_VALIDATIONS = 'all_checks'
 
     included do
@@ -18,60 +19,64 @@ module QaServer
       self.logger_class = QaServer::ScenarioLogger
     end
 
-    private
+  private
 
-      def status_log
-        @status_log ||= logger_class.new
-      end
+    def status_log
+      @status_log ||= logger_class.new
+    end
 
-      def status_data_from_log
-        @status_data = status_log.to_a
-      end
+    def status_data_from_log
+      @status_data = status_log.to_a
+    end
 
-      def authorities_list
-        @authorities_list ||= lister_class.authorities_list
-      end
+    def authorities_list
+      @authorities_list ||= lister_class.authorities_list
+    end
 
-      def validate(authorities_list, validation_type = validator_class::DEFAULT_VALIDATION_TYPE)
-        return if authorities_list.blank?
-        authorities_list.each { |auth_name| validate_authority(auth_name, validation_type) }
-      end
+    def validate(authorities_list, validation_type = validator_class::DEFAULT_VALIDATION_TYPE)
+      return if authorities_list.blank?
+      result = []
+      authorities_list.each { |auth_name| result << validate_authority(auth_name, validation_type) }
+      result
+    end
 
-      def validate_authority(auth_name, validation_type)
-        validator_class.run(authority_name: auth_name, validation_type: validation_type, status_log: status_log)
-      end
+    def validate_authority(auth_name, validation_type)
+      validator_class.run(authority_name: auth_name, validation_type: validation_type, status_log: status_log)
+    end
 
-      def list(authorities_list)
-        return if authorities_list.blank?
-        authorities_list.each { |auth_name| list_scenarios(auth_name) }
-      end
+    def list(authorities_list)
+      return if authorities_list.blank?
+      authorities_list.each { |auth_name| list_scenarios(auth_name) }
+    end
 
-      def list_scenarios(auth_name)
-        lister_class.scenarios_list(authority_name: auth_name, status_log: status_log)
-      end
+    def list_scenarios(auth_name)
+      lister_class.scenarios_list(authority_name: auth_name, status_log: status_log)
+    end
 
-      def validating_connections?
-        return true if validation_type == VALIDATE_CONNECTIONS || validation_type == ALL_VALIDATIONS
-        false
-      end
+    def validating_accuracy?
+      return true if validation_type == validator_class::VALIDATE_ACCURACY
+      false
+    end
 
-      def validating_accuracy?
-        return true if validation_type == VALIDATE_ACCURACY || validation_type == ALL_VALIDATIONS
-        false
-      end
+    def comparing_accuracy?
+      return true if validation_type == validator_class::VALIDATE_ACCURACY_COMPARISON
+      false
+    end
 
-      def validation_type
-        return @validation_type if @validation_type.present?
-        case params[VALIDATION_TYPE_PARAM]
-        when ALL_VALIDATIONS
-          validator_class::ALL_VALIDATIONS
-        when VALIDATE_CONNECTIONS
-          validator_class::VALIDATE_CONNECTIONS
-        when VALIDATE_ACCURACY
-          validator_class::VALIDATE_ACCURACY
-        else
-          validator_class::DEFAULT_VALIDATION_TYPE
-        end
+    def validation_type
+      return @validation_type if @validation_type.present?
+      case params[VALIDATION_TYPE_PARAM]
+      when ALL_VALIDATIONS
+        validator_class::ALL_VALIDATIONS
+      when VALIDATE_CONNECTIONS
+        validator_class::VALIDATE_CONNECTIONS
+      when VALIDATE_ACCURACY
+        validator_class::VALIDATE_ACCURACY
+      when VALIDATE_ACCURACY_COMPARISON
+        validator_class::VALIDATE_ACCURACY_COMPARISON
+      else
+        validator_class::DEFAULT_VALIDATION_TYPE
       end
+    end
   end
 end

data/app/controllers/qa_server/check_status_controller.rb

@@ -7,6 +7,7 @@ module QaServer
     include QaServer::AuthorityValidationBehavior
 
     ALL_AUTHORITIES = '__all__'
+    VALIDATE_ACCURACY_COMPARISON = :accuracy_comparison
 
     class_attribute :presenter_class
     self.presenter_class = QaServer::CheckStatusPresenter
@@ -17,36 +18,105 @@ module QaServer
       validate(authorities_to_validate, validation_type)
       @presenter = presenter_class.new(authorities_list: authorities_list,
                                        connection_status_data: connection_status_data_from_log,
-                                       accuracy_status_data: accuracy_status_data_from_log)
+                                       accuracy_status_data: accuracy_status_data_from_log,
+                                       comparison_status_data: comparison_status_data_from_log)
     end
 
-    private
+  private
 
-      def connection_status_data_from_log
-        status_log.filter(type: validator_class::VALIDATE_CONNECTIONS)
-      end
+    def connection_status_data_from_log
+      status_log.filter(type: validator_class::VALIDATE_CONNECTIONS)
+    end
 
-      def accuracy_status_data_from_log
-        status_log.filter(type: validator_class::VALIDATE_ACCURACY)
-      end
+    def accuracy_status_data_from_log
+      return [] unless validating_accuracy?
+      status_log.filter(type: validator_class::VALIDATE_ACCURACY)
+    end
 
-      def authorities_to_validate
-        return [] unless authority_name.present?
-        authority_name == ALL_AUTHORITIES ? authorities_list : [authority_name]
-      end
+    def comparison_status_data_from_log
+      return [] unless comparing_accuracy?
+      filtered_log = status_log.filter(type: validator_class::VALIDATE_ACCURACY, group: true)
+      return [] unless filtered_log.count == 2
+      overlay_log(filtered_log)
+    end
 
-      def authority_name
-        return @authority_name if @authority_name.present?
-        @authority_name = params.key?(:authority) ? params[:authority].downcase : nil
-      end
+    def overlay_log(log)
+      auths = log.keys
+      auth_a = log[auths[0]]
+      auth_b = log[auths[1]]
+      overlay = []
+      auth_a.each { |test| overlay << match_and_merge_test(test, auth_b) }
+      auth_b.each { |test| overlay << merge_test_results(empty_test(test), test) }
+      overlay
+    end
 
-      def log_header
-        QaServer.config.performance_cache_logger.debug("----------------------  check status (max_cache_size = #{max_cache_size}) ----------------------")
-        QaServer.config.performance_cache_logger.debug("(#{self.class}##{__method__}) check status page request (authority_name # #{authority_name})")
+    def match_and_merge_test(a_test, auth_b)
+      auth_b.each_with_index do |b_test, idx|
+        next unless b_test[:action] == a_test[:action]
+        next unless b_test[:subauthority_name] == a_test[:subauthority_name]
+        next unless b_test[:request_data] == a_test[:request_data]
+        next unless b_test[:target] == a_test[:target]
+        return merge_test_results(a_test, auth_b.delete_at(idx))
       end
+      merge_test_results(a_test, empty_test(a_test))
+    end
 
-      def max_cache_size
-        ActiveSupport::NumberHelper.number_to_human_size(QaServer.config.max_performance_cache_size)
-      end
+    def merge_test_results(a_test, b_test)
+      merged_tests = {}
+      merged_tests[:status] = [a_test[:status], b_test[:status]]
+      merged_tests[:service] = [a_test[:service], b_test[:service]]
+      merged_tests[:action] = a_test[:action]
+      merged_tests[:authority_name] = [a_test[:authority_name], b_test[:authority_name]]
+      merged_tests[:subauthority_name] = a_test[:subauthority_name]
+      merged_tests[:request_data] = a_test[:request_data]
+      merged_tests[:target] = a_test[:target]
+      merged_tests[:expected] = [a_test[:expected], b_test[:expected]]
+      merged_tests[:actual] = [a_test[:actual], b_test[:actual]]
+      merged_tests[:url] = [a_test[:url], b_test[:url]]
+      merged_tests[:err_message] = [a_test[:err_message], b_test[:err_message]]
+      merged_tests
+    end
+
+    def empty_test(base_test)
+      merged_tests = {}
+      merged_tests[:status] = ''
+      merged_tests[:service] = ''
+      merged_tests[:action] = base_test[:action]
+      merged_tests[:authority_name] = ''
+      merged_tests[:subauthority_name] = base_test[:subauthority_name]
+      merged_tests[:request_data] = base_test[:request_data]
+      merged_tests[:target] = base_test[:target]
+      merged_tests[:expected] = ''
+      merged_tests[:actual] = ''
+      merged_tests[:url] = ''
+      merged_tests[:err_message] = ''
+      merged_tests
+    end
+
+    def authorities_to_validate
+      return [] if authority_name.blank?
+      authority_names = authority_name == ALL_AUTHORITIES ? authorities_list : [authority_name]
+      authority_names << compare_with if comparing_accuracy? && compare_with.present?
+      authority_names
+    end
+
+    def authority_name
+      return @authority_name if @authority_name.present?
+      @authority_name = params.key?(:authority) ? params[:authority].downcase : nil
+    end
+
+    def compare_with
+      return @compare_with if @compare_with.present?
+      @compare_with = params.key?(:compare_with) ? params[:compare_with].downcase : nil
+    end
+
+    def log_header
+      QaServer.config.performance_cache_logger.debug("----------------------  check status (max_cache_size = #{max_cache_size}) ----------------------")
+      QaServer.config.performance_cache_logger.debug("(#{self.class}##{__method__}) check status page request (authority_name # #{authority_name})")
+    end
+
+    def max_cache_size
+      ActiveSupport::NumberHelper.number_to_human_size(QaServer.config.max_performance_cache_size)
+    end
   end
 end

data/app/controllers/qa_server/fetch_controller.rb

@@ -20,41 +20,41 @@ module QaServer
                                        term_results: term_results)
     end
 
-    private
-
-      def authorities_list
-        @authorities_list ||= lister_class.authorities_list
-      end
-
-      # @return [Qa::Authorities::LinkedData::GenericAuthority] the instance of the QA authority
-      def authority
-        return unless authority_name?
-        @authority ||= QaServer::AuthorityLoaderService.load(authority_name: authority_name)
-      end
-
-      def uri?
-        uri.present?
-      end
-
-      def uri
-        @uri ||= params.key?(:uri) ? params[:uri] : nil
-      end
-
-      def authority_name?
-        authority_name.present?
-      end
-
-      def authority_name
-        @authority_name ||= params.key?(:authority) ? params[:authority].downcase : nil
-      end
-
-      def format
-        @format ||= params.key?(:results_format) ? params[:results_format] : 'json'
-      end
-
-      def term_results
-        return unless authority_name? && uri?
-        @term_results = authority.find(uri, format: format)
-      end
+  private
+
+    def authorities_list
+      @authorities_list ||= lister_class.authorities_list
+    end
+
+    # @return [Qa::Authorities::LinkedData::GenericAuthority] the instance of the QA authority
+    def authority
+      return unless authority_name?
+      @authority ||= QaServer::AuthorityLoaderService.load(authority_name: authority_name)
+    end
+
+    def uri?
+      uri.present?
+    end
+
+    def uri
+      @uri ||= params.key?(:uri) ? params[:uri] : nil
+    end
+
+    def authority_name?
+      authority_name.present?
+    end
+
+    def authority_name
+      @authority_name ||= params.key?(:authority) ? params[:authority].downcase : nil
+    end
+
+    def format
+      @format ||= params.key?(:results_format) ? params[:results_format] : 'json'
+    end
+
+    def term_results
+      return unless authority_name? && uri?
+      @term_results = authority.find(uri, format: format)
+    end
   end
 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
@@ -21,113 +21,135 @@ module QaServer
                                        historical_summary_data: historical_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
+  private
 
-      def perform_updates
-        update_tests
-        update_historical_graph
-        update_performance_graphs
-      end
+    def perform_updates
+      update_tests
+      update_historical_graph
+      update_performance_graphs
+    end
 
-      def update_tests
-        QaServer::ScenarioRunCache.run_tests(force: refresh_tests?)
-      end
+    def update_tests
+      QaServer::ScenarioRunCache.run_tests(force: refresh_tests?)
+    end
 
-      # Sets @latest_test_run [QaServer::ScenarioRunRegistry]
-      def latest_test_run
-        @latest_test_run ||= scenario_run_registry_class.latest_run
-      end
+    # Sets @latest_test_run [QaServer::ScenarioRunRegistry]
+    def latest_test_run
+      @latest_test_run ||= scenario_run_registry_class.latest_run
+    end
 
-      # @returns [QaServer::ScenarioRunSummary] summary statistics on the latest run
-      def latest_summary
-        QaServer::ScenarioRunSummaryCache.summary_for_run(run: latest_test_run)
-      end
+    # @returns [QaServer::ScenarioRunSummary] summary statistics on the latest run
+    def latest_summary
+      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)
-      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
+      latest_test_run ? QaServer::ScenarioRunFailuresCache.failures_for_run(run: latest_test_run) : nil
+    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_data
-        @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_data
+      @historical_data ||= QaServer::ScenarioHistoryCache.historical_summary(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?)
-      end
+    def update_historical_graph
+      return unless QaServer.config.display_historical_graph?
+      QaServer::ScenarioHistoryGraphCache.generate_graph(data: historical_data, force: refresh_history?)
+    end
 
-      def performance_table_data
-        return {} unless QaServer.config.display_performance_datatable?
-        QaServer::PerformanceDatatableCache.data(force: refresh_performance_table?)
-      end
+    def performance_table_data
+      return {} unless QaServer.config.display_performance_datatable?
+      QaServer::PerformanceDatatableCache.data(force: refresh_performance_table?)
+    end
 
-      def update_performance_graphs
-        return unless QaServer.config.display_performance_graph?
-        QaServer::PerformanceDayGraphCache.generate_graphs(force: refresh_performance_graphs?)
-        QaServer::PerformanceMonthGraphCache.generate_graphs(force: refresh_performance_graphs?)
-        QaServer::PerformanceYearGraphCache.generate_graphs(force: refresh_performance_graphs?)
-      end
+    def update_performance_graphs
+      return unless QaServer.config.display_performance_graph?
+      QaServer::PerformanceDayGraphCache.generate_graphs(force: refresh_performance_graphs?)
+      QaServer::PerformanceMonthGraphCache.generate_graphs(force: refresh_performance_graphs?)
+      QaServer::PerformanceYearGraphCache.generate_graphs(force: refresh_performance_graphs?)
+    end
 
-      def refresh?
-        params.key?(:refresh) && validate_auth_reload_token("refresh status")
-      end
+    def refresh?
+      return @refresh unless @refresh.nil?
+      @refresh ||= params.key?(:refresh) && validate_auth_reload_token("refresh status")
+    end
 
-      def refresh_all?
-        return false unless refresh?
-        params[:refresh].nil? || params[:refresh].casecmp?('all') # nil is for backward compatibility
-      end
+    def refresh_all?
+      return false unless refresh?
+      params[:refresh].nil? || params[:refresh].casecmp?('all') # nil is for backward compatibility
+    end
 
-      def refresh_tests?
-        refresh? ? (refresh_all? || params[:refresh].casecmp?('tests')) : false
+    def refresh_tests?
+      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
+    def refresh_history?
+      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
+    def refresh_performance?
+      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?
-        refresh? ? (refresh_performance? || params[:refresh].casecmp?('performance_table')) : false
-      end
+    def refresh_performance_table?
+      refresh? ? (refresh_performance? || params[:refresh].casecmp?('performance_table')) : false
+    end
 
-      def refresh_performance_graphs?
-        refresh? ? (refresh_performance? || params[:refresh].casecmp?('performance_graphs')) : false
-      end
+    def refresh_performance_graphs?
+      refresh? ? (refresh_performance? || params[:refresh].casecmp?('performance_graphs')) : false
+    end
 
-      def commit_cache?
-        params.key?(:commit) && validate_auth_reload_token("commit cache")
-      end
+    def commit_cache?
+      params.key?(:commit) && validate_auth_reload_token("commit cache")
+    end
 
-      def commit_cache
-        QaServer.config.performance_cache.write_all
-      end
+    def commit_cache
+      QaServer.config.performance_cache.write_all
+    end
 
-      def validate_auth_reload_token(action)
-        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}."
-        logger.warn msg
-        flash.now[:error] = msg
-        false
-      end
+    def validate_auth_reload_token(action)
+      token = params.key?(:auth_token) ? params[:auth_token] : nil
+      valid = Qa.config.valid_authority_reload_token?(token)
+      return true if valid
+      msg = I18n.t('qa_server.monitor_status.permission_denied', action: action)
+      logger.warn msg
+      flash.now[:error] = msg
+      false
+    end
 
-      def log_header
-        QaServer.config.monitor_logger.debug("------------------------------------  monitor status  -----------------------------------")
-        QaServer.config.monitor_logger.debug("refresh_all? #{refresh_all?}, refresh_tests? #{refresh_tests?}, refresh_history? #{refresh_history?}")
-        QaServer.config.monitor_logger.debug("refresh_performance? #{refresh_performance?}, refresh_performance_table? #{refresh_performance_table?}, " \
-                                             "refresh_performance_graphs? #{refresh_performance_graphs?})")
-      end
+    def log_header
+      QaServer.config.monitor_logger.debug("------------------------------------  monitor status  -----------------------------------")
+      QaServer.config.monitor_logger.debug("refresh_all? #{refresh_all?}, refresh_tests? #{refresh_tests?}, refresh_history? #{refresh_history?}")
+      QaServer.config.monitor_logger.debug("refresh_performance? #{refresh_performance?}, refresh_performance_table? #{refresh_performance_table?}, " \
+                                           "refresh_performance_graphs? #{refresh_performance_graphs?})")
+    end
   end
 end