bulk_data_test_kit 0.11.1 → 0.12.0

data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb

@@ -2,7 +2,6 @@
 
 module BulkDataTestKit
   module BulkDataV200Client
-    # Bulk Data Client Output
     class OutputTest < Inferno::Test
       title 'Bulk Data Output File Request'
 

data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb

@@ -2,7 +2,6 @@
 
 module BulkDataTestKit
   module BulkDataV200Client
-    # Bulk Data Client Status
     class StatusTest < Inferno::Test
       title 'Bulk Data Status Request'
 

data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_test_suite.rb

@@ -4,6 +4,7 @@ require_relative '../version'
 require_relative 'tags'
 require_relative 'urls'
 require_relative 'export_types'
+require_relative 'server_proxy'
 
 require_relative 'endpoints/delete'
 require_relative 'endpoints/kick_off'
@@ -11,11 +12,9 @@ require_relative 'endpoints/output'
 require_relative 'endpoints/status'
 
 require_relative 'bulk_data_client_export_group'
-require_relative 'bulk_data_client_delete_group'
 
 module BulkDataTestKit
   module BulkDataV200Client
-    # Bulk Data Access v2.0.0 Client Test Suite
     class BulkDataClientTestSuite < Inferno::TestSuite
       title 'Bulk Data Access v2.0.0 Client'
 
@@ -70,9 +69,28 @@ module BulkDataTestKit
 
       input :group_id,
             title: 'Group ID',
-            description: 'If using the Group endpoint, the identifier of the Group to export.',
-            default: 1,
-            locked: true
+            description: 'If using the Group endpoint, the ID that represents the data set that will be used.',
+            type: 'radio',
+            options: {
+              list_options: [
+                {
+                  label: 'PDex Data',
+                  value: 'pdex-Group'
+                },
+                {
+                  label: 'CARIN Data',
+                  value: 'carin-Group'
+                },
+                {
+                  label: 'US Core Data',
+                  value: '1a'
+                },
+                {
+                  label: 'PDex, CARIN, and US Core Data',
+                  value: 'combo-Group'
+                }
+              ]
+            }
 
       suite_endpoint :get, PATIENT_KICKOFF_ROUTE, Endpoints::KickOff
       suite_endpoint :get, GROUP_KICKOFF_ROUTE, Endpoints::KickOff
@@ -81,12 +99,11 @@ module BulkDataTestKit
       suite_endpoint :get, OUTPUT_ROUTE, Endpoints::Output
       suite_endpoint :delete, STATUS_ROUTE, Endpoints::Delete
 
-      resume_test_route :get, RESUME_PASS_PATH do |request|
+      resume_test_route :get, RESUME_PASS_ROUTE do |request|
         request.query_parameters['id']
       end
 
       group from: :bulk_data_client_export_group
-      group from: :bulk_data_client_delete_group
     end
   end
 end

data/lib/bulk_data_test_kit/v2.0.0_client/{bulk_data_client_export_wait_test.rb → bulk_data_client_wait_test.rb}

@@ -2,8 +2,7 @@
 
 module BulkDataTestKit
   module BulkDataV200Client
-    # Bulk Data Client - Export Wait
-    class ExportWaitTest < Inferno::Test
+    class WaitTest < Inferno::Test
       include URLs
 
       title 'Wait For Request Sequence'
@@ -12,7 +11,7 @@ module BulkDataTestKit
         This test will receive bulk data export requests until the user confirms they are finished.
       )
 
-      id :bulk_data_client_export_wait
+      id :bulk_data_client_wait
 
       input :access_token, :export_type, :group_id
 
@@ -22,22 +21,22 @@ module BulkDataTestKit
           message: %(
             Perform a **#{export_type}** endpoint type bulk export kick-off using the following base URL:
 
-            #{kickoff_url}
+            #{fhir_url}
 
             #{export_type == GROUP_EXPORT_TYPE ? "Ensure the Group ID is set to **#{group_id}**." : ''}
 
             Include the following bearer access token with all requests: **#{access_token}**
 
-            After the kick-off is made, a subsequent status request (using the URL provided in the response
-            to the kick-off request) and then a download request (using the URL provided in the response to
-            the status request) are expected.
+            After the kick-off is made, subsequent status request(s) (using the URL provided in the response
+            to the kick-off request), a download request (using the URL provided in the response to
+            the status request), and finally a delete request are expected.
 
-            The entire request sequence will be recorded and used in the subsequent tests to
-            verify comformity to the
+            The entire request sequence will be recorded and verified to check conformance to the
             [Bulk Data IG](https://build.fhir.org/ig/HL7/bulk-data/export.html#sequence-overview).
 
             [Click here](#{resume_pass_url}?id=#{access_token}) when finished.
-          )
+          ),
+          timeout: 900
         )
       end
     end

data/lib/bulk_data_test_kit/v2.0.0_client/docs/suite_description.md

@@ -20,14 +20,13 @@ Note: authentication options for these tests have not been finalized and are sub
 ### Sample Execution - Postman
 
 To try out these tests without a Bulk Data client implementation, you may
-run them using [this "bulk data client system export" Postman collection](https://github.com/inferno-framework/bulk-data-test-kit/blob/main/lib/bulk_data_test_kit/v2.0.0_client/postman/system_export.postman_collection.json) and [this "bulk data client delete" Postman collection](https://github.com/inferno-framework/bulk-data-test-kit/blob/main/lib/bulk_data_test_kit/v2.0.0_client/postman/delete.postman_collection.json).
+run them using the [`Bulk Data Client - System Export Postman`](https://github.com/inferno-framework/bulk-data-test-kit/blob/main/lib/bulk_data_test_kit/v2.0.0_client/postman/collection.json) collection. This will kick-off an export, poll the status endpoint (respecting the `retry-after` header), download the first output result, and then delete the export.
 
-To run client tests against one of the Postman collections:
+To run client tests against this Postman collection:
 1. Start an Inferno session of the Bulk Data Client test suite.
-2. Navigate to either the export tests group or the delete tests group (depending on which Postman collection you want to use).
-3. Click the "Run Tests" button in the upper right, enter any value (e.g. `SAMPLE_TOKEN`) as the access token, and select the "System Level Export" option for export type.
-4. Click the "Submit" button. The simulated server will then be waiting for an interaction.
-5. Open Postman and import the relevant Postman collection.
-6. Set the `access_token` variable equal to the value entered in step 3 (the value is also displayed on the test modal in the Inferno UI for reference).
-7. Run the collection.
-8. Once the postman collection has run, click the "Click here" link in the wait dialog to evaluate the requests.
+2. Click the "Run All Tests" button in the upper right, enter any value (e.g. `SAMPLE_TOKEN`) as the access token, and select the "System Level Export" option for export type.
+3. Click the "Submit" button. The simulated server will start waiting for requests.
+4. Open Postman and import the relevant Postman collection.
+5. Set the `access_token` variable equal to the value entered in step 2 (the value is also displayed on the test modal in the Inferno UI for reference).
+6. Run the collection.
+7. Once the postman collection has run, click the "Click here" link in the Inferno wait dialog modal to evaluate the requests and generate the results.

data/lib/bulk_data_test_kit/v2.0.0_client/endpoints/delete.rb

@@ -3,8 +3,9 @@
 module BulkDataTestKit
   module BulkDataV200Client
     module Endpoints
-      # Delete Endpoint
       class Delete < Inferno::DSL::SuiteEndpoint
+        include ServerProxy
+
         def test_run_identifier
           request.get_header('HTTP_AUTHORIZATION')&.split&.last
         end
@@ -16,6 +17,10 @@ module BulkDataTestKit
         def tags
           [DELETE_TAG]
         end
+
+        def job_id
+          request.params[:job_id]
+        end
       end
     end
   end

data/lib/bulk_data_test_kit/v2.0.0_client/endpoints/kick_off.rb

@@ -3,21 +3,31 @@
 module BulkDataTestKit
   module BulkDataV200Client
     module Endpoints
-      # Kick Off Endpoint
       class KickOff < Inferno::DSL::SuiteEndpoint
         include URLs
+        include ServerProxy
 
         def test_run_identifier
           request.get_header('HTTP_AUTHORIZATION')&.split&.last
         end
 
+        # Proxy the request to the reference server, and re-use the returned '_jobId' as
+        # the identifier we'll return to the user for our own `content-location` header.
         def make_response
-          response.status = 202
-          response.headers['Content-Location'] = status_url
+          server_response = proxy_kickoff
+          case server_response.status
+          when 202
+            server_status_url = server_response.headers['content-location']
+            response.status = 202
+            response.headers['content-location'] = status_url.gsub(':job_id', job_id(server_status_url))
+          else
+            response.status = server_response.status
+            response.body = server_response.body
+          end
         end
 
         def tags
-          case request_type.titleize
+          case request_type
           when PATIENT_EXPORT_TYPE
             [PATIENT_KICKOFF_TAG]
           when GROUP_EXPORT_TYPE
@@ -27,8 +37,32 @@ module BulkDataTestKit
           end
         end
 
+        def proxy_kickoff
+          case request_type
+          when PATIENT_EXPORT_TYPE
+            proxy_client.get('$export', request_params)
+          when GROUP_EXPORT_TYPE
+            proxy_client.get("#{request_type}/#{group_id}/$export", request_params)
+          when SYSTEM_EXPORT_TYPE
+            proxy_client.get('$export', request_params)
+          end
+        end
+
+        # Collect request params to forward to the reference server
+        def request_params
+          request.params.to_h.stringify_keys
+        end
+
         def request_type
-          request.params[:type] || SYSTEM_EXPORT_TYPE
+          (request.params[:type] || SYSTEM_EXPORT_TYPE).titleize
+        end
+
+        def group_id
+          request.params[:group_id]
+        end
+
+        def job_id(url)
+          CGI.parse(URI.parse(url).query)['_jobId']&.first
         end
       end
     end

data/lib/bulk_data_test_kit/v2.0.0_client/endpoints/output.rb

@@ -3,27 +3,34 @@
 module BulkDataTestKit
   module BulkDataV200Client
     module Endpoints
-      # Output Endpoint
       class Output < Inferno::DSL::SuiteEndpoint
+        include ServerProxy
+
         def test_run_identifier
           request.get_header('HTTP_AUTHORIZATION')&.split&.last
         end
 
+        # Proxy the request to the reference server for a completed output file,
+        # using the same id provided with the completed status request.
         def make_response
-          response.status = 200
-          response.headers['Content-Type'] = 'application/fhir+ndjson'
-          response.body = "#{example_patient.to_json.squish}\n"
+          server_response = proxy_client.get("Binary/#{binary_id}")
+
+          case server_response.status
+          when 200
+            response.status = 200
+            response.headers['Content-Type'] = 'application/fhir+ndjson'
+          else
+            response.status = server_response.status
+          end
+          response.body = server_response.body
         end
 
         def tags
           [OUTPUT_TAG]
         end
 
-        def example_patient
-          FHIR::Patient.new(
-            id: test_run_identifier,
-            name: FHIR::HumanName.new(given: 'Example', family: 'Patient')
-          )
+        def binary_id
+          request.params[:binary_id]
         end
       end
     end

data/lib/bulk_data_test_kit/v2.0.0_client/endpoints/status.rb

@@ -3,36 +3,59 @@
 module BulkDataTestKit
   module BulkDataV200Client
     module Endpoints
-      # Status Endpoint
       class Status < Inferno::DSL::SuiteEndpoint
         include URLs
+        include ServerProxy
 
         def test_run_identifier
           request.get_header('HTTP_AUTHORIZATION')&.split&.last
         end
 
+        # Proxy the request to the reference server using the same `_jobId`` we received
+        # on kickoff, and respond with the current status. If the status is complete,
+        # return the output adjusted to point at Inferno.
         def make_response
-          response.status = 200
-          response.body = response_body.to_json
-          response.format = :json
+          server_response = proxy_client.get("$export-poll-status?_jobId=#{job_id}")
+
+          case server_response.status
+          when 202
+            # In-Progress Status
+            response.status = 202
+            response.headers['retry-after'] = 120
+          when 200
+            # Complete Status
+            body = JSON.parse(server_response.body)
+            response.status = 200
+            response.body = response_body(body).to_json
+            response.format = :json
+          else
+            response.status = server_response.status
+            response.body = server_response.body
+          end
         end
 
         def tags
           [STATUS_TAG]
         end
 
-        def response_body
+        def response_body(body)
+          output = body['output']&.map do |binary|
+            binary['url'] = rewrite_url_base(binary['url'])
+            binary
+          end
+
           {
             transactionTime: DateTime.now.iso8601,
-            request: kickoff_url,
+            request: rewrite_url_base(body['request']),
             requiresAccessToken: true,
-            output: [{
-              type: 'Patient',
-              url: output_url
-            }],
+            output: output || [],
             error: []
           }
         end
+
+        def job_id
+          request.params[:job_id]
+        end
       end
     end
   end

data/lib/bulk_data_test_kit/v2.0.0_client/postman/{system_export.postman_collection.json → collection.json}

@@ -11,7 +11,7 @@
 					"listen": "test",
 					"script": {
 						"exec": [
-							"pm.test(\"kick-off was accepted\", function () {",
+							"pm.test(\"export was kicked off\", function () {",
 							"  pm.response.to.have.status(202);",
 							"});",
 							"",
@@ -48,13 +48,20 @@
 					"listen": "test",
 					"script": {
 						"exec": [
-							"let responseData = pm.response.json();",
-							"",
-							"pm.test(\"export is complete\", function () {",
-							"  pm.response.to.have.status(200);",
+							"pm.test(\"status was checked\", function () {",
+							"    pm.expect(pm.response.code).to.be.oneOf([200, 202]);",
 							"});",
 							"",
-							"pm.collectionVariables.set(\"download_url\", responseData.output[0].url);",
+							"if (pm.response.code === 202) {",
+							"    var retryAfter = pm.response.headers.get('retry-after');",
+							"    var retryAfterMs = parseInt(retryAfter, 10) * 1000;",
+							"    setTimeout(function() {",
+							"        pm.execution.setNextRequest(pm.info.requestName);",
+							"    }, retryAfterMs);",
+							"} else if (pm.response.code === 200) {",
+							"    let responseData = pm.response.json();",
+							"    pm.collectionVariables.set(\"download_url\", responseData.output[0].url);",
+							"}",
 							""
 						],
 						"type": "text/javascript",
@@ -91,7 +98,7 @@
 					"listen": "test",
 					"script": {
 						"exec": [
-							"pm.test(\"downlaod is successful\", function () {",
+							"pm.test(\"output was downloaded\", function () {",
 							"  pm.response.to.have.status(200);",
 							"});",
 							""
@@ -122,6 +129,45 @@
 				}
 			},
 			"response": []
+		},
+		{
+			"name": "Delete",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"export was deleted\", function () {",
+							"  pm.response.to.have.status(202);",
+							"});",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				},
+				{
+					"listen": "prerequest",
+					"script": {
+						"exec": [
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "DELETE",
+				"header": [],
+				"url": {
+					"raw": "{{status_url}}",
+					"host": [
+						"{{status_url}}"
+					]
+				}
+			},
+			"response": []
 		}
 	],
 	"auth": {
@@ -159,7 +205,7 @@
 	"variable": [
 		{
 			"key": "access_token",
-			"value": "SAMPLE_TOKEN",
+			"value": "test",
 			"type": "string"
 		},
 		{

data/lib/bulk_data_test_kit/v2.0.0_client/server_proxy.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    module ServerProxy
+      include URLs
+
+      def proxy_client
+        @proxy_client ||= Faraday.new(
+          url: ENV.fetch('FHIR_REFERENCE_SERVER'),
+          params: {},
+          headers: request_headers
+        ) do |proxy|
+          proxy.use FaradayMiddleware::Gzip
+          proxy.options.params_encoder = Faraday::FlatParamsEncoder
+        end
+      end
+
+      def rewrite_url_base(url)
+        url.gsub(ENV.fetch('FHIR_REFERENCE_SERVER'), fhir_url)
+      end
+
+      def request_headers
+        {
+          'Content-Type' => 'application/json',
+          'Authorization' => 'Bearer SAMPLE_TOKEN',
+          'Prefer' => 'respond-async'
+        }
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v2.0.0_client/urls.rb

@@ -2,26 +2,25 @@
 
 module BulkDataTestKit
   module BulkDataV200Client
-    RESUME_PASS_PATH = '/resume_pass'
+    RESUME_PASS_ROUTE = '/resume_pass'
     BASE_ROUTE = '/fhir'
-    METADATA_ROUTE = "#{BASE_ROUTE}/metadata".freeze
     PATIENT_KICKOFF_ROUTE = "#{BASE_ROUTE}/:type/$export".freeze
     GROUP_KICKOFF_ROUTE = "#{BASE_ROUTE}/:type/:group_id/$export".freeze
     SYSTEM_KICKOFF_ROUTE = "#{BASE_ROUTE}/$export".freeze
-    STATUS_ROUTE = '/status'
-    OUTPUT_ROUTE = '/output/example.ndjson'
+    STATUS_ROUTE = '/status/:job_id'
+    OUTPUT_ROUTE = "#{BASE_ROUTE}/Binary/:binary_id".freeze
 
     # URLs for use in Bulk Data Client tests and endpoints
     module URLs
       def base_url
-        "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+        "#{Inferno::Application['base_url']}/custom/bulk_data_v200_client"
       end
 
       def resume_pass_url
-        base_url + RESUME_PASS_PATH
+        base_url + RESUME_PASS_ROUTE
       end
 
-      def kickoff_url
+      def fhir_url
         base_url + BASE_ROUTE
       end
 
@@ -32,14 +31,6 @@ module BulkDataTestKit
       def output_url
         base_url + OUTPUT_ROUTE
       end
-
-      def suite_id
-        if respond_to?('result') # If being used with a suite endpoint
-          result.test_id.split('-').first
-        elsif self.class.respond_to?('suite') # If being used with a test/group/suite
-          self.class.suite.id
-        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.11.1'
-  LAST_UPDATED = '2026-03-06'
+  VERSION = '0.12.0'
+  LAST_UPDATED = '2025-03-25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulk_data_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bloomer
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.7
 - !ruby/object:Gem::Dependency
   name: json-jwt
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: tls_test_kit
   requirement: !ruby/object:Gem::Requirement
@@ -264,23 +264,21 @@ files:
 - lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb
 - lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_cancel_group.rb
 - lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb
-- lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_group.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb
-- lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_wait_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_export_group.rb
-- lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_export_wait_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_kick_off_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_test_suite.rb
+- lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_wait_test.rb
 - lib/bulk_data_test_kit/v2.0.0_client/docs/suite_description.md
 - lib/bulk_data_test_kit/v2.0.0_client/endpoints/delete.rb
 - lib/bulk_data_test_kit/v2.0.0_client/endpoints/kick_off.rb
 - lib/bulk_data_test_kit/v2.0.0_client/endpoints/output.rb
 - lib/bulk_data_test_kit/v2.0.0_client/endpoints/status.rb
 - lib/bulk_data_test_kit/v2.0.0_client/export_types.rb
-- lib/bulk_data_test_kit/v2.0.0_client/postman/delete.postman_collection.json
-- lib/bulk_data_test_kit/v2.0.0_client/postman/system_export.postman_collection.json
+- lib/bulk_data_test_kit/v2.0.0_client/postman/collection.json
+- 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/version.rb

data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_group.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'bulk_data_client_delete_wait_test'
-require_relative 'bulk_data_client_kick_off_test'
-require_relative 'bulk_data_client_delete_test'
-
-module BulkDataTestKit
-  module BulkDataV200Client
-    # Bulk Data Client Delete Tests
-    class DeleteGroup < Inferno::TestGroup
-      title 'Bulk Data Client Delete Tests'
-
-      description %(
-        The Bulk Data Client Delete tests verify the ability of a client to delete
-        a kicked-off bulk data export request.
-      )
-
-      id :bulk_data_client_delete_group
-
-      run_as_group
-
-      test from: :bulk_data_client_delete_wait
-      test from: :bulk_data_client_kick_off
-      test from: :bulk_data_client_delete
-    end
-  end
-end