us_core_test_kit 0.11.2 → 0.11.3

data/lib/us_core_test_kit/client/generator/templates/urls.rb.erb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    module <%= module_name %>
+      RESUME_PASS_ROUTE = '/resume_pass'
+      FHIR_ROUTE = '/fhir'
+      READ_ROUTE = "#{FHIR_ROUTE}/:resource_type/:resource_id"
+      SEARCH_ROUTE = "#{FHIR_ROUTE}/:resource_type"
+      SEARCH_POST_ROUTE = "#{FHIR_ROUTE}/:resource_type/_search"
+      METADATA_PATH = "#{FHIR_ROUTE}/metadata"
+      TOKEN_PATH = '/auth/token'.freeze
+      AUTHORIZATION_PATH = '/auth/authorization'.freeze
+
+      module URLs
+        def base_url
+          "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+        end
+
+        def resume_pass_url
+          base_url + RESUME_PASS_ROUTE
+        end
+
+        def fhir_url
+          base_url + FHIR_ROUTE
+        end
+
+        def client_fhir_base_url # alias for OIDC from SMART / UDAP client tests
+          fhir_url
+        end
+
+        def read_url
+          base_url + READ_ROUTE
+        end
+
+        def search_url
+          base_url + SEARCH_ROUTE
+        end
+
+        def token_url
+          @token_url ||= base_url + TOKEN_PATH
+        end
+
+        def authorization_url
+          @authorization_url ||= base_url + AUTHORIZATION_PATH
+        end
+
+        def suite_id
+          '<%= suite_id %>'
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/generator/templates/wait_group.rb.erb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'smart_app_launch_test_kit'
+
+module USCoreTestKit
+  module Client
+    module <%= module_name %>
+      class <%= class_name %> < Inferno::TestGroup
+        include URLs
+
+        id :<%= group_id %>
+        title '<%= title %>'
+        description %(
+          <%= description %>
+        )
+
+        def suite_id
+          return config.options[:endpoint_suite_id] if config.options[:endpoint_suite_id].present?
+          
+          '<%= suite_id %>'
+        end
+
+        test do
+          id :<%= test_id %>
+          title '<%= title %>'
+          description %(
+            <%= description %>
+          )
+
+          input :client_id,
+                title: 'Client Id',
+                type: 'text',
+                optional: true,
+                locked: true,
+                description: SMARTAppLaunch::INPUT_CLIENT_ID_DESCRIPTION_LOCKED
+          input :smart_launch_urls,
+                title: 'SMART App Launch URL(s)',
+                type: 'textarea',
+                locked: true,
+                optional: true,
+                description: SMARTAppLaunch::INPUT_SMART_LAUNCH_URLS_DESCRIPTION_LOCKED
+          input :launch_context,
+                title: 'Launch Context',
+                type: 'textarea',
+                optional: true,
+                description: SMARTAppLaunch::INPUT_LAUNCH_CONTEXT_DESCRIPTION       
+          input :fhir_user_relative_reference,
+                title: 'FHIR User Relative Reference',
+                type: 'text',
+                optional: true,
+                description: SMARTAppLaunch::INPUT_FHIR_USER_RELATIVE_REFERENCE
+          
+          input_order :launch_context, :fhir_user_relative_reference, :smart_launch_urls, :client_id
+          output :launch_key
+          config options: { accepts_multiple_requests: true }
+
+          run do
+            if smart_launch_urls.present?
+              launch_key = SecureRandom.hex(32)
+              output(launch_key:)
+            end
+            
+            wait(
+              identifier: client_id,
+              message: %(
+Inferno will now wait for the client under test to make the required requests against the following base URL:
+
+#{fhir_url}
+
+All requests will be recorded. When finished, the requests will be inspected to ensure that the client under test is making the required requests.
+Requests should target the following patient record:
+- **Resource ID**: us-core-client-tests-patient
+- **Name**: ClientTests USCore
+- **Member Identifier**: us-core-client-tests-patient (system: Inferno)
+- **Date of Birth**: 1940-03-29
+- **Gender**: male
+
+[Click here](#{resume_pass_url}?token=#{client_id}) when finished.
+
+The following requirements will be checked:
+
+<%= check_list %>
+
+[Click here](#{resume_pass_url}?token=#{client_id}) when finished.
+              ),
+              timeout: 900
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/generator/token_endpoint_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    class Generator
+      class TokenEndpointGenerator
+        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', 'token_endpoint.rb.erb'))
+        end
+
+        def output
+          @output ||= ERB.new(template, trim_mode: '-').result(binding)
+        end
+
+        def base_output_file_name
+          'token_endpoint.rb'
+        end
+
+        def module_name
+          "USCoreClient#{ig_metadata.reformatted_version.upcase}"
+        end
+
+        def output_file_name
+          File.join(base_output_dir, base_output_file_name)
+        end
+
+        def generate
+          File.write(output_file_name, output)
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/generator/urls_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    class Generator
+      class UrlsGenerator
+        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', 'urls.rb.erb'))
+        end
+
+        def output
+          @output ||= ERB.new(template).result(binding)
+        end
+
+        def base_output_file_name
+          'urls.rb'
+        end
+
+        def module_name
+          "USCoreClient#{ig_metadata.reformatted_version.upcase}"
+        end
+
+        def output_file_name
+          File.join(base_output_dir, base_output_file_name)
+        end
+
+        def suite_id
+          "us_core_client_#{ig_metadata.reformatted_version}"
+        end
+
+        def generate
+          File.write(output_file_name, output)
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/generator/wait_group_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    class Generator
+      class WaitGroupGenerator
+        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', 'wait_group.rb.erb'))
+        end
+
+        def output
+          @output ||= ERB.new(template).result(binding)
+        end
+
+        def class_name
+          "WaitGroup"
+        end
+
+        def base_output_file_name
+          "#{class_name.underscore}.rb"
+        end
+
+        def module_name
+          "USCoreClient#{ig_metadata.reformatted_version.upcase}"
+        end
+
+        def output_file_name
+          File.join(base_output_dir, base_output_file_name)
+        end
+
+        def group_id
+          "us_core_client_wait_group_#{ig_metadata.reformatted_version.downcase}"
+        end
+
+        def test_id
+          "us_core_client_wait_test_#{ig_metadata.reformatted_version.downcase}"
+        end
+
+        def suite_id
+          "us_core_client_#{ig_metadata.reformatted_version}"
+        end
+
+        def title
+          'Wait for Requests'
+        end
+
+        def description
+          <<~DESCRIPTION
+
+            This test will wait for the client under test to submit requests for resources for
+            each of the US Core profiles, and for requests including all of the required search
+            parameters for each resource type.
+          DESCRIPTION
+        end
+
+        def groups
+          ig_metadata.ordered_groups
+            .reject { |group| USCoreTestKit::Generator::SpecialCases.exclude_group? group }
+        end
+
+        def check_list
+          groups
+            .map do |group|
+              profile_name = USCoreTestKit::Generator::Naming.upper_camel_case_for_profile(group)
+              profile_header = "* **#{profile_name}**"
+              profile_id = "  * read id:\n    * us-core-client-tests-#{profile_name.underscore.dasherize}"
+              required_searches = group.searches.each do |search|
+                next unless search[:expectation] == 'SHALL'
+
+                search
+              end
+              searches = "  * searches:"
+              search_list = required_searches.map do |search|
+                "    * #{search[:names].join(' + ')}"
+              end
+              "#{profile_header}\n#{profile_id}\n#{searches}\n#{search_list.join("\n")}"
+            end
+            .join("\n")
+        end
+
+        def generate
+          File.write(output_file_name, output)
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/generator.rb

@@ -0,0 +1,124 @@
+require 'fhir_models'
+require 'inferno/ext/fhir_models'
+
+require_relative '../generator/ig_loader'
+require_relative '../generator/ig_metadata_extractor'
+
+require_relative 'generator/group_generator'
+require_relative 'generator/tags_generator'
+require_relative 'generator/urls_generator'
+require_relative 'generator/suite_generator'
+require_relative 'generator/read_test_generator'
+require_relative 'generator/search_test_generator'
+require_relative 'generator/wait_group_generator'
+require_relative 'generator/read_endpoint_generator'
+require_relative 'generator/search_endpoint_generator'
+require_relative 'generator/authorization_endpoint_generator'
+require_relative 'generator/token_endpoint_generator'
+require_relative 'generator/auth_smart_group_generator'
+require_relative 'generator/auth_udap_group_generator'
+require_relative 'generator/registration_group_generator'
+require_relative 'generator/registration_configuration_display_test_generator'
+
+module USCoreTestKit
+  module Client
+    class Generator
+      def self.generate
+        ig_packages = Dir.glob(File.join(Dir.pwd, 'lib', 'us_core_test_kit', 'igs', '*.tgz'))
+
+        ig_packages.each do |ig_package|
+          new(ig_package).generate
+        end
+      end
+
+      attr_accessor :ig_resources, :ig_metadata, :ig_file_name
+
+      def initialize(ig_file_name)
+        self.ig_file_name = ig_file_name
+      end
+
+      def generate
+        puts "Generating client suites for IG #{File.basename(ig_file_name)}"
+
+        load_ig_package
+        extract_metadata
+
+        generate_tags
+        generate_urls
+        generate_read_tests
+        generate_search_tests
+        generate_wait_group
+        generate_endpoints
+        generate_registration_tests
+        generate_auth_tests
+
+        generate_groups
+        generate_suites
+      end
+
+      def extract_metadata
+        self.ig_metadata = USCoreTestKit::Generator::IGMetadataExtractor.new(ig_resources).extract
+
+        FileUtils.mkdir_p(base_output_dir)
+      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 = USCoreTestKit::Generator::IGLoader.new(ig_file_name).load
+      end
+
+      def generate_groups
+        GroupGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_tags
+        TagsGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_urls
+        UrlsGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_suites
+        SuiteGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_wait_group
+        WaitGroupGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_read_tests
+        ReadTestGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_search_tests
+        SearchTestGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_endpoints
+        ReadEndpointGenerator.generate(ig_metadata, base_output_dir)
+        SearchEndpointGenerator.generate(ig_metadata, base_output_dir)
+        AuthorizationEndpointGenerator.generate(ig_metadata, base_output_dir)
+        TokenEndpointGenerator.generate(ig_metadata, base_output_dir)
+      end
+
+      def generate_registration_tests
+        RegistrationGroupGenerator.generate(ig_metadata, base_output_dir)
+        FileUtils.mkdir_p(File.join(base_output_dir, 'registration'))
+        RegistrationConfigurationDisplayTestGenerator.generate(ig_metadata, base_output_dir, 'smart')
+        RegistrationConfigurationDisplayTestGenerator.generate(ig_metadata, base_output_dir, 'udap')
+      end
+
+      def generate_auth_tests
+        AuthSMARTGroupGenerator.generate(ig_metadata, base_output_dir, 'alca')
+        AuthSMARTGroupGenerator.generate(ig_metadata, base_output_dir, 'alcs')
+        AuthSMARTGroupGenerator.generate(ig_metadata, base_output_dir, 'alp')
+        AuthUDAPGroupGenerator.generate(ig_metadata, base_output_dir)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/metadata/mock_capability_statement.json.erb

@@ -0,0 +1,54 @@
+{
+  "resourceType": "CapabilityStatement",
+  "status": "active",
+  "date": "2021-06-17T18:03:00+00:00",
+  "publisher": "MITRE",
+  "kind": "instance",
+  "instantiates": [
+    "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
+  ],
+  "implementation": {
+      "description": "Inferno US Core Testing Simulation Server",
+      "url": "<%= Inferno::Application['base_url'] %>/custom/us_core_client_<%= version %>/fhir"
+  },
+  "fhirVersion": "4.0.1",
+  "format": [
+      "application/fhir+json"
+  ],
+  "implementationGuide": [
+    "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
+  ],
+  "rest": [
+    {
+      "mode": "server",
+      "security": {
+        "extension": [
+            {
+                "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
+                "extension": [
+                    {
+                        "url": "token",
+                        "valueUri": "<%= Inferno::Application['base_url']  %>/custom/us_core_client_<%= version %>/auth/token"
+                    },
+                    {
+                        "url": "authorize",
+                        "valueUri": "<%= Inferno::Application['base_url']  %>/custom/us_core_client_<%= version %>/auth/authorization"
+                    }
+                ]
+            }
+        ],
+        "service": [
+            {
+                "coding": [
+                    {
+                        "system": "http://hl7.org/fhir/restful-security-service",
+                        "code": "SMART-on-FHIR"
+                    }
+                ],
+                "text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"
+            }
+        ]
+      }
+    }
+  ]
+}

data/lib/us_core_test_kit/client/metadata_helper.rb

@@ -0,0 +1,21 @@
+module USCoreTestKit
+  module Client
+    module MetadataHelper
+      module_function
+
+      def get_metadata(version)
+        erb_template = ERB.new(
+          File.read(
+            File.join(__dir__, 'metadata/mock_capability_statement.json.erb')
+          )
+        )
+        capability_statement = JSON.parse(erb_template.result(binding)).to_json
+
+        proc {
+          [200, { 'Content-Type' => 'application/fhir+json;charset=utf-8', 'Access-Control-Allow-Origin' => '*' },
+          [capability_statement]]
+        }
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/server_proxy.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    module ServerProxy
+      def proxy_client
+        @proxy_client ||= Faraday.new(
+          url: ENV.fetch('FHIR_REFERENCE_SERVER'),
+          params: {},
+          headers: request_headers
+        ) do |proxy|
+          proxy.use FaradayMiddleware::Gzip
+          proxy.options.params_encoder = Faraday::FlatParamsEncoder
+        end
+      end
+
+      def request_headers
+        {
+          'Content-Type' => 'application/json',
+          'Authorization' => 'Bearer SAMPLE_TOKEN',
+        }
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/test_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module USCoreTestKit
+  module Client
+    module TestHelper
+      def filter_requests_by_resource_type(requests, resource_type)
+        requests.select do |request|
+          request.url.split('/').any? { |segment| segment.split('?').first&.casecmp?(resource_type)  }
+        end
+      end
+
+      def filter_requests_by_resource_id(requests, resource_id)
+        requests.select do |request|
+          request.url.split('/').last.split('?').first&.casecmp?(resource_id)
+        end
+      end
+
+      def filter_requests_by_search_parameters(requests, search_parameters)
+        requests.select do |request|
+          included_params = 
+            if request.verb.downcase == 'get'
+              url_params(request.url).keys
+            elsif request.verb.downcase == 'post'
+              CGI.parse(request.request_body).keys
+            end
+          next unless included_params.present?
+
+          search_parameters.all? { |param| included_params.include? param }
+        end
+      end
+
+      def url_params(url)
+        CGI.parse(URI.parse(url).query)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/client/us_core_client_options.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'smart_app_launch_test_kit'
+require 'udap_security_test_kit'
+
+module USCoreTestKit
+  module Client
+    module USCoreClientOptions
+      SMART_APP_LAUNCH_PUBLIC = SMARTAppLaunch::SMARTClientOptions::SMART_APP_LAUNCH_PUBLIC
+      SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC =
+        SMARTAppLaunch::SMARTClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
+      SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC =
+        SMARTAppLaunch::SMARTClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
+      UDAP_AUTHORIZATION_CODE = 
+        UDAPSecurityTestKit::UDAPClientOptions::UDAP_AUTHORIZATION_CODE
+
+      def selected_security_ig(suite_options)
+        if suite_options[:client_type].include?(UDAPSecurityTestKit::UDAP_TAG)
+          UDAPSecurityTestKit::UDAP_TAG
+        else 
+          SMARTAppLaunch::SMART_TAG
+        end
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generator/group_metadata_extractor.rb

@@ -3,6 +3,7 @@ require_relative 'ig_metadata'
 require_relative 'must_support_metadata_extractor'
 require_relative 'search_metadata_extractor'
 require_relative 'terminology_binding_metadata_extractor'
+require_relative 'naming'
 
 module USCoreTestKit
   class Generator

data/lib/us_core_test_kit/practitioner_address_test.rb

@@ -25,7 +25,7 @@ module USCoreTestKit
 
     def verify_practitioner_address
       references = scratch.dig(:references, 'Practitioner')
-      assert references.any?, 'No Practitioner references found.'
+      assert references&.any?, 'No Practitioner references found.'
 
       @missing_elements = MUST_SUPPORT_ELEMENTS
       practitioners = []

data/lib/us_core_test_kit/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module USCoreTestKit
-  VERSION = '0.11.2'
-  LAST_UPDATED = '2025-05-05'
+  VERSION = '0.11.3'
+  LAST_UPDATED = '2025-05-20'
 end

data/lib/us_core_test_kit.rb

@@ -4,4 +4,8 @@ require_relative 'us_core_test_kit/generated/v4.0.0/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v5.0.1/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v6.1.0/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v7.0.0/us_core_test_suite'
-
+require_relative 'us_core_test_kit/client/generated/v3.1.1/us_core_client_test_suite'
+require_relative 'us_core_test_kit/client/generated/v4.0.0/us_core_client_test_suite'
+require_relative 'us_core_test_kit/client/generated/v5.0.1/us_core_client_test_suite'
+require_relative 'us_core_test_kit/client/generated/v6.1.0/us_core_client_test_suite'
+require_relative 'us_core_test_kit/client/generated/v7.0.0/us_core_client_test_suite'