qa_server 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91196c2e5b8c6f31cb7c3e38e6fd7567cae793f8
-  data.tar.gz: 3fa8f94c8f584a7e9110d5a046bc5abf234e9f28
+  metadata.gz: 26e45e1d4aa00f3f8fd82cdd24e412477ea2b448
+  data.tar.gz: c42568892610df1b1be0fae23b5bf5ae9dae2e3a
 SHA512:
-  metadata.gz: 46dd223510421a7a72f1c1f507ea2e33b2dd1064595fafd783b17f9f555056cb44b5f6e744afd1b08dcbbbabe77fa309e73f5e7fe4d1c84280efa69dc443b45a
-  data.tar.gz: bcecafa888be4eeaf4dc6bfb44acd6b4b70b4b239e8de64b12138945e6c8930b268ad40487d14da36d8e8ab7a7779df2f472c9c1e70efbf659ca5c7d3d17efc9
+  metadata.gz: 4e80f46f48200d0788b687ac06ae49d93ee2530bd511465fa4e0f2203cd468c81765b13098aff93116168b85491e292353d7f0dc0fdb80d2b68bb0ee6c054233
+  data.tar.gz: 94d8b59f177c37c7458495586b4c4334afb38d6e40cf8d1324ca3f5b823d3c3d73d87d636a724356d362556649e716cf51f411f4876e447a71e3fdf1358cbb0c

data/.rubocop.yml

@@ -11,8 +11,14 @@ AllCops:
     - 'script/**/*'
     - 'spec/test_app_templates/**/*'
     - 'vendor/**/*'
-    - 'lib/hyrax/specs/**/*'
+    - 'lib/qa_server/specs/**/*'
 
 Lint/ImplicitStringConcatenation:
   Exclude:
     - 'lib/generators/qa_server/**/*'
+
+Metrics/BlockLength:
+  ExcludedMethods: ['included']
+  Exclude:
+    - 'qa_server.gemspec'
+    - 'spec/**/*.rb'

data/.rubocop_fixme.yml

@@ -8,3 +8,7 @@ Lint/RescueException:
 Lint/UnusedMethodArgument:
   Exclude:
     - 'app/models/qa_server/authority_scenario.rb'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'tasks/qa_server_dev.rake'

data/.travis.yml

@@ -0,0 +1,35 @@
+language: ruby
+sudo: required
+dist: trusty
+
+addons:
+  chrome: stable
+cache:
+  bundler: true
+
+before_install:
+  - gem update --system
+  - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
+
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test'
+  # Travis should check every minor version in a range of supported versions, because
+  # rails does not follow sem-ver conventions, see http://guides.rubyonrails.org/maintenance_policy.html
+  # 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.1.7"
+    - "RAILS_VERSION=5.2.3"
+
+services:
+  - redis-server
+before_script:
+  - jdk_switcher use oraclejdk8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 5.2.0 (2019-12-10)
+
+* cache performance data saving once a day when monitoring runs
+* set monitoring to expire at 3am ET by default (configurable)
+* setup travis-ci to run
+
 ### 5.1.0 (2019-12-10)
 
 * allow suppression of performance data gathering

data/Gemfile

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+source "https://rubygems.org"
+# git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Declare your gem's dependencies in qa_server.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
-gemspec
+gemspec path: File.expand_path('..', __FILE__)
+
+group :development, :test do
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+end
 
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
@@ -15,7 +20,6 @@ gemspec
 # To use a debugger
 # gem 'byebug', group: [:development, :test]
 
-# rubocop:disable Bundler/DuplicatedGem
 # BEGIN ENGINE_CART BLOCK
 # engine_cart: 1.1.0
 # engine_cart stanza: 0.10.0
@@ -31,6 +35,7 @@ if File.exist?(file)
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
 
+  # rubocop:disable Bundler/DuplicatedGem
   if ENV['RAILS_VERSION']
     if ENV['RAILS_VERSION'] == 'edge'
       gem 'rails', github: 'rails/rails'
@@ -41,6 +46,8 @@ else
   end
 
   case ENV['RAILS_VERSION']
+  when /^5.[12]/
+    gem 'sass-rails', '~> 5.0'
   when /^4.2/
     gem 'coffee-rails', '~> 4.1.0'
     gem 'responders', '~> 2.0'
@@ -48,8 +55,8 @@ else
   when /^4.[01]/
     gem 'sass-rails', '5.1.6'
   end
+  # rubocop:enable Bundler/DuplicatedGem
 end
 # END ENGINE_CART BLOCK
-# rubocop:enable Bundler/DuplicatedGem
 
 eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__)) unless File.exist?(file)

data/app/controllers/qa_server/monitor_status_controller.rb

@@ -44,11 +44,7 @@ module QaServer
       end
 
       def expired?
-        @expired ||= latest_summary.blank? || latest_summary.run_dt_stamp < yesterday_midnight_et
-      end
-
-      def yesterday_midnight_et
-        (DateTime.yesterday.midnight.to_time + 4.hours).to_datetime.in_time_zone("Eastern Time (US & Canada)")
+        @expired ||= latest_summary.blank? || latest_summary.run_dt_stamp < QaServer.monitoring_expires_at
       end
 
       def historical_summary_data(refresh: false)
@@ -116,8 +112,8 @@ module QaServer
       end
 
       def refresh_performance?
-        return false unless refresh?
-        refresh_all? || params[:refresh].casecmp?('performance')
+        return false unless refresh? || expired?
+        refresh_all? || params[:refresh].casecmp?('performance') || expired?
       end
   end
 end

data/app/models/qa_server/performance_cache.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+# Model to hold performance data in memory and ultimately write it out to the database
+module QaServer
+  class PerformanceCache
+    def initialize
+      @cache = {}
+    end
+
+    def new_entry(authority:, action:)
+      entry = { dt_stamp: QaServer.current_time,
+                authority: authority,
+                action: action }
+      id = SecureRandom.uuid
+      @cache[id] = entry
+      id
+    end
+
+    def update(id:, updates: {})
+      return false unless id && @cache.key?(id)
+      entry = @cache[id]
+      @cache[id] = entry.merge(updates)
+    end
+
+    def destroy(id)
+      @cache.delete(id)
+    end
+
+    def write_all
+      size_before = @cache.size
+      @cache.each do |id, entry|
+        next if incomplete? entry
+        QaServer::PerformanceHistory.create(dt_stamp: entry[:dt_stamp], authority: entry[:authority],
+                                            action: entry[:action], action_time_ms: entry[:action_time_ms],
+                                            size_bytes: entry[:size_bytes], retrieve_time_ms: entry[:retrieve_time_ms],
+                                            graph_load_time_ms: entry[:graph_load_time_ms],
+                                            normalization_time_ms: entry[:normalization_time_ms])
+        @cache.delete(id)
+      end
+      Rails.logger.warn("0 of #{size_before} performance data records were saved") if size_before.positive? && (size_before == @cache.size)
+      Rails.logger.info("#{size_before - @cache.size} of #{size_before} performance data records were saved") if size_before.positive? && (size_before > @cache.size)
+    end
+
+    def log(id:)
+      Rails.logger.info("*** performance data for id: #{id} ***")
+      Rails.logger.info(@cache[id].to_yaml)
+    end
+
+    private
+
+      def incomplete?(entry)
+        required_keys.each { |k| return true unless entry.key? k }
+        false
+      end
+
+      def required_keys
+        [:dt_stamp,
+         :authority,
+         :action,
+         :action_time_ms,
+         :size_bytes,
+         :retrieve_time_ms,
+         :graph_load_time_ms,
+         :normalization_time_ms]
+      end
+  end
+end

data/app/models/qa_server/performance_history.rb

@@ -18,9 +18,10 @@ module QaServer
       # Save a scenario result
       # @param authority [String] name of the authority
       # @param action [Symbol] type of action being evaluated (e.g. :fetch, :search)
+      # @param dt_stamp [Time] defaults to current time in preferred time zone
       # @return ActveRecord::Base for the new performance history record
-      def create_record(authority:, action:)
-        create(dt_stamp: Time.now.getlocal,
+      def create_record(authority:, action:, dt_stamp: QaServer.current_time)
+        create(dt_stamp: dt_stamp,
                authority: authority,
                action: action)
       end
@@ -65,6 +66,7 @@ module QaServer
       #   }
       def performance_data(datatype: :datatable)
         return if datatype == :none
+        QaServer.config.performance_cache.write_all
         data = calculate_data(datatype)
         graphing_service_class.create_performance_graphs(performance_data: data) if calculate_graphdata? datatype
         data
@@ -124,7 +126,7 @@ module QaServer
 
         def records_for_last_24_hours(auth_name)
           return unless expected_time_period == :day
-          end_hour = Time.now.getlocal
+          end_hour = QaServer.current_time
           start_hour = end_hour - 23.hours
           where_clause = { dt_stamp: start_hour..end_hour }
           records_for_authority(auth_name, where_clause)
@@ -132,7 +134,7 @@ module QaServer
 
         def records_for_last_30_days(auth_name)
           return unless expected_time_period == :month
-          end_day = Time.now.getlocal
+          end_day = QaServer.current_time
           start_day = end_day - 29.days
           where_clause = { dt_stamp: start_day..end_day }
           records_for_authority(auth_name, where_clause)
@@ -140,7 +142,7 @@ module QaServer
 
         def records_for_last_12_months(auth_name)
           return unless expected_time_period == :year
-          end_month = Time.now.getlocal
+          end_month = QaServer.current_time
           start_month = end_month - 11.months
           where_clause = { dt_stamp: start_month..end_month }
           records_for_authority(auth_name, where_clause)

data/app/prepends/prepended_linked_data/find_term.rb

@@ -2,20 +2,20 @@
 module PrependedLinkedData::FindTerm
   # Override Qa::Authorities::LinkedData::FindTerm#find method
   # @return [Hash] single term results in requested format
-  def find(id, request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists
+  def find(id, request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists, Metrics/CyclomaticComplexity
     return super if QaServer.config.suppress_performance_gathering
 
-    start_time_s = Time.now.to_f
+    start_time_s = QaServer.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
-    ph_record = QaServer::PerformanceHistory.create_record(authority: authority_name, action: 'fetch')
-    @phid = ph_record.id
+
+    @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'fetch')
     begin
       full_results = super
       update_performance_history_record(full_results, start_time_s)
     rescue Exception => e # rubocop:disable Lint/RescueException
-      ph_record.destroy
+      QaServer.config.performance_cache.destroy(@phid)
       raise e
     end
     saved_performance_data || !full_results.is_a?(Hash) ? full_results : full_results[:results]
@@ -24,25 +24,25 @@ module PrependedLinkedData::FindTerm
   private
 
     def update_performance_history_record(full_results, start_time_s)
-      ph_record = QaServer::PerformanceHistory.find(@phid)
-      return ph_record.destroy unless full_results.is_a?(Hash) && full_results.key?(:performance)
-      ph_record.action_time_ms = (Time.now.to_f - start_time_s) * 1000
-      ph_record.size_bytes = full_results[:performance][:fetched_bytes]
-      ph_record.retrieve_plus_graph_load_time_ms = full_results[:performance][:fetch_time_s] * 1000
-      ph_record.normalization_time_ms = full_results[:performance][:normalization_time_s] * 1000
-      ph_record.save
+      return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
+      updates = { action_time_ms: (QaServer.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.log(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
 
-      access_start_dt = Time.now.utc
+      access_start_dt = QaServer.current_time
 
       url += "&phid=#{@phid}"
       @full_graph = graph_service.load_graph(url: url)
 
-      access_end_dt = Time.now.utc
+      access_end_dt = QaServer.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")

data/app/prepends/prepended_linked_data/search_query.rb

@@ -5,17 +5,17 @@ module PrependedLinkedData::SearchQuery
   def search(query, request_header: {}, language: nil, replacements: {}, subauth: nil, context: false, performance_data: false) # rubocop:disable Metrics/ParameterLists
     return super if QaServer.config.suppress_performance_gathering
 
-    start_time_s = Time.now.to_f
+    start_time_s = QaServer.current_time_s
     request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, context: context, performance_data: performance_data) if request_header.empty?
     saved_performance_data = performance_data || request_header[:performance_data]
     request_header[:performance_data] = true
-    ph_record = QaServer::PerformanceHistory.create_record(authority: authority_name, action: 'search')
-    @phid = ph_record.id
+
+    @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'search')
     begin
       full_results = super
       update_performance_history_record(full_results, start_time_s)
     rescue Exception => e # rubocop:disable Lint/RescueException
-      ph_record.destroy
+      QaServer.config.performance_cache.destroy(@phid)
       raise e
     end
     requested_results(full_results, saved_performance_data)
@@ -24,25 +24,25 @@ module PrependedLinkedData::SearchQuery
   private
 
     def update_performance_history_record(full_results, start_time_s)
-      ph_record = QaServer::PerformanceHistory.find(@phid)
-      return ph_record.destroy unless full_results.is_a?(Hash) && full_results.key?(:performance)
-      ph_record.action_time_ms = (Time.now.to_f - start_time_s) * 1000
-      ph_record.size_bytes = full_results[:performance][:fetched_bytes]
-      ph_record.retrieve_plus_graph_load_time_ms = full_results[:performance][:fetch_time_s] * 1000
-      ph_record.normalization_time_ms = full_results[:performance][:normalization_time_s] * 1000
-      ph_record.save
+      return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
+      updates = { action_time_ms: (QaServer.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.log(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
 
-      access_start_dt = Time.now.utc
+      access_start_dt = QaServer.current_time
 
       url += "&phid=#{@phid}"
       @full_graph = graph_service.load_graph(url: url)
 
-      access_end_dt = Time.now.utc
+      access_end_dt = QaServer.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")

data/app/prepends/prepended_rdf/rdf_graph.rb

@@ -16,13 +16,13 @@ module PrependedRdf::RdfGraph
 
     raise TypeError, "#{self} is immutable" if immutable?
     phid, real_url = parse_phid(url)
-    ph_record = QaServer::PerformanceHistory.find(phid)
+    performance_udpates = {}
     start_time_s = Time.now.to_f
 
     reader = RDF::Reader.open(real_url, { base_uri: real_url }.merge(options))
 
     end_time_s = Time.now.to_f
-    ph_record.retrieve_time_ms = (end_time_s - start_time_s) * 1000
+    performance_udpates[:retrieve_time_ms] = (end_time_s - start_time_s) * 1000
     QaServer.config.performance_tracker.write "#{format('%.6f', end_time_s - start_time_s)}, " # read data
 
     start_time_s = Time.now.to_f
@@ -41,8 +41,8 @@ module PrependedRdf::RdfGraph
     end
 
     end_time_s = Time.now.to_f
-    ph_record.graph_load_time_ms = (end_time_s - start_time_s) * 1000
-    ph_record.save
+    performance_udpates[:graph_load_time_ms] = (end_time_s - start_time_s) * 1000
+    QaServer.config.performance_cache.update(id: phid, updates: performance_udpates)
     QaServer.config.performance_tracker.write "#{format('%.6f', end_time_s - start_time_s)}, " # load graph
   end
 

data/app/presenters/concerns/qa_server/monitor_status/performance_datatable_behavior.rb

@@ -106,7 +106,7 @@ module QaServer::MonitorStatus
 
       def unsupported_action?(stats)
         values = stats.values
-        return true if values.all? &:zero?
+        return true if values.all?(&:zero?)
         values.any? { |v| v.respond_to?(:nan?) && v.nan? }
       end
 

data/app/services/qa_server/performance_graphing_service.rb

@@ -82,7 +82,7 @@ module QaServer
 
         def rework_performance_data_for_gruff(performance_data, label_key)
           labels = {}
-          full_load_data = []
+          # full_load_data = []
           retrieve_data = []
           graph_load_data = []
           normalization_data = []
@@ -100,7 +100,9 @@ module QaServer
           # create the graph using the old :load stat when both :retrieve and :graph_load are 0. If the value truly
           # is 0, then :load will also be 0.
           # NOTE: It's ok to use AVG_RETR for the retrieve data point because it is 0.
+          # rubocop:disable Style/TernaryParentheses
           (data[STATS][AVG_RETR].zero? && data[STATS][AVG_GRPH].zero?) ? data[STATS][AVG_LOAD] : data[STATS][AVG_GRPH]
+          # rubocop:enable Style/TernaryParentheses
         end
 
         def performance_graph_theme(g, x_axis_label)

data/app/validators/qa_server/scenario_validator.rb

@@ -59,15 +59,15 @@ module QaServer
       # Runs the test in the block passed by the specific scenario type.
       # @return [Symbol] :good (PASS) or :unknown (UNKNOWN) based on whether enough results were returned
       def test_connection(min_expected_size: MIN_EXPECTED_SIZE, scenario_type_name:)
-        dt_start = Time.now.utc
+        dt_start = QaServer.current_time
         results = yield if block_given?
-        dt_end = Time.now.utc
+        dt_end = QaServer.current_time
         actual_size = results.to_s.length
         status = actual_size > min_expected_size ? PASS : UNKNOWN
         errmsg = status == PASS ? '' : "#{scenario_type_name.capitalize} scenario unknown status; cause: Results actual size (#{actual_size} < expected size (#{min_expected_size})"
         log(status: status, error_message: errmsg, normalization_run_time: (dt_end - dt_start)) # TODO: need to get run times from results
       rescue Exception => e
-        dt_end = Time.now.utc
+        dt_end = QaServer.current_time
         log(status: FAIL, error_message: "Exception executing #{scenario_type_name} scenario; cause: #{e.message}", request_run_time: (dt_end - dt_start))
       end
 

data/app/validators/qa_server/search_scenario_validator.rb

@@ -40,9 +40,9 @@ module QaServer
 
       # Runs the accuracy test and log results
       def test_accuracy(subject_uri:, expected_by_position:)
-        dt_start = Time.now.utc
+        dt_start = QaServer.current_time
         results = yield if block_given?
-        dt_end = Time.now.utc
+        dt_end = QaServer.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
@@ -50,7 +50,7 @@ module QaServer
 
         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 = Time.now.utc
+        dt_end = QaServer.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))
       end

data/lib/qa_server/configuration.rb

@@ -1,6 +1,24 @@
 # frozen_string_literal: true
 module QaServer
   class Configuration
+    # Preferred time zone for reporting historical data and performance data
+    # @param [String] time zone name
+    # @see https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html for possible values of TimeZone names
+    attr_writer :preferred_time_zone_name
+    def preferred_time_zone_name
+      @preferred_time_zone_name ||= 'Eastern Time (US & Canada)'
+    end
+
+    # Preferred hour to run monitoring tests
+    # @param [Integer] count of hours from midnight (0-23 with 0=midnight)
+    # @example
+    #   For preferred_time_zone_name of ET, use 3 for slow down at midnight PT/3am ET
+    #   For preferred_time_zone_name of PT, use 0 for slow down at midnight PT/3am ET
+    attr_writer :hour_offset_to_run_monitoring_tests
+    def hour_offset_to_run_monitoring_tests
+      @hour_offset_to_run_monitoring_tests ||= 3
+    end
+
     # Displays a graph of historical test data when true
     # @param [Boolean] display history graph when true
     attr_writer :display_historical_graph
@@ -122,5 +140,9 @@ module QaServer
     def suppress_performance_gathering
       @suppress_performance_gathering ||= false
     end
+
+    def performance_cache
+      @performance_cache ||= QaServer::PerformanceCache.new
+    end
   end
 end

data/lib/qa_server/version.rb

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

data/lib/qa_server.rb

@@ -21,4 +21,17 @@ module QaServer
 
     @config
   end
+
+  def self.current_time
+    Time.now.in_time_zone(QaServer.config.preferred_time_zone_name)
+  end
+
+  def self.current_time_s
+    current_time.to_f
+  end
+
+  def self.monitoring_expires_at
+    offset = QaServer.config.hour_offset_to_run_monitoring_tests
+    (current_time - offset.hours).beginning_of_day + offset.hours
+  end
 end

data/qa_server.gemspec

@@ -34,10 +34,24 @@ 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', '~> 1.0.0' # rubocop styleguide
-  # spec.add_development_dependency 'capybara', '~> 2.13'
+  # 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 'engine_cart', '~> 2.0'
+  spec.add_development_dependency "factory_bot", '~> 4.4'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rails-controller-testing', '~> 1'
   spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
   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 'selenium-webdriver'
+  spec.add_development_dependency 'webdrivers', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+
+  ########################################################
+  # Temporarily pinned dependencies. INCLUDE EXPLANATIONS.
+  #
+  # Pin sass-rails to 5.x because rails 5.x apps have this same dependency in their generated Gemfiles
+  spec.add_dependency 'sass-rails', '~> 5.0'
 end

data/spec/lib/qa_server_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe QaServer do
+  # rubocop:disable RSpec/MessageChain
+  let(:timezone_name) { 'Eastern Time (US & Canada)' }
+  describe '.current_time' do
+    before do
+      allow(described_class).to receive_message_chain(:config, :preferred_time_zone_name).and_return(timezone_name)
+      allow(Time).to receive(:now).and_return(DateTime.parse('2019-12-11 05:00:00 -0500').in_time_zone(timezone_name))
+    end
+
+    it 'returns the time in the preferred time zone' do
+      puts 'Running QaServer.current_time spec'
+      expect(described_class.current_time.zone).to eq 'EST'
+    end
+  end
+
+  describe '.monitoring_expires_at' do
+    before do
+      allow(described_class).to receive_message_chain(:config, :hour_offset_to_run_monitoring_tests).and_return(3)
+    end
+
+    context 'when current hour is after offset time' do
+      before do
+        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 05:00:00 -0500').in_time_zone(timezone_name))
+      end
+
+      it 'returns expiration on current date at offset time' do
+        puts 'Running QaServer.monitoring_expires_at when current hour is after offset time spec'
+        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-11 03:00:00 -0500').in_time_zone(timezone_name)
+      end
+    end
+
+    context 'when current hour is before offset time' do
+      before do
+        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 01:00:00 -0500').in_time_zone(timezone_name))
+      end
+
+      it 'returns expiration on previous date at offset time' do
+        puts 'Running QaServer.monitoring_expires_at when current hour is before offset time spec'
+        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-10 03:00:00 -0500').in_time_zone(timezone_name)
+      end
+    end
+  end
+  # rubocop:enable RSpec/MessageChain
+end

data/spec/spec_helper.rb

@@ -1,283 +1,64 @@
 # frozen_string_literal: true
-ENV["RAILS_ENV"] ||= 'test'
-require "bundler/setup"
+require 'linkeddata'
+require 'json'
+require 'engine_cart'
+require 'simplecov'
+require 'coveralls'
+require 'byebug' unless ENV['TRAVIS']
 
-def coverage_needed?
-  ENV['COVERAGE'] || ENV['TRAVIS']
-end
+ENV["RAILS_ENV"] ||= "test"
 
-if coverage_needed?
-  require 'simplecov'
-  require 'coveralls'
-  SimpleCov.root(File.expand_path('../..', __FILE__))
-  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-  SimpleCov.start('rails') do
-    add_filter '/.internal_test_app'
-    add_filter '/lib/generators'
-    add_filter '/spec'
-    add_filter '/tasks'
-    add_filter '/lib/qa_server/version.rb'
-    add_filter '/lib/qa_server/engine.rb'
-  end
-  SimpleCov.command_name 'spec'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start('rails') do
+  add_filter '/.internal_test_app'
+  add_filter '/lib/generators'
+  add_filter '/spec'
+  add_filter '/tasks'
+  add_filter '/lib/qa/version.rb'
+  add_filter '/lib/qa/engine.rb'
 end
+SimpleCov.command_name 'spec'
 
-require 'factory_bot'
-require 'engine_cart'
 EngineCart.load_application!
+Coveralls.wear!
 
-# require 'devise'
-# require 'devise/version'
-# require 'mida'
-require 'rails-controller-testing'
 require 'rspec/rails'
-require 'rspec/its'
-require 'rspec/matchers'
-require 'rspec/active_model/mocks'
-require 'capybara/rspec'
-require 'capybara/rails'
-require 'selenium-webdriver'
-# require 'equivalent-xml'
-# require 'equivalent-xml/rspec_matchers'
-# require 'database_cleaner' # TODO: Explore whether to include database cleaner
-
-unless ENV['SKIP_MALEFICENT']
-  # See https://github.com/jeremyf/capybara-maleficent
-  # Wrap Capybara matchers with sleep intervals to reduce fragility of specs.
-  require 'capybara/maleficent/spindle'
-
-  Capybara::Maleficent.config do |c|
-    # Quieting down maleficent's logging
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::INFO
-    c.logger = logger
-  end
-end
-
-# Require supporting ruby files from spec/support/ and subdirectories.  Note: engine, not Rails.root context.
-Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
-
 require 'webmock/rspec'
-WebMock.disable_net_connect!(allow_localhost: true)
+# require 'pry'
 
-require 'i18n/debug' if ENV['I18N_DEBUG']
-require 'byebug' unless ENV['TRAVIS']
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
 
-# @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux
-#       container build environments to mitigate Meltdown/Spectre
-#       vulnerabilities, at which point Qa Server could no longer use the
-#       Capybara-provided :selenium_chrome_headless driver (which does not
-#       include the `--no-sandbox` argument).
-Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
-  browser_options = ::Selenium::WebDriver::Chrome::Options.new
-  browser_options.args << '--headless'
-  browser_options.args << '--disable-gpu'
-  browser_options.args << '--no-sandbox'
-  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
-end
+RSpec.configure do |config|
+  config.fixture_path = File.expand_path("../fixtures", __FILE__)
 
-Capybara.default_driver = :rack_test # This is a faster driver
-Capybara.javascript_driver = :selenium_chrome_headless_sandboxless # This is slower
+  config.use_transactional_fixtures = true
 
-# ActiveJob::Base.queue_adapter = :test
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
 
-# require 'http_logger'
-# HttpLogger.logger = Logger.new(STDOUT)
-# HttpLogger.ignore = [/localhost:8983\/solr/]
-# HttpLogger.colorize = false
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
 
-# if defined?(ClamAV)
-#   ClamAV.instance.loaddb
-# else
-#   class ClamAV
-#     include Singleton
-#     def scanfile(_f)
-#       0
-#     end
-#
-#     def loaddb
-#       nil
-#     end
-#   end
-# end
+  # Disable Webmock if we choose so we can test against the authorities, instead of their mocks
+  WebMock.disable! if ENV["WEBMOCK"] == "disabled"
 
-# class JsonStrategy
-#   def initialize
-#     @strategy = FactoryBot.strategy_by_name(:create).new
-#   end
-#
-#   delegate :association, to: :@strategy
-#
-#   def result(evaluation)
-#     @strategy.result(evaluation).to_json
-#   end
-# end
-#
-# FactoryBot.register_strategy(:json, JsonStrategy)
-# FactoryBot.definition_file_paths = [File.expand_path("../factories", __FILE__)]
-# FactoryBot.find_definitions
+  config.infer_spec_type_from_file_location!
+end
 
-module EngineRoutes
-  def self.included(base)
-    base.routes { QaServer::Engine.routes }
-  end
+def webmock_fixture(fixture)
+  File.new File.expand_path(File.join("../fixtures", fixture), __FILE__)
+end
 
-  def main_app
-    Rails.application.class.routes.url_helpers
+# returns the file contents
+def load_fixture_file(fname)
+  File.open(Rails.root.join('spec', 'fixtures', fname)) do |f|
+    return f.read
   end
 end
-
-# require 'shoulda/matchers'
-# require 'shoulda/callback/matchers'
-# Shoulda::Matchers.configure do |config|
-#   config.integrate do |with|
-#     with.test_framework :rspec
-#     with.library :rails
-#   end
-# end
-
-# require 'active_fedora/cleaner'
-# RSpec.configure do |config|
-#   config.disable_monkey_patching!
-#   config.include Shoulda::Matchers::ActiveRecord, type: :model
-#   config.include Shoulda::Matchers::ActiveModel, type: :form
-#   config.include Shoulda::Callback::Matchers::ActiveModel
-#   config.full_backtrace = true if ENV['TRAVIS']
-#   config.expect_with :rspec do |c|
-#     c.syntax = :expect
-#   end
-#
-#   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-#   config.fixture_path = File.expand_path("../fixtures", __FILE__)
-#
-#   config.use_transactional_fixtures = false
-#
-#   config.before :suite do
-#     DatabaseCleaner.clean_with(:truncation)
-#     # Noid minting causes extra LDP requests which slow the test suite.
-#     QaServer.config.enable_noids = false
-#   end
-#
-#   config.before do |example|
-#     if example.metadata[:type] == :feature && Capybara.current_driver != :rack_test
-#       DatabaseCleaner.strategy = :truncation
-#     else
-#       DatabaseCleaner.strategy = :transaction
-#       DatabaseCleaner.start
-#     end
-#
-#     # using :workflow is preferable to :clean_repo, use the former if possible
-#     # It's important that this comes after DatabaseCleaner.start
-#     ensure_deposit_available_for(user) if example.metadata[:workflow]
-#     if example.metadata[:clean_repo]
-#       ActiveFedora::Cleaner.clean!
-#       # The JS is executed in a different thread, so that other thread
-#       # may think the root path has already been created:
-#       ActiveFedora.fedora.connection.send(:init_base_path) if example.metadata[:js]
-#     end
-#     QaServer.config.nested_relationship_reindexer = if example.metadata[:with_nested_reindexing]
-#                                                    # Use the default relationship reindexer (and the cascading reindexing of child documents)
-#                                                    QaServer.config.default_nested_relationship_reindexer
-#                                                  else
-#                                                    # Don't use the nested relationship reindexer. This slows everything down quite a bit.
-#                                                    ->(id:, extent:) {}
-#                                                  end
-#   end
-
-# config.include(ControllerLevelHelpers, type: :view)
-# config.before(:each, type: :view) { initialize_controller_helpers(view) }
-#
-# config.before(:all, type: :feature) do
-#   # Assets take a long time to compile. This causes two problems:
-#   # 1) the profile will show the first feature test taking much longer than it
-#   #    normally would.
-#   # 2) The first feature test will trigger rack-timeout
-#   #
-#   # Precompile the assets to prevent these issues.
-#   visit "/assets/application.css"
-#   visit "/assets/application.js"
-# end
-#
-# config.after do
-#   DatabaseCleaner.clean
-# end
-#
-# # If true, the base class of anonymous controllers will be inferred
-# # automatically. This will be the default behavior in future versions of
-# # rspec-rails.
-# config.infer_base_class_for_anonymous_controllers = false
-#
-# config.include Shoulda::Matchers::Independent
-#
-# if Devise::VERSION >= '4.2'
-#   config.include Devise::Test::ControllerHelpers, type: :controller
-# else
-#   config.include Devise::TestHelpers, type: :controller
-# end
-#
-# config.include EngineRoutes, type: :controller
-# config.include Warden::Test::Helpers, type: :request
-# config.include Warden::Test::Helpers, type: :feature
-# config.after(:each, type: :feature) do
-#   Warden.test_reset!
-#   Capybara.reset_sessions!
-#   page.driver.reset!
-# end
-#
-# config.include Capybara::RSpecMatchers, type: :input
-# config.include InputSupport, type: :input
-# config.include FactoryBot::Syntax::Methods
-# config.include OptionalExample
-#
-# config.infer_spec_type_from_file_location!
-#
-# config.expect_with :rspec do |expectations|
-#   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-# end
-#
-# config.formatter = 'LoggingFormatter'
-# config.default_formatter = 'doc' if config.files_to_run.one?
-#
-# config.order = :random
-# Kernel.srand config.seed
-#
-# config.shared_context_metadata_behavior = :apply_to_host_groups
-#
-# config.filter_run_when_matching :focus
-#
-# config.example_status_persistence_file_path = 'spec/examples.txt'
-#
-# config.profile_examples = 10
-#
-# # Use this example metadata when you want to perform jobs inline during testing.
-# #
-# #   describe '#my_method`, :perform_enqueued do
-# #     ...
-# #   end
-# #
-# # If you pass an `Array` of job classes, they will be treated as the filter list.
-# #
-# #   describe '#my_method`, perform_enqueued: [MyJobClass] do
-# #     ...
-# #   end
-# #
-# # Limit to specific job classes with:
-# #
-# #   ActiveJob::Base.queue_adapter.filter = [JobClass]
-# #
-# config.before(:example, :perform_enqueued) do |example|
-#   ActiveJob::Base.queue_adapter.filter =
-#     example.metadata[:perform_enqueued].try(:to_a)
-#
-#   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = true
-#   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
-# end
-#
-# config.after(:example, :perform_enqueued) do
-#   ActiveJob::Base.queue_adapter.filter         = nil
-#   ActiveJob::Base.queue_adapter.enqueued_jobs  = []
-#   ActiveJob::Base.queue_adapter.performed_jobs = []
-#
-#   ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = false
-#   ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = false
-# end

data/tasks/qa_server_dev.rake

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
-require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 require 'engine_cart/rake_task'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+
 desc 'Run style checker'
 RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
   task.fail_on_error = true
 end
 
-RSpec::Core::RakeTask.new(:spec)
-
-desc 'Generate the engine_cart and spin up test servers and run specs'
-task ci: ['rubocop', 'engine_cart:generate'] do
-  puts 'running continuous integration'
-  Rake::Task['spec_with_app_load'].invoke
+desc "Run continuous integration build"
+task ci: ['engine_cart:generate'] do
+  Rake::Task['spec'].invoke
 end
+
+desc 'Run continuous integration build'
+task ci: ['rubocop', 'spec']
+
+task default: :ci

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec-activemodel-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +220,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: A rails engine with questioning authority gem installed to serve as an
   authority search server with normalized results.
 email:
@@ -177,6 +289,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_fixme.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -209,6 +322,7 @@ files:
 - app/models/qa_server/authority_scenario.rb
 - app/models/qa_server/authority_status.rb
 - app/models/qa_server/authority_status_failure.rb
+- app/models/qa_server/performance_cache.rb
 - app/models/qa_server/performance_history.rb
 - app/models/qa_server/scenario_run_history.rb
 - app/models/qa_server/scenario_run_registry.rb
@@ -329,6 +443,7 @@ files:
 - lib/tasks/qa_server_tasks.rake
 - qa_server.gemspec
 - spec/.gitignore
+- spec/lib/qa_server_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
@@ -360,6 +475,7 @@ specification_version: 4
 summary: Authority Lookup Server
 test_files:
 - spec/.gitignore
+- spec/lib/qa_server_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra