bulk_data_test_kit 0.13.1 → 0.14.0

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative 'urls'
+require_relative 'helpers'
+require_relative '../shared/jwks'
+require_relative 'endpoints/submit'
+require_relative 'endpoints/status'
+require_relative 'endpoints/poll'
+
+require_relative 'client_registration_group'
+require_relative 'manifest_and_file_retrieval'
+require_relative 'poll_group'
+require_relative 'processing_wait_group'
+require_relative 'wait_group'
+require_relative 'submit_group'
+require_relative 'submit_stopped_group'
+require_relative 'status_submit_group'
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class TestSuite < Inferno::TestSuite
+          include URLs
+          extend Shared::JWKS
+
+          title 'Bulk Data Access v4.0.0-ballot Submit - Provider'
+
+          description File.read(File.join(__dir__, 'docs', 'suite_description.md'))
+
+          id :bulk_data_v400_submit_provider
+
+          requirement_sets(
+            {
+              identifier: 'hl7.fhir.uv.smart-app-launch_2.2.0',
+              title: 'SMART App Launch',
+              actor: 'Client',
+              requirements: '22,293,294'
+            }
+          )
+
+          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'
+            }
+          ]
+
+          suite_endpoint :post, SUBMIT_ROUTE, Endpoints::Submit
+          suite_endpoint :post, STATUS_SUBMIT_ROUTE, Endpoints::Status
+          suite_endpoint :get, POLL_ROUTE, Endpoints::Poll
+
+          resume_test_route :get, RESUME_PASS_ROUTE do |request|
+            request.query_parameters['id']
+          end
+
+          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)
+
+          input :consumer_auth_info,
+                type: :auth_info,
+                title: 'Bulk Submit Data Consumer Client Credentials',
+                description: <<~DESCRIPTION,
+                  Inferno will use these credentials when making requests to the
+                  Data Provider under test
+                DESCRIPTION
+                options: {
+                  mode: :auth,
+                  components: [
+                    {
+                      name: :auth_type,
+                      default: 'backend_services',
+                      locked: true
+                    },
+                    {
+                      name: :use_discovery,
+                      locked: true
+                    },
+                    {
+                      name: :client_id,
+                      default: 'inferno_demo_consumer_client_id'
+                    },
+                    {
+                      name: :requested_scopes,
+                      default: 'system/*.r'
+                    }
+                  ]
+                }
+
+          group from: :bulk_data_v400_submit_provider_client_registration
+
+          group do
+            id :bulk_data_v400_submit_provider_sequence
+            title 'Data Provider Sequence'
+
+            run_as_group
+
+            group from: :bulk_data_v400_submit_provider_wait
+            group from: :bulk_data_v400_submit_provider_submit
+            group from: :bulk_data_v400_submit_provider_status_submit
+            group from: :bulk_data_v400_submit_provider_processing_wait
+            group from: :bulk_data_v400_submit_provider_poll
+
+            group from: :bulk_data_v400_submit_provider_manifest_file_retrieval
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        RESUME_PASS_ROUTE = '/resume_pass'
+        FHIR_BASE_ROUTE = '/fhir'
+        SUBMIT_ROUTE = "#{FHIR_BASE_ROUTE}/$bulk-submit".freeze
+        STATUS_SUBMIT_ROUTE = "#{FHIR_BASE_ROUTE}/$bulk-submit-status".freeze
+        POLL_ROUTE = "#{FHIR_BASE_ROUTE}/status/:submission_key".freeze
+        SMART_DISCOVERY_ROUTE = "#{FHIR_BASE_ROUTE}/.well-known/smart-configuration".freeze
+        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 fhir_base_url
+            "#{base_url}#{FHIR_BASE_ROUTE}"
+          end
+
+          def submit_url
+            "#{base_url}#{SUBMIT_ROUTE}"
+          end
+
+          def status_submit_url
+            "#{base_url}#{STATUS_SUBMIT_ROUTE}"
+          end
+
+          def poll_url(submission_key = ':submission_key')
+            "#{base_url}#{POLL_ROUTE.sub(':submission_key', submission_key)}"
+          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/wait_group.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Provider
+        class WaitGroup < Inferno::TestGroup
+          include URLs
+
+          title 'Wait For Requests'
+
+          description %(
+            This group will capture bulk data submit requests until the user confirms they are finished.
+          )
+
+          id :bulk_data_v400_submit_provider_wait
+
+          run_as_group
+
+          test do
+            id :bulk_data_v400_submit_provider_wait_for_requests
+            title 'Wait For Submit Sequence'
+
+            output :provider_submission_outcomes, type: :textarea
+
+            input :client_id,
+                  title: 'Client Id',
+                  type: 'text',
+                  optional: true,
+                  locked: true,
+                  description: SMARTAppLaunch::INPUT_CLIENT_ID_DESCRIPTION_LOCKED
+
+            run do
+              output provider_submission_outcomes: '{}'
+              identifier = client_id.presence || test_session_id
+
+              wait(
+                identifier:,
+                message: %(
+                  This test will wait and capture all requests made while the tester performs a bulk data submit
+                  operation (as a Data Provider) against the provided endpoint(s).
+
+                  Use the following URL as the base Data Consumer endpoint:
+
+                  #{fhir_base_url}
+
+                  Start a bulk submit operation (as a Data Provider) by performing a POST request with a submit
+                  manifest against the following URL:
+
+                  #{submit_url}
+
+                  Use client id `#{identifier}` to obtain a backend services access token from the SMART authorization
+                  server for this FHIR server and include the access token on all subsequent requests.
+
+                  Send all requests for each submission through the terminal
+                  `completed` request, then use the link below to allow Inferno
+                  to retrieve every completed submission.
+
+                  The entire request sequence will be recorded and verified to check conformance to the
+                  [Bulk Submit Operation](https://hl7.org/fhir/uv/bulkdata/4.0.0-202609-ballot/en/)
+                  within the Bulk Data Access v4.0.0-ballot IG.
+
+                  [Click here](#{resume_pass_url}?id=#{identifier}) when finished.
+                ),
+                timeout: 900
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/shared/jwks.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Shared
+        module JWKS
+          DEFAULT_JWKS_PATH = File.expand_path('../../../bulk_data_jwks.json', __dir__)
+
+          def jwks_json
+            bulk_data_jwks = JSON.parse(
+              File.read(ENV.fetch('BULK_DATA_JWKS', DEFAULT_JWKS_PATH))
+            )
+
+            @jwks_json ||= JSON.pretty_generate(
+              { keys: bulk_data_jwks['keys'].select { |key| key['key_ops']&.include?('verify') } }
+            )
+          end
+
+          def jwks_route_handler
+            ->(_env) { [200, { 'Content-Type' => 'application/json' }, [jwks_json]] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/shared/submission_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Shared
+        module SubmissionStatus
+          SYSTEM = 'http://hl7.org/fhir/event-status'
+          CODES = %w[in-progress completed stopped].freeze
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v4.0.0/submit/shared/submitter_identifier.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV400
+    module Submit
+      module Shared
+        module SubmitterIdentifier
+          SYSTEM = 'https://example.org/fhir/NamingSystem/inferno-bulk-submitter'
+          VALUE = 'inferno-demo-data-provider'
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module BulkDataTestKit
-  VERSION = '0.13.1'
-  LAST_UPDATED = '2026-06-01'
+  VERSION = '0.14.0'
+  LAST_UPDATED = '2026-10-29'
 end

data/lib/bulk_data_test_kit.rb

@@ -3,3 +3,5 @@ require_relative 'bulk_data_test_kit/metadata.rb'
 require_relative 'bulk_data_test_kit/v1.0.1/bulk_data_test_suite'
 require_relative 'bulk_data_test_kit/v2.0.0/bulk_data_test_suite'
 require_relative 'bulk_data_test_kit/v2.0.0_client/bulk_data_client_test_suite'
+require_relative 'bulk_data_test_kit/v4.0.0/submit/provider/test_suite'
+require_relative 'bulk_data_test_kit/v4.0.0/submit/consumer/test_suite'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulk_data_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-01 00:00:00.000000000 Z
+date: 2026-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bloomer
@@ -100,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: smart_app_launch_test_kit
   requirement: !ruby/object:Gem::Requirement
@@ -210,20 +196,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: roo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.10.1
 description: FHIR Bulk Data Access Test Kit
 email:
 executables: []
@@ -235,6 +207,8 @@ files:
 - config/presets/bulk_data_v101_inferno_reference_server.json
 - config/presets/bulk_data_v200_bulk_data_server.json
 - config/presets/bulk_data_v200_inferno_reference_server.json
+- config/presets/bulk_data_v400_submit_consumer_demo.json.erb
+- config/presets/bulk_data_v400_submit_provider_demo.json
 - lib/bulk_data_test_kit.rb
 - lib/bulk_data_test_kit/bulk_data_jwks.json
 - lib/bulk_data_test_kit/bulk_data_test_kit_properties.rb
@@ -249,6 +223,8 @@ files:
 - lib/bulk_data_test_kit/requirements/generated/bulk_data_v101_requirements_coverage.csv
 - lib/bulk_data_test_kit/requirements/generated/bulk_data_v200_client_requirements_coverage.csv
 - lib/bulk_data_test_kit/requirements/generated/bulk_data_v200_requirements_coverage.csv
+- lib/bulk_data_test_kit/requirements/generated/bulk_data_v400_submit_consumer_requirements_coverage.csv
+- lib/bulk_data_test_kit/requirements/generated/bulk_data_v400_submit_provider_requirements_coverage.csv
 - lib/bulk_data_test_kit/requirements/hl7.fhir.uv.bulkdata_1.0.0_reqs.xlsx
 - lib/bulk_data_test_kit/requirements/hl7.fhir.uv.bulkdata_2.0.0_reqs.xlsx
 - lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb
@@ -317,6 +293,41 @@ files:
 - lib/bulk_data_test_kit/v2.0.0_client/server_proxy.rb
 - lib/bulk_data_test_kit/v2.0.0_client/tags.rb
 - lib/bulk_data_test_kit/v2.0.0_client/urls.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/backend_services_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/complete_poll_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/docs/suite_description.md
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/endpoints/file_download.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/endpoints/manifest.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/helpers.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/manifest_and_file_retrieval.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/poll_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/processing_wait_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/status_submit_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/submit_completed_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/submit_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/tags.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/test_suite.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/consumer/urls.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/client_registration_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/docs/suite_description.md
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/endpoints/poll.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/endpoints/status.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/endpoints/submit.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/helpers.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/manifest_and_file_retrieval.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/poll_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/processing_wait_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/retrieval.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/status_submit_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/submit_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/submit_stopped_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/tags.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/test_suite.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/urls.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/provider/wait_group.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/shared/jwks.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/shared/submission_status.rb
+- lib/bulk_data_test_kit/v4.0.0/submit/shared/submitter_identifier.rb
 - lib/bulk_data_test_kit/version.rb
 homepage: https://github.com/inferno-framework/bulk-data-test-kit
 licenses: