us_core_test_kit 0.1.1 → 0.2.2

data/lib/us_core_test_kit/generator/search_definition_metadata_extractor.rb

@@ -13,8 +13,8 @@ module USCoreTestKit
       def search_definition
         @search_definition ||=
           {
-            path: path,
-            full_path: full_path,
+            paths: paths,
+            full_paths: full_paths,
             comparators: comparators,
             values: values,
             type: type,
@@ -32,24 +32,25 @@ module USCoreTestKit
         param.source_hash
       end
 
-      def full_path
-        @full_path ||=
+      def full_paths
+        @full_paths ||=
           begin
             path = param.expression.gsub(/.where\((.*)/, '')
             path = path[1..-2] if path.start_with?('(') && path.end_with?(')')
-            as_type = path.scan(/[. ]as[( ]([^)]*)[)]?/).flatten.first
-            path.gsub!(/[. ]as[( ]([^)]*)[)]?/, as_type.upcase_first) if as_type.present?
-            path
+            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 path
-        @path ||= full_path.gsub("#{resource}.", '')
+      def paths
+        @paths ||= full_paths.map { |a_path| a_path.gsub("#{resource}.", '') }
       end
 
       def profile_element
         @profile_element ||=
-          profile_elements.find { |element| element.id == full_path }
+          profile_elements.find { |element| full_paths.include?(element.id) }
       end
 
       def comparator_expectation_extensions
@@ -111,19 +112,22 @@ module USCoreTestKit
       end
 
       def values
-        (
+        values = (
+          (
           values_from_slices +
           values_from_fixed_codes +
-          values_from_pattern_codeable_concept +
-          values_from_value_set_binding
-        ).uniq.presence || values_from_resource_metadata
+          values_from_pattern_coding +
+          values_from_pattern_codeable_concept          
+          ).uniq.presence || values_from_value_set_binding
+        ).presence || values_from_resource_metadata
+        values
       end
 
       def slices
         return [] unless contains_multiple?
 
         profile_elements.select do |element|
-          element.path == full_path &&
+          full_paths.include?(element.path) &&
             element.sliceName.present? &&
             element.patternCodeableConcept.present?
         end
@@ -143,6 +147,14 @@ module USCoreTestKit
           .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?
 
@@ -167,14 +179,22 @@ module USCoreTestKit
         bound_systems.flat_map { |system| system.concept.map { |code| code.code } }.uniq
       end
 
-      def fhir_metadata
-        FHIR.const_get(resource)::METADATA[path.gsub("#{resource}.", '')]
+      def fhir_metadata(current_path)
+        FHIR.const_get(resource)::METADATA[current_path]
       end
 
       def values_from_resource_metadata
-        return [] if fhir_metadata&.dig('valid_codes').blank?
+        values = []
+
+        paths.each do |current_path|
+          current_metadata = fhir_metadata(current_path)
+
+          if current_metadata&.dig('valid_codes').present?
+            values = values + current_metadata['valid_codes'].values.flatten 
+          end
+        end
 
-        fhir_metadata['valid_codes'].values.flatten
+        values
       end
     end
   end

data/lib/us_core_test_kit/generator/search_test_generator.rb

@@ -5,21 +5,22 @@ module USCoreTestKit
   class Generator
     class SearchTestGenerator
       class << self
-        def generate(ig_metadata)
+        def generate(ig_metadata, base_output_dir)
           ig_metadata.groups
-            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .reject { |group| SpecialCases.exclude_group? group }
             .select { |group| group.searches.present? }
             .each do |group|
-              group.searches.each { |search| new(group, search).generate }
+              group.searches.each { |search| new(group, search, base_output_dir).generate }
             end
         end
       end
 
-      attr_accessor :group_metadata, :search_metadata
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir
 
-      def initialize(group_metadata, search_metadata)
+      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
@@ -35,7 +36,7 @@ module USCoreTestKit
       end
 
       def output_file_directory
-        File.join(__dir__, '..', 'generated', profile_identifier)
+        File.join(base_output_dir, profile_identifier)
       end
 
       def output_file_name
@@ -47,7 +48,7 @@ module USCoreTestKit
       end
 
       def test_id
-        "us_core_311_#{profile_identifier}_#{search_identifier}_search_test"
+        "us_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
       end
 
       def search_identifier
@@ -62,6 +63,10 @@ module USCoreTestKit
         "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
       end
 
+      def module_name
+        "USCore#{group_metadata.reformatted_version.upcase}"
+      end
+
       def resource_type
         group_metadata.resource
       end
@@ -127,7 +132,7 @@ module USCoreTestKit
       end
 
       def optional?
-        conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory] 
+        conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory]
       end
 
       def search_definition(name)
@@ -203,6 +208,15 @@ module USCoreTestKit
         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}" }
@@ -256,7 +270,7 @@ module USCoreTestKit
         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 v3.1.1.
+        requirement of US Core #{group_metadata.version}.
         POST_SEARCH_DESCRIPTION
       end
 
@@ -272,7 +286,7 @@ module USCoreTestKit
         #{first_search_description}
         #{post_search_description}
 
-        [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+        [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/#{url_version}/CapabilityStatement-us-core-server.html)
         DESCRIPTION
       end
     end

data/lib/us_core_test_kit/generator/special_cases.rb

@@ -7,10 +7,19 @@ module USCoreTestKit
         'PractitionerRole'
       ].freeze
 
+      PROFILES_TO_EXCLUDE = [
+        'us_core_vital_signs'
+      ].freeze
+
       class << self
         def exclude_resource?(resource)
           RESOURCES_TO_EXCLUDE.include? resource
         end
+
+        def exclude_group?(group)
+          RESOURCES_TO_EXCLUDE.include?(group.resource) ||
+          PROFILES_TO_EXCLUDE.include?(group.name)
+        end
       end
     end
   end

data/lib/us_core_test_kit/generator/suite_generator.rb

@@ -5,15 +5,16 @@ module USCoreTestKit
   class Generator
     class SuiteGenerator
       class << self
-        def generate(ig_metadata)
-          new(ig_metadata).generate
+        def generate(ig_metadata, base_output_dir)
+          new(ig_metadata, base_output_dir).generate
         end
       end
 
-      attr_accessor :ig_metadata
+      attr_accessor :ig_metadata, :base_output_dir
 
-      def initialize(ig_metadata)
+      def initialize(ig_metadata, base_output_dir)
         self.ig_metadata = ig_metadata
+        self.base_output_dir = base_output_dir
       end
 
       def template
@@ -32,16 +33,24 @@ module USCoreTestKit
         "USCoreTestSuite"
       end
 
+      def module_name
+        "USCore#{ig_metadata.reformatted_version.upcase}"
+      end
+
       def output_file_name
-        File.join(__dir__, '..', 'generated', base_output_file_name)
+        File.join(base_output_dir, base_output_file_name)
       end
 
       def suite_id
-        'us_core_311'
+        "us_core_#{ig_metadata.reformatted_version}"
       end
 
       def title
-        'US Core 3.1.1'
+        "US Core #{ig_metadata.ig_version}"
+      end
+
+      def validator_env_name
+        "#{ig_metadata.reformatted_version.upcase}_VALIDATOR_URL"
       end
 
       def generate
@@ -50,7 +59,7 @@ module USCoreTestKit
 
       def groups
         ig_metadata.ordered_groups
-          .reject { |group| SpecialCases.exclude_resource? group.resource }
+          .reject { |group| SpecialCases.exclude_group? group }
       end
 
       def group_id_list
@@ -62,6 +71,22 @@ module USCoreTestKit
         @group_file_list ||=
           groups.map { |group| group.file_name.delete_suffix('.rb') }
       end
+
+      def capability_statement_file_name
+        "../../custom_groups/#{ig_metadata.ig_version}/capability_statement_group"
+      end
+
+      def capability_statement_group_id
+        "us_core_#{ig_metadata.reformatted_version}_capability_statement"
+      end
+
+      def clinical_notes_guidance_file_name
+        "../../custom_groups/#{ig_metadata.ig_version}/clinical_notes_guidance_group"
+      end
+
+      def clinical_notes_guidance_group_id
+        "us_core_#{ig_metadata.reformatted_version}_clinical_notes_guidance"
+      end
     end
   end
 end

data/lib/us_core_test_kit/generator/validation_test_generator.rb

@@ -5,26 +5,27 @@ module USCoreTestKit
   class Generator
     class ValidationTestGenerator
       class << self
-        def generate(ig_metadata)
+        def generate(ig_metadata, base_output_dir)
           ig_metadata.groups
-            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .reject { |group| SpecialCases.exclude_group? group }
             .each do |group|
-              new(group).generate
+              new(group, base_output_dir: base_output_dir).generate
               next unless group.resource == 'MedicationRequest'
 
               # The Medication validation test lives in the MedicationRequest
               # group, so we need to pass in that group's metadata
               medication_group_metadata = ig_metadata.groups.find { |group| group.resource == 'Medication' }
-              new(medication_group_metadata, group).generate
+              new(medication_group_metadata, group, base_output_dir: base_output_dir).generate
             end
         end
       end
 
-      attr_accessor :group_metadata, :medication_request_metadata
+      attr_accessor :group_metadata, :medication_request_metadata, :base_output_dir
 
-      def initialize(group_metadata, medication_request_metadata = nil)
+      def initialize(group_metadata, medication_request_metadata = nil, base_output_dir:)
         self.group_metadata = group_metadata
         self.medication_request_metadata = medication_request_metadata
+        self.base_output_dir = base_output_dir
       end
 
       def template
@@ -40,7 +41,7 @@ module USCoreTestKit
       end
 
       def output_file_directory
-        File.join(__dir__, '..', 'generated', directory_name)
+        File.join(base_output_dir, directory_name)
       end
 
       def output_file_name
@@ -64,13 +65,17 @@ module USCoreTestKit
       end
 
       def test_id
-        "us_core_311_#{profile_identifier}_validation_test"
+        "us_core_#{group_metadata.reformatted_version}_#{profile_identifier}_validation_test"
       end
 
       def class_name
         "#{Naming.upper_camel_case_for_profile(group_metadata)}ValidationTest"
       end
 
+      def module_name
+        "USCore#{group_metadata.reformatted_version.upcase}"
+      end
+
       def resource_type
         group_metadata.resource
       end
@@ -79,6 +84,12 @@ module USCoreTestKit
         read_interaction[:expectation]
       end
 
+      def skip_if_empty
+        # Return true if a system must demonstrate at least one example of the resource type.
+        # This drives omit vs. skip result statuses in this test.
+        resource_type != 'Medication'
+      end
+
       def generate
         FileUtils.mkdir_p(output_file_directory)
         File.open(output_file_name, 'w') { |f| f.write(output) }
@@ -116,6 +127,7 @@ module USCoreTestKit
           <<~GENERIC_INTRO
           This test verifies resources returned from the first search conform to
           the [#{profile_name}](#{profile_url}).
+          Systems must demonstrate at least one valid example in order to pass this test.
           GENERIC_INTRO
         end
       end

data/lib/us_core_test_kit/generator.rb

@@ -15,9 +15,27 @@ require_relative 'generator/validation_test_generator'
 
 module USCoreTestKit
   class Generator
-    attr_accessor :ig_resources, :ig_metadata
+    def self.generate
+      base_ig_directory = File.join(Dir.pwd, 'lib', 'us_core_test_kit', 'igs')
+      ig_directories =
+        Dir.entries(base_ig_directory)
+          .reject { |path| path.start_with? '.' }
+          .map { |path| File.join(base_ig_directory, path) }
+          .select { |path| File.directory? path }
+
+      ig_directories.each do |ig_directory|
+        new(ig_directory).generate
+      end
+    end
+
+    attr_accessor :ig_resources, :ig_metadata, :ig_directory
+
+    def initialize(ig_directory)
+      self.ig_directory = ig_directory
+    end
 
     def generate
+      puts "Generating tests for IG in #{ig_directory}"
       load_ig_package
       extract_metadata
       generate_resource_list
@@ -37,50 +55,56 @@ module USCoreTestKit
 
     def extract_metadata
       self.ig_metadata = IGMetadataExtractor.new(ig_resources).extract
-      File.open(File.join(__dir__, 'generated', 'metadata.yml'), 'w') do |file|
+
+      FileUtils.mkdir_p(base_output_dir)
+      File.open(File.join(base_output_dir, 'metadata.yml'), 'w') do |file|
         file.write(YAML.dump(ig_metadata.to_hash))
       end
     end
 
+    def base_output_dir
+      File.join(__dir__, 'generated', ig_metadata.ig_version)
+    end
+
     def load_ig_package
       FHIR.logger = Logger.new('/dev/null')
-      self.ig_resources = IGLoader.new.load
+      self.ig_resources = IGLoader.new(ig_directory).load
     end
 
     def generate_resource_list
-      ResourceListGenerator.generate(ig_metadata)
+      ResourceListGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_reference_resolution_tests
-      ReferenceResolutionTestGenerator.generate(ig_metadata)
+      ReferenceResolutionTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_must_support_tests
-      MustSupportTestGenerator.generate(ig_metadata)
+      MustSupportTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_validation_tests
-      ValidationTestGenerator.generate(ig_metadata)
+      ValidationTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_read_tests
-      ReadTestGenerator.generate(ig_metadata)
+      ReadTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_search_tests
-      SearchTestGenerator.generate(ig_metadata)
+      SearchTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_provenance_revinclude_search_tests
-      ProvenanceRevincludeSearchTestGenerator.generate(ig_metadata)
+      ProvenanceRevincludeSearchTestGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_groups
-      GroupGenerator.generate(ig_metadata)
+      GroupGenerator.generate(ig_metadata, base_output_dir)
     end
 
     def generate_suites
-      SuiteGenerator.generate(ig_metadata)
+      SuiteGenerator.generate(ig_metadata, base_output_dir)
     end
   end
 end

data/lib/us_core_test_kit/must_support_test.rb

@@ -14,7 +14,7 @@ module USCoreTestKit
     def perform_must_support_test(resources)
       skip_if resources.blank?, "No #{resource_type} resources were found"
 
-      if (missing_elements(resources) + missing_slices(resources)).length.zero?
+      if (missing_elements(resources) + missing_slices(resources) + missing_extensions(resources)).length.zero?
         pass
       end
 
@@ -64,12 +64,24 @@ module USCoreTestKit
 
               (value_without_extensions.present? || value_without_extensions == false) &&
                 (element_definition[:fixed_value].blank? || value == element_definition[:fixed_value])
+
             end
 
             # Note that false.present? => false, which is why we need to add this extra check
             value_found.present? || value_found == false
           end
         end
+
+      if metadata.must_supports[:choices].present?
+        @missing_elements.delete_if do |element|
+          choice_paths = metadata.must_supports[:choices].find { |choice| choice[:paths].include?(element[:path]) }
+
+          choice_paths.present? &&
+            choice_paths[:paths].any? { |path| @missing_elements.none? { |element| element[:path] == path } }
+        end
+      end
+
+      @missing_elements
     end
 
     def must_support_slices
@@ -94,6 +106,11 @@ module USCoreTestKit
           find_a_value_at(element, coding_path) do |coding|
             coding.code == discriminator[:code] && coding.system == discriminator[:system]
           end
+        when 'patternCoding'
+          coding_path = discriminator[:path].present? ? discriminator[:path] : ''
+          find_a_value_at(element, coding_path) do |coding|
+            coding.code == discriminator[:code] && coding.system == discriminator[:system]
+          end
         when 'patternIdentifier'
           find_a_value_at(element, discriminator[:path]) { |identifier| identifier.system == discriminator[:system] }
         when 'value'

data/lib/us_core_test_kit/read_test.rb

@@ -52,7 +52,7 @@ module USCoreTestKit
     end
 
     def bad_resource_id_message(expected_id)
-      "Expected resource to have id: `#{id}`, but found `#{resource.id}`"
+      "Expected resource to have id: `#{expected_id.inspect}`, but found `#{resource.id.inspect}`"
     end
 
     def resource_class