us_core_test_kit 0.7.0 → 0.7.1

data/lib/us_core_test_kit/granular_scope.rb

@@ -0,0 +1,63 @@
+module USCoreTestKit
+  module GranularScope
+
+    def granular_scopes
+      @granular_scopes ||=
+        received_scopes
+          .split(' ')
+          .select do |scope|
+            (scope.start_with?("patient/#{resource_type}") || scope.start_with?("user/#{resource_type}")) &&
+              scope.include?('?')
+          end
+    end
+
+    def granular_scope_search_params
+      @granular_scope_search_params ||=
+        granular_scopes.map do |scope|
+          _, granular_scope = scope.split('?')
+          name, value = granular_scope.split('=')
+
+          {
+            name:,
+            value:
+          }
+        end
+    end
+
+    def resource_specific_granular_scope_search_params
+      @resource_specific_granular_scope_search_params ||=
+        granular_scopes.select {|scope| scope.include?(resource_type)}.map do |scope|
+          _, granular_scope = scope.split('?')
+          name, value = granular_scope.split('=')
+          _, value = value.split('|')
+          {
+            name:,
+            value:
+          }
+      end
+    end
+
+    def previous_request_resources
+      first_request = previous_requests.first
+      next_page_url = nil
+      hash = Hash.new { |hash, key| hash[key] = [] }
+      previous_requests.each_with_object(hash) do |request, request_resource_hash|
+        request_resources =
+          if request.status == 200
+            request.resource.entry.map(&:resource).select { |resource| resource.resourceType == resource_type }
+          else
+            []
+          end
+
+        first_request = request if request.url != next_page_url
+
+        request_resource_hash[first_request].concat(request_resources)
+
+        next if request.resource&.resourceType != 'Bundle'
+
+        next_page_url = request.resource&.link&.find { |link| link.relation == 'next' }&.url
+      end
+    end
+
+  end
+end

data/lib/us_core_test_kit/granular_scope_read_test.rb

@@ -0,0 +1,71 @@
+require_relative 'resource_search_param_checker'
+require_relative 'granular_scope'
+
+module USCoreTestKit
+  module GranularScopeReadTest
+    extend Forwardable
+    include ResourceSearchParamChecker
+    include GranularScope
+
+    def_delegators 'self.class', :metadata
+    def self.included(klass)
+      klass.input(:received_scopes)
+      klass.attr_accessor :previous_requests
+    end
+
+    def run_scope_read_test
+      assert granular_scopes.present?, "No granular scopes were received for #{resource_type} resources"
+      resource_scopes = granular_scopes.select {|scope| scope.include?(resource_type)}
+
+      load_previous_requests
+      skip_if previous_requests.blank?,
+              "No #{resource_type} reads found"
+      previous_resources_for_reads = previous_request_resources.values.flatten
+
+      resource_specific_granular_scope_search_params.each do |scope| 
+        current_scope = granular_scopes.find {|granular| granular.include?(scope[:name]) && granular.include?(scope[:value])}
+
+        resource_matching_scope = previous_resources_for_reads.find do |prev_resource| 
+          resource_matches_param?(prev_resource, scope[:name], scope[:value])
+        end
+        skip_if resource_matching_scope.nil?, "Unable to find any resources to match scope #{current_scope}"
+
+        fhir_read resource_type, resource_matching_scope.id
+
+        assert_response_status(200)
+        assert_resource_type(resource_type)
+      end
+
+      nonmatching_resource = previous_resources_for_reads.find do |prev_resource|
+        resource_specific_granular_scope_search_params.none? do |scope| 
+          resource_matches_param?(prev_resource, scope[:name], scope[:value])
+        end
+      end
+      if nonmatching_resource
+        fhir_read resource_type, nonmatching_resource.id
+        assert (response && response[:status]) != 200, "Server incorrectly responded with a successful status, read should fail due to scopes."
+        assert (resource && resource.resourceType != resource_type), "Server incorrectly returned a #{resource_type}, read should fail due to scopes"
+      else
+        info "Unable to find a resource that does not match scopes."
+      end
+    end
+    
+    def load_previous_requests
+      params = metadata.searches.first[:names]
+      search_params_as_hash = params.each_with_object({}) do |name, hash|
+        hash[name] = nil
+      end
+      @previous_requests ||=
+        load_tagged_requests(search_params_tag(search_params_as_hash))
+          .sort_by { |request| request.index }
+    end
+
+    def unescape_search_value(value)
+      value&.gsub('\\,', ',')
+    end
+
+    def search_params_tag(params)
+      "#{resource_type}?#{params.keys.join('&')}"
+    end
+  end
+end

data/lib/us_core_test_kit/{granular_scope_checker.rb → granular_scope_search_test.rb}

@@ -1,11 +1,17 @@
+require_relative 'resource_search_param_checker'
+require_relative 'granular_scope'
+
 module USCoreTestKit
-  module GranularScopeChecker
+  module GranularScopeSearchTest
+    include ResourceSearchParamChecker
+    include GranularScope
+
     def self.included(klass)
       klass.input(:received_scopes)
       klass.attr_accessor :previous_requests
     end
 
-    def run_scope_check_test
+    def run_scope_search_test
       assert granular_scopes.present?, "No granular scopes were received for #{resource_type} resources"
 
       load_previous_requests
@@ -47,51 +53,6 @@ module USCoreTestKit
       end
     end
 
-    def previous_request_resources
-      first_request = previous_requests.first
-      next_page_url = nil
-      hash = Hash.new { |hash, key| hash[key] = [] }
-      previous_requests.each_with_object(hash) do |request, request_resource_hash|
-        request_resources =
-          if request.status == 200
-            request.resource.entry.map(&:resource).select { |resource| resource.resourceType == resource_type }
-          else
-            []
-          end
-
-        first_request = request if request.url != next_page_url
-
-        request_resource_hash[first_request].concat(request_resources)
-
-        next if request.resource&.resourceType != 'Bundle'
-
-        next_page_url = request.resource&.link&.find { |link| link.relation == 'next' }&.url
-      end
-    end
-
-    def granular_scopes
-      @granular_scopes ||=
-        received_scopes
-          .split(' ')
-          .select do |scope|
-            (scope.start_with?("patient/#{resource_type}") || scope.start_with?("user/#{resource_type}")) &&
-              scope.include?('?')
-          end
-    end
-
-    def granular_scope_search_params
-      @granular_scope_search_params ||=
-        granular_scopes.map do |scope|
-          _, granular_scope = scope.split('?')
-          name, value = granular_scope.split('=')
-
-          {
-            name:,
-            value:
-          }
-        end
-    end
-
     def load_previous_requests
       search_params_as_hash = search_param_names.each_with_object({}) do |name, hash|
         hash[name] = nil

data/lib/us_core_test_kit/must_support_test.rb

@@ -115,12 +115,13 @@ module USCoreTestKit
               .map { |ex| ex[:url] }
 
             value_found = find_a_value_at(resource, path) do |value|
-              if value.respond_to?(:extension) && ms_extension_urls.present?
-                urls = value.extension.map(&:url)
+              if value.instance_of?(USCoreTestKit::PrimitiveType) && ms_extension_urls.present?
+                urls = value.extension&.map(&:url)
                 has_ms_extension = (urls & ms_extension_urls).present?
               end
 
               unless has_ms_extension
+                value = value.value if value.instance_of?(USCoreTestKit::PrimitiveType)
                 value_without_extensions =
                   value.respond_to?(:to_hash) ? value.to_hash.reject { |key, _| key == 'extension' } : value
               end

data/lib/us_core_test_kit/primitive_type.rb

@@ -0,0 +1,5 @@
+module USCoreTestKit
+  class PrimitiveType < FHIR::Element
+    attr_accessor :value
+  end
+end

data/lib/us_core_test_kit/provenance_validator.rb

@@ -19,11 +19,10 @@ module USCoreTestKit
 
       failed_provenance =
         find_a_value_at(resource, 'agent') do |agent|
-          ['Practitioner', 'Device'].any? { |resource_type| agent.who.reference&.include?(resource_type) } &&
-          agent.onBehalfOf.nil?
+          ['Practitioner', 'Device'].any? { |resource_type| agent.who&.reference&.include?(resource_type) } &&
+            agent.onBehalfOf.nil?
         end
 
-
       if failed_provenance.present?
         validation_messages << {
           type: 'error',
@@ -34,4 +33,4 @@ module USCoreTestKit
       validation_messages
     end
   end
-end
+end

data/lib/us_core_test_kit/resource_search_param_checker.rb

@@ -0,0 +1,139 @@
+require_relative 'fhir_resource_navigation'
+
+module USCoreTestKit
+  module ResourceSearchParamChecker
+    include FHIRResourceNavigation
+
+    def search_param_paths(name)
+      paths = metadata.search_definitions[name.to_sym][:paths]
+      if paths.first =='class'
+        paths[0] = 'local_class'
+      end
+
+      paths
+    end
+
+    def element_has_valid_value?(element, include_system)
+      case element
+      when FHIR::Reference
+        element.reference.present?
+      when FHIR::CodeableConcept
+        if include_system
+          coding =
+            find_a_value_at(element, 'coding') { |coding| coding.code.present? && coding.system.present? }
+          coding.present?
+        else
+          find_a_value_at(element, 'coding.code').present?
+        end
+      when FHIR::Identifier
+        include_system ? element.value.present? && element.system.present? : element.value.present?
+      when FHIR::Coding
+        include_system ? element.code.present? && element.system.present? : element.code.present?
+      when FHIR::HumanName
+        (element.family || element.given&.first || element.text).present?
+      when FHIR::Address
+        (element.text || element.city || element.state || element.postalCode || element.country).present?
+      when FHIR::Element
+        false
+      else
+        true
+      end
+    end
+
+    def resource_matches_param?(resource, search_param_name, escaped_search_value, values_found = [])
+      search_value = unescape_search_value(escaped_search_value)
+      paths = search_param_paths(search_param_name)
+
+      match_found = false
+
+      paths.each do |path|
+        type = metadata.search_definitions[search_param_name.to_sym][:type]
+        values_found =
+          resolve_path(resource, path)
+            .map do |value|
+          if value.is_a? FHIR::Reference
+            value.reference
+          else
+            value
+          end
+        end
+
+        match_found =
+          case type
+          when 'Period', 'date', 'instant', 'dateTime'
+            values_found.any? { |date| validate_date_search(search_value, date) }
+          when 'HumanName'
+            # When a string search parameter refers to the types HumanName and Address,
+            # the search covers the elements of type string, and does not cover elements such as use and period
+            # https://www.hl7.org/fhir/search.html#string
+            search_value_downcase = search_value.downcase
+            values_found.any? do |name|
+              name&.text&.downcase&.start_with?(search_value_downcase) ||
+                name&.family&.downcase&.start_with?(search_value_downcase) ||
+                name&.given&.any? { |given| given.downcase.start_with?(search_value_downcase) } ||
+                name&.prefix&.any? { |prefix| prefix.downcase.start_with?(search_value_downcase) } ||
+                name&.suffix&.any? { |suffix| suffix.downcase.start_with?(search_value_downcase) }
+            end
+          when 'Address'
+            search_value_downcase = search_value.downcase
+            values_found.any? do |address|
+              address&.text&.downcase&.start_with?(search_value_downcase) ||
+                address&.city&.downcase&.start_with?(search_value_downcase) ||
+                address&.state&.downcase&.start_with?(search_value_downcase) ||
+                address&.postalCode&.downcase&.start_with?(search_value_downcase) ||
+                address&.country&.downcase&.start_with?(search_value_downcase)
+            end
+          when 'CodeableConcept'
+            # FHIR token search (https://www.hl7.org/fhir/search.html#token): "When in doubt, servers SHOULD
+            # treat tokens in a case-insensitive manner, on the grounds that including undesired data has
+            # less safety implications than excluding desired behavior".
+            codings = values_found.flat_map(&:coding)
+            if search_value.include? '|'
+              system = search_value.split('|').first
+              code = search_value.split('|').last
+              codings&.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
+            else
+              codings&.any? { |coding| coding.code&.casecmp?(search_value) }
+            end
+          when 'Coding'
+            if search_value.include? '|'
+              system = search_value.split('|').first
+              code = search_value.split('|').last
+              values_found.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
+            else
+              values_found.any? { |coding| coding.code&.casecmp?(search_value) }
+            end
+          when 'Identifier'
+            if search_value.include? '|'
+              values_found.any? { |identifier| "#{identifier.system}|#{identifier.value}" == search_value }
+            else
+              values_found.any? { |identifier| identifier.value == search_value }
+            end
+          when 'string'
+            searched_values = search_value.downcase.split(/(?<!\\\\),/).map{ |string| string.gsub('\\,', ',') }
+            values_found.any? do |value_found|
+              searched_values.any? { |searched_value| value_found.downcase.starts_with? searched_value }
+            end
+          else
+            # searching by patient requires special case because we are searching by a resource identifier
+            # references can also be URLs, so we may need to resolve those URLs
+            if ['subject', 'patient'].include? search_param_name.to_s
+              id = search_value.split('Patient/').last
+              possible_values = [id, "Patient/#{id}", "#{url}/Patient/#{id}"]
+              values_found.any? do |reference|
+                possible_values.include? reference
+              end
+            else
+              search_values = search_value.split(/(?<!\\\\),/).map { |string| string.gsub('\\,', ',') }
+              values_found.any? { |value_found| search_values.include? value_found }
+            end
+          end
+
+        break if match_found
+      end
+
+      match_found
+    end
+    
+  end
+end

data/lib/us_core_test_kit/search_test.rb

@@ -1,5 +1,6 @@
 require_relative 'date_search_validation'
 require_relative 'fhir_resource_navigation'
+require_relative 'resource_search_param_checker'
 require_relative 'search_test_properties'
 
 module USCoreTestKit
@@ -7,6 +8,7 @@ module USCoreTestKit
     extend Forwardable
     include DateSearchValidation
     include FHIRResourceNavigation
+    include ResourceSearchParamChecker
 
     def_delegators 'self.class', :metadata, :provenance_metadata, :properties
     def_delegators 'properties',
@@ -629,6 +631,8 @@ module USCoreTestKit
             element.family || element.given&.first || element.text
           when FHIR::Address
             element.text || element.city || element.state || element.postalCode || element.country
+          when USCoreTestKit::PrimitiveType
+            element.value
           else
             if metadata.version != 'v3.1.1' &&
                metadata.search_definitions[name.to_sym][:type] == 'date' &&
@@ -676,8 +680,8 @@ module USCoreTestKit
         (element.family || element.given&.first || element.text).present?
       when FHIR::Address
         (element.text || element.city || element.state || element.postalCode || element.country).present?
-      when FHIR::Element
-        false
+      when USCoreTestKit::PrimitiveType
+        element.value.present?
       else
         true
       end

data/lib/us_core_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module USCoreTestKit
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end