ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generated/resprate/resprate_patient_category_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class RespratePatientCategorySearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + category'
+    description %(
+A server SHALL support searching by
+patient + category on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_resprate_patient_category_search_test
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category'],
+        possible_status_search: true,
+        token_search_params: ['category']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_patient_category_status_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class RespratePatientCategoryStatusSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + category + status'
+    description %(
+A server SHOULD support searching by
+patient + category + status on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_resprate_patient_category_status_search_test
+    optional
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'category', 'status'],
+        token_search_params: ['category'],
+        multiple_or_search_params: ['status']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_patient_code_date_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class RespratePatientCodeDateSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code + date'
+    description %(
+A server SHOULD support searching by
+patient + code + date on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_resprate_patient_code_date_search_test
+    optional
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code', 'date'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        params_with_comparators: ['date']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_patient_code_search_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class RespratePatientCodeSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Observation search by patient + code'
+    description %(
+A server SHALL support searching by
+patient + code on the Observation resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+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. IPA
+requires that both forms are supported by IPA responders.
+
+Because this is the first search of the sequence, resources in the
+response will be used for subsequent tests.
+
+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 IPA v0.1.0.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_resprate_patient_code_search_test
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        first_search: true,
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        test_reference_variants: true,
+        test_post_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_provenance_revinclude_search_test.rb

@@ -0,0 +1,51 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class ResprateProvenanceRevincludeSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Observation search by patient + code + revInclude:Provenance:target'
+    description %(
+      A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+      This test will perform a search by patient + code + revInclude:Provenance:target and
+      will pass if a Provenance resource is found in the response.
+    %)
+
+    id :ipa_010_resprate_provenance_revinclude_search_test
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def properties
+      @properties ||= SearchTestProperties.new(
+        fixed_value_search: true,
+        resource_type: 'Observation',
+        search_param_names: ['patient', 'code'],
+        possible_status_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def self.provenance_metadata
+      @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module IpaTestKit
+  class ResprateReadTest < Inferno::Test
+    include IpaTestKit::ReadTest
+
+    title 'Server returns correct Observation resource from Observation read interaction'
+    description 'A server SHALL support the Observation read interaction.'
+
+    id :ipa_010_resprate_read_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(all_scratch_resources)
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_reference_resolution_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../reference_resolution_test'
+
+module IpaTestKit
+  class ResprateReferenceResolutionTest < Inferno::Test
+    include IpaTestKit::ReferenceResolutionTest
+
+    title 'Every reference within Observation resources can be read'
+    description %(
+      This test will attempt to read the first 50 references found in the
+      resources from the first search. The test will fail if Inferno fails to
+      read any of those references.
+    )
+
+    id :ipa_010_resprate_reference_resolution_test
+
+    def resource_type
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      perform_reference_resolution_test(scratch_resources[:all])
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate/resprate_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../validation_test'
+
+module IpaTestKit
+  class ResprateValidationTest < Inferno::Test
+    include IpaTestKit::ValidationTest
+
+    id :ipa_010_resprate_validation_test
+    title 'Observation resources returned during previous tests conform to the Observation Respiratory Rate Profile'
+    description %(
+This test verifies resources returned from the first search conform to
+the [Observation Respiratory Rate Profile](http://hl7.org/fhir/StructureDefinition/resprate).
+
+It verifies the presence of mandatory elements and that elements with
+required bindings contain appropriate values. CodeableConcept element
+bindings will fail if none of their codings have a code/system belonging
+to the bound ValueSet. Quantity, Coding, and code element bindings will
+fail if their code/system are not found in the valueset.
+
+    )
+    output :dar_code_found, :dar_extension_found
+
+    def resource_type
+      'Observation'
+    end
+
+    def scratch_resources
+      scratch[:resprate_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [], 'http://hl7.org/fhir/StructureDefinition/resprate')
+    end
+  end
+end

data/lib/ipa_test_kit/generated/resprate_group.rb

@@ -0,0 +1,93 @@
+require_relative 'resprate/resprate_patient_code_search_test'
+require_relative 'resprate/resprate_patient_category_date_search_test'
+require_relative 'resprate/resprate_patient_category_status_search_test'
+require_relative 'resprate/resprate_patient_code_date_search_test'
+require_relative 'resprate/resprate_patient_category_search_test'
+require_relative 'resprate/resprate_read_test'
+require_relative 'resprate/resprate_provenance_revinclude_search_test'
+require_relative 'resprate/resprate_validation_test'
+require_relative 'resprate/resprate_must_support_test'
+require_relative 'resprate/resprate_reference_resolution_test'
+
+module IpaTestKit
+  class ResprateGroup < Inferno::TestGroup
+    title 'Observation Respiratory Rate Tests'
+    short_description 'Verify support for the server capabilities required by the Observation Respiratory Rate Profile.'
+    description %(
+# Background
+
+The IPA Observation Respiratory Rate sequence verifies that the system under test is
+able to provide correct responses for Observation queries. These queries
+must contain resources conforming to the Observation Respiratory Rate Profile as
+specified in the IPA v0.1.0 Implementation Guide.
+
+# Testing Methodology
+## Searching
+This test sequence will first perform each required search associated
+with this resource. This sequence will perform searches with the
+following parameters:
+
+* patient + code
+* patient + category + date
+* patient + category
+
+### Search Parameters
+The first search uses the selected patient(s) from the prior launch
+sequence. Any subsequent searches will look for its parameter values
+from the results of the first search. For example, the `identifier`
+search in the patient sequence is performed by looking for an existing
+`Patient.identifier` from any of the resources returned in the `_id`
+search. If a value cannot be found this way, the search is skipped.
+
+### Search Validation
+Inferno will retrieve up to the first 20 bundle pages of the reply for
+Observation resources and save them for subsequent tests. Each of
+these resources is then checked to see if it matches the searched
+parameters in accordance with [FHIR search
+guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+for example, if a Patient search for `gender=male` returns a `female`
+patient.
+
+
+## Must Support
+Each profile contains elements marked as "must support". This test
+sequence expects to see each of these elements at least once. If at
+least one cannot be found, the test will fail. The test will look
+through the Observation resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [Observation Respiratory Rate Profile](http://hl7.org/fhir/StructureDefinition/resprate). Each element is checked against
+teminology binding and cardinality requirements.
+
+Elements with a required binding are validated against their bound
+ValueSet. If the code/system in the element is not part of the ValueSet,
+then the test will fail.
+
+## Reference Validation
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :ipa_010_resprate
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'resprate', 'metadata.yml')))
+    end
+
+    test from: :ipa_010_resprate_patient_code_search_test
+    test from: :ipa_010_resprate_patient_category_date_search_test
+    test from: :ipa_010_resprate_patient_category_status_search_test
+    test from: :ipa_010_resprate_patient_code_date_search_test
+    test from: :ipa_010_resprate_patient_category_search_test
+    test from: :ipa_010_resprate_read_test
+    test from: :ipa_010_resprate_provenance_revinclude_search_test
+    test from: :ipa_010_resprate_validation_test
+    test from: :ipa_010_resprate_must_support_test
+    test from: :ipa_010_resprate_reference_resolution_test
+  end
+end

data/lib/ipa_test_kit/generator/group_generator.rb

@@ -0,0 +1,171 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module IpaTestKit
+  class Generator
+    class GroupGenerator
+      class << self
+        def generate(ig_metadata)
+          ig_metadata.ordered_groups
+            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .each { |group| new(group).generate }
+        end
+      end
+
+      attr_accessor :group_metadata
+
+      def initialize(group_metadata)
+        self.group_metadata = group_metadata
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'group.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def base_metadata_file_name
+        "metadata.yml"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}Group"
+      end
+
+      def title
+        group_metadata.title
+      end
+
+      def short_description
+        group_metadata.short_description
+      end
+
+      def output_file_name
+        File.join(__dir__, '..', 'generated', base_output_file_name)
+      end
+
+      def metadata_file_name
+        File.join(__dir__, '..', 'generated', profile_identifier, base_metadata_file_name)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def group_id
+        "ipa_010_#{profile_identifier}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def profile_name
+        group_metadata.profile_name
+      end
+
+      def profile_url
+        group_metadata.profile_url
+      end
+
+      def generate
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+        group_metadata.id = group_id
+        group_metadata.file_name = base_output_file_name
+        File.open(metadata_file_name, 'w') { |f| f.write(YAML.dump(group_metadata.to_hash)) }
+      end
+
+      def test_id_list
+        @test_id_list ||=
+          group_metadata.tests.map { |test| test[:id] }
+      end
+
+      def test_file_list
+        @test_file_list ||=
+          group_metadata.tests.map { |test| test[:file_name].delete_suffix('.rb') }
+      end
+
+      def required_searches
+        group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
+      end
+
+      def search_param_name_string
+        required_searches
+          .map { |search| search[:names].join(' + ') }
+          .map { |names| "* #{names}" }
+          .join("\n")
+      end
+
+      def search_description
+        return '' if required_searches.blank?
+
+        <<~SEARCH_DESCRIPTION
+        ## Searching
+        This test sequence will first perform each required search associated
+        with this resource. This sequence will perform searches with the
+        following parameters:
+
+        #{search_param_name_string}
+
+        ### Search Parameters
+        The first search uses the selected patient(s) from the prior launch
+        sequence. Any subsequent searches will look for its parameter values
+        from the results of the first search. For example, the `identifier`
+        search in the patient sequence is performed by looking for an existing
+        `Patient.identifier` from any of the resources returned in the `_id`
+        search. If a value cannot be found this way, the search is skipped.
+
+        ### Search Validation
+        Inferno will retrieve up to the first 20 bundle pages of the reply for
+        #{resource_type} resources and save them for subsequent tests. Each of
+        these resources is then checked to see if it matches the searched
+        parameters in accordance with [FHIR search
+        guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+        for example, if a Patient search for `gender=male` returns a `female`
+        patient.
+        SEARCH_DESCRIPTION
+      end
+
+      def description
+        <<~DESCRIPTION
+        # Background
+
+        The IPA #{title} sequence verifies that the system under test is
+        able to provide correct responses for #{resource_type} queries. These queries
+        must contain resources conforming to the #{profile_name} as
+        specified in the IPA v0.1.0 Implementation Guide.
+
+        # Testing Methodology
+        #{search_description}
+
+        ## Must Support
+        Each profile contains elements marked as "must support". This test
+        sequence expects to see each of these elements at least once. If at
+        least one cannot be found, the test will fail. The test will look
+        through the #{resource_type} resources found in the first test for these
+        elements.
+
+        ## Profile Validation
+        Each resource returned from the first search is expected to conform to
+        the [#{profile_name}](#{profile_url}). Each element is checked against
+        teminology binding and cardinality requirements.
+
+        Elements with a required binding are validated against their bound
+        ValueSet. If the code/system in the element is not part of the ValueSet,
+        then the test will fail.
+
+        ## Reference Validation
+        Each reference within the resources found from the previous tests must
+        resolve. The test will attempt to read each reference found and will
+        fail if any attempted read fails.
+        DESCRIPTION
+      end
+    end
+  end
+end