qa_server 7.1.3 → 7.5.0

data/app/models/qa_server/authority_scenario.rb

@@ -5,13 +5,13 @@ module QaServer
     # @return [Qa::Authorities::LinkedData::GenericAuthority] authority instance the scenarios run against
     attr_reader :authority
 
-    # @return [String] name of the authority the scenarios run against (e.g. 'agrovoc_direct')
+    # @return [Symbol] name of the authority the scenarios run against (e.g. :AGROVOC_DIRECT)
     attr_reader :authority_name
 
     # @return [String] identifies the primary service provider (e.g. 'ld4l_cache', 'direct', etc.)
     attr_reader :service
 
-    # @return [String] name of the subauthority the scenario runs against
+    # @return [String] name of the subauthority the scenario runs against (e.g. 'person')
     attr_reader :subauthority_name
 
     # @return [Integer] the minimum size of data that must be returned for the scenario to be considered passing
@@ -21,14 +21,14 @@ module QaServer
     MIN_EXPECTED_SIZE = 200
 
     # @param authority [Qa::Authorities::LinkedData::GenericAuthority] the instance of the QA authority
-    # @param authoity_name [String] the name of the authority the scenario tests (e.g. "agrovoc_direct")
+    # @param authority_name [Symbol] the name of the authority the scenario tests (e.g. :AGROVOC_DIRECT)
     # @param authority_scenario_config [Hash] configurations from the yml file that pertain to all scenarios regardless of type
     # @param scenario_config [Hash] configuration from the yml file that are specific to a type of scenario
     def initialize(authority:, authority_name:, authority_scenario_config:, scenario_config: nil)
       @authority = authority
       @authority_name = authority_name
       @service = authority_scenario_config['service']
-      @context = authority_scenario_config.fetch('context', false)
+      @context = scenario_config.key?("position") ? false : authority_scenario_config.fetch('context', false)
       @subauthority_name = DEFAULT_SUBAUTH
       @min_result_size = MIN_EXPECTED_SIZE
     end

data/app/models/qa_server/authority_status.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 # Provide access to the authority_status database table which tracks a summary of status data over time.
 module QaServer
-  class AuthorityStatus < ActiveRecord::Base
+  class AuthorityStatus < ApplicationRecord
     self.table_name = 'authority_status'
-    has_many :authority_status_failure, foreign_key: :authority_status_id
+    has_many :authority_status_failure, dependent: :destroy
 
     # Get the latest saved status.
     def self.latest

data/app/models/qa_server/authority_status_failure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # Provide access to the authority_status_failure database table which tracks specific failures over time.
 module QaServer
-  class AuthorityStatusFailure < ActiveRecord::Base
+  class AuthorityStatusFailure < ApplicationRecord
     self.table_name = 'authority_status_failure'
     belongs_to :authority_status
   end

data/app/models/qa_server/performance_history.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 # Provide access to the scenario_results_history database table which tracks specific scenario runs over time.
 module QaServer
-  class PerformanceHistory < ActiveRecord::Base
+  class PerformanceHistory < ApplicationRecord
     self.table_name = 'performance_history'
 
-    enum action: [:fetch, :search]
+    enum action: { fetch: 0, search: 1 }
 
     class_attribute :datatable_data_service_class, :graph_data_service_class
     self.datatable_data_service_class = QaServer::PerformanceDatatableService

data/app/models/qa_server/scenario_run_history.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 # Provide access to the scenario_run_history database table which tracks scenario runs over time.
 module QaServer
-  class ScenarioRunHistory < ActiveRecord::Base
+  class ScenarioRunHistory < ApplicationRecord
     self.table_name = 'scenario_run_history'
     belongs_to :scenario_run_registry
-    enum scenario_type: [:connection, :accuracy, :performance], _suffix: :type
-    enum status: [:good, :bad, :unknown], _suffix: true
+    enum scenario_type: { connection: 0, accuracy: 1, performance: 2 }, _suffix: :type
+    enum status: { good: 0, bad: 1, unknown: 2 }, _suffix: true
 
     GOOD_MARKER = '√'
     BAD_MARKER = 'X'
@@ -96,66 +96,66 @@ module QaServer
         end
       end
 
-      private
+    private
 
-        def day_count(auth, days)
-          days&.key?(auth) ? days[auth] : 0
-        end
+      def day_count(auth, days)
+        days&.key?(auth) ? days[auth] : 0
+      end
 
-        def count_days(status)
-          where = time_period_where
-          where[:status] = status
-          auths = QaServer::ScenarioRunHistory.where(where).select("authority_name").group("date, authority_name")
-                                              .order("authority_name").pluck(:authority_name)
-          auths.each_with_object({}) do |auth, hash|
-            hash[auth] = 0 unless hash.key? auth
-            hash[auth] += 1
-          end
+      def count_days(status)
+        where = time_period_where
+        where[:status] = status
+        auths = QaServer::ScenarioRunHistory.where(where).select("authority_name").group("date, authority_name")
+                                            .order("authority_name").pluck(:authority_name)
+        auths.each_with_object({}) do |auth, hash|
+          hash[auth] = 0 unless hash.key? auth
+          hash[auth] += 1
         end
+      end
 
-        def authorities_in_run(run_id:)
-          QaServer::ScenarioRunHistory.where(scenario_run_registry_id: run_id).pluck(:authority_name).uniq
-        end
+      def authorities_in_run(run_id:)
+        QaServer::ScenarioRunHistory.where(scenario_run_registry_id: run_id).pluck(:authority_name).uniq
+      end
 
-        def authorities_with_failures_in_run(run_id:)
-          QaServer::ScenarioRunHistory.where(scenario_run_registry_id: run_id).where.not(status: 'good').pluck('authority_name').uniq
-        end
+      def authorities_with_failures_in_run(run_id:)
+        QaServer::ScenarioRunHistory.where(scenario_run_registry_id: run_id).where.not(status: 'good').pluck('authority_name').uniq
+      end
 
-        # @return [Hash] status counts across all authorities (used for current test summary)
-        # @example { "good" => 23, "bad" => 3, "unknown" => 0 }
-        def status_counts_in_run(run_id:)
-          status = QaServer::ScenarioRunHistory.group('status').where(scenario_run_registry_id: run_id).count
-          status["good"] = 0 unless status.key? "good"
-          status["bad"] = 0 unless status.key? "bad"
-          status["unknown"] = 0 unless status.key? "unknown"
-          status
-        end
+      # @return [Hash] status counts across all authorities (used for current test summary)
+      # @example { "good" => 23, "bad" => 3, "unknown" => 0 }
+      def status_counts_in_run(run_id:)
+        status = QaServer::ScenarioRunHistory.group('status').where(scenario_run_registry_id: run_id).count
+        status["good"] = 0 unless status.key? "good"
+        status["bad"] = 0 unless status.key? "bad"
+        status["unknown"] = 0 unless status.key? "unknown"
+        status
+      end
 
-        def runs_per_authority_for_time_period
-          status = QaServer::ScenarioRunHistory.joins(:scenario_run_registry).where(time_period_where).group('authority_name', 'status').count
-          status.each_with_object({}) do |(k, v), hash|
-            h = hash[k[0]] || { "good" => 0, "bad" => 0 } # initialize for an authority if it doesn't already exist
-            h[k[1]] = v
-            hash[k[0]] = h
-          end
+      def runs_per_authority_for_time_period
+        status = QaServer::ScenarioRunHistory.joins(:scenario_run_registry).where(time_period_where).group('authority_name', 'status').count
+        status.each_with_object({}) do |(k, v), hash|
+          h = hash[k[0]] || { "good" => 0, "bad" => 0 } # initialize for an authority if it doesn't already exist
+          h[k[1]] = v
+          hash[k[0]] = h
         end
+      end
 
-        def expected_time_period
-          QaServer.config.historical_datatable_default_time_period
-        end
+      def expected_time_period
+        QaServer.config.historical_datatable_default_time_period
+      end
 
-        def time_period_where
-          case expected_time_period
-          when :day
-            QaServer::TimePeriodService.where_clause_for_last_24_hours(dt_table: :scenario_run_history, dt_column: :date)
-          when :month
-            QaServer::TimePeriodService.where_clause_for_last_30_days(dt_table: :scenario_run_history, dt_column: :date)
-          when :year
-            QaServer::TimePeriodService.where_clause_for_last_12_months(dt_table: :scenario_run_history, dt_column: :date)
-          else
-            all_records
-          end
+      def time_period_where
+        case expected_time_period
+        when :day
+          QaServer::TimePeriodService.where_clause_for_last_24_hours(dt_table: :scenario_run_history, dt_column: :date)
+        when :month
+          QaServer::TimePeriodService.where_clause_for_last_30_days(dt_table: :scenario_run_history, dt_column: :date)
+        when :year
+          QaServer::TimePeriodService.where_clause_for_last_12_months(dt_table: :scenario_run_history, dt_column: :date)
+        else
+          all_records
         end
+      end
     end
   end
 end

data/app/models/qa_server/scenario_run_registry.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 # Provide access to the scenario_run_registry database table which registers each run of tests made over time.
 module QaServer
-  class ScenarioRunRegistry < ActiveRecord::Base
+  class ScenarioRunRegistry < ApplicationRecord
     self.table_name = 'scenario_run_registry'
-    has_many :scenario_run_history, foreign_key: :scenario_run_registry_id
+    has_many :scenario_run_history, dependent: :destroy
 
     # @return [ScenarioRunRegistry] registry data for latest run (e.g. id, dt_stamp)
     def self.latest_run

data/app/models/qa_server/scenarios.rb

@@ -32,38 +32,38 @@ module QaServer
       parse_search_scenarios
     end
 
-    private
+  private
 
-      def parse_term_scenarios
-        @term_scenarios = []
-        term_scenarios_config.each do |term_scenario_config|
-          @term_scenarios << QaServer::TermScenario.new(authority: authority,
-                                                        authority_name: authority_name,
-                                                        authority_scenario_config: authority_scenario_config,
-                                                        scenario_config: term_scenario_config)
-        end
+    def parse_term_scenarios
+      @term_scenarios = []
+      term_scenarios_config.each do |term_scenario_config|
+        @term_scenarios << QaServer::TermScenario.new(authority: authority,
+                                                      authority_name: authority_name,
+                                                      authority_scenario_config: authority_scenario_config,
+                                                      scenario_config: term_scenario_config)
       end
+    end
 
-      def parse_search_scenarios
-        @search_scenarios = []
-        search_scenarios_config.each do |search_scenario_config|
-          @search_scenarios << QaServer::SearchScenario.new(authority: authority,
-                                                            authority_name: authority_name,
-                                                            authority_scenario_config: authority_scenario_config,
-                                                            scenario_config: search_scenario_config)
-        end
+    def parse_search_scenarios
+      @search_scenarios = []
+      search_scenarios_config.each do |search_scenario_config|
+        @search_scenarios << QaServer::SearchScenario.new(authority: authority,
+                                                          authority_name: authority_name,
+                                                          authority_scenario_config: authority_scenario_config,
+                                                          scenario_config: search_scenario_config)
       end
+    end
 
-      def authority_scenario_config
-        scenarios_config[AUTHORITY_SCENARIO]
-      end
+    def authority_scenario_config
+      scenarios_config[AUTHORITY_SCENARIO]
+    end
 
-      def term_scenarios_config
-        scenarios_config[TERM_SCENARIOS] || []
-      end
+    def term_scenarios_config
+      scenarios_config[TERM_SCENARIOS] || []
+    end
 
-      def search_scenarios_config
-        scenarios_config[SEARCH_SCENARIOS] || []
-      end
+    def search_scenarios_config
+      scenarios_config[SEARCH_SCENARIOS] || []
+    end
   end
 end

data/app/models/qa_server/search_scenario.rb

@@ -20,10 +20,10 @@ module QaServer
     DEFAULT_SUBJECT_URI = nil
 
     # @param authority [Qa::Authorities::LinkedData::GenericAuthority] the instance of the QA authority
-    # @param authoity_name [Symbol] the name of the authority the scenario tests (e.g. :AGROVOC_DIRECT)
+    # @param authority_name [Symbol] the name of the authority the scenario tests (e.g. :AGROVOC_DIRECT)
     # @param authority_scenario_config [Hash] configurations from the yml file that pertain to all scenarios regardless of type
     # @param scenario_config [Hash] configuration from the yml file that are specific to a search scenario
-    def initialize(authority:, authority_name:, authority_scenario_config:, scenario_config:)
+    def initialize(authority:, authority_name:, authority_scenario_config:, scenario_config:) # rubocop:disable Metrics/CyclomaticComplexity
       super
       @query = scenario_config['query']
       @subauthority_name = scenario_config['subauth'] || DEFAULT_SUBAUTH
@@ -31,6 +31,7 @@ module QaServer
       @replacements = scenario_config['replacements'] || DEFAULT_REPLACEMENTS
       @expected_by_position = scenario_config['position'] || DEFAULT_POSITION
       @subject_uri = scenario_config['subject_uri'] || DEFAULT_SUBJECT_URI
+      @pending = scenario_config['pending'] || false
     end
 
     # Generate an example URL that can be called in a browser or through curl
@@ -42,18 +43,22 @@ module QaServer
       "#{prefix}?q=#{query}#{url_replacements}#{context}"
     end
 
-    private
+    def pending?
+      @pending
+    end
+
+  private
 
-      # Convert replacements hash into URL parameters
-      def url_replacements
-        return "&maxRecords=#{MAX_RECORDS}" unless replacements
-        param_replacements = ""
-        replacements.each { |k, v| param_replacements += "&#{k}=#{v}" }
-        param_replacements
-      end
+    # Convert replacements hash into URL parameters
+    def url_replacements
+      return "&maxRecords=#{MAX_RECORDS}" unless replacements
+      param_replacements = ""
+      replacements.each { |k, v| param_replacements += "&#{k}=#{v}" }
+      param_replacements
+    end
 
-      def subauthority?
-        subauthority_name.present?
-      end
+    def subauthority?
+      subauthority_name.present?
+    end
   end
 end

data/app/models/qa_server/term_scenario.rb

@@ -26,41 +26,41 @@ module QaServer
       authority.term_id_expects_uri? ? fetch_url : show_url
     end
 
-    private
+  private
 
-      # Generate an example URL that can be called in a browser or through curl
-      # @return [String] the example URL
-      def show_url
-        "#{prefix_for_url('show')}/#{url_identifier}"
-      end
+    # Generate an example URL that can be called in a browser or through curl
+    # @return [String] the example URL
+    def show_url
+      "#{prefix_for_url('show')}/#{url_identifier}"
+    end
 
-      # Generate an example URL that can be called in a browser or through curl
-      # @return [String] the example URL
-      def fetch_url
-        "#{prefix_for_url('fetch')}?uri=#{url_identifier}"
-      end
+    # Generate an example URL that can be called in a browser or through curl
+    # @return [String] the example URL
+    def fetch_url
+      "#{prefix_for_url('fetch')}?uri=#{url_identifier}"
+    end
 
-      def prefix_for_url(action)
-        subauth = "/#{subauthority_name}" if subauthority_name.present?
-        "#{QaServer::Engine.qa_engine_mount}/#{action}/linked_data/#{authority_name.downcase}#{subauth}"
-      end
+    def prefix_for_url(action)
+      subauth = "/#{subauthority_name}" if subauthority_name.present?
+      "#{QaServer::Engine.qa_engine_mount}/#{action}/linked_data/#{authority_name.downcase}#{subauth}"
+    end
 
-      # Convert identifier into URL safe version with encoding if needed.
-      def url_identifier
-        return uri_encode(identifier) if encode?
-        identifier
-      end
+    # Convert identifier into URL safe version with encoding if needed.
+    def url_identifier
+      return uri_encode(identifier) if encode?
+      identifier
+    end
 
-      def subauthority?
-        subauthority_name.present?
-      end
+    def subauthority?
+      subauthority_name.present?
+    end
 
-      def encode?
-        authority.term_id_expects_uri?
-      end
+    def encode?
+      authority.term_id_expects_uri?
+    end
 
-      def uri_encode(uri)
-        url_encode(uri).gsub(".", "%2E")
-      end
+    def uri_encode(uri)
+      url_encode(uri).gsub(".", "%2E")
+    end
   end
 end

data/app/prepends/prepended_linked_data/find_term.rb

@@ -17,52 +17,52 @@ module PrependedLinkedData::FindTerm
     requested_results(full_results)
   end
 
-  private
+private
 
-    def setup_find(request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists
-      QaServer.log_agent_info(request_header[:request])
-      @start_time_s = QaServer::TimeService.current_time_s
-      request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, format: format, performance_data: performance_data) if request_header.empty?
-      @saved_performance_data = performance_data || request_header[:performance_data]
-      request_header[:performance_data] = true
-      request_header
-    end
+  def setup_find(request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists
+    QaServer.log_agent_info(request_header[:request])
+    @start_time_s = QaServer::TimeService.current_time_s
+    request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, format: format, performance_data: performance_data) if request_header.empty?
+    @saved_performance_data = performance_data || request_header[:performance_data]
+    request_header[:performance_data] = true
+    request_header
+  end
 
-    def update_performance_history_record(full_results)
-      return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
-      updates = { action_time_ms: (QaServer::TimeService.current_time_s - @start_time_s) * 1000,
-                  size_bytes: full_results[:performance][:fetched_bytes],
-                  retrieve_plus_graph_load_time_ms: full_results[:performance][:fetch_time_s] * 1000,
-                  normalization_time_ms: full_results[:performance][:normalization_time_s] * 1000 }
-      QaServer.config.performance_cache.update(id: @phid, updates: updates)
-      QaServer.config.performance_cache.complete_entry(id: @phid)
-    end
+  def update_performance_history_record(full_results)
+    return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
+    updates = { action_time_ms: (QaServer::TimeService.current_time_s - @start_time_s) * 1000,
+                size_bytes: full_results[:performance][:fetched_bytes],
+                retrieve_plus_graph_load_time_ms: full_results[:performance][:fetch_time_s] * 1000,
+                normalization_time_ms: full_results[:performance][:normalization_time_s] * 1000 }
+    QaServer.config.performance_cache.update(id: @phid, updates: updates)
+    QaServer.config.performance_cache.complete_entry(id: @phid)
+  end
 
-    # Override to append performance history record id into the URL to allow access to the record in RDF::Graph
-    def load_graph(url:)
-      return super if QaServer.config.suppress_performance_gathering?
+  # Override to append performance history record id into the URL to allow access to the record in RDF::Graph
+  def load_graph(url:)
+    return super if QaServer.config.suppress_performance_gathering?
 
-      access_start_dt = QaServer::TimeService.current_time
+    access_start_dt = QaServer::TimeService.current_time
 
-      url += "&phid=#{@phid}"
-      @full_graph = graph_service.load_graph(url: url)
+    url += "&phid=#{@phid}"
+    @full_graph = graph_service.load_graph(url: url)
 
-      access_end_dt = QaServer::TimeService.current_time
-      @access_time_s = access_end_dt - access_start_dt
-      @fetched_size = full_graph.triples.to_s.size if performance_data?
-      Rails.logger.info("Time to receive data from authority: #{access_time_s}s")
-    end
+    access_end_dt = QaServer::TimeService.current_time
+    @access_time_s = access_end_dt - access_start_dt
+    @fetched_size = full_graph.triples.to_s.size if performance_data?
+    Rails.logger.info("Time to receive data from authority: #{access_time_s}s")
+  end
 
-    # Temporary override to fix bug.  Remove when QA Issue #271 is fixed and a new release is cut
-    def performance_data?
-      return super if QaServer.config.suppress_performance_gathering?
-      @performance_data == true
-    end
+  # Temporary override to fix bug.  Remove when QA Issue #271 is fixed and a new release is cut
+  def performance_data?
+    return super if QaServer.config.suppress_performance_gathering?
+    @performance_data == true
+  end
 
-    def requested_results(full_results)
-      return full_results if @saved_performance_data || !full_results.is_a?(Hash)
-      return full_results[:results] unless full_results.key? :response_header
-      full_results.delete(:performance)
-      full_results
-    end
+  def requested_results(full_results)
+    return full_results if @saved_performance_data || !full_results.is_a?(Hash)
+    return full_results[:results] unless full_results.key? :response_header
+    full_results.delete(:performance)
+    full_results
+  end
 end