qa_server 7.2.0 → 7.5.1

data/app/validators/qa_server/search_scenario_validator.rb

@@ -6,87 +6,93 @@ module QaServer
   class SearchScenarioValidator < ScenarioValidator
     SEARCH_ACTION = 'search'
 
+    # CONCRETE Implementation: Return value of request_data
+    attr_reader :request_data
+    private :request_data
+
     # @param scenario [SearchScenario] the scenario to run
     # @param status_log [ScenarioLogger] logger for recording test results
     # @param validation_type [Symbol] the type of scenarios to run (e.g. VALIDATE_CONNECTION, VALIDATE_ACCURACY, ALL_VALIDATIONS)
     def initialize(scenario:, status_log:, validation_type: DEFAULT_VALIDATION_TYPE)
       super
+      @request_data = scenario.query
     end
 
-    private
+  private
 
-      def action
-        SEARCH_ACTION
-      end
+    def action
+      SEARCH_ACTION
+    end
 
-      # Run the connection test and log results
-      def run_connection_scenario
-        test_connection(min_expected_size: scenario.min_result_size, scenario_type_name: 'search') do
-          replacements = scenario.replacements.dup
-          authority.search(scenario.query,
-                           subauth: scenario.subauthority_name,
-                           replacements: replacements)
-        end
+    # CONCRETE Implementation: Run the connection test and log results
+    def run_connection_scenario
+      test_connection(min_expected_size: scenario.min_result_size, scenario_type_name: 'search') do
+        replacements = scenario.replacements.dup
+        authority.search(scenario.query,
+                         subauth: scenario.subauthority_name,
+                         replacements: replacements)
       end
+    end
 
-      # Run the accuracy test and log results
-      def run_accuracy_scenario
-        test_accuracy(subject_uri: scenario.subject_uri, expected_by_position: scenario.expected_by_position) do
-          authority.search(scenario.query,
-                           subauth: scenario.subauthority_name,
-                           replacements: scenario.replacements)
-        end
+    # CONCRETE Implementation: Run the accuracy test and log results
+    def run_accuracy_scenario
+      test_accuracy(subject_uri: scenario.subject_uri, expected_by_position: scenario.expected_by_position, pending: scenario.pending?) do
+        replacements = scenario.replacements.dup
+        authority.search(scenario.query,
+                         subauth: scenario.subauthority_name,
+                         replacements: replacements)
       end
+    end
 
-      # Runs the accuracy test and log results
-      def test_accuracy(subject_uri:, expected_by_position:)
-        dt_start = QaServer::TimeService.current_time
-        results = yield if block_given?
-        dt_end = QaServer::TimeService.current_time
-        if results.blank?
-          log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: no results found", expected: expected_by_position, target: subject_uri, request_run_time: (dt_end - dt_start))
-          return
-        end
-
-        check_position(results, subject_uri, expected_by_position, total_run_time: (dt_end - dt_start)) # TODO: need to get run times from results
-      rescue Exception => e
-        dt_end = QaServer::TimeService.current_time
-        log(status: FAIL, errmsg: "Exception executing search position scenario; cause: #{e.message}",
-            expected: expected_by_position, target: subject_uri, request_run_time: (dt_end - dt_start))
+    # Runs the accuracy test and log results
+    def test_accuracy(subject_uri:, expected_by_position:, pending: false)
+      dt_start = QaServer::TimeService.current_time
+      results = yield if block_given?
+      dt_end = QaServer::TimeService.current_time
+      if results.blank?
+        log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: no results found", expected: expected_by_position,
+            target: subject_uri, request_run_time: (dt_end - dt_start), pending: pending)
+        return
       end
 
-      def accuracy_scenario?
-        return false if scenario.expected_by_position.blank? || scenario.subject_uri.blank?
-        true
-      end
+      check_position(results, subject_uri, expected_by_position, total_run_time: (dt_end - dt_start), pending: pending) # TODO: need to get run times from results
+    rescue Exception => e
+      dt_end = QaServer::TimeService.current_time
+      log(status: FAIL, errmsg: "Exception executing search position scenario; cause: #{e.message}",
+          expected: expected_by_position, target: subject_uri, request_run_time: (dt_end - dt_start), pending: pending)
+    end
 
-      def connection_scenario?
-        # There are only two types of tests, so if this isn't an accuracy scenario, it must be a connection scenario.
-        !accuracy_scenario?
-      end
+    def accuracy_scenario?
+      return false if scenario.expected_by_position.blank? || scenario.subject_uri.blank?
+      true
+    end
 
-      def check_position(results, subject_uri, expected_by_position, total_run_time)
-        actual_position = subject_position(results, subject_uri, total_run_time)
-        return if actual_position.blank?
+    def connection_scenario?
+      # There are only two types of tests, so if this isn't an accuracy scenario, it must be a connection scenario.
+      !accuracy_scenario?
+    end
 
-        actual_position += 1
-        if actual_position <= expected_by_position
-          log(status: PASS, expected: expected_by_position, actual: actual_position, target: subject_uri,
-              normalization_run_time: total_run_time) # TODO: need to get run times from results
-        else
-          log(status: UNKNOWN, errmsg: 'Subject URI not found by the expected position.',
-              expected: expected_by_position, actual: actual_position, target: subject_uri,
-              normalization_run_time: total_run_time) # TODO: need to get run times from results
-        end
+    def check_position(results, subject_uri, expected_by_position, total_run_time:, pending:)
+      actual_position = subject_position(results, subject_uri, total_run_time, pending)
+      return if actual_position.blank?
+
+      if actual_position <= expected_by_position
+        log(status: PASS, expected: expected_by_position, actual: actual_position, target: subject_uri,
+            normalization_run_time: total_run_time, pending: pending) # TODO: need to get run times from results
+      else
+        log(status: UNKNOWN, errmsg: 'Subject URI not found by the expected position.',
+            expected: expected_by_position, actual: actual_position, target: subject_uri,
+            normalization_run_time: total_run_time, pending: pending) # TODO: need to get run times from results
       end
+    end
 
-      def subject_position(results, subject_uri, total_run_time)
-        0.upto(results.size - 1) do |position|
-          return position if results[position][:uri] == subject_uri
-        end
-        log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: subject uri (#{subject_uri}) not found in results",
-            expected: scenario.expected_by_position, target: subject_uri, normalization_run_time: total_run_time) # TODO: need to get run times from results
-        nil
+    def subject_position(results, subject_uri, total_run_time, pending)
+      0.upto(results.size - 1) do |position|
+        return position + 1 if results[position][:uri] == subject_uri
       end
+      log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: subject uri (#{subject_uri}) not found in results",
+          expected: scenario.expected_by_position, target: subject_uri, normalization_run_time: total_run_time, pending: pending) # TODO: need to get run times from results
+      nil
+    end
   end
 end

data/app/validators/qa_server/term_scenario_validator.rb

@@ -4,14 +4,21 @@ module QaServer
   class TermScenarioValidator < ScenarioValidator
     TERM_ACTION = 'term'
 
+    # CONCRETE Implementation: Return value of request_data
+    attr_reader :request_data
+    private :request_data
+
     # @param scenario [TermScenario] the scenario to run
     # @param status_log [ScenarioLogger] logger for recording test results
     # @param validation_type [Symbol] the type of scenarios to run (e.g. VALIDATE_CONNECTION, VALIDATE_ACCURACY, ALL_VALIDATIONS)
     def initialize(scenario:, status_log:, validation_type: DEFAULT_VALIDATION_TYPE)
       super
+      @request_data = scenario.identifier
     end
 
-    # Run a term scenario and log results.
+  private
+
+    # CONCRETE Implementation: Run a term scenario and log results.
     def run_connection_scenario
       test_connection(min_expected_size: scenario.min_result_size, scenario_type_name: 'term') do
         authority.find(scenario.identifier,
@@ -19,25 +26,23 @@ module QaServer
       end
     end
 
-    # Run a term scenario and log results.
+    # CONCRETE Implementation: Run a term scenario and log results.
     def run_accuracy_scenario
       # no accuracy scenarios defined for terms at this time
     end
 
-    private
-
-      def action
-        TERM_ACTION
-      end
+    def action
+      TERM_ACTION
+    end
 
-      def accuracy_scenario?
-        # At this time, all scenarios are connection scenarios for terms.
-        false
-      end
+    def accuracy_scenario?
+      # At this time, all scenarios are connection scenarios for terms.
+      false
+    end
 
-      def connection_scenario?
-        # At this time, all scenarios are connection scenarios for terms.
-        true
-      end
+    def connection_scenario?
+      # At this time, all scenarios are connection scenarios for terms.
+      true
+    end
   end
 end

data/app/views/qa_server/check_status/index.html.erb

@@ -1,10 +1,35 @@
 <script>
+  function hide_data() {
+    connection_status_section = document.getElementById('connection-status-section');
+    if (connection_status_section != null) {
+      connection_status_section.style.display = 'none';
+    }
+    accuracy_status_section = document.getElementById('accuracy-status-section');
+    if (accuracy_status_section != null) {
+      accuracy_status_section.style.display = 'none';
+    }
+    comparison_status_section = document.getElementById('comparison-status-section');
+    if (comparison_status_section != null) {
+      comparison_status_section.style.display = 'none';
+    }
+  }
+
   function validate_authority(form) {
-    form.submit();
+    show_loading_message();
+    hide_data();
+  }
+
+  function show_loading_message() {
     document.getElementById('status-loading-message').style.display = 'block';
-    document.getElementById('connection-status-section').style.display = 'none';
-    document.getElementById('accuracy-status-section').style.display = 'none';
-    document.getElementById('example-url-warning').style.display = 'none';
+  }
+  function hide_loading_message() {
+    document.getElementById('status-loading-message').style.display = 'none';
+  }
+  function show_comparison_selector() {
+    document.getElementById('comparison-authority-selector').style.display = 'block';
+  }
+  function hide_comparison_selector() {
+    document.getElementById('comparison-authority-selector').style.display = 'none';
   }
 </script>
 
@@ -12,24 +37,43 @@
 
   <h2><%= t('qa_server.check_status.title') %></h2>
 
+  <% selected_authority = @presenter.selected_authority %>
+  <% selected_comparison = @presenter.selected_comparison %>
   <%= form_tag({ action: 'index' }, { method: :get }) do %>
-  <select name="authority" id="authority" class="string multi-value optional form-control form-control multi-text-field" value="" aria-labelledby="authority" onchange="validate_authority(this.form)">
-    <option value=""><%= t('qa_server.check_status.select_authority') %></option>
-    <option disabled>──────────</option>
-    <option value="<%= @presenter.value_all_collections %>"><%= t('qa_server.check_status.show_all') %></option>
-    <option disabled>──────────</option>
-    <% @authorities_list.each do |auth_name| %>
-        <option value="<%= auth_name %>"><%= auth_name.upcase %></option>
-    <% end %>
-  </select>
-  <div class="validation-types">
-    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_connections, :selected) %>
-    <%= label_tag(@presenter.label_check_connections, t('qa_server.check_status.connections'), class: 'horizontal-list') %>
-    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_accuracy) %>
-    <%= label_tag(@presenter.label_check_accuracy, t('qa_server.check_status.accuracy'), class: 'horizontal-list') %>
-    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_all_checks) %>
-    <%= label_tag(@presenter.label_all_checks, t('qa_server.check_status.all_checks'), class: 'horizontal-list') %>
-  </div>
+    <div id="authority-selector">
+      <select name="authority" id="authority" class="string optional form-control form-control" value="" aria-labelledby="authority" onchange="hide_data()">
+        <option value=""><%= t('qa_server.check_status.select_authority') %></option>
+        <option disabled>──────────</option>
+        <option value="<%= @presenter.value_all_collections %>"><%= t('qa_server.check_status.show_all') %></option>
+        <option disabled>──────────</option>
+        <% @authorities_list.each do |auth_name| %>
+          <option value="<%= auth_name %>"<%= " selected" if auth_name == selected_authority %>><%= auth_name.upcase %></option>
+        <% end %>
+      </select>
+    </div>
+
+    <div id="comparison-authority-selector" style="<%= "display\: block" if @presenter.comparison_status_data? %>">
+      Compare with:
+      <select name="compare_with" id="compare-with" class="string optional form-control form-control" value="" aria-labelledby="authority" onchange="hide_data()">
+        <option value=""><%= t('qa_server.check_status.select_authority') %></option>
+        <option disabled>──────────</option>
+        <% @authorities_list.each do |auth_name| %>
+            <option value="<%= auth_name %>"<%= " selected" if auth_name == selected_comparison %>><%= auth_name.upcase %></option>
+        <% end %>
+      </select>
+    </div>
+
+    <div class="validation-types">
+      <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_connections, @presenter.connection_tests_checked, onClick: "hide_comparison_selector()") %>
+      <%= label_tag(@presenter.label_check_connections, t('qa_server.check_status.connections'), class: 'horizontal-list') %>
+      <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_accuracy, @presenter.accuracy_tests_checked, onClick: "hide_comparison_selector()") %>
+      <%= label_tag(@presenter.label_check_accuracy, t('qa_server.check_status.accuracy'), class: 'horizontal-list') %>
+      <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_comparison, @presenter.comparison_tests_checked, onClick: "show_comparison_selector()") %>
+      <%= label_tag(@presenter.label_check_comparison, t('qa_server.check_status.comparison'), class: 'horizontal-list') %>
+      <%= radio_button_tag(@presenter.value_check_param, @presenter.value_all_checks, false, onClick: "hide_comparison_selector()") %>
+      <%= label_tag(@presenter.label_all_checks, t('qa_server.check_status.all_checks'), class: 'horizontal-list') %>
+    </div>
+    <button type="submit" class="btn btn-primary" id="check-status-go" onclick="validate_authority(this.form)">GO</button>
   <% end %>
 
 
@@ -56,7 +100,7 @@
           </tr>
       <% end %>
       <tr>
-        <td class="<%= @presenter.status_style_class(status) %>"><%= @presenter.status_label(status) %></td>
+        <td class="<%= @presenter.status_style_class(status[:status]) %>"><%= @presenter.status_label(status[:status]) %></td>
         <td><%= status[:subauthority_name] %></td>
         <td><%= status[:service] %></td>
         <td><%= status[:action] %></td>
@@ -75,6 +119,7 @@
     <tr>
       <th><%= t('qa_server.check_status.status_table.expected_by_position') %></th>
       <th><%= t('qa_server.check_status.status_table.actual_position') %></th>
+      <th><%= t('qa_server.check_status.status_table.request_data') %></th>
       <th><%= t('qa_server.check_status.status_table.subject_uri') %></th>
       <th><%= t('qa_server.check_status.status_table.authority') %></th>
       <th><%= t('qa_server.check_status.status_table.subauthority') %></th>
@@ -83,10 +128,18 @@
       <th><%= t('qa_server.check_status.status_table.url') %></th>
       <th><%= t('qa_server.check_status.status_table.errmsg') %></th>
     </tr>
+    <% current_authority = nil %>
     <% @presenter.accuracy_status_data.each do |status| %>
+      <% unless status[:authority_name] == current_authority %>
+        <% current_authority = status[:authority_name] %>
+        <tr>
+          <td class="table_subheading" colspan="10"><%= current_authority %></td>
+        </tr>
+      <% end %>
     <tr>
-      <td class="position <%= @presenter.status_style_class(status) %>"><%= status[:expected] %></td>
-      <td class="position <%= @presenter.status_style_class(status) %>"><%= status[:actual] %></td>
+      <td class="position <%= @presenter.status_style_class(status[:status]) %>"><%= status[:expected] %></td>
+      <td class="position <%= @presenter.status_style_class(status[:status]) %>"><%= status[:actual] %></td>
+      <td><%= status[:request_data] %></td>
       <td><a href="<%= status[:target] %>"><%= status[:target] %></a></td>
       <td><%= status[:authority_name] %></td>
       <td><%= status[:subauthority_name] %></td>
@@ -100,4 +153,47 @@
 </div>
 <% end %>
 
+<% if @presenter.comparison_status_data? %>
+<div id="comparison-status-section" class="status-section">
+  <h3><%= t('qa_server.check_status.comparison_checks') %></h3>
+  <% auth_before =  @presenter.comparison_status_data.first[:authority_name][0]%>
+  <% auth_after =  @presenter.comparison_status_data.first[:authority_name][1]%>
+  <table class="status">
+    <tr>
+      <th class="comparison-header comparison-before bold-left-border" colspan=2><%= auth_before %><br><%= t('qa_server.check_status.status_table.before') %></th>
+      <th class="comparison-header comparison-after" colspan=2><%= auth_after %><br><%= t('qa_server.check_status.status_table.after') %></th>
+      <th class="comparison-header" colspan=7></th>
+    </tr>
+    <tr>
+      <th class="bold-left-border"><%= t('qa_server.check_status.status_table.expected_by_position') %></th>
+      <th><%= t('qa_server.check_status.status_table.actual_position') %></th>
+      <th class="bold-left-border"><%= t('qa_server.check_status.status_table.expected_by_position') %></th>
+      <th><%= t('qa_server.check_status.status_table.actual_position') %></th>
+      <th class="bold-left-border"><%= t('qa_server.check_status.status_table.request_data') %></th>
+      <th><%= t('qa_server.check_status.status_table.subject_uri') %></th>
+      <th><%= t('qa_server.check_status.status_table.subauthority') %></th>
+      <th><%= t('qa_server.check_status.status_table.service') %></th>
+      <th><%= t('qa_server.check_status.status_table.action') %></th>
+      <th><%= t('qa_server.check_status.status_table.url') %></th>
+      <th><%= t('qa_server.check_status.status_table.errmsg') %></th>
+    </tr>
+    <% @presenter.comparison_status_data.each do |status| %>
+    <tr>
+      <td class="position bold-left-border <%= @presenter.status_style_class(status[:status][0]) %>"><%= status[:expected][0] %></td>
+      <td class="position <%= @presenter.status_style_class(status[:status][0]) %>"><%= status[:actual][0] %></td>
+      <td class="position bold-left-border <%= @presenter.status_style_class(status[:status][1]) %>"><%= status[:expected][1] %></td>
+      <td class="position <%= @presenter.status_style_class(status[:status][1]) %>"><%= status[:actual][1] %></td>
+      <td class="bold-left-border"><%= status[:request_data] %></td>
+      <td><a href="<%= status[:target] %>"><%= status[:target] %></a></td>
+      <td><%= status[:subauthority_name] %></td>
+      <td><%= status[:service] %></td>
+      <td><%= status[:action] %></td>
+      <td><a href="<%= status[:url][0] %>"><%= status[:url][0] %></a>, <a href="<%= status[:url][1] %>"><%= status[:url][1] %></a></td>
+      <td><%= status[:err_message] %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>
+<% end %>
+
 </div>

data/config/i18n-tasks.yml

@@ -0,0 +1,133 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
+    - config/locales/**/*.%{locale}.yml
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  # External locale data (e.g. gems).
+  # This data is not considered unused and is never written to.
+  external:
+    ## Example (replace %#= with %=):
+    # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: conservative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/mailers
+  #   - app/presenters
+  #   - app/views
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+    - app/assets/videos
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # only: ["*.rb", "*.html.slim"]
+
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  # strict: true
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
+
+## Translation Services
+# translation:
+#   # Google Translate
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   google_translate_api_key: "AbC-dEf5"
+#   # DeepL Pro Translate
+#   # Get an API key and subscription at https://www.deepl.com/pro to use DeepL Pro
+#   deepl_api_key: "48E92789-57A3-466A-9959-1A1A1A1A1A1A"
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+# ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Exclude these keys from the `i18n-tasks check-consistent-interpolations` report:
+# ignore_inconsistent_interpolations:
+# - 'activerecord.attributes.*'
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       only: %w(*.html.haml *.html.slim),
+#       patterns: [['= title\b', '.page_title']] %>
+#
+# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>