davinci_crd_test_kit 0.9.0

data/lib/davinci_crd_test_kit/cards_validation.rb

@@ -0,0 +1,234 @@
+require_relative 'server_hook_request_validation'
+require_relative 'suggestion_actions_validation'
+
+module DaVinciCRDTestKit
+  module CardsValidation
+    include DaVinciCRDTestKit::ServerHookRequestValidation
+    include DaVinciCRDTestKit::SuggestionActionsValidation
+
+    HOOKS = [
+      'appointment-book', 'encounter-discharge', 'encounter-start',
+      'order-dispatch', 'order-select', 'order-sign'
+    ].freeze
+
+    def card_required_fields
+      { 'summary' => String, 'indicator' => String, 'source' => Hash }
+    end
+
+    def source_required_fields
+      { 'label' => String, 'topic' => Hash }
+    end
+
+    def source_topic_required_fields
+      { 'code' => String, 'system' => String }
+    end
+
+    def card_optional_fields
+      {
+        'uuid' => String,
+        'detail' => String,
+        'suggestions' => Array,
+        'overrideReasons' => Array,
+        'links' => Array
+      }
+    end
+
+    def override_reasons_required_fields
+      { 'code' => String, 'system' => String, 'display' => String }
+    end
+
+    def link_required_fields
+      { 'label' => String, 'type' => String, 'url' => 'URL' }
+    end
+
+    def valid_card_with_optionals?(card)
+      current_error_count = messages.count { |msg| msg[:type] == 'error' }
+      card_optional_fields.each do |field, type|
+        next unless card[field]
+
+        validate_presence_and_type(card, field, type, 'Card')
+      end
+
+      card_selection_behavior_check(card)
+      card_override_reasons_check(card)
+      card_links_check(card)
+      card_suggestions_check(card)
+
+      current_error_count == messages.count { |msg| msg[:type] == 'error' }
+    end
+
+    def card_selection_behavior_check(card)
+      return unless card['suggestions'].present?
+
+      selection_behavior = card['selectionBehavior']
+      unless selection_behavior
+        add_message('error', "`Card.selectionBehavior` must be provided if suggestions are present. In Card `#{card}`")
+        return
+      end
+
+      allowed_values = ['at-most-one', 'any']
+      return if allowed_values.include?(selection_behavior)
+
+      error_msg = "`selectionBehavior` #{selection_behavior} not allowed. " \
+                  "Allowed values: #{allowed_values.to_sentence}. In Card `#{card}`"
+      add_message('error', error_msg)
+    end
+
+    def card_override_reasons_check(card)
+      return unless card['overrideReasons'].is_a?(Array)
+
+      card['overrideReasons'].each do |reason|
+        override_reasons_required_fields.each do |field, type|
+          validate_presence_and_type(reason, field, type, 'OverrideReason Coding')
+        end
+      end
+    end
+
+    def card_links_check(card)
+      return unless card['links'].is_a?(Array) && card['links'].present?
+
+      card['links'].each do |link|
+        link_required_fields.each do |field, type|
+          validate_presence_and_type(link, field, type, 'Link')
+        end
+
+        card_link_type_check(card, link)
+      end
+    end
+
+    def card_link_type_check(card, link)
+      return unless link['type']
+
+      unless ['absolute', 'smart'].include?(link['type'])
+        add_message('error',
+                    "`Link.type` must be `absolute` or `smart`. Got `#{link['type']}`: `#{link}`. In Card `#{card}`")
+        return
+      end
+
+      return unless link['type'] == 'absolute' && link['appContext'].present?
+
+      msg = '`appContext` field should only be valued if the link type is smart and is not valid for absolute links: ' \
+            "`#{link}`. In Card `#{card}`"
+      add_message('error', msg)
+    end
+
+    def card_suggestions_check(card)
+      return unless card['suggestions'].is_a?(Array) && card['suggestions'].present?
+
+      card['suggestions'].each do |suggestion|
+        process_suggestion(card, suggestion)
+      end
+    end
+
+    def process_suggestion(card, suggestion)
+      validate_presence_and_type(suggestion, 'label', String, 'Suggestion')
+      return unless suggestion['actions']
+
+      validate_and_process_actions(card, suggestion)
+    end
+
+    def validate_and_process_actions(card, suggestion)
+      actions = suggestion['actions']
+      if !actions.is_a?(Array)
+        add_message('error', "Suggestion `actions` field is not of type Array: `#{suggestion}`. In Card `#{card}`")
+        return
+      elsif actions.empty?
+        add_message('error',
+                    "Suggestion `actions` field should not be an empty Array: `#{suggestion}`. In Card `#{card}`")
+        return
+      end
+
+      actions.each do |action|
+        action_fields_validation(action)
+      end
+    end
+
+    def card_source_check(card)
+      source = card['source']
+      return unless source.is_a?(Hash)
+
+      source_required_fields.each do |field, type|
+        validate_presence_and_type(source, field, type, 'Source')
+      end
+
+      card_source_topic_check(source['topic'])
+      # TODO: How to validate topic binding to the ValueSet CRD Card Types?
+    end
+
+    def card_source_topic_check(topic)
+      return unless topic.is_a?(Hash)
+
+      source_topic_required_fields.each do |field, type|
+        validate_presence_and_type(topic, field, type, 'Source topic')
+      end
+    end
+
+    def card_summary_check(card)
+      return if !card['summary'].is_a?(String) || card['summary'].length < 140
+
+      add_message('error', "`summary` is over the 140-character limit: `#{card}`")
+    end
+
+    def card_indicator_check(card)
+      return if !card['indicator'].is_a?(String) || ['info', 'warning', 'critical'].include?(card['indicator'])
+
+      msg = "`indicator` is `#{card['indicator']}`. Allowed values are `info`, `warning`, `critical`: `#{card}`"
+      add_message('error', msg)
+    end
+
+    def cards_check(cards)
+      cards.each do |card|
+        current_error_count = messages.count { |msg| msg[:type] == 'error' }
+        card_required_fields.each do |field, type|
+          validate_presence_and_type(card, field, type, 'Card')
+        end
+
+        card_summary_check(card)
+        card_indicator_check(card)
+        card_source_check(card)
+
+        valid_cards << card if current_error_count == messages.count { |msg| msg[:type] == 'error' }
+      end
+    end
+
+    def perform_cards_validation(cards, response_index = 0)
+      unless cards
+        add_message('error', "Server response #{response_index + 1} did not have the `cards` field.")
+        return
+      end
+      unless cards.is_a?(Array)
+        add_message('error', "`cards` field of server response #{response_index + 1} is not an array.")
+        return
+      end
+      warning do
+        assert cards.present?, "Server response #{response_index + 1} has no decision support."
+      end
+      cards_check(cards)
+    end
+
+    def all_requests
+      @all_requests ||= HOOKS.each_with_object([]) do |hook, reqs|
+        load_tagged_requests(hook)
+        reqs.concat(requests)
+      end
+    end
+
+    def extract_all_valid_cards_from_hooks_responses
+      all_requests.keep_if { |request| request.status == 200 }
+      all_requests.each_with_index do |request, index|
+        service_response = JSON.parse(request.response_body)
+        perform_cards_validation(service_response['cards'], index)
+      rescue JSON::ParserError
+        add_message('error', "Invalid JSON: server response #{index + 1} is not a valid JSON.")
+      end
+    end
+
+    def extract_valid_cards_with_links_from_hooks_responses
+      extract_all_valid_cards_from_hooks_responses
+
+      valid_cards.each do |card|
+        valid_cards_with_links << card if valid_card_with_optionals?(card) && (card['links'])
+      end
+    end
+  end
+end