us_core_test_kit 0.11.3 → 0.11.4

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

@@ -7,22 +7,24 @@ module USCoreTestKit
         include TestHelper
 
         id :<%= test_id %>
-
         title '<%= title %>'
-
         description %(
           <%= description %>
         )
 
+        def skip_message
+          "Inferno did not receive any read requests for the `<%= resource_type %>` resource type."
+        end
+
         def failure_message
-          "Did not receive a request for `<%= resource_type %>` with id: `<%= expected_resource_id %>`."
+          "Inferno did not receive the expected read request for the target instance of the <%= group_metadata.profile_name %>: `<%= resource_type %>/<%= expected_resource_id %>`."
         end
 
         run do
           requests = load_tagged_requests(READ_<%= resource.underscore.upcase %>_TAG)
-          requests = load_tagged_requests(READ_REQUEST_TAG) if requests.empty?
-          requests_of_type = filter_requests_by_resource_type(requests, '<%= resource_type %>')
-          requests_for_id = filter_requests_by_resource_id(requests_of_type, '<%= expected_resource_id %>')
+          skip_if requests.blank?, skip_message
+
+          requests_for_id = filter_requests_by_resource_id(requests, '<%= expected_resource_id %>')
           assert requests_for_id.any?, failure_message
         end
       end

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

@@ -7,7 +7,7 @@ module USCoreTestKit
         include URLs
 
         id :us_core_client_<%= version %>_reg_config_<%= protocol.downcase %>_display
-        title 'Confirm client configuration'
+        title 'Confirm Client Configuration'
         description %(
           This test provides all the information needed for testers to configure
           the client under test to communicate with Inferno's simulated US Core server

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

@@ -1,8 +1,6 @@
-require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
 require_relative '../../us_core_client_options'
 require_relative 'registration/configuration_display_smart_test'
-require_relative 'registration/configuration_display_udap_test'
 
 module USCoreTestKit
   module Client
@@ -11,9 +9,10 @@ module USCoreTestKit
         id :us_core_client_<%= version %>_registration
         title 'Client Registration'
         description %(
-          Register the client under test with Inferno's simulated US Core Server,
+          During these tests, the client will register with Inferno's simulated US Core Server,
           including configuration of the system under test to hit the correct endpoints and
-          enable authentication and authorization of US Core requests.
+          enable authentication and authorization of US Core requests. Inferno will verify
+          that the registration details are conformant.
         )
         run_as_group
 
@@ -45,24 +44,6 @@ module USCoreTestKit
               required_suite_options: {
                 client_type: USCoreClientOptions::SMART_APP_LAUNCH_PUBLIC
               }
-
-        # udap registration tests
-        test from: :udap_client_registration_interaction,
-            id: :us_core_client_<%= version %>_reg_udap_interaction,
-            config: { options: { endpoint_suite_id: :us_core_client_<%= version %> } },
-            required_suite_options: {
-              client_type: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
-            }
-        test from: :udap_client_registration_ac_verification,
-            id: :us_core_client_<%= version %>_reg_udap_verification,
-            config: { options: { endpoint_suite_id: :us_core_client_<%= version %> } },
-            required_suite_options: {
-              client_type: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
-            }
-        test from: :us_core_client_<%= version %>_reg_config_udap_display,
-              required_suite_options: {
-                client_type: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
-              }
       end
     end
   end

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

@@ -2,28 +2,23 @@
 
 require_relative '../../server_proxy'
 require_relative 'tags'
+require_relative 'urls'
 
 module USCoreTestKit
   module Client
     module <%= module_name %>
       class SearchEndpoint < Inferno::DSL::SuiteEndpoint
         include ServerProxy
+        include URLs
 
         def test_run_identifier
-          UDAPSecurityTestKit::MockUDAPServer.issued_token_to_client_id(
+          SMARTAppLaunch::MockSMARTServer.issued_token_to_client_id(
             request.headers['authorization']&.delete_prefix('Bearer ')
           )
         end
 
         def make_response
-          server_response = proxy_request
-          response.status = server_response.status
-          response.body = server_response.body
-        end
-
-        def proxy_request
-          puts request_params
-          proxy_client.get(resource_type, request_params)
+          build_proxied_search_response
         end
 
         def tags
@@ -43,8 +38,8 @@ module USCoreTestKit
           request.params[:resource_type]
         end
 
-        def request_params
-          request.params.to_h.except(:resource_type).stringify_keys
+        def suite_id
+          USCoreClientTestSuite.id
         end
       end
     end

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

@@ -7,26 +7,29 @@ module USCoreTestKit
         include TestHelper
 
         id :<%= test_id %>
-
         title '<%= title %>'
-
         description %(
           <%= description %>
         )
+        optional <%= optional? %>
 
         def required_params
           <%= search_metadata[:names] %>
         end
 
+        def skip_message
+          "Inferno did not receive any search requests for the `<%= resource_type %>` resource type."
+        end
+
         def failure_message
-          "Did not receive a request for `<%= resource_type %>` with required search parameters: `#{required_params.join(' + ')}`"
+          "Inferno did not receive the expected search made for the `<%= resource_type %>` resource type with required search parameters: `#{required_params.join(' + ')}`."
         end
 
         run do
           requests = load_tagged_requests(SEARCH_<%= resource.underscore.upcase %>_TAG)
-          requests = load_tagged_requests(SEARCH_REQUEST_TAG) if requests.empty?
-          requests_of_type = filter_requests_by_resource_type(requests, '<%= resource_type %>')
-          requests_with_params = filter_requests_by_search_parameters(requests_of_type, required_params)
+          skip_if requests.blank?, skip_message
+
+          requests_with_params = filter_requests_by_search_parameters(requests, required_params)
           assert requests_with_params.any?, failure_message
         end
       end

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
 require_relative '../../../version'
 require_relative 'tags'
 require_relative 'urls'
 require_relative '../../metadata_helper'
-require_relative 'authorization_endpoint'
-require_relative 'token_endpoint'
 require_relative 'read_endpoint'
 require_relative 'search_endpoint'
 require_relative '../../test_helper'
@@ -17,7 +14,6 @@ require_relative 'wait_group'
 require_relative 'auth_smart_alca_group'
 require_relative 'auth_smart_alcs_group'
 require_relative 'auth_smart_alp_group'
-require_relative 'auth_udap_group'
 <%- group_file_list.each do |group| -%>
 require_relative '<%= group %>'
 <%- end -%>
@@ -29,9 +25,7 @@ module USCoreTestKit
         include URLs
 
         id :<%= suite_id %>
-
         title '<%= title %>'
-
         description %(
           <%= description %>
         )
@@ -51,6 +45,10 @@ module USCoreTestKit
             type: 'download',
             label: 'Download',
             url: 'https://github.com/inferno-framework/us-core-test-kit/releases/'
+          },
+          {
+            label: 'Implementation Guide',
+            url: '<%= ig_link %>'
           }
         ]
 
@@ -68,17 +66,10 @@ module USCoreTestKit
                         {
                           label: 'SMART App Launch Confidential Asymmetric Client',
                           value: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
-                        },
-                        {
-                          label: 'UDAP Authorization Code Client',
-                          value: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
                         }
                       ]
 
         route(:get, METADATA_PATH, USCoreTestKit::Client::MetadataHelper.get_metadata('<%= ig_metadata.reformatted_version.downcase %>'))
-        route(:get, UDAPSecurityTestKit::UDAP_DISCOVERY_PATH, lambda { |_env|
-          UDAPSecurityTestKit::MockUDAPServer.udap_server_metadata(id)
-        })
         route(:get, SMARTAppLaunch::SMART_DISCOVERY_PATH, lambda { |_env|
           SMARTAppLaunch::MockSMARTServer.smart_server_metadata(id)
         })
@@ -89,11 +80,9 @@ module USCoreTestKit
           ->(_env) { [200, { 'Content-Type' => 'application/json' }, [SMARTAppLaunch::OIDCJWKS.jwks_json]] }
         )
 
-        suite_endpoint :post, UDAPSecurityTestKit::REGISTRATION_PATH,
-                        UDAPSecurityTestKit::MockUDAPServer::RegistrationEndpoint
-        suite_endpoint :post, UDAPSecurityTestKit::TOKEN_PATH, MockUdapSmartServer::TokenEndpoint
-        suite_endpoint :get,  UDAPSecurityTestKit::AUTHORIZATION_PATH, MockUdapSmartServer::AuthorizationEndpoint
-        suite_endpoint :post, UDAPSecurityTestKit::AUTHORIZATION_PATH, MockUdapSmartServer::AuthorizationEndpoint
+        suite_endpoint :post, SMARTAppLaunch::TOKEN_PATH, SMARTAppLaunch::MockSMARTServer::TokenEndpoint
+        suite_endpoint :get,  SMARTAppLaunch::AUTHORIZATION_PATH, SMARTAppLaunch::MockSMARTServer::AuthorizationEndpoint
+        suite_endpoint :post, SMARTAppLaunch::AUTHORIZATION_PATH, SMARTAppLaunch::MockSMARTServer::AuthorizationEndpoint
 
         suite_endpoint :post, SEARCH_POST_ROUTE, SearchEndpoint
         suite_endpoint :get, SEARCH_ROUTE, SearchEndpoint
@@ -108,31 +97,25 @@ module USCoreTestKit
         group do
           id :us_core_client_read_search_group_<%= ig_metadata.reformatted_version.downcase %>
           title 'Read & Search'
+          description %(
+            <%= read_and_search_description %>
+          )
 
-          run_as_group
-
-          group from: :<%= wait_group_id %>
-
-          group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alca,
-              required_suite_options: {
-                client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
-              }
-          group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alcs,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
-                }
-          group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alp,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::SMART_APP_LAUNCH_PUBLIC
-                }
-          group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_udap,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
-                }
+          group from: :<%= access_group_id %>
 
           <%- group_id_list.each do |group| -%>
           group from: :<%= group %>
           <%- end -%>
+
+          run do
+            passing_profile_group = groups.find do |group|
+              next if group.id.include?('wait') || group.id.include?('auth')
+
+              results[group.id]&.result == 'pass'
+            end
+
+            assert passing_profile_group.present?, 'At least one profile group must pass.'
+          end
         end
       end
     end

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

@@ -25,7 +25,7 @@ module USCoreTestKit
           base_url + FHIR_ROUTE
         end
 
-        def client_fhir_base_url # alias for OIDC from SMART / UDAP client tests
+        def client_fhir_base_url # alias for OIDC from SMART client tests
           fhir_url
         end
 

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

@@ -1,92 +1,124 @@
 # frozen_string_literal: true
 
 require 'smart_app_launch_test_kit'
+require_relative 'auth_smart_alca_group'
+require_relative 'auth_smart_alcs_group'
+require_relative 'auth_smart_alp_group'
 
 module USCoreTestKit
   module Client
-    module <%= module_name %>
+    module USCoreClient<%= ig_metadata.reformatted_version.upcase %>
       class <%= class_name %> < Inferno::TestGroup
         include URLs
 
-        id :<%= group_id %>
-        title '<%= title %>'
+        id :us_core_client_access_group_<%= ig_metadata.reformatted_version.downcase %>
+        title 'Client Access'
         description %(
-          <%= description %>
+          During these tests, Inferno will simulate a US Core FHIR Server for the client to
+          use to access data. Inferno will wait while the client submits requests and will
+          both respond with data and collect the requests for later analysis.
         )
 
+        run_as_group
+
         def suite_id
           return config.options[:endpoint_suite_id] if config.options[:endpoint_suite_id].present?
           
-          '<%= suite_id %>'
+          'us_core_client_<%= ig_metadata.reformatted_version.downcase %>'
         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
+        group do
+          id :us_core_client_wait_group_<%= ig_metadata.reformatted_version.downcase %>
+          title 'Perform Data Access'
+
+          test do
+            id :us_core_client_wait_test_<%= ig_metadata.reformatted_version.downcase %>
+            title 'Wait for Requests'
+            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.
+            )
+
+            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: %(
+                    A FHIR relative reference (<resource type>/<id>) for the FHIR user record to return
+                    when the openid and fhirUser scopes are requested. If populated, ensure that the
+                    referenced resource is available in Inferno's simulated FHIR server so that it can
+                    be accessed.
+                  )
             
-            wait(
-              identifier: client_id,
-              message: %(
-Inferno will now wait for the client under test to make the required requests against the following base URL:
+            input_order :launch_context, :fhir_user_relative_reference, :smart_launch_urls, :client_id
+            output :launch_key
+            config options: { accepts_multiple_requests: true }
 
-#{fhir_url}
+            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:
 
-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
+  #{fhir_url}
 
-[Click here](#{resume_pass_url}?token=#{client_id}) when finished.
+  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: `urn:inferno:mrn`)
+  - **Date of Birth**: 1940-03-29
+  - **Gender**: male
 
-The following requirements will be checked:
+  [Click here](#{resume_pass_url}?token=#{client_id}) when finished.
 
-<%= check_list %>
+  The following requirements will be checked:
 
-[Click here](#{resume_pass_url}?token=#{client_id}) when finished.
-              ),
-              timeout: 900
-            )
+  <%= check_list %>
+
+  [Click here](#{resume_pass_url}?token=#{client_id}) when finished.
+                ),
+                timeout: 900
+              )
+            end
           end
         end
+
+        group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alca,
+              required_suite_options: {
+                client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
+              }
+        group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alcs,
+              required_suite_options: {
+                client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
+              }
+        group from: :us_core_client_<%= ig_metadata.reformatted_version.downcase %>_auth_smart_alp,
+              required_suite_options: {
+                client_type: USCoreClientOptions::SMART_APP_LAUNCH_PUBLIC
+              }
       end
     end
   end

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

@@ -33,39 +33,10 @@ module USCoreTestKit
           "#{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 }

data/lib/us_core_test_kit/client/generator.rb

@@ -1,7 +1,7 @@
 require 'fhir_models'
 require 'inferno/ext/fhir_models'
 
-require_relative '../generator/ig_loader'
+require_relative 'generator/ig_loader'
 require_relative '../generator/ig_metadata_extractor'
 
 require_relative 'generator/group_generator'
@@ -13,10 +13,7 @@ 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'
 
@@ -68,7 +65,7 @@ module USCoreTestKit
 
       def load_ig_package
         FHIR.logger = Logger.new('/dev/null')
-        self.ig_resources = USCoreTestKit::Generator::IGLoader.new(ig_file_name).load
+        self.ig_resources = IGLoader.new(ig_file_name).load
       end
 
       def generate_groups
@@ -90,7 +87,7 @@ module USCoreTestKit
       def generate_wait_group
         WaitGroupGenerator.generate(ig_metadata, base_output_dir)
       end
-
+      
       def generate_read_tests
         ReadTestGenerator.generate(ig_metadata, base_output_dir)
       end
@@ -102,22 +99,18 @@ module USCoreTestKit
       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