au_core_test_kit 0.0.16

data/lib/au_core_test_kit/generator/ig_metadata_extractor.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative 'ig_metadata'
+require_relative 'group_metadata_extractor'
+
+module AUCoreTestKit
+  class Generator
+    class IGMetadataExtractor
+      attr_accessor :ig_resources, :metadata
+
+      def initialize(ig_resources)
+        self.ig_resources = ig_resources
+        add_missing_supported_profiles
+        remove_extra_supported_profiles
+        self.metadata = IGMetadata.new
+      end
+
+      def extract
+        add_metadata_from_ig
+        add_metadata_from_resources
+        metadata
+      end
+
+      def add_metadata_from_ig
+        metadata.ig_version = "v#{ig_resources.ig.version}"
+      end
+
+      def resources_in_capability_statement
+        ig_resources.capability_statement.rest.first.resource
+      end
+
+      def add_missing_supported_profiles
+        case ig_resources.ig.version
+        when '3.1.1'
+          # The AU Core v3.1.1 Server Capability Statement does not list support for the
+          # required vital signs profiles, so they need to be added
+          ig_resources.capability_statement.rest.first.resource
+                      .find { |resource| resource.type == 'Observation' }
+                      .supportedProfile.concat [
+                        'http://hl7.org/fhir/StructureDefinition/bodyheight',
+                        'http://hl7.org/fhir/StructureDefinition/bodytemp',
+                        'http://hl7.org/fhir/StructureDefinition/bp',
+                        'http://hl7.org/fhir/StructureDefinition/bodyweight',
+                        'http://hl7.org/fhir/StructureDefinition/heartrate',
+                        'http://hl7.org/fhir/StructureDefinition/resprate'
+                      ]
+        end
+      end
+
+      def remove_extra_supported_profiles
+        ig_resources.capability_statement.rest.first.resource
+                    .find { |resource| resource.type == 'Observation' }
+                    .supportedProfile.delete_if do |profile_url|
+          SpecialCases::PROFILES_TO_EXCLUDE.include?(profile_url)
+        end
+      end
+
+      def add_metadata_from_resources
+        profile_arr_to_skip = [
+          'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire',
+          'http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding',
+          'http://hl7.org/fhir/StructureDefinition/DocumentReference' # https://github.com/hl7au/au-fhir-core-inferno/issues/216
+        ]
+
+        # NOTE: We use two different groups because of CapabilityStatement.rest.resource
+        # in AU Core IG supports two ways to describe the profile:
+        # 1. "profile" element which is a string
+        # 2. "supportedProfile" element which is an array of strings
+
+        supported_profile_groups = resources_in_capability_statement.flat_map do |resource|
+          resource.supportedProfile&.map do |supported_profile|
+            supported_profile = supported_profile.split('|').first
+            next if profile_arr_to_skip.include?(supported_profile)
+
+            GroupMetadataExtractor.new(resource, supported_profile, metadata, ig_resources).group_metadata
+          end
+        end.compact
+
+        profile_groups = resources_in_capability_statement.flat_map do |resource|
+          next unless resource.profile.present?
+          next if profile_arr_to_skip.include?(resource.profile)
+
+          GroupMetadataExtractor.new(resource, resource.profile, metadata, ig_resources).group_metadata
+        end.compact
+
+        metadata.groups = supported_profile_groups + profile_groups
+
+        metadata.postprocess_groups(ig_resources)
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/generator/ig_resources.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module AUCoreTestKit
+  class Generator
+    class IGResources
+      def add(resource)
+        resources_by_type[resource.resourceType] << resource
+      end
+
+      def capability_statement(mode = 'server')
+        resources_by_type['CapabilityStatement'].find do |capability_statement_resource|
+          capability_statement_resource.rest.any? { |r| r.mode == mode }
+        end
+      end
+
+      def ig
+        resources_by_type['ImplementationGuide'].first
+      end
+
+      def inspect
+        'IGResources'
+      end
+
+      def profile_by_url(url)
+        resources_by_type['StructureDefinition'].find { |profile| profile.url == url }
+      end
+
+      def resource_for_profile(url)
+        resources_by_type['StructureDefinition'].find { |profile| profile.url == url }.type
+      end
+
+      def value_set_by_url(url)
+        resources_by_type['ValueSet'].find { |profile| profile.url == url }
+      end
+
+      def code_system_by_url(url)
+        resources_by_type['CodeSystem'].find { |system| system.url == url }
+      end
+
+      def search_param_by_exact_resource_and_code(resource, code)
+        search_params = resources_by_type['SearchParameter']
+                        .select { |param| param.base.include?(resource) && param.code == code }
+
+        if search_params.length > 1
+          search_params.find do |param|
+            param.jurisdiction.any? do |codeable_concept|
+              codeable_concept.coding.any? do |coding|
+                coding.system == 'urn:iso:std:iso:3166' && coding.code == 'AU'
+              end
+            end
+          end
+        else
+          search_params.first
+        end
+      end
+
+      def search_param_by_general_resource_and_code(resource, code)
+        # For all base search params (eg: _id) which not defined in separate files, we get details from the base Resource.
+        search_param = resources_by_type['SearchParameter']
+                       .find { |param| param.base.include?('Resource') && param.code == code }
+
+        search_param_dup = search_param.dup
+
+        if search_param_dup.present?
+          search_param_dup.id = search_param_dup.id.gsub('Resource', resource)
+          search_param_dup.base = resource
+          search_param_dup.expression = search_param_dup.expression.gsub('Resource', resource)
+        end
+
+        search_param_dup
+      end
+
+      def search_param_by_specific_cases(resource, code)
+        case "#{resource}-#{code}"
+        when 'ServiceRequest-code'
+          resources_by_type['SearchParameter']
+            .find { |param| param.id == 'ServiceRequest-code-concept' }
+        end
+      end
+
+      def search_param_by_resource_and_code(resource, code)
+        exact_resource = search_param_by_exact_resource_and_code(resource, code)
+        if exact_resource.present?
+          exact_resource
+        else
+          general_resource = search_param_by_general_resource_and_code(resource, code)
+          if general_resource.present?
+            general_resource
+          else
+            search_param_by_specific_cases(resource, code)
+          end
+        end
+      end
+
+      def search_param_by_resource_and_name(resource, name)
+        search_param_by_resource_and_code(resource, name)
+      end
+
+      private
+
+      def resources_by_type
+        @resources_by_type ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/generator/include_search_test_generator.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative 'naming'
+require_relative 'special_cases'
+require_relative 'search_test_generator'
+
+module AUCoreTestKit
+  class Generator
+    class IncludeSearchTestGenerator < SearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .select { |group| group.include_params.present? }
+                     .each do |group|
+            group.searches.each do |search|
+              next unless SpecialCases.search_params_for_include_by_resource[group.resource].include? search[:names]
+
+              group.include_params.each do |include_param|
+                new(group, search, base_output_dir, include_param).generate
+              end
+            end
+          end
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir, :include_param
+
+      def initialize(group_metadata, search_metadata, base_output_dir, include_param)
+        self.group_metadata = group_metadata
+        self.search_metadata = search_metadata
+        self.base_output_dir = base_output_dir
+        self.include_param = include_param
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'include.rb.erb'))
+      end
+
+      def search_identifier
+        search_metadata[:names].join('_').tr('-', '_')
+      end
+
+      def test_id
+        "au_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_param_names_lodash_string}_include_#{search_identifier.downcase}_search_test"
+      end
+
+      def search_title
+        search_identifier.camelize
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}Include#{includes.first['target_resource']}Test"
+      end
+
+      def conformance_expectation
+        'SHOULD'
+      end
+
+      def optional?
+        true
+      end
+
+      def needs_patient_id?
+        true
+      end
+
+      def search_properties
+        {}.tap do |properties|
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:saves_delayed_references] = 'true' if saves_delayed_references?
+          properties[:search_param_names] = search_param_names_array
+          properties[:includes] = includes if group_metadata.include_params.present?
+          properties[:use_any_data_for_search] = true
+        end
+      end
+
+      def target_resources_string
+        includes.map { |include| include['target_resource'] }.join(', ')
+      end
+
+      def include_params_string
+        includes.map { |include| include['parameter'] }.join(', ')
+      end
+
+      def search_param_names_string
+        search_param_names.join(', ')
+      end
+
+      def search_param_names_lodash_string
+        search_param_names.join('_')
+      end
+
+      def title
+        "Server returns #{target_resources_string} resources from #{resource_type} search by #{search_param_names_string} and #{include_params_string}"
+      end
+
+      def description
+        <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
+          This test will perform a search by #{search_param_names_string} and the _include=#{include_params_string}
+
+          Test will pass if a #{target_resources_string} resources are found in the response.
+        DESCRIPTION
+      end
+
+      def search_method
+        'run_include_test'
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/generator/multiple_and_search_test_generator.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require_relative 'naming'
+require_relative 'special_cases'
+require_relative '../helpers'
+
+module AUCoreTestKit
+  class Generator
+    class MultipleAndSearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .select { |group| group.searches.present? }
+                     .each do |group|
+            group.search_definitions.each_key do |search_key|
+              new(search_key.to_s, group, group.search_definitions[search_key], base_output_dir).generate if group.search_definitions[search_key].key?(:multiple_and) && search_key.to_s != 'patient'
+            end
+          end
+        end
+      end
+
+      attr_accessor :search_name, :group_metadata, :search_metadata, :base_output_dir
+
+      def initialize(search_name, group_metadata, search_metadata, base_output_dir)
+        self.search_name = search_name
+        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', 'multiple_and_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
+        "au_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_multiple_and_search_test"
+      end
+
+      def search_identifier
+        search_name.to_s.tr('-', '_')
+      end
+
+      def search_title
+        search_identifier
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title.capitalize}MultipleAndSearchTest"
+      end
+
+      def module_name
+        "AUCore#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def conformance_expectation
+        search_metadata[:multiple_and]
+      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_name
+      end
+
+      def needs_patient_id?
+        true
+      end
+
+      def search_param_names
+        [search_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 optional?
+        conformance_expectation == 'SHOULD' || conformance_expectation == 'MAY'
+      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 required_multiple_and_search_params
+        @required_multiple_and_search_params ||=
+          search_definition(search_name)[:multiple_and] == 'SHALL'
+      end
+
+      def optional_multiple_and_search_params
+        @optional_multiple_and_search_params ||=
+          search_definition(search_name)[:multiple_and] == 'SHOULD'
+      end
+
+      def required_multiple_and_search_params_string
+        required_multiple_and_search_params
+      end
+
+      def optional_multiple_and_search_params_string
+        optional_multiple_and_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?
+        %w[MedicationRequest MedicationDispense].include?(resource_type)
+      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
+          properties[:saves_delayed_references] = 'true' if saves_delayed_references?
+          properties[:test_medication_inclusion] = 'true' if test_medication_inclusion?
+          properties[:test_reference_variants] = 'true' if test_reference_variants?
+          if required_multiple_and_search_params.present?
+            properties[:multiple_and_search_params] =
+              required_multiple_and_search_params_string
+          end
+          properties[:optional_multiple_and_search_params] = optional_multiple_and_search_params_string if optional_multiple_and_search_params.present?
+          properties[:search_by_target_resource_data] = 'true' if Helpers.test_on_target_resource_data?(
+            SpecialCases.multiple_or_and_search_by_target_resource,
+            resource_type, search_param_names
+          )
+        end
+      end
+
+      def url_version
+        case group_metadata.version
+        when 'v0.3.0-ballot'
+          '0.3.0-ballot'
+        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 description
+        Helpers.multiple_test_description('AND', conformance_expectation, search_param_name_string, resource_type, url_version)
+      end
+    end
+  end
+end