davinci_dtr_test_kit 0.16.0 → 0.16.2

data/lib/davinci_dtr_test_kit/dtr_full_ehr_suite.rb

@@ -1,12 +1,19 @@
+require 'udap_security_test_kit'
+require 'smart_app_launch_test_kit'
 require_relative 'client_groups/custom_static/dtr_full_ehr_custom_static_workflow_group'
 require_relative 'client_groups/dinner_static/dtr_full_ehr_static_dinner_workflow_group'
-require_relative 'client_groups/dinner_adaptive/dtr_full_ehr_adaptive_dinner_workflow_group'
-require_relative 'auth_groups/oauth2_authentication_group'
+require_relative 'client_groups/adaptive_questionnaire/dinner_order/dtr_full_ehr_adaptive_dinner_workflow_group'
+require_relative 'client_groups/adaptive_questionnaire/custom/dtr_full_ehr_custom_adaptive_workflow_group'
+require_relative 'client_groups/payer_registration/dtr_client_registration_group'
+require_relative 'client_groups/must_support/dtr_full_ehr_questionnaire_must_support_group'
+require_relative 'client_groups/auth/dtr_client_payer_auth_smart_group'
+require_relative 'client_groups/auth/dtr_client_payer_auth_udap_group'
 require_relative 'endpoints/cors'
-require_relative 'endpoints/mock_authorization/simple_token_endpoint'
+require_relative 'endpoints/mock_udap_smart_server/token_endpoint'
 require_relative 'endpoints/mock_payer/full_ehr_questionnaire_package_endpoint'
 require_relative 'endpoints/mock_payer/full_ehr_next_question_endpoint'
 require_relative 'version'
+require_relative 'dtr_client_options'
 
 module DaVinciDTRTestKit
   class DTRFullEHRSuite < Inferno::TestSuite
@@ -35,9 +42,30 @@ module DaVinciDTRTestKit
       }
     ]
 
+    requirement_sets(
+      {
+        identifier: 'hl7.fhir.us.davinci-dtr_2.0.1',
+        title: 'Da Vinci Documentation Templates and Rules (DTR) v2.0.1',
+        actor: 'Full EHR'
+      }
+    )
+
+    suite_option :client_type,
+                 title: 'Client Security Type',
+                 list_options: [
+                   {
+                     label: 'SMART Backend Services',
+                     value: DTRClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
+                   },
+                   {
+                     label: 'UDAP B2B Client Credentials',
+                     value: DTRClientOptions::UDAP_CLIENT_CREDENTIALS
+                   }
+                 ]
+
     # Hl7 Validator Wrapper:
     fhir_resource_validator do
-      igs 'hl7.fhir.us.davinci-dtr#2.0.1'
+      igs 'igs/davinci_dtr_2.0.1.tgz'
 
       exclude_message do |message|
         message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
@@ -46,7 +74,16 @@ module DaVinciDTRTestKit
 
     allow_cors QUESTIONNAIRE_PACKAGE_PATH, NEXT_PATH
 
-    suite_endpoint :post, PAYER_TOKEN_PATH, MockAuthorization::SimpleTokenEndpoint
+    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)
+    })
+
+    suite_endpoint :post, UDAPSecurityTestKit::REGISTRATION_PATH,
+                   UDAPSecurityTestKit::MockUDAPServer::RegistrationEndpoint
+    suite_endpoint :post, UDAPSecurityTestKit::TOKEN_PATH, MockUdapSmartServer::TokenEndpoint
 
     suite_endpoint :post, QUESTIONNAIRE_PACKAGE_PATH, MockPayer::FullEHRQuestionnairePackageEndpoint
     suite_endpoint :post, NEXT_PATH, MockPayer::FullEHRNextQuestionEndpoint
@@ -59,13 +96,13 @@ module DaVinciDTRTestKit
       request.query_parameters['token']
     end
 
-    group from: :oauth2_authentication
+    group from: :dtr_client_payer_registration
     group do
       id :dtr_full_ehr_basic_workflows
       title 'Basic Workflows'
 
       group from: :dtr_full_ehr_custom_static_workflow
-      group from: :dtr_full_ehr_adaptive_dinner_workflow
+      group from: :dtr_full_ehr_custom_adaptive_workflow
     end
     group do
       id :dtr_full_ehr_questionnaire_functionality
@@ -75,6 +112,17 @@ module DaVinciDTRTestKit
         covering additional pre-population features of questionnaires.
       )
       group from: :dtr_full_ehr_static_dinner_workflow
+      group from: :dtr_full_ehr_adaptive_dinner_workflow
     end
+    group from: :dtr_full_ehr_questionnaire_ms
+
+    group from: :dtr_client_payer_auth_smart,
+          required_suite_options: {
+            client_type: DTRClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
+          }
+    group from: :dtr_client_payer_auth_udap,
+          required_suite_options: {
+            client_type: DTRClientOptions::UDAP_CLIENT_CREDENTIALS
+          }
   end
 end

data/lib/davinci_dtr_test_kit/dtr_light_ehr_suite.rb

@@ -43,6 +43,14 @@ module DaVinciDTRTestKit
       }
     ]
 
+    requirement_sets(
+      {
+        identifier: 'hl7.fhir.us.davinci-dtr_2.0.1',
+        title: 'Da Vinci Documentation Templates and Rules (DTR) v2.0.1',
+        actor: 'Light EHR'
+      }
+    )
+
     # Hl7 Validator Wrapper:
     fhir_resource_validator do
       igs('hl7.fhir.us.davinci-dtr#2.0.1', 'hl7.fhir.us.davinci-pas#2.0.1', 'hl7.fhir.us.davinci-crd#2.0.1')

data/lib/davinci_dtr_test_kit/dtr_payer_server_suite.rb

@@ -34,6 +34,14 @@ module DaVinciDTRTestKit
       }
     ]
 
+    requirement_sets(
+      {
+        identifier: 'hl7.fhir.us.davinci-dtr_2.0.1',
+        title: 'Da Vinci Documentation Templates and Rules (DTR) v2.0.1',
+        actor: 'Payer Service'
+      }
+    )
+
     # These inputs will be available to all tests in this suite
 
     input :retrieval_method,

data/lib/davinci_dtr_test_kit/dtr_questionnaire_response_validation.rb

@@ -29,14 +29,7 @@ module DaVinciDTRTestKit
                 "Couldn't find Questionnaire #{qr.questionnaire} in the provided custom questionnaire package
                 to validate the QuestionnaireResponse."
 
-        missing_origin_sources = ['auto', 'manual', 'override'] - extract_origin_sources(qr.item)
-        unless missing_origin_sources.empty?
-          add_message(
-            'error',
-            'All origin sources (auto, manual, override) must be present in the QuestionnaireResponse. ' \
-            "Missing #{missing_origin_sources.to_sentence}"
-          )
-        end
+        check_missing_origin_sources(qr)
       end
 
       check_origin_sources(questionnaire.item, qr.item, expected_overrides:)
@@ -46,6 +39,18 @@ module DaVinciDTRTestKit
       assert(messages.none? { |m| m[:type] == 'error' }, 'QuestionnaireResponse is not correct, see error message(s)')
     end
 
+    def check_missing_origin_sources(questionnaire_response, index = nil)
+      missing_origin_sources = ['auto', 'manual', 'override'] - extract_origin_sources(questionnaire_response.item)
+      return if missing_origin_sources.empty?
+
+      prefix = index ? "Request #{index}: " : ''
+      add_message(
+        'error',
+        "#{prefix}All origin sources (auto, manual, override) must be present in the QuestionnaireResponse. " \
+        "Missing #{missing_origin_sources.to_sentence}"
+      )
+    end
+
     def check_is_questionnaire_response(questionnaire_response_json)
       assert_valid_json(questionnaire_response_json)
       questionnaire_response = begin
@@ -65,9 +70,10 @@ module DaVinciDTRTestKit
     end
 
     # This only checks answers in the questionnaire response, meaning it does not catch missing answers
-    def check_origin_sources(questionnaire_items, response_items, expected_overrides: [])
+    def check_origin_sources(questionnaire_items, response_items, expected_overrides: [], index: nil)
+      prefix = index ? "Request #{index}: " : ''
       response_items&.each do |response_item|
-        check_origin_sources(questionnaire_items, response_item.item, expected_overrides:)
+        check_origin_sources(questionnaire_items, response_item.item, expected_overrides:, index:)
         next unless response_item.answer&.any?
 
         link_id = response_item.linkId
@@ -76,20 +82,25 @@ module DaVinciDTRTestKit
         is_cql_expression = item_is_cql_expression?(questionnaire_item)
 
         if origin_source.nil?
-          add_message('error', "Required `origin.source` extension not present on answer to item `#{link_id}`")
+          add_message('error', "#{prefix}Required `origin.source` extension not present on answer to item `#{link_id}`")
         else
-          check_origin_source(origin_source, link_id, is_cql_expression, override: expected_overrides.include?(link_id))
+          check_origin_source(
+            origin_source, link_id, is_cql_expression,
+            override: expected_overrides.include?(link_id),
+            index:
+          )
         end
       end
     end
 
-    def check_origin_source(origin_source, link_id, is_cql_expression, override: false)
+    def check_origin_source(origin_source, link_id, is_cql_expression, override: false, index: nil) # rubocop:disable  Metrics/CyclomaticComplexity
+      prefix = index ? "Request #{index}: " : ''
       if override
-        origin_source_error(link_id, ['override'], origin_source) unless origin_source == 'override'
+        origin_source_error(link_id, ['override'], origin_source, prefix) unless origin_source == 'override'
       elsif is_cql_expression && !['auto', 'override'].include?(origin_source)
-        origin_source_error(link_id, 'auto or override', origin_source)
+        origin_source_error(link_id, 'auto or override', origin_source, prefix)
       elsif !is_cql_expression && origin_source != 'manual'
-        origin_source_error(link_id, 'manual', origin_source)
+        origin_source_error(link_id, 'manual', origin_source, prefix)
       end
     end
 
@@ -104,11 +115,13 @@ module DaVinciDTRTestKit
 
     # Ensures that all required questions have been answered.
     # If required_link_ids not provided, all questions are treated as optional.
-    def check_answer_presence(response_items, required_link_ids = [])
+    def check_answer_presence(response_items, required_link_ids = [], index = nil)
+      prefix = index ? "Request #{index}: " : ''
+
       required_link_ids.each do |link_id|
         item = find_item_by_link_id(response_items, link_id)
         unless item&.answer&.any? { |answer| answer.value.present? }
-          add_message('error', "No answer for item #{link_id}")
+          add_message('error', "#{prefix}No answer for item #{link_id}")
         end
       end
     end
@@ -176,7 +189,6 @@ module DaVinciDTRTestKit
                                                questionnaire_cql_expression_link_ids,
                                                expected_prepopulated = {},
                                                expected_overrides = {})
-
       questionnaire_cql_expression_link_ids.each do |target_link_id|
         target_item = find_item_by_link_id(template_questionnaire_response.item, target_link_id)
         raise "Template QuestionnaireResponse missing item with link id `#{target_link_id}`" unless target_item.present?
@@ -235,8 +247,8 @@ module DaVinciDTRTestKit
       end
     end
 
-    def origin_source_error(link_id, expected, actual)
-      add_message('error', %(`origin.source` extension on item `#{link_id}` contains unexpected value.
+    def origin_source_error(link_id, expected, actual, msg_prefix = nil)
+      add_message('error', %(#{msg_prefix}`origin.source` extension on item `#{link_id}` contains unexpected value.
                              Expected: #{expected}. Found: #{actual}))
     end
 

data/lib/davinci_dtr_test_kit/dtr_smart_app_suite.rb

@@ -1,8 +1,10 @@
 require_relative 'auth_groups/oauth2_authentication_group'
 require_relative 'client_groups/respiratory/dtr_smart_app_respiratory_workflow_group'
 require_relative 'client_groups/dinner_static/dtr_smart_app_static_dinner_workflow_group'
-require_relative 'client_groups/dinner_adaptive/dtr_smart_app_adaptive_dinner_workflow_group'
+require_relative 'client_groups/adaptive_questionnaire/dinner_order/dtr_smart_app_adaptive_dinner_workflow_group'
 require_relative 'client_groups/custom_static/dtr_smart_app_custom_static_workflow_group'
+require_relative 'client_groups/adaptive_questionnaire/custom/dtr_smart_app_custom_adaptive_workflow_group'
+require_relative 'client_groups/must_support/dtr_smart_app_questionnaire_must_support_group'
 require_relative 'endpoints/cors'
 require_relative 'endpoints/mock_authorization'
 require_relative 'endpoints/mock_authorization/authorize_endpoint'
@@ -41,9 +43,17 @@ module DaVinciDTRTestKit
       }
     ]
 
+    requirement_sets(
+      {
+        identifier: 'hl7.fhir.us.davinci-dtr_2.0.1',
+        title: 'Da Vinci Documentation Templates and Rules (DTR) v2.0.1',
+        actor: 'SMART Client'
+      }
+    )
+
     # Hl7 Validator Wrapper:
     fhir_resource_validator do
-      igs 'hl7.fhir.us.davinci-dtr#2.0.1'
+      igs 'igs/davinci_dtr_2.0.1.tgz'
 
       exclude_message do |message|
         message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
@@ -90,10 +100,9 @@ module DaVinciDTRTestKit
       )
 
       group from: :dtr_smart_app_custom_static_workflow
-      group from: :dtr_smart_app_adaptive_dinner_workflow
+      group from: :dtr_smart_app_custom_adaptive_workflow
     end
     group do
-      id :dtr_smart_app_questionnaire_functionality
       title 'Questionnaire Functionality Coverage'
       description %(
         Tests in this group validate that the client can complete additional DTR workflows
@@ -101,6 +110,8 @@ module DaVinciDTRTestKit
       )
       group from: :dtr_smart_app_resp_workflow
       group from: :dtr_smart_app_static_dinner_workflow
+      group from: :dtr_smart_app_adaptive_dinner_workflow
     end
+    group from: :dtr_smart_app_questionnaire_ms
   end
 end

data/lib/davinci_dtr_test_kit/endpoints/mock_ehr.rb

@@ -21,7 +21,7 @@ module DaVinciDTRTestKit
         # Overwrite the OAuth URIs returned by the reference server to point to the suite endpoints instead
         oauth_uris_url = 'http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris'
         base_url = MockAuthorization.env_base_url(env, METADATA_PATH)
-        sec_ext = cs.rest.first&.security&.extension&.delete_if { |e| e.url == oauth_uris_url }
+        sec_ext = cs.rest.first&.security&.extension&.delete_if { |e| e.url == oauth_uris_url } # rubocop:disable Style/SafeNavigationChainLength
         sec_ext&.push(
           FHIR::Extension.new(
             url: oauth_uris_url,

data/lib/davinci_dtr_test_kit/endpoints/mock_payer/full_ehr_next_question_endpoint.rb

@@ -4,7 +4,26 @@ module DaVinciDTRTestKit
   module MockPayer
     class FullEHRNextQuestionEndpoint < NextQuestionEndpoint
       def test_run_identifier
-        request.headers['authorization']&.delete_prefix('Bearer ')
+        return request.params[:session_path] if request.params[:session_path].present?
+
+        UDAPSecurityTestKit::MockUDAPServer.issued_token_to_client_id(
+          request.headers['authorization']&.delete_prefix('Bearer ')
+        )
+      end
+
+      def make_response
+        return if response.status == 401 # set in update_result (expired token handling there)
+
+        super
+      end
+
+      def update_result
+        if UDAPSecurityTestKit::MockUDAPServer.request_has_expired_token?(request)
+          UDAPSecurityTestKit::MockUDAPServer.update_response_for_expired_token(response, 'Bearer token')
+          return
+        end
+
+        super
       end
     end
   end

data/lib/davinci_dtr_test_kit/endpoints/mock_payer/full_ehr_questionnaire_package_endpoint.rb

@@ -1,10 +1,30 @@
+require 'udap_security_test_kit'
 require_relative 'questionnaire_package_endpoint'
 
 module DaVinciDTRTestKit
   module MockPayer
     class FullEHRQuestionnairePackageEndpoint < QuestionnairePackageEndpoint
       def test_run_identifier
-        request.headers['authorization']&.delete_prefix('Bearer ')
+        return request.params[:session_path] if request.params[:session_path].present?
+
+        UDAPSecurityTestKit::MockUDAPServer.issued_token_to_client_id(
+          request.headers['authorization']&.delete_prefix('Bearer ')
+        )
+      end
+
+      def make_response
+        return if response.status == 401 # set in update_result (expired token handling there)
+
+        super
+      end
+
+      def update_result
+        if UDAPSecurityTestKit::MockUDAPServer.request_has_expired_token?(request)
+          UDAPSecurityTestKit::MockUDAPServer.update_response_for_expired_token(response, 'Bearer token')
+          return
+        end
+
+        super
       end
     end
   end

data/lib/davinci_dtr_test_kit/endpoints/mock_payer/next_question_endpoint.rb

@@ -22,6 +22,29 @@ module DaVinciDTRTestKit
         response.body = build_questionnaire_next_response.to_json
       end
 
+      def custom_next_question_requests
+        requests_repo.tagged_requests(test_run.test_session_id, ["custom_#{DaVinciDTRTestKit::CLIENT_NEXT_TAG}"])
+      end
+
+      def custom_questionnaires
+        return @custom_questionnaires unless @custom_questionnaires.nil?
+
+        questionnaires = JSON.parse(result.input_json)
+          .find { |input| input['name'].include?('custom_next_question_questionnaires') }
+          &.dig('value')
+        return unless questionnaires
+
+        @custom_questionnaires = [JSON.parse(questionnaires)].flatten.compact
+      end
+
+      def next_custom_questionnaire
+        custom_questionnaires[custom_next_question_requests.length]
+      end
+
+      def complete_questionnaire?
+        custom_questionnaires && next_custom_questionnaire.blank?
+      end
+
       def update_result
         results_repo.update_result(result.id, 'pass') unless test.config.options[:accepts_multiple_requests]
       end
@@ -41,9 +64,9 @@ module DaVinciDTRTestKit
 
         questionnaire_response_param = FHIR::Parameters::Parameter.new(name: 'return', resource: questionnaire_response)
 
-        if questionnaire_last_dinner_order_question_present?(questionnaire_response)
+        if complete_questionnaire? || questionnaire_last_dinner_order_question_present?(questionnaire_response)
           # change the questionnaire response status to completed and return the parameters
-          return handle_last_dinner_order(questionnaire_response)
+          return complete_questionnaire(questionnaire_response)
         end
 
         next_questionnaire = determine_next_questionnaire(questionnaire_response, test.id)
@@ -103,15 +126,17 @@ module DaVinciDTRTestKit
       end
 
       def determine_next_questionnaire(questionnaire_response, test_id)
+        if custom_questionnaires
+          FHIR.from_contents(next_custom_questionnaire.to_json)
         # Retrieve the selected option from the response and determine the next set of questions
-        if questionnaire_dinner_order_selection_present?(questionnaire_response)
+        elsif questionnaire_dinner_order_selection_present?(questionnaire_response)
           dinner_question_from_selection(questionnaire_response, test_id)
         else
           Fixtures.next_question_for_test(test_id)
         end
       end
 
-      def handle_last_dinner_order(questionnaire_response)
+      def complete_questionnaire(questionnaire_response)
         update_questionnaire_response(questionnaire_response)
         questionnaire_response
       end

data/lib/davinci_dtr_test_kit/endpoints/mock_payer/questionnaire_package_endpoint.rb

@@ -12,7 +12,7 @@ module DaVinciDTRTestKit
       end
 
       def tags
-        [QUESTIONNAIRE_PACKAGE_TAG]
+        [test.config.options[:questionnaire_package_tag].presence || QUESTIONNAIRE_PACKAGE_TAG]
       end
 
       def make_response

data/lib/davinci_dtr_test_kit/endpoints/mock_udap_smart_server/token_endpoint.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'udap_security_test_kit'
+require 'smart_app_launch_test_kit'
+require_relative '../../urls'
+require_relative '../../tags'
+
+module DaVinciDTRTestKit
+  module MockUdapSmartServer
+    class TokenEndpoint < Inferno::DSL::SuiteEndpoint
+      include SMARTAppLaunch::MockSMARTServer::SMARTTokenResponseCreation
+      include UDAPSecurityTestKit::MockUDAPServer::UDAPTokenResponseCreation
+
+      def test_run_identifier
+        UDAPSecurityTestKit::MockUDAPServer.client_id_from_client_assertion(request.params[:client_assertion])
+      end
+
+      def make_response
+        if request.params[:udap].present?
+          make_udap_client_credential_token_response
+        else
+          make_smart_client_credential_token_response
+        end
+      end
+
+      def update_result
+        nil # never update for now
+      end
+
+      def tags
+        type_tag = request.params[:udap].present? ? UDAPSecurityTestKit::UDAP_TAG : SMARTAppLaunch::SMART_TAG
+        [UDAPSecurityTestKit::TOKEN_TAG, UDAPSecurityTestKit::CLIENT_CREDENTIALS_TAG, type_tag]
+      end
+    end
+  end
+end