qa_server 7.1.1 → 7.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b76bc4d754d7b4fde7b44483af5e442f7ec57866
-  data.tar.gz: 596c4ee549b8157470bbd184966cc5f136b19084
+  metadata.gz: c75de6851b1a52b9d4f482ef560bd0bae7107524
+  data.tar.gz: 25e2b0642efce7a0f73e260057248621d17f7e94
 SHA512:
-  metadata.gz: f05e9708ede292b5ffe541e45d2061731fb2822284cdfd3f9e43993eaa7adf940904e230b9d2591fb70dc879e372f48ffa87d95122ea9d14064b1989169847af
-  data.tar.gz: 41c0d98b7169ade0f5a18780d47a90bd6bdbfd888edca6c2f7606a332701903311704513210e0fb17f692876714a0fb6510eda4a8b48d9ceedabdf7144092786
+  metadata.gz: 145db9e102f9e88a48cb4e3fdd99687b70890d16751c8d9d43471eeeb126e478085ccce96f0e6d8a37170c91146c6e9704d2839ec899949acea0a88913ae16f6
+  data.tar.gz: 203aee3ca6a69164bf5f4b9ac6e6db49901d622e88a15521303c9815311e4f8182c74d7a8fd7485f57b848de3748081a42fcb5f4c0dedacfccb72bd6bf479405

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 7.1.2 (2020-02-21)
+
+* make configs that return true/false end with ?
+* add tests for configs that weren’t tested
+* fix bugs in config#convert_size_to_bytes in response to testing
+
 ### 7.1.1 (2020-02-21)
 
 * empty performance cache after running monitor status tests

data/app/cache_processors/qa_server/performance_cache.rb

@@ -59,7 +59,7 @@ module QaServer
       end
 
       def log(id:)
-        return if QaServer.config.suppress_logging_performance_datails
+        return if QaServer.config.suppress_logging_performance_datails?
         Rails.logger.debug("*** performance data for id: #{id} ***")
         Rails.logger.debug(@cache[id].to_yaml)
       end

data/app/prepends/prepended_linked_data/find_term.rb

@@ -3,7 +3,7 @@ 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
-    return super if QaServer.config.suppress_performance_gathering
+    return super if QaServer.config.suppress_performance_gathering?
     request_header = setup_find(request_header: request_header, language: language, replacements: replacements, subauth: subauth,
                                 format: format, performance_data: performance_data)
     @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'fetch')
@@ -40,7 +40,7 @@ module PrependedLinkedData::FindTerm
 
     # 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
+      return super if QaServer.config.suppress_performance_gathering?
 
       access_start_dt = QaServer::TimeService.current_time
 
@@ -55,7 +55,7 @@ module PrependedLinkedData::FindTerm
 
     # 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
+      return super if QaServer.config.suppress_performance_gathering?
       @performance_data == true
     end
 

data/app/prepends/prepended_linked_data/search_query.rb

@@ -3,7 +3,7 @@ module PrependedLinkedData::SearchQuery
   # Override Qa::Authorities::LinkedData::SearchQuery#search method
   # @return [String] json results for search query
   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
+    return super if QaServer.config.suppress_performance_gathering?
     request_header = setup_search(request_header: request_header, language: language, replacements: replacements, subauth: subauth,
                                   context: context, performance_data: performance_data)
     @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'search')
@@ -40,7 +40,7 @@ module PrependedLinkedData::SearchQuery
 
     # 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
+      return super if QaServer.config.suppress_performance_gathering?
 
       access_start_dt = QaServer::TimeService.current_time
 

data/app/prepends/prepended_rdf/rdf_graph.rb

@@ -12,7 +12,7 @@ module PrependedRdf::RdfGraph
   #   Set set graph name of each loaded statement
   # @return [void]
   def load(url, graph_name: nil, **options) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    return super if QaServer.config.suppress_performance_gathering
+    return super if QaServer.config.suppress_performance_gathering?
 
     raise TypeError, "#{self} is immutable" if immutable?
     phid, real_url = parse_phid(url)

data/lib/qa_server/configuration.rb

@@ -63,7 +63,7 @@ module QaServer
     # @param time_period [Symbol] time period for calculating historical pass/fail (i.e., one of :month, :year, or :all)
     # @raise [ArgumentError] if time_period is not one of :month, :year, or :all
     def historical_datatable_default_time_period=(time_period)
-      raise ArgumentError, 'time_period must be one of :day, :month, or :year' unless [:month, :year, :all].include? time_period
+      raise ArgumentError, 'time_period must be one of :month, :year, or :all' unless [:month, :year, :all].include? time_period
       @historical_datatable_default_time_period = time_period
     end
 
@@ -189,17 +189,23 @@ module QaServer
     # impact and may need to be suppressed.  Performance stats will not be gathered when this config is true.
     # @param [Boolean] do not gather performance data when true (defaults to false for backward compatibitily)
     attr_writer :suppress_performance_gathering
-    def suppress_performance_gathering
+    def suppress_performance_gathering?
+      return @suppress_performance_gathering unless @suppress_performance_gathering.nil?
       @suppress_performance_gathering ||= false
     end
+    alias suppress_performance_gathering suppress_performance_gathering?
+    deprecation_deprecate suppress_performance_gathering: "use #suppress_performance_gathering? instead"
 
     # Performance data is gathered on every incoming query.  Basic stats are logged from QA.  Full stats are logged
     # by QaServer and can eat up logging realestate.  To suppress the logging of details, set this config to true.
     # @param [Boolean] do not log performance data details when true (defaults to false for backward compatibitily)
     attr_writer :suppress_logging_performance_datails
-    def suppress_logging_performance_datails
+    def suppress_logging_performance_datails?
+      return @suppress_logging_performance_datails unless @suppress_logging_performance_datails.nil?
       @suppress_logging_performance_datails ||= false
     end
+    alias suppress_logging_performance_datails suppress_logging_performance_datails?
+    deprecation_deprecate suppress_logging_performance_datails: "use #suppress_logging_performance_datails? instead"
 
     # Maximum amount of memory the performance cache can occupy before it is written to the database.
     # @param [Integer] maximum size of performance cache before flushing
@@ -246,7 +252,9 @@ module QaServer
     private
 
       def convert_size_to_bytes(size)
+        return if size.nil?
         md = size.match(/^(?<num>\d+)\s?(?<unit>\w+)?$/)
+        return md[:num].to_i if md[:unit].nil?
         md[:num].to_i *
           case md[:unit].upcase
           when 'KB'

data/lib/qa_server/version.rb

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

data/spec/lib/configuration_spec.rb

@@ -62,6 +62,30 @@ RSpec.describe QaServer::Configuration do
     end
   end
 
+  describe '#historical_datatable_default_time_period=' do
+    it 'raises exception if time_period is invalid' do
+      expect { config.historical_datatable_default_time_period = :day }.to raise_error ArgumentError, 'time_period must be one of :month, :year, or :all'
+      expect { config.historical_datatable_default_time_period = :decade }.to raise_error ArgumentError, 'time_period must be one of :month, :year, or :all'
+    end
+
+    it 'sets time_period if valid' do
+      expect(config.historical_datatable_default_time_period = :month).to eq :month
+      expect(config.historical_datatable_default_time_period = :year).to eq :year
+      expect(config.historical_datatable_default_time_period = :all).to eq :all
+    end
+  end
+
+  describe '#historical_datatable_default_time_period' do
+    it 'return default as :year' do
+      expect(config.historical_datatable_default_time_period).to eq :year
+    end
+
+    it 'returns set value' do
+      config.historical_datatable_default_time_period = :month
+      expect(config.historical_datatable_default_time_period).to eq :month
+    end
+  end
+
   describe '#display_performance_graph?' do
     it 'return default as false' do
       expect(config.display_performance_graph?).to eq false
@@ -196,4 +220,99 @@ RSpec.describe QaServer::Configuration do
       expect(config.performance_datatable_warning_threshold).to eq 500
     end
   end
+
+  describe '#suppress_performance_gathering?' do
+    it 'return default as false' do
+      expect(config.suppress_performance_gathering?).to eq false
+    end
+
+    it 'returns set value' do
+      config.suppress_performance_gathering = true
+      expect(config.suppress_performance_gathering?).to eq true
+    end
+  end
+
+  describe '#suppress_logging_performance_datails?' do
+    it 'return default as false' do
+      expect(config.suppress_logging_performance_datails?).to eq false
+    end
+
+    it 'returns set value' do
+      config.suppress_logging_performance_datails = true
+      expect(config.suppress_logging_performance_datails?).to eq true
+    end
+  end
+
+  describe '#max_performance_cache_size' do
+    it 'return default as 32MB' do
+      expect(config.max_performance_cache_size).to eq 32.megabytes
+    end
+
+    it 'returns set value' do
+      config.max_performance_cache_size = 500
+      expect(config.max_performance_cache_size).to eq 500
+    end
+
+    context 'when value set through ENV' do
+      context 'when no unit specified' do
+        before { stub_const('ENV', 'MAX_PERFORMANCE_CACHE_SIZE' => '96') }
+        it 'sets value as is' do
+          expect(config.max_performance_cache_size).to eq 96
+        end
+      end
+
+      context 'when unit is KB' do
+        before { stub_const('ENV', 'MAX_PERFORMANCE_CACHE_SIZE' => '64KB') }
+        it 'sets value as is' do
+          expect(config.max_performance_cache_size).to eq 64.kilobytes
+        end
+      end
+
+      context 'when unit is MB' do
+        before { stub_const('ENV', 'MAX_PERFORMANCE_CACHE_SIZE' => '16mb') }
+        it 'sets value as is' do
+          expect(config.max_performance_cache_size).to eq 16.megabytes
+        end
+      end
+
+      context 'when unit is GB' do
+        before { stub_const('ENV', 'MAX_PERFORMANCE_CACHE_SIZE' => '8 gb') }
+        it 'sets value as is' do
+          expect(config.max_performance_cache_size).to eq 8.gigabytes
+        end
+      end
+    end
+  end
+
+  describe '#enable_performance_cache_logging' do
+    before { stub_const('ENV', 'PERFORMANCE_CACHE_LOG_PATH' => 'tmp/performance_cache.log') }
+    it 'sets logger level to DEBUG' do
+      config.enable_performance_cache_logging
+      expect(config.performance_cache_logger.level).to be Logger::DEBUG
+    end
+  end
+
+  describe '#disable_performance_cache_logging' do
+    before { stub_const('ENV', 'PERFORMANCE_CACHE_LOG_PATH' => 'tmp/performance_cache.log') }
+    it 'sets logger level to INFO' do
+      config.disable_performance_cache_logging
+      expect(config.performance_cache_logger.level).to be Logger::INFO
+    end
+  end
+
+  describe '#enable_monitor_status_logging' do
+    before { stub_const('ENV', 'MONITOR_LOG_PATH' => 'tmp/monitor.log') }
+    it 'sets logger level to DEBUG' do
+      config.enable_monitor_status_logging
+      expect(config.monitor_logger.level).to be Logger::DEBUG
+    end
+  end
+
+  describe '#disable_monitor_status_logging' do
+    before { stub_const('ENV', 'MONITOR_LOG_PATH' => 'tmp/monitor.log') }
+    it 'sets logger level to INFO' do
+      config.disable_monitor_status_logging
+      expect(config.monitor_logger.level).to be Logger::INFO
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.2
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -500,6 +500,7 @@ files:
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - tasks/qa_server_dev.rake
+- tmp/.keep
 homepage: http://github.com/LD4P/qa_server
 licenses:
 - Apache-2.0