bulk_data_test_kit 0.13.2 → 0.14.0

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/helpers.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../shared/submission_status'
+require_relative '../shared/submitter_identifier'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        module Helpers
+          def submit_parameters(submission_id, base_url, status: nil, manifest_url: nil, oauth_metadata_url: nil)
+            params = submission_identification_parameters(submission_id)
+
+            params.parameter << FHIR::R4::Parameters::Parameter.new({
+                                                                      name: 'fhirBaseUrl',
+                                                                      valueUrl: base_url
+            })
+
+            unless status.nil?
+              status_coding = FHIR::R4::Coding.new({
+                                                      system: Shared::SubmissionStatus::SYSTEM,
+                                                      code: status
+                                                    })
+
+              params.parameter << FHIR::R4::Parameters::Parameter.new({
+                                                                        name: 'submissionStatus',
+                                                                        # http://hl7.org/fhir/uv/bulkdata/ValueSet/submission-status
+                                                                        valueCoding: status_coding
+                                                                      })
+            end
+
+            unless manifest_url.nil?
+              params.parameter << FHIR::R4::Parameters::Parameter.new({
+                                                                        name: 'manifestUrl',
+                                                                        valueUrl: manifest_url
+                                                                      })
+            end
+
+            unless oauth_metadata_url.nil?
+              params.parameter << FHIR::R4::Parameters::Parameter.new({
+                                                                        name: 'oauthMetadataUrl',
+                                                                        valueUrl: oauth_metadata_url
+                                                                      })
+            end
+
+            params
+          end
+
+          def status_parameters(submission_id)
+            submission_identification_parameters(submission_id)
+          end
+
+          private
+
+          def submission_identification_parameters(submission_id)
+            params = FHIR::R4::Parameters.new
+            submitter_identifier = FHIR::R4::Identifier.new(
+              system: Shared::SubmitterIdentifier::SYSTEM,
+              value: Shared::SubmitterIdentifier::VALUE
+            )
+
+            params.parameter << FHIR::R4::Parameters::Parameter.new(
+              name: 'submitter',
+              valueIdentifier: submitter_identifier
+            )
+
+            params.parameter << FHIR::R4::Parameters::Parameter.new({
+                                                                      name: 'submissionId',
+                                                                      valueString: submission_id
+                                                                    })
+
+            params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/manifest_and_file_retrieval.rb

@@ -0,0 +1,59 @@
+require_relative 'tags'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class ManifestAndFileRetrieval < Inferno::TestGroup
+          title 'Manifest and File Retrieval'
+          id :bulk_data_v400_submit_consumer_manifest_file_retrieval
+
+          test do
+            id :bulk_data_v400_submit_consumer_token_request
+            title 'Token request received'
+            description <<~DESCRIPTION
+              This test verifies that the Data Consumer requested an access
+              token.
+            DESCRIPTION
+
+            run do
+              load_tagged_requests SMARTAppLaunch::TOKEN_TAG
+
+              assert requests.present?, 'No token request was received'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_manifests_retrieved
+            title 'Manifests retrieved'
+            description <<~DESCRIPTION
+              This test verifies that all manifests included in the manifest
+              were retrieved.
+            DESCRIPTION
+
+            run do
+              load_tagged_requests Consumer::MANIFEST_TAG
+
+              assert requests.present?, 'No manifests were downloaded'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_files_retrieved
+            title 'Files retrieved'
+            description <<~DESCRIPTION
+              This test verifies that all files included in the manifest
+              were retrieved.
+            DESCRIPTION
+
+            run do
+              load_tagged_requests Consumer::FILE_DOWNLOAD_TAG
+
+              assert requests.present?, 'No files were downloaded'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/poll_group.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class PollGroup < Inferno::TestGroup
+          include URLs
+          include Helpers
+
+          title 'Bulk Data Status Polling Request'
+
+          description %(
+            This group verifies that a Data Consumer returns an in-progress response
+            to an initial status poll. Inferno sends the terminal `completed`
+            submission immediately after this group, then polls for the final result.
+          )
+
+          id :bulk_data_v400_submit_consumer_poll
+
+          run_as_group
+
+          input :smart_jwk_set,
+                title: 'Data Consumer JSON Web Key Set (JWKS)',
+                description: <<~DESCRIPTION
+                  The Bulk Submit Data Consumer system's JSON Web Key Set
+                  including the key(s) Inferno will need to verify signatures on
+                  token requests made by the client. May be provided as either a
+                  publicly accessible url containing the JWKS, or the raw JWKS
+                  JSON.
+                DESCRIPTION
+
+          input :smart_auth_info,
+                type: :auth_info,
+                options: { mode: 'access' },
+                optional: false
+
+          input :poll_url
+
+          http_client do
+            headers 'Authorization' => "Bearer #{smart_auth_info.access_token}",
+                    'Accept' => 'application/json'
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_initial_poll_status
+            title 'Initial Poll Status'
+
+            description %(
+              This test verifies that a provider can poll for status against the Data Consumer under test.
+            )
+
+            run do
+              get poll_url
+
+              assert_response_status(202)
+              assert request.response_header('x-export-status').nil?,
+                     'The initial poll response included an unexpected `X-Export-Status` header.'
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/processing_wait_group.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class ProcessingWaitGroup < Inferno::TestGroup
+          include URLs
+
+          title 'Wait For Processing'
+
+          description %(
+            This group pauses after Inferno sends the terminal `completed`
+            submission so the tester can allow the Data Consumer to finish
+            processing before Inferno begins final status polling.
+          )
+
+          id :bulk_data_v400_submit_consumer_processing_wait
+
+          run_as_group
+
+          input :consumer_client_id,
+                title: 'Data Consumer Client ID',
+                optional: true,
+                description: <<~DESCRIPTION
+                  Client ID of the Bulk Submit Data Consumer system under test.
+                  If no value is provided, the Inferno session id will be used.
+                DESCRIPTION
+
+          test do
+            id :bulk_data_v400_submit_consumer_processing_wait_test
+            title 'Wait For Data Consumer Processing'
+
+            run do
+              identifier = consumer_client_id.presence || test_session_id
+
+              wait(
+                identifier:,
+                message: %(
+                  Inferno has sent the terminal `completed` submission. When the
+                  Data Consumer under test has finished processing and its final
+                  status poll is ready to return `200`,
+                  [click here](#{resume_pass_url}?id=#{identifier}).
+                ),
+                timeout: 900
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/status_submit_group.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class StatusSubmitGroup < Inferno::TestGroup
+          include URLs
+          include Helpers
+
+          title 'Bulk Submit Status Operation - Initialize'
+
+          description %(
+            This group verifies that a status submission can be made against the Data Consumer.
+
+            This group will:
+            1. Using the provided base URL of the Data Consumer system under test, will perform the $bulk-submit-status operation.
+            2. Check that the response contains a `Content-Location` header for status polling.
+          )
+
+          id :bulk_data_v400_submit_consumer_status_submit
+
+          run_as_group
+
+          input :smart_auth_info,
+                type: :auth_info,
+                options: { mode: 'access' },
+                optional: false
+
+          output :poll_url
+
+          http_client do
+            headers 'Authorization' => "Bearer #{smart_auth_info.access_token}",
+                    'Content-Type' => 'application/fhir+json'
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_status_submit_request
+            title 'Status Submit'
+
+            description %(
+              This test verifies that a status submission can be made against the Data Consumer.
+            )
+
+            run do
+              parameters = status_parameters(submission_id)
+
+              post "#{consumer_fhir_base_url}/$bulk-submit-status",
+                   body: parameters.to_json,
+                   headers: {
+                     'Accept' => 'application/fhir+json',
+                     'Prefer' => 'respond-async'
+                   }
+
+              assert_response_status(202)
+
+              poll_url = request.response_header('content-location')&.value
+              assert poll_url.present?, 'Status response headers did not include "Content-Location".'
+
+              begin
+                parsed_poll_url = URI.parse(poll_url)
+              rescue URI::InvalidURIError
+                assert false, '"Content-Location" must be an absolute HTTP(S) URL.'
+              end
+
+              assert %w[http https].include?(parsed_poll_url.scheme&.downcase) && parsed_poll_url.host.present?,
+                     '"Content-Location" must be an absolute HTTP(S) URL.'
+
+              output poll_url:
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/submit_completed_group.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class SubmitCompletedGroup < Inferno::TestGroup
+          include URLs
+          include Helpers
+
+          title 'Bulk Submit Operation - Completed'
+
+          description %(
+            This group verifies that a submission with a status of `completed` can be made against the Data Consumer.
+
+            This group will:
+            1. Using the provided base URL of the Data Consumer system under test, will perform the $bulk-submit operation with a `submissionStatus` of `completed`.
+            2. Check that the response is valid.
+          )
+
+          id :bulk_data_v400_submit_consumer_submit_completed
+
+          run_as_group
+
+          input :smart_auth_info,
+                type: :auth_info,
+                options: { mode: 'access' },
+                optional: false
+
+          http_client do
+            headers 'Authorization' => "Bearer #{smart_auth_info.access_token}",
+                    'Content-Type' => 'application/fhir+json'
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_completed_submit
+            title 'Submit Completed Status'
+
+            description %(
+              This test verifies that a submission with a status of `completed` can be made against the Data Consumer.
+            )
+
+            run do
+              parameters =
+                submit_parameters(
+                  submission_id,
+                  base_url,
+                  status: 'completed',
+                  oauth_metadata_url: smart_discovery_url
+                )
+
+              post "#{consumer_fhir_base_url}/$bulk-submit",
+                   body: parameters.to_json,
+                   headers: {
+                     'Accept' => 'application/fhir+json'
+                   }
+
+              assert_response_status(200)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/submit_group.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class SubmitGroup < Inferno::TestGroup
+          include URLs
+          include Helpers
+
+          title 'Bulk Submit Operation'
+
+          description %(
+            This group verifies that a submission can be made against the Data Consumer.
+
+            This group will:
+            1. Using the provided base URL of the Data Consumer system under test, will perform a "kick off" $bulk-submit operation.
+            2. Check that the response is valid.
+          )
+
+          id :bulk_data_v400_submit_consumer_submit
+
+          run_as_group
+
+          input :smart_auth_info,
+                type: :auth_info,
+                options: { mode: 'access' },
+                optional: false
+
+          http_client do
+            headers 'Authorization' => "Bearer #{smart_auth_info.access_token}",
+                    'Content-Type' => 'application/fhir+json'
+          end
+
+          test do
+            id :bulk_data_v400_submit_consumer_manifest_url_submit
+            title 'Submit Manifest URL'
+
+            description %(
+              This test verifies that a submission can be made against the Data Consumer.
+            )
+
+            run do
+              parameters =
+                submit_parameters(
+                  submission_id,
+                  base_url,
+                  status: 'in-progress',
+                  manifest_url: manifest_url,
+                  oauth_metadata_url: smart_discovery_url
+                )
+
+              post "#{consumer_fhir_base_url}/$bulk-submit",
+                   body: parameters.to_json,
+                   headers: {
+                     'Accept' => 'application/fhir+json'
+                   }
+
+              assert_response_status(200)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/tags.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        MANIFEST_TAG = 'bulk_submit_manifest'
+        FILE_DOWNLOAD_TAG = 'bulk_submit_download'
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/test_suite.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative 'urls'
+require_relative 'helpers'
+require_relative '../shared/jwks'
+
+require_relative 'backend_services_group'
+require_relative 'complete_poll_group'
+require_relative 'endpoints/file_download'
+require_relative 'endpoints/manifest'
+require_relative 'manifest_and_file_retrieval'
+require_relative 'poll_group'
+require_relative 'processing_wait_group'
+require_relative 'submit_group'
+require_relative 'submit_completed_group'
+require_relative 'status_submit_group'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        class TestSuite < Inferno::TestSuite
+          include URLs
+          extend Shared::JWKS
+
+          title 'Bulk Data Access v4.0.0-ballot Submit - Consumer'
+
+          description File.read(File.join(__dir__, 'docs', 'suite_description.md'))
+
+          id :bulk_data_v400_submit_consumer
+
+          requirement_sets(
+            {
+              identifier: 'hl7.fhir.uv.smart-app-launch_2.2.0',
+              title: 'SMART App Launch',
+              actor: 'Server',
+              requirements: '30,251,253-256,258,372-374,377,381-383,385,393,394'
+            }
+          )
+
+          links [
+            {
+              label: 'Report Issue',
+              url: 'https://github.com/inferno-framework/bulk-data-test-kit/issues/'
+            },
+            {
+              label: 'Open Source',
+              url: 'https://github.com/inferno-framework/bulk-data-test-kit/'
+            },
+            {
+              label: 'Download',
+              url: 'https://github.com/inferno-framework/bulk-data-test-kit/releases'
+            }
+          ]
+
+          input :consumer_fhir_base_url,
+                title: 'Bulk Data Consumer Base FHIR URL',
+                description: 'The URL Inferno should use as the base for the Data Consumer under test.',
+                type: 'text',
+                optional: false
+
+          input :submission_id,
+                title: 'Submission ID',
+                description: 'Set the submission ID that will be used for the submission flow.',
+                type: 'text',
+                optional: false,
+                default: '123'
+
+          route(:get, SMART_DISCOVERY_ROUTE, lambda { |_env|
+                  SMARTAppLaunch::MockSMARTServer.smart_server_metadata(id)
+                })
+          suite_endpoint :post, SMART_TOKEN_ROUTE, SMARTAppLaunch::MockSMARTServer::TokenEndpoint
+
+          route(:get, JWKS_ROUTE, jwks_route_handler)
+
+          config(
+            inputs: {
+              smart_auth_info: {
+                title: 'Bulk Submit Data Provider Client Credentials',
+                description: 'Inferno will use these credentials when making requests to the Data Consumer under test.'
+              }
+            },
+            options: {
+              post_authorization_uri: "#{Inferno::Application['base_url']}/custom/smart_stu2/post_auth"
+            }
+          )
+
+          resume_test_route :get, RESUME_PASS_ROUTE do |request|
+            request.query_parameters['id']
+          end
+
+          suite_endpoint :get, MANIFEST_ROUTE, Endpoints::Manifest
+          suite_endpoint :get, DOWNLOAD_ROUTE, Endpoints::FileDownload
+
+          group from: :bulk_data_v400_submit_consumer_backend_services
+
+          group do
+            id :bulk_data_v400_submit_consumer_sequence
+            title 'Data Consumer Sequence'
+
+            run_as_group
+
+            group from: :bulk_data_v400_submit_consumer_submit
+            group from: :bulk_data_v400_submit_consumer_status_submit
+            group from: :bulk_data_v400_submit_consumer_poll
+            group from: :bulk_data_v400_submit_consumer_submit_completed
+            group from: :bulk_data_v400_submit_consumer_processing_wait
+            group from: :bulk_data_v400_submit_consumer_poll_complete
+
+            group from: :bulk_data_v400_submit_consumer_manifest_file_retrieval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/consumer/urls.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Consumer
+        RESUME_PASS_ROUTE = '/resume_pass'
+        MANIFEST_ROUTE = '/manifest'
+        DOWNLOAD_ROUTE = '/example.ndjson'
+        SMART_DISCOVERY_ROUTE = '/.well-known/smart-configuration'
+        AUTH_SERVER_ROUTE = '/auth'
+        SMART_TOKEN_ROUTE = "#{AUTH_SERVER_ROUTE}/token".freeze
+        JWKS_ROUTE = '/.well-known/jwks.json'
+
+        module URLs
+          def base_url
+            "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+          end
+
+          def resume_pass_url
+            "#{base_url}#{RESUME_PASS_ROUTE}"
+          end
+
+          def manifest_url
+            "#{base_url}#{MANIFEST_ROUTE}"
+          end
+
+          def download_url
+            "#{base_url}#{DOWNLOAD_ROUTE}"
+          end
+
+          def smart_discovery_url
+            "#{base_url}#{SMART_DISCOVERY_ROUTE}"
+          end
+
+          def suite_id
+            TestSuite.id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/provider/client_registration_group.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'smart_app_launch_test_kit'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class ClientRegistrationGroup < Inferno::TestGroup
+          id :bulk_data_v400_submit_provider_client_registration
+
+          title 'Client Registration'
+
+          config(
+            inputs: {
+              client_id: {
+                title: 'Provider Client ID',
+                description: <<~DESCRIPTION
+                  Client ID of the Bulk Data Submit Provider system under test.
+                  If no value is provided, the Inferno session id will be used.
+                DESCRIPTION
+              },
+              smart_jwk_set: {
+                title: 'Provider JSON Web Key Set (JWKS)',
+                description: <<~DESCRIPTION
+                  The Bulk Data Submit Provider system's JSON Web Key Set
+                  including the key(s) Inferno will need to verify signatures on
+                  token requests made by the client. May be provided as either a
+                  publicly accessible url containing the JWKS, or the raw JWKS
+                  JSON.
+                DESCRIPTION
+              }
+            }
+          )
+
+          test from: :smart_client_registration_bsca_verification,
+               title: 'Verify Provider Client Registration'
+        end
+      end
+    end
+  end
+end