carin_for_blue_button_test_kit 0.9.0

data/lib/carin_for_blue_button_test_kit/generator/search_definition_metadata_extractor.rb

@@ -0,0 +1,207 @@
+require_relative 'value_extractor'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class SearchDefinitionMetadataExtractor
+      attr_accessor :ig_resources, :name, :resource, :profile_elements
+
+      def initialize(name, ig_resources, resource, profile_elements)
+        self.name = name
+        self.ig_resources = ig_resources
+        self.resource = resource
+        self.profile_elements = profile_elements
+      end
+
+      def search_definition
+        @search_definition ||=
+          {
+            paths: paths,
+            full_paths: full_paths,
+            comparators: comparators,
+            values: values,
+            type: type,
+            contains_multiple: contains_multiple?,
+            multiple_or: multiple_or_expectation,
+            chain: chain
+          }.compact
+      end
+
+      def param
+        @param ||= ig_resources.search_param_by_resource_and_name(resource, name)
+      end
+
+      def param_hash
+        if !param.nil?
+            param.source_hash
+        else
+            nil
+        end
+      end
+
+      def full_paths
+        @full_paths ||=
+          begin
+            if !param.nil?
+                path = param.expression.gsub(/.where\((.*)/, '')
+                path = path[1..-2] if path.start_with?('(') && path.end_with?(')')
+                path.scan(/[. ]as[( ]([^)]*)[)]?/).flatten.map do |as_type|
+                path.gsub!(/[. ]as[( ](#{as_type}[^)]*)[)]?/, as_type.upcase_first) if as_type.present?
+                end
+                path.split('|')
+            else
+                []
+            end
+          end
+      end
+
+      def paths
+        @paths ||= full_paths.map { |a_path| a_path.gsub("#{resource}.", '') }
+      end
+
+      def profile_element
+        @profile_element ||=
+          profile_elements.find { |element| full_paths.include?(element.id) }
+      end
+
+      def comparator_expectation_extensions
+        @comparator_expectation_extensions ||= param_hash['_comparator'] || []
+      end
+
+      def support_expectation(extension)
+        extension['extension'].first['valueCode']
+      end
+
+      def comparator_expectation(extension)
+        if extension.nil?
+          'MAY'
+        else
+          support_expectation(extension)
+        end
+      end
+
+      def comparators
+        if !param.nil?
+            {}.tap do |comparators|
+                param.comparator&.each_with_index do |comparator, index|
+                comparators[comparator.to_sym] = comparator_expectation(comparator_expectation_extensions[index])
+                end
+            end
+        end
+      end
+
+      def type
+        if profile_element.present?
+          profile_element.type.first.code
+        else
+          # search is a variable type, eg. Condition.onsetDateTime - element
+          # in profile def is Condition.onset[x]
+           if !param.nil?
+            param.type
+           else
+            nil
+           end
+        end
+      end
+
+      def contains_multiple?
+        profile_element&.max == '*'
+      end
+
+      def chain_extensions
+        param_hash['_chain']
+      end
+
+      def chain_expectations
+        chain_extensions.map { |extension| support_expectation(extension) }
+      end
+
+      def chain
+        return nil if param.nil?
+        return nil if param.chain.blank?
+
+        param.chain
+          .zip(chain_expectations)
+          .map { |chain, expectation| { chain: chain, expectation: expectation } }
+      end
+
+      def multiple_or_expectation
+        if !param_hash.nil? then
+          begin
+            return param_hash['_multipleOr']['extension'].first['valueCode']
+          rescue NoMethodError
+            return nil
+          end
+        else
+          return nil
+        end
+      end
+
+      def values
+        values = (
+            values_from_pattern_codeable_concept_slices +
+            values_from_required_binding_slices +
+            values_from_fixed_codes +
+            values_from_pattern_coding +
+            values_from_pattern_codeable_concept
+          ).uniq.presence ||
+          value_extractor.values_from_value_set_binding(profile_element).presence ||
+          value_extractor.values_from_resource_metadata(paths).presence || []
+
+        values
+      end
+
+      def slices
+        return [] unless contains_multiple?
+
+        profile_elements.select do |element|
+          full_paths.include?(element.path) &&
+            element.sliceName.present? &&
+            (
+              element.patternCodeableConcept.present? ||
+              element.binding.present? && element.binding.strength == 'required'
+            )
+        end
+      end
+
+      def values_from_pattern_codeable_concept_slices
+        slices.map do |slice|
+          slice.patternCodeableConcept.coding.first.code if slice.patternCodeableConcept.present?
+        end.compact
+      end
+
+      def values_from_required_binding_slices
+        slices.map do |slice|
+          if slice.binding.present? && slice.binding.strength == 'required'
+            value_extractor.values_from_value_set_binding(slice)
+          end
+        end.flatten.compact
+      end
+
+      def values_from_fixed_codes
+        return [] unless type == 'CodeableConcept'
+
+        profile_elements
+          .select { |element| element.path == "#{profile_element.path}.coding.code" && element.fixedCode.present? }
+          .map { |element| element.fixedCode }
+      end
+
+      def values_from_pattern_coding
+        return [] unless type == 'CodeableConcept'
+
+        profile_elements
+          .select { |element| element.path == "#{profile_element.path}.coding" && element.patternCoding.present? }
+          .map { |element| element.patternCoding.code }
+      end
+
+      def values_from_pattern_codeable_concept
+        return [] if type != 'CodeableConcept' || profile_element.patternCodeableConcept.blank?
+
+        [profile_element.patternCodeableConcept.coding.first.code]
+      end
+
+      def value_extractor
+        @value_extractor ||= ValueExactor.new(ig_resources, resource)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generator/search_metadata_extractor.rb

@@ -0,0 +1,74 @@
+require_relative 'search_definition_metadata_extractor'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class SearchMetadataExtractor
+      COMBO_EXTENSION_URL =
+        'http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination'.freeze
+
+      attr_accessor :resource_capabilities, :ig_resources, :resource, :profile_elements
+
+      def initialize(resource_capabilities, ig_resources, resource, profile_elements)
+        self.resource_capabilities = resource_capabilities
+        self.ig_resources = ig_resources
+        self.resource = resource
+        self.profile_elements = profile_elements
+      end
+
+      def searches
+        @searches ||= basic_searches + combo_searches
+      end
+
+      def conformance_expectation(search_param)
+        search_param.extension.first.valueCode # TODO: fix expectation extension finding
+      end
+
+      def no_search_params?
+        resource_capabilities.searchParam.blank?
+      end
+
+      def basic_searches
+        return [] if no_search_params?
+
+        resource_capabilities.searchParam
+          .select { |search_param| ['SHALL', 'SHOULD'].include? conformance_expectation(search_param) }
+          .map do |search_param|
+            {
+              names: [search_param.name],
+              expectation: conformance_expectation(search_param)
+            }
+          end
+      end
+
+      def search_extensions
+        resource_capabilities.extension
+      end
+
+      def combo_searches
+        return [] if search_extensions.blank?
+
+        search_extensions
+          .select { |extension| extension.url == COMBO_EXTENSION_URL }
+          .select { |extension| ['SHALL', 'SHOULD'].include? conformance_expectation(extension) }
+          .map do |extension|
+            names = extension.extension.select { |param| param.valueString.present? }.map(&:valueString)
+            {
+              expectation: conformance_expectation(extension),
+              names: names
+            }
+          end
+      end
+
+      def search_param_names
+        searches.flat_map { |search| search[:names] }.uniq
+      end
+
+      def search_definitions
+          search_param_names.each_with_object({}) do |name, definitions|
+              definitions[name.to_sym] =
+              SearchDefinitionMetadataExtractor.new(name, ig_resources, resource, profile_elements).search_definition
+          end
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb

@@ -0,0 +1,299 @@
+require_relative 'naming'
+require_relative 'special_cases'
+require_relative 'include_search_test_generator'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class SearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_group? group }
+            .select { |group| group.searches.present? }
+            .each do |group|
+              group.searches.each { |search| new(group, search, base_output_dir).generate }
+              group.include_params.each{ |param| IncludeSearchTestGenerator.new(group, param, base_output_dir).generate }
+            end
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir
+
+      def initialize(group_metadata, search_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.search_metadata = search_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'search.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def output_file_directory
+        File.join(base_output_dir, profile_identifier)
+      end
+
+      def output_file_name
+        File.join(output_file_directory, base_output_file_name)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "c4bb_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
+      end
+
+      def search_identifier
+        search_metadata[:names].join('_').tr('-', '_')
+      end
+
+      def search_title
+        search_identifier.camelize
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
+      end
+
+      def module_name
+        "CARIN4BB#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def conformance_expectation
+        search_metadata[:expectation]
+      end
+
+      def search_params
+        @search_params ||=
+          search_metadata[:names].map do |name|
+            {
+              name: name,
+              path: search_definition(name)[:path]
+            }
+          end
+      end
+
+      def first_search?
+        group_metadata.searches.first == search_metadata
+      end
+
+      def fixed_value_search?
+        first_search? && search_metadata[:names] != ['patient'] &&
+          !group_metadata.delayed? && resource_type != 'Patient'
+      end
+
+      def fixed_value_search_param_name
+        (search_metadata[:names] - [:patient]).first
+      end
+
+      def search_param_name_string
+        search_metadata[:names].join(' + ')
+      end
+
+      def needs_patient_id?
+        search_metadata[:names].include?('patient') ||
+          (resource_type == 'Patient' && search_metadata[:names].include?('_id'))
+      end
+
+      def search_param_names
+        search_params.map { |param| param[:name] }
+      end
+
+      def search_param_names_array
+        array_of_strings(search_param_names)
+      end
+
+      def path_for_value(path)
+        path == 'class' ? 'local_class' : path
+      end
+
+      def required_comparators_for_param(name)
+        begin
+            return search_definition(name)[:comparators].select { |_comparator, expectation| expectation == 'SHALL' }
+        rescue NoMethodError
+            return []
+        end
+      end
+
+      def required_comparators
+        @required_comparators ||=
+          search_param_names.each_with_object({}) do |name, comparators|
+            required_comparators = required_comparators_for_param(name)
+            comparators[name] = required_comparators if required_comparators.present?
+          end
+      end
+
+      def optional?
+        conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory]
+      end
+
+      def search_definition(name)
+        group_metadata.search_definitions[name.to_sym]
+      end
+
+      def saves_delayed_references?
+        first_search? && group_metadata.delayed_references.present?
+      end
+
+      def possible_status_search?
+        !search_metadata[:names].any? { |name| name.include? 'status' } &&
+          group_metadata.search_definitions.keys.any? { |key| key.to_s.include? 'status' }
+      end
+
+      def token_search_params
+        @token_search_params ||=
+          search_param_names.select do |name|
+            ['Identifier', 'CodeableConcept', 'Coding'].include? group_metadata.search_definitions[name.to_sym][:type]
+          end
+      end
+
+      def token_search_params_string
+        array_of_strings(token_search_params)
+      end
+
+      def required_multiple_or_search_params
+        @multiple_or_search_params ||=
+          search_param_names.select do |name|
+            search_definition(name)[:multiple_or] == 'SHALL'
+          end
+      end
+
+      def required_multiple_or_search_params_string
+        array_of_strings(required_multiple_or_search_params)
+      end
+
+      def required_comparators_string
+        array_of_strings(required_comparators.keys)
+      end
+
+      def array_of_strings(array)
+        quoted_strings = array.map { |element| "'#{element}'" }
+        "[#{quoted_strings.join(', ')}]"
+      end
+
+      def test_reference_variants?
+        first_search? && search_param_names.include?('patient')
+      end
+
+      def test_medication_inclusion?
+        resource_type == 'MedicationRequest'
+      end
+
+      def test_post_search?
+        first_search?
+      end
+
+      def search_properties
+        {}.tap do |properties|
+          properties[:first_search] = 'true' if first_search?
+          properties[:fixed_value_search] = 'true' if fixed_value_search?
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:search_param_names] = search_param_names_array
+          properties[:saves_delayed_references] = 'true' if saves_delayed_references?
+          properties[:possible_status_search] = 'true' if possible_status_search?
+          properties[:test_medication_inclusion] = 'true' if test_medication_inclusion?
+          properties[:token_search_params] = token_search_params_string if token_search_params.present?
+          properties[:test_reference_variants] = 'true' if test_reference_variants?
+          properties[:params_with_comparators] = required_comparators_string if required_comparators.present?
+          properties[:multiple_or_search_params] = required_multiple_or_search_params_string if required_multiple_or_search_params.present?
+          properties[:test_post_search] = 'true' if first_search?
+        end
+      end
+
+      def url_version
+        case group_metadata.version
+        when 'v3.1.1'
+          'STU3.1.1'
+        when 'v4.0.0'
+          'STU4'
+        end
+      end
+
+      def search_test_properties_string
+        search_properties
+          .map { |key, value| "#{' ' * 8}#{key}: #{value}" }
+          .join(",\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+
+      def reference_search_description
+        return '' unless test_reference_variants?
+
+        <<~REFERENCE_SEARCH_DESCRIPTION
+        This test verifies that the server supports searching by reference using
+        the form `patient=[id]` as well as `patient=Patient/[id]`. The two
+        different forms are expected to return the same number of results. CARIN requires that both forms are supported by CARIN for Blue Button responders.
+        REFERENCE_SEARCH_DESCRIPTION
+      end
+
+      def first_search_description
+        return '' unless first_search?
+
+        <<~FIRST_SEARCH_DESCRIPTION
+        Because this is the first search of the sequence, resources in the
+        response will be used for subsequent tests.
+        FIRST_SEARCH_DESCRIPTION
+      end
+
+      def post_search_description
+        return '' unless test_post_search?
+
+        <<~POST_SEARCH_DESCRIPTION
+        Additionally, this test will check that GET and POST search methods
+        return the same number of results. Search by POST is required by the
+        FHIR R4 specification, and these tests interpret search by GET as a
+        requirement of CARIN IG for Blue Button® #{group_metadata.version}.
+        POST_SEARCH_DESCRIPTION
+      end
+
+      def description
+        <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
+        A server #{conformance_expectation} support searching by
+        #{search_param_name_string} on the #{resource_type} resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        #{reference_search_description}
+        #{first_search_description}
+        #{post_search_description}
+
+        DESCRIPTION
+      end
+
+      def input_title
+        <<~INPUT_TITLE
+        #{resource_type} search parameter for #{search_param_name_string}
+        INPUT_TITLE
+      end
+
+      def input_description
+        <<~INPUT_DESCRIPTION
+        #{resource_type} search parameter: #{search_param_name_string}
+        INPUT_DESCRIPTION
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generator/special_cases.rb

@@ -0,0 +1,21 @@
+module CarinForBlueButtonTestKit
+    class Generator
+      module SpecialCases
+        RESOURCES_TO_EXCLUDE = [
+          'Patient',
+          'Organization',
+          'Practitioner',
+          'RelatedPerson'
+        ].freeze
+  
+        PROFILES_TO_EXCLUDE = [
+        ].freeze
+  
+        class << self
+          def exclude_group?(group)
+            RESOURCES_TO_EXCLUDE.include?(group.resource)
+          end
+        end
+      end
+    end
+  end

data/lib/carin_for_blue_button_test_kit/generator/suite_generator.rb

@@ -0,0 +1,94 @@
+require_relative 'naming'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class SuiteGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          new(ig_metadata, base_output_dir).generate
+        end
+      end
+
+      attr_accessor :ig_metadata, :base_output_dir
+
+      def initialize(ig_metadata, base_output_dir)
+        self.ig_metadata = ig_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'suite.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "c4bb_test_suite.rb"
+      end
+
+      def class_name
+        "C4BBTestKit"
+      end
+
+      def module_name
+        "CARIN4BB#{ig_metadata.reformatted_version.upcase}"
+      end
+
+      def output_file_name
+        File.join(base_output_dir, base_output_file_name)
+      end
+
+      def suite_id
+        "c4bb_#{ig_metadata.reformatted_version}"
+      end
+
+      def title
+        "CARIN IG for Blue Button® #{ig_metadata.ig_version}"
+      end
+
+      def validator_env_name
+        "#{ig_metadata.reformatted_version.upcase}_VALIDATOR_URL"
+      end
+
+      def ig_link
+        case ig_metadata.ig_version
+        when 'v1.1.0'
+          'http://hl7.org/fhir/us/carin-bb/STU1.1'
+        when 'v2.0.0'
+          'http://hl7.org/fhir/us/carin-bb/STU2'
+        else
+          'http://hl7.org/fhir/us/carin-bb/history.html'
+        end
+      end
+
+      def generate
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+      end
+
+      def groups
+        ig_metadata.ordered_groups
+      end
+
+      def group_id_list
+        @group_id_list ||=
+          groups.select.map(&:id)
+      end
+
+      def group_file_list
+        @group_file_list ||=
+          groups.map { |group| group.file_name.delete_suffix('.rb') }
+      end
+
+      def capability_statement_file_name
+        "../capability_statement/capability_statement_group"
+      end
+
+      def capability_statement_group_id
+        "c4bb_#{ig_metadata.reformatted_version}_capability_statement"
+      end
+
+    end
+  end
+end