qa_server 7.7.0 → 7.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57808d7b02e3ca992f1d927f43dd6630025451e6fb6c7cebab7ed2882acd79c9
-  data.tar.gz: 3ab76c0ebda5fd6e1ebe9811ff522bf0a7d13e0461b28a4b7a421ac5bdd66a18
+  metadata.gz: b0978259611a921fa54a761892e41d7248f1176274534d2760501abe367beeaa
+  data.tar.gz: 2db5881b75ef09978b4ed2a26c6f80aa18e7b18d5f947df8b3d0c2062672082b
 SHA512:
-  metadata.gz: 77d4103d2ff49636bf353f8d5ca93019fb2f477c90ff62e9f94832d9d7f387ed3be3f1577692025863882c53bbc38ae2020a1435a6d84379e73d1bee4bb06714
-  data.tar.gz: b99e3284b1e690236f83e088fd78ece19e743a995ad65342da4d8b75022e962b96478222529132d1965521a7a57e5c01a0b38cd5bc68e05fd6e709ea6c334970
+  metadata.gz: a25a399d6ac07235da877181c581307e80dbd8c562f3af789ddc580e14480520da1a3dd2201c5a1c631aba5b2f4d7f79172a2acb456348b763626abfaa79c40b
+  data.tar.gz: 023bbcb131e44ed281222c6b85a8e67028612027c11a4a432d3f99115ee0223b359a48c82892710b329958fd959840c210cc2957773e85556f18f6ae974a8ff8

data/.rubocop_fixme.yml

@@ -15,3 +15,7 @@ Style/SpecialGlobalVars:
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
+
+Layout/HashAlignment:
+  Exclude:
+    - 'spec/presenters/qa_server/monitor_status/history_presenter_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 7.7.1 (2021-04-14)
+
+* fix background colors in historical uptime table
+
 ### 7.7.0 (2021-04-13)
 
 * remove unused translations

data/app/presenters/qa_server/monitor_status/history_presenter.rb

@@ -7,6 +7,11 @@ module QaServer::MonitorStatus
 
     # @param parent [QaServer::MonitorStatusPresenter] parent presenter
     # @param historical_summary_data [Array<Hash>] summary of past failuring runs per authority to drive chart
+    # @example historical_summary_data
+    # {
+    #   "AGROVOC_DIRECT"=>{:good=>4, :bad=>0},
+    #   "AGROVOC_LD4L_CACHE"=>{:good=>4, :bad=>0}
+    # }
     def initialize(parent:, historical_summary_data:)
       @parent = parent
       @historical_summary_data = historical_summary_data
@@ -14,8 +19,10 @@ module QaServer::MonitorStatus
 
     # @return [Array<Hash>] historical test data to be displayed (authname, failing, passing)
     # @example
-    #   [ [ 'agrovoc', 0, 24 ],
-    #     [ 'geonames_ld4l_cache', 2, 22 ] ... ]
+    # {
+    #   "AGROVOC_DIRECT"=>{:good=>4, :bad=>0},
+    #   "AGROVOC_LD4L_CACHE"=>{:good=>4, :bad=>0}
+    # }
     def historical_summary
       @historical_summary_data
     end
@@ -72,47 +79,88 @@ module QaServer::MonitorStatus
       end
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] name of the authority (e.g. 'AUTH_NAME')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def historical_data_authority_name(historical_entry)
       historical_entry[0]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days with passing tests (e.g. 949)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_passing(historical_entry)
       historical_entry[1][:good]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days with failing tests (e.g. 51)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_failing(historical_entry)
       historical_entry[1][:bad]
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Integer] number of days tested (e.g. 1000)
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def days_authority_tested(historical_entry)
       days_authority_passing(historical_entry) + days_authority_failing(historical_entry)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [Float] percent of failing to passing tests (e.g. 0.05374 )
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def percent_authority_failing(historical_entry)
       days_authority_failing(historical_entry).to_f / days_authority_tested(historical_entry)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] percent of failing to passing tests (e.g. '5.4%')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def percent_authority_failing_str(historical_entry)
       ActiveSupport::NumberHelper.number_to_percentage(percent_authority_failing(historical_entry) * 100, precision: 1)
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] css class for background in Days Failing and Percent Failing columns (e.g. 'status-neutral', 'status-unknown', 'status-bad')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def failure_style_class(historical_entry)
-      return "status-neutral" if days_authority_failing(historical_entry) <= CAUTION_THRESHOLD
-      percent_authority_failing(historical_entry) < WARNING_THRESHOLD ? "status-unknown" : "status-bad"
+      case percent_authority_failing(historical_entry)
+      when 0.0...CAUTION_THRESHOLD
+        "status-neutral"
+      when CAUTION_THRESHOLD...WARNING_THRESHOLD
+        "status-unknown"
+      else
+        "status-bad"
+      end
     end
 
+    # @param historical_entry [Array<String,Hash>] data for a single authority including name, # passing tests (good), # failing tests (bad)
+    # @return [String] css class for background in Days Passing column (e.g. 'status-good', 'status-bad')
+    # @example historical_entry
+    #   [ 'AUTH_NAME',  { good: 949, bad: 51 } ]
     def passing_style_class(historical_entry)
       days_authority_passing(historical_entry) <= 0 ? "status-bad" : "status-good"
     end
 
+    # @return [Boolean] true if historical section should be visible; otherwise false
     def display_history_details?
       display_historical_graph? || display_historical_datatable?
     end
 
+    # @return [Boolean] true if historical graph should be visible; otherwise false
     def display_historical_graph?
       QaServer.config.display_historical_graph? && QaServer::HistoryGraphingService.history_graph_image_exists?
     end
 
+    # @return [Boolean] true if historical datatable should be visible; otherwise false
     def display_historical_datatable?
       QaServer.config.display_historical_datatable?
     end

data/lib/qa_server/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 7.7.0
+  version: 7.7.1
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -546,6 +546,7 @@ files:
 - spec/i18n_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/qa_server_spec.rb
+- spec/presenters/qa_server/monitor_status/history_presenter_spec.rb
 - spec/rails_helper.rb
 - spec/services/qa_server/time_period_service_spec.rb
 - spec/services/qa_server/time_service_spec.rb
@@ -584,6 +585,7 @@ test_files:
 - spec/i18n_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/qa_server_spec.rb
+- spec/presenters/qa_server/monitor_status/history_presenter_spec.rb
 - spec/rails_helper.rb
 - spec/services/qa_server/time_period_service_spec.rb
 - spec/services/qa_server/time_service_spec.rb