bulk_data_test_kit 0.13.2 → 0.14.0

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'retrieval'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class ProcessingWaitGroup < Inferno::TestGroup
+          include URLs
+
+          title 'Retrieve Submissions and Wait For Final Polls'
+
+          description %(
+            After the tester confirms that all submit requests have been sent,
+            Inferno retrieves each completed submission. It then pauses while
+            the Data Provider makes its final status polling requests.
+          )
+
+          id :bulk_data_v400_submit_provider_processing_wait
+
+          run_as_group
+
+          input :client_id,
+                title: 'Client Id',
+                type: 'text',
+                optional: true,
+                locked: true,
+                description: SMARTAppLaunch::INPUT_CLIENT_ID_DESCRIPTION_LOCKED
+
+          test do
+            id :bulk_data_v400_submit_provider_retrieve_submissions
+            include Helpers
+            include Retrieval
+
+            title 'Retrieve Completed Submissions and Wait For Final Polls'
+
+            output :provider_submission_outcomes, type: :textarea
+
+            run do
+              identities = completed_submission_identities
+              skip_if identities.empty?, 'No completed submissions were received.'
+
+              outcomes = identities.each_with_object({}) do |identity, submission_outcomes|
+                key = submission_key(identity)
+
+                begin
+                  retrieve_submission(identity)
+                  submission_outcomes[key] = {
+                    status: 'succeeded',
+                    submission_id: identity[:submission_id]
+                  }
+                rescue StandardError
+                  submission_outcomes[key] = {
+                    status: 'failed',
+                    submission_id: identity[:submission_id],
+                    diagnostic: Retrieval::FAILURE_DIAGNOSTIC
+                  }
+                end
+              end
+
+              output provider_submission_outcomes: outcomes.to_json
+
+              identifier = client_id.presence || test_session_id
+              wait(
+                identifier:,
+                message: %(
+                  Inferno has finished retrieving the completed submissions.
+                  The Data Provider may now make its final request to each
+                  Content-Location returned by `$bulk-submit-status`.
+
+                  [Click here](#{resume_pass_url}?id=#{identifier}) after all
+                  final polling requests have been made.
+                ),
+                timeout: 900
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'smart_app_launch_test_kit'
+require_relative 'helpers'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        module Retrieval
+          FAILURE_DIAGNOSTIC = 'Bulk Submit retrieval failed.'
+
+          def completed_submission_identities
+            completed_submission_timelines.keys
+          end
+
+          def completed_submission_timelines
+            @completed_submission_timelines ||=
+              valid_completed_submission_timelines(parsed_submissions)
+          end
+
+          def parsed_submissions
+            @parsed_submissions ||= parsed_submission_parameters(load_tagged_requests(SUBMIT_TAG))
+          end
+
+          def retrieval_contexts(identity)
+            Array(completed_submission_timelines[identity]).flat_map do |parameters|
+              oauth_metadata_url = parameters.parameter.find do |parameter|
+                parameter.name == 'oauthMetadataUrl' && parameter.valueUrl.present?
+              end&.valueUrl
+
+              parameters.parameter.filter_map do |parameter|
+                next unless parameter.name == 'manifestUrl' && parameter.valueUrl.present?
+
+                { manifest_url: parameter.valueUrl, oauth_metadata_url: }
+              end
+            end
+          end
+
+          def retrieve_submission(identity)
+            retrieval_contexts(identity).each do |context|
+              retrieve_manifest_and_files(context)
+            end
+          end
+
+          def retrieve_manifest_and_files(context)
+            headers = { 'Accept' => 'application/json' }
+            if context[:oauth_metadata_url]
+              headers['Authorization'] = "Bearer #{access_token(context[:oauth_metadata_url])}"
+            end
+
+            manifest_request = get(context[:manifest_url], headers:, tags: [MANIFEST_TAG])
+            require_success(manifest_request)
+            manifest = JSON.parse(manifest_request.response_body).deep_symbolize_keys
+            raise 'The retrieved manifest was not a JSON object' unless manifest.is_a?(Hash)
+
+            file_headers = { 'Accept' => 'application/fhir+ndjson' }
+            if context[:oauth_metadata_url] && manifest[:requiresAccessToken]
+              file_headers['Authorization'] = "Bearer #{access_token(context[:oauth_metadata_url])}"
+            end
+
+            Array(manifest[:output]).each do |output|
+              file_request = get(
+                output[:url],
+                headers: file_headers,
+                tags: [FILE_DOWNLOAD_TAG, output[:type].to_s]
+              )
+              require_success(file_request)
+            end
+          end
+
+          def require_success(request)
+            return request if request.status.to_i == 200
+
+            raise "Retrieval request to #{request.url} failed with status #{request.status}"
+          end
+
+          def oauth_metadata(metadata_url)
+            oauth_metadata_cache[metadata_url] ||= begin
+              metadata_request = get(metadata_url, tags: [OAUTH_METADATA_TAG])
+              require_success(metadata_request)
+              metadata = JSON.parse(metadata_request.response_body).deep_symbolize_keys
+              raise 'The retrieved OAuth metadata was not a JSON object' unless metadata.is_a?(Hash)
+
+              metadata
+            end
+          end
+
+          def access_token(metadata_url)
+            token = token_response(metadata_url)[:access_token]
+            raise 'OAuth token response did not include an access token' if token.blank?
+
+            token
+          end
+
+          def token_response(metadata_url)
+            token_response_cache[metadata_url] ||= begin
+              endpoint = oauth_metadata(metadata_url)[:token_endpoint]
+              raise 'OAuth metadata did not include a token endpoint' if endpoint.blank?
+
+              request_details = token_request(endpoint)
+              token_request_result = post(
+                endpoint,
+                body: request_details[:body],
+                headers: request_details[:headers],
+                tags: [TOKEN_TAG]
+              )
+              require_success(token_request_result)
+              response = JSON.parse(token_request_result.response_body).deep_symbolize_keys
+              raise 'The OAuth token response was not a JSON object' unless response.is_a?(Hash)
+
+              response
+            end
+          end
+
+          def token_request(audience)
+            SMARTAppLaunch::BackendServicesAuthorizationRequestBuilder.build(
+              encryption_method: consumer_auth_info.encryption_algorithm,
+              scope: consumer_auth_info.requested_scopes,
+              iss: consumer_auth_info.client_id,
+              sub: consumer_auth_info.client_id,
+              aud: audience,
+              kid: consumer_auth_info.kid,
+              custom_jwks: consumer_auth_info.jwks
+            )
+          end
+
+          def oauth_metadata_cache
+            @oauth_metadata_cache ||= {}
+          end
+
+          def token_response_cache
+            @token_response_cache ||= {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class StatusSubmitGroup < Inferno::TestGroup
+          include Helpers
+
+          title 'Bulk Submit Status Operation'
+
+          description %(
+            This group verifies that a provider successfully made a status submit request.
+          )
+
+          id :bulk_data_v400_submit_provider_status_submit
+
+          run_as_group
+
+          optional
+
+          test do
+            id :bulk_data_v400_submit_provider_status_submit_request
+            title 'Status Submit Request Was Made'
+
+            description %(
+              This test verifies that at least one status submit request was made.
+            )
+
+            run do
+              assert load_tagged_requests(STATUS_SUBMIT_TAG).any?, 'Did not receive a status submit request.'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_status_submit_identity
+            title '`submitter` and `submissionId` Match Submission'
+
+            description %(
+              This test verifies that every status submission includes exactly one
+              populated `submitter` Identifier and `submissionId`, and that the
+              combination matches a submit request.
+            )
+
+            run do
+              validate_status_submission_identities(
+                load_tagged_requests(STATUS_SUBMIT_TAG),
+                load_tagged_requests(SUBMIT_TAG)
+              )
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_status_submit_submission_id
+            title 'Submission ID Provided via `submissionId`'
+
+            description %(
+              This test verifies that every status request includes exactly one
+              populated `submissionId` string parameter.
+            )
+
+            run do
+              submissions = load_tagged_requests(STATUS_SUBMIT_TAG)
+              validate_submission_ids(submissions, '$bulk-submit-status')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_status_submit_output_format
+            title 'Submission Provided optional `_outputFormat` with type `string`'
+
+            description %(
+              This test verifies that a submission included the optional `_outputFormat` parameter, and had type `string`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(STATUS_SUBMIT_TAG)
+              output_format_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == '_outputFormat'
+              end
+
+              skip_if output_format_parameters.empty?,
+                      'No submission included the optional `_outputFormat` parameter'
+              assert output_format_parameters.all? { |parameter| !parameter.valueString.nil? },
+                     '`_outputFormat` must have type `string`'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,314 @@
+# frozen_string_literal: true
+
+require_relative '../shared/submission_status'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class SubmitGroup < Inferno::TestGroup
+          include Helpers
+
+          title 'Bulk Submit Operation'
+
+          description %(
+            This group verifies that a provider successfully made at least one
+            valid completed submission.
+          )
+
+          id :bulk_data_v400_submit_provider_submit
+
+          run_as_group
+
+          test do
+            id :bulk_data_v400_submit_provider_in_progress_submit
+            title 'In-Progress Submit Request Was Made'
+
+            description %(
+              This test verifies that at least one `in-progress` submit request was made.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              found_in_progress = submissions.any? do |request|
+                request_has_submission_status?(request, 'in-progress')
+              end
+
+              skip_if !found_in_progress, 'An `in-progress` submission was not detected.'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_completed_submit
+            title 'Completed Submit Request Was Made'
+
+            description %(
+              This test verifies that at least one `completed` submit request was made.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              found_completed = submissions.any? do |request|
+                request_has_submission_status?(request, 'completed')
+              end
+
+              assert found_completed, 'A `completed` submission was not detected.'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_submitter_identifier
+            title '`submitter` Identifier Is Valid and Consistent'
+
+            description %(
+              This test verifies that every submission includes exactly one
+              populated `submitter` Identifier and uses the same Identifier
+              throughout the submission.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_submitter_identifiers(
+                submissions,
+                '$bulk-submit'
+              )
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_submission_id
+            title 'Required Submission ID Provided via `submissionId`'
+
+            description %(
+              This test verifies that every submission request includes exactly one
+              populated `submissionId` string parameter.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_submission_ids(submissions, '$bulk-submit')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_submission_status
+            title 'Received `submissionStatus` has a valid Coding'
+
+            description %(
+              This test verifies that when a `submissionStatus` is included, its system and code are valid.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_submission_statuses(submissions)
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_manifest_url
+            title 'Submission Provided optional `manifestUrl` with type `url`'
+
+            description %(
+              This test verifies that a submission included the optional `manifestUrl` parameter, and had type `url`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              manifest_url_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == 'manifestUrl'
+              end
+
+              skip_if manifest_url_parameters.empty?, 'No submission included the optional `manifestUrl` parameter'
+              assert manifest_url_parameters.all? { |parameter| !parameter.valueUrl.nil? },
+                     '`manifestUrl` must have type `url`'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_replaces_manifest_url
+            title 'Submission Provided optional `replacesManifestUrl` with type `url`'
+
+            description %(
+              This test verifies that a submission included the optional `replacesManifestUrl` parameter, and had type `url`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              replaces_manifest_url_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == 'replacesManifestUrl'
+              end
+
+              skip_if replaces_manifest_url_parameters.empty?,
+                      'No submission included the optional `replacesManifestUrl` parameter'
+              assert replaces_manifest_url_parameters.all? { |parameter| !parameter.valueUrl.nil? },
+                     '`replacesManifestUrl` must have type `url`'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_output_format
+            title 'Submission Provided optional `outputFormat` with type `string`'
+
+            description %(
+              This test verifies that a submission included the optional `outputFormat` parameter, and had type `string`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              output_format_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == 'outputFormat'
+              end
+
+              skip_if output_format_parameters.empty?,
+                      'No submission included the optional `outputFormat` parameter'
+              assert output_format_parameters.all? { |parameter| !parameter.valueString.nil? },
+                     '`outputFormat` must have type `string`'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_fhir_base_url
+            title 'Submission Provided optional `fhirBaseUrl` with type `url`'
+
+            description %(
+              This test verifies that a submission included the optional `fhirBaseUrl` parameter, and had type `url`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              fhir_base_url_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == 'fhirBaseUrl'
+              end
+
+              skip_if fhir_base_url_parameters.empty?, 'No submission included the optional `fhirBaseUrl` parameter'
+              assert fhir_base_url_parameters.all? { |parameter| !parameter.valueUrl.nil? },
+                     '`fhirBaseUrl` must have type `url`'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_file_request_header
+            title 'Submission Provided optional `fileRequestHeader` with type `part`'
+
+            description %(
+              This test verifies that a submission included the optional `fileRequestHeader` parameter, and had type `part`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_optional_part_parameter(submissions, 'fileRequestHeader')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_oauth_metadata_url
+            title 'Submission Provided optional `oauthMetadataUrl` with type `url`'
+
+            description %(
+              This test verifies that a submission included the optional `oauthMetadataUrl` parameter, and had type `url`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              oauth_metadata_url_parameters = submissions.flat_map do |request|
+                FHIR.from_contents(request.request_body).parameter
+              end.select do |parameter|
+                parameter.name == 'oauthMetadataUrl'
+              end
+
+              skip_if oauth_metadata_url_parameters.empty?,
+                      'No submission included the optional `oauthMetadataUrl` parameter'
+              assert oauth_metadata_url_parameters.all? { |parameter| !parameter.valueUrl.nil? },
+                     '`oauthMetadataUrl` must have type `url`'
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_file_encryption_key
+            title 'Submission Provided optional `fileEncryptionKey` with type `part`'
+
+            description %(
+              This test verifies that a submission included the optional `fileEncryptionKey` parameter, and had type `part`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_optional_part_parameter(submissions, 'fileEncryptionKey')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_metadata
+            title 'Submission Provided optional `metadata` with type `part`'
+
+            description %(
+              This test verifies that a submission included the optional `metadata` parameter, and had type `part`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_optional_part_parameter(submissions, 'metadata')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_import
+            title 'Submission Provided optional `import` with type `part`'
+
+            description %(
+              This test verifies that a submission included the optional `import` parameter, and had type `part`.
+            )
+
+            optional
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_optional_part_parameter(submissions, 'import')
+            end
+          end
+
+          test do
+            id :bulk_data_v400_submit_provider_terminal_submission_order
+            title 'No Requests Follow a Terminal Submission Status'
+
+            description %(
+              This test verifies that no additional `$bulk-submit` request was
+              made for a submission after it was marked `completed` or `stopped`.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              validate_terminal_submission_order(submissions)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class SubmitStoppedGroup < Inferno::TestGroup
+          include Helpers
+
+          title 'Bulk Submit Operation - Stopped'
+
+          description %(
+            This group verifies that a provider made at least one submission with a status of `stopped`.
+          )
+
+          id :bulk_data_v400_submit_provider_submit_stopped
+
+          run_as_group
+
+          optional
+
+          test do
+            id :bulk_data_v400_submit_provider_stopped_submit
+            title 'Stopped Submit Request Was Made'
+
+            description %(
+              This test verifies that at least one `stopped` submit request was made.
+            )
+
+            run do
+              submissions = load_tagged_requests(SUBMIT_TAG)
+              found_stopped = submissions.any? do |request|
+                request_has_submission_status?(request, 'stopped')
+              end
+
+              skip_if !found_stopped, 'A `stopped` submission was not detected.'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        FILE_DOWNLOAD_TAG = 'bulk_submit_file_download'
+        MANIFEST_TAG = 'bulk_submit_manifest'
+        OAUTH_METADATA_TAG = 'bulk_submit_oauth_metadata'
+        POLL_TAG = 'bulk_submit_status_poll'
+        STATUS_TAG = 'bulk_submit_status'
+        STATUS_SUBMIT_TAG = 'bulk_submit_status_submit'
+        SUBMIT_TAG = 'bulk_submit_submit'
+        TOKEN_TAG = 'bulk_submit_token'
+      end
+    end
+  end
+end