davinci_dtr_test_kit 0.9.0

data/lib/davinci_dtr_test_kit/dtr_smart_app_suite.rb

@@ -0,0 +1,85 @@
+require_relative 'ext/inferno_core/runnable'
+require_relative 'ext/inferno_core/record_response_route'
+require_relative 'ext/inferno_core/request'
+require_relative 'auth_groups/oauth2_authentication_group'
+require_relative 'client_groups/resp_assist_device/dtr_smart_app_questionnaire_workflow_group'
+require_relative 'client_groups/dinner_static/dtr_smart_app_questionnaire_workflow_group'
+require_relative 'client_groups/dinner_adaptive/dtr_smart_app_questionnaire_workflow_group'
+require_relative 'mock_payer'
+require_relative 'mock_ehr'
+require_relative 'version'
+
+module DaVinciDTRTestKit
+  class DTRSmartAppSuite < Inferno::TestSuite
+    extend MockPayer
+    extend MockEHR
+
+    id :dtr_smart_app
+    title 'Da Vinci DTR SMART App Test Suite'
+    description File.read(File.join(__dir__, 'docs', 'dtr_smart_app_suite_description_v201.md'))
+
+    version VERSION
+
+    # All FHIR validation requsets will use this FHIR validator
+    validator do
+      url ENV.fetch('VALIDATOR_URL')
+    end
+
+    allow_cors QUESTIONNAIRE_PACKAGE_PATH, QUESTIONNAIRE_RESPONSE_PATH, FHIR_RESOURCE_PATH, FHIR_SEARCH_PATH
+
+    route(:get, '/fhir/metadata', method(:metadata_handler))
+
+    record_response_route :post, TOKEN_PATH, 'dtr_auth', method(:token_response) do |request|
+      DTRSmartAppSuite.extract_client_id(request)
+    end
+
+    record_response_route :post, QUESTIONNAIRE_PACKAGE_PATH, QUESTIONNAIRE_PACKAGE_TAG,
+                          method(:questionnaire_package_response), resumes: ->(_) { false } do |request|
+      DTRSmartAppSuite.extract_bearer_token(request)
+    end
+
+    record_response_route :post, QUESTIONNAIRE_RESPONSE_PATH, 'dtr_smart_app_questionnaire_response',
+                          method(:questionnaire_response_response) do |request|
+      DTRSmartAppSuite.extract_bearer_token(request)
+    end
+
+    record_response_route :get, FHIR_RESOURCE_PATH, SMART_APP_EHR_REQUEST_TAG, method(:get_fhir_resource),
+                          resumes: ->(_) { false } do |request|
+      DTRSmartAppSuite.extract_bearer_token(request)
+    end
+
+    record_response_route :get, FHIR_SEARCH_PATH, SMART_APP_EHR_REQUEST_TAG, method(:get_fhir_resource),
+                          resumes: ->(_) { false } do |request|
+      DTRSmartAppSuite.extract_bearer_token(request)
+    end
+
+    resume_test_route :get, RESUME_PASS_PATH do |request|
+      DTRSmartAppSuite.extract_token_from_query_params(request)
+    end
+
+    resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
+      DTRSmartAppSuite.extract_token_from_query_params(request)
+    end
+
+    group from: :oauth2_authentication
+    group do
+      id :dtr_smart_app_basic_workflows
+      title 'Basic Workflows'
+      description %(
+        Tests in this group validate that the client can complete basic DTR workflows
+      )
+
+      group from: :dtr_smart_app_static_dinner_questionnaire_workflow
+      # group from: :dtr_smart_app_adaptive_dinner_questionnaire_workflow - TODO
+    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
+        covering additional must support features of questionnaires.
+      )
+      group from: :dtr_smart_app_questionnaire_workflow
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/ext/inferno_core/record_response_route.rb

@@ -0,0 +1,98 @@
+require 'hanami/controller'
+
+module Inferno
+  module DSL
+    # A base class for creating routes with custom response logic. Requests and responses are tagged and saved.
+    # @private
+    # @see Inferno::DSL::Runnable#resume_test_route
+    class RecordResponseRoute < Hanami::Action
+      include Import[
+                requests_repo: 'inferno.repositories.requests',
+                results_repo: 'inferno.repositories.results',
+                test_runs_repo: 'inferno.repositories.test_runs',
+                tests_repo: 'inferno.repositories.tests'
+              ]
+
+      def self.call(...)
+        new.call(...)
+      end
+
+      # @private
+      def test_run_identifier_block
+        self.class.singleton_class.instance_variable_get(:@test_run_identifier_block)
+      end
+
+      # @private
+      def build_response_block
+        self.class.singleton_class.instance_variable_get(:@build_response_block)
+      end
+
+      # @private
+      def tags
+        self.class.singleton_class.instance_variable_get(:@tags)
+      end
+
+      # @private
+      def resumes?(test)
+        instance_exec(test, &self.class.singleton_class.instance_variable_get(:@resumes))
+      end
+
+      # @private
+      def find_test_run(test_run_identifier)
+        test_runs_repo.find_latest_waiting_by_identifier(test_run_identifier)
+      end
+
+      # @private
+      def find_waiting_result(test_run)
+        results_repo.find_waiting_result(test_run_id: test_run.id)
+      end
+
+      # @private
+      def update_result(waiting_result)
+        results_repo.update_result(waiting_result.id, 'pass')
+      end
+
+      # @private
+      def persist_request(request, test_run, waiting_result, test)
+        requests_repo.create(
+          request.to_hash.merge(
+            test_session_id: test_run.test_session_id,
+            result_id: waiting_result.id,
+            name: test.config.request_name(test.incoming_request_name),
+            tags:
+          )
+        )
+      end
+
+      # @private
+      def find_test(waiting_result)
+        tests_repo.find(waiting_result.test_id)
+      end
+
+      # @private
+      def handle(req, res)
+        request = Inferno::Entities::Request.from_hanami_request(req)
+
+        test_run_identifier = instance_exec(request, &test_run_identifier_block)
+
+        test_run = find_test_run(test_run_identifier)
+
+        halt 500, "Unable to find test run with identifier '#{test_run_identifier}'." if test_run.nil?
+
+        waiting_result = find_waiting_result(test_run)
+        test = find_test(waiting_result)
+
+        test_runs_repo.mark_as_no_longer_waiting(test_run.id) if resumes? test
+
+        update_result(waiting_result) if resumes? test
+
+        instance_exec(request, test, waiting_result, &build_response_block)
+
+        Inferno::Entities::Request.to_hanami_response(request, res)
+        persist_request(request, test_run, waiting_result, test)
+
+        Jobs.perform(Jobs::ResumeTestRun, test_run.id) if resumes? test
+      end
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/ext/inferno_core/request.rb

@@ -0,0 +1,19 @@
+module Inferno
+  module Entities
+    class Request
+      def self.to_hanami_response(request, response)
+        response.status = request.status
+        response.body = request.response_body
+        request.response_headers.each do |header|
+          response.headers[header.name] = header.value
+        end
+
+        response
+      end
+
+      def response_headers=(headers_hash)
+        headers.concat(headers_hash.map { |key, value| Header.new(name: key.to_s, value:, type: 'response') })
+      end
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/ext/inferno_core/runnable.rb

@@ -0,0 +1,35 @@
+require_relative 'record_response_route'
+
+module Inferno
+  module DSL
+    module Runnable
+      PRE_FLIGHT_HANDLER = proc do
+        [
+          200,
+          {
+            'Access-Control-Allow-Origin' => '*',
+            'Access-Control-Allow-Headers' => 'Content-Type, Authorization'
+          },
+          ['']
+        ]
+      end
+
+      def allow_cors(*paths)
+        paths.each do |path|
+          route(:options, path, PRE_FLIGHT_HANDLER)
+        end
+      end
+
+      def record_response_route(method, path, tags, build_response, resumes: ->(_) { true }, &block)
+        route_class = Class.new(Inferno::DSL::RecordResponseRoute) do |klass|
+          klass.singleton_class.instance_variable_set(:@build_response_block, build_response)
+          klass.singleton_class.instance_variable_set(:@test_run_identifier_block, block)
+          klass.singleton_class.instance_variable_set(:@tags, Array.wrap(tags))
+          klass.singleton_class.instance_variable_set(:@resumes, resumes)
+        end
+
+        route(method, path, route_class)
+      end
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/fixture_loader.rb

@@ -0,0 +1,99 @@
+require 'singleton'
+require 'fhir_models'
+
+module DaVinciDTRTestKit
+  class FixtureLoader
+    include Singleton
+
+    def initialize
+      # list of lists
+      # - first entry is the path to a file containing a Questionnaire Bundle (not Parameters)
+      # - second entry is the path to a file containing a Populated QuestionnaireResponse
+      #   for use in validation.
+      # - third entry is a list of group id within which this questionnaire should be used and
+      #   will be returned for any $questionnaire-package calls. This association of a questionnaire
+      #   with a specific test is Inferno's simulated version of payer business logic.
+      questionnaires_to_load =
+        [
+          [
+            'fixtures/questionnaire_package.json',
+            'fixtures/pre_populated_questionnaire_response.json',
+            ['dtr_smart_app_questionnaire_workflow', 'dtr_full_ehr_questionnaire_workflow']
+          ],
+          [
+            'fixtures/dinner_static/questionnaire_dinner_order_static.json',
+            'fixtures/dinner_static/questionnaire_response_dinner_order_static.json',
+            ['dtr_smart_app_static_dinner_questionnaire_workflow']
+          ],
+          [
+            'fixtures/dinner_adaptive/questionnaire_dinner_order_adaptive.json',
+            '',
+            ['dtr_smart_app_adaptive_dinner_questionnaire_workflow']
+          ]
+        ]
+
+      questionnaires_to_load.each do |questionnaire_details|
+        init_questionnaire_package_and_response(questionnaire_details[0], questionnaire_details[1],
+                                                questionnaire_details[2])
+      end
+    end
+
+    def canonical_to_questionnaire_package_map
+      @canonical_to_questionnaire_package_map ||= {}
+    end
+
+    def questionnaire_package_for_canonical(url)
+      @canonical_to_questionnaire_package_map[url]
+    end
+
+    def group_id_to_questionnaire_canonical_map
+      @group_id_to_questionnaire_canonical_map ||= {}
+    end
+
+    def questionnaire_canonical_for_group_id(group_id)
+      group_id_to_questionnaire_canonical_map[group_id]
+    end
+
+    def questionnaire_package_for_group_id(group_id)
+      canonical = questionnaire_canonical_for_group_id(group_id)
+      return unless canonical
+
+      @canonical_to_questionnaire_package_map[canonical]
+    end
+
+    def group_id_to_questionnaire_response_map
+      @group_id_to_questionnaire_response_map ||= {}
+    end
+
+    def questionnaire_response_for_group_id(group_id)
+      group_id_to_questionnaire_response_map[group_id]
+    end
+
+    def init_questionnaire_package_and_response(package_file, response_file = nil, covered_groups = nil)
+      package_json = File.read(File.join(__dir__, package_file))
+      package = FHIR.from_contents(package_json)
+      url = get_url_for_questionnaire(package)
+
+      canonical_to_questionnaire_package_map[url] = package if url
+      covered_groups&.each do |group|
+        group_id_to_questionnaire_canonical_map[group] = url
+      end
+
+      if response_file.present?
+        response_json = File.read(File.join(__dir__, response_file))
+        response = FHIR.from_contents(response_json)
+
+        covered_groups&.each do |group|
+          group_id_to_questionnaire_response_map[group] = response
+        end
+
+      end
+
+      package
+    end
+
+    def get_url_for_questionnaire(questionnaire_bundle)
+      questionnaire_bundle.entry[0].resource.url
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/fixtures/dinner_adaptive/dinner_order_adaptive_next_question_burrito.json

@@ -0,0 +1,170 @@
+{
+  "resourceType": "Questionnaire",
+  "id": "DinnerOrderAdaptive",
+  "meta": {
+    "profile": [
+      "http://hl7.org/fhir/StructureDefinition/cqf-questionnaire",
+      "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt"
+    ]
+  },
+  "extension": [
+    {
+      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive",
+      "valueBoolean": true
+    },
+    {
+      "url": "http://hl7.org/fhir/StructureDefinition/cqf-library",
+      "valueCanonical": "https://madie.cms.gov/Library/DTRTest"
+    }
+  ],
+  "name": "DinnerOrderAdaptive",
+  "title": "Dinner Order (Adaptive)",
+  "status": "draft",
+  "subjectType": [
+    "Patient"
+  ],
+  "date": "2024-05-06",
+  "publisher": "Inferno",
+  "item": [
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "PBD",
+      "text": "Patient Information",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".LastName"
+              }
+            }
+          ],
+          "linkId": "PBD.1",
+          "text": "Last Name:",
+          "type": "string",
+          "required": true
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstName"
+              }
+            }
+          ],
+          "linkId": "PBD.2",
+          "text": "First Name:",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "LOC",
+      "text": "Patient's Location",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstLocationDescription"
+              }
+            }
+          ],
+          "linkId": "LOC.1",
+          "text": "Location",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "linkId": "3",
+      "text": "Dinner Order",
+      "type": "group",
+      "item": [
+        {
+          "linkId": "3.1",
+          "text": "What would you like for dinner?",
+          "type": "choice",
+          "required": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Hamburger"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Bean Burrito"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.2.b",
+          "text": "What would you like on your bean burrito?",
+          "type": "choice",
+          "required": false,
+          "repeats": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Cheese"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Pico de Gallo"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Guacamole"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.3",
+          "text": "Any special requests?",
+          "type": "string",
+          "required": false
+        }
+      ]
+    }
+  ]
+}

data/lib/davinci_dtr_test_kit/fixtures/dinner_adaptive/dinner_order_adaptive_next_question_hamburger.json

@@ -0,0 +1,175 @@
+{
+  "resourceType": "Questionnaire",
+  "id": "DinnerOrderAdaptive",
+  "meta": {
+    "profile": [
+      "http://hl7.org/fhir/StructureDefinition/cqf-questionnaire",
+      "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt"
+    ]
+  },
+  "extension": [
+    {
+      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive",
+      "valueBoolean": true
+    },
+    {
+      "url": "http://hl7.org/fhir/StructureDefinition/cqf-library",
+      "valueCanonical": "https://madie.cms.gov/Library/DTRTest"
+    }
+  ],
+  "name": "DinnerOrderAdaptive",
+  "title": "Dinner Order (Adaptive)",
+  "status": "draft",
+  "subjectType": [
+    "Patient"
+  ],
+  "date": "2024-05-06",
+  "publisher": "Inferno",
+  "item": [
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "PBD",
+      "text": "Patient Information",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".LastName"
+              }
+            }
+          ],
+          "linkId": "PBD.1",
+          "text": "Last Name:",
+          "type": "string",
+          "required": true
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstName"
+              }
+            }
+          ],
+          "linkId": "PBD.2",
+          "text": "First Name:",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+          "valueCodeableConcept": {
+            "coding": [
+              {
+                "system": "http://hl7.org/fhir/questionnaire-item-control",
+                "code": "gtable"
+              }
+            ]
+          }
+        }
+      ],
+      "linkId": "LOC",
+      "text": "Patient's Location",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/cql",
+                "expression": "\"DTRTest\".FirstLocationDescription"
+              }
+            }
+          ],
+          "linkId": "LOC.1",
+          "text": "Location",
+          "type": "string",
+          "required": true
+        }
+      ]
+    },
+    {
+      "linkId": "3",
+      "text": "Dinner Order",
+      "type": "group",
+      "item": [
+        {
+          "linkId": "3.1",
+          "text": "What would you like for dinner?",
+          "type": "choice",
+          "required": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Hamburger"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Bean Burrito"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.2.a",
+          "text": "What would you like on your hamburger?",
+          "type": "choice",
+          "required": false,
+          "repeats": true,
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "Ketchup"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Mustard"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Pickels"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "Tomato"
+              }
+            }
+          ]
+        },
+        {
+          "linkId": "3.3",
+          "text": "Any special requests?",
+          "type": "string",
+          "required": false
+        }
+      ]
+    }
+  ]
+}