qa_server 7.5.1 → 7.9.0

data/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios/mesh_nlm_ld4l_cache_validation.yml

@@ -14,10 +14,6 @@ search:
   -
     query: Malignant Hyperthermia
     subauth: subject
-  -
-    query: Spain
-    subauth: subject
-    result_size: 75
   -
     query: Address
     subauth: publication_type
@@ -26,7 +22,6 @@ search:
   #  Accuracy tests
   #------------------
   -
-    pending: true
     query: Malignant Hyperthermia
     subject_uri: "http://id.nlm.nih.gov/mesh/D008305"
     position: 3
@@ -47,6 +42,14 @@ search:
     position: 3
     replacements:
       maxRecords: '8'
+  -
+    pending: true
+    query: Spain
+    subauth: geographic
+    subject_uri: "http://id.nlm.nih.gov/mesh/D013030"
+    position: 3
+    replacements:
+      maxRecords: '8'
   -
     pending: true
     query: Email

data/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios/oclcfast_direct_validation.yml

@@ -26,12 +26,13 @@ search:
     replacements:
       maxRecords: '4'
 #  -
-#    query: War
+#    # This is an event at OCLCFAST web-search, but a meeting through OCLCFAST API.
+#    query: Bronze Night
 #    subauth: event_name
 #    replacements:
 #      maxRecords: '4'
   -
-    query: Festival
+    query: convention
     subauth: meeting
     replacements:
       maxRecords: '4'
@@ -71,7 +72,6 @@ search:
     replacements:
       maxRecords: '5'
   -
-    pending: true
     query: Sleep-overs
     subauth: concept
     subject_uri: "http://id.worldcat.org/fast/1120873"
@@ -79,6 +79,7 @@ search:
     replacements:
       maxRecords: '10'
   -
+    # This is a meeting in OCLCFAST_DIRECT, but event in OCLCFAST_LD4L_CACHE.
     pending: true
     query: People's International Tribunal on the Rights of Indigenous Hawaiians
     subauth: event
@@ -86,6 +87,13 @@ search:
     position: 3
     replacements:
       maxRecords: '8'
+  -
+    query: Science Fiction
+    subauth: meeting
+    subject_uri: "http://id.worldcat.org/fast/1406163"
+    position: 5
+    replacements:
+      maxRecords: '10'
   -
     pending: true
     query: University of Chicago Library
@@ -102,7 +110,6 @@ search:
     replacements:
       maxRecords: '20'
   -
-    pending: true
     query: Sjælland
     subauth: place
     result_size: 190
@@ -111,13 +118,12 @@ search:
     replacements:
       maxRecords: '10'
   -
-    pending: true
     query: Scream
     subauth: work
     subject_uri: "http://id.worldcat.org/fast/1358031"
-    position: 5
+    position: 10
     replacements:
-      maxRecords: '10'
+      maxRecords: '20'
 term:
   -
     identifier: '1914919'

data/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios/oclcfast_ld4l_cache_validation.yml

@@ -13,6 +13,9 @@ search:
   -
     query: tribunal
     subauth: event
+  -
+    query: convention
+    subauth: meeting
   -
     query: 'mark twain'
     subauth: person
@@ -32,7 +35,6 @@ search:
   #  Accuracy tests
   #------------------
   -
-    pending: true
     query: Tralee & Dingle Railway
     subject_uri: "http://id.worldcat.org/fast/1733583"
     position: 3
@@ -53,6 +55,14 @@ search:
     replacements:
       maxRecords: '8'
   -
+    query: Science Fiction
+    subauth: meeting
+    subject_uri: "http://id.worldcat.org/fast/1406163"
+    position: 5
+    replacements:
+      maxRecords: '10'
+  -
+    pending: true
     query: University of Chicago Library
     subauth: organization
     subject_uri: "http://id.worldcat.org/fast/539173"
@@ -78,10 +88,16 @@ search:
     query: Scream
     subauth: work
     subject_uri: "http://id.worldcat.org/fast/1358031"
-    position: 5
+    position: 10
+    replacements:
+      maxRecords: '20'
+  -
+    query: 'mark twain'
+    subauth: intangible
+    subject_uri: "http://id.worldcat.org/fast/1200561"
+    position: 3
     replacements:
       maxRecords: '10'
-
 term:
   -
     identifier: 'http://id.worldcat.org/fast/1914919'

data/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios/rda_registry_ld4l_cache_validation.yml

@@ -316,7 +316,6 @@ search:
     replacements:
       maxRecords: '20'
   -
-    pending: true
     query: polychrome
     subauth: colour_content
     position: 3
@@ -457,7 +456,6 @@ search:
     replacements:
       maxRecords: '20'
   -
-    pending: true
     query: unknown
     subauth: gender
     position: 3
@@ -556,7 +554,6 @@ search:
     replacements:
       maxRecords: '10'
   -
-    pending: true
     query: Hi 8
     subauth: video_format
     position: 3

data/lib/generators/qa_server/templates/config/initializers/qa_server.rb

@@ -24,6 +24,14 @@ QaServer.config do |config|
   # @param [Symbol] time period for calculating historical pass/fail (i.e., one of :month, :year, or :all)
   # config.historical_datatable_default_time_period = :year
 
+  # Threshold for percentage of queries that timed out after which it gets marked in the Authority Connection up-down History
+  # @param [Float] percentage of queries that are ok to timeout
+  # config.up_down_data_timeouts_max_threshold = 0.3
+
+  # Threshold for percentage of queries that are passing, below which are marked in the Authority Connection up-down History as barely_up
+  # @param [Float] required percentage of queries passing to be considered mostly-up when there are some failures
+  # config.up_down_data_mostly_up_threshold = 0.95
+
   # Displays a graph of performance test data when true
   # @param [Boolean] display performance graph when true
   # config.display_performance_graph = false

data/lib/qa_server/configuration.rb

@@ -73,6 +73,20 @@ module QaServer
       @historical_datatable_default_time_period ||= :year
     end
 
+    # Threshold for percentage of queries that timed out after which it gets marked in the Authority Connection up-down History
+    # @param [Float] percentage of queries that are ok to timeout
+    attr_writer :up_down_data_timeouts_max_threshold
+    def up_down_data_timeouts_max_threshold
+      @up_down_data_timeouts_max_threshold ||= 0.3
+    end
+
+    # Threshold for percentage of queries that are passing, below which are marked in the Authority Connection up-down History as barely_up
+    # @param [Float] required percentage of queries passing to be considered mostly-up when there are some failures
+    attr_writer :up_down_data_mostly_up_threshold
+    def up_down_data_mostly_up_threshold
+      @up_down_data_mostly_up_threshold ||= 0.95
+    end
+
     # Displays a graph of performance test data when true
     # @param [Boolean] display performance graph when true
     attr_writer :display_performance_graph

data/lib/qa_server/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module QaServer
-  VERSION = '7.5.1'
+  VERSION = '7.9.0'
 end

data/qa_server.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
   # Note: rails does not follow sem-ver conventions, it's
   # minor version releases can include breaking changes; see
   # http://guides.rubyonrails.org/maintenance_policy.html
-  spec.add_dependency 'rails', '~> 5.0' # Keep in sync with version supported by Hyrax
+  spec.add_dependency 'rails', '~> 5.2', '>= 5.2.5' # v5.2.5 required to address mimemagic gem yank
   spec.add_dependency 'useragent'
 
   # Required gems for QA and linked data access
-  spec.add_development_dependency 'qa', '~> 5.3'
+  spec.add_development_dependency 'qa', '~> 5.5', '>= 5.5.1' # questioning_authority
   spec.add_development_dependency 'linkeddata'
 
   # Produces dashboard charts on monitor status page
@@ -34,12 +34,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'better_errors' # provide debugging command line in
   spec.add_development_dependency 'binding_of_caller' # provides deep stack info used by better_errors
-  spec.add_development_dependency 'bixby', '~> 3.0.0' # rubocop styleguide
+  spec.add_development_dependency 'bixby', '~> 3.0', ">= 3.0.2" # rubocop styleguide
   # spec.add_development_dependency "capybara", '~> 3.29'
   # spec.add_development_dependency 'capybara-maleficent', '~> 0.3.0'
   # spec.add_development_dependency 'chromedriver-helper', '~> 2.1'
   spec.add_development_dependency 'deprecation'
-  spec.add_development_dependency 'engine_cart', '~> 2.0'
+  spec.add_development_dependency 'engine_cart', '~> 2.2'
   spec.add_development_dependency "factory_bot", '~> 4.4'
   spec.add_development_dependency 'i18n-tasks'
   spec.add_development_dependency 'simplecov'
@@ -49,7 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its', '~> 1.1'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'
   spec.add_development_dependency 'selenium-webdriver'
-  spec.add_development_dependency 'webdrivers', '~> 3.0'
+  spec.add_development_dependency 'webdrivers', '~> 4.4'
   spec.add_development_dependency 'webmock'
 
   ########################################################

data/spec/feature/accuracy_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe 'Accuracy test' do # rubocop:disable RSpec/DescribeClass
         it "finds actual <= expected" do
           pending 'test is known to fail' if test_result[:pending]
           expect(test_result[:err_message]).to be_empty
-          expect(test_result[:request_data]).not_to be_empty
+          expect(test_result[:request_data]).to be_present
           expect(test_result[:actual]).not_to be_nil
           expect(test_result[:actual]).to be <= test_result[:expected]
         end

data/spec/i18n_spec.rb

@@ -14,7 +14,6 @@ RSpec.describe I18n do
   end
 
   it 'does not have unused keys' do
-    pending 'need to explore unused keys further'
     expect(unused_keys).to be_empty,
                            "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end

data/spec/lib/configuration_spec.rb

@@ -86,6 +86,28 @@ RSpec.describe QaServer::Configuration do
     end
   end
 
+  describe '#up_down_data_timeouts_max_threshold' do
+    it 'return default as 0.3 (e.g. 30%)' do
+      expect(config.up_down_data_timeouts_max_threshold).to eq 0.3
+    end
+
+    it 'returns set value' do
+      config.up_down_data_timeouts_max_threshold = 0.25
+      expect(config.up_down_data_timeouts_max_threshold).to eq 0.25
+    end
+  end
+
+  describe '#up_down_data_mostly_up_threshold' do
+    it 'return default as 0.95 (e.g. 95%)' do
+      expect(config.up_down_data_mostly_up_threshold).to eq 0.95
+    end
+
+    it 'returns set value' do
+      config.up_down_data_mostly_up_threshold = 0.98
+      expect(config.up_down_data_mostly_up_threshold).to eq 0.98
+    end
+  end
+
   describe '#display_performance_graph?' do
     it 'return default as false' do
       expect(config.display_performance_graph?).to eq false

data/spec/presenters/qa_server/monitor_status/history_presenter_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe QaServer::MonitorStatus::HistoryPresenter do
+  let(:presenter) { described_class.new(parent: nil, historical_summary_data: historical_summary_data) }
+  # rubocop:disable Layout/ExtraSpacing
+  let(:historical_summary_data) do
+    # { 'auth_name' => { good: count_of_passing_tests, bad: count_of_failing_tests } }
+    {
+      'GOOD_AUTH'   => { good:    0, bad: 1000 },
+      'BARELY_GOOD' => { good:   49, bad:  951 },
+      'OK_AUTH'     => { good:   50, bad:  950 },
+      'STILL_OK'    => { good:   51, bad:  949 },
+      'BARELY_OK'   => { good:   99, bad:  901 },
+      'BAD_AUTH'    => { good:  100, bad:  900 },
+      'STILL_BAD'   => { good:  101, bad:  899 },
+      'REALLY_BAD'  => { good:  500, bad:  500 },
+      'HORRIBLE'    => { good: 1000, bad:    0 }
+    }
+    # rubocop:enable Layout/ExtraSpacing
+  end
+
+  describe '.failure_style_class' do
+    context 'returns NEUTRAL style' do
+      let(:expected_css_style) { "status-neutral" }
+      let(:zero_failure_entry) { ['GOOD_AUTH',   { good: 1000, bad:  0 }] } # rubocop:disable Layout/ExtraSpacing
+      let(:just_below_caution) { ['BARELY_GOOD', { good:  951, bad: 49 }] } # rubocop:disable Layout/ExtraSpacing
+
+      it 'when no failures' do
+        expect(presenter.failure_style_class(zero_failure_entry)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is just below the CAUTION_THRESHOLD' do
+        expect(presenter.failure_style_class(just_below_caution)).to eq expected_css_style
+      end
+    end
+
+    context 'returns CAUTION style' do
+      let(:expected_css_style) { "status-unknown" }
+      let(:equal_caution)      { ['OK_AUTH',   { good: 950, bad: 50 }] }
+      let(:just_above_caution) { ['STILL_OK',  { good: 949, bad: 51 }] }
+      let(:just_below_warning) { ['BARELY_OK', { good: 901, bad: 99 }] }
+
+      it 'when percent of failures is equal to CAUTION_THRESHOLD' do
+        expect(presenter.failure_style_class(equal_caution)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is just above CAUTION_THRESHOLD' do
+        expect(presenter.failure_style_class(just_above_caution)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is just below WARNING_THRESHOLD' do
+        expect(presenter.failure_style_class(just_below_warning)).to eq expected_css_style
+      end
+    end
+
+    context 'returns WARNING style' do
+      let(:expected_css_style) { "status-bad" }
+      let(:equal_warning)      { ['BAD_AUTH',   { good: 900, bad:  100 }] }
+      let(:just_above_warning) { ['STILL_BAD',  { good: 899, bad:  101 }] }
+      let(:well_above_warning) { ['REALLY_BAD', { good: 500, bad:  500 }] }
+      let(:all_failures)       { ['HORRIBLE',   { good:   0, bad: 1000 }] }
+
+      it 'when percent of failures is equal to WARNING_THRESHOLD' do
+        expect(presenter.failure_style_class(equal_warning)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is just above WARNING_THRESHOLD' do
+        expect(presenter.failure_style_class(just_above_warning)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is well above WARNING_THRESHOLD' do
+        expect(presenter.failure_style_class(well_above_warning)).to eq expected_css_style
+      end
+
+      it 'when percent of failures is 100%' do
+        expect(presenter.failure_style_class(all_failures)).to eq expected_css_style
+      end
+    end
+  end
+end

data/spec/services/qa_server/history_up_down_service_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe QaServer::HistoryUpDownService do
+  let(:service) { described_class.new }
+
+  context 'when total_count is 0' do
+    let(:good_count) { 0 }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { 0 }
+    let(:timeout_count) { 0 }
+    it 'returns :no_data' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :no_data
+    end
+  end
+
+  context 'when all queries failed' do
+    let(:good_count) { 0 }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { 5 }
+    let(:timeout_count) { 0 }
+    it 'returns :down' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :down
+    end
+  end
+
+  context 'when all queries passed' do
+    let(:good_count) { 5 }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { 0 }
+    let(:timeout_count) { 0 }
+    it 'returns :fully_up' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :fully_up
+    end
+  end
+
+  context 'when all queries are unknown' do
+    let(:good_count) { 0 }
+    let(:unknown_count) { 5 }
+    let(:bad_count) { 0 }
+    let(:timeout_count) { 0 }
+    it 'returns :barely_up' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :barely_up
+    end
+  end
+
+  context 'when too many queries timed out' do
+    let(:threshold) { 0.5 }
+    let(:good_count) { 100 - bad_count }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { timeout_count + 2 }
+    let(:timeout_count) { threshold * 100 + 1 }
+    it 'returns :good' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :timeouts
+    end
+  end
+
+  context 'when almost all queries pass' do
+    let(:threshold) { 0.95 }
+    let(:good_count) { threshold * 100 + 1 }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { 100 - good_count }
+    let(:timeout_count) { 0 }
+    it 'returns :good' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :mostly_up
+    end
+  end
+
+  context 'when too many queries fail' do
+    let(:threshold) { 0.95 }
+    let(:good_count) { threshold * 100 - 1 }
+    let(:unknown_count) { 0 }
+    let(:bad_count) { 100 - good_count }
+    let(:timeout_count) { 0 }
+    it 'returns :good' do
+      status = service.send(:status_determination, good_count, unknown_count, bad_count, timeout_count)
+      expect(status).to eq :barely_up
+    end
+  end
+end