davinci_us_drug_formulary_test_kit 0.9.0

data/lib/davinci_us_drug_formulary_test_kit/generator/read_test_generator.rb

@@ -0,0 +1,92 @@
+require_relative 'naming'
+
+module DaVinciUSDrugFormularyTestKit
+  class Generator
+    class ReadTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .select { |group| read_interaction(group).present? }
+            .each { |group| new(group, base_output_dir).generate }
+        end
+
+        def read_interaction(group_metadata)
+          group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
+        end
+      end
+
+      attr_accessor :group_metadata, :base_output_dir
+
+      def initialize(group_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'read.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 read_interaction
+        self.class.read_interaction(group_metadata)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "usdf_#{group_metadata.reformatted_version}_#{profile_identifier}_read_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReadTest"
+      end
+
+      def module_name
+        "USDF#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def resource_collection_string
+        if group_metadata.delayed? && resource_type != 'Provenance'
+          "scratch.dig(:references, '#{resource_type}')"
+        else
+          'all_scratch_resources'
+        end
+      end
+
+      def conformance_expectation
+        read_interaction[:expectation]
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.write(output_file_name, output)
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generator/reference_resolution_test_generator.rb

@@ -0,0 +1,91 @@
+require_relative 'naming'
+
+module DaVinciUSDrugFormularyTestKit
+  class Generator
+    class ReferenceResolutionTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .each { |group| new(group, base_output_dir).generate }
+        end
+      end
+
+      attr_accessor :group_metadata, :base_output_dir
+
+      def initialize(group_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'reference_resolution.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
+        "usdf_#{group_metadata.reformatted_version}_#{profile_identifier}_reference_resolution_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReferenceResolutionTest"
+      end
+
+      def module_name
+        "DaVinciUSDrugFormulary#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def resource_collection_string
+        'scratch_resources[:all]'
+      end
+
+      def must_support_references
+        group_metadata.must_supports[:references]
+      end
+
+      def must_support_reference_list_string
+        must_support_references
+          .map { |element| "#{' ' * 8}* #{resource_type}.#{element[:path]}" }
+          .map do |string|
+            string
+              .gsub(".where(url='http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/", ':')
+              .gsub("')", '')
+          end.uniq.sort.join("\n")
+      end
+
+      def generate
+        return if must_support_references.empty?
+
+        FileUtils.mkdir_p(output_file_directory)
+        File.write(output_file_name, output)
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generator/search_definition_metadata_extractor.rb

@@ -0,0 +1,187 @@
+require_relative 'value_extractor'
+
+module DaVinciUSDrugFormularyTestKit
+  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:,
+            full_paths:,
+            comparators:,
+            values:,
+            type:,
+            target:,
+            contains_multiple: contains_multiple?,
+            multiple_or: multiple_or_expectation,
+            chain:
+          }.compact
+      end
+
+      def param
+        @param ||= ig_resources.search_param_by_resource_and_name(resource, name)
+      end
+
+      def param_hash
+        param.source_hash
+      end
+
+      def full_paths
+        @full_paths ||=
+          begin
+            path = param.expression.gsub(/.where\(resolve\((.*)/, '').gsub("url = '", 'url=\'')
+            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('|')
+          end
+      end
+
+      def paths
+        @paths ||= full_paths.map { |a_path| a_path.gsub("#{resource}.", '').strip }
+      end
+
+      def extensions
+        @extensions ||= full_paths.select { |a_path| a_path.include?('extension.where') }
+          .map { |a_path| { url: a_path[/(?<=extension.where\(url=').*(?='\))/] } }
+          .presence
+      end
+
+      def profile_element
+        @profile_element ||=
+          profile_elements.find { |element| full_paths.include?(element.id) } ||
+          extension_definition&.differential&.element&.find { |element| element.id == 'Extension.value[x]' }
+      end
+
+      def extension_definition
+        @extension_definition ||=
+          begin
+            ext_definition = nil
+            extensions&.each do |ext_metadata|
+              ext_definition = ig_resources.profile_by_url(ext_metadata[:url])
+              break if ext_definition.present?
+            end
+            ext_definition
+          end
+      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
+        {}.tap do |comparators|
+          param.comparator&.each_with_index do |comparator, index|
+            comparators[comparator.to_sym] = comparator_expectation(comparator_expectation_extensions[index])
+          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]
+          param.type
+        end
+      end
+
+      def target
+        # The search param definition for FormularyItem.subject doesn't have a target for some reason
+        return 'MedicationKnowledge' if param.url == 'http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-subject'
+
+        param.target.first
+      end
+
+      def contains_multiple?
+        if profile_element.present?
+          if profile_element.id.start_with?('Extension') && extension_definition.present?
+            # Find the extension instance in a US Core profile
+            target_element = profile_elements.find do |element|
+              element.type.any? { |type| type.code == 'Extension' && type.profile.include?(extension_definition.url) }
+            end
+            target_element&.max == '*'
+          else
+            profile_element.max == '*'
+          end
+        else
+          false
+        end
+      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.chain.blank?
+
+        param.chain
+          .zip(chain_expectations)
+          .map { |chain, expectation| { chain:, expectation: } }
+      end
+
+      def multiple_or_expectation
+        param_hash['multipleOr']
+      end
+
+      def basic_status_search?
+        resource == 'Basic' && name == 'status'
+      end
+
+      def basic_status_values
+        ['draft', 'active', 'retired', 'unknown']
+      end
+
+      def values
+        return basic_status_values if basic_status_search?
+
+        value_extractor.values_from_slicing(profile_element, type).presence ||
+          value_extractor.values_from_required_binding(profile_element).presence ||
+          value_extractor.values_from_value_set_binding(profile_element).presence ||
+          values_from_resource_metadata(paths).presence ||
+          []
+      end
+
+      def values_from_resource_metadata(paths)
+        if multiple_or_expectation || paths.any? { |path| path.downcase.include?('status') }
+          value_extractor.values_from_resource_metadata(paths)
+        else
+          []
+        end
+      end
+
+      def value_extractor
+        @value_extractor ||= ValueExactor.new(ig_resources, resource, profile_elements)
+      end
+    end
+  end
+end

data/lib/davinci_us_drug_formulary_test_kit/generator/search_metadata_extractor.rb

@@ -0,0 +1,59 @@
+require_relative 'search_definition_metadata_extractor'
+
+module DaVinciUSDrugFormularyTestKit
+  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 combo_searches
+        []
+      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/davinci_us_drug_formulary_test_kit/generator/search_test_generator.rb

@@ -0,0 +1,270 @@
+require_relative 'naming'
+module DaVinciUSDrugFormularyTestKit
+  class Generator
+    class SearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .select { |group| group.searches.present? }
+            .each do |group|
+              group.searches.each { |search| new(group, search, 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
+        "usdf_#{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
+        "DaVinciUSDrugFormulary#{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:,
+              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] == ['status'] || search_metadata[:names] == ['code'])
+      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_id?
+        # resource_type == 'Location'
+        search_metadata[:names].include?('_id') && resource_type == 'Location'
+
+        # 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)
+        search_definition(name)[:comparators].select { |_comparator, expectation| expectation == 'SHALL' }
+      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 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
+        @required_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?
+        search_param_names.any? do |name|
+          group_metadata.search_definitions[name.to_sym][:type] == 'Reference'
+        end
+      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[: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?
+          if required_multiple_or_search_params.present?
+            properties[:multiple_or_search_params] =
+              required_multiple_or_search_params_string
+          end
+          properties[:test_post_search] = 'true' if first_search?
+        end
+      end
+
+      def url_version
+        'STU2'
+      end
+
+      def search_test_properties_string
+        search_properties
+          .map { |key, value| "#{' ' * 10}#{key}: #{value}" }
+          .join(",\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.write(output_file_name, 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 `formulary=[id]` as well as `formulary=Formulary/[id]`. The two
+          different forms are expected to return the same number of results. USDF#{' '}
+          requires that both forms are supported by 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 US Core #{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.
+
+          #{first_search_description}
+          #{post_search_description}
+
+          [US Drug Formulary](http://hl7.org/fhir/us/davinci-drug-formulary/#{url_version}/CapabilityStatement-usdf-server.html)
+        DESCRIPTION
+      end
+    end
+  end
+end