Module: USCoreTestKit::GranularScopeSearchTest

Includes:
GranularScope, ResourceSearchParamChecker
Included in:
USCoreV610::ConditionPatientAbatementDateGranularScopeSearchTest, USCoreV610::ConditionPatientAssertedDateGranularScopeSearchTest, USCoreV610::ConditionPatientCategoryClinicalStatusGranularScopeSearchTest, USCoreV610::ConditionPatientCategoryEncounterGranularScopeSearchTest, USCoreV610::ConditionPatientCategoryGranularScopeSearchTest, USCoreV610::ConditionPatientClinicalStatusGranularScopeSearchTest, USCoreV610::ConditionPatientCodeGranularScopeSearchTest, USCoreV610::ConditionPatientGranularScopeSearchTest, USCoreV610::ConditionPatientOnsetDateGranularScopeSearchTest, USCoreV610::ConditionPatientRecordedDateGranularScopeSearchTest, USCoreV610::ObservationPatientCategoryDateGranularScopeSearchTest, USCoreV610::ObservationPatientCategoryGranularScopeSearchTest, USCoreV610::ObservationPatientCategoryStatusGranularScopeSearchTest, USCoreV610::ObservationPatientCodeDateGranularScopeSearchTest, USCoreV610::ObservationPatientCodeGranularScopeSearchTest, USCoreV700::ConditionPatientAbatementDateGranularScopeSearchTest, USCoreV700::ConditionPatientAssertedDateGranularScopeSearchTest, USCoreV700::ConditionPatientCategoryClinicalStatusGranularScopeSearchTest, USCoreV700::ConditionPatientCategoryEncounterGranularScopeSearchTest, USCoreV700::ConditionPatientCategoryGranularScopeSearchTest, USCoreV700::ConditionPatientClinicalStatusGranularScopeSearchTest, USCoreV700::ConditionPatientCodeGranularScopeSearchTest, USCoreV700::ConditionPatientGranularScopeSearchTest, USCoreV700::ConditionPatientLastupdatedGranularScopeSearchTest, USCoreV700::ConditionPatientOnsetDateGranularScopeSearchTest, USCoreV700::ConditionPatientRecordedDateGranularScopeSearchTest, USCoreV700::ObservationPatientCategoryDateGranularScopeSearchTest, USCoreV700::ObservationPatientCategoryGranularScopeSearchTest, USCoreV700::ObservationPatientCategoryLastupdatedGranularScopeSearchTest, USCoreV700::ObservationPatientCategoryStatusGranularScopeSearchTest, USCoreV700::ObservationPatientCodeDateGranularScopeSearchTest, USCoreV700::ObservationPatientCodeGranularScopeSearchTest, USCoreV800::ConditionPatientAbatementDateGranularScopeSearchTest, USCoreV800::ConditionPatientAssertedDateGranularScopeSearchTest, USCoreV800::ConditionPatientCategoryClinicalStatusGranularScopeSearchTest, USCoreV800::ConditionPatientCategoryEncounterGranularScopeSearchTest, USCoreV800::ConditionPatientCategoryGranularScopeSearchTest, USCoreV800::ConditionPatientClinicalStatusGranularScopeSearchTest, USCoreV800::ConditionPatientCodeGranularScopeSearchTest, USCoreV800::ConditionPatientGranularScopeSearchTest, USCoreV800::ConditionPatientLastupdatedGranularScopeSearchTest, USCoreV800::ConditionPatientOnsetDateGranularScopeSearchTest, USCoreV800::ConditionPatientRecordedDateGranularScopeSearchTest, USCoreV800::ObservationPatientCategoryDateGranularScopeSearchTest, USCoreV800::ObservationPatientCategoryGranularScopeSearchTest, USCoreV800::ObservationPatientCategoryLastupdatedGranularScopeSearchTest, USCoreV800::ObservationPatientCategoryStatusGranularScopeSearchTest, USCoreV800::ObservationPatientCodeDateGranularScopeSearchTest, USCoreV800::ObservationPatientCodeGranularScopeSearchTest
Defined in:
lib/us_core_test_kit/granular_scope_search_test.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GranularScope

#granular_scope_search_params, #granular_scopes, #previous_request_resources, #resource_specific_granular_scope_search_params

Methods included from ResourceSearchParamChecker

#element_has_valid_value?, #resource_matches_param?, #search_param_paths

Class Method Details

.included(klass) ⇒ Object 



9
10
11
12
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 9

def self.included(klass)
  klass.input(:received_scopes)
  klass.attr_accessor :previous_requests
end

Instance Method Details

#expected_resource_ids(resources) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 105

def expected_resource_ids(resources)
  resources
    .select { |resource| resource.resourceType == resource_type }
    .select do |resource|
      granular_scope_search_params.any? do |param|
        resource_matches_param?(resource, param[:name], param[:value])
      end
    end
    .map(&:id)
end

#granular_params_present?(granular_params, search_params) ⇒ Boolean 



83
84
85
86
87
88
89
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 83

def granular_params_present?(granular_params, search_params)
  CGI.parse(granular_params).each do |param_name, value|
    return false unless search_params.key?(param_name) && value.include?(search_params[param_name])
  end

  true
end

#load_previous_requests ⇒ Object 



59
60
61
62
63
64
65
66
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 59

def load_previous_requests
  search_params_as_hash = search_param_names.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

#mismatched_resource_ids(resources) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 116

def mismatched_resource_ids(resources)
  resources
    .select { |resource| resource.resourceType == resource_type }
    .reject do |resource|
      granular_scope_search_params.any? do |param|
        resource_matches_param?(resource, param[:name], param[:value])
      end
    end
    .map(&:id)
end

#previous_resources(params) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 91

def previous_resources(params)
  previous_requests(params)
    .flat_map do |request|
      resource = request.resource
      if resource.is_a?(FHIR::Bundle)
        resource.entry&.map(&:resource)
      else
        resource
      end
    end
    .compact
    .select { |resource| resource.resourceType == resource_type }
end

#query_in_scope?(resource_type, params) ⇒ Boolean 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 68

def query_in_scope?(resource_type, params)
  received_scopes.split(' ').each do |scope|
    parsed_scope = URI.parse(scope)
    
    # check for resource type, search scope, and matched params
    next unless parsed_scope.path =~ /\/#{resource_type}\./ &&
                parsed_scope.path.split('.')[1].include?('s') &&
                granular_params_present?(parsed_scope.query, params)
  
    return true
  end

  false
end

#run_scope_search_test ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/us_core_test_kit/granular_scope_search_test.rb', line 14

def run_scope_search_test
  assert granular_scopes.present?, "No granular scopes were received for #{resource_type} resources"

  load_previous_requests

  skip_if previous_requests.blank?,
          "No #{resource_type} searches with search params #{search_param_names.join(' & ')} found"

  previous_request_resources.each do |previous_request, all_previous_resources|
    search_method = previous_request.verb.to_sym
    params = search_method == :get ? previous_request.query_parameters : Hash[URI.decode_www_form(previous_request.request_body)]
    fhir_search(resource_type, params:, search_method:)

    found_resources =
      if request.status != 200
        []
      else
        fetch_all_bundled_resources(resource_type: resource_type, bundle: resource)
          .select { |resource| resource.resourceType == resource_type }
      end

    mismatched_ids = mismatched_resource_ids(found_resources)
    assert mismatched_ids.empty?,
           'Resources with the following ids were received even though they do not match the ' \
           "granted granular scopes: #{mismatched_ids.join(', ')}"

    # if the query is in scope or resource were returned, we must check missing and unexpected
    if query_in_scope?(resource_type, params) || found_resources.present?

      found_ids = found_resources.map(&:id)
      previous_ids = expected_resource_ids(all_previous_resources)

      missing_ids = previous_ids - found_ids
      assert missing_ids.empty?,
             'Resources with the following ids were received when using resource-level scopes, ' \
             "but not when using granular scopes: #{missing_ids.join(', ')}"

      unexpected_ids = found_ids - previous_ids
      assert unexpected_ids.empty?,
             'Resources with the following ids were received when using granular scopes, ' \
             "but not when using resource-level scopes: #{unexpected_ids.join(', ')}"
    end
  end
end