qa_server 0.1.99

data/app/assets/stylesheets/qa_server/_check-status.scss

@@ -0,0 +1,72 @@
+div.wait-message {
+  display: none;
+  font-family: "Arial", sans-serif;
+  margin-top: 50px;
+  margin-bottom: 50px;
+  margin-left: 90px;
+  margin-right: 90px;
+  border: 1px solid #b30000;
+  padding: 20px;
+  text-align: center;
+  background-color: #ffffe6;
+  color: #4d0000;
+  font-weight: bold;
+  font-size: 1.1em;
+}
+
+div#example-url-warning {
+  font-family: "Arial", sans-serif;
+  margin-top: 50px;
+  margin-bottom: 0px;
+  margin-left: 20px;
+  margin-right: 20px;
+  border: 1px solid #b30000;
+  padding: 10px;
+  color: #4d0000;
+}
+
+div.status-section {
+  margin-top: 50px;
+}
+
+div.validation-types {
+  margin-top: 20px;
+}
+
+table {
+  border-collapse: collapse;
+  margin-bottom: 20px;
+  background-color: white;
+}
+table, th, td {
+  border: 1px solid darkgray;
+  padding: 5px;
+}
+
+th {
+  background-color: #a1b1c4;
+  color: black;
+}
+
+td.position {
+  text-align: center;
+}
+
+.status-good {
+  text-align: center;
+  background-color: #ccffcc;
+}
+
+.status-unknown {
+  text-align: center;
+  background-color: #ffff99;
+}
+
+.status-bad {
+  text-align: center;
+  background-color: #ffcccc;
+}
+
+label.horizontal-list {
+  padding-right: 15px;
+}

data/app/assets/stylesheets/qa_server/_footer.scss

@@ -0,0 +1,20 @@
+img.footer-logo {
+  margin-top: 12px;
+  margin-bottom: 20px;
+  margin-left: 10px;
+  margin-right: 20px;
+  height: 32px;
+}
+
+div.footer-logos {
+  width: 100%;
+  text-align: center;
+}
+
+div.footer-logos a {
+  border: none;
+}
+
+footer {
+  margin-top: 50px;
+}

data/app/assets/stylesheets/qa_server/_header.scss

@@ -0,0 +1,51 @@
+img.header-logo {
+  float: left;
+  margin-top: 12px;
+  margin-left: 15px;
+  margin-bottom: 8px;
+  height: 64px;
+}
+
+/* Banner */
+.navbar-brand {
+  margin-top: 18px;
+}
+
+.institution-name {
+  color: whitesmoke;
+  font-size: 2em;
+  vertical-align: bottom;
+}
+
+div.navbar-header {
+  width: 100%;
+}
+
+ul.nav-menu, ul.nav-right-menu {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+  overflow: hidden;
+  background-color: #222;
+  width: 100%
+}
+
+ul.nav-menu li.left-menu {
+  float: left;
+}
+
+ul.nav-menu li.right-menu {
+  float: right;
+}
+
+ul.nav-menu li a, ul.nav-right-menu li a {
+  display: inline-block;
+  color: lightgrey;
+  text-align: center;
+  padding: 14px 16px;
+  text-decoration: none;
+}
+
+ul.nav-menu li a:hover, ul.nav-right-menuli a:hover {
+  background-color: dimgray;
+}

data/app/assets/stylesheets/qa_server/_home-page.scss

@@ -0,0 +1,15 @@
+div.page-description {
+  padding-bottom: 50px;
+}
+
+p.welcome, p.welcome2 {
+  padding-top: 50px;
+  padding-left: 225px;
+  padding-right: 225px;
+  font-size: 1.2em;
+  text-align: justify;
+}
+
+p.welcome2 {
+  padding-top: 10px;
+}

data/app/assets/stylesheets/qa_server/_monitor-status.scss

@@ -0,0 +1,13 @@
+table.dashboard-status td {
+  text-align: center;
+}
+
+a.dashboard-refresh {
+  margin-left: 20px;
+  color: #0088cc;
+}
+
+p.status-update-dtstamp {
+  color: darkred;
+  font-style: italic;
+}

data/app/assets/stylesheets/qa_server/_qa_server.scss

@@ -0,0 +1,36 @@
+@import 'qa_server/styles', 'qa_server/header', 'qa_server/footer', 'qa_server/home-page', 'qa_server/usage',
+        'qa_server/authorities', 'qa_server/check-status', 'qa_server/monitor-status';
+
+
+
+//@import 'hydra-editor/multi_value_fields';
+//@import 'qa_server/variables', 'qa_server/file_sets', 'qa_server/settings', 'qa_server/header',
+//        'qa_server/styles', 'qa_server/file-listing', 'qa_server/browse_everything_overrides',
+//        'qa_server/nestable', 'qa_server/collections', 'qa_server/collection_types', 'qa_server/batch-edit',
+//        'qa_server/home-page', 'qa_server/featured', 'qa_server/usage-stats', 'qa_server/catalog',
+//        'qa_server/buttons', 'qa_server/tinymce', 'qa_server/proxy-rights', 'qa_server/file-show',
+//        'qa_server/work-show', 'qa_server/modal', 'qa_server/forms', 'qa_server/form',
+//        'qa_server/file_manager', 'qa_server/form-progress', 'qa_server/positioning',
+//        'qa_server/fixedsticky', 'qa_server/file_upload', 'qa_server/representative-media',
+//        'qa_server/footer', 'qa_server/select_work_type', 'qa_server/users', 'qa_server/dashboard',
+//        'qa_server/sidebar', 'qa_server/controlled_vocabulary', 'qa_server/accessibility',
+//        'qa_server/recent', 'qa_server/viewer', 'qa_server/breadcrumbs';
+//@import 'typeahead';
+//@import 'sharing_buttons';
+//
+///* This class is to workaround an issue in which Bootstrap requires a div to display a tooltip
+// * on a disabled button. Using a span instead of a div would be ideal but unfortunately it does
+// * not render the tooltip correctly in all browsers (e.g. in Chrome the tooltip is detected in
+// * the wrong position). This class forces the div to render inline, just like a span.
+// *
+// * More info:
+// *    http://getbootstrap.com/css/#responsive-utilities-classes
+// *    http://stackoverflow.com/a/19938049/446681
+// */
+//.visible-all-inline-block {
+//  display: inline-block;
+//}
+//
+//.controlled_vocabulary {
+//  @extend .multi_value;
+//}

data/app/assets/stylesheets/qa_server/_styles.scss

@@ -0,0 +1,27 @@
+.container {
+  padding-left: 0px;
+  padding-right: 0px;
+}
+
+.ld4l-identity .container {
+  background: #303d4d none repeat scroll 0 0;
+}
+
+div#content-wrapper {
+  padding-left: 15px;
+  padding-right: 15px;
+}
+
+hr {
+  display: block;
+  height: 1px;
+  border: 0;
+  border-top: 1px solid #ccc;
+  margin: 1em 0;
+  padding: 0;
+  margin-top: 40px;
+}
+
+h4 {
+  margin-top: 40px;
+}

data/app/controllers/qa_server/authority_list_controller.rb

@@ -0,0 +1,14 @@
+# Controller for Authorities header menu item
+module QaServer
+  class AuthorityListController < AuthorityValidationController
+
+    class_attribute :presenter_class
+    self.presenter_class = AuthorityListPresenter
+
+    # Sets up presenter with data to display in the UI
+    def index
+      list(authorities_list)
+      @presenter = presenter_class.new(urls_data: status_data_from_log)
+    end
+  end
+end

data/app/controllers/qa_server/authority_validation_controller.rb

@@ -0,0 +1,77 @@
+module QaServer
+  class AuthorityValidationController < ApplicationController
+    layout 'qa_server'
+
+    attr_reader :status_data
+
+    class_attribute :validator_class,
+                    :lister_class,
+                    :logger_class
+
+    self.validator_class = AuthorityValidatorService
+    self.lister_class = AuthorityListerService
+    self.logger_class = ScenarioLogger
+
+    VALIDATION_TYPE_PARAM = :validation_type
+    VALIDATE_CONNECTIONS = 'connections'.freeze
+    VALIDATE_ACCURACY = 'accuracy'.freeze
+    ALL_VALIDATIONS = 'all_checks'.freeze
+    DEFAULT_VALIDATION_TYPE = validator_class::VALIDATE_CONNECTIONS
+
+    private
+
+      def status_log
+        @status_log ||= logger_class.new
+      end
+
+      def status_data_from_log
+        @status_data = status_log.to_a
+      end
+
+      def authorities_list
+        @authorities_list ||= lister_class.authorities_list
+      end
+
+      def validate(authorities_list, validation_type = DEFAULT_VALIDATION_TYPE)
+        return if authorities_list.blank?
+        authorities_list.each { |auth_name| validate_authority(auth_name, validation_type) }
+      end
+
+      def validate_authority(auth_name, validation_type)
+        validator_class.run(authority_name: auth_name, validation_type: validation_type, status_log: status_log)
+      end
+
+      def list(authorities_list)
+        return if authorities_list.blank?
+        authorities_list.each { |auth_name| list_scenarios(auth_name) }
+      end
+
+      def list_scenarios(auth_name)
+        lister_class.scenarios_list(authority_name: auth_name, status_log: status_log)
+      end
+
+      def validating_connections?
+        return true if validation_type == VALIDATE_CONNECTIONS || validation_type == ALL_VALIDATIONS
+        false
+      end
+
+      def validating_accuracy?
+        return true if validation_type == VALIDATE_ACCURACY || validation_type == ALL_VALIDATIONS
+        false
+      end
+
+      def validation_type
+        return @validation_type if @validation_type.present?
+        case
+        when params[VALIDATION_TYPE_PARAM] == ALL_VALIDATIONS
+          validator_class::ALL_VALIDATIONS
+        when params[VALIDATION_TYPE_PARAM] == VALIDATE_CONNECTIONS
+          validator_class::VALIDATE_CONNECTIONS
+        when params[VALIDATION_TYPE_PARAM] == VALIDATE_ACCURACY
+          validator_class::VALIDATE_ACCURACY
+        else
+          DEFAULT_VALIDATION_TYPE
+        end
+      end
+  end
+end

data/app/controllers/qa_server/check_status_controller.rb

@@ -0,0 +1,38 @@
+# Controller for Check Status header menu item
+module QaServer
+  class CheckStatusController < AuthorityValidationController
+
+    ALL_AUTHORITIES = '__all__'.freeze
+
+    class_attribute :presenter_class
+    self.presenter_class = CheckStatusPresenter
+
+    # Sets up presenter with data to display in the UI
+    def index
+      validate(authorities_to_validate, validation_type)
+      @presenter = presenter_class.new(authorities_list: authorities_list,
+                                       connection_status_data: connection_status_data_from_log,
+                                       accuracy_status_data: accuracy_status_data_from_log)
+    end
+
+    private
+
+      def connection_status_data_from_log
+        status_log.filter(type: validator_class::VALIDATE_CONNECTIONS)
+      end
+
+      def accuracy_status_data_from_log
+        status_log.filter(type: validator_class::VALIDATE_ACCURACY)
+      end
+
+      def authorities_to_validate
+        return [] unless authority_name.present?
+        (authority_name == ALL_AUTHORITIES) ? authorities_list : [authority_name]
+      end
+
+      def authority_name
+        return @authority_name if @authority_name.present?
+        @authority_name = (params.key? :authority) ? params[:authority].downcase : nil
+      end
+  end
+end

data/app/controllers/qa_server/homepage_controller.rb

@@ -0,0 +1,8 @@
+module QaServer
+  class HomepageController < ApplicationController
+    layout 'qa_server'
+
+    def index
+    end
+  end
+end

data/app/controllers/qa_server/monitor_status_controller.rb

@@ -0,0 +1,79 @@
+# Controller for Monitor Status header menu item
+module QaServer
+  class MonitorStatusController < AuthorityValidationController
+
+    class_attribute :presenter_class,
+                    :authority_status_model_class,
+                    :authority_status_failure_model_class
+
+    self.presenter_class = MonitorStatusPresenter
+    self.authority_status_model_class = AuthorityStatus
+    self.authority_status_failure_model_class = AuthorityStatusFailure
+
+    # Sets up presenter with data to display in the UI
+    def index
+      authority_status = latest_authority_status
+      if refresh? || expired_status? || authority_status.blank?
+        validate(authorities_list)
+        status_log.delete_passing
+        update_authority_status
+        authority_status = latest_authority_status
+      end
+      @authority_count = authorities_list.size
+      # TODO: Include historical data too
+      @presenter = presenter_class.new(authority_count: @authority_count,
+                                       authority_status: @latest_authority_status,
+                                       current_data: @status_data,
+                                       historical_data: [])
+      render 'index', :status => :internal_server_error if authority_status.failure_count.positive?
+    end
+
+    private
+
+      def latest_authority_status
+        @status_data ||= authority_status_model_class.latest_failures.to_a
+        @latest_authority_status ||= authority_status_model_class.latest
+      end
+
+      def update_authority_status
+        save_authority_status(status_log)
+        @status_data = status_data_from_log
+      end
+
+      def save_authority_status(status_log)
+        @latest_authority_status = authority_status_model_class.create(dt_stamp: dt_stamp_now_et,
+                                                                       test_count: status_log.test_count,
+                                                                       failure_count: status_log.failure_count)
+        status_log.to_a.each { |failure| save_authority_status_failure(@latest_authority_status, failure) }
+      end
+
+      def save_authority_status_failure(authority_status, failure)
+        authority_status_failure_model_class.create(authority_status_id: authority_status.id,
+                                                    status: failure[:status],
+                                                    status_label: failure[:status_label],
+                                                    authority_name: failure[:authority_name].to_s,
+                                                    subauthority_name: failure[:subauthority_name],
+                                                    service: failure[:service],
+                                                    action: failure[:action],
+                                                    url: failure[:url],
+                                                    err_message: failure[:err_message])
+      end
+
+      def expired_status?
+        status = latest_authority_status
+        status.blank? || status.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)")
+      end
+
+      def dt_stamp_now_et
+        Time.now.in_time_zone("Eastern Time (US & Canada)")
+      end
+
+      def refresh?
+        params.key? :refresh
+      end
+  end
+end

data/app/controllers/qa_server/usage_controller.rb

@@ -0,0 +1,8 @@
+module QaServer
+  class UsageController < ApplicationController
+    layout 'qa_server'
+
+    def index
+    end
+  end
+end

data/app/loggers/qa_server/scenario_logger.rb

@@ -0,0 +1,84 @@
+# Provide a log of scenario data and test results
+module QaServer
+  class ScenarioLogger
+    attr_reader :test_count, :failure_count
+
+    PASS = ScenarioValidator::PASS
+    FAIL = ScenarioValidator::FAIL
+    UNKNOWN = ScenarioValidator::UNKNOWN
+
+    def initialize(test_count = 0, failure_count = 0)
+      @log = []
+      @test_count = test_count
+      @failure_count = failure_count
+    end
+
+    # Add a scenario to the log
+    # @param authority_name [String] name of the authority the scenario was run against
+    # @param status [Symbol] indicating whether the scenario passed, failed, or has unknown status (see PASS, FAIL, UNKNOWN constants)
+    # @param validation_type [Symbol] the type of validation this status data describes (e.g. :connection, :accuracy)
+    # @param subauth [String] name of the subauthority the scenario was run against
+    # @param service [String] identifies the primary service provider (e.g. 'ld4l_cache', 'direct', etc.)
+    # @param action [String] type of scenario (i.e. 'term', 'search')
+    # @param url [String] example url that was used to test a specific term fetch or search query
+    # @param error_message [String] error message if scenario failed
+    # @param expected [Integer] the expected result (e.g. min size of result OR max position of subject within results)
+    # @param actual [Integer] the actual result (e.g. actual size of results OR actual position of subject within results)
+    # @param target [String] the expected target that was validated (e.g. subject_uri for query, pref label for term fetch)
+    def add(authority_name:, validation_type: '', status:, subauth: '', service: '', action: '', url: '', error_message: '', expected: nil, actual: nil, target: nil)
+      @test_count += 1
+      case status
+        when PASS
+          status_label = '√'
+        when UNKNOWN
+          status_label = '?'
+          @failure_count += 1
+        when FAIL
+          status_label = 'X'
+          @failure_count += 1
+      end
+      @log << { type: validation_type,
+                status: status,
+                status_label: status_label,
+                authority_name: authority_name,
+                subauthority_name: subauth,
+                service: service,
+                action: action,
+                url: url,
+                expected: expected,
+                actual: actual,
+                target: target,
+                err_message: error_message }
+    end
+
+    # Delete from the log any tests that passed.
+    def delete_passing
+      @log.delete_if { |entry| entry[:status] == PASS }
+    end
+
+    # Append a log to this log.
+    # @param [ScenarioLog] the log to append to this log
+    def append(other)
+      return unless other.present?
+      @log += other.to_a
+      @test_count += other.test_count
+      @failure_count += other.failure_count
+    end
+
+    # @return selected scenario test results data as an array limited to the specified type or all scenarios if type is nil
+    def filter(type: nil)
+      return @log if type.blank?
+      @log.select { |entry| entry[:type] == type }
+    end
+
+    # @return the scenario test results data as an array
+    def to_a
+      @log
+    end
+
+    # @return the number of scenarios recorded in the log
+    def size
+      to_a.size
+    end
+  end
+end

data/app/models/qa_server/authority_scenario.rb

@@ -0,0 +1,35 @@
+# Abstract class that parses the authority configuration from the yml file into the parts needed by inheriting scenario types.
+module QaServer
+  class AuthorityScenario
+
+    # @return [Qa::Authorities::LinkedData::GenericAuthority] authority instance the scenarios run against
+    attr_reader :authority
+
+    # @return [String] name of the authority the scenarios run against (e.g. 'agrovoc_direct')
+    attr_reader :authority_name
+
+    # @return [String] identifies the primary service provider (e.g. 'ld4l_cache', 'direct', etc.)
+    attr_reader :service
+
+    # @return [String] name of the subauthority the scenario runs against
+    attr_reader :subauthority_name
+
+    # @return [Integer] the minimum size of data that must be returned for the scenario to be considered passing
+    attr_reader :min_result_size
+
+    DEFAULT_SUBAUTH = nil
+    MIN_EXPECTED_SIZE = 200
+
+    # @param authority [Qa::Authorities::LinkedData::GenericAuthority] the instance of the QA authority
+    # @param authoity_name [String] the name of the authority the scenario tests (e.g. "agrovoc_direct")
+    # @param authority_scenario_config [Hash] configurations from the yml file that pertain to all scenarios regardless of type
+    # @param scenario_config [Hash] configuration from the yml file that are specific to a type of scenario
+    def initialize(authority:, authority_name:, authority_scenario_config:, scenario_config: nil)
+      @authority = authority
+      @authority_name = authority_name
+      @service = authority_scenario_config['service']
+      @subauthority_name = DEFAULT_SUBAUTH
+      @min_result_size = MIN_EXPECTED_SIZE
+    end
+  end
+end

data/app/models/qa_server/authority_status.rb

@@ -0,0 +1,18 @@
+# Provide access to the authority_status database table which tracks a summary of status data over time.
+module QaServer
+  class AuthorityStatus < ActiveRecord::Base
+    self.table_name = 'authority_status'
+    has_many :authority_status_failure, foreign_key: :authority_status_id
+
+    # Get the latest saved status.
+    def self.latest
+      last
+    end
+
+    # Get the latest set of failures, if any.
+    def self.latest_failures
+      return nil if latest.blank?
+      AuthorityStatusFailure.where(authority_status_id: latest.id)
+    end
+  end
+end

data/app/models/qa_server/authority_status_failure.rb

@@ -0,0 +1,7 @@
+# Provide access to the authority_status_failure database table which tracks specific failures over time.
+module QaServer
+  class AuthorityStatusFailure < ActiveRecord::Base
+    self.table_name = 'authority_status_failure'
+    belongs_to :authority_status
+  end
+end