bulk_data_test_kit 0.10.1 → 0.11.0

data/lib/bulk_data_test_kit/v1.0.1/bulk_data_smart_discovery_v101_contents_test.rb

@@ -0,0 +1,77 @@
+require 'pry'
+module BulkDataTestKit
+  module BulkDataV101
+    class BulkDataSmartDiscoveryV101ContentsTest < Inferno::Test
+      title 'Well-known configuration contains the required fields'
+      id :bulk_data_smart_discovery_v101_contents
+
+      description %(
+        The [Bulk Data v1.0.1 SMART Backend Services IG](https://hl7.org/fhir/uv/bulkdata/STU1.0.1/authorization/index.html#advertising-server-conformance-with-smart-backend-services) states:
+        > A server MAY advertise its conformance with SMART Backend Services, by hosting a Well-Known Uniform Resource
+        > Identifiers (URIs) (RFC5785) JSON document as described at SMART App Launch Authorization Discovery. If
+        > advertising support, a server’s /.well-known/smart-configuration endpoint SHOULD include token_endpoint,
+        > scopes_supported, token_endpoint_auth_methods_supported (with values that include private_key_jwt), and
+        > token_endpoint_auth_signing_alg_values_supported (with values that include at least one of RS384, ES384)
+        > attributes for backend services. The response is a JSON document using the application/json mime type.
+
+        This test requires a valid `token_endpoint` claim to pass but issue a warning for any other recommended claims
+        that are not present.
+        However, any included claim must have the proper format and/or values indicated by the IG.
+      )
+
+      input :well_known_configuration
+
+      output :smart_token_url
+
+      def test_key(config, key, type)
+        assert config[key].present?, "Well-known configuration field `#{key}` is blank"
+        assert config[key].is_a?(type), "Well-known `#{key}` must be type: #{type.to_s.downcase}"
+      end
+
+      run do
+        config = JSON.parse(well_known_configuration)
+
+        # token_endpoint must be output for downstream tests to work
+        assert config.key?('token_endpoint'), 'Well-known configuration does not include `token_endpoint`'
+        test_key(config, 'token_endpoint', String)
+        token_endpoint = config['token_endpoint']
+        assert_valid_http_uri(token_endpoint, "`#{token_endpoint}` is not a valid URI")
+
+        output smart_token_url: token_endpoint
+
+        recommended_capabilities = [
+          'token_endpoint_auth_methods_supported',
+          'token_endpoint_auth_signing_alg_values_supported',
+          'scopes_supported'
+        ]
+
+        present_capabilities = []
+        recommended_capabilities.each do |key|
+          if config.key?(key) then present_capabilities.append(key)
+          else
+            warning do
+              assert config.key?(key), "Well-known configuration does not include `#{key}`"
+            end
+          end
+        end
+
+        present_capabilities.each do |key|
+          test_key(config, key, Array)
+        end
+
+        if present_capabilities.include?('token_endpoint_auth_methods_supported')
+          assert config['token_endpoint_auth_methods_supported'].include?('private_key_jwt'),
+                '`token_endpoint_auth_methods_supported` does not include the value `private_key_jwt`'
+        end
+
+        if present_capabilities.include?('token_endpoint_auth_methods_supported')
+            supports_RS384 = config['token_endpoint_auth_signing_alg_values_supported'].include? 'RS384'
+          supports_ES384 = config['token_endpoint_auth_signing_alg_values_supported'].include? 'ES384'
+
+          assert (supports_RS384 || supports_ES384),
+          '`token_endpoint_auth_signing_alg_values_supported` does not include values for `RS384` or `ES384`'
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v1.0.1/bulk_data_smart_discovery_v101_group.rb

@@ -0,0 +1,15 @@
+require 'smart_app_launch/well_known_endpoint_test'
+require_relative 'bulk_data_smart_discovery_v101_contents_test'
+
+module BulkDataTestKit
+  module BulkDataV101
+    class BulkDataSmartDiscoveryV101Group < Inferno::TestGroup
+      title 'SMART on FHIR Discovery'
+      id :bulk_data_smart_discovery_v101
+      run_as_group
+
+      test from: :well_known_endpoint
+      test from: :bulk_data_smart_discovery_v101_contents
+    end
+  end
+end

data/lib/bulk_data_test_kit/v1.0.1/bulk_data_test_suite.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../version'
-require_relative 'bulk_data_smart_backend_services_group'
+require_relative 'bulk_data_smart_backend_services_v101_group'
 require_relative 'bulk_data_export_tests_test_group'
 
 module BulkDataTestKit
   module BulkDataV101
     class BulkDataTestSuite < Inferno::TestSuite
-      title 'Bulk Data Access v1.0.1'
-      version VERSION
+      title 'Bulk Data Access v1.0.1 Server'
       id :bulk_data_v101
       links [
         {
@@ -158,8 +157,7 @@ module BulkDataTestKit
         url :bulk_server_url
       end
 
-      group from: :bulk_data_smart_backend_services,
-            id: :bulk_data_smart_backend_services_v101
+      group from: :bulk_data_smart_backend_services_v101
 
       group from: :bulk_data_export_tests_v101
     end

data/lib/bulk_data_test_kit/{v1.0.1/bulk_data_smart_backend_services_group.rb → v2.0.0/bulk_data_smart_backend_services_v200_group.rb}

@@ -3,10 +3,10 @@
 require 'smart_app_launch/smart_stu2_suite'
 
 module BulkDataTestKit
-  module BulkDataV101
-    class BulkDataSmartBackendServicesGroup < Inferno::TestGroup
+  module BulkDataV200
+    class BulkDataSmartBackendServicesV200Group < Inferno::TestGroup
       title 'SMART Backend Services'
-      id :bulk_data_smart_backend_services
+      id :bulk_data_smart_backend_services_v200
       run_as_group
       optional
 

data/lib/bulk_data_test_kit/v2.0.0/bulk_data_test_suite.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../version'
-require_relative '../v1.0.1/bulk_data_smart_backend_services_group'
+require_relative 'bulk_data_smart_backend_services_v200_group'
 require_relative 'bulk_data_export_tests_test_group'
 
 module BulkDataTestKit
   module BulkDataV200
     class BulkDataTestSuite < Inferno::TestSuite
-      title 'Bulk Data Access v2.0.0'
-      version VERSION
+      title 'Bulk Data Access v2.0.0 Server'
       id :bulk_data_v200
       links [
         {
@@ -156,8 +155,7 @@ module BulkDataTestKit
         url :bulk_server_url
       end
 
-      group from: :bulk_data_smart_backend_services,
-            id: :bulk_data_smart_backend_services_v200
+      group from: :bulk_data_smart_backend_services_v200
 
       group from: :bulk_data_export_tests_v200
     end

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

@@ -0,0 +1,27 @@
+# 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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client - Delete
+    class DeleteTest < Inferno::Test
+      title 'Bulk Data Delete Request'
+
+      description %(
+        This test verifies that after a Bulk Data request has been started, the client can send a
+        DELETE request to the URL provided in the Content-Location header to
+        [delete the request](https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request),
+        as described in the [FHIR Asynchronous Request Pattern](https://www.hl7.org/fhir/R4/async.html).
+      )
+
+      id :bulk_data_client_delete
+
+      verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@119'
+
+      run do
+        assert load_tagged_requests(DELETE_TAG).any?, fail_message
+      end
+
+      def fail_message
+        'Did not receive a delete request.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client - Delete Wait
+    class DeleteWaitTest < Inferno::Test
+      include URLs
+
+      title 'Wait For Request Sequence'
+
+      description %(
+        This test will receive bulk data export requests until the user confirms they are finished.
+      )
+
+      id :bulk_data_client_delete_wait
+
+      input :access_token, :export_type, :group_id
+
+      run do
+        wait(
+          identifier: access_token,
+          message: %(
+            Kick-off a **#{export_type}** endpoint type bulk export using the following base URL:
+
+            #{kickoff_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}**
+
+            Once the export request has been kicked-off,
+            [delete the export](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request).
+
+            The entire request sequence will be recorded and used in the subsequent tests to
+            verify comformity 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.
+          )
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'bulk_data_client_export_wait_test'
+require_relative 'bulk_data_client_kick_off_test'
+require_relative 'bulk_data_client_status_test'
+require_relative 'bulk_data_client_output_test'
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client Export Tests
+    class ExportGroup < Inferno::TestGroup
+      title 'Bulk Data Client Export Tests'
+
+      description %(
+        The Bulk Data Client Export tests verify the ability of a client to:
+          - Kick-off a new bulk data export request
+          - Poll the in-progress request for status updates
+          - Download a completed bulk data export file
+      )
+
+      id :bulk_data_client_export_group
+
+      run_as_group
+
+      test from: :bulk_data_client_export_wait
+      test from: :bulk_data_client_kick_off
+      test from: :bulk_data_client_status
+      test from: :bulk_data_client_output
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client - Export Wait
+    class ExportWaitTest < Inferno::Test
+      include URLs
+
+      title 'Wait For Request Sequence'
+
+      description %(
+        This test will receive bulk data export requests until the user confirms they are finished.
+      )
+
+      id :bulk_data_client_export_wait
+
+      input :access_token, :export_type, :group_id
+
+      run do
+        wait(
+          identifier: access_token,
+          message: %(
+            Perform a **#{export_type}** endpoint type bulk export kick-off using the following base URL:
+
+            #{kickoff_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.
+
+            The entire request sequence will be recorded and used in the subsequent tests to
+            verify comformity 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.
+          )
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client Kick-off
+    class KickOffTest < Inferno::Test
+      title 'Bulk Data Kick-off Request'
+
+      description %(
+        This test verifies that a client can
+        [kick-off a Bulk Data request](https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles)
+        using the `$export` operation against the proper endpoint type.
+      )
+
+      id :bulk_data_client_kick_off
+
+      verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@17'
+
+      input :export_type
+
+      run do
+        case export_type
+        when PATIENT_EXPORT_TYPE
+          assert load_tagged_requests(PATIENT_KICKOFF_TAG).any?, patient_fail_message
+        when GROUP_EXPORT_TYPE
+          assert load_tagged_requests(GROUP_KICKOFF_TAG).any?, group_fail_message
+        when SYSTEM_EXPORT_TYPE
+          assert load_tagged_requests(SYSTEM_KICKOFF_TAG).any?, system_fail_message
+        end
+      end
+
+      def patient_fail_message
+        'Did not receive a Patient type kick-off request.'
+      end
+
+      def group_fail_message
+        'Did not receive a Group type kick-off request.'
+      end
+
+      def system_fail_message
+        'Did not receive a System type kick-off request.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client Output
+    class OutputTest < Inferno::Test
+      title 'Bulk Data Output File Request'
+
+      description %(
+        This test verifies that the client, using the URL supplied in the Complete Status response body,
+        can [download](https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request)
+        the generated Bulk Data file.
+      )
+
+      id :bulk_data_client_output
+
+      verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@200'
+
+      run do
+        assert load_tagged_requests(OUTPUT_TAG).any?, fail_message
+      end
+
+      def fail_message
+        'Did not receive a download request.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    # Bulk Data Client Status
+    class StatusTest < Inferno::Test
+      title 'Bulk Data Status Request'
+
+      description %(
+        This test verifies that after a Bulk Data request has been started, the client can
+        [poll the status URL](https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request)
+        provided in the Content-Location header, as as described in the
+        [FHIR Asynchronous Request Pattern](https://www.hl7.org/fhir/R4/async.html).
+      )
+
+      id :bulk_data_client_status
+
+      verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@123'
+
+      run do
+        assert load_tagged_requests(STATUS_TAG).any?, fail_message
+      end
+
+      def fail_message
+        'Did not receive a status request.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative '../version'
+require_relative 'tags'
+require_relative 'urls'
+require_relative 'export_types'
+
+require_relative 'endpoints/delete'
+require_relative 'endpoints/kick_off'
+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'
+
+      description File.read(File.join(__dir__, 'docs', 'suite_description.md'))
+
+      id :bulk_data_v200_client
+
+      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'
+        },
+        {
+          label: 'Implementation Guide',
+          url: 'https://hl7.org/fhir/uv/bulkdata/STU2/'
+        }
+      ]
+
+      input :access_token,
+            title: 'Access Token',
+            description: 'The access token that will be included in all client requests during testing.'
+
+      input :export_type,
+            title: 'Export Type',
+            description: 'The export endpoint type to test against.',
+            type: 'radio',
+            default: SYSTEM_EXPORT_TYPE,
+            options: {
+              list_options: [
+                {
+                  label: 'All Patients',
+                  value: PATIENT_EXPORT_TYPE
+                },
+                {
+                  label: 'Group of Patients',
+                  value: GROUP_EXPORT_TYPE
+                },
+                {
+                  label: 'System Level Export',
+                  value: SYSTEM_EXPORT_TYPE
+                }
+              ]
+            }
+
+      input :group_id,
+            title: 'Group ID',
+            description: 'If using the Group endpoint, the identifier of the Group to export.',
+            default: 1,
+            locked: true
+
+      suite_endpoint :get, PATIENT_KICKOFF_ROUTE, Endpoints::KickOff
+      suite_endpoint :get, GROUP_KICKOFF_ROUTE, Endpoints::KickOff
+      suite_endpoint :get, SYSTEM_KICKOFF_ROUTE, Endpoints::KickOff
+      suite_endpoint :get, STATUS_ROUTE, Endpoints::Status
+      suite_endpoint :get, OUTPUT_ROUTE, Endpoints::Output
+      suite_endpoint :delete, STATUS_ROUTE, Endpoints::Delete
+
+      resume_test_route :get, RESUME_PASS_PATH 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/docs/suite_description.md

@@ -0,0 +1,33 @@
+The Bulk Data Access v2.0.0 Client test suite validates the conformance of a client
+to the [FHIR Bulk Data Access IG STU2](http://hl7.org/fhir/uv/bulkdata/STU2).
+
+## Scope
+
+These tests are a **DRAFT** intended to allow implementers to perform
+preliminary checks of their systems against the requirements stated for Bulk Data client actors
+and [provide feedback](https://github.com/inferno-framework/bulk-data-test-kit/issues)
+on the tests. Future versions of these tests may verify other
+requirements and may change the test verification logic.
+
+## Running the Tests
+
+### Quick Start
+
+Inferno needs to be able to identify when requests come from the client under test. Testers must provide a bearer access token that will be provided within the Authentication header (Bearer <token>) on all requests made to Inferno endpoints during the test. Inferno uses this information to associate the message with the test session and determine how to respond. How the token provided to Inferno is generated is up to the tester.
+
+Note: authentication options for these tests have not been finalized and are subject to change as the requirements evolve. If the implemented approach prevents you from using these tests, please provide feedback so the limitations can be addressed.
+
+### 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).
+
+To run client tests against one of the Postman collections:
+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.

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    module Endpoints
+      # Delete Endpoint
+      class Delete < Inferno::DSL::SuiteEndpoint
+        def test_run_identifier
+          request.get_header('HTTP_AUTHORIZATION')&.split&.last
+        end
+
+        def make_response
+          response.status = 202
+        end
+
+        def tags
+          [DELETE_TAG]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    module Endpoints
+      # Kick Off Endpoint
+      class KickOff < Inferno::DSL::SuiteEndpoint
+        include URLs
+
+        def test_run_identifier
+          request.get_header('HTTP_AUTHORIZATION')&.split&.last
+        end
+
+        def make_response
+          response.status = 202
+          response.headers['Content-Location'] = status_url
+        end
+
+        def tags
+          case request_type.titleize
+          when PATIENT_EXPORT_TYPE
+            [PATIENT_KICKOFF_TAG]
+          when GROUP_EXPORT_TYPE
+            [GROUP_KICKOFF_TAG]
+          when SYSTEM_EXPORT_TYPE
+            [SYSTEM_KICKOFF_TAG]
+          end
+        end
+
+        def request_type
+          request.params[:type] || SYSTEM_EXPORT_TYPE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    module Endpoints
+      # Output Endpoint
+      class Output < Inferno::DSL::SuiteEndpoint
+        def test_run_identifier
+          request.get_header('HTTP_AUTHORIZATION')&.split&.last
+        end
+
+        def make_response
+          response.status = 200
+          response.headers['Content-Type'] = 'application/fhir+ndjson'
+          response.body = "#{example_patient.to_json.squish}\n"
+        end
+
+        def tags
+          [OUTPUT_TAG]
+        end
+
+        def example_patient
+          FHIR::Patient.new(
+            id: test_run_identifier,
+            name: FHIR::HumanName.new(given: 'Example', family: 'Patient')
+          )
+        end
+      end
+    end
+  end
+end